Path utilities for Python

Warnings

• breaking The `pathtools` library is incompatible with Python 3.12 and newer versions due to its reliance on the removed `imp` module in its `setup.py`.
  Fix: There is no official fix from the maintainer. Consider replacing `pathtools` with `pathlib` for modern Python development or using a vendored/patched version if absolutely necessary.
• deprecated The `pathtools` project appears to be unmaintained, with the last commit over 10 years ago and no new releases since 2011. For new projects, the built-in `pathlib` module (available since Python 3.4) offers a more modern, object-oriented, and actively maintained alternative for path manipulation.
  Fix: Migrate to `pathlib` for robust and future-proof path handling. Projects like `watchdog` have already replaced `pathtools` with `pathlib`.
• gotcha The library's functionality is limited compared to modern alternatives like `pathlib`. It lacks features such as direct path object manipulation, platform-independent path construction (beyond basic separators), and integration with asynchronous operations.
  Fix: Evaluate `pathlib` for more comprehensive and idiomatic Pythonic path operations. For specific advanced use cases, other specialized libraries might be more suitable.

Install

• pip install pathtools PyPI

Imports

• filter_paths

  from pathtools.patterns import filter_paths

• match_path

  from pathtools.patterns import match_path

• absolute_path

  from pathtools.path import absolute_path

Quickstart

This example demonstrates how to use `filter_paths` from `pathtools.patterns` to filter a list of file paths based on inclusion and exclusion patterns.

import os
from pathtools.patterns import filter_paths

# Create some dummy files for demonstration
os.makedirs("temp_dir", exist_ok=True)
with open("temp_dir/file1.txt", "w") as f: f.write("test")
with open("temp_dir/image.png", "w") as f: f.write("test")
with open("temp_dir/document.pdf", "w") as f: f.write("test")

all_paths = [
    "temp_dir/file1.txt",
    "temp_dir/image.png",
    "temp_dir/document.pdf",
    "temp_dir/another.txt",
    "ignore_me.log"
]

# Filter paths to include only .txt files and exclude 'ignore_me.log'
included_patterns = ['*.txt']
excluded_patterns = ['*ignore_me.log']

filtered = filter_paths(all_paths, included_patterns, excluded_patterns)
print(list(filtered))

# Clean up
os.remove("temp_dir/file1.txt")
os.remove("temp_dir/image.png")
os.remove("temp_dir/document.pdf")
os.rmdir("temp_dir")