PyMiscUtils

0.3.14 · active · verified Sun Apr 12

PyMiscUtils (installed via `pip install pymiscutils`) provides a collection of miscellaneous Python utilities, including context managers like `Timer` and `Suppressor`, a `NestedParser` for string parsing, and various helper classes for introspection, environment variables, and version management. The library is currently at version 0.3.14 and is under active development with frequent minor releases, though the API is subject to change.

Warnings

breaking The library is explicitly stated as being under active development, and its API is subject to significant changes that may break existing code in future versions. Use with caution in production environments where API stability is critical.
Fix: Regularly check the GitHub repository for updates and review release notes for breaking changes. Pin your dependency version in `requirements.txt` to mitigate unexpected issues: `pymiscutils==0.3.14`.
gotcha The PyPI package name is `pymiscutils`, but the actual top-level Python import package is `miscutils`. Attempting to `import pymiscutils` will result in an `ModuleNotFoundError`.
Fix: Always use `import miscutils` or `from miscutils...` when importing components from this library after installation with `pip install pymiscutils`.
gotcha Many useful classes and functions are nested within specific submodules (e.g., `miscutils.context_managers`, `miscutils.string_manipulation`, `miscutils.system`). Direct imports from `miscutils` for these specific components will often fail.
Fix: Consult the GitHub README or source code to determine the correct submodule path for the specific utility you intend to import. For example, use `from miscutils.context_managers import Timer` instead of `from miscutils import Timer`.

Install

pip install pymiscutils Install PyMiscUtils

Imports

Timer
```
from miscutils.context_managers import Timer
```
The installed PyPI package `pymiscutils` exposes its functionality under the `miscutils` top-level package name.
NestedParser
```
from miscutils.string_manipulation import NestedParser
```
Most utilities are organized into specific submodules, not directly under the `miscutils` package.

EnvironmentVariables

from miscutils.system import EnvironmentVariables

Quickstart

This example demonstrates using the `Timer` context manager to measure the execution time of a function. The `Timer` will print the elapsed time upon exiting the `with` block.

import time
from miscutils.context_managers import Timer

def long_running_task():
    print("Starting a long task...")
    time.sleep(1.5)
    print("Task finished.")

with Timer('My Task'):
    long_running_task()

view raw JSON →