pyutils (haaksmash)

1.0.2 · active · verified Sun Apr 12

A grab-bag of utility functions and objects for Python, developed by haaksmash. This library provides common, oft-repeated functionalities across various modules like enums, math, dictionaries, lists, booleans, dates, and objects. It is currently at version 1.0.2 and appears to have a stable, though not rapid, release cadence.

Warnings

gotcha When defining enums using `utils.enum.Enum` with `Options.frozen = True`, enum members become immutable. Attempting to reassign a value to an enum member (e.g., `Colors.RED = 2`) will raise a `TypeError`.
Fix: Respect the immutability of frozen enum members. If mutability is required, set `frozen = False` in the `Options` class or avoid using the `frozen` option.
gotcha Due to the generic name 'utils', there is a potential for import conflicts with other packages that might define a 'utils' module or with local project modules also named 'utils'.
Fix: Be explicit with imports (e.g., `from utils import enum` instead of `import utils` if only specific submodules are needed). Consider importing with an alias (e.g., `import utils as haak_utils`) in projects with potential name clashes.
deprecated The GitHub repository's last significant commit was over a year ago, suggesting the library may be in maintenance mode with infrequent updates. Users should verify active development if new features or urgent bug fixes are critical.
Fix: Monitor the GitHub repository for any new releases or activity. Consider contributing fixes or new features if critical to your project, or explore actively maintained alternatives if the lack of updates becomes an issue.

Install

pip install utils Install stable version

Imports

enum
```
from utils import enum
```
Imports the custom Enum implementation.
TimePeriod
```
from utils.dates import TimePeriod
```
Imports the TimePeriod class for date range manipulation.
flatten
```
from utils.lists import flatten
```
Example of importing a specific utility function from a submodule.

Quickstart

This quickstart demonstrates the core functionality of the `enum` module for creating robust enumerations and the `TimePeriod` class from the `dates` module for handling date ranges. It showcases how to define an enum with options like `frozen` and `strict`, and how to check if a date falls within a defined time period.

from datetime import date
from utils import enum
from utils.dates import TimePeriod

class Colors(enum.Enum):
    RED = 0
    GREEN = 1

# Defining an Enum class allows you to specify a few
# things about the way it's going to behave.
class Options:
    frozen = True # can't change attributes
    strict = True # can only compare to itself

# Usage of Enum
print(f"Red enum: {Colors.RED}")
print(f"Is Colors.RED == 0? {Colors.RED == 0}")

# Usage of TimePeriod
time_period = TimePeriod(date(2023, 1, 1), date(2023, 1, 31))
print(f"Time period: {time_period}")
print(f"Is 2023-01-15 in period? {date(2023, 1, 15) in time_period}")

view raw JSON →