|
|
|
|
|
<!DOCTYPE html>
|
|
|
|
|
|
<html xmlns="http://www.w3.org/1999/xhtml">
|
|
|
<head>
|
|
|
<meta charset="utf-8" />
|
|
|
<title>fnmatch — Unix filename pattern matching — Python 3.7.4 documentation</title>
|
|
|
<link rel="stylesheet" href="../_static/pydoctheme.css" type="text/css" />
|
|
|
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
|
|
|
|
|
|
<script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
|
|
|
<script type="text/javascript" src="../_static/jquery.js"></script>
|
|
|
<script type="text/javascript" src="../_static/underscore.js"></script>
|
|
|
<script type="text/javascript" src="../_static/doctools.js"></script>
|
|
|
<script type="text/javascript" src="../_static/language_data.js"></script>
|
|
|
|
|
|
<script type="text/javascript" src="../_static/sidebar.js"></script>
|
|
|
|
|
|
<link rel="search" type="application/opensearchdescription+xml"
|
|
|
title="Search within Python 3.7.4 documentation"
|
|
|
href="../_static/opensearch.xml"/>
|
|
|
<link rel="author" title="About these documents" href="../about.html" />
|
|
|
<link rel="index" title="Index" href="../genindex.html" />
|
|
|
<link rel="search" title="Search" href="../search.html" />
|
|
|
<link rel="copyright" title="Copyright" href="../copyright.html" />
|
|
|
<link rel="next" title="linecache — Random access to text lines" href="linecache.html" />
|
|
|
<link rel="prev" title="glob — Unix style pathname pattern expansion" href="glob.html" />
|
|
|
<link rel="shortcut icon" type="image/png" href="../_static/py.png" />
|
|
|
<link rel="canonical" href="https://docs.python.org/3/library/fnmatch.html" />
|
|
|
|
|
|
<script type="text/javascript" src="../_static/copybutton.js"></script>
|
|
|
<script type="text/javascript" src="../_static/switchers.js"></script>
|
|
|
|
|
|
|
|
|
|
|
|
<style>
|
|
|
@media only screen {
|
|
|
table.full-width-table {
|
|
|
width: 100%;
|
|
|
}
|
|
|
}
|
|
|
</style>
|
|
|
|
|
|
|
|
|
</head><body>
|
|
|
|
|
|
<div class="related" role="navigation" aria-label="related navigation">
|
|
|
<h3>Navigation</h3>
|
|
|
<ul>
|
|
|
<li class="right" style="margin-right: 10px">
|
|
|
<a href="../genindex.html" title="General Index"
|
|
|
accesskey="I">index</a></li>
|
|
|
<li class="right" >
|
|
|
<a href="../py-modindex.html" title="Python Module Index"
|
|
|
>modules</a> |</li>
|
|
|
<li class="right" >
|
|
|
<a href="linecache.html" title="linecache — Random access to text lines"
|
|
|
accesskey="N">next</a> |</li>
|
|
|
<li class="right" >
|
|
|
<a href="glob.html" title="glob — Unix style pathname pattern expansion"
|
|
|
accesskey="P">previous</a> |</li>
|
|
|
<li><img src="../_static/py.png" alt=""
|
|
|
style="vertical-align: middle; margin-top: -1px"/></li>
|
|
|
<li><a href="https://www.python.org/">Python</a> »</li>
|
|
|
<li>
|
|
|
<span class="language_switcher_placeholder">en</span>
|
|
|
<span class="version_switcher_placeholder">3.7.4</span>
|
|
|
<a href="../index.html">Documentation </a> »
|
|
|
</li>
|
|
|
|
|
|
<li class="nav-item nav-item-1"><a href="index.html" >The Python Standard Library</a> »</li>
|
|
|
<li class="nav-item nav-item-2"><a href="filesys.html" accesskey="U">File and Directory Access</a> »</li>
|
|
|
<li class="right">
|
|
|
|
|
|
|
|
|
<div class="inline-search" style="display: none" role="search">
|
|
|
<form class="inline-search" action="../search.html" method="get">
|
|
|
<input placeholder="Quick search" type="text" name="q" />
|
|
|
<input type="submit" value="Go" />
|
|
|
<input type="hidden" name="check_keywords" value="yes" />
|
|
|
<input type="hidden" name="area" value="default" />
|
|
|
</form>
|
|
|
</div>
|
|
|
<script type="text/javascript">$('.inline-search').show(0);</script>
|
|
|
|
|
|
|
</li>
|
|
|
|
|
|
</ul>
|
|
|
</div>
|
|
|
|
|
|
<div class="document">
|
|
|
<div class="documentwrapper">
|
|
|
<div class="bodywrapper">
|
|
|
<div class="body" role="main">
|
|
|
|
|
|
<div class="section" id="module-fnmatch">
|
|
|
<span id="fnmatch-unix-filename-pattern-matching"></span><h1><a class="reference internal" href="#module-fnmatch" title="fnmatch: Unix shell style filename pattern matching."><code class="xref py py-mod docutils literal notranslate"><span class="pre">fnmatch</span></code></a> — Unix filename pattern matching<a class="headerlink" href="#module-fnmatch" title="Permalink to this headline">¶</a></h1>
|
|
|
<p><strong>Source code:</strong> <a class="reference external" href="https://github.com/python/cpython/tree/3.7/Lib/fnmatch.py">Lib/fnmatch.py</a></p>
|
|
|
<span class="target" id="index-0"></span><hr class="docutils" id="index-1" />
|
|
|
<p>This module provides support for Unix shell-style wildcards, which are <em>not</em> the
|
|
|
same as regular expressions (which are documented in the <a class="reference internal" href="re.html#module-re" title="re: Regular expression operations."><code class="xref py py-mod docutils literal notranslate"><span class="pre">re</span></code></a> module). The
|
|
|
special characters used in shell-style wildcards are:</p>
|
|
|
<table class="docutils align-center" id="index-2">
|
|
|
<colgroup>
|
|
|
<col style="width: 25%" />
|
|
|
<col style="width: 75%" />
|
|
|
</colgroup>
|
|
|
<thead>
|
|
|
<tr class="row-odd"><th class="head"><p>Pattern</p></th>
|
|
|
<th class="head"><p>Meaning</p></th>
|
|
|
</tr>
|
|
|
</thead>
|
|
|
<tbody>
|
|
|
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">*</span></code></p></td>
|
|
|
<td><p>matches everything</p></td>
|
|
|
</tr>
|
|
|
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">?</span></code></p></td>
|
|
|
<td><p>matches any single character</p></td>
|
|
|
</tr>
|
|
|
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">[seq]</span></code></p></td>
|
|
|
<td><p>matches any character in <em>seq</em></p></td>
|
|
|
</tr>
|
|
|
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">[!seq]</span></code></p></td>
|
|
|
<td><p>matches any character not in <em>seq</em></p></td>
|
|
|
</tr>
|
|
|
</tbody>
|
|
|
</table>
|
|
|
<p>For a literal match, wrap the meta-characters in brackets.
|
|
|
For example, <code class="docutils literal notranslate"><span class="pre">'[?]'</span></code> matches the character <code class="docutils literal notranslate"><span class="pre">'?'</span></code>.</p>
|
|
|
<p id="index-3">Note that the filename separator (<code class="docutils literal notranslate"><span class="pre">'/'</span></code> on Unix) is <em>not</em> special to this
|
|
|
module. See module <a class="reference internal" href="glob.html#module-glob" title="glob: Unix shell style pathname pattern expansion."><code class="xref py py-mod docutils literal notranslate"><span class="pre">glob</span></code></a> for pathname expansion (<a class="reference internal" href="glob.html#module-glob" title="glob: Unix shell style pathname pattern expansion."><code class="xref py py-mod docutils literal notranslate"><span class="pre">glob</span></code></a> uses
|
|
|
<a class="reference internal" href="#fnmatch.filter" title="fnmatch.filter"><code class="xref py py-func docutils literal notranslate"><span class="pre">filter()</span></code></a> to match pathname segments). Similarly, filenames starting with
|
|
|
a period are not special for this module, and are matched by the <code class="docutils literal notranslate"><span class="pre">*</span></code> and <code class="docutils literal notranslate"><span class="pre">?</span></code>
|
|
|
patterns.</p>
|
|
|
<dl class="function">
|
|
|
<dt id="fnmatch.fnmatch">
|
|
|
<code class="descclassname">fnmatch.</code><code class="descname">fnmatch</code><span class="sig-paren">(</span><em>filename</em>, <em>pattern</em><span class="sig-paren">)</span><a class="headerlink" href="#fnmatch.fnmatch" title="Permalink to this definition">¶</a></dt>
|
|
|
<dd><p>Test whether the <em>filename</em> string matches the <em>pattern</em> string, returning
|
|
|
<a class="reference internal" href="constants.html#True" title="True"><code class="xref py py-const docutils literal notranslate"><span class="pre">True</span></code></a> or <a class="reference internal" href="constants.html#False" title="False"><code class="xref py py-const docutils literal notranslate"><span class="pre">False</span></code></a>. Both parameters are case-normalized
|
|
|
using <a class="reference internal" href="os.path.html#os.path.normcase" title="os.path.normcase"><code class="xref py py-func docutils literal notranslate"><span class="pre">os.path.normcase()</span></code></a>. <a class="reference internal" href="#fnmatch.fnmatchcase" title="fnmatch.fnmatchcase"><code class="xref py py-func docutils literal notranslate"><span class="pre">fnmatchcase()</span></code></a> can be used to perform a
|
|
|
case-sensitive comparison, regardless of whether that’s standard for the
|
|
|
operating system.</p>
|
|
|
<p>This example will print all file names in the current directory with the
|
|
|
extension <code class="docutils literal notranslate"><span class="pre">.txt</span></code>:</p>
|
|
|
<div class="highlight-python3 notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">fnmatch</span>
|
|
|
<span class="kn">import</span> <span class="nn">os</span>
|
|
|
|
|
|
<span class="k">for</span> <span class="n">file</span> <span class="ow">in</span> <span class="n">os</span><span class="o">.</span><span class="n">listdir</span><span class="p">(</span><span class="s1">'.'</span><span class="p">):</span>
|
|
|
<span class="k">if</span> <span class="n">fnmatch</span><span class="o">.</span><span class="n">fnmatch</span><span class="p">(</span><span class="n">file</span><span class="p">,</span> <span class="s1">'*.txt'</span><span class="p">):</span>
|
|
|
<span class="nb">print</span><span class="p">(</span><span class="n">file</span><span class="p">)</span>
|
|
|
</pre></div>
|
|
|
</div>
|
|
|
</dd></dl>
|
|
|
|
|
|
<dl class="function">
|
|
|
<dt id="fnmatch.fnmatchcase">
|
|
|
<code class="descclassname">fnmatch.</code><code class="descname">fnmatchcase</code><span class="sig-paren">(</span><em>filename</em>, <em>pattern</em><span class="sig-paren">)</span><a class="headerlink" href="#fnmatch.fnmatchcase" title="Permalink to this definition">¶</a></dt>
|
|
|
<dd><p>Test whether <em>filename</em> matches <em>pattern</em>, returning <a class="reference internal" href="constants.html#True" title="True"><code class="xref py py-const docutils literal notranslate"><span class="pre">True</span></code></a> or
|
|
|
<a class="reference internal" href="constants.html#False" title="False"><code class="xref py py-const docutils literal notranslate"><span class="pre">False</span></code></a>; the comparison is case-sensitive and does not apply
|
|
|
<a class="reference internal" href="os.path.html#os.path.normcase" title="os.path.normcase"><code class="xref py py-func docutils literal notranslate"><span class="pre">os.path.normcase()</span></code></a>.</p>
|
|
|
</dd></dl>
|
|
|
|
|
|
<dl class="function">
|
|
|
<dt id="fnmatch.filter">
|
|
|
<code class="descclassname">fnmatch.</code><code class="descname">filter</code><span class="sig-paren">(</span><em>names</em>, <em>pattern</em><span class="sig-paren">)</span><a class="headerlink" href="#fnmatch.filter" title="Permalink to this definition">¶</a></dt>
|
|
|
<dd><p>Return the subset of the list of <em>names</em> that match <em>pattern</em>. It is the same as
|
|
|
<code class="docutils literal notranslate"><span class="pre">[n</span> <span class="pre">for</span> <span class="pre">n</span> <span class="pre">in</span> <span class="pre">names</span> <span class="pre">if</span> <span class="pre">fnmatch(n,</span> <span class="pre">pattern)]</span></code>, but implemented more efficiently.</p>
|
|
|
</dd></dl>
|
|
|
|
|
|
<dl class="function">
|
|
|
<dt id="fnmatch.translate">
|
|
|
<code class="descclassname">fnmatch.</code><code class="descname">translate</code><span class="sig-paren">(</span><em>pattern</em><span class="sig-paren">)</span><a class="headerlink" href="#fnmatch.translate" title="Permalink to this definition">¶</a></dt>
|
|
|
<dd><p>Return the shell-style <em>pattern</em> converted to a regular expression for
|
|
|
using with <a class="reference internal" href="re.html#re.match" title="re.match"><code class="xref py py-func docutils literal notranslate"><span class="pre">re.match()</span></code></a>.</p>
|
|
|
<p>Example:</p>
|
|
|
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="kn">import</span> <span class="nn">fnmatch</span><span class="o">,</span> <span class="nn">re</span>
|
|
|
<span class="go">>>></span>
|
|
|
<span class="gp">>>> </span><span class="n">regex</span> <span class="o">=</span> <span class="n">fnmatch</span><span class="o">.</span><span class="n">translate</span><span class="p">(</span><span class="s1">'*.txt'</span><span class="p">)</span>
|
|
|
<span class="gp">>>> </span><span class="n">regex</span>
|
|
|
<span class="go">'(?s:.*\\.txt)\\Z'</span>
|
|
|
<span class="gp">>>> </span><span class="n">reobj</span> <span class="o">=</span> <span class="n">re</span><span class="o">.</span><span class="n">compile</span><span class="p">(</span><span class="n">regex</span><span class="p">)</span>
|
|
|
<span class="gp">>>> </span><span class="n">reobj</span><span class="o">.</span><span class="n">match</span><span class="p">(</span><span class="s1">'foobar.txt'</span><span class="p">)</span>
|
|
|
<span class="go"><re.Match object; span=(0, 10), match='foobar.txt'></span>
|
|
|
</pre></div>
|
|
|
</div>
|
|
|
</dd></dl>
|
|
|
|
|
|
<div class="admonition seealso">
|
|
|
<p class="admonition-title">See also</p>
|
|
|
<dl class="simple">
|
|
|
<dt>Module <a class="reference internal" href="glob.html#module-glob" title="glob: Unix shell style pathname pattern expansion."><code class="xref py py-mod docutils literal notranslate"><span class="pre">glob</span></code></a></dt><dd><p>Unix shell-style path expansion.</p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</div>
|
|
|
</div>
|
|
|
|
|
|
|
|
|
</div>
|
|
|
</div>
|
|
|
</div>
|
|
|
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
|
|
<div class="sphinxsidebarwrapper">
|
|
|
<h4>Previous topic</h4>
|
|
|
<p class="topless"><a href="glob.html"
|
|
|
title="previous chapter"><code class="xref py py-mod docutils literal notranslate"><span class="pre">glob</span></code> — Unix style pathname pattern expansion</a></p>
|
|
|
<h4>Next topic</h4>
|
|
|
<p class="topless"><a href="linecache.html"
|
|
|
title="next chapter"><code class="xref py py-mod docutils literal notranslate"><span class="pre">linecache</span></code> — Random access to text lines</a></p>
|
|
|
<div role="note" aria-label="source link">
|
|
|
<h3>This Page</h3>
|
|
|
<ul class="this-page-menu">
|
|
|
<li><a href="../bugs.html">Report a Bug</a></li>
|
|
|
<li>
|
|
|
<a href="https://github.com/python/cpython/blob/3.7/Doc/library/fnmatch.rst"
|
|
|
rel="nofollow">Show Source
|
|
|
</a>
|
|
|
</li>
|
|
|
</ul>
|
|
|
</div>
|
|
|
</div>
|
|
|
</div>
|
|
|
<div class="clearer"></div>
|
|
|
</div>
|
|
|
<div class="related" role="navigation" aria-label="related navigation">
|
|
|
<h3>Navigation</h3>
|
|
|
<ul>
|
|
|
<li class="right" style="margin-right: 10px">
|
|
|
<a href="../genindex.html" title="General Index"
|
|
|
>index</a></li>
|
|
|
<li class="right" >
|
|
|
<a href="../py-modindex.html" title="Python Module Index"
|
|
|
>modules</a> |</li>
|
|
|
<li class="right" >
|
|
|
<a href="linecache.html" title="linecache — Random access to text lines"
|
|
|
>next</a> |</li>
|
|
|
<li class="right" >
|
|
|
<a href="glob.html" title="glob — Unix style pathname pattern expansion"
|
|
|
>previous</a> |</li>
|
|
|
<li><img src="../_static/py.png" alt=""
|
|
|
style="vertical-align: middle; margin-top: -1px"/></li>
|
|
|
<li><a href="https://www.python.org/">Python</a> »</li>
|
|
|
<li>
|
|
|
<span class="language_switcher_placeholder">en</span>
|
|
|
<span class="version_switcher_placeholder">3.7.4</span>
|
|
|
<a href="../index.html">Documentation </a> »
|
|
|
</li>
|
|
|
|
|
|
<li class="nav-item nav-item-1"><a href="index.html" >The Python Standard Library</a> »</li>
|
|
|
<li class="nav-item nav-item-2"><a href="filesys.html" >File and Directory Access</a> »</li>
|
|
|
<li class="right">
|
|
|
|
|
|
|
|
|
<div class="inline-search" style="display: none" role="search">
|
|
|
<form class="inline-search" action="../search.html" method="get">
|
|
|
<input placeholder="Quick search" type="text" name="q" />
|
|
|
<input type="submit" value="Go" />
|
|
|
<input type="hidden" name="check_keywords" value="yes" />
|
|
|
<input type="hidden" name="area" value="default" />
|
|
|
</form>
|
|
|
</div>
|
|
|
<script type="text/javascript">$('.inline-search').show(0);</script>
|
|
|
|
|
|
|
</li>
|
|
|
|
|
|
</ul>
|
|
|
</div>
|
|
|
<div class="footer">
|
|
|
© <a href="../copyright.html">Copyright</a> 2001-2019, Python Software Foundation.
|
|
|
<br />
|
|
|
The Python Software Foundation is a non-profit corporation.
|
|
|
<a href="https://www.python.org/psf/donations/">Please donate.</a>
|
|
|
<br />
|
|
|
Last updated on Jul 13, 2019.
|
|
|
<a href="../bugs.html">Found a bug</a>?
|
|
|
<br />
|
|
|
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 2.0.1.
|
|
|
</div>
|
|
|
|
|
|
</body>
|
|
|
</html> |