Examples

To use this library, the PIL.Image module from the pillow library must be imported. If the pillowcases module is imported afterwards, the PIL.Image module’s PIL.Image.Image class is redefined to refer to the pillowcases.Image class (which is itself derived from the PIL.Image.Image class):

>>> import PIL.Image
>>> import pillowcases
>>> i = PIL.Image.frombytes('RGBA', (2, 2), bytes([0]*16))
>>> isinstance(i, pillowcases.Image)
True

Because instances of pillowcases.Image are hashable, they can be added as elements to set objects and can be used as keys in dict objects:

>>> 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]
2

Compare the above to the default behavior of the PIL.Image.Image class, demonstrated below:

>>> from importlib import reload
>>> 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 (most recent call last):
    ...
TypeError: unhashable type: 'Image'

Documentation

The documentation can be generated automatically from the source files using Sphinx:

python -m pip install .[docs]
cd docs
sphinx-apidoc -f -E --templatedir=_templates -o _source .. && make html

Testing and Conventions

All unit tests are executed and their coverage is measured when using pytest (see the pyproject.toml file for configuration details):

python -m pip install .[test]
python -m pytest

Alternatively, all unit tests are included in the module itself and can be executed using doctest:

python src/pillowcases/pillowcases.py -v

Style conventions are enforced using Pylint:

python -m pip install .[lint]
python -m pylint src/pillowcases

Contributions

In order to contribute to the source code, open an issue or submit a pull request on the GitHub page for this library.

Versioning

The version number format for this library and the changes to the library associated with version number increments conform with Semantic Versioning 2.0.0.

Publishing

This library can be published as a package on PyPI by a package maintainer. First, install the dependencies required for packaging and publishing:

python -m pip install .[publish]

Ensure that the correct version number appears in pyproject.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 an automation rule that activates and sets as the default all tagged versions. Create and push a tag for this version (replacing ?.?.? with the version number):

git tag ?.?.?
git push origin ?.?.?

Remove any old build/distribution files. Then, package the source into a distribution archive:

rm -rf build dist src/*.egg-info
python -m build --sdist --wheel .

Finally, upload the package distribution archive to PyPI:

python -m twine upload dist/*