This module contains miscellaneous utility functions that can be applied in a variety of circumstances; there are context managers, membership functions (test if an argument is of a given type), numerical functions, string functions and functions to aid in the unit testing of modules
Project description
Description
This module contains miscellaneous utility functions that can be applied in a variety of circumstances; there are context managers, membership functions (test if an argument is of a given type), numerical functions, string functions and functions to aid in the unit testing of modules
Py.test is the supported test runner
Interpreter
The package has been developed and tested with Python 2.7, 3.5, 3.6 and 3.7 under Linux (Debian, Ubuntu), Apple OS X and Microsoft Windows
Installing
$ pip install pmisc
Documentation
Available at Read the Docs
Contributing
Abide by the adopted code of conduct
Fork the repository from GitHub and then clone personal copy [1]:
$ github_user=myname $ git clone \ https://github.com/"${github_user}"/pmisc.git Cloning into 'pmisc'... ... $ cd pmisc $ export PMISC_DIR=${PWD}
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
$PMISC_DIR
shell environment variable:$ "${PMISC_DIR}"/sbin/complete-cloning.sh Installing Git hooks Building pmisc package documentation ...
Ensure that the Python interpreter can find the package modules (update the
$PYTHONPATH
environment variable, or use sys.paths(), etc.)$ export PYTHONPATH=${PYTHONPATH}:${PMISC_DIR}
Install the dependencies (if needed, done automatically by pip):
Astroid (1.6.0 or newer)
Cog (2.5.1 or newer)
Coverage (4.4.2 or newer)
Decorator (4.2.1 or newer)
Docutils (0.14 or newer)
Funcsigs (1.0.2 or newer)
Inline Syntax Highlight Sphinx Extension (0.2 or newer)
Mock (2.0.0 or newer)
Numpy (1.8.2 or newer)
Py.test (3.4.0 or newer)
Pylint (1.8.1 or newer)
Pytest-coverage (2.5.1 or newer)
Pytest-xdist (optional, 1.22.0 or newer)
ReadTheDocs Sphinx theme (0.1.9 or newer)
Shellcheck Linter Sphinx Extension (1.0.5 or newer)
Sphinx (1.6.6 or newer)
Tox (2.9.1 or newer)
Virtualenv (15.1.0 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 Py.test:
$ tox GLOB sdist-make: .../pmisc/setup.py py26-pkg inst-nodeps: .../pmisc/.tox/dist/pmisc-...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 pmisc.egg-info/requires.txt writing pmisc.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: .../pmisc/setup.py py27-pkg inst-nodeps: .../pmisc/.tox/dist/pmisc-...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 pmisc 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_pmisc.py GLOB sdist-make: [...]/pmisc/setup.py py36-test inst-nodeps: [...]/pmisc/.tox/dist/pmisc-1.1rc1.zip py36-test installed: -f file:[...] py36-test runtests: PYTHONHASHSEED='1264622266' py36-test runtests: commands[0] | [...]py.test -x test_pmisc.py ===================== test session starts ===================== platform linux -- Python 3.6.4, pytest-3.3.1, py-1.5.2, pluggy-0.6.0 rootdir: [...]/pmisc/.tox/py36/share/pmisc/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
${pmisc_DIR}/.tox/py[PV]/usr/share/pmisc/tests/htmlcov/index.html
where [PV] stands for 27, 35, 36 or 37 depending on the interpreter used
Verify that continuous integration tests pass. The package has continuous integration configured for Linux (via Travis) and for Microsoft Windows (via Appveyor). Aggregation/cloud code coverage is configured via Codecov. It is assumed that the Codecov repository upload token in the Travis build is stored in the
${CODECOV_TOKEN}
environment variable (securely defined in the Travis repository settings page).Document the new feature or bug fix (if needed). The script
${PMISC_DIR}/sbin/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 pmisc package documentation optional arguments: -h, --help show this help message and exit -d DIRECTORY, --directory DIRECTORY specify source file directory (default ../pmisc) -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
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.5.2 [2019-02-15]: Continuous integration bug fix
1.5.1 [2019-02-15]: Minor documentation update
1.5.0 [2019-02-15]: Dropped support for Python 2.6, 3.3 and 3.4. Updates to support newest versions of dependencies
1.4.2 [2018-03-01]: Fixed bugs in gcd and per functions which were not correctly handling Numpy data types. Minor code refactoring
1.4.1 [2018-02-18]: Moved traceback shortening functions to test module so as to enable the pytest-pmisc Pytest plugin to shorten the tracebacks of the test module functions in that environment
1.4.0 [2018-02-16]: Shortened traceback of test methods to point only to the line that uses the function that generates the exception
1.3.1 [2018-01-18]: Minor package build fix
1.3.0 [2018-01-18]: Dropped support for Python interpreter versions 2.6, 3.3 and 3.4. Updated dependencies versions to their current versions. Fixed failing tests under newer Pytest versions
1.2.2 [2017-02-09]: Package build enhancements and fixes
1.2.1 [2017-02-07]: Python 3.6 support
1.2.0 [2016-10-28]: Added TmpDir context manager to work with temporary directories
1.1.9 [2016-09-26]: Minor documentation update
1.1.8 [2016-08-27]: Fixed Appveyor-CI failures
1.1.7 [2016-08-24]: Fixed Travis-CI failures
1.1.6 [2016-08-24]: Fixed Py.test 3.0.x-related incompatibilities
1.1.5 [2016-08-24]: assert_exception now prints better message when actual exception is different than expected exception
1.1.4 [2016-08-06]: assert_exception now prints traceback when exception raised is different than expected exception
1.1.3 [2016-06-09]: assert_exception exception message is now not limited to just strings
1.1.2 [2016-06-01]: Fixed continuous integration failures in term_echo function testing
1.1.1 [2016-06-01]: Enhanced TmpFile context manager by allowing positional and keyword arguments to be passed to optional write function
1.1.0 [2016-05-15]: Added incfile, ste and term_echo functions. These produce output marked up in reStructuredText of source files (incfile) or terminal commands (ste, term_echo). All can be used to include relevant information in docstrings to enhance documentation
1.0.5 [2016-05-13]: Minor documentation update
1.0.4 [2016-05-02]: Minor documentation and testing enhancements
1.0.3 [2016-04-26]: Dependencies fixes
1.0.2 [2016-04-26]: Windows continuous integration fixes
1.0.1 [2016-04-26]: Removed dependency on Numpy
1.0.0 [2016-04-23]: Final release of 1.0.0 branch
1.0.0rc1 [2016-04-22]: Initial commit, merges misc and test modules of putil PyPI package
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.