.. README.rst
.. Copyright (c) 2013-2019 Pablo Acosta-Serafini
.. See LICENSE for details
.. image:: https://badge.fury.io/py/ptrie.svg
:target: https://pypi.org/project/ptrie
:alt: PyPI version
.. image:: https://img.shields.io/pypi/l/ptrie.svg
:target: https://pypi.org/project/ptrie
:alt: License
.. image:: https://img.shields.io/pypi/pyversions/ptrie.svg
:target: https://pypi.org/project/ptrie
:alt: Python versions supported
.. image:: https://img.shields.io/pypi/format/ptrie.svg
:target: https://pypi.org/project/ptrie
:alt: Format
|
.. image::
https://dev.azure.com/pmasdev/ptrie/_apis/build/status/pmacosta.ptrie?branchName=master
:target: https://dev.azure.com/pmasdev/ptrie/_build?definitionId=4&_a=summary
:alt: Continuous integration test status
.. image::
https://img.shields.io/azure-devops/coverage/pmasdev/ptrie/4.svg
:target: https://dev.azure.com/pmasdev/ptrie/_build?definitionId=4&_a=summary
:alt: Continuous integration test coverage
.. image::
https://readthedocs.org/projects/pip/badge/?version=stable
:target: https://pip.readthedocs.io/en/stable/?badge=stable
:alt: Documentation status
|
Description
.. role:: bash(code)
:language: bash
.. _Cog: https://nedbatchelder.com/code/cog
.. _Coverage: https://coverage.readthedocs.io
.. _Docutils: http://docutils.sourceforge.net/docs
.. _Mock: https://docs.python.org/3/library/unittest.mock.html
.. _Pmisc: http://pmisc.readthedocs.org
.. _Pydocstyle: http://www.pydocstyle.org
.. _Pylint: https://www.pylint.org
.. _Py.test: http://pytest.org
.. _Pytest-coverage: https://pypi.org/project/pytest-cov
.. _Pytest-pmisc: http://pytest-pmisc.readthedocs.org
.. _Pytest-xdist: https://pypi.org/project/pytest-xdist
.. _Sphinx: http://sphinx-doc.org
.. _ReadTheDocs Sphinx theme: https://github.com/rtfd/sphinx_rtd_theme
.. _Inline Syntax Highlight Sphinx Extension:
https://bitbucket.org/klorenz/sphinxcontrib-inlinesyntaxhighlight
.. _Shellcheck Linter Sphinx Extension:
https://pypi.org/project/sphinxcontrib-shellcheck
.. _Tox: https://tox.readthedocs.io
.. _Virtualenv: https://docs.python-guide.org/dev/virtualenvs
This module can be used to build, handle, process and search tries <https://en.wikipedia.org/wiki/Trie>
_
Interpreter
The package has been developed and tested with Python 2.7, 3.5, 3.6 and 3.7
under Linux (Debian, Ubuntu), Apple macOS and Microsoft Windows
Installing
.. code-block:: console
$ pip install ptrie
Documentation
Available at Read the Docs <https://ptrie.readthedocs.io>
_
Contributing
-
Abide by the adopted code of conduct <https://www.contributor-covenant.org/version/1/4/code-of-conduct>
_
-
Fork the repository <https://github.com/pmacosta/ptrie>
_ from GitHub and
then clone personal copy [#f1]_:
.. code-block:: console
$ github_user=myname
$ git clone --recurse-submodules \
https://github.com/"${github_user}"/ptrie.git
Cloning into 'ptrie'...
...
$ cd ptrie || exit 1
$ export PTRIE_DIR=${PWD}
$
-
The package uses two sub-modules: a set of custom Pylint plugins to help with
some areas of code quality and consistency (under the pylint_plugins
directory), and a lightweight package management framework (under the
pypkg
directory). Additionally, the pre-commit framework <https://pre-commit.com/>
_ is used to perform various pre-commit code
quality and consistency checks. To enable the pre-commit hooks:
.. code-block:: console
$ cd "${PTRIE_DIR}" || exit 1
$ pre-commit install
pre-commit installed at .../ptrie/.git/hooks/pre-commit
$
-
Ensure that the Python interpreter can find the package modules
(update the :bash:$PYTHONPATH
environment variable, or use
sys.paths() <https://docs.python.org/3/library/sys.html#sys.path>
_,
etc.)
.. code-block:: console
$ export PYTHONPATH=${PYTHONPATH}:${PTRIE_DIR}
$
-
Install the dependencies (if needed, done automatically by pip):
-
Cog
_ (2.5.1 or newer)
-
Coverage
_ (4.5.3 or newer)
-
Docutils
_ (0.14 or newer)
-
Inline Syntax Highlight Sphinx Extension
_ (0.2 or newer)
-
Mock
_ (2.0.0 or newer)
-
Pmisc
_ (1.5.8 or newer)
-
Py.test
_ (4.3.1 or newer)
-
Pydocstyle
_ (3.0.0 or newer)
-
Pylint
_ (Python 2.x: 1.9.4 or newer, Python 3.x: 2.3.1 or newer)
-
Pytest-coverage
_ (2.6.1 or newer)
-
Pytest-pmisc
_ (1.0.7 or newer)
-
Pytest-xdist
_ (optional, 1.26.0 or newer)
-
ReadTheDocs Sphinx theme
_ (0.4.3 or newer)
-
Shellcheck Linter Sphinx Extension
_ (1.0.8 or newer)
-
Sphinx
_ (1.8.5 or newer)
-
Tox
_ (3.7.0 or newer)
-
Virtualenv
_ (16.4.3 or newer)
-
Implement a new feature or fix a bug
-
Write a unit test which shows that the contributed code works as expected.
Run the package tests to ensure that the bug fix or new feature does not
have adverse side effects. If possible achieve 100% code and branch
coverage of the contribution. Thorough package validation
can be done via Tox and Pytest:
.. code-block:: console
$ PKG_NAME=ptrie tox
GLOB sdist-make: .../ptrie/setup.py
py27-pkg create: .../ptrie/.tox/py27
py27-pkg installdeps: -r.../ptrie/requirements/tests_py27.pip, -r.../ptrie/requirements/docs_py27.pip
...
py27-pkg: commands succeeded
py35-pkg: commands succeeded
py36-pkg: commands succeeded
py37-pkg: commands succeeded
congratulations :)
$
Setuptools <https://bitbucket.org/pypa/setuptools>
_ can also be used
(Tox is configured as its virtual environment manager):
.. code-block:: console
$ PKG_NAME=ptrie python setup.py tests
running tests
running egg_info
writing ptrie.egg-info/PKG-INFO
writing dependency_links to ptrie.egg-info/dependency_links.txt
writing requirements to ptrie.egg-info/requires.txt
...
py27-pkg: commands succeeded
py35-pkg: commands succeeded
py36-pkg: commands succeeded
py37-pkg: commands succeeded
congratulations :)
$
Tox (or Setuptools via Tox) runs with the following default environments:
py27-pkg
, py35-pkg
, py36-pkg
and py37-pkg
[#f3]_. These use
the 2.7, 3.5, 3.6 and 3.7 interpreters, respectively, to test all code in
the documentation (both in Sphinx *.rst
source files and in
docstrings), run all unit tests, measure test coverage and re-build the
exceptions documentation. To pass arguments to Pytest (the test runner) use
a double dash (--
) after all the Tox arguments, for example:
.. code-block:: console
$ PKG_NAME=ptrie tox -e py27-pkg -- -n 4
GLOB sdist-make: .../ptrie/setup.py
py27-pkg inst-nodeps: .../ptrie/.tox/.tmp/package/1/ptrie-1.1.7.zip
...
py27-pkg: commands succeeded
congratulations :)
$
Or use the :code:-a
Setuptools optional argument followed by a quoted
string with the arguments for Pytest. For example:
.. code-block:: console
$ PKG_NAME=ptrie python setup.py tests -a "-e py27-pkg -- -n 4"
running tests
...
py27-pkg: commands succeeded
congratulations :)
$
There are other convenience environments defined for Tox [#f3]_:
-
py27-repl
, py35-repl
, py36-repl
and py37-repl
run the
Python 2.7, 3.5, 3.6 and 3.7 REPL, respectively, in the appropriate
virtual environment. The ptrie
package is pip-installed by Tox when
the environments are created. Arguments to the interpreter can be
passed in the command line after a double dash (--
).
-
py27-test
, py35-test
, py36-test
and py37-test
run Pytest
using the Python 2.7, 3.5, 3.6 and 3.7 interpreter, respectively, in the
appropriate virtual environment. Arguments to pytest can be passed in
the command line after a double dash (--
) , for example:
.. code-block:: console
$ PKG_NAME=ptrie tox -e py27-test -- -x test_ptrie.py
GLOB sdist-make: .../ptrie/setup.py
py27-pkg inst-nodeps: .../ptrie/.tox/.tmp/package/1/ptrie-1.1.7.zip
...
py27-pkg: commands succeeded
congratulations :)
$
-
py27-test
, py35-test
, py36-test
and py37-test
test code
and branch coverage using the 2.7, 3.5, 3.6 and 3.7 interpreter,
respectively, in the appropriate virtual environment. Arguments to
pytest can be passed in the command line after a double dash (--
).
The report can be found in :bash:${PTRIE_DIR}/.tox/py[PV]/usr/share/ptr ie/tests/htmlcov/index.html
where [PV]
stands for 2.7
, 3.5
,
3.6
or 3.7
depending on the interpreter used.
-
Verify that continuous integration tests pass. The package has continuous
integration configured for Linux, Apple macOS and Microsoft Windows (all via
Azure DevOps <https://dev.azure.com/pmasdev>
_).
-
Document the new feature or bug fix (if needed). The script
:bash:${PTRIE_DIR}/pypkg/build_docs.py
re-builds the whole package
documentation (re-generates images, cogs source files, etc.):
.. code-block:: console
$ "${PTRIE_DIR}"/pypkg/build_docs.py -h
usage: build_docs.py [-h] [-d DIRECTORY] [-r]
[-n NUM_CPUS] [-t]
Build ptrie package documentation
optional arguments:
-h, --help show this help message and exit
-d DIRECTORY, --directory DIRECTORY
specify source file directory
(default ../ptrie)
-r, --rebuild rebuild exceptions documentation.
If no module name is given all
modules with auto-generated
exceptions documentation are
rebuilt
-n NUM_CPUS, --num-cpus NUM_CPUS
number of CPUs to use (default: 1)
-t, --test diff original and rebuilt file(s)
(exit code 0 indicates file(s) are
identical, exit code 1 indicates
file(s) are different)
.. rubric:: Footnotes
.. [#f1] All examples are for the bash <https://www.gnu.org/software/bash/>
_
shell
.. [#f2] It is assumed that all the Python interpreters are in the executables
path. Source code for the interpreters can be downloaded from Python's main
site <https://www.python.org/downloads/>
_
.. [#f3] Tox configuration largely inspired by
Ionel's codelog <https://blog.ionelmc.ro/2015/04/14/ tox-tricks-and-patterns/>
_
License
The MIT License (MIT)
Copyright (c) 2013-2019 Pablo Acosta-Serafini
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
.. CHANGELOG.rst
.. Copyright (c) 2013-2019 Pablo Acosta-Serafini
.. See LICENSE for details
Changelog
-
1.1.8 [2019-05-30]: Documentation update
-
1.1.7 [2019-05-30]: Added equality magic method to Trie class
-
1.1.6 [2019-03-21]: Dependency bug fix
-
1.1.5 [2019-03-21]: Dependency update
-
1.1.4 [2019-03-21]: Documentation update
-
1.1.3 [2019-03-04]: Documentation update
-
1.1.2 [2019-03-02]: Critical dependencies update
-
1.1.1 [2019-03-01]: Updated package management framework
-
1.1.0 [2018-01-18]: Dropped support for Python interpreter versions 2.6, 3.3
and 3.4. Updated dependencies versions to their current versions
-
1.0.6 [2017-02-09]: Package build enhancements and fixes
-
1.0.5 [2017-02-07]: Python 3.6 support
-
1.0.4 [2016-06-11]: Minor documentation build bug fix
-
1.0.3 [2016-05-13]: Documentation update
-
1.0.2 [2016-05-11]: Documentation update
-
1.0.1 [2016-05-02]: Minor documentation and testing enhancements
-
1.0.0 [2016-04-25]: Final release of 1.0.0 branch
-
1.0.0rc1 [2016-04-25]: Initial commit, forked off putil PyPI package