PyPI version License Python versions supported Format

Continuous integration test status Continuous integration test coverage Documentation status

Description

This module can be used to build, handle, process and search tries

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

$ pip install ptrie

Documentation

Available at Read the Docs

Contributing

  1. Abide by the adopted code of conduct

  2. Fork the repository from GitHub and then clone personal copy [1]:

    $ github_user=myname
$ git clone --recursive \
      https://github.com/"${github_user}"/ptrie.git
Cloning into 'ptrie'...
...
$ cd ptrie
$ export PTRIE_DIR=${PWD}

  3. Install the project’s Git hooks and build the documentation. The pre-commit hook does some minor consistency checks, namely trailing whitespace and PEP8 compliance via Pylint. Assuming the directory to which the repository was cloned is in the $PTRIE_DIR shell environment variable:

    $ "${PTRIE_DIR}"/pypkg/complete-cloning.sh
Installing Git hooks
Building ptrie package documentation
...

  4. Ensure that the Python interpreter can find the package modules (update the $PYTHONPATH environment variable, or use sys.paths(), etc.)

    $ export PYTHONPATH=${PYTHONPATH}:${PTRIE_DIR}

  5. Install the dependencies (if needed, done automatically by pip):

  6. Implement a new feature or fix a bug

  7. 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 Py.test:

    $ tox
GLOB sdist-make: .../ptrie/setup.py
py26-pkg inst-nodeps: .../ptrie/.tox/dist/ptrie-...zip

    Setuptools can also be used (Tox is configured as its virtual environment manager):

    $ python setup.py tests
running tests
running egg_info
writing requirements to ptrie.egg-info/requires.txt
writing ptrie.egg-info/PKG-INFO
...

    Tox (or Setuptools via Tox) runs with the following default environments: py27-pkg, py35-pkg, py36-pkg and py37-pkg [3]. 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 Py.test (the test runner) use a double dash (--) after all the Tox arguments, for example:

    $ tox -e py27-pkg -- -n 4
GLOB sdist-make: .../ptrie/setup.py
py27-pkg inst-nodeps: .../ptrie/.tox/dist/ptrie-...zip
...

    Or use the -a Setuptools optional argument followed by a quoted string with the arguments for Py.test. For example:

    $ python setup.py tests -a "-e py27-pkg -- -n 4"
running tests
...

    There are other convenience environments defined for Tox [3]:

    • py27-repl, py35-repl, py36-repl and py37-repl run the 2.7, 3.5, 3.6 or 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 py.test using the Python 2.7, 3.5, Python 3.6 or Python 3.7 interpreter, respectively, in the appropriate virtual environment. Arguments to py.test can be passed in the command line after a double dash (--) , for example:

      $ tox -e py36-test -- -x test_ptrie.py
GLOB sdist-make: [...]/ptrie/setup.py
py36-test inst-nodeps: [...]/ptrie/.tox/dist/ptrie-1.1rc1.zip
py36-test installed: -f file:[...]
py36-test runtests: PYTHONHASHSEED='1264622266'
py36-test runtests: commands[0] | [...]py.test -x test_ptrie.py
===================== test session starts =====================
platform linux -- Python 3.6.4, pytest-3.3.1, py-1.5.2, pluggy-0.6.0
rootdir: [...]/ptrie/.tox/py36/share/ptrie/tests, inifile: pytest.ini
plugins: xdist-1.21.0, forked-0.2, cov-2.5.1
collected 414 items
...

    • py27-cov, py35-cov, py36-cov and py37-cov test code and branch coverage using the 2.7, 3.5, 3.6 or 3.7 interpreter, respectively, in the appropriate virtual environment. Arguments to py.test can be passed in the command line after a double dash (--). The report can be found in ${PTRIE_DIR}/.tox/py[PV]/usr/share/ptrie/tests/htmlcov/index.html where [PV] stands for 27, 35, 36 or 37 depending on the interpreter used

  8. Verify that continuous integration tests pass. The package has continuous integration configured for Linux, Apple macOS and Microsoft Windows (all via Azure DevOps) Aggregation/cloud code coverage is configured via Codecov. It is assumed that the Codecov repository upload token in the build is stored in the $(codecovToken) environment variable (securely defined in the pipeline settings page).

  9. Document the new feature or bug fix (if needed). The script ${PTRIE_DIR}/pypkg/build_docs.py re-builds the whole package documentation (re-generates images, cogs source files, etc.):

    $ ${PKG_BIN_DIR}/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)

Footnotes

[1]All examples are for the bash shell
[2]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
[3](1, 2) Tox configuration largely inspired by Ionel’s codelog

Changelog

  • 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

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.

Indices and tables