Python Utils

3.9.1 · active · verified Sun Mar 29

Python Utils is a module with convenient utilities not included with the standard Python install. It offers a collection of functions and classes for common patterns, including decorators, converters, formatters, and data structures like `UniqueList` and `SlicableDeque`. The library is actively maintained with frequent releases, currently at version 3.9.1.

Warnings

gotcha When migrating from `python-utils` v2.x.x (Python 2 compatible) to v3.x.x (Python 3+), note that v3.x.x explicitly requires Python 3.9 or higher and has no other external dependencies. Compatibility with Python 2 requires the `six` package and older library versions.
Fix: Ensure your project is running on Python 3.9+ for `python-utils` v3.x.x. If using older Python 3 versions, you might need older `python-utils` releases and potentially address `typing-extensions` compatibility if encountering type-hinting issues.
gotcha Avoid incorrect top-level imports like `import utils`. The correct package name is `python_utils`, and you should import specific classes, functions, or submodules from `python_utils` (e.g., `from python_utils import UniqueList` or `from python_utils.converters import to_int`).
Fix: Always use `import python_utils` or `from python_utils import <symbol>` / `from python_utils.<submodule> import <symbol>`.
gotcha In `v3.8.2`, a fix was introduced for `fromtimestamp` overflow issues on Windows, where it previously raised a `ValueError` but can now also raise an `OSError`. This might affect code handling timestamp conversions.
Fix: Upgrade to `v3.8.2` or higher and ensure your code handles both `ValueError` and `OSError` when working with `datetime.fromtimestamp` and potentially large or invalid timestamp values, especially on Windows.

Install

pip install python-utils Install latest version

Imports

UniqueList
```
from python_utils import UniqueList
```
SlicableDeque
```
from python_utils import SlicableDeque
```
to_int
```
from python_utils.converters import to_int
```
While some top-level imports exist, importing from specific submodules like `converters` is clearer and often recommended if the symbol is not directly exposed at the top level or to avoid name collisions. The documentation shows examples of both direct and submodule imports.
listify
```
from python_utils.decorators import listify
```
Importing from specific submodules like `decorators` is clearer and often recommended, though some functions might be exposed at the top-level for convenience.
Logged
```
from python_utils.logger import Logged
```
Importing logging utilities from the `logger` submodule ensures clarity.

Quickstart

This quickstart demonstrates how to use the `to_int` converter to safely extract integers from strings and the `listify` decorator to convert generator output into a list.

from python_utils.converters import to_int
from python_utils.decorators import listify

# Convert a string to an integer, with a default if conversion fails
num = to_int('spam15eggs')
print(f"Converted 'spam15eggs' to {num}")

default_num = to_int('spam', default=1)
print(f"Converted 'spam' with default to {default_num}")

# Use a decorator to automatically convert a generator to a list
@listify()
def generate_numbers():
    yield 1
    yield 2
    yield 3

my_list = generate_numbers()
print(f"Generator output as a list: {my_list}")

view raw JSON →