mirror of
https://github.com/python/cpython.git
synced 2026-02-05 09:25:35 +00:00
[3.13] gh-123345: improve fnmatch docs (GH-123346) (#128776)
gh-123345: improve `fnmatch` docs (GH-123346)
(cherry picked from commit 29fe8072cf)
Co-authored-by: Bénédikt Tran <10796600+picnixz@users.noreply.github.com>
This commit is contained in:
parent
33c0ba0ead
commit
05bd6cbe61
1 changed files with 12 additions and 6 deletions
|
|
@ -46,9 +46,15 @@ module. See module :mod:`glob` for pathname expansion (:mod:`glob` uses
|
|||
a period are not special for this module, and are matched by the ``*`` and ``?``
|
||||
patterns.
|
||||
|
||||
Also note that :func:`functools.lru_cache` with the *maxsize* of 32768 is used to
|
||||
cache the compiled regex patterns in the following functions: :func:`fnmatch`,
|
||||
:func:`fnmatchcase`, :func:`.filter`.
|
||||
Unless stated otherwise, "filename string" and "pattern string" either refer to
|
||||
:class:`str` or ``ISO-8859-1`` encoded :class:`bytes` objects. Note that the
|
||||
functions documented below do not allow to mix a :class:`!bytes` pattern with
|
||||
a :class:`!str` filename, and vice-versa.
|
||||
|
||||
Finally, note that :func:`functools.lru_cache` with a *maxsize* of 32768
|
||||
is used to cache the (typed) compiled regex patterns in the following
|
||||
functions: :func:`fnmatch`, :func:`fnmatchcase`, :func:`.filter`.
|
||||
|
||||
|
||||
.. function:: fnmatch(name, pat)
|
||||
|
||||
|
|
@ -78,8 +84,8 @@ cache the compiled regex patterns in the following functions: :func:`fnmatch`,
|
|||
|
||||
.. function:: filter(names, pat)
|
||||
|
||||
Construct a list from those elements of the :term:`iterable` *names*
|
||||
that match pattern *pat*.
|
||||
Construct a list from those elements of the :term:`iterable` of filename
|
||||
strings *names* that match the pattern string *pat*.
|
||||
It is the same as ``[n for n in names if fnmatch(n, pat)]``,
|
||||
but implemented more efficiently.
|
||||
|
||||
|
|
@ -87,7 +93,7 @@ cache the compiled regex patterns in the following functions: :func:`fnmatch`,
|
|||
.. function:: translate(pat)
|
||||
|
||||
Return the shell-style pattern *pat* converted to a regular expression for
|
||||
using with :func:`re.match`.
|
||||
using with :func:`re.match`. The pattern is expected to be a :class:`str`.
|
||||
|
||||
Example:
|
||||
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue