Provides a wide range of useful classes and functions.
This library is currently still under development. The API will likely undergo significant changes that may break any code you write with it. The documentation will fall out of sync with the updates regularly until development slows down. Use it at your own risk.
Provides a wide range of useful classes and functions:
NestedParser
classSysTrayApp
hides the console and runs a system tray app which can have its options customized with callbacksTimer
counts the time since it was instanciated, and prints it on exiting contextSuppressor
supresses all console output and warnings on enter and resores it on exitingPrintRedirector
redirects stdout to a given fileNullContext
will always return itself on attribute access or when called, and does nothing when used as a context manager or when attributes are set on itCounter
is an object-oriented replacement for manipulating an integer var for iteration purposesWhoCalledMe
can be dropped in to print out the call stackEnvironmentVariables
can be used on Windows to get and set environment variables permanentlyBeep
produces a beeping sound of variable duration on WindowsVersion
object to represent versions, with comparator magic methods and wildcard supportis_running_in_ipython
returns True
if in an ipython session, else False
issubclass_safe
is a version of the built-in issubclass
that doesn't raise an error if the candidate is an instance rather than a class, just returns False
To install use pip:
$ pip install pymiscutils
Or clone the repo:
$ git clone https://github.com/matthewgdv/miscutils.git
$ python setup.py install
Usage examples coming soon.
Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given.
You can contribute in many ways:
Report bugs at https://github.com/matthewgdv/miscutils/issues
If you are reporting a bug, please include:
Look through the GitHub issues for bugs. Anything tagged with "bug" and "help wanted" is open to whoever wants to implement a fix for it.
Look through the GitHub issues for features. Anything tagged with "enhancement" and "help wanted" is open to whoever wants to implement it.
The repository could always use more documentation, whether as part of the official docs, in docstrings, or even on the web in blog posts, articles, and such.
The best way to send feedback is to file an issue at https://github.com/matthewgdv/miscutils/issues.
If you are proposing a new feature:
Before you submit a pull request, check that it meets these guidelines:
If the pull request adds functionality, it should include tests and the docs should be updated. Write docstrings for any functions that are part of the external API, and add the feature to the README.md.
If the pull request fixes a bug, tests should be added proving that the bug has been fixed. However, no update to the docs is necessary for bugfixes.
The pull request should work for the newest version of Python (currently 3.7). Older versions may incidentally work, but are not officially supported.
Inline type hints should be used, with an emphasis on ensuring that introspection and autocompletion tools such as Jedi are able to understand the code wherever possible.
PEP8 guidelines should be followed where possible, but deviations from it where it makes sense and improves legibility are encouraged. The following PEP8 error codes can be safely ignored: E121, E123, E126, E226, E24, E704, W503
This repository intentionally disallows the PEP8 79-character limit. Therefore, any contributions adhering to this convention will be rejected. As a rule of thumb you should endeavor to stay under 200 characters except where going over preserves alignment, or where the line is mostly non-algorythmic code, such as extremely long strings or function calls.