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

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


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

Pattern

意味

*

すべてにマッチします

?

任意の一文字にマッチします

[seq]

seq にある任意の文字にマッチします

[!seq]

seq にない任意の文字にマッチします

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

ファイル名の区切り文字 (Unix では '/') は、このモジュールでは特別扱い されません。 パス名の展開については glob モジュールを参照してください (glob はパス名の各部分の照合に filter() を使います)。 同様に、ピリオドで始まるファイル名も特別扱いされず、* や ? のパターンにマッチします。

特に断りがなければ、「ファイル名文字列」と「パターン文字列」は str または ISO-8859-1 でエンコードされた bytes オブジェクトを指します。 以下の関数では、bytes のパターンと str のファイル名を混在させることはできず、その逆も同様です。

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().

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)

ファイル名文字列の イテラブル names のうち、パターン文字列 pat にマッチする要素からリストを作成します。 [n for n in names if fnmatch(n, pat)] と同じですが、より効率的に実装されています。

fnmatch.translate(pat)

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

例:

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

参考

glob モジュール

Unix シェル形式のパス展開。