Helpful functions for Python

3.10.0 · active · verified Sat Apr 11

domdf-python-tools is a Python library providing a comprehensive collection of helpful functions and tools for various development tasks, encompassing utilities for strings, paths, dates, and more. It is actively maintained with a regular release cadence, primarily focusing on minor and patch updates. The current version is 3.10.0.

Warnings

breaking The license changed from LGPLv3+ to MIT License starting with version 3.0.0. Users upgrading from versions prior to 3.0.0 should be aware of this license change.
Fix: Review the MIT License for compliance if migrating from an LGPLv3+ licensed version.
gotcha The PyPI package name is `domdf-python-tools` (with hyphens), but the Python import name uses underscores: `domdf_python_tools`. This is a common pattern but can trip up new users.
Fix: Always use `import domdf_python_tools` or `from domdf_python_tools import ...` in your Python code after installing with `pip install domdf-python-tools`.
gotcha Some versions of `domdf-python-tools` (e.g., prior to a fix in Fedora's `3.9.0-7.fc43` package) have exhibited compatibility issues with newer Python versions, specifically Python 3.14, leading to `AssertionError` in tests related to string processing (e.g., `test_words.py::test_alpha_sort`).
Fix: Ensure you are using the latest available version of `domdf-python-tools` and check its release notes for explicit compatibility with the target Python version. If encountering issues with Python 3.14 or newer, consider checking for distribution-specific patches or reporting an upstream issue if using the latest library version.

Install

pip install domdf-python-tools Install with pip

Imports

true_str
```
from domdf_python_tools.utils import true_str
```
A utility function to convert string representations of truth to True or False.
StringList
```
from domdf_python_tools.stringlist import StringList
```
A subclass of list that supports custom delimiters in format strings.
PathPlus
```
from domdf_python_tools.paths import PathPlus
```
A subclass of pathlib.Path with additional methods and a default encoding of UTF-8.

Quickstart

This quickstart demonstrates key utilities from `domdf-python-tools`, including boolean string conversion, custom delimited lists, and extended `pathlib.Path` functionality.

from domdf_python_tools.utils import true_str
from domdf_python_tools.stringlist import StringList
from domdf_python_tools.paths import PathPlus
import os

# Using a utility function
print(f"Converting 'True' to boolean: {true_str('True')}")
print(f"Converting 'false' to boolean: {true_str('false')}")

# Using StringList for custom delimited output
my_list = StringList([1, 2, 3], delimiter="|")
print(f"Custom delimited list: {my_list}")

# Using PathPlus for extended path operations
current_dir = PathPlus(os.getcwd())
print(f"Current directory path (PathPlus): {current_dir}")
print(f"Is current directory a directory? {current_dir.is_dir()}")

view raw JSON →