8000 GH-101112: Add "pattern language" section to pathlib docs by barneygale · Pull Request #114030 · python/cpython · GitHub
[go: up one dir, main page]
Skip to content

GH-101112: Add "pattern language" section to pathlib docs #114030

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

Merged
merged 18 commits into from
Feb 26, 2024
Merged

GH-101112: Add "pattern language" section to pathlib docs #114030

Changes from 1 commit
Commits
Show all changes
18 commits
Select commit Hold shift + click to select a range
db927ea
GH-101112: Add "pattern language" section to pathlib docs
barneygale Jan 13, 2024
fbe11f3
Delete news entry
barneygale Jan 16, 2024
aa94135
Simplify presentation.
barneygale Jan 26, 2024
3a0b6ce
Merge branch 'main' into gh-101112
barneygale Jan 26, 2024
9fe2866
Convert to table, add examples.
barneygale Jan 26, 2024
42a75b8
Fix broken table.
barneygale Jan 26, 2024
44face0
Final tweaks
barneygale Jan 26, 2024
23d4a3f
Reword note on `**`, move paragraph on escaping wildcards up.
barneygale Jan 27, 2024
406cf4d
Explain trailing slash handling.
barneygale Jan 30, 2024
d33037d
Merge branch 'main' into gh-101112
barneygale Jan 30, 2024
b60970b
Move language change notices into new section.
barneygale Jan 30, 2024
7caf247
Soften note about trailing slashes.
barneygale Jan 30, 2024
5311f45
Use definition list for wildcards, similar to `re` docs.
barneygale Feb 10, 2024
1461d8b
Add "comparison to the glob module" section
barneygale Feb 12, 2024
fb20b5c
Remove duplicated text
barneygale Feb 12, 2024
d7e6ed1
Address review feedback
barneygale Feb 25, 2024
ec80126
Clarifications
barneygale Feb 26, 2024
5cc4894
Missed edit.
barneygale Feb 26, 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
Prev Previous commit
Next Next commit
Convert to table, add examples.
  • Loading branch information
@barneygale
barneygale committed Jan 26, 2024
commit 9fe2866c22a8328b3708ec80ccb67e804400e9be
32 changes: 20 additions & 12 deletions Doc/library/pathlib.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1634,22 +1634,30 @@ Pattern language
The following wildcards are supported in patterns for
:meth:`~PurePath.full_match`, :meth:`~Path.glob` and :meth:`~Path.rglob`:

"``**``" (standalone segment)
Matches any number of file or directory segments.
"``*``" (standalone segment)
Matches one non-empty file or directory segment.
"``*``" (otherwise)
Matches any number of non-separator characters.
"``?``"
Matches one non-separator character.
"``[seq]``"
Matches one character in *seq*.
"``[!seq]``"
Matches one character not in *seq*.
========================= ===========================================
Wildcard Matches
========================= ===========================================
"``**``" (full segment) Any number of file or directory segments.
"``*``" (full segment) One file or directory segment.
"``*``" (otherwise) Any number of non-separator characters.
"``?``" One non-separator character.
"``[seq]``" One character in *seq*.
"``[!seq]``" One character not in *seq*.
========================= ===========================================

For a literal match, wrap the meta-characters in brackets.
For example, ``"[?]"`` matches the character ``"?"``.

The "``**``" wildcard enables recursive globbing:

========================= ===========================================
Pattern Meaning
========================= ===========================================
``"**/*"`` Any path with at least one segment.
``"**/*.py"`` Any path with a final segment ending ``".py"``.
``"assets/**"`` Any path starting with ``"assets/"``.
``"assets/**/*"`` Any path starting with ``"assets/"``, excluding ``"assets/"`` itself.


Correspondence to tools in the :mod:`os` module
-----------------------------------------------
Expand Down
0