<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="X-UA-Compatible" content="IE=Edge" />
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>regex – Tools for representing MongoDB regular expressions — PyMongo 3.7.2 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="index" title="Index" href="../../genindex.html" />
<link rel="search" title="Search" href="../../search.html" />
<link rel="next" title="son – Tools for working with SON, an ordered mapping" href="son.html" />
<link rel="prev" title="raw_bson – Tools for representing raw BSON documents." href="raw_bson.html" />
</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="son.html" title="son – Tools for working with SON, an ordered mapping"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="raw_bson.html" title="raw_bson – Tools for representing raw BSON documents."
accesskey="P">previous</a> |</li>
<li class="nav-item nav-item-0"><a href="../../index.html">PyMongo 3.7.2 documentation</a> »</li>
<li class="nav-item nav-item-1"><a href="../index.html" >API Documentation</a> »</li>
<li class="nav-item nav-item-2"><a href="index.html" accesskey="U"><code class="docutils literal notranslate"><span class="pre">bson</span></code> – BSON (Binary JSON) Encoding and Decoding</a> »</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<div class="section" id="regex-tools-for-representing-mongodb-regular-expressions">
<h1><code class="xref py py-mod docutils literal notranslate"><span class="pre">regex</span></code> – Tools for representing MongoDB regular expressions<a class="headerlink" href="#regex-tools-for-representing-mongodb-regular-expressions" title="Permalink to this headline">¶</a></h1>
<div class="versionadded">
<p><span class="versionmodified">New in version 2.7.</span></p>
</div>
<span class="target" id="module-bson.regex"></span><p>Tools for representing MongoDB regular expressions.</p>
<dl class="class">
<dt id="bson.regex.Regex">
<em class="property">class </em><code class="descclassname">bson.regex.</code><code class="descname">Regex</code><span class="sig-paren">(</span><em>pattern</em>, <em>flags=0</em><span class="sig-paren">)</span><a class="headerlink" href="#bson.regex.Regex" title="Permalink to this definition">¶</a></dt>
<dd><p>BSON regular expression data.</p>
<p>This class is useful to store and retrieve regular expressions that are
incompatible with Python’s regular expression dialect.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><cite>pattern</cite>: string</li>
<li><cite>flags</cite>: (optional) an integer bitmask, or a string of flag
characters like “im” for IGNORECASE and MULTILINE</li>
</ul>
</td>
</tr>
</tbody>
</table>
<dl class="classmethod">
<dt id="bson.regex.Regex.from_native">
<em class="property">classmethod </em><code class="descname">from_native</code><span class="sig-paren">(</span><em>regex</em><span class="sig-paren">)</span><a class="headerlink" href="#bson.regex.Regex.from_native" title="Permalink to this definition">¶</a></dt>
<dd><p>Convert a Python regular expression into a <code class="docutils literal notranslate"><span class="pre">Regex</span></code> instance.</p>
<p>Note that in Python 3, a regular expression compiled from a
<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> has the <code class="docutils literal notranslate"><span class="pre">re.UNICODE</span></code> flag set. If it is undesirable
to store this flag in a BSON regular expression, unset it first:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">pattern</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="s1">'.*'</span><span class="p">)</span>
<span class="gp">>>> </span><span class="n">regex</span> <span class="o">=</span> <span class="n">Regex</span><span class="o">.</span><span class="n">from_native</span><span class="p">(</span><span class="n">pattern</span><span class="p">)</span>
<span class="gp">>>> </span><span class="n">regex</span><span class="o">.</span><span class="n">flags</span> <span class="o">^=</span> <span class="n">re</span><span class="o">.</span><span class="n">UNICODE</span>
<span class="gp">>>> </span><span class="n">db</span><span class="o">.</span><span class="n">collection</span><span class="o">.</span><span class="n">insert</span><span class="p">({</span><span class="s1">'pattern'</span><span class="p">:</span> <span class="n">regex</span><span class="p">})</span>
</pre></div>
</div>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><cite>regex</cite>: A regular expression object from <code class="docutils literal notranslate"><span class="pre">re.compile()</span></code>.</li>
</ul>
</td>
</tr>
</tbody>
</table>
<div class="admonition warning">
<p class="first admonition-title">Warning</p>
<p class="last">Python regular expressions use a different syntax and different
set of flags than MongoDB, which uses <a class="reference external" href="http://www.pcre.org/">PCRE</a>. A regular
expression retrieved from the server may not compile in
Python, or may match a different set of strings in Python than
when used in a MongoDB query.</p>
</div>
</dd></dl>
<dl class="method">
<dt id="bson.regex.Regex.try_compile">
<code class="descname">try_compile</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#bson.regex.Regex.try_compile" title="Permalink to this definition">¶</a></dt>
<dd><p>Compile this <a class="reference internal" href="#bson.regex.Regex" title="bson.regex.Regex"><code class="xref py py-class docutils literal notranslate"><span class="pre">Regex</span></code></a> as a Python regular expression.</p>
<div class="admonition warning">
<p class="first admonition-title">Warning</p>
<p class="last">Python regular expressions use a different syntax and different
set of flags than MongoDB, which uses <a class="reference external" href="http://www.pcre.org/">PCRE</a>. A regular
expression retrieved from the server may not compile in
Python, or may match a different set of strings in Python than
when used in a MongoDB query. <a class="reference internal" href="#bson.regex.Regex.try_compile" title="bson.regex.Regex.try_compile"><code class="xref py py-meth docutils literal notranslate"><span class="pre">try_compile()</span></code></a> may raise
<code class="xref py py-exc docutils literal notranslate"><span class="pre">re.error</span></code>.</p>
</div>
</dd></dl>
</dd></dl>
</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="raw_bson.html"
title="previous chapter"><code class="docutils literal notranslate"><span class="pre">raw_bson</span></code> – Tools for representing raw BSON documents.</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="son.html"
title="next chapter"><code class="docutils literal notranslate"><span class="pre">son</span></code> – Tools for working with SON, an ordered mapping</a></p>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="../../_sources/api/bson/regex.rst.txt"
rel="nofollow">Show Source</a></li>
</ul>
</div>
<div id="searchbox" style="display: none" role="search">
<h3>Quick search</h3>
<div class="searchformwrapper">
<form class="search" action="../../search.html" method="get">
<input 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>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</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="son.html" title="son – Tools for working with SON, an ordered mapping"
>next</a> |</li>
<li class="right" >
<a href="raw_bson.html" title="raw_bson – Tools for representing raw BSON documents."
>previous</a> |</li>
<li class="nav-item nav-item-0"><a href="../../index.html">PyMongo 3.7.2 documentation</a> »</li>
<li class="nav-item nav-item-1"><a href="../index.html" >API Documentation</a> »</li>
<li class="nav-item nav-item-2"><a href="index.html" ><code class="docutils literal notranslate"><span class="pre">bson</span></code> – BSON (Binary JSON) Encoding and Decoding</a> »</li>
</ul>
</div>
<div class="footer" role="contentinfo">
© Copyright MongoDB, Inc. 2008-present. MongoDB, Mongo, and the leaf logo are registered trademarks of MongoDB, Inc.
</div>
</body>
</html>
distrib
>
Mageia
>
7
>
i586
>
media
>
core-release
>
by-pkgid
>
bc55833f04f370ac3ed453ef5b0ad686
>
files
>
230
