Package: pillowcases
Library that makes it possible to work in a concise, algebraic way with Python Imaging Library image objects.Installation and UsageThis library is available as apackage on PyPI:python-mpipinstallpillowcasesThe library can be imported in the usual way:importpillowcasesExamplesTo use this library, thePIL.Imagemodule from thepillowlibrary must be imported. If thepillowcasesmodule is imported afterwards, thePIL.Imagemodule’sPIL.Image.Imageclass is redefined to refer to thepillowcases.Imageclass (which is itself derived from thePIL.Image.Imageclass):>>>importPIL.Image>>>importpillowcases>>>i=PIL.Image.frombytes('RGBA',(2,2),bytes([0]*16))>>>isinstance(i,pillowcases.Image)TrueBecause instances ofpillowcases.Imagearehashable, they can be added as elements tosetobjects and can be used as keys indictobjects:>>>j=PIL.Image.frombytes('RGBA',(2,2),bytes([0]*16))>>>k=PIL.Image.frombytes('RGBA',(2,2),bytes([255]*16))>>>len({i,j,k})2>>>d={j:1,k:2}>>>d[k]2Compare the above to the default behavior of thePIL.Image.Imageclass, demonstrated below:>>>fromimportlibimportreload>>>PIL.Image=reload(PIL.Image)>>>i=PIL.Image.frombytes('RGBA',(2,2),bytes([0]*16))>>>j=PIL.Image.frombytes('RGBA',(2,2),bytes([0]*16))>>>j=PIL.Image.frombytes('RGBA',(2,2),bytes([255]*16))>>>len({i,j,k})Traceback(mostrecentcalllast):...TypeError:unhashabletype:'Image'DevelopmentAll installation and development dependencies are fully specified inpyproject.toml. Theproject.optional-dependenciesobject is used tospecify optional requirementsfor various development tasks. This makes it possible to specify additional options (such asdocs,lint, and so on) when performing installation usingpip:python-mpipinstall.[docs,lint]DocumentationThe documentation can be generated automatically from the source files usingSphinx:python-mpipinstall.[docs]cddocssphinx-apidoc-f-E--templatedir=_templates-o_source..&&makehtmlTesting and ConventionsAll unit tests are executed and their coverage is measured when usingpytest(see thepyproject.tomlfile for configuration details):python-mpipinstall.[test]python-mpytestAlternatively, all unit tests are included in the module itself and can be executed usingdoctest:pythonsrc/pillowcases/pillowcases.py-vStyle conventions are enforced usingPylint:python-mpipinstall.[lint]python-mpylintsrc/pillowcasesContributionsIn order to contribute to the source code, open an issue or submit a pull request on theGitHub pagefor this library.VersioningThe version number format for this library and the changes to the library associated with version number increments conform withSemantic Versioning 2.0.0.PublishingThis library can be published as apackage on PyPIby a package maintainer. First, install the dependencies required for packaging and publishing:python-mpipinstall.[publish]Ensure that the correct version number appears inpyproject.toml, and that any links in this README document to the Read the Docs documentation of this package (or its dependencies) have appropriate version numbers. Also ensure that the Read the Docs project for this library has anautomation rulethat activates and sets as the default all tagged versions. Create and push a tag for this version (replacing?.?.?with the version number):gittag?.?.?gitpushorigin?.?.?Remove any old build/distribution files. Then, package the source into a distribution archive:rm-rfbuilddistsrc/*.egg-infopython-mbuild--sdist--wheel.Finally, upload the package distribution archive toPyPI:python-mtwineuploaddist/*