flake8-use-pathlib

0.3.0 · active · verified Wed Apr 15

flake8-use-pathlib is a plugin for the Flake8 linter that identifies patterns in Python code where functions from the `os.path` module (and other `os` functions) can be replaced by a more modern, object-oriented approach using the `pathlib` module. It helps developers write cleaner, more consistent, and cross-platform compatible code for file system operations. The current version is 0.3.0, released in August 2022, and it is actively maintained, with its rules also integrated into linters like Ruff.

Warnings

breaking The package was previously named `flake8-pathlib`. Users should ensure they are installing `flake8-use-pathlib` as the former name is deprecated and no longer updated.
Fix: Use `pip install flake8-use-pathlib` instead of `pip install flake8-pathlib`.
gotcha While `pathlib` generally improves code, converting `Path` objects to `str` too early, e.g., `open(str(my_path))`, negates `pathlib`'s benefits. Python's `open()` (since 3.6) and most modern libraries natively accept `Path` objects.
Fix: Pass `Path` objects directly to functions that accept them (e.g., `open(my_path)`). Only convert to `str` if a function strictly requires it and does not support `os.PathLike` objects.
gotcha Some autofixes derived from `flake8-use-pathlib` rules (e.g., for `os.path.expanduser` to `Path.expanduser`) are considered 'unsafe' because `os.path` and `pathlib.Path` methods can have subtly different behaviors (e.g., error handling) or return types.
Fix: Always review and test code after applying autofixes, especially those marked as potentially unsafe, to ensure functionality is preserved.
gotcha Using `pathlib` can sometimes be less performant than lower-level `os` module alternatives, especially on older Python versions or in performance-critical sections of code.
Fix: For highly performance-sensitive operations, consider benchmarking `pathlib` against `os` module functions. For most typical file operations, `pathlib`'s benefits in readability and maintainability outweigh minor performance differences.
gotcha Flake8's configuration file discovery changed in version 5.0.0. Configuration in `~/.flake8` is explicitly ignored for global settings.
Fix: Ensure project-specific configurations are placed in `setup.cfg`, `tox.ini`, or `.flake8` within the project root, rather than relying on global `~/.flake8` settings for `flake8-use-pathlib` rules.

Install

pip install flake8-use-pathlib Install stable version

Quickstart

After installation, `flake8-use-pathlib` automatically integrates with `flake8`. Simply run `flake8` on your Python files or project, and it will report issues where `os.path` functions can be replaced with `pathlib` equivalents, using 'PL' error codes.

# 1. Install flake8-use-pathlib (if you haven't already)
# pip install flake8 flake8-use-pathlib

# 2. Create a Python file, e.g., my_app.py, with some os.path usage:
# import os
#
# def get_absolute_path(filename):
#     return os.path.abspath(filename)
#
# def list_directory(path):
#     return os.listdir(path)
#
# print(get_absolute_path('file.txt'))
# print(list_directory('.'))

# 3. Run flake8 from your terminal in the directory containing my_app.py:
# flake8 my_app.py

# Expected output (or similar, depending on flake8 version and other plugins):
# my_app.py:4:12: PL100 os.path.abspath("filename") should be replaced by filename_path.resolve() (os-path-abspath)
# my_app.py:7:12: PL208 os.listdir(path) should be replaced by path_obj.iterdir() (os-listdir)

view raw JSON →