"fnmatch" --- Unix のファイル名パターンマッチ
*********************************************

**ソースコード:** Lib/fnmatch.py

======================================================================

このモジュールは Unix のシェル形式のワイルドカードに対応しています。こ
れらは、 ("re" モジュールでドキュメント化されている) 正規表現とは *異
なります* 。シェル形式のワイルドカードで使われる特殊文字は、次のとおり
です。

+--------------+--------------------------------------+
| Pattern      | 意味                                 |
|==============|======================================|
| "*"          | すべてにマッチします                 |
+--------------+--------------------------------------+
| "?"          | 任意の一文字にマッチします           |
+--------------+--------------------------------------+
| "[seq]"      | *seq* にある任意の文字にマッチします |
+--------------+--------------------------------------+
| "[!seq]"     | *seq* にない任意の文字にマッチします |
+--------------+--------------------------------------+

リテラルにマッチさせるには、メタ文字を括弧に入れてください。例えば、
"'[?]'" は文字 "'?'" にマッチします。

ファイル名の区切り文字 (Unixでは "'/'") はこのモジュールに固有なもので
は *ない* ことに注意してください。パス名展開については、 "glob" モジュ
ールを参照してください ("glob" はパス名の部分にマッチさせるのに
"filter()" を使っています)。同様に、ピリオドで始まるファイル名はこのモ
ジュールに固有ではなくて、 "*" と "?" のパターンでマッチします。

Unless stated otherwise, "filename string" and "pattern string" either
refer to "str" or "ISO-8859-1" encoded "bytes" objects. Note that the
functions documented below do not allow to mix a "bytes" pattern with
a "str" filename, and vice-versa.

Finally, note that "functools.lru_cache()" with a *maxsize* of 32768
is used to cache the (typed) compiled regex patterns in the following
functions: "fnmatch()", "fnmatchcase()", "filter()", "filterfalse()".

fnmatch.fnmatch(name, pat)

   ファイルの文字列 *name* がパターン文字列 *pat* にマッチするかテスト
   して、 "True" または "False" のいずれかを返します。どちらの引数とも
   "os.path.normcase()" を使って、大文字、小文字が正規化されます。オペ
   レーティングシステムが標準でどうなっているかに関係なく、大文字、小
   文字を区別して比較する場合には、 "fnmatchcase()" が使用できます。

   次の例では、カレントディレクトリにある、拡張子が ".txt" である全て
   のファイルを表示しています:

      import fnmatch
      import os

      for file in os.listdir('.'):
          if fnmatch.fnmatch(file, '*.txt'):
              print(file)

fnmatch.fnmatchcase(name, pat)

   ファイル名の文字列 *name* がパターン文字列 *pat* にマッチするかテス
   トして、 "True" または "False" を返します。比較は大文字、小文字を区
   別し、 "os.path.normcase()" は適用しません。

fnmatch.filter(names, pat)

   Construct a list from those elements of the *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.

fnmatch.filterfalse(names, pat)

   Construct a list from those elements of the *iterable* of filename
   strings *names* that do not match the pattern string *pat*. It is
   the same as "[n for n in names if not fnmatch(n, pat)]", but
   implemented more efficiently.

   Added in version 3.14.

fnmatch.translate(pat)

   Return the shell-style pattern *pat* converted to a regular
   expression for using with "re.prefixmatch()". The pattern is
   expected to be a "str".

   例:

   >>> import fnmatch, re
   >>>
   >>> regex = fnmatch.translate('*.txt')
   >>> regex
   '(?s:.*\\.txt)\\z'
   >>> reobj = re.compile(regex)
   >>> reobj.prefixmatch('foobar.txt')
   <re.Match object; span=(0, 10), match='foobar.txt'>

参考:

  "glob" モジュール
     Unix シェル形式のパス展開。
