summaryrefslogtreecommitdiffstats
path: root/Doc/library/fnmatch.rst
diff options
context:
space:
mode:
authorGeorg Brandl <georg@python.org>2007-08-15 14:28:22 (GMT)
committerGeorg Brandl <georg@python.org>2007-08-15 14:28:22 (GMT)
commit116aa62bf54a39697e25f21d6cf6799f7faa1349 (patch)
tree8db5729518ed4ca88e26f1e26cc8695151ca3eb3 /Doc/library/fnmatch.rst
parent739c01d47b9118d04e5722333f0e6b4d0c8bdd9e (diff)
downloadcpython-116aa62bf54a39697e25f21d6cf6799f7faa1349.zip
cpython-116aa62bf54a39697e25f21d6cf6799f7faa1349.tar.gz
cpython-116aa62bf54a39697e25f21d6cf6799f7faa1349.tar.bz2
Move the 3k reST doc tree in place.
Diffstat (limited to 'Doc/library/fnmatch.rst')
-rw-r--r--Doc/library/fnmatch.rst91
1 files changed, 91 insertions, 0 deletions
diff --git a/Doc/library/fnmatch.rst b/Doc/library/fnmatch.rst
new file mode 100644
index 0000000..244bad9
--- /dev/null
+++ b/Doc/library/fnmatch.rst
@@ -0,0 +1,91 @@
+
+:mod:`fnmatch` --- Unix filename pattern matching
+=================================================
+
+.. module:: fnmatch
+ :synopsis: Unix shell style filename pattern matching.
+
+
+.. index:: single: filenames; wildcard expansion
+
+.. index:: module: re
+
+This module provides support for Unix shell-style wildcards, which are *not* the
+same as regular expressions (which are documented in the :mod:`re` module). The
+special characters used in shell-style wildcards are:
+
++------------+------------------------------------+
+| Pattern | Meaning |
++============+====================================+
+| ``*`` | matches everything |
++------------+------------------------------------+
+| ``?`` | matches any single character |
++------------+------------------------------------+
+| ``[seq]`` | matches any character in *seq* |
++------------+------------------------------------+
+| ``[!seq]`` | matches any character not in *seq* |
++------------+------------------------------------+
+
+.. index:: module: glob
+
+Note that the filename separator (``'/'`` on Unix) is *not* special to this
+module. See module :mod:`glob` for pathname expansion (:mod:`glob` uses
+:func:`fnmatch` to match pathname segments). Similarly, filenames starting with
+a period are not special for this module, and are matched by the ``*`` and ``?``
+patterns.
+
+
+.. function:: fnmatch(filename, pattern)
+
+ Test whether the *filename* string matches the *pattern* string, returning true
+ or false. If the operating system is case-insensitive, then both parameters
+ will be normalized to all lower- or upper-case before the comparison is
+ performed. If you require a case-sensitive comparison regardless of whether
+ that's standard for your operating system, use :func:`fnmatchcase` instead.
+
+ This example will print all file names in the current directory with the
+ extension ``.txt``::
+
+ import fnmatch
+ import os
+
+ for file in os.listdir('.'):
+ if fnmatch.fnmatch(file, '*.txt'):
+ print file
+
+
+.. function:: fnmatchcase(filename, pattern)
+
+ Test whether *filename* matches *pattern*, returning true or false; the
+ comparison is case-sensitive.
+
+
+.. function:: filter(names, pattern)
+
+ Return the subset of the list of *names* that match *pattern*. It is the same as
+ ``[n for n in names if fnmatch(n, pattern)]``, but implemented more efficiently.
+
+ .. versionadded:: 2.2
+
+
+.. function:: translate(pattern)
+
+ Return the shell-style *pattern* converted to a regular expression.
+
+ Example::
+
+ >>> import fnmatch, re
+ >>>
+ >>> regex = fnmatch.translate('*.txt')
+ >>> regex
+ '.*\\.txt$'
+ >>> reobj = re.compile(regex)
+ >>> print reobj.match('foobar.txt')
+ <_sre.SRE_Match object at 0x...>
+
+
+.. seealso::
+
+ Module :mod:`glob`
+ Unix shell-style path expansion.
+