symbolism 0.4.0

Examples

The library makes it possible to construct symbolic Python expressions (as instances of the symbol class) that can be evaluated at a later time. A symbolic expression involving addition of integers is created in the example below:

>>> from symbolism import *
>>> addition = symbol(lambda x, y: x + y)
>>> summation = addition(symbol(1), symbol(2))

The expression above can be evaluated at a later time:

>>> summation.evaluate()
3

Instances of symbol are compatible with common built-in infix and prefix arithmetic, logical, and relational operators. When an operator is applied to one or more symbol instances, a new symbol instance is created:

>>> summation = symbol(1) + symbol(2)
>>> summation.evaluate()
3

Pre-defined constants are also provided for all built-in operators supported by the symbol class:

>>> conjunction = and_(symbol(True), symbol(False))
>>> conjunction.evaluate()
False

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/symbolism/symbolism.py -v

Style conventions are enforced using Pylint:

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

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/*