skip to navigation
skip to content

pmisc 1.2.2

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



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-based)

Interpreter

The package has been developed and tested with Python 2.6, 2.7, 3.3, 3.4, 3.5 and 3.6 under Linux (Debian, Ubuntu), macOS and Microsoft Windows

Installing

$ pip install pmisc

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]:

    $ git clone \
          https://github.com/[github-user-name]/pmisc.git
    Cloning into 'pmisc'...
    ...
    $ cd pmisc
    $ export PMISC_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 $PMISC_DIR shell environment variable:

    $ ${PMISC_DIR}/sbin/complete-cloning.sh
    Installing Git hooks
    Building pmisc 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}:${PMISC_DIR}
    
  5. Install the dependencies (if needed, done automatically by pip):

    • Astroid (Python 2.6: older than 1.4, Python 2.7 or newer: 1.3.8 or newer)
    • Cog (2.4 or newer)
    • Coverage (3.7.1 or newer)
    • Decorator (3.4.2 or newer)
    • Docutils (Python 2.6: 0.12 or newer and older than 0.13, Python 2.7: 0.12 or newer, Python 3.3: 0.12 or newer and older than 0.13, Python 3.4: 0.12 or newer, Python 3.5: 0.12 or newer, Python 3.6: 0.12 or newer)
    • Funcsigs (Python 2.x only, 0.4 or newer)
    • Inline Syntax Highlight Sphinx Extension (0.2 or newer)
    • Mock (Python 2.x only, 1.0.1 or newer)
    • Py.test (2.7.0 or newer)
    • Pylint (Python 2.6: 1.3 or newer and older than 1.4, Python 2.7 or newer: 1.3.1 or newer)
    • Pytest-coverage (1.8.0 or newer)
    • Pytest-xdist (optional, 1.8.0 or newer)
    • ReadTheDocs Sphinx theme (0.1.9 or newer)
    • Sphinx (Python 2.6: 1.2.3 or newer and 1.4.9 or older, Python 2.7: 1.5 or newer, Python 3.3: 1.2.3 or newer and 1.4.9 or older, Python 3.4: 1.5 or newer, Python 3.5: 1.5 or newer, Python 3.6: 1.5 or newer)
    • Tox (1.9.0 or newer)
    • Virtualenv (13.1.2 or newer)
  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: .../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: py26-pkg, py27-pkg, py33-pkg, py34-pkg and py35-pkg [2]. These use the Python 2.6, 2.7, 3.3, 3.4 and 3.5 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]:

    • py26-repl, py27-repl, py33-repl, py34-repl and py35-repl run the Python 2.6, 2.7, 3.3, 3.4 or 3.5 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 (--)

    • py26-test, py27-test, py33-test, py34-test and py35-test run py.test using the Python 2.6, 2.7, 3.3, 3.4 or Python 3.5 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 py34-test -- -x test_pmisc.py
      GLOB sdist-make: [...]/pmisc/setup.py
      py34-test inst-nodeps: [...]/pmisc/.tox/dist/pmisc-[...].zip
      py34-test runtests: PYTHONHASHSEED='680528711'
      py34-test runtests: [...]py.test -x test_pmisc.py
      ============== test session starts ==============
      platform linux -- Python 3.4.2 -- py-1.4.30 -- [...]
      ...
      
    • py26-cov, py27-cov, py33-cov, py34-cov and py35-cov test code and branch coverage using the Python 2.6, 2.7, 3.3, 3.4 or 3.5 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 26, 27, 33, 34 or 35 depending on the interpreter used

  8. 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).

  9. 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

[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]Tox configuration largely inspired by Ionel’s codelog

License

The MIT License (MIT)

Copyright (c) 2013-2017 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-2017 Pablo Acosta-Serafini .. See LICENSE for details

Changelog

  • 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
 
File Type Py Version Uploaded on Size
pmisc-1.2.2-py26-none-any.whl (md5) Python Wheel py26 2017-02-10 33KB
pmisc-1.2.2-py27-none-any.whl (md5) Python Wheel py27 2017-02-10 33KB
pmisc-1.2.2-py33-none-any.whl (md5) Python Wheel py33 2017-02-10 33KB
pmisc-1.2.2-py34-none-any.whl (md5) Python Wheel py34 2017-02-10 33KB
pmisc-1.2.2-py35-none-any.whl (md5) Python Wheel py35 2017-02-10 33KB
pmisc-1.2.2-py36-none-any.whl (md5) Python Wheel py36 2017-02-10 33KB
pmisc-1.2.2.tar.gz (md5) Source 2017-02-10 83KB