Baoding-FenShuaJiang
/
Green_GoodERP18_FSJ_Standard
Observar 1
Favorito 0
Wiki 捐赠
gooderp18绿色标准版
Você não pode selecionar mais de 25 tópicos Os tópicos devem começar com uma letra ou um número, podem incluir traços ('-') e podem ter até 35 caracteres.
Tag: 0f75e31513
Branches Tags
${ item.name }
Criar branch ${ searchTerm }
de 0f75e31513
${ noResults }
Green_GoodERP18_FSJ_Standard/python/Doc/html/library/enum.html

1502 linhas
130KB
Original Anotar Histórico 

  1. <!DOCTYPE html>

  2. 

  3. <html lang="en" data-content_root="../">

  4.   <head>

  5.     <meta charset="utf-8" />

  6.     <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />

  7. <meta property="og:title" content="enum — Support for enumerations" />

  8. <meta property="og:type" content="website" />

  9. <meta property="og:url" content="https://docs.python.org/3/library/enum.html" />

  10. <meta property="og:site_name" content="Python documentation" />

  11. <meta property="og:description" content="Source code: Lib/enum.py Important: This page contains the API reference information. For tutorial information and discussion of more advanced topics, see Basic Tutorial, Advanced Tutorial, Enum Co..." />

  12. <meta property="og:image" content="https://docs.python.org/3/_static/og-image.png" />

  13. <meta property="og:image:alt" content="Python documentation" />

  14. <meta name="description" content="Source code: Lib/enum.py Important: This page contains the API reference information. For tutorial information and discussion of more advanced topics, see Basic Tutorial, Advanced Tutorial, Enum Co..." />

  15. <meta property="og:image:width" content="200" />

  16. <meta property="og:image:height" content="200" />

  17. <meta name="theme-color" content="#3776ab" />

  18. 

  19.     <title>enum — Support for enumerations &#8212; Python 3.12.3 documentation</title><meta name="viewport" content="width=device-width, initial-scale=1.0">

  20.     

  21.     <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=80d5e7a1" />

  22.     <link rel="stylesheet" type="text/css" href="../_static/pydoctheme.css?v=bb723527" />

  23.     <link id="pygments_dark_css" media="(prefers-color-scheme: dark)" rel="stylesheet" type="text/css" href="../_static/pygments_dark.css?v=b20cc3f5" />

  24.     

  25.     <script src="../_static/documentation_options.js?v=2c828074"></script>

  26.     <script src="../_static/doctools.js?v=888ff710"></script>

  27.     <script src="../_static/sphinx_highlight.js?v=dc90522c"></script>

  28.     

  29.     <script src="../_static/sidebar.js"></script>

  30.     

  31.     <link rel="search" type="application/opensearchdescription+xml"

  32.           title="Search within Python 3.12.3 documentation"

  33.           href="../_static/opensearch.xml"/>

  34.     <link rel="author" title="About these documents" href="../about.html" />

  35.     <link rel="index" title="Index" href="../genindex.html" />

  36.     <link rel="search" title="Search" href="../search.html" />

  37.     <link rel="copyright" title="Copyright" href="../copyright.html" />

  38.     <link rel="next" title="graphlib — Functionality to operate with graph-like structures" href="graphlib.html" />

  39.     <link rel="prev" title="reprlib — Alternate repr() implementation" href="reprlib.html" />

  40.     <link rel="canonical" href="https://docs.python.org/3/library/enum.html" />

  41.     

  42.       

  43.     

  44. 

  45.     

  46.     <style>

  47.       @media only screen {

  48.         table.full-width-table {

  49.             width: 100%;

  50.         }

  51.       }

  52.     </style>

  53. <link rel="stylesheet" href="../_static/pydoctheme_dark.css" media="(prefers-color-scheme: dark)" id="pydoctheme_dark_css">

  54.     <link rel="shortcut icon" type="image/png" href="../_static/py.svg" />

  55.             <script type="text/javascript" src="../_static/copybutton.js"></script>

  56.             <script type="text/javascript" src="../_static/menu.js"></script>

  57.             <script type="text/javascript" src="../_static/search-focus.js"></script>

  58.             <script type="text/javascript" src="../_static/themetoggle.js"></script> 

  59. 

  60.   </head>

  61. <body>

  62. <div class="mobile-nav">

  63.     <input type="checkbox" id="menuToggler" class="toggler__input" aria-controls="navigation"

  64.            aria-pressed="false" aria-expanded="false" role="button" aria-label="Menu" />

  65.     <nav class="nav-content" role="navigation">

  66.         <label for="menuToggler" class="toggler__label">

  67.             <span></span>

  68.         </label>

  69.         <span class="nav-items-wrapper">

  70.             <a href="https://www.python.org/" class="nav-logo">

  71.                 <img src="../_static/py.svg" alt="Python logo"/>

  72.             </a>

  73.             <span class="version_switcher_placeholder"></span>

  74.             <form role="search" class="search" action="../search.html" method="get">

  75.                 <svg xmlns="http://www.w3.org/2000/svg" width="20" height="20" viewBox="0 0 24 24" class="search-icon">

  76.                     <path fill-rule="nonzero" fill="currentColor" d="M15.5 14h-.79l-.28-.27a6.5 6.5 0 001.48-5.34c-.47-2.78-2.79-5-5.59-5.34a6.505 6.505 0 00-7.27 7.27c.34 2.8 2.56 5.12 5.34 5.59a6.5 6.5 0 005.34-1.48l.27.28v.79l4.25 4.25c.41.41 1.08.41 1.49 0 .41-.41.41-1.08 0-1.49L15.5 14zm-6 0C7.01 14 5 11.99 5 9.5S7.01 5 9.5 5 14 7.01 14 9.5 11.99 14 9.5 14z"></path>

  77.                 </svg>

  78.                 <input placeholder="Quick search" aria-label="Quick search" type="search" name="q" />

  79.                 <input type="submit" value="Go"/>

  80.             </form>

  81.         </span>

  82.     </nav>

  83.     <div class="menu-wrapper">

  84.         <nav class="menu" role="navigation" aria-label="main navigation">

  85.             <div class="language_switcher_placeholder"></div>

  86.             

  87. <label class="theme-selector-label">

  88.     Theme

  89.     <select class="theme-selector" oninput="activateTheme(this.value)">

  90.         <option value="auto" selected>Auto</option>

  91.         <option value="light">Light</option>

  92.         <option value="dark">Dark</option>

  93.     </select>

  94. </label>

  95.   <div>

  96.     <h3><a href="../contents.html">Table of Contents</a></h3>

  97.     <ul>

  98. <li><a class="reference internal" href="#"><code class="xref py py-mod docutils literal notranslate"><span class="pre">enum</span></code> — Support for enumerations</a><ul>

  99. <li><a class="reference internal" href="#module-contents">Module Contents</a></li>

  100. <li><a class="reference internal" href="#data-types">Data Types</a><ul>

  101. <li><a class="reference internal" href="#supported-dunder-names">Supported <code class="docutils literal notranslate"><span class="pre">__dunder__</span></code> names</a></li>

  102. <li><a class="reference internal" href="#supported-sunder-names">Supported <code class="docutils literal notranslate"><span class="pre">_sunder_</span></code> names</a></li>

  103. </ul>

  104. </li>

  105. <li><a class="reference internal" href="#utilities-and-decorators">Utilities and Decorators</a></li>

  106. <li><a class="reference internal" href="#notes">Notes</a></li>

  107. </ul>

  108. </li>

  109. </ul>

  110. 

  111.   </div>

  112.   <div>

  113.     <h4>Previous topic</h4>

  114.     <p class="topless"><a href="reprlib.html"

  115.                           title="previous chapter"><code class="xref py py-mod docutils literal notranslate"><span class="pre">reprlib</span></code> — Alternate <code class="xref py py-func docutils literal notranslate"><span class="pre">repr()</span></code> implementation</a></p>

  116.   </div>

  117.   <div>

  118.     <h4>Next topic</h4>

  119.     <p class="topless"><a href="graphlib.html"

  120.                           title="next chapter"><code class="xref py py-mod docutils literal notranslate"><span class="pre">graphlib</span></code> — Functionality to operate with graph-like structures</a></p>

  121.   </div>

  122.   <div role="note" aria-label="source link">

  123.     <h3>This Page</h3>

  124.     <ul class="this-page-menu">

  125.       <li><a href="../bugs.html">Report a Bug</a></li>

  126.       <li>

  127.         <a href="https://github.com/python/cpython/blob/main/Doc/library/enum.rst"

  128.             rel="nofollow">Show Source

  129.         </a>

  130.       </li>

  131.     </ul>

  132.   </div>

  133.         </nav>

  134.     </div>

  135. </div>

  136. 

  137.   

  138.     <div class="related" role="navigation" aria-label="related navigation">

  139.       <h3>Navigation</h3>

  140.       <ul>

  141.         <li class="right" style="margin-right: 10px">

  142.           <a href="../genindex.html" title="General Index"

  143.              accesskey="I">index</a></li>

  144.         <li class="right" >

  145.           <a href="../py-modindex.html" title="Python Module Index"

  146.              >modules</a> |</li>

  147.         <li class="right" >

  148.           <a href="graphlib.html" title="graphlib — Functionality to operate with graph-like structures"

  149.              accesskey="N">next</a> |</li>

  150.         <li class="right" >

  151.           <a href="reprlib.html" title="reprlib — Alternate repr() implementation"

  152.              accesskey="P">previous</a> |</li>

  153. 

  154.           <li><img src="../_static/py.svg" alt="Python logo" style="vertical-align: middle; margin-top: -1px"/></li>

  155.           <li><a href="https://www.python.org/">Python</a> &#187;</li>

  156.           <li class="switchers">

  157.             <div class="language_switcher_placeholder"></div>

  158.             <div class="version_switcher_placeholder"></div>

  159.           </li>

  160.           <li>

  161.               

  162.           </li>

  163.     <li id="cpython-language-and-version">

  164.       <a href="../index.html">3.12.3 Documentation</a> &#187;

  165.     </li>

  166. 

  167.           <li class="nav-item nav-item-1"><a href="index.html" >The Python Standard Library</a> &#187;</li>

  168.           <li class="nav-item nav-item-2"><a href="datatypes.html" accesskey="U">Data Types</a> &#187;</li>

  169.         <li class="nav-item nav-item-this"><a href=""><code class="xref py py-mod docutils literal notranslate"><span class="pre">enum</span></code> — Support for enumerations</a></li>

  170.                 <li class="right">

  171.                     

  172. 

  173.     <div class="inline-search" role="search">

  174.         <form class="inline-search" action="../search.html" method="get">

  175.           <input placeholder="Quick search" aria-label="Quick search" type="search" name="q" id="search-box" />

  176.           <input type="submit" value="Go" />

  177.         </form>

  178.     </div>

  179.                      |

  180.                 </li>

  181.             <li class="right">

  182. <label class="theme-selector-label">

  183.     Theme

  184.     <select class="theme-selector" oninput="activateTheme(this.value)">

  185.         <option value="auto" selected>Auto</option>

  186.         <option value="light">Light</option>

  187.         <option value="dark">Dark</option>

  188.     </select>

  189. </label> |</li>

  190.             

  191.       </ul>

  192.     </div>    

  193. 

  194.     <div class="document">

  195.       <div class="documentwrapper">

  196.         <div class="bodywrapper">

  197.           <div class="body" role="main">

  198.             

  199.   <section id="module-enum">

  200. <span id="enum-support-for-enumerations"></span><h1><a class="reference internal" href="#module-enum" title="enum: Implementation of an enumeration class."><code class="xref py py-mod docutils literal notranslate"><span class="pre">enum</span></code></a> — Support for enumerations<a class="headerlink" href="#module-enum" title="Link to this heading">¶</a></h1>

  201. <div class="versionadded">

  202. <p><span class="versionmodified added">New in version 3.4.</span></p>

  203. </div>

  204. <p><strong>Source code:</strong> <a class="reference external" href="https://github.com/python/cpython/tree/3.12/Lib/enum.py">Lib/enum.py</a></p>

  205. <aside class="sidebar">

  206. <p class="sidebar-title">Important</p>

  207. <p>This page contains the API reference information. For tutorial

  208. information and discussion of more advanced topics, see</p>

  209. <ul class="simple">

  210. <li><p><a class="reference internal" href="../howto/enum.html#enum-basic-tutorial"><span class="std std-ref">Basic Tutorial</span></a></p></li>

  211. <li><p><a class="reference internal" href="../howto/enum.html#enum-advanced-tutorial"><span class="std std-ref">Advanced Tutorial</span></a></p></li>

  212. <li><p><a class="reference internal" href="../howto/enum.html#enum-cookbook"><span class="std std-ref">Enum Cookbook</span></a></p></li>

  213. </ul>

  214. </aside>

  215. <hr class="docutils" />

  216. <p>An enumeration:</p>

  217. <ul class="simple">

  218. <li><p>is a set of symbolic names (members) bound to unique values</p></li>

  219. <li><p>can be iterated over to return its canonical (i.e. non-alias) members in

  220. definition order</p></li>

  221. <li><p>uses <em>call</em> syntax to return members by value</p></li>

  222. <li><p>uses <em>index</em> syntax to return members by name</p></li>

  223. </ul>

  224. <p>Enumerations are created either by using <a class="reference internal" href="../reference/compound_stmts.html#class"><code class="xref std std-keyword docutils literal notranslate"><span class="pre">class</span></code></a> syntax, or by

  225. using function-call syntax:</p>

  226. <div class="highlight-python3 notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="kn">from</span> <span class="nn">enum</span> <span class="kn">import</span> <span class="n">Enum</span>

  227. 

  228. <span class="gp">&gt;&gt;&gt; </span><span class="c1"># class syntax</span>

  229. <span class="gp">&gt;&gt;&gt; </span><span class="k">class</span> <span class="nc">Color</span><span class="p">(</span><span class="n">Enum</span><span class="p">):</span>

  230. <span class="gp">... </span>    <span class="n">RED</span> <span class="o">=</span> <span class="mi">1</span>

  231. <span class="gp">... </span>    <span class="n">GREEN</span> <span class="o">=</span> <span class="mi">2</span>

  232. <span class="gp">... </span>    <span class="n">BLUE</span> <span class="o">=</span> <span class="mi">3</span>

  233. 

  234. <span class="gp">&gt;&gt;&gt; </span><span class="c1"># functional syntax</span>

  235. <span class="gp">&gt;&gt;&gt; </span><span class="n">Color</span> <span class="o">=</span> <span class="n">Enum</span><span class="p">(</span><span class="s1">&#39;Color&#39;</span><span class="p">,</span> <span class="p">[</span><span class="s1">&#39;RED&#39;</span><span class="p">,</span> <span class="s1">&#39;GREEN&#39;</span><span class="p">,</span> <span class="s1">&#39;BLUE&#39;</span><span class="p">])</span>

  236. </pre></div>

  237. </div>

  238. <p>Even though we can use <a class="reference internal" href="../reference/compound_stmts.html#class"><code class="xref std std-keyword docutils literal notranslate"><span class="pre">class</span></code></a> syntax to create Enums, Enums

  239. are not normal Python classes.  See

  240. <a class="reference internal" href="../howto/enum.html#enum-class-differences"><span class="std std-ref">How are Enums different?</span></a> for more details.</p>

  241. <div class="admonition note">

  242. <p class="admonition-title">Note</p>

  243. <p>Nomenclature</p>

  244. <ul class="simple">

  245. <li><p>The class <code class="xref py py-class docutils literal notranslate"><span class="pre">Color</span></code> is an <em>enumeration</em> (or <em>enum</em>)</p></li>

  246. <li><p>The attributes <code class="xref py py-attr docutils literal notranslate"><span class="pre">Color.RED</span></code>, <code class="xref py py-attr docutils literal notranslate"><span class="pre">Color.GREEN</span></code>, etc., are

  247. <em>enumeration members</em> (or <em>members</em>) and are functionally constants.</p></li>

  248. <li><p>The enum members have <em>names</em> and <em>values</em> (the name of

  249. <code class="xref py py-attr docutils literal notranslate"><span class="pre">Color.RED</span></code> is <code class="docutils literal notranslate"><span class="pre">RED</span></code>, the value of <code class="xref py py-attr docutils literal notranslate"><span class="pre">Color.BLUE</span></code> is

  250. <code class="docutils literal notranslate"><span class="pre">3</span></code>, etc.)</p></li>

  251. </ul>

  252. </div>

  253. <hr class="docutils" />

  254. <section id="module-contents">

  255. <h2>Module Contents<a class="headerlink" href="#module-contents" title="Link to this heading">¶</a></h2>

  256. <blockquote>

  257. <div><p><a class="reference internal" href="#enum.EnumType" title="enum.EnumType"><code class="xref py py-class docutils literal notranslate"><span class="pre">EnumType</span></code></a></p>

  258. <blockquote>

  259. <div><p>The <code class="docutils literal notranslate"><span class="pre">type</span></code> for Enum and its subclasses.</p>

  260. </div></blockquote>

  261. <p><a class="reference internal" href="#enum.Enum" title="enum.Enum"><code class="xref py py-class docutils literal notranslate"><span class="pre">Enum</span></code></a></p>

  262. <blockquote>

  263. <div><p>Base class for creating enumerated constants.</p>

  264. </div></blockquote>

  265. <p><a class="reference internal" href="#enum.IntEnum" title="enum.IntEnum"><code class="xref py py-class docutils literal notranslate"><span class="pre">IntEnum</span></code></a></p>

  266. <blockquote>

  267. <div><p>Base class for creating enumerated constants that are also

  268. subclasses of <a class="reference internal" href="functions.html#int" title="int"><code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code></a>. (<a class="reference internal" href="#notes">Notes</a>)</p>

  269. </div></blockquote>

  270. <p><a class="reference internal" href="#enum.StrEnum" title="enum.StrEnum"><code class="xref py py-class docutils literal notranslate"><span class="pre">StrEnum</span></code></a></p>

  271. <blockquote>

  272. <div><p>Base class for creating enumerated constants that are also

  273. subclasses of <a class="reference internal" href="stdtypes.html#str" title="str"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></a>. (<a class="reference internal" href="#notes">Notes</a>)</p>

  274. </div></blockquote>

  275. <p><a class="reference internal" href="#enum.Flag" title="enum.Flag"><code class="xref py py-class docutils literal notranslate"><span class="pre">Flag</span></code></a></p>

  276. <blockquote>

  277. <div><p>Base class for creating enumerated constants that can be combined using

  278. the bitwise operations without losing their <a class="reference internal" href="#enum.Flag" title="enum.Flag"><code class="xref py py-class docutils literal notranslate"><span class="pre">Flag</span></code></a> membership.</p>

  279. </div></blockquote>

  280. <p><a class="reference internal" href="#enum.IntFlag" title="enum.IntFlag"><code class="xref py py-class docutils literal notranslate"><span class="pre">IntFlag</span></code></a></p>

  281. <blockquote>

  282. <div><p>Base class for creating enumerated constants that can be combined using

  283. the bitwise operators without losing their <a class="reference internal" href="#enum.IntFlag" title="enum.IntFlag"><code class="xref py py-class docutils literal notranslate"><span class="pre">IntFlag</span></code></a> membership.

  284. <a class="reference internal" href="#enum.IntFlag" title="enum.IntFlag"><code class="xref py py-class docutils literal notranslate"><span class="pre">IntFlag</span></code></a> members are also subclasses of <a class="reference internal" href="functions.html#int" title="int"><code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code></a>. (<a class="reference internal" href="#notes">Notes</a>)</p>

  285. </div></blockquote>

  286. <p><a class="reference internal" href="#enum.ReprEnum" title="enum.ReprEnum"><code class="xref py py-class docutils literal notranslate"><span class="pre">ReprEnum</span></code></a></p>

  287. <blockquote>

  288. <div><p>Used by <a class="reference internal" href="#enum.IntEnum" title="enum.IntEnum"><code class="xref py py-class docutils literal notranslate"><span class="pre">IntEnum</span></code></a>, <a class="reference internal" href="#enum.StrEnum" title="enum.StrEnum"><code class="xref py py-class docutils literal notranslate"><span class="pre">StrEnum</span></code></a>, and <a class="reference internal" href="#enum.IntFlag" title="enum.IntFlag"><code class="xref py py-class docutils literal notranslate"><span class="pre">IntFlag</span></code></a>

  289. to keep the <a class="reference internal" href="stdtypes.html#str" title="str"><code class="xref py py-class docutils literal notranslate"><span class="pre">str()</span></code></a> of the mixed-in type.</p>

  290. </div></blockquote>

  291. <p><a class="reference internal" href="#enum.EnumCheck" title="enum.EnumCheck"><code class="xref py py-class docutils literal notranslate"><span class="pre">EnumCheck</span></code></a></p>

  292. <blockquote>

  293. <div><p>An enumeration with the values <code class="docutils literal notranslate"><span class="pre">CONTINUOUS</span></code>, <code class="docutils literal notranslate"><span class="pre">NAMED_FLAGS</span></code>, and

  294. <code class="docutils literal notranslate"><span class="pre">UNIQUE</span></code>, for use with <a class="reference internal" href="#enum.verify" title="enum.verify"><code class="xref py py-func docutils literal notranslate"><span class="pre">verify()</span></code></a> to ensure various constraints

  295. are met by a given enumeration.</p>

  296. </div></blockquote>

  297. <p><a class="reference internal" href="#enum.FlagBoundary" title="enum.FlagBoundary"><code class="xref py py-class docutils literal notranslate"><span class="pre">FlagBoundary</span></code></a></p>

  298. <blockquote>

  299. <div><p>An enumeration with the values <code class="docutils literal notranslate"><span class="pre">STRICT</span></code>, <code class="docutils literal notranslate"><span class="pre">CONFORM</span></code>, <code class="docutils literal notranslate"><span class="pre">EJECT</span></code>, and

  300. <code class="docutils literal notranslate"><span class="pre">KEEP</span></code> which allows for more fine-grained control over how invalid values

  301. are dealt with in an enumeration.</p>

  302. </div></blockquote>

  303. <p><a class="reference internal" href="#enum.auto" title="enum.auto"><code class="xref py py-class docutils literal notranslate"><span class="pre">auto</span></code></a></p>

  304. <blockquote>

  305. <div><p>Instances are replaced with an appropriate value for Enum members.

  306. <a class="reference internal" href="#enum.StrEnum" title="enum.StrEnum"><code class="xref py py-class docutils literal notranslate"><span class="pre">StrEnum</span></code></a> defaults to the lower-cased version of the member name,

  307. while other Enums default to 1 and increase from there.</p>

  308. </div></blockquote>

  309. <p><a class="reference internal" href="#enum.property" title="enum.property"><code class="xref py py-func docutils literal notranslate"><span class="pre">property()</span></code></a></p>

  310. <blockquote>

  311. <div><p>Allows <a class="reference internal" href="#enum.Enum" title="enum.Enum"><code class="xref py py-class docutils literal notranslate"><span class="pre">Enum</span></code></a> members to have attributes without conflicting with

  312. member names.  The <code class="docutils literal notranslate"><span class="pre">value</span></code> and <code class="docutils literal notranslate"><span class="pre">name</span></code> attributes are implemented this

  313. way.</p>

  314. </div></blockquote>

  315. <p><a class="reference internal" href="#enum.unique" title="enum.unique"><code class="xref py py-func docutils literal notranslate"><span class="pre">unique()</span></code></a></p>

  316. <blockquote>

  317. <div><p>Enum class decorator that ensures only one name is bound to any one value.</p>

  318. </div></blockquote>

  319. <p><a class="reference internal" href="#enum.verify" title="enum.verify"><code class="xref py py-func docutils literal notranslate"><span class="pre">verify()</span></code></a></p>

  320. <blockquote>

  321. <div><p>Enum class decorator that checks user-selectable constraints on an

  322. enumeration.</p>

  323. </div></blockquote>

  324. <p><a class="reference internal" href="#enum.member" title="enum.member"><code class="xref py py-func docutils literal notranslate"><span class="pre">member()</span></code></a></p>

  325. <blockquote>

  326. <div><p>Make <code class="docutils literal notranslate"><span class="pre">obj</span></code> a member.  Can be used as a decorator.</p>

  327. </div></blockquote>

  328. <p><a class="reference internal" href="#enum.nonmember" title="enum.nonmember"><code class="xref py py-func docutils literal notranslate"><span class="pre">nonmember()</span></code></a></p>

  329. <blockquote>

  330. <div><p>Do not make <code class="docutils literal notranslate"><span class="pre">obj</span></code> a member.  Can be used as a decorator.</p>

  331. </div></blockquote>

  332. <p><a class="reference internal" href="#enum.global_enum" title="enum.global_enum"><code class="xref py py-func docutils literal notranslate"><span class="pre">global_enum()</span></code></a></p>

  333. <blockquote>

  334. <div><p>Modify the <a class="reference internal" href="stdtypes.html#str" title="str"><code class="xref py py-class docutils literal notranslate"><span class="pre">str()</span></code></a> and <a class="reference internal" href="functions.html#repr" title="repr"><code class="xref py py-func docutils literal notranslate"><span class="pre">repr()</span></code></a> of an enum

  335. to show its members as belonging to the module instead of its class,

  336. and export the enum members to the global namespace.</p>

  337. </div></blockquote>

  338. <p><a class="reference internal" href="#enum.show_flag_values" title="enum.show_flag_values"><code class="xref py py-func docutils literal notranslate"><span class="pre">show_flag_values()</span></code></a></p>

  339. <blockquote>

  340. <div><p>Return a list of all power-of-two integers contained in a flag.</p>

  341. </div></blockquote>

  342. </div></blockquote>

  343. <div class="versionadded">

  344. <p><span class="versionmodified added">New in version 3.6: </span><code class="docutils literal notranslate"><span class="pre">Flag</span></code>, <code class="docutils literal notranslate"><span class="pre">IntFlag</span></code>, <code class="docutils literal notranslate"><span class="pre">auto</span></code></p>

  345. </div>

  346. <div class="versionadded">

  347. <p><span class="versionmodified added">New in version 3.11: </span><code class="docutils literal notranslate"><span class="pre">StrEnum</span></code>, <code class="docutils literal notranslate"><span class="pre">EnumCheck</span></code>, <code class="docutils literal notranslate"><span class="pre">ReprEnum</span></code>, <code class="docutils literal notranslate"><span class="pre">FlagBoundary</span></code>, <code class="docutils literal notranslate"><span class="pre">property</span></code>, <code class="docutils literal notranslate"><span class="pre">member</span></code>, <code class="docutils literal notranslate"><span class="pre">nonmember</span></code>, <code class="docutils literal notranslate"><span class="pre">global_enum</span></code>, <code class="docutils literal notranslate"><span class="pre">show_flag_values</span></code></p>

  348. </div>

  349. </section>

  350. <hr class="docutils" />

  351. <section id="data-types">

  352. <h2>Data Types<a class="headerlink" href="#data-types" title="Link to this heading">¶</a></h2>

  353. <dl class="py class">

  354. <dt class="sig sig-object py" id="enum.EnumType">

  355. <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">enum.</span></span><span class="sig-name descname"><span class="pre">EnumType</span></span><a class="headerlink" href="#enum.EnumType" title="Link to this definition">¶</a></dt>

  356. <dd><p><em>EnumType</em> is the <a class="reference internal" href="../glossary.html#term-metaclass"><span class="xref std std-term">metaclass</span></a> for <em>enum</em> enumerations.  It is possible

  357. to subclass <em>EnumType</em> – see <a class="reference internal" href="../howto/enum.html#enumtype-examples"><span class="std std-ref">Subclassing EnumType</span></a>

  358. for details.</p>

  359. <p><em>EnumType</em> is responsible for setting the correct <code class="xref py py-meth docutils literal notranslate"><span class="pre">__repr__()</span></code>,

  360. <code class="xref py py-meth docutils literal notranslate"><span class="pre">__str__()</span></code>, <code class="xref py py-meth docutils literal notranslate"><span class="pre">__format__()</span></code>, and <code class="xref py py-meth docutils literal notranslate"><span class="pre">__reduce__()</span></code> methods on the

  361. final <em>enum</em>, as well as creating the enum members, properly handling

  362. duplicates, providing iteration over the enum class, etc.</p>

  363. <dl class="py method">

  364. <dt class="sig sig-object py" id="enum.EnumType.__call__">

  365. <span class="sig-name descname"><span class="pre">__call__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cls</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">value</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">names</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">module</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">qualname</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">type</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">start</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">1</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">boundary</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#enum.EnumType.__call__" title="Link to this definition">¶</a></dt>

  366. <dd><p>This method is called in two different ways:</p>

  367. <ul>

  368. <li><p>to look up an existing member:</p>

  369. <blockquote>

  370. <div><dl class="field-list simple">

  371. <dt class="field-odd">cls<span class="colon">:</span></dt>

  372. <dd class="field-odd"><p>The enum class being called.</p>

  373. </dd>

  374. <dt class="field-even">value<span class="colon">:</span></dt>

  375. <dd class="field-even"><p>The value to lookup.</p>

  376. </dd>

  377. </dl>

  378. </div></blockquote>

  379. </li>

  380. <li><p>to use the <code class="docutils literal notranslate"><span class="pre">cls</span></code> enum to create a new enum (only if the existing enum

  381. does not have any members):</p>

  382. <blockquote>

  383. <div><dl class="field-list simple">

  384. <dt class="field-odd">cls<span class="colon">:</span></dt>

  385. <dd class="field-odd"><p>The enum class being called.</p>

  386. </dd>

  387. <dt class="field-even">value<span class="colon">:</span></dt>

  388. <dd class="field-even"><p>The name of the new Enum to create.</p>

  389. </dd>

  390. <dt class="field-odd">names<span class="colon">:</span></dt>

  391. <dd class="field-odd"><p>The names/values of the members for the new Enum.</p>

  392. </dd>

  393. <dt class="field-even">module<span class="colon">:</span></dt>

  394. <dd class="field-even"><p>The name of the module the new Enum is created in.</p>

  395. </dd>

  396. <dt class="field-odd">qualname<span class="colon">:</span></dt>

  397. <dd class="field-odd"><p>The actual location in the module where this Enum can be found.</p>

  398. </dd>

  399. <dt class="field-even">type<span class="colon">:</span></dt>

  400. <dd class="field-even"><p>A mix-in type for the new Enum.</p>

  401. </dd>

  402. <dt class="field-odd">start<span class="colon">:</span></dt>

  403. <dd class="field-odd"><p>The first integer value for the Enum (used by <a class="reference internal" href="#enum.auto" title="enum.auto"><code class="xref py py-class docutils literal notranslate"><span class="pre">auto</span></code></a>).</p>

  404. </dd>

  405. <dt class="field-even">boundary<span class="colon">:</span></dt>

  406. <dd class="field-even"><p>How to handle out-of-range values from bit operations (<a class="reference internal" href="#enum.Flag" title="enum.Flag"><code class="xref py py-class docutils literal notranslate"><span class="pre">Flag</span></code></a> only).</p>

  407. </dd>

  408. </dl>

  409. </div></blockquote>

  410. </li>

  411. </ul>

  412. </dd></dl>

  413. 

  414. <dl class="py method">

  415. <dt class="sig sig-object py" id="enum.EnumType.__contains__">

  416. <span class="sig-name descname"><span class="pre">__contains__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cls</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">member</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#enum.EnumType.__contains__" title="Link to this definition">¶</a></dt>

  417. <dd><p>Returns <code class="docutils literal notranslate"><span class="pre">True</span></code> if member belongs to the <code class="docutils literal notranslate"><span class="pre">cls</span></code>:</p>

  418. <div class="highlight-python3 notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">some_var</span> <span class="o">=</span> <span class="n">Color</span><span class="o">.</span><span class="n">RED</span>

  419. <span class="gp">&gt;&gt;&gt; </span><span class="n">some_var</span> <span class="ow">in</span> <span class="n">Color</span>

  420. <span class="go">True</span>

  421. <span class="gp">&gt;&gt;&gt; </span><span class="n">Color</span><span class="o">.</span><span class="n">RED</span><span class="o">.</span><span class="n">value</span> <span class="ow">in</span> <span class="n">Color</span>

  422. <span class="go">True</span>

  423. </pre></div>

  424. </div>

  425. </dd></dl>

  426. 

  427. <div class="versionchanged">

  428. <p><span class="versionmodified changed">Changed in version 3.12: </span>Before Python 3.12, a <code class="docutils literal notranslate"><span class="pre">TypeError</span></code> is raised if a

  429. non-Enum-member is used in a containment check.</p>

  430. </div>

  431. <dl class="py method">

  432. <dt class="sig sig-object py" id="enum.EnumType.__dir__">

  433. <span class="sig-name descname"><span class="pre">__dir__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cls</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#enum.EnumType.__dir__" title="Link to this definition">¶</a></dt>

  434. <dd><p>Returns <code class="docutils literal notranslate"><span class="pre">['__class__',</span> <span class="pre">'__doc__',</span> <span class="pre">'__members__',</span> <span class="pre">'__module__']</span></code> and the

  435. names of the members in <em>cls</em>:</p>

  436. <div class="highlight-python3 notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="nb">dir</span><span class="p">(</span><span class="n">Color</span><span class="p">)</span>

  437. <span class="go">[&#39;BLUE&#39;, &#39;GREEN&#39;, &#39;RED&#39;, &#39;__class__&#39;, &#39;__contains__&#39;, &#39;__doc__&#39;, &#39;__getitem__&#39;, &#39;__init_subclass__&#39;, &#39;__iter__&#39;, &#39;__len__&#39;, &#39;__members__&#39;, &#39;__module__&#39;, &#39;__name__&#39;, &#39;__qualname__&#39;]</span>

  438. </pre></div>

  439. </div>

  440. </dd></dl>

  441. 

  442. <dl class="py method">

  443. <dt class="sig sig-object py" id="enum.EnumType.__getitem__">

  444. <span class="sig-name descname"><span class="pre">__getitem__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cls</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">name</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#enum.EnumType.__getitem__" title="Link to this definition">¶</a></dt>

  445. <dd><p>Returns the Enum member in <em>cls</em> matching <em>name</em>, or raises a <a class="reference internal" href="exceptions.html#KeyError" title="KeyError"><code class="xref py py-exc docutils literal notranslate"><span class="pre">KeyError</span></code></a>:</p>

  446. <div class="highlight-python3 notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">Color</span><span class="p">[</span><span class="s1">&#39;BLUE&#39;</span><span class="p">]</span>

  447. <span class="go">&lt;Color.BLUE: 3&gt;</span>

  448. </pre></div>

  449. </div>

  450. </dd></dl>

  451. 

  452. <dl class="py method">

  453. <dt class="sig sig-object py" id="enum.EnumType.__iter__">

  454. <span class="sig-name descname"><span class="pre">__iter__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cls</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#enum.EnumType.__iter__" title="Link to this definition">¶</a></dt>

  455. <dd><p>Returns each member in <em>cls</em> in definition order:</p>

  456. <div class="highlight-python3 notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="nb">list</span><span class="p">(</span><span class="n">Color</span><span class="p">)</span>

  457. <span class="go">[&lt;Color.RED: 1&gt;, &lt;Color.GREEN: 2&gt;, &lt;Color.BLUE: 3&gt;]</span>

  458. </pre></div>

  459. </div>

  460. </dd></dl>

  461. 

  462. <dl class="py method">

  463. <dt class="sig sig-object py" id="enum.EnumType.__len__">

  464. <span class="sig-name descname"><span class="pre">__len__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cls</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#enum.EnumType.__len__" title="Link to this definition">¶</a></dt>

  465. <dd><p>Returns the number of member in <em>cls</em>:</p>

  466. <div class="highlight-python3 notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="nb">len</span><span class="p">(</span><span class="n">Color</span><span class="p">)</span>

  467. <span class="go">3</span>

  468. </pre></div>

  469. </div>

  470. </dd></dl>

  471. 

  472. <dl class="py attribute">

  473. <dt class="sig sig-object py" id="enum.EnumType.__members__">

  474. <span class="sig-name descname"><span class="pre">__members__</span></span><a class="headerlink" href="#enum.EnumType.__members__" title="Link to this definition">¶</a></dt>

  475. <dd><p>Returns a mapping of every enum name to its member, including aliases</p>

  476. </dd></dl>

  477. 

  478. <dl class="py method">

  479. <dt class="sig sig-object py" id="enum.EnumType.__reversed__">

  480. <span class="sig-name descname"><span class="pre">__reversed__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cls</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#enum.EnumType.__reversed__" title="Link to this definition">¶</a></dt>

  481. <dd><p>Returns each member in <em>cls</em> in reverse definition order:</p>

  482. <div class="highlight-python3 notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="nb">list</span><span class="p">(</span><span class="nb">reversed</span><span class="p">(</span><span class="n">Color</span><span class="p">))</span>

  483. <span class="go">[&lt;Color.BLUE: 3&gt;, &lt;Color.GREEN: 2&gt;, &lt;Color.RED: 1&gt;]</span>

  484. </pre></div>

  485. </div>

  486. </dd></dl>

  487. 

  488. <div class="versionadded">

  489. <p><span class="versionmodified added">New in version 3.11: </span>Before 3.11 <code class="docutils literal notranslate"><span class="pre">enum</span></code> used <code class="docutils literal notranslate"><span class="pre">EnumMeta</span></code> type, which is kept as an alias.</p>

  490. </div>

  491. </dd></dl>

  492. 

  493. <dl class="py class">

  494. <dt class="sig sig-object py" id="enum.Enum">

  495. <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">enum.</span></span><span class="sig-name descname"><span class="pre">Enum</span></span><a class="headerlink" href="#enum.Enum" title="Link to this definition">¶</a></dt>

  496. <dd><p><em>Enum</em> is the base class for all <em>enum</em> enumerations.</p>

  497. <dl class="py attribute">

  498. <dt class="sig sig-object py" id="enum.Enum.name">

  499. <span class="sig-name descname"><span class="pre">name</span></span><a class="headerlink" href="#enum.Enum.name" title="Link to this definition">¶</a></dt>

  500. <dd><p>The name used to define the <code class="docutils literal notranslate"><span class="pre">Enum</span></code> member:</p>

  501. <div class="highlight-python3 notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">Color</span><span class="o">.</span><span class="n">BLUE</span><span class="o">.</span><span class="n">name</span>

  502. <span class="go">&#39;BLUE&#39;</span>

  503. </pre></div>

  504. </div>

  505. </dd></dl>

  506. 

  507. <dl class="py attribute">

  508. <dt class="sig sig-object py" id="enum.Enum.value">

  509. <span class="sig-name descname"><span class="pre">value</span></span><a class="headerlink" href="#enum.Enum.value" title="Link to this definition">¶</a></dt>

  510. <dd><p>The value given to the <code class="docutils literal notranslate"><span class="pre">Enum</span></code> member:</p>

  511. <div class="highlight-python3 notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">Color</span><span class="o">.</span><span class="n">RED</span><span class="o">.</span><span class="n">value</span>

  512. <span class="go">1</span>

  513. </pre></div>

  514. </div>

  515. <p>Value of the member, can be set in <a class="reference internal" href="../reference/datamodel.html#object.__new__" title="object.__new__"><code class="xref py py-meth docutils literal notranslate"><span class="pre">__new__()</span></code></a>.</p>

  516. <div class="admonition note">

  517. <p class="admonition-title">Note</p>

  518. <p>Enum member values</p>

  519. <p>Member values can be anything: <a class="reference internal" href="functions.html#int" title="int"><code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code></a>, <a class="reference internal" href="stdtypes.html#str" title="str"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></a>, etc.  If

  520. the exact value is unimportant you may use <a class="reference internal" href="#enum.auto" title="enum.auto"><code class="xref py py-class docutils literal notranslate"><span class="pre">auto</span></code></a> instances and an

  521. appropriate value will be chosen for you.  See <a class="reference internal" href="#enum.auto" title="enum.auto"><code class="xref py py-class docutils literal notranslate"><span class="pre">auto</span></code></a> for the

  522. details.</p>

  523. <p>While mutable/unhashable values, such as <a class="reference internal" href="stdtypes.html#dict" title="dict"><code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code></a>, <a class="reference internal" href="stdtypes.html#list" title="list"><code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code></a> or

  524. a mutable <a class="reference internal" href="dataclasses.html#dataclasses.dataclass" title="dataclasses.dataclass"><code class="xref py py-class docutils literal notranslate"><span class="pre">dataclass</span></code></a>, can be used, they will have a

  525. quadratic performance impact during creation relative to the

  526. total number of mutable/unhashable values in the enum.</p>

  527. </div>

  528. </dd></dl>

  529. 

  530. <dl class="py attribute">

  531. <dt class="sig sig-object py" id="enum.Enum._name_">

  532. <span class="sig-name descname"><span class="pre">_name_</span></span><a class="headerlink" href="#enum.Enum._name_" title="Link to this definition">¶</a></dt>

  533. <dd><p>Name of the member.</p>

  534. </dd></dl>

  535. 

  536. <dl class="py attribute">

  537. <dt class="sig sig-object py" id="enum.Enum._value_">

  538. <span class="sig-name descname"><span class="pre">_value_</span></span><a class="headerlink" href="#enum.Enum._value_" title="Link to this definition">¶</a></dt>

  539. <dd><p>Value of the member, can be set in <a class="reference internal" href="../reference/datamodel.html#object.__new__" title="object.__new__"><code class="xref py py-meth docutils literal notranslate"><span class="pre">__new__()</span></code></a>.</p>

  540. </dd></dl>

  541. 

  542. <dl class="py attribute">

  543. <dt class="sig sig-object py" id="enum.Enum._order_">

  544. <span class="sig-name descname"><span class="pre">_order_</span></span><a class="headerlink" href="#enum.Enum._order_" title="Link to this definition">¶</a></dt>

  545. <dd><p>No longer used, kept for backward compatibility.

  546. (class attribute, removed during class creation).</p>

  547. </dd></dl>

  548. 

  549. <dl class="py attribute">

  550. <dt class="sig sig-object py" id="enum.Enum._ignore_">

  551. <span class="sig-name descname"><span class="pre">_ignore_</span></span><a class="headerlink" href="#enum.Enum._ignore_" title="Link to this definition">¶</a></dt>

  552. <dd><p><code class="docutils literal notranslate"><span class="pre">_ignore_</span></code> is only used during creation and is removed from the

  553. enumeration once creation is complete.</p>

  554. <p><code class="docutils literal notranslate"><span class="pre">_ignore_</span></code> is a list of names that will not become members, and whose

  555. names will also be removed from the completed enumeration.  See

  556. <a class="reference internal" href="../howto/enum.html#enum-time-period"><span class="std std-ref">TimePeriod</span></a> for an example.</p>

  557. </dd></dl>

  558. 

  559. <dl class="py method">

  560. <dt class="sig sig-object py" id="enum.Enum.__dir__">

  561. <span class="sig-name descname"><span class="pre">__dir__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#enum.Enum.__dir__" title="Link to this definition">¶</a></dt>

  562. <dd><p>Returns <code class="docutils literal notranslate"><span class="pre">['__class__',</span> <span class="pre">'__doc__',</span> <span class="pre">'__module__',</span> <span class="pre">'name',</span> <span class="pre">'value']</span></code> and

  563. any public methods defined on <em>self.__class__</em>:</p>

  564. <div class="highlight-python3 notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="kn">from</span> <span class="nn">datetime</span> <span class="kn">import</span> <span class="n">date</span>

  565. <span class="gp">&gt;&gt;&gt; </span><span class="k">class</span> <span class="nc">Weekday</span><span class="p">(</span><span class="n">Enum</span><span class="p">):</span>

  566. <span class="gp">... </span>    <span class="n">MONDAY</span> <span class="o">=</span> <span class="mi">1</span>

  567. <span class="gp">... </span>    <span class="n">TUESDAY</span> <span class="o">=</span> <span class="mi">2</span>

  568. <span class="gp">... </span>    <span class="n">WEDNESDAY</span> <span class="o">=</span> <span class="mi">3</span>

  569. <span class="gp">... </span>    <span class="n">THURSDAY</span> <span class="o">=</span> <span class="mi">4</span>

  570. <span class="gp">... </span>    <span class="n">FRIDAY</span> <span class="o">=</span> <span class="mi">5</span>

  571. <span class="gp">... </span>    <span class="n">SATURDAY</span> <span class="o">=</span> <span class="mi">6</span>

  572. <span class="gp">... </span>    <span class="n">SUNDAY</span> <span class="o">=</span> <span class="mi">7</span>

  573. <span class="gp">... </span>    <span class="nd">@classmethod</span>

  574. <span class="gp">... </span>    <span class="k">def</span> <span class="nf">today</span><span class="p">(</span><span class="bp">cls</span><span class="p">):</span>

  575. <span class="gp">... </span>        <span class="nb">print</span><span class="p">(</span><span class="s1">&#39;today is </span><span class="si">%s</span><span class="s1">&#39;</span> <span class="o">%</span> <span class="bp">cls</span><span class="p">(</span><span class="n">date</span><span class="o">.</span><span class="n">today</span><span class="p">()</span><span class="o">.</span><span class="n">isoweekday</span><span class="p">())</span><span class="o">.</span><span class="n">name</span><span class="p">)</span>

  576. <span class="gp">...</span>

  577. <span class="gp">&gt;&gt;&gt; </span><span class="nb">dir</span><span class="p">(</span><span class="n">Weekday</span><span class="o">.</span><span class="n">SATURDAY</span><span class="p">)</span>

  578. <span class="go">[&#39;__class__&#39;, &#39;__doc__&#39;, &#39;__eq__&#39;, &#39;__hash__&#39;, &#39;__module__&#39;, &#39;name&#39;, &#39;today&#39;, &#39;value&#39;]</span>

  579. </pre></div>

  580. </div>

  581. </dd></dl>

  582. 

  583. <dl class="py method">

  584. <dt class="sig sig-object py" id="enum.Enum._generate_next_value_">

  585. <span class="sig-name descname"><span class="pre">_generate_next_value_</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">start</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">count</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">last_values</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#enum.Enum._generate_next_value_" title="Link to this definition">¶</a></dt>

  586. <dd><blockquote>

  587. <div><dl class="field-list simple">

  588. <dt class="field-odd">name<span class="colon">:</span></dt>

  589. <dd class="field-odd"><p>The name of the member being defined (e.g. ‘RED’).</p>

  590. </dd>

  591. <dt class="field-even">start<span class="colon">:</span></dt>

  592. <dd class="field-even"><p>The start value for the Enum; the default is 1.</p>

  593. </dd>

  594. <dt class="field-odd">count<span class="colon">:</span></dt>

  595. <dd class="field-odd"><p>The number of members currently defined, not including this one.</p>

  596. </dd>

  597. <dt class="field-even">last_values<span class="colon">:</span></dt>

  598. <dd class="field-even"><p>A list of the previous values.</p>

  599. </dd>

  600. </dl>

  601. </div></blockquote>

  602. <p>A <em>staticmethod</em> that is used to determine the next value returned by

  603. <a class="reference internal" href="#enum.auto" title="enum.auto"><code class="xref py py-class docutils literal notranslate"><span class="pre">auto</span></code></a>:</p>

  604. <div class="highlight-python3 notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="kn">from</span> <span class="nn">enum</span> <span class="kn">import</span> <span class="n">auto</span>

  605. <span class="gp">&gt;&gt;&gt; </span><span class="k">class</span> <span class="nc">PowersOfThree</span><span class="p">(</span><span class="n">Enum</span><span class="p">):</span>

  606. <span class="gp">... </span>    <span class="nd">@staticmethod</span>

  607. <span class="gp">... </span>    <span class="k">def</span> <span class="nf">_generate_next_value_</span><span class="p">(</span><span class="n">name</span><span class="p">,</span> <span class="n">start</span><span class="p">,</span> <span class="n">count</span><span class="p">,</span> <span class="n">last_values</span><span class="p">):</span>

  608. <span class="gp">... </span>        <span class="k">return</span> <span class="mi">3</span> <span class="o">**</span> <span class="p">(</span><span class="n">count</span> <span class="o">+</span> <span class="mi">1</span><span class="p">)</span>

  609. <span class="gp">... </span>    <span class="n">FIRST</span> <span class="o">=</span> <span class="n">auto</span><span class="p">()</span>

  610. <span class="gp">... </span>    <span class="n">SECOND</span> <span class="o">=</span> <span class="n">auto</span><span class="p">()</span>

  611. <span class="gp">...</span>

  612. <span class="gp">&gt;&gt;&gt; </span><span class="n">PowersOfThree</span><span class="o">.</span><span class="n">SECOND</span><span class="o">.</span><span class="n">value</span>

  613. <span class="go">9</span>

  614. </pre></div>

  615. </div>

  616. </dd></dl>

  617. 

  618. <dl class="py method">

  619. <dt class="sig sig-object py" id="enum.Enum.__init__">

  620. <span class="sig-name descname"><span class="pre">__init__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwds</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#enum.Enum.__init__" title="Link to this definition">¶</a></dt>

  621. <dd><p>By default, does nothing.  If multiple values are given in the member

  622. assignment, those values become separate arguments to <code class="docutils literal notranslate"><span class="pre">__init__</span></code>; e.g.</p>

  623. <div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="kn">from</span> <span class="nn">enum</span> <span class="kn">import</span> <span class="n">Enum</span>

  624. <span class="gp">&gt;&gt;&gt; </span><span class="k">class</span> <span class="nc">Weekday</span><span class="p">(</span><span class="n">Enum</span><span class="p">):</span>

  625. <span class="gp">... </span>    <span class="n">MONDAY</span> <span class="o">=</span> <span class="mi">1</span><span class="p">,</span> <span class="s1">&#39;Mon&#39;</span>

  626. </pre></div>

  627. </div>

  628. <p><code class="docutils literal notranslate"><span class="pre">Weekday.__init__()</span></code> would be called as <code class="docutils literal notranslate"><span class="pre">Weekday.__init__(self,</span> <span class="pre">1,</span> <span class="pre">'Mon')</span></code></p>

  629. </dd></dl>

  630. 

  631. <dl class="py method">

  632. <dt class="sig sig-object py" id="enum.Enum.__init_subclass__">

  633. <span class="sig-name descname"><span class="pre">__init_subclass__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cls</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwds</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#enum.Enum.__init_subclass__" title="Link to this definition">¶</a></dt>

  634. <dd><p>A <em>classmethod</em> that is used to further configure subsequent subclasses.

  635. By default, does nothing.</p>

  636. </dd></dl>

  637. 

  638. <dl class="py method">

  639. <dt class="sig sig-object py" id="enum.Enum._missing_">

  640. <span class="sig-name descname"><span class="pre">_missing_</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cls</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">value</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#enum.Enum._missing_" title="Link to this definition">¶</a></dt>

  641. <dd><p>A <em>classmethod</em> for looking up values not found in <em>cls</em>.  By default it

  642. does nothing, but can be overridden to implement custom search behavior:</p>

  643. <div class="highlight-python3 notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="kn">from</span> <span class="nn">enum</span> <span class="kn">import</span> <span class="n">StrEnum</span>

  644. <span class="gp">&gt;&gt;&gt; </span><span class="k">class</span> <span class="nc">Build</span><span class="p">(</span><span class="n">StrEnum</span><span class="p">):</span>

  645. <span class="gp">... </span>    <span class="n">DEBUG</span> <span class="o">=</span> <span class="n">auto</span><span class="p">()</span>

  646. <span class="gp">... </span>    <span class="n">OPTIMIZED</span> <span class="o">=</span> <span class="n">auto</span><span class="p">()</span>

  647. <span class="gp">... </span>    <span class="nd">@classmethod</span>

  648. <span class="gp">... </span>    <span class="k">def</span> <span class="nf">_missing_</span><span class="p">(</span><span class="bp">cls</span><span class="p">,</span> <span class="n">value</span><span class="p">):</span>

  649. <span class="gp">... </span>        <span class="n">value</span> <span class="o">=</span> <span class="n">value</span><span class="o">.</span><span class="n">lower</span><span class="p">()</span>

  650. <span class="gp">... </span>        <span class="k">for</span> <span class="n">member</span> <span class="ow">in</span> <span class="bp">cls</span><span class="p">:</span>

  651. <span class="gp">... </span>            <span class="k">if</span> <span class="n">member</span><span class="o">.</span><span class="n">value</span> <span class="o">==</span> <span class="n">value</span><span class="p">:</span>

  652. <span class="gp">... </span>                <span class="k">return</span> <span class="n">member</span>

  653. <span class="gp">... </span>        <span class="k">return</span> <span class="kc">None</span>

  654. <span class="gp">...</span>

  655. <span class="gp">&gt;&gt;&gt; </span><span class="n">Build</span><span class="o">.</span><span class="n">DEBUG</span><span class="o">.</span><span class="n">value</span>

  656. <span class="go">&#39;debug&#39;</span>

  657. <span class="gp">&gt;&gt;&gt; </span><span class="n">Build</span><span class="p">(</span><span class="s1">&#39;deBUG&#39;</span><span class="p">)</span>

  658. <span class="go">&lt;Build.DEBUG: &#39;debug&#39;&gt;</span>

  659. </pre></div>

  660. </div>

  661. </dd></dl>

  662. 

  663. <dl class="py method">

  664. <dt class="sig sig-object py" id="enum.Enum.__new__">

  665. <span class="sig-name descname"><span class="pre">__new__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cls</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwds</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#enum.Enum.__new__" title="Link to this definition">¶</a></dt>

  666. <dd><p>By default, doesn’t exist.  If specified, either in the enum class

  667. definition or in a mixin class (such as <code class="docutils literal notranslate"><span class="pre">int</span></code>), all values given

  668. in the member assignment will be passed; e.g.</p>

  669. <div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="kn">from</span> <span class="nn">enum</span> <span class="kn">import</span> <span class="n">Enum</span>

  670. <span class="gp">&gt;&gt;&gt; </span><span class="k">class</span> <span class="nc">MyIntEnum</span><span class="p">(</span><span class="n">Enum</span><span class="p">):</span>

  671. <span class="gp">... </span>    <span class="n">SEVENTEEN</span> <span class="o">=</span> <span class="s1">&#39;1a&#39;</span><span class="p">,</span> <span class="mi">16</span>

  672. </pre></div>

  673. </div>

  674. <p>results in the call <code class="docutils literal notranslate"><span class="pre">int('1a',</span> <span class="pre">16)</span></code> and a value of <code class="docutils literal notranslate"><span class="pre">17</span></code> for the member.</p>

  675. <dl class="simple">

  676. <dt>..note:: When writing a custom <code class="docutils literal notranslate"><span class="pre">__new__</span></code>, do not use <code class="docutils literal notranslate"><span class="pre">super().__new__</span></code> –</dt><dd><p>call the appropriate <code class="docutils literal notranslate"><span class="pre">__new__</span></code> instead.</p>

  677. </dd>

  678. </dl>

  679. </dd></dl>

  680. 

  681. <dl class="py method">

  682. <dt class="sig sig-object py" id="enum.Enum.__repr__">

  683. <span class="sig-name descname"><span class="pre">__repr__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#enum.Enum.__repr__" title="Link to this definition">¶</a></dt>

  684. <dd><p>Returns the string used for <em>repr()</em> calls.  By default, returns the

  685. <em>Enum</em> name, member name, and value, but can be overridden:</p>

  686. <div class="highlight-python3 notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="k">class</span> <span class="nc">OtherStyle</span><span class="p">(</span><span class="n">Enum</span><span class="p">):</span>

  687. <span class="gp">... </span>    <span class="n">ALTERNATE</span> <span class="o">=</span> <span class="n">auto</span><span class="p">()</span>

  688. <span class="gp">... </span>    <span class="n">OTHER</span> <span class="o">=</span> <span class="n">auto</span><span class="p">()</span>

  689. <span class="gp">... </span>    <span class="n">SOMETHING_ELSE</span> <span class="o">=</span> <span class="n">auto</span><span class="p">()</span>

  690. <span class="gp">... </span>    <span class="k">def</span> <span class="fm">__repr__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>

  691. <span class="gp">... </span>        <span class="n">cls_name</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="vm">__class__</span><span class="o">.</span><span class="vm">__name__</span>

  692. <span class="gp">... </span>        <span class="k">return</span> <span class="sa">f</span><span class="s1">&#39;</span><span class="si">{</span><span class="n">cls_name</span><span class="si">}</span><span class="s1">.</span><span class="si">{</span><span class="bp">self</span><span class="o">.</span><span class="n">name</span><span class="si">}</span><span class="s1">&#39;</span>

  693. <span class="gp">...</span>

  694. <span class="gp">&gt;&gt;&gt; </span><span class="n">OtherStyle</span><span class="o">.</span><span class="n">ALTERNATE</span><span class="p">,</span> <span class="nb">str</span><span class="p">(</span><span class="n">OtherStyle</span><span class="o">.</span><span class="n">ALTERNATE</span><span class="p">),</span> <span class="sa">f</span><span class="s2">&quot;</span><span class="si">{</span><span class="n">OtherStyle</span><span class="o">.</span><span class="n">ALTERNATE</span><span class="si">}</span><span class="s2">&quot;</span>

  695. <span class="go">(OtherStyle.ALTERNATE, &#39;OtherStyle.ALTERNATE&#39;, &#39;OtherStyle.ALTERNATE&#39;)</span>

  696. </pre></div>

  697. </div>

  698. </dd></dl>

  699. 

  700. <dl class="py method">

  701. <dt class="sig sig-object py" id="enum.Enum.__str__">

  702. <span class="sig-name descname"><span class="pre">__str__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#enum.Enum.__str__" title="Link to this definition">¶</a></dt>

  703. <dd><p>Returns the string used for <em>str()</em> calls.  By default, returns the

  704. <em>Enum</em> name and member name, but can be overridden:</p>

  705. <div class="highlight-python3 notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="k">class</span> <span class="nc">OtherStyle</span><span class="p">(</span><span class="n">Enum</span><span class="p">):</span>

  706. <span class="gp">... </span>    <span class="n">ALTERNATE</span> <span class="o">=</span> <span class="n">auto</span><span class="p">()</span>

  707. <span class="gp">... </span>    <span class="n">OTHER</span> <span class="o">=</span> <span class="n">auto</span><span class="p">()</span>

  708. <span class="gp">... </span>    <span class="n">SOMETHING_ELSE</span> <span class="o">=</span> <span class="n">auto</span><span class="p">()</span>

  709. <span class="gp">... </span>    <span class="k">def</span> <span class="fm">__str__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>

  710. <span class="gp">... </span>        <span class="k">return</span> <span class="sa">f</span><span class="s1">&#39;</span><span class="si">{</span><span class="bp">self</span><span class="o">.</span><span class="n">name</span><span class="si">}</span><span class="s1">&#39;</span>

  711. <span class="gp">...</span>

  712. <span class="gp">&gt;&gt;&gt; </span><span class="n">OtherStyle</span><span class="o">.</span><span class="n">ALTERNATE</span><span class="p">,</span> <span class="nb">str</span><span class="p">(</span><span class="n">OtherStyle</span><span class="o">.</span><span class="n">ALTERNATE</span><span class="p">),</span> <span class="sa">f</span><span class="s2">&quot;</span><span class="si">{</span><span class="n">OtherStyle</span><span class="o">.</span><span class="n">ALTERNATE</span><span class="si">}</span><span class="s2">&quot;</span>

  713. <span class="go">(&lt;OtherStyle.ALTERNATE: 1&gt;, &#39;ALTERNATE&#39;, &#39;ALTERNATE&#39;)</span>

  714. </pre></div>

  715. </div>

  716. </dd></dl>

  717. 

  718. <dl class="py method">

  719. <dt class="sig sig-object py" id="enum.Enum.__format__">

  720. <span class="sig-name descname"><span class="pre">__format__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#enum.Enum.__format__" title="Link to this definition">¶</a></dt>

  721. <dd><p>Returns the string used for <em>format()</em> and <em>f-string</em> calls.  By default,

  722. returns <a class="reference internal" href="#enum.Enum.__str__" title="enum.Enum.__str__"><code class="xref py py-meth docutils literal notranslate"><span class="pre">__str__()</span></code></a> return value, but can be overridden:</p>

  723. <div class="highlight-python3 notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="k">class</span> <span class="nc">OtherStyle</span><span class="p">(</span><span class="n">Enum</span><span class="p">):</span>

  724. <span class="gp">... </span>    <span class="n">ALTERNATE</span> <span class="o">=</span> <span class="n">auto</span><span class="p">()</span>

  725. <span class="gp">... </span>    <span class="n">OTHER</span> <span class="o">=</span> <span class="n">auto</span><span class="p">()</span>

  726. <span class="gp">... </span>    <span class="n">SOMETHING_ELSE</span> <span class="o">=</span> <span class="n">auto</span><span class="p">()</span>

  727. <span class="gp">... </span>    <span class="k">def</span> <span class="fm">__format__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">spec</span><span class="p">):</span>

  728. <span class="gp">... </span>        <span class="k">return</span> <span class="sa">f</span><span class="s1">&#39;</span><span class="si">{</span><span class="bp">self</span><span class="o">.</span><span class="n">name</span><span class="si">}</span><span class="s1">&#39;</span>

  729. <span class="gp">...</span>

  730. <span class="gp">&gt;&gt;&gt; </span><span class="n">OtherStyle</span><span class="o">.</span><span class="n">ALTERNATE</span><span class="p">,</span> <span class="nb">str</span><span class="p">(</span><span class="n">OtherStyle</span><span class="o">.</span><span class="n">ALTERNATE</span><span class="p">),</span> <span class="sa">f</span><span class="s2">&quot;</span><span class="si">{</span><span class="n">OtherStyle</span><span class="o">.</span><span class="n">ALTERNATE</span><span class="si">}</span><span class="s2">&quot;</span>

  731. <span class="go">(&lt;OtherStyle.ALTERNATE: 1&gt;, &#39;OtherStyle.ALTERNATE&#39;, &#39;ALTERNATE&#39;)</span>

  732. </pre></div>

  733. </div>

  734. </dd></dl>

  735. 

  736. <div class="admonition note">

  737. <p class="admonition-title">Note</p>

  738. <p>Using <a class="reference internal" href="#enum.auto" title="enum.auto"><code class="xref py py-class docutils literal notranslate"><span class="pre">auto</span></code></a> with <a class="reference internal" href="#enum.Enum" title="enum.Enum"><code class="xref py py-class docutils literal notranslate"><span class="pre">Enum</span></code></a> results in integers of increasing value,

  739. starting with <code class="docutils literal notranslate"><span class="pre">1</span></code>.</p>

  740. </div>

  741. <div class="versionchanged">

  742. <p><span class="versionmodified changed">Changed in version 3.12: </span>Added <a class="reference internal" href="../howto/enum.html#enum-dataclass-support"><span class="std std-ref">Dataclass support</span></a></p>

  743. </div>

  744. </dd></dl>

  745. 

  746. <dl class="py class">

  747. <dt class="sig sig-object py" id="enum.IntEnum">

  748. <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">enum.</span></span><span class="sig-name descname"><span class="pre">IntEnum</span></span><a class="headerlink" href="#enum.IntEnum" title="Link to this definition">¶</a></dt>

  749. <dd><p><em>IntEnum</em> is the same as <em>Enum</em>, but its members are also integers and can be

  750. used anywhere that an integer can be used.  If any integer operation is performed

  751. with an <em>IntEnum</em> member, the resulting value loses its enumeration status.</p>

  752. <div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="kn">from</span> <span class="nn">enum</span> <span class="kn">import</span> <span class="n">IntEnum</span>

  753. <span class="gp">&gt;&gt;&gt; </span><span class="k">class</span> <span class="nc">Number</span><span class="p">(</span><span class="n">IntEnum</span><span class="p">):</span>

  754. <span class="gp">... </span>    <span class="n">ONE</span> <span class="o">=</span> <span class="mi">1</span>

  755. <span class="gp">... </span>    <span class="n">TWO</span> <span class="o">=</span> <span class="mi">2</span>

  756. <span class="gp">... </span>    <span class="n">THREE</span> <span class="o">=</span> <span class="mi">3</span>

  757. <span class="gp">...</span>

  758. <span class="gp">&gt;&gt;&gt; </span><span class="n">Number</span><span class="o">.</span><span class="n">THREE</span>

  759. <span class="go">&lt;Number.THREE: 3&gt;</span>

  760. <span class="gp">&gt;&gt;&gt; </span><span class="n">Number</span><span class="o">.</span><span class="n">ONE</span> <span class="o">+</span> <span class="n">Number</span><span class="o">.</span><span class="n">TWO</span>

  761. <span class="go">3</span>

  762. <span class="gp">&gt;&gt;&gt; </span><span class="n">Number</span><span class="o">.</span><span class="n">THREE</span> <span class="o">+</span> <span class="mi">5</span>

  763. <span class="go">8</span>

  764. <span class="gp">&gt;&gt;&gt; </span><span class="n">Number</span><span class="o">.</span><span class="n">THREE</span> <span class="o">==</span> <span class="mi">3</span>

  765. <span class="go">True</span>

  766. </pre></div>

  767. </div>

  768. <div class="admonition note">

  769. <p class="admonition-title">Note</p>

  770. <p>Using <a class="reference internal" href="#enum.auto" title="enum.auto"><code class="xref py py-class docutils literal notranslate"><span class="pre">auto</span></code></a> with <a class="reference internal" href="#enum.IntEnum" title="enum.IntEnum"><code class="xref py py-class docutils literal notranslate"><span class="pre">IntEnum</span></code></a> results in integers of increasing

  771. value, starting with <code class="docutils literal notranslate"><span class="pre">1</span></code>.</p>

  772. </div>

  773. <div class="versionchanged">

  774. <p><span class="versionmodified changed">Changed in version 3.11: </span><a class="reference internal" href="../reference/datamodel.html#object.__str__" title="object.__str__"><code class="xref py py-meth docutils literal notranslate"><span class="pre">__str__()</span></code></a> is now <code class="xref py py-meth docutils literal notranslate"><span class="pre">int.__str__()</span></code> to

  775. better support the <em>replacement of existing constants</em> use-case.

  776. <a class="reference internal" href="../reference/datamodel.html#object.__format__" title="object.__format__"><code class="xref py py-meth docutils literal notranslate"><span class="pre">__format__()</span></code></a> was already <code class="xref py py-meth docutils literal notranslate"><span class="pre">int.__format__()</span></code> for that same reason.</p>

  777. </div>

  778. </dd></dl>

  779. 

  780. <dl class="py class">

  781. <dt class="sig sig-object py" id="enum.StrEnum">

  782. <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">enum.</span></span><span class="sig-name descname"><span class="pre">StrEnum</span></span><a class="headerlink" href="#enum.StrEnum" title="Link to this definition">¶</a></dt>

  783. <dd><p><em>StrEnum</em> is the same as <em>Enum</em>, but its members are also strings and can be used

  784. in most of the same places that a string can be used.  The result of any string

  785. operation performed on or with a <em>StrEnum</em> member is not part of the enumeration.</p>

  786. <div class="admonition note">

  787. <p class="admonition-title">Note</p>

  788. <p>There are places in the stdlib that check for an exact <a class="reference internal" href="stdtypes.html#str" title="str"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></a>

  789. instead of a <a class="reference internal" href="stdtypes.html#str" title="str"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></a> subclass (i.e. <code class="docutils literal notranslate"><span class="pre">type(unknown)</span> <span class="pre">==</span> <span class="pre">str</span></code>

  790. instead of <code class="docutils literal notranslate"><span class="pre">isinstance(unknown,</span> <span class="pre">str)</span></code>), and in those locations you

  791. will need to use <code class="docutils literal notranslate"><span class="pre">str(StrEnum.member)</span></code>.</p>

  792. </div>

  793. <div class="admonition note">

  794. <p class="admonition-title">Note</p>

  795. <p>Using <a class="reference internal" href="#enum.auto" title="enum.auto"><code class="xref py py-class docutils literal notranslate"><span class="pre">auto</span></code></a> with <a class="reference internal" href="#enum.StrEnum" title="enum.StrEnum"><code class="xref py py-class docutils literal notranslate"><span class="pre">StrEnum</span></code></a> results in the lower-cased member

  796. name as the value.</p>

  797. </div>

  798. <div class="admonition note">

  799. <p class="admonition-title">Note</p>

  800. <p><a class="reference internal" href="../reference/datamodel.html#object.__str__" title="object.__str__"><code class="xref py py-meth docutils literal notranslate"><span class="pre">__str__()</span></code></a> is <code class="xref py py-meth docutils literal notranslate"><span class="pre">str.__str__()</span></code> to better support the

  801. <em>replacement of existing constants</em> use-case.  <a class="reference internal" href="../reference/datamodel.html#object.__format__" title="object.__format__"><code class="xref py py-meth docutils literal notranslate"><span class="pre">__format__()</span></code></a> is likewise

  802. <code class="xref py py-meth docutils literal notranslate"><span class="pre">str.__format__()</span></code> for that same reason.</p>

  803. </div>

  804. <div class="versionadded">

  805. <p><span class="versionmodified added">New in version 3.11.</span></p>

  806. </div>

  807. </dd></dl>

  808. 

  809. <dl class="py class">

  810. <dt class="sig sig-object py" id="enum.Flag">

  811. <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">enum.</span></span><span class="sig-name descname"><span class="pre">Flag</span></span><a class="headerlink" href="#enum.Flag" title="Link to this definition">¶</a></dt>

  812. <dd><p><code class="docutils literal notranslate"><span class="pre">Flag</span></code> is the same as <a class="reference internal" href="#enum.Enum" title="enum.Enum"><code class="xref py py-class docutils literal notranslate"><span class="pre">Enum</span></code></a>, but its members support the bitwise

  813. operators <code class="docutils literal notranslate"><span class="pre">&amp;</span></code> (<em>AND</em>), <code class="docutils literal notranslate"><span class="pre">|</span></code> (<em>OR</em>), <code class="docutils literal notranslate"><span class="pre">^</span></code> (<em>XOR</em>), and <code class="docutils literal notranslate"><span class="pre">~</span></code> (<em>INVERT</em>);

  814. the results of those operators are members of the enumeration.</p>

  815. <dl class="py method">

  816. <dt class="sig sig-object py" id="enum.Flag.__contains__">

  817. <span class="sig-name descname"><span class="pre">__contains__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">value</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#enum.Flag.__contains__" title="Link to this definition">¶</a></dt>

  818. <dd><p>Returns <em>True</em> if value is in self:</p>

  819. <div class="highlight-python3 notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="kn">from</span> <span class="nn">enum</span> <span class="kn">import</span> <span class="n">Flag</span><span class="p">,</span> <span class="n">auto</span>

  820. <span class="gp">&gt;&gt;&gt; </span><span class="k">class</span> <span class="nc">Color</span><span class="p">(</span><span class="n">Flag</span><span class="p">):</span>

  821. <span class="gp">... </span>    <span class="n">RED</span> <span class="o">=</span> <span class="n">auto</span><span class="p">()</span>

  822. <span class="gp">... </span>    <span class="n">GREEN</span> <span class="o">=</span> <span class="n">auto</span><span class="p">()</span>

  823. <span class="gp">... </span>    <span class="n">BLUE</span> <span class="o">=</span> <span class="n">auto</span><span class="p">()</span>

  824. <span class="gp">...</span>

  825. <span class="gp">&gt;&gt;&gt; </span><span class="n">purple</span> <span class="o">=</span> <span class="n">Color</span><span class="o">.</span><span class="n">RED</span> <span class="o">|</span> <span class="n">Color</span><span class="o">.</span><span class="n">BLUE</span>

  826. <span class="gp">&gt;&gt;&gt; </span><span class="n">white</span> <span class="o">=</span> <span class="n">Color</span><span class="o">.</span><span class="n">RED</span> <span class="o">|</span> <span class="n">Color</span><span class="o">.</span><span class="n">GREEN</span> <span class="o">|</span> <span class="n">Color</span><span class="o">.</span><span class="n">BLUE</span>

  827. <span class="gp">&gt;&gt;&gt; </span><span class="n">Color</span><span class="o">.</span><span class="n">GREEN</span> <span class="ow">in</span> <span class="n">purple</span>

  828. <span class="go">False</span>

  829. <span class="gp">&gt;&gt;&gt; </span><span class="n">Color</span><span class="o">.</span><span class="n">GREEN</span> <span class="ow">in</span> <span class="n">white</span>

  830. <span class="go">True</span>

  831. <span class="gp">&gt;&gt;&gt; </span><span class="n">purple</span> <span class="ow">in</span> <span class="n">white</span>

  832. <span class="go">True</span>

  833. <span class="gp">&gt;&gt;&gt; </span><span class="n">white</span> <span class="ow">in</span> <span class="n">purple</span>

  834. <span class="go">False</span>

  835. </pre></div>

  836. </div>

  837. </dd></dl>

  838. 

  839. <dl class="py method">

  840. <dt class="sig sig-object py">

  841. <span class="sig-name descname"><span class="pre">__iter__(self):</span></span></dt>

  842. <dd><p>Returns all contained non-alias members:</p>

  843. <div class="highlight-python3 notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="nb">list</span><span class="p">(</span><span class="n">Color</span><span class="o">.</span><span class="n">RED</span><span class="p">)</span>

  844. <span class="go">[&lt;Color.RED: 1&gt;]</span>

  845. <span class="gp">&gt;&gt;&gt; </span><span class="nb">list</span><span class="p">(</span><span class="n">purple</span><span class="p">)</span>

  846. <span class="go">[&lt;Color.RED: 1&gt;, &lt;Color.BLUE: 4&gt;]</span>

  847. </pre></div>

  848. </div>

  849. <div class="versionadded">

  850. <p><span class="versionmodified added">New in version 3.11.</span></p>

  851. </div>

  852. </dd></dl>

  853. 

  854. <dl class="py method">

  855. <dt class="sig sig-object py">

  856. <span class="sig-name descname"><span class="pre">__len__(self):</span></span></dt>

  857. <dd><p>Returns number of members in flag:</p>

  858. <div class="highlight-python3 notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="nb">len</span><span class="p">(</span><span class="n">Color</span><span class="o">.</span><span class="n">GREEN</span><span class="p">)</span>

  859. <span class="go">1</span>

  860. <span class="gp">&gt;&gt;&gt; </span><span class="nb">len</span><span class="p">(</span><span class="n">white</span><span class="p">)</span>

  861. <span class="go">3</span>

  862. </pre></div>

  863. </div>

  864. </dd></dl>

  865. 

  866. <dl class="py method">

  867. <dt class="sig sig-object py">

  868. <span class="sig-name descname"><span class="pre">__bool__(self):</span></span></dt>

  869. <dd><p>Returns <em>True</em> if any members in flag, <em>False</em> otherwise:</p>

  870. <div class="highlight-python3 notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="nb">bool</span><span class="p">(</span><span class="n">Color</span><span class="o">.</span><span class="n">GREEN</span><span class="p">)</span>

  871. <span class="go">True</span>

  872. <span class="gp">&gt;&gt;&gt; </span><span class="nb">bool</span><span class="p">(</span><span class="n">white</span><span class="p">)</span>

  873. <span class="go">True</span>

  874. <span class="gp">&gt;&gt;&gt; </span><span class="n">black</span> <span class="o">=</span> <span class="n">Color</span><span class="p">(</span><span class="mi">0</span><span class="p">)</span>

  875. <span class="gp">&gt;&gt;&gt; </span><span class="nb">bool</span><span class="p">(</span><span class="n">black</span><span class="p">)</span>

  876. <span class="go">False</span>

  877. </pre></div>

  878. </div>

  879. </dd></dl>

  880. 

  881. <dl class="py method">

  882. <dt class="sig sig-object py" id="enum.Flag.__or__">

  883. <span class="sig-name descname"><span class="pre">__or__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">other</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#enum.Flag.__or__" title="Link to this definition">¶</a></dt>

  884. <dd><p>Returns current flag binary or’ed with other:</p>

  885. <div class="highlight-python3 notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">Color</span><span class="o">.</span><span class="n">RED</span> <span class="o">|</span> <span class="n">Color</span><span class="o">.</span><span class="n">GREEN</span>

  886. <span class="go">&lt;Color.RED|GREEN: 3&gt;</span>

  887. </pre></div>

  888. </div>

  889. </dd></dl>

  890. 

  891. <dl class="py method">

  892. <dt class="sig sig-object py" id="enum.Flag.__and__">

  893. <span class="sig-name descname"><span class="pre">__and__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">other</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#enum.Flag.__and__" title="Link to this definition">¶</a></dt>

  894. <dd><p>Returns current flag binary and’ed with other:</p>

  895. <div class="highlight-python3 notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">purple</span> <span class="o">&amp;</span> <span class="n">white</span>

  896. <span class="go">&lt;Color.RED|BLUE: 5&gt;</span>

  897. <span class="gp">&gt;&gt;&gt; </span><span class="n">purple</span> <span class="o">&amp;</span> <span class="n">Color</span><span class="o">.</span><span class="n">GREEN</span>

  898. <span class="go">&lt;Color: 0&gt;</span>

  899. </pre></div>

  900. </div>

  901. </dd></dl>

  902. 

  903. <dl class="py method">

  904. <dt class="sig sig-object py" id="enum.Flag.__xor__">

  905. <span class="sig-name descname"><span class="pre">__xor__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">other</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#enum.Flag.__xor__" title="Link to this definition">¶</a></dt>

  906. <dd><p>Returns current flag binary xor’ed with other:</p>

  907. <div class="highlight-python3 notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">purple</span> <span class="o">^</span> <span class="n">white</span>

  908. <span class="go">&lt;Color.GREEN: 2&gt;</span>

  909. <span class="gp">&gt;&gt;&gt; </span><span class="n">purple</span> <span class="o">^</span> <span class="n">Color</span><span class="o">.</span><span class="n">GREEN</span>

  910. <span class="go">&lt;Color.RED|GREEN|BLUE: 7&gt;</span>

  911. </pre></div>

  912. </div>

  913. </dd></dl>

  914. 

  915. <dl class="py method">

  916. <dt class="sig sig-object py">

  917. <span class="sig-name descname"><span class="pre">__invert__(self):</span></span></dt>

  918. <dd><p>Returns all the flags in <em>type(self)</em> that are not in self:</p>

  919. <div class="highlight-python3 notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="o">~</span><span class="n">white</span>

  920. <span class="go">&lt;Color: 0&gt;</span>

  921. <span class="gp">&gt;&gt;&gt; </span><span class="o">~</span><span class="n">purple</span>

  922. <span class="go">&lt;Color.GREEN: 2&gt;</span>

  923. <span class="gp">&gt;&gt;&gt; </span><span class="o">~</span><span class="n">Color</span><span class="o">.</span><span class="n">RED</span>

  924. <span class="go">&lt;Color.GREEN|BLUE: 6&gt;</span>

  925. </pre></div>

  926. </div>

  927. </dd></dl>

  928. 

  929. <dl class="py method">

  930. <dt class="sig sig-object py" id="enum.Flag._numeric_repr_">

  931. <span class="sig-name descname"><span class="pre">_numeric_repr_</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#enum.Flag._numeric_repr_" title="Link to this definition">¶</a></dt>

  932. <dd><p>Function used to format any remaining unnamed numeric values.  Default is

  933. the value’s repr; common choices are <a class="reference internal" href="functions.html#hex" title="hex"><code class="xref py py-func docutils literal notranslate"><span class="pre">hex()</span></code></a> and <a class="reference internal" href="functions.html#oct" title="oct"><code class="xref py py-func docutils literal notranslate"><span class="pre">oct()</span></code></a>.</p>

  934. </dd></dl>

  935. 

  936. <div class="admonition note">

  937. <p class="admonition-title">Note</p>

  938. <p>Using <a class="reference internal" href="#enum.auto" title="enum.auto"><code class="xref py py-class docutils literal notranslate"><span class="pre">auto</span></code></a> with <a class="reference internal" href="#enum.Flag" title="enum.Flag"><code class="xref py py-class docutils literal notranslate"><span class="pre">Flag</span></code></a> results in integers that are powers

  939. of two, starting with <code class="docutils literal notranslate"><span class="pre">1</span></code>.</p>

  940. </div>

  941. <div class="versionchanged">

  942. <p><span class="versionmodified changed">Changed in version 3.11: </span>The <em>repr()</em> of zero-valued flags has changed.  It

  943. is now::</p>

  944. <div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">Color</span><span class="p">(</span><span class="mi">0</span><span class="p">)</span> 

  945. <span class="go">&lt;Color: 0&gt;</span>

  946. </pre></div>

  947. </div>

  948. </div>

  949. </dd></dl>

  950. 

  951. <dl class="py class">

  952. <dt class="sig sig-object py" id="enum.IntFlag">

  953. <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">enum.</span></span><span class="sig-name descname"><span class="pre">IntFlag</span></span><a class="headerlink" href="#enum.IntFlag" title="Link to this definition">¶</a></dt>

  954. <dd><p><em>IntFlag</em> is the same as <em>Flag</em>, but its members are also integers and can be

  955. used anywhere that an integer can be used.</p>

  956. <div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="kn">from</span> <span class="nn">enum</span> <span class="kn">import</span> <span class="n">IntFlag</span><span class="p">,</span> <span class="n">auto</span>

  957. <span class="gp">&gt;&gt;&gt; </span><span class="k">class</span> <span class="nc">Color</span><span class="p">(</span><span class="n">IntFlag</span><span class="p">):</span>

  958. <span class="gp">... </span>    <span class="n">RED</span> <span class="o">=</span> <span class="n">auto</span><span class="p">()</span>

  959. <span class="gp">... </span>    <span class="n">GREEN</span> <span class="o">=</span> <span class="n">auto</span><span class="p">()</span>

  960. <span class="gp">... </span>    <span class="n">BLUE</span> <span class="o">=</span> <span class="n">auto</span><span class="p">()</span>

  961. <span class="gp">...</span>

  962. <span class="gp">&gt;&gt;&gt; </span><span class="n">Color</span><span class="o">.</span><span class="n">RED</span> <span class="o">&amp;</span> <span class="mi">2</span>

  963. <span class="go">&lt;Color: 0&gt;</span>

  964. <span class="gp">&gt;&gt;&gt; </span><span class="n">Color</span><span class="o">.</span><span class="n">RED</span> <span class="o">|</span> <span class="mi">2</span>

  965. <span class="go">&lt;Color.RED|GREEN: 3&gt;</span>

  966. </pre></div>

  967. </div>

  968. <p>If any integer operation is performed with an <em>IntFlag</em> member, the result is

  969. not an <em>IntFlag</em>:</p>

  970. <div class="highlight-python3 notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">Color</span><span class="o">.</span><span class="n">RED</span> <span class="o">+</span> <span class="mi">2</span>

  971. <span class="go">3</span>

  972. </pre></div>

  973. </div>

  974. <p>If a <em>Flag</em> operation is performed with an <em>IntFlag</em> member and:</p>

  975. <ul class="simple">

  976. <li><p>the result is a valid <em>IntFlag</em>: an <em>IntFlag</em> is returned</p></li>

  977. <li><p>the result is not a valid <em>IntFlag</em>: the result depends on the <em>FlagBoundary</em> setting</p></li>

  978. </ul>

  979. <p>The <em>repr()</em> of unnamed zero-valued flags has changed.  It is now:</p>

  980. <div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">Color</span><span class="p">(</span><span class="mi">0</span><span class="p">)</span>

  981. <span class="go">&lt;Color: 0&gt;</span>

  982. </pre></div>

  983. </div>

  984. <div class="admonition note">

  985. <p class="admonition-title">Note</p>

  986. <p>Using <a class="reference internal" href="#enum.auto" title="enum.auto"><code class="xref py py-class docutils literal notranslate"><span class="pre">auto</span></code></a> with <a class="reference internal" href="#enum.IntFlag" title="enum.IntFlag"><code class="xref py py-class docutils literal notranslate"><span class="pre">IntFlag</span></code></a> results in integers that are powers

  987. of two, starting with <code class="docutils literal notranslate"><span class="pre">1</span></code>.</p>

  988. </div>

  989. <div class="versionchanged">

  990. <p><span class="versionmodified changed">Changed in version 3.11: </span><a class="reference internal" href="../reference/datamodel.html#object.__str__" title="object.__str__"><code class="xref py py-meth docutils literal notranslate"><span class="pre">__str__()</span></code></a> is now <code class="xref py py-meth docutils literal notranslate"><span class="pre">int.__str__()</span></code> to better support the

  991. <em>replacement of existing constants</em> use-case.  <a class="reference internal" href="../reference/datamodel.html#object.__format__" title="object.__format__"><code class="xref py py-meth docutils literal notranslate"><span class="pre">__format__()</span></code></a> was

  992. already <code class="xref py py-meth docutils literal notranslate"><span class="pre">int.__format__()</span></code> for that same reason.</p>

  993. <p>Inversion of an <code class="xref py py-class docutils literal notranslate"><span class="pre">IntFlag</span></code> now returns a positive value that is the

  994. union of all flags not in the given flag, rather than a negative value.

  995. This matches the existing <a class="reference internal" href="#enum.Flag" title="enum.Flag"><code class="xref py py-class docutils literal notranslate"><span class="pre">Flag</span></code></a> behavior.</p>

  996. </div>

  997. </dd></dl>

  998. 

  999. <dl class="py class">

  1000. <dt class="sig sig-object py" id="enum.ReprEnum">

  1001. <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">enum.</span></span><span class="sig-name descname"><span class="pre">ReprEnum</span></span><a class="headerlink" href="#enum.ReprEnum" title="Link to this definition">¶</a></dt>

  1002. <dd><p><code class="xref py py-class docutils literal notranslate"><span class="pre">ReprEnum</span></code> uses the <a class="reference internal" href="#enum.Enum.__repr__" title="enum.Enum.__repr__"><code class="xref py py-meth docutils literal notranslate"><span class="pre">repr()</span></code></a> of <a class="reference internal" href="#enum.Enum" title="enum.Enum"><code class="xref py py-class docutils literal notranslate"><span class="pre">Enum</span></code></a>,

  1003. but the <a class="reference internal" href="stdtypes.html#str" title="str"><code class="xref py py-class docutils literal notranslate"><span class="pre">str()</span></code></a> of the mixed-in data type:</p>

  1004. <ul class="simple">

  1005. <li><p><code class="xref py py-meth docutils literal notranslate"><span class="pre">int.__str__()</span></code> for <a class="reference internal" href="#enum.IntEnum" title="enum.IntEnum"><code class="xref py py-class docutils literal notranslate"><span class="pre">IntEnum</span></code></a> and <a class="reference internal" href="#enum.IntFlag" title="enum.IntFlag"><code class="xref py py-class docutils literal notranslate"><span class="pre">IntFlag</span></code></a></p></li>

  1006. <li><p><code class="xref py py-meth docutils literal notranslate"><span class="pre">str.__str__()</span></code> for <a class="reference internal" href="#enum.StrEnum" title="enum.StrEnum"><code class="xref py py-class docutils literal notranslate"><span class="pre">StrEnum</span></code></a></p></li>

  1007. </ul>

  1008. <p>Inherit from <code class="xref py py-class docutils literal notranslate"><span class="pre">ReprEnum</span></code> to keep the <a class="reference internal" href="stdtypes.html#str" title="str"><code class="xref py py-class docutils literal notranslate"><span class="pre">str()</span></code></a> / <a class="reference internal" href="functions.html#format" title="format"><code class="xref py py-func docutils literal notranslate"><span class="pre">format()</span></code></a>

  1009. of the mixed-in data type instead of using the

  1010. <a class="reference internal" href="#enum.Enum" title="enum.Enum"><code class="xref py py-class docutils literal notranslate"><span class="pre">Enum</span></code></a>-default <a class="reference internal" href="#enum.Enum.__str__" title="enum.Enum.__str__"><code class="xref py py-meth docutils literal notranslate"><span class="pre">str()</span></code></a>.</p>

  1011. <div class="versionadded">

  1012. <p><span class="versionmodified added">New in version 3.11.</span></p>

  1013. </div>

  1014. </dd></dl>

  1015. 

  1016. <dl class="py class">

  1017. <dt class="sig sig-object py" id="enum.EnumCheck">

  1018. <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">enum.</span></span><span class="sig-name descname"><span class="pre">EnumCheck</span></span><a class="headerlink" href="#enum.EnumCheck" title="Link to this definition">¶</a></dt>

  1019. <dd><p><em>EnumCheck</em> contains the options used by the <a class="reference internal" href="#enum.verify" title="enum.verify"><code class="xref py py-func docutils literal notranslate"><span class="pre">verify()</span></code></a> decorator to ensure

  1020. various constraints; failed constraints result in a <a class="reference internal" href="exceptions.html#ValueError" title="ValueError"><code class="xref py py-exc docutils literal notranslate"><span class="pre">ValueError</span></code></a>.</p>

  1021. <dl class="py attribute">

  1022. <dt class="sig sig-object py" id="enum.EnumCheck.UNIQUE">

  1023. <span class="sig-name descname"><span class="pre">UNIQUE</span></span><a class="headerlink" href="#enum.EnumCheck.UNIQUE" title="Link to this definition">¶</a></dt>

  1024. <dd><p>Ensure that each value has only one name:</p>

  1025. <div class="highlight-python3 notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="kn">from</span> <span class="nn">enum</span> <span class="kn">import</span> <span class="n">Enum</span><span class="p">,</span> <span class="n">verify</span><span class="p">,</span> <span class="n">UNIQUE</span>

  1026. <span class="gp">&gt;&gt;&gt; </span><span class="nd">@verify</span><span class="p">(</span><span class="n">UNIQUE</span><span class="p">)</span>

  1027. <span class="gp">... </span><span class="k">class</span> <span class="nc">Color</span><span class="p">(</span><span class="n">Enum</span><span class="p">):</span>

  1028. <span class="gp">... </span>    <span class="n">RED</span> <span class="o">=</span> <span class="mi">1</span>

  1029. <span class="gp">... </span>    <span class="n">GREEN</span> <span class="o">=</span> <span class="mi">2</span>

  1030. <span class="gp">... </span>    <span class="n">BLUE</span> <span class="o">=</span> <span class="mi">3</span>

  1031. <span class="gp">... </span>    <span class="n">CRIMSON</span> <span class="o">=</span> <span class="mi">1</span>

  1032. <span class="gt">Traceback (most recent call last):</span>

  1033. <span class="c">...</span>

  1034. <span class="gr">ValueError</span>: <span class="n">aliases found in &lt;enum &#39;Color&#39;&gt;: CRIMSON -&gt; RED</span>

  1035. </pre></div>

  1036. </div>

  1037. </dd></dl>

  1038. 

  1039. <dl class="py attribute">

  1040. <dt class="sig sig-object py" id="enum.EnumCheck.CONTINUOUS">

  1041. <span class="sig-name descname"><span class="pre">CONTINUOUS</span></span><a class="headerlink" href="#enum.EnumCheck.CONTINUOUS" title="Link to this definition">¶</a></dt>

  1042. <dd><p>Ensure that there are no missing values between the lowest-valued member

  1043. and the highest-valued member:</p>

  1044. <div class="highlight-python3 notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="kn">from</span> <span class="nn">enum</span> <span class="kn">import</span> <span class="n">Enum</span><span class="p">,</span> <span class="n">verify</span><span class="p">,</span> <span class="n">CONTINUOUS</span>

  1045. <span class="gp">&gt;&gt;&gt; </span><span class="nd">@verify</span><span class="p">(</span><span class="n">CONTINUOUS</span><span class="p">)</span>

  1046. <span class="gp">... </span><span class="k">class</span> <span class="nc">Color</span><span class="p">(</span><span class="n">Enum</span><span class="p">):</span>

  1047. <span class="gp">... </span>    <span class="n">RED</span> <span class="o">=</span> <span class="mi">1</span>

  1048. <span class="gp">... </span>    <span class="n">GREEN</span> <span class="o">=</span> <span class="mi">2</span>

  1049. <span class="gp">... </span>    <span class="n">BLUE</span> <span class="o">=</span> <span class="mi">5</span>

  1050. <span class="gt">Traceback (most recent call last):</span>

  1051. <span class="c">...</span>

  1052. <span class="gr">ValueError</span>: <span class="n">invalid enum &#39;Color&#39;: missing values 3, 4</span>

  1053. </pre></div>

  1054. </div>

  1055. </dd></dl>

  1056. 

  1057. <dl class="py attribute">

  1058. <dt class="sig sig-object py" id="enum.EnumCheck.NAMED_FLAGS">

  1059. <span class="sig-name descname"><span class="pre">NAMED_FLAGS</span></span><a class="headerlink" href="#enum.EnumCheck.NAMED_FLAGS" title="Link to this definition">¶</a></dt>

  1060. <dd><p>Ensure that any flag groups/masks contain only named flags – useful when

  1061. values are specified instead of being generated by <a class="reference internal" href="#enum.auto" title="enum.auto"><code class="xref py py-func docutils literal notranslate"><span class="pre">auto()</span></code></a>:</p>

  1062. <div class="highlight-python3 notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="kn">from</span> <span class="nn">enum</span> <span class="kn">import</span> <span class="n">Flag</span><span class="p">,</span> <span class="n">verify</span><span class="p">,</span> <span class="n">NAMED_FLAGS</span>

  1063. <span class="gp">&gt;&gt;&gt; </span><span class="nd">@verify</span><span class="p">(</span><span class="n">NAMED_FLAGS</span><span class="p">)</span>

  1064. <span class="gp">... </span><span class="k">class</span> <span class="nc">Color</span><span class="p">(</span><span class="n">Flag</span><span class="p">):</span>

  1065. <span class="gp">... </span>    <span class="n">RED</span> <span class="o">=</span> <span class="mi">1</span>

  1066. <span class="gp">... </span>    <span class="n">GREEN</span> <span class="o">=</span> <span class="mi">2</span>

  1067. <span class="gp">... </span>    <span class="n">BLUE</span> <span class="o">=</span> <span class="mi">4</span>

  1068. <span class="gp">... </span>    <span class="n">WHITE</span> <span class="o">=</span> <span class="mi">15</span>

  1069. <span class="gp">... </span>    <span class="n">NEON</span> <span class="o">=</span> <span class="mi">31</span>

  1070. <span class="gt">Traceback (most recent call last):</span>

  1071. <span class="c">...</span>

  1072. <span class="gr">ValueError</span>: <span class="n">invalid Flag &#39;Color&#39;: aliases WHITE and NEON are missing combined values of 0x18 [use enum.show_flag_values(value) for details]</span>

  1073. </pre></div>

  1074. </div>

  1075. </dd></dl>

  1076. 

  1077. <div class="admonition note">

  1078. <p class="admonition-title">Note</p>

  1079. <p>CONTINUOUS and NAMED_FLAGS are designed to work with integer-valued members.</p>

  1080. </div>

  1081. <div class="versionadded">

  1082. <p><span class="versionmodified added">New in version 3.11.</span></p>

  1083. </div>

  1084. </dd></dl>

  1085. 

  1086. <dl class="py class">

  1087. <dt class="sig sig-object py" id="enum.FlagBoundary">

  1088. <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">enum.</span></span><span class="sig-name descname"><span class="pre">FlagBoundary</span></span><a class="headerlink" href="#enum.FlagBoundary" title="Link to this definition">¶</a></dt>

  1089. <dd><p><em>FlagBoundary</em> controls how out-of-range values are handled in <em>Flag</em> and its

  1090. subclasses.</p>

  1091. <dl class="py attribute">

  1092. <dt class="sig sig-object py" id="enum.FlagBoundary.STRICT">

  1093. <span class="sig-name descname"><span class="pre">STRICT</span></span><a class="headerlink" href="#enum.FlagBoundary.STRICT" title="Link to this definition">¶</a></dt>

  1094. <dd><p>Out-of-range values cause a <a class="reference internal" href="exceptions.html#ValueError" title="ValueError"><code class="xref py py-exc docutils literal notranslate"><span class="pre">ValueError</span></code></a> to be raised. This is the

  1095. default for <a class="reference internal" href="#enum.Flag" title="enum.Flag"><code class="xref py py-class docutils literal notranslate"><span class="pre">Flag</span></code></a>:</p>

  1096. <div class="highlight-python3 notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="kn">from</span> <span class="nn">enum</span> <span class="kn">import</span> <span class="n">Flag</span><span class="p">,</span> <span class="n">STRICT</span><span class="p">,</span> <span class="n">auto</span>

  1097. <span class="gp">&gt;&gt;&gt; </span><span class="k">class</span> <span class="nc">StrictFlag</span><span class="p">(</span><span class="n">Flag</span><span class="p">,</span> <span class="n">boundary</span><span class="o">=</span><span class="n">STRICT</span><span class="p">):</span>

  1098. <span class="gp">... </span>    <span class="n">RED</span> <span class="o">=</span> <span class="n">auto</span><span class="p">()</span>

  1099. <span class="gp">... </span>    <span class="n">GREEN</span> <span class="o">=</span> <span class="n">auto</span><span class="p">()</span>

  1100. <span class="gp">... </span>    <span class="n">BLUE</span> <span class="o">=</span> <span class="n">auto</span><span class="p">()</span>

  1101. <span class="gp">...</span>

  1102. <span class="gp">&gt;&gt;&gt; </span><span class="n">StrictFlag</span><span class="p">(</span><span class="mi">2</span><span class="o">**</span><span class="mi">2</span> <span class="o">+</span> <span class="mi">2</span><span class="o">**</span><span class="mi">4</span><span class="p">)</span>

  1103. <span class="gt">Traceback (most recent call last):</span>

  1104. <span class="c">...</span>

  1105. <span class="gr">ValueError</span>: <span class="n">&lt;flag &#39;StrictFlag&#39;&gt; invalid value 20</span>

  1106. <span class="x">    given 0b0 10100</span>

  1107. <span class="x">  allowed 0b0 00111</span>

  1108. </pre></div>

  1109. </div>

  1110. </dd></dl>

  1111. 

  1112. <dl class="py attribute">

  1113. <dt class="sig sig-object py" id="enum.FlagBoundary.CONFORM">

  1114. <span class="sig-name descname"><span class="pre">CONFORM</span></span><a class="headerlink" href="#enum.FlagBoundary.CONFORM" title="Link to this definition">¶</a></dt>

  1115. <dd><p>Out-of-range values have invalid values removed, leaving a valid <em>Flag</em>

  1116. value:</p>

  1117. <div class="highlight-python3 notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="kn">from</span> <span class="nn">enum</span> <span class="kn">import</span> <span class="n">Flag</span><span class="p">,</span> <span class="n">CONFORM</span><span class="p">,</span> <span class="n">auto</span>

  1118. <span class="gp">&gt;&gt;&gt; </span><span class="k">class</span> <span class="nc">ConformFlag</span><span class="p">(</span><span class="n">Flag</span><span class="p">,</span> <span class="n">boundary</span><span class="o">=</span><span class="n">CONFORM</span><span class="p">):</span>

  1119. <span class="gp">... </span>    <span class="n">RED</span> <span class="o">=</span> <span class="n">auto</span><span class="p">()</span>

  1120. <span class="gp">... </span>    <span class="n">GREEN</span> <span class="o">=</span> <span class="n">auto</span><span class="p">()</span>

  1121. <span class="gp">... </span>    <span class="n">BLUE</span> <span class="o">=</span> <span class="n">auto</span><span class="p">()</span>

  1122. <span class="gp">...</span>

  1123. <span class="gp">&gt;&gt;&gt; </span><span class="n">ConformFlag</span><span class="p">(</span><span class="mi">2</span><span class="o">**</span><span class="mi">2</span> <span class="o">+</span> <span class="mi">2</span><span class="o">**</span><span class="mi">4</span><span class="p">)</span>

  1124. <span class="go">&lt;ConformFlag.BLUE: 4&gt;</span>

  1125. </pre></div>

  1126. </div>

  1127. </dd></dl>

  1128. 

  1129. <dl class="py attribute">

  1130. <dt class="sig sig-object py" id="enum.FlagBoundary.EJECT">

  1131. <span class="sig-name descname"><span class="pre">EJECT</span></span><a class="headerlink" href="#enum.FlagBoundary.EJECT" title="Link to this definition">¶</a></dt>

  1132. <dd><p>Out-of-range values lose their <em>Flag</em> membership and revert to <a class="reference internal" href="functions.html#int" title="int"><code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code></a>.</p>

  1133. <div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="kn">from</span> <span class="nn">enum</span> <span class="kn">import</span> <span class="n">Flag</span><span class="p">,</span> <span class="n">EJECT</span><span class="p">,</span> <span class="n">auto</span>

  1134. <span class="gp">&gt;&gt;&gt; </span><span class="k">class</span> <span class="nc">EjectFlag</span><span class="p">(</span><span class="n">Flag</span><span class="p">,</span> <span class="n">boundary</span><span class="o">=</span><span class="n">EJECT</span><span class="p">):</span>

  1135. <span class="gp">... </span>    <span class="n">RED</span> <span class="o">=</span> <span class="n">auto</span><span class="p">()</span>

  1136. <span class="gp">... </span>    <span class="n">GREEN</span> <span class="o">=</span> <span class="n">auto</span><span class="p">()</span>

  1137. <span class="gp">... </span>    <span class="n">BLUE</span> <span class="o">=</span> <span class="n">auto</span><span class="p">()</span>

  1138. <span class="gp">...</span>

  1139. <span class="gp">&gt;&gt;&gt; </span><span class="n">EjectFlag</span><span class="p">(</span><span class="mi">2</span><span class="o">**</span><span class="mi">2</span> <span class="o">+</span> <span class="mi">2</span><span class="o">**</span><span class="mi">4</span><span class="p">)</span>

  1140. <span class="go">20</span>

  1141. </pre></div>

  1142. </div>

  1143. </dd></dl>

  1144. 

  1145. <dl class="py attribute">

  1146. <dt class="sig sig-object py" id="enum.FlagBoundary.KEEP">

  1147. <span class="sig-name descname"><span class="pre">KEEP</span></span><a class="headerlink" href="#enum.FlagBoundary.KEEP" title="Link to this definition">¶</a></dt>

  1148. <dd><p>Out-of-range values are kept, and the <em>Flag</em> membership is kept.

  1149. This is the default for <a class="reference internal" href="#enum.IntFlag" title="enum.IntFlag"><code class="xref py py-class docutils literal notranslate"><span class="pre">IntFlag</span></code></a>:</p>

  1150. <div class="highlight-python3 notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="kn">from</span> <span class="nn">enum</span> <span class="kn">import</span> <span class="n">Flag</span><span class="p">,</span> <span class="n">KEEP</span><span class="p">,</span> <span class="n">auto</span>

  1151. <span class="gp">&gt;&gt;&gt; </span><span class="k">class</span> <span class="nc">KeepFlag</span><span class="p">(</span><span class="n">Flag</span><span class="p">,</span> <span class="n">boundary</span><span class="o">=</span><span class="n">KEEP</span><span class="p">):</span>

  1152. <span class="gp">... </span>    <span class="n">RED</span> <span class="o">=</span> <span class="n">auto</span><span class="p">()</span>

  1153. <span class="gp">... </span>    <span class="n">GREEN</span> <span class="o">=</span> <span class="n">auto</span><span class="p">()</span>

  1154. <span class="gp">... </span>    <span class="n">BLUE</span> <span class="o">=</span> <span class="n">auto</span><span class="p">()</span>

  1155. <span class="gp">...</span>

  1156. <span class="gp">&gt;&gt;&gt; </span><span class="n">KeepFlag</span><span class="p">(</span><span class="mi">2</span><span class="o">**</span><span class="mi">2</span> <span class="o">+</span> <span class="mi">2</span><span class="o">**</span><span class="mi">4</span><span class="p">)</span>

  1157. <span class="go">&lt;KeepFlag.BLUE|16: 20&gt;</span>

  1158. </pre></div>

  1159. </div>

  1160. </dd></dl>

  1161. 

  1162. </dd></dl>

  1163. 

  1164. <div class="versionadded">

  1165. <p><span class="versionmodified added">New in version 3.11.</span></p>

  1166. </div>

  1167. <hr class="docutils" />

  1168. <section id="supported-dunder-names">

  1169. <h3>Supported <code class="docutils literal notranslate"><span class="pre">__dunder__</span></code> names<a class="headerlink" href="#supported-dunder-names" title="Link to this heading">¶</a></h3>

  1170. <p><a class="reference internal" href="#enum.EnumType.__members__" title="enum.EnumType.__members__"><code class="xref py py-attr docutils literal notranslate"><span class="pre">__members__</span></code></a> is a read-only ordered mapping of <code class="docutils literal notranslate"><span class="pre">member_name</span></code>:<code class="docutils literal notranslate"><span class="pre">member</span></code>

  1171. items.  It is only available on the class.</p>

  1172. <p><a class="reference internal" href="../reference/datamodel.html#object.__new__" title="object.__new__"><code class="xref py py-meth docutils literal notranslate"><span class="pre">__new__()</span></code></a>, if specified, must create and return the enum members; it is

  1173. also a very good idea to set the member’s <code class="xref py py-attr docutils literal notranslate"><span class="pre">_value_</span></code> appropriately.  Once

  1174. all the members are created it is no longer used.</p>

  1175. </section>

  1176. <section id="supported-sunder-names">

  1177. <h3>Supported <code class="docutils literal notranslate"><span class="pre">_sunder_</span></code> names<a class="headerlink" href="#supported-sunder-names" title="Link to this heading">¶</a></h3>

  1178. <ul>

  1179. <li><p><a class="reference internal" href="#enum.Enum._name_" title="enum.Enum._name_"><code class="xref py py-attr docutils literal notranslate"><span class="pre">_name_</span></code></a> – name of the member</p></li>

  1180. <li><p><a class="reference internal" href="#enum.Enum._value_" title="enum.Enum._value_"><code class="xref py py-attr docutils literal notranslate"><span class="pre">_value_</span></code></a> – value of the member; can be set in <code class="docutils literal notranslate"><span class="pre">__new__</span></code></p></li>

  1181. <li><p><a class="reference internal" href="#enum.Enum._missing_" title="enum.Enum._missing_"><code class="xref py py-meth docutils literal notranslate"><span class="pre">_missing_()</span></code></a> – a lookup function used when a value is not found;

  1182. may be overridden</p></li>

  1183. <li><p><a class="reference internal" href="#enum.Enum._ignore_" title="enum.Enum._ignore_"><code class="xref py py-attr docutils literal notranslate"><span class="pre">_ignore_</span></code></a> – a list of names, either as a <a class="reference internal" href="stdtypes.html#list" title="list"><code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code></a> or a

  1184. <a class="reference internal" href="stdtypes.html#str" title="str"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></a>, that will not be transformed into members, and will be removed

  1185. from the final class</p></li>

  1186. <li><p><a class="reference internal" href="#enum.Enum._order_" title="enum.Enum._order_"><code class="xref py py-attr docutils literal notranslate"><span class="pre">_order_</span></code></a> – no longer used, kept for backward

  1187. compatibility (class attribute, removed during class creation)</p></li>

  1188. <li><p><a class="reference internal" href="#enum.Enum._generate_next_value_" title="enum.Enum._generate_next_value_"><code class="xref py py-meth docutils literal notranslate"><span class="pre">_generate_next_value_()</span></code></a> – used to get an appropriate value for

  1189. an enum member; may be overridden</p>

  1190. <div class="admonition note">

  1191. <p class="admonition-title">Note</p>

  1192. <p>For standard <a class="reference internal" href="#enum.Enum" title="enum.Enum"><code class="xref py py-class docutils literal notranslate"><span class="pre">Enum</span></code></a> classes the next value chosen is the last value seen

  1193. incremented by one.</p>

  1194. <p>For <a class="reference internal" href="#enum.Flag" title="enum.Flag"><code class="xref py py-class docutils literal notranslate"><span class="pre">Flag</span></code></a> classes the next value chosen will be the next highest

  1195. power-of-two, regardless of the last value seen.</p>

  1196. </div>

  1197. </li>

  1198. </ul>

  1199. <div class="versionadded">

  1200. <p><span class="versionmodified added">New in version 3.6: </span><code class="docutils literal notranslate"><span class="pre">_missing_</span></code>, <code class="docutils literal notranslate"><span class="pre">_order_</span></code>, <code class="docutils literal notranslate"><span class="pre">_generate_next_value_</span></code></p>

  1201. </div>

  1202. <div class="versionadded">

  1203. <p><span class="versionmodified added">New in version 3.7: </span><code class="docutils literal notranslate"><span class="pre">_ignore_</span></code></p>

  1204. </div>

  1205. </section>

  1206. </section>

  1207. <hr class="docutils" />

  1208. <section id="utilities-and-decorators">

  1209. <h2>Utilities and Decorators<a class="headerlink" href="#utilities-and-decorators" title="Link to this heading">¶</a></h2>

  1210. <dl class="py class">

  1211. <dt class="sig sig-object py" id="enum.auto">

  1212. <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">enum.</span></span><span class="sig-name descname"><span class="pre">auto</span></span><a class="headerlink" href="#enum.auto" title="Link to this definition">¶</a></dt>

  1213. <dd><p><em>auto</em> can be used in place of a value.  If used, the <em>Enum</em> machinery will

  1214. call an <em>Enum</em>’s <a class="reference internal" href="#enum.Enum._generate_next_value_" title="enum.Enum._generate_next_value_"><code class="xref py py-meth docutils literal notranslate"><span class="pre">_generate_next_value_()</span></code></a> to get an appropriate value.

  1215. For <em>Enum</em> and <em>IntEnum</em> that appropriate value will be the last value plus

  1216. one; for <em>Flag</em> and <em>IntFlag</em> it will be the first power-of-two greater

  1217. than the highest value; for <em>StrEnum</em> it will be the lower-cased version of

  1218. the member’s name.  Care must be taken if mixing <em>auto()</em> with manually

  1219. specified values.</p>

  1220. <p><em>auto</em> instances are only resolved when at the top level of an assignment:</p>

  1221. <ul class="simple">

  1222. <li><p><code class="docutils literal notranslate"><span class="pre">FIRST</span> <span class="pre">=</span> <span class="pre">auto()</span></code> will work (auto() is replaced with <code class="docutils literal notranslate"><span class="pre">1</span></code>);</p></li>

  1223. <li><p><code class="docutils literal notranslate"><span class="pre">SECOND</span> <span class="pre">=</span> <span class="pre">auto(),</span> <span class="pre">-2</span></code> will work (auto is replaced with <code class="docutils literal notranslate"><span class="pre">2</span></code>, so <code class="docutils literal notranslate"><span class="pre">2,</span> <span class="pre">-2</span></code> is

  1224. used to create the <code class="docutils literal notranslate"><span class="pre">SECOND</span></code> enum member;</p></li>

  1225. <li><p><code class="docutils literal notranslate"><span class="pre">THREE</span> <span class="pre">=</span> <span class="pre">[auto(),</span> <span class="pre">-3]</span></code> will <em>not</em> work (<code class="docutils literal notranslate"><span class="pre">&lt;auto</span> <span class="pre">instance&gt;,</span> <span class="pre">-3</span></code> is used to

  1226. create the <code class="docutils literal notranslate"><span class="pre">THREE</span></code> enum member)</p></li>

  1227. </ul>

  1228. <div class="versionchanged">

  1229. <p><span class="versionmodified changed">Changed in version 3.11.1: </span>In prior versions, <code class="docutils literal notranslate"><span class="pre">auto()</span></code> had to be the only thing

  1230. on the assignment line to work properly.</p>

  1231. </div>

  1232. <p><code class="docutils literal notranslate"><span class="pre">_generate_next_value_</span></code> can be overridden to customize the values used by

  1233. <em>auto</em>.</p>

  1234. <div class="admonition note">

  1235. <p class="admonition-title">Note</p>

  1236. <p>in 3.13 the default <code class="docutils literal notranslate"><span class="pre">_generate_next_value_</span></code> will always return

  1237. the highest member value incremented by 1, and will fail if any

  1238. member is an incompatible type.</p>

  1239. </div>

  1240. </dd></dl>

  1241. 

  1242. <dl class="py function">

  1243. <dt class="sig sig-object py" id="enum.property">

  1244. <span class="sig-prename descclassname"><span class="pre">&#64;</span></span><span class="sig-prename descclassname"><span class="pre">enum.</span></span><span class="sig-name descname"><span class="pre">property</span></span><a class="headerlink" href="#enum.property" title="Link to this definition">¶</a></dt>

  1245. <dd><p>A decorator similar to the built-in <em>property</em>, but specifically for

  1246. enumerations.  It allows member attributes to have the same names as members

  1247. themselves.</p>

  1248. <div class="admonition note">

  1249. <p class="admonition-title">Note</p>

  1250. <p>the <em>property</em> and the member must be defined in separate classes;

  1251. for example, the <em>value</em> and <em>name</em> attributes are defined in the

  1252. <em>Enum</em> class, and <em>Enum</em> subclasses can define members with the

  1253. names <code class="docutils literal notranslate"><span class="pre">value</span></code> and <code class="docutils literal notranslate"><span class="pre">name</span></code>.</p>

  1254. </div>

  1255. <div class="versionadded">

  1256. <p><span class="versionmodified added">New in version 3.11.</span></p>

  1257. </div>

  1258. </dd></dl>

  1259. 

  1260. <dl class="py function">

  1261. <dt class="sig sig-object py" id="enum.unique">

  1262. <span class="sig-prename descclassname"><span class="pre">&#64;</span></span><span class="sig-prename descclassname"><span class="pre">enum.</span></span><span class="sig-name descname"><span class="pre">unique</span></span><a class="headerlink" href="#enum.unique" title="Link to this definition">¶</a></dt>

  1263. <dd><p>A <a class="reference internal" href="../reference/compound_stmts.html#class"><code class="xref std std-keyword docutils literal notranslate"><span class="pre">class</span></code></a> decorator specifically for enumerations.  It searches an

  1264. enumeration’s <a class="reference internal" href="#enum.EnumType.__members__" title="enum.EnumType.__members__"><code class="xref py py-attr docutils literal notranslate"><span class="pre">__members__</span></code></a>, gathering any aliases it finds; if any are

  1265. found <a class="reference internal" href="exceptions.html#ValueError" title="ValueError"><code class="xref py py-exc docutils literal notranslate"><span class="pre">ValueError</span></code></a> is raised with the details:</p>

  1266. <div class="highlight-python3 notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="kn">from</span> <span class="nn">enum</span> <span class="kn">import</span> <span class="n">Enum</span><span class="p">,</span> <span class="n">unique</span>

  1267. <span class="gp">&gt;&gt;&gt; </span><span class="nd">@unique</span>

  1268. <span class="gp">... </span><span class="k">class</span> <span class="nc">Mistake</span><span class="p">(</span><span class="n">Enum</span><span class="p">):</span>

  1269. <span class="gp">... </span>    <span class="n">ONE</span> <span class="o">=</span> <span class="mi">1</span>

  1270. <span class="gp">... </span>    <span class="n">TWO</span> <span class="o">=</span> <span class="mi">2</span>

  1271. <span class="gp">... </span>    <span class="n">THREE</span> <span class="o">=</span> <span class="mi">3</span>

  1272. <span class="gp">... </span>    <span class="n">FOUR</span> <span class="o">=</span> <span class="mi">3</span>

  1273. <span class="gp">...</span>

  1274. <span class="gt">Traceback (most recent call last):</span>

  1275. <span class="c">...</span>

  1276. <span class="gr">ValueError</span>: <span class="n">duplicate values found in &lt;enum &#39;Mistake&#39;&gt;: FOUR -&gt; THREE</span>

  1277. </pre></div>

  1278. </div>

  1279. </dd></dl>

  1280. 

  1281. <dl class="py function">

  1282. <dt class="sig sig-object py" id="enum.verify">

  1283. <span class="sig-prename descclassname"><span class="pre">&#64;</span></span><span class="sig-prename descclassname"><span class="pre">enum.</span></span><span class="sig-name descname"><span class="pre">verify</span></span><a class="headerlink" href="#enum.verify" title="Link to this definition">¶</a></dt>

  1284. <dd><p>A <a class="reference internal" href="../reference/compound_stmts.html#class"><code class="xref std std-keyword docutils literal notranslate"><span class="pre">class</span></code></a> decorator specifically for enumerations.  Members from

  1285. <a class="reference internal" href="#enum.EnumCheck" title="enum.EnumCheck"><code class="xref py py-class docutils literal notranslate"><span class="pre">EnumCheck</span></code></a> are used to specify which constraints should be checked

  1286. on the decorated enumeration.</p>

  1287. <div class="versionadded">

  1288. <p><span class="versionmodified added">New in version 3.11.</span></p>

  1289. </div>

  1290. </dd></dl>

  1291. 

  1292. <dl class="py function">

  1293. <dt class="sig sig-object py" id="enum.member">

  1294. <span class="sig-prename descclassname"><span class="pre">&#64;</span></span><span class="sig-prename descclassname"><span class="pre">enum.</span></span><span class="sig-name descname"><span class="pre">member</span></span><a class="headerlink" href="#enum.member" title="Link to this definition">¶</a></dt>

  1295. <dd><p>A decorator for use in enums: its target will become a member.</p>

  1296. <div class="versionadded">

  1297. <p><span class="versionmodified added">New in version 3.11.</span></p>

  1298. </div>

  1299. </dd></dl>

  1300. 

  1301. <dl class="py function">

  1302. <dt class="sig sig-object py" id="enum.nonmember">

  1303. <span class="sig-prename descclassname"><span class="pre">&#64;</span></span><span class="sig-prename descclassname"><span class="pre">enum.</span></span><span class="sig-name descname"><span class="pre">nonmember</span></span><a class="headerlink" href="#enum.nonmember" title="Link to this definition">¶</a></dt>

  1304. <dd><p>A decorator for use in enums: its target will not become a member.</p>

  1305. <div class="versionadded">

  1306. <p><span class="versionmodified added">New in version 3.11.</span></p>

  1307. </div>

  1308. </dd></dl>

  1309. 

  1310. <dl class="py function">

  1311. <dt class="sig sig-object py" id="enum.global_enum">

  1312. <span class="sig-prename descclassname"><span class="pre">&#64;</span></span><span class="sig-prename descclassname"><span class="pre">enum.</span></span><span class="sig-name descname"><span class="pre">global_enum</span></span><a class="headerlink" href="#enum.global_enum" title="Link to this definition">¶</a></dt>

  1313. <dd><p>A decorator to change the <a class="reference internal" href="stdtypes.html#str" title="str"><code class="xref py py-class docutils literal notranslate"><span class="pre">str()</span></code></a> and <a class="reference internal" href="functions.html#repr" title="repr"><code class="xref py py-func docutils literal notranslate"><span class="pre">repr()</span></code></a> of an enum

  1314. to show its members as belonging to the module instead of its class.

  1315. Should only be used when the enum members are exported

  1316. to the module global namespace (see <a class="reference internal" href="re.html#re.RegexFlag" title="re.RegexFlag"><code class="xref py py-class docutils literal notranslate"><span class="pre">re.RegexFlag</span></code></a> for an example).</p>

  1317. <div class="versionadded">

  1318. <p><span class="versionmodified added">New in version 3.11.</span></p>

  1319. </div>

  1320. </dd></dl>

  1321. 

  1322. <dl class="py function">

  1323. <dt class="sig sig-object py" id="enum.show_flag_values">

  1324. <span class="sig-prename descclassname"><span class="pre">enum.</span></span><span class="sig-name descname"><span class="pre">show_flag_values</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">value</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#enum.show_flag_values" title="Link to this definition">¶</a></dt>

  1325. <dd><p>Return a list of all power-of-two integers contained in a flag <em>value</em>.</p>

  1326. <div class="versionadded">

  1327. <p><span class="versionmodified added">New in version 3.11.</span></p>

  1328. </div>

  1329. </dd></dl>

  1330. 

  1331. </section>

  1332. <hr class="docutils" />

  1333. <section id="notes">

  1334. <h2>Notes<a class="headerlink" href="#notes" title="Link to this heading">¶</a></h2>

  1335. <p><a class="reference internal" href="#enum.IntEnum" title="enum.IntEnum"><code class="xref py py-class docutils literal notranslate"><span class="pre">IntEnum</span></code></a>, <a class="reference internal" href="#enum.StrEnum" title="enum.StrEnum"><code class="xref py py-class docutils literal notranslate"><span class="pre">StrEnum</span></code></a>, and <a class="reference internal" href="#enum.IntFlag" title="enum.IntFlag"><code class="xref py py-class docutils literal notranslate"><span class="pre">IntFlag</span></code></a></p>

  1336. <blockquote>

  1337. <div><p>These three enum types are designed to be drop-in replacements for existing

  1338. integer- and string-based values; as such, they have extra limitations:</p>

  1339. <ul class="simple">

  1340. <li><p><code class="docutils literal notranslate"><span class="pre">__str__</span></code> uses the value and not the name of the enum member</p></li>

  1341. <li><p><code class="docutils literal notranslate"><span class="pre">__format__</span></code>, because it uses <code class="docutils literal notranslate"><span class="pre">__str__</span></code>, will also use the value of

  1342. the enum member instead of its name</p></li>

  1343. </ul>

  1344. <p>If you do not need/want those limitations, you can either create your own

  1345. base class by mixing in the <code class="docutils literal notranslate"><span class="pre">int</span></code> or <code class="docutils literal notranslate"><span class="pre">str</span></code> type yourself:</p>

  1346. <div class="highlight-python3 notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="kn">from</span> <span class="nn">enum</span> <span class="kn">import</span> <span class="n">Enum</span>

  1347. <span class="gp">&gt;&gt;&gt; </span><span class="k">class</span> <span class="nc">MyIntEnum</span><span class="p">(</span><span class="nb">int</span><span class="p">,</span> <span class="n">Enum</span><span class="p">):</span>

  1348. <span class="gp">... </span>    <span class="k">pass</span>

  1349. </pre></div>

  1350. </div>

  1351. <p>or you can reassign the appropriate <a class="reference internal" href="stdtypes.html#str" title="str"><code class="xref py py-meth docutils literal notranslate"><span class="pre">str()</span></code></a>, etc., in your enum:</p>

  1352. <div class="highlight-python3 notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="kn">from</span> <span class="nn">enum</span> <span class="kn">import</span> <span class="n">Enum</span><span class="p">,</span> <span class="n">IntEnum</span>

  1353. <span class="gp">&gt;&gt;&gt; </span><span class="k">class</span> <span class="nc">MyIntEnum</span><span class="p">(</span><span class="n">IntEnum</span><span class="p">):</span>

  1354. <span class="gp">... </span>    <span class="fm">__str__</span> <span class="o">=</span> <span class="n">Enum</span><span class="o">.</span><span class="fm">__str__</span>

  1355. </pre></div>

  1356. </div>

  1357. </div></blockquote>

  1358. </section>

  1359. </section>

  1360. 

  1361. 

  1362.             <div class="clearer"></div>

  1363.           </div>

  1364.         </div>

  1365.       </div>

  1366.       <div class="sphinxsidebar" role="navigation" aria-label="main navigation">

  1367.         <div class="sphinxsidebarwrapper">

  1368.   <div>

  1369.     <h3><a href="../contents.html">Table of Contents</a></h3>

  1370.     <ul>

  1371. <li><a class="reference internal" href="#"><code class="xref py py-mod docutils literal notranslate"><span class="pre">enum</span></code> — Support for enumerations</a><ul>

  1372. <li><a class="reference internal" href="#module-contents">Module Contents</a></li>

  1373. <li><a class="reference internal" href="#data-types">Data Types</a><ul>

  1374. <li><a class="reference internal" href="#supported-dunder-names">Supported <code class="docutils literal notranslate"><span class="pre">__dunder__</span></code> names</a></li>

  1375. <li><a class="reference internal" href="#supported-sunder-names">Supported <code class="docutils literal notranslate"><span class="pre">_sunder_</span></code> names</a></li>

  1376. </ul>

  1377. </li>

  1378. <li><a class="reference internal" href="#utilities-and-decorators">Utilities and Decorators</a></li>

  1379. <li><a class="reference internal" href="#notes">Notes</a></li>

  1380. </ul>

  1381. </li>

  1382. </ul>

  1383. 

  1384.   </div>

  1385.   <div>

  1386.     <h4>Previous topic</h4>

  1387.     <p class="topless"><a href="reprlib.html"

  1388.                           title="previous chapter"><code class="xref py py-mod docutils literal notranslate"><span class="pre">reprlib</span></code> — Alternate <code class="xref py py-func docutils literal notranslate"><span class="pre">repr()</span></code> implementation</a></p>

  1389.   </div>

  1390.   <div>

  1391.     <h4>Next topic</h4>

  1392.     <p class="topless"><a href="graphlib.html"

  1393.                           title="next chapter"><code class="xref py py-mod docutils literal notranslate"><span class="pre">graphlib</span></code> — Functionality to operate with graph-like structures</a></p>

  1394.   </div>

  1395.   <div role="note" aria-label="source link">

  1396.     <h3>This Page</h3>

  1397.     <ul class="this-page-menu">

  1398.       <li><a href="../bugs.html">Report a Bug</a></li>

  1399.       <li>

  1400.         <a href="https://github.com/python/cpython/blob/main/Doc/library/enum.rst"

  1401.             rel="nofollow">Show Source

  1402.         </a>

  1403.       </li>

  1404.     </ul>

  1405.   </div>

  1406.         </div>

  1407. <div id="sidebarbutton" title="Collapse sidebar">

  1408. <span>«</span>

  1409. </div>

  1410. 

  1411.       </div>

  1412.       <div class="clearer"></div>

  1413.     </div>  

  1414.     <div class="related" role="navigation" aria-label="related navigation">

  1415.       <h3>Navigation</h3>

  1416.       <ul>

  1417.         <li class="right" style="margin-right: 10px">

  1418.           <a href="../genindex.html" title="General Index"

  1419.              >index</a></li>

  1420.         <li class="right" >

  1421.           <a href="../py-modindex.html" title="Python Module Index"

  1422.              >modules</a> |</li>

  1423.         <li class="right" >

  1424.           <a href="graphlib.html" title="graphlib — Functionality to operate with graph-like structures"

  1425.              >next</a> |</li>

  1426.         <li class="right" >

  1427.           <a href="reprlib.html" title="reprlib — Alternate repr() implementation"

  1428.              >previous</a> |</li>

  1429. 

  1430.           <li><img src="../_static/py.svg" alt="Python logo" style="vertical-align: middle; margin-top: -1px"/></li>

  1431.           <li><a href="https://www.python.org/">Python</a> &#187;</li>

  1432.           <li class="switchers">

  1433.             <div class="language_switcher_placeholder"></div>

  1434.             <div class="version_switcher_placeholder"></div>

  1435.           </li>

  1436.           <li>

  1437.               

  1438.           </li>

  1439.     <li id="cpython-language-and-version">

  1440.       <a href="../index.html">3.12.3 Documentation</a> &#187;

  1441.     </li>

  1442. 

  1443.           <li class="nav-item nav-item-1"><a href="index.html" >The Python Standard Library</a> &#187;</li>

  1444.           <li class="nav-item nav-item-2"><a href="datatypes.html" >Data Types</a> &#187;</li>

  1445.         <li class="nav-item nav-item-this"><a href=""><code class="xref py py-mod docutils literal notranslate"><span class="pre">enum</span></code> — Support for enumerations</a></li>

  1446.                 <li class="right">

  1447.                     

  1448. 

  1449.     <div class="inline-search" role="search">

  1450.         <form class="inline-search" action="../search.html" method="get">

  1451.           <input placeholder="Quick search" aria-label="Quick search" type="search" name="q" id="search-box" />

  1452.           <input type="submit" value="Go" />

  1453.         </form>

  1454.     </div>

  1455.                      |

  1456.                 </li>

  1457.             <li class="right">

  1458. <label class="theme-selector-label">

  1459.     Theme

  1460.     <select class="theme-selector" oninput="activateTheme(this.value)">

  1461.         <option value="auto" selected>Auto</option>

  1462.         <option value="light">Light</option>

  1463.         <option value="dark">Dark</option>

  1464.     </select>

  1465. </label> |</li>

  1466.             

  1467.       </ul>

  1468.     </div>  

  1469.     <div class="footer">

  1470.     &copy; 

  1471.       <a href="../copyright.html">

  1472.     

  1473.     Copyright

  1474.     

  1475.       </a>

  1476.      2001-2024, Python Software Foundation.

  1477.     <br />

  1478.     This page is licensed under the Python Software Foundation License Version 2.

  1479.     <br />

  1480.     Examples, recipes, and other code in the documentation are additionally licensed under the Zero Clause BSD License.

  1481.     <br />

  1482.     

  1483.       See <a href="/license.html">History and License</a> for more information.<br />

  1484.     

  1485.     

  1486.     <br />

  1487. 

  1488.     The Python Software Foundation is a non-profit corporation.

  1489. <a href="https://www.python.org/psf/donations/">Please donate.</a>

  1490. <br />

  1491.     <br />

  1492.       Last updated on Apr 09, 2024 (13:47 UTC).

  1493.     

  1494.       <a href="/bugs.html">Found a bug</a>?

  1495.     

  1496.     <br />

  1497. 

  1498.     Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 7.2.6.

  1499.     </div>

  1500. 

  1501.   </body>

  1502. </html>
上海开阖软件有限公司 沪ICP备12045867号-1