Skip to content

fnmatch: support pathlib #12522

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 4 commits into from
Closed

fnmatch: support pathlib #12522

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
ee6b34b
fnmatch: support pathlib
adamjstewart Aug 13, 2024
e8a28e4
Use builtin GenericPath stub
adamjstewart Aug 13, 2024
f0c032e
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] Aug 13, 2024
d5b4b4c
Don't forget import
adamjstewart Aug 13, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 4 additions & 3 deletions stdlib/fnmatch.pyi
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,10 @@
from _typeshed import GenericPath
from collections.abc import Iterable
from typing import AnyStr

__all__ = ["filter", "fnmatch", "fnmatchcase", "translate"]

def fnmatch(name: AnyStr, pat: AnyStr) -> bool: ...
def fnmatchcase(name: AnyStr, pat: AnyStr) -> bool: ...
def filter(names: Iterable[AnyStr], pat: AnyStr) -> list[AnyStr]: ...
def fnmatch(name: GenericPath[AnyStr], pat: AnyStr) -> bool: ...
def fnmatchcase(name: GenericPath[AnyStr], pat: AnyStr) -> bool: ...
Copy link
Member

@JelleZijlstra JelleZijlstra Aug 22, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This doesn't work

>>> import fnmatch
>>> from pathlib import Path
>>> fnmatch.fnmatchcase(Path("hi"), "x")
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
  File "/Users/jelle/Library/Application Support/uv/python/cpython-3.8.19-macos-aarch64-none/lib/python3.8/fnmatch.py", line 71, in fnmatchcase
    return match(name) is not None
TypeError: expected string or bytes-like object

The other functions do currently work with paths, but I'm not sure we should change the stubs; it feels accidental, and the module documentation talks about "path strings".

Copy link
Collaborator

@hauntsaninja hauntsaninja Aug 22, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Another reason to not accept Paths: pathlib's trailing slash normalisation can also be undesirable in fnmatch like situations, e.g. Black has had bugs because of this kind of thing

def filter(names: Iterable[GenericPath[AnyStr]], pat: AnyStr) -> list[AnyStr]: ...
def translate(pat: str) -> str: ...