Skip to content

Execute a python module or function and log all calls and locals to formats that can be compared for execution variations.

License

Notifications You must be signed in to change notification settings

pyruncompare-dev/pyruncompare

pyruncompare

Azure Status Travis Status Appveyor Status PyPI version Python Versions PyPI downloads per month Documentation Status Coverage Status Black

Execute a python module or function and log all calls and locals to formats that can be compared for execution variations.

This allows programmatic inspection looking for common mistakes in the variables, the specific example that inspired this project was looking for python 2to3 issues to do with python byte strings being handled incorrectly. By logging all primitive typed local variables, these could be scanned for the appearance of "b'...." or 'b"....' that signified a string representation of a byte sequence.

Execution

pyruncompare supports a nested module runner system to inject itself into tracing, e.g.

python -m pyruncompare -m cookiecutter

Can be used to trace an execution of the cookiecutter main module execution.

More details can be found in the Online Documentation.

Installation

You can install pyruncompare for Python via pip from PyPI.

$ pip install pyruncompare

Prerequisites:

  • docopt
  • six

Download from PyPI.org

https://pypi.org/project/pyruncompare/

Contributing

Contributions are very welcome, consider using the file an issue to discuss the work before beginning, but if you already have a Pull Request ready then this is no problem, please submit it and it will be very gratefully considered. The Contribution Guidelines outlines the pyruncompare commitment to ensuring all contributions receive appropriate recognition.

License

Distributed under the terms of the GPLv3 license, "pyruncompare" is free and open source software

Issues

If you encounter any problems, please file an issue along with a detailed description.

Additional Documentation:

About

Execute a python module or function and log all calls and locals to formats that can be compared for execution variations.

Resources

License

Code of conduct

Contributing

Security policy

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published