Package: circuit
Pure-Python library for building and working with logical circuits.Installation and UsageThis library is available as apackage on PyPI:python -m pip install circuitThe library can be imported in the usual way:import circuit
from circuit import *ExamplesThis library makes it possible to programmatically construct logical circuits consisting of interconnected logic gates. The functions corresponding to individual logic gates are represented using thelogicallibrary. In the example below, a simple conjunction circuit is constructed, and its input and output gates (corresponding to the logical unary identity function) are created and designated as such:>>> from circuit import circuit, op
>>> c = circuit()
>>> g0 = c.gate(op.id_, is_input=True)
>>> g1 = c.gate(op.id_, is_input=True)
>>> g2 = c.gate(op.and_, [g0, g1])
>>> g3 = c.gate(op.id_, [g2], is_output=True)
>>> c.count() # Number of gates in the circuit.
4The gate list associated with a circuit can be converted into a concise human-readable format, enabling manual inspection of the circuit:>>> c.gates.to_legible()
(('id',), ('id',), ('and', 0, 1), ('id', 2))The circuit accepts two input bits (represented as integers) and can be evaluated on any list of two bits using theevaluatemethod. The result is a bit vector that includes one bit for each output gate:>>> c.evaluate([0, 1])
[0]
>>> [list(c.evaluate(bs)) for bs in [[0, 0], [0, 1], [1, 0], [1, 1]]]
[[0], [0], [0], [1]]Note that the order of the output bits corresponds to the order in which the output gates were originally introduced using thegatemethod. It is possible to specify the signature of a circuit (i.e., the organization of input gates and output gates into distinct bit vectors of specific lengths) at the time the circuit object is created:>>> from circuit import signature
>>> c = circuit(signature([2], [1]))
>>> g0 = c.gate(op.id_, is_input=True)
>>> g1 = c.gate(op.id_, is_input=True)
>>> g2 = c.gate(op.not_, [g0])
>>> g3 = c.gate(op.not_, [g1])
>>> g4 = c.gate(op.xor_, [g2, g3])
>>> g5 = c.gate(op.not_, [g4])
>>> g6 = c.gate(op.id_, [g4], is_output=True)
>>> [list(c.evaluate([bs])) for bs in [[0, 0], [0, 1], [1, 0], [1, 1]]]
[[[0]], [[1]], [[1]], [[0]]]It is also possible to remove all internal gates from which an output gate cannot be reached (such asg5in the example above). Doing so does not change the order of the input gates or the order of the output gates:>>> c.count()
7
>>> c.prune_and_topological_sort_stable()
>>> c.count()
6Other methods make it possible todiscard a gate, toreplace a collection of gates, and toconvert a circuit into a boolean function. Descriptions and examples of these and other methods can be found in thedocumentation for the main library module.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 -m pip install .[docs,lint]DocumentationThe documentation can be generated automatically from the source files usingSphinx:python -m pip install .[docs]
cd docs
sphinx-apidoc -f -E --templatedir=_templates -o _source .. && make htmlTesting and ConventionsAll unit tests are executed and their coverage is measured when usingpytest(see thepyproject.tomlfile for configuration details):python -m pip install .[test]
python -m pytestAlternatively, all unit tests are included in the module itself and can be executed usingdoctest:python src/circuit/circuit.py -vStyle conventions are enforced usingPylint:python -m pip install .[lint]
python -m pylint src/circuitContributionsIn order to contribute to the source code, open an issue or submit a pull request on theGitHub pagepage for this library.VersioningBeginning with version 0.2.0, the 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 -m pip install .[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):git tag ?.?.?
git push origin ?.?.?Remove any old build/distribution files. Then, package the source into a distribution archive using thewheelpackage:rm -rf build dist src/*.egg-info
python -m build --sdist --wheel .Finally, upload the package distribution archive toPyPIusing thetwinepackage:python -m twine upload dist/*