Metadata-Version: 1.1
Name: pmisc
Version: 1.5.9
Summary: UNKNOWN
Home-page: http://github.com/pmacosta/pmisc/
Author: Pablo Acosta-Serafini
Author-email: pmasdev@gmail.com
License: MIT
Description: .. README.rst
        .. Copyright (c) 2013-2020 Pablo Acosta-Serafini
        .. See LICENSE for details
        
        .. image:: https://badge.fury.io/py/pmisc.svg
            :target: https://pypi.org/project/pmisc
            :alt: PyPI version
        
        .. image:: https://img.shields.io/pypi/l/pmisc.svg
            :target: https://pypi.org/project/pmisc
            :alt: License
        
        .. image:: https://img.shields.io/pypi/pyversions/pmisc.svg
            :target: https://pypi.org/project/pmisc
            :alt: Python versions supported
        
        .. image:: https://img.shields.io/pypi/format/pmisc.svg
            :target: https://pypi.org/project/pmisc
            :alt: Format
        
        |
        
        .. image::
            https://dev.azure.com/pmasdev/pmisc/_apis/build/status/pmacosta.pmisc?branchName=master
            :target: https://dev.azure.com/pmasdev/pmisc/_build?definitionId=3&_a=summary
            :alt: Continuous integration test status
        
        .. image::
            https://img.shields.io/azure-devops/coverage/pmasdev/pmisc/3.svg
            :target: https://dev.azure.com/pmasdev/pmisc/_build?definitionId=3&_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
        .. _Decorator: https://raw.githubusercontent.com/micheles/decorator/mast
           er/docs/documentation.md
        .. _Docutils: https://docutils.sourceforge.io/docs
        .. _Funcsigs: https://pypi.org/project/funcsigs
        .. _Mock: https://docs.python.org/3/library/unittest.mock.html
        .. _Numpy: https://numpy.org
        .. _Pydocstyle: http://www.pydocstyle.org
        .. _Pylint: https://www.pylint.org
        .. _Pytest: http://pytest.org
        .. _Pytest-coverage: https://pypi.org/project/pytest-cov
        .. _Pytest-xdist: https://pypi.org/project/pytest-xdist
        .. _Sphinx: http://sphinx-doc.org
        .. _ReadTheDocs Sphinx theme:
           https://github.com/readthedocs/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 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
        `Pytest`_ is the supported test runner
        
        Interpreter
        ===========
        
        The package has been developed and tested with Python 3.5, 3.6, 3.7 and 3.8
        under Linux (Debian, Ubuntu), Apple macOS and Microsoft Windows
        
        Installing
        ==========
        
        .. code-block:: console
        
        	$ pip install pmisc
        
        Documentation
        =============
        
        Available at `Read the Docs <https://pmisc.readthedocs.io>`_
        
        Contributing
        ============
        
        1. Abide by the adopted `code of conduct
           <https://www.contributor-covenant.org/version/1/4/code-of-conduct>`_
        
        2. Fork the `repository <https://github.com/pmacosta/pmisc>`_ from GitHub and
           then clone personal copy [#f1]_:
        
            .. code-block:: console
        
                $ github_user=myname
                $ git clone --recurse-submodules \
                      https://github.com/"${github_user}"/pmisc.git
                Cloning into 'pmisc'...
                ...
                $ cd pmisc || exit 1
                $ export PMISC_DIR=${PWD}
                $
        
        3. 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 "${PMISC_DIR}" || exit 1
                $ pre-commit install
                pre-commit installed at .../pmisc/.git/hooks/pre-commit
                $
        
        4. 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}:${PMISC_DIR}
               $
        
        5. Install the dependencies (if needed, done automatically by pip):
        
            * `Cog`_ (2.5.1 or newer)
        
            * `Coverage`_ (4.5.3 or newer)
        
            * `Decorator`_ (4.4.0 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.16.2 or newer)
        
            * `Pydocstyle`_ (3.0.0 or newer)
        
            * `Pylint`_ (2.3.1 or newer)
        
            * `Pytest`_ (4.3.1 or newer)
        
            * `Pytest-coverage`_ (2.6.1 or newer)
        
            * `Pytest-xdist`_ (optional, 1.26.1 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)
        
        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 Pytest:
        
           .. code-block:: console
        
               $ PKG_NAME=pmisc tox
               GLOB sdist-make: .../pmisc/setup.py
               py35-pkg create: .../pmisc/.tox/py35
               py35-pkg installdeps: -r.../pmisc/requirements/tests_py35.pip, -r.../pmisc/requirements/docs_py35.pip
               ...
                 py35-pkg: commands succeeded
                 py36-pkg: commands succeeded
                 py37-pkg: commands succeeded
                 py38-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=pmisc python setup.py tests
               running tests
               running egg_info
               writing pmisc.egg-info/PKG-INFO
               writing dependency_links to pmisc.egg-info/dependency_links.txt
               writing requirements to pmisc.egg-info/requires.txt
               ...
                 py35-pkg: commands succeeded
                 py36-pkg: commands succeeded
                 py37-pkg: commands succeeded
                 py38-pkg: commands succeeded
                 congratulations :)
               $
        
           Tox (or Setuptools via Tox) runs with the following default environments:
           ``py35-pkg``, ``py36-pkg``, ``py37-pkg`` and ``py38-pkg`` [#f3]_. These use
           the 3.5, 3.6, 3.7 and 3.8 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=pmisc tox -e py35-pkg -- -n 4
               GLOB sdist-make: .../pmisc/setup.py
               py35-pkg inst-nodeps: .../pmisc/.tox/.tmp/package/1/pmisc-1.5.9.zip
               ...
                 py35-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=pmisc python setup.py tests -a "-e py35-pkg -- -n 4"
               running tests
               ...
                 py35-pkg: commands succeeded
                 congratulations :)
               $
        
           There are other convenience environments defined for Tox [#f3]_:
        
            * ``py35-repl``, ``py36-repl``, ``py37-repl`` and ``py38-repl`` run the
              Python 3.5, 3.6, 3.7 and 3.8 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 (``--``).
        
            * ``py35-test``, ``py36-test``, ``py37-test`` and ``py38-test`` run Pytest
              using the Python 3.5, 3.6, 3.7 and 3.8 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=pmisc tox -e py35-test -- -x test_pmisc.py
               GLOB sdist-make: .../pmisc/setup.py
               py35-pkg inst-nodeps: .../pmisc/.tox/.tmp/package/1/pmisc-1.5.9.zip
               ...
                 py35-pkg: commands succeeded
                 congratulations :)
               $
            * ``py35-test``, ``py36-test``, ``py37-test`` and ``py38-test`` test code
              and branch coverage using the 3.5, 3.6, 3.7 and 3.8 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:`${PMISC_DIR}/.tox/py[PV]/usr/share/pmi
              sc/tests/htmlcov/index.html` where ``[PV]`` stands for ``3.5``, ``3.6``,
              ``3.7`` or ``3.8`` 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 <https://dev.azure.com/pmasdev>`_).
        
        9. Document the new feature or bug fix (if needed). The script
           :bash:`${PMISC_DIR}/pypkg/build_docs.py` re-builds the whole package
           documentation (re-generates images, cogs source files, etc.):
        
           .. code-block:: console
        
               $ "${PMISC_DIR}"/pypkg/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)
        
        .. 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-2020 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-2020 Pablo Acosta-Serafini
        .. See LICENSE for details
        
        Changelog
        =========
        
        * 1.5.8 [2019-03-21]: Minor documentation update
        
        * 1.5.7 [2019-03-21]: Small enhancement to ste API to make it more flexible.
        
        * 1.5.6 [2019-03-16]: Suppress warnings while extracting exception message
        
        * 1.5.5 [2019-03-02]: Fixed bug affecting pytest-pmisc plugin
        
        * 1.5.4 [2019-03-01]: Abstracted package management to a lightweight framework
        
        * 1.5.3 [2019-02-25]: Package management updates
        
        * 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
        
Platform: any
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Development Status :: 5 - Production/Stable
Classifier: Natural Language :: English
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Topic :: Software Development :: Libraries :: Python Modules
