Codestin Search App

radarhere · 2026-02-12T09:11:41Z

Most of the headings at https://pillow.readthedocs.io/en/stable/handbook/image-file-formats.html match the format attribute, as used by open() or save().

This updates it so that they all do.

While here, I have also updated the format / id for PalmImagePlugin to be uppercase, since Image immediately transforms it anyway.

Pillow/src/PIL/PalmImagePlugin.py

Lines 213 to 217 in 913698b

    
           Image.register_save("Palm", _save) 
        
           Image.register_extension("Palm", ".palm") 
        
           Image.register_mime("Palm", "image/palm")

Pillow/src/PIL/Image.py

Lines 3845 to 3855 in 913698b

    
           def register_save( 
        
               id: str, driver: Callable[[Image, IO[bytes], str | bytes], None] 
        
           ) -> None: 
        
               """ 
        
               Registers an image save function.  This function should not be 
        
               used in application code. 
        
               :param id: An image format identifier. 
        
               :param driver: A function to save images in this format. 
        
               """ 
        
               SAVE[id.upper()] = driver

Pillow/src/PIL/Image.py

Lines 3872 to 3880 in 913698b

    
           def register_extension(id: str, extension: str) -> None: 
        
               """ 
        
               Registers an image extension.  This function should not be 
        
               used in application code. 
        
               :param id: An image format identifier. 
        
               :param extension: An extension used for this format. 
        
               """ 
        
               EXTENSION[extension.lower()] = id.upper()

Pillow/src/PIL/Image.py

Lines 3830 to 3842 in 913698b

    
           def register_mime(id: str, mimetype: str) -> None: 
        
               """ 
        
               Registers an image MIME type by populating ``Image.MIME``. This function 
        
               should not be used in application code. 
        
               ``Image.MIME`` provides a mapping from image format identifiers to mime 
        
               formats, but :py:meth:`~PIL.ImageFile.ImageFile.get_format_mimetype` can 
        
               provide a different result for specific images. 
        
               :param id: An image format identifier. 
        
               :param mimetype: The image MIME type for this format. 
        
               """ 
        
               MIME[id.upper()] = mimetype

hugovk · 2026-02-12T10:45:41Z

I think the "human readable" names, where available, are more, well, readable.

radarhere · 2026-02-12T10:51:40Z

Does it at least make sense to combine the PFM and PPM entries? They are handled by one plugin.

docs/handbook/image-file-formats.rst

Co-authored-by: Hugo van Kemenade <[email protected]>

Merge PFM into PPM

657d041

radarhere force-pushed the formats branch from 3fdfb24 to 657d041 Compare February 12, 2026 10:51

radarhere changed the title ~~Update documentation headings to match plugin formats~~ Merge PFM documentation into PPM Feb 12, 2026

hugovk reviewed Feb 12, 2026

View reviewed changes

docs/handbook/image-file-formats.rst Outdated Show resolved Hide resolved

Use versionadded

f71d74e

Co-authored-by: Hugo van Kemenade <[email protected]>

radarhere added the Documentation label Feb 13, 2026

hugovk merged commit d411196 into python-pillow:main Feb 13, 2026
5 checks passed

radarhere deleted the formats branch February 13, 2026 23:16

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Merge PFM documentation into PPM#9434

Merge PFM documentation into PPM#9434
hugovk merged 2 commits intopython-pillow:mainfrom
radarhere:formats

radarhere commented Feb 12, 2026

Uh oh!

hugovk commented Feb 12, 2026

Uh oh!

radarhere commented Feb 12, 2026

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

	Image.register_save("Palm", _save)

	Image.register_extension("Palm", ".palm")

	Image.register_mime("Palm", "image/palm")

	def register_save(
	id: str, driver: Callable[[Image, IO[bytes], str \| bytes], None]
	) -> None:
	"""
	Registers an image save function. This function should not be
	used in application code.

	:param id: An image format identifier.
	:param driver: A function to save images in this format.
	"""
	SAVE[id.upper()] = driver

	def register_extension(id: str, extension: str) -> None:
	"""
	Registers an image extension. This function should not be
	used in application code.

	:param id: An image format identifier.
	:param extension: An extension used for this format.
	"""
	EXTENSION[extension.lower()] = id.upper()

	def register_mime(id: str, mimetype: str) -> None:
	"""
	Registers an image MIME type by populating ``Image.MIME``. This function
	should not be used in application code.

	``Image.MIME`` provides a mapping from image format identifiers to mime
	formats, but :py:meth:`~PIL.ImageFile.ImageFile.get_format_mimetype` can
	provide a different result for specific images.

	:param id: An image format identifier.
	:param mimetype: The image MIME type for this format.
	"""
	MIME[id.upper()] = mimetype

Uh oh!

Conversation

radarhere commented Feb 12, 2026

Uh oh!

hugovk commented Feb 12, 2026

Uh oh!

radarhere commented Feb 12, 2026

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants