Gecko [ fernandoquevedodop.com ]

Name	Size	Permission
2to3.html	70.96 KB	-rw-r--r--
__future__.html	20.75 KB	-rw-r--r--
__main__.html	44.87 KB	-rw-r--r--
_thread.html	30.39 KB	-rw-r--r--
abc.html	46.87 KB	-rw-r--r--
aifc.html	35.56 KB	-rw-r--r--
allos.html	34.33 KB	-rw-r--r--
archiving.html	17 KB	-rw-r--r--
argparse.html	300.89 KB	-rw-r--r--
array.html	37.28 KB	-rw-r--r--
ast.html	293.08 KB	-rw-r--r--
asynchat.html	37.41 KB	-rw-r--r--
asyncio-api-index.html	27.68 KB	-rw-r--r--
asyncio-dev.html	36.1 KB	-rw-r--r--
asyncio-eventloop.html	204.43 KB	-rw-r--r--
asyncio-exceptions.html	17.11 KB	-rw-r--r--
asyncio-future.html	38.23 KB	-rw-r--r--
asyncio-llapi-index.html	61.97 KB	-rw-r--r--
asyncio-platforms.html	21.77 KB	-rw-r--r--
asyncio-policy.html	39.56 KB	-rw-r--r--
asyncio-protocol.html	118.33 KB	-rw-r--r--
asyncio-queue.html	31.86 KB	-rw-r--r--
asyncio-stream.html	69.98 KB	-rw-r--r--
asyncio-subprocess.html	49.25 KB	-rw-r--r--
asyncio-sync.html	42.79 KB	-rw-r--r--
asyncio-task.html	109.14 KB	-rw-r--r--
asyncio.html	17.31 KB	-rw-r--r--
asyncore.html	49.36 KB	-rw-r--r--
atexit.html	22.87 KB	-rw-r--r--
audioop.html	46 KB	-rw-r--r--
audit_events.html	72.85 KB	-rw-r--r--
base64.html	48.09 KB	-rw-r--r--
bdb.html	66 KB	-rw-r--r--
binary.html	15.97 KB	-rw-r--r--
binascii.html	36.3 KB	-rw-r--r--
binhex.html	15.97 KB	-rw-r--r--
bisect.html	43.38 KB	-rw-r--r--
builtins.html	14.87 KB	-rw-r--r--
bz2.html	50.68 KB	-rw-r--r--
calendar.html	69.35 KB	-rw-r--r--
cgi.html	59.95 KB	-rw-r--r--
cgitb.html	19.96 KB	-rw-r--r--
chunk.html	22.21 KB	-rw-r--r--
cmath.html	43.89 KB	-rw-r--r--
cmd.html	50.42 KB	-rw-r--r--
code.html	35.38 KB	-rw-r--r--
codecs.html	157.96 KB	-rw-r--r--
codeop.html	18.26 KB	-rw-r--r--
collections.abc.html	79.17 KB	-rw-r--r--
collections.html	189.43 KB	-rw-r--r--
colorsys.html	17.31 KB	-rw-r--r--
compileall.html	50.68 KB	-rw-r--r--
concurrency.html	24.15 KB	-rw-r--r--
concurrent.futures.html	79.03 KB	-rw-r--r--
concurrent.html	11.56 KB	-rw-r--r--
configparser.html	159.4 KB	-rw-r--r--
constants.html	22.41 KB	-rw-r--r--
contextlib.html	117.2 KB	-rw-r--r--
contextvars.html	38.38 KB	-rw-r--r--
copy.html	17.92 KB	-rw-r--r--
copyreg.html	18.63 KB	-rw-r--r--
crypt.html	28.29 KB	-rw-r--r--
crypto.html	13.93 KB	-rw-r--r--
csv.html	82.89 KB	-rw-r--r--
ctypes.html	295.49 KB	-rw-r--r--
curses.ascii.html	32.04 KB	-rw-r--r--
curses.html	221.24 KB	-rw-r--r--
curses.panel.html	22.16 KB	-rw-r--r--
custominterp.html	11.85 KB	-rw-r--r--
dataclasses.html	113.16 KB	-rw-r--r--
datatypes.html	31.82 KB	-rw-r--r--
datetime.html	374.92 KB	-rw-r--r--
dbm.html	51.16 KB	-rw-r--r--
debug.html	17 KB	-rw-r--r--
decimal.html	270.12 KB	-rw-r--r--
development.html	32.34 KB	-rw-r--r--
devmode.html	31.72 KB	-rw-r--r--
dialog.html	43.03 KB	-rw-r--r--
difflib.html	111.99 KB	-rw-r--r--
dis.html	136.07 KB	-rw-r--r--
distribution.html	13.67 KB	-rw-r--r--
distutils.html	14.73 KB	-rw-r--r--
doctest.html	199.32 KB	-rw-r--r--
email.charset.html	31.92 KB	-rw-r--r--
email.compat32-message.html	97.74 KB	-rw-r--r--
email.contentmanager.html	37.02 KB	-rw-r--r--
email.encoders.html	18.47 KB	-rw-r--r--
email.errors.html	24.45 KB	-rw-r--r--
email.examples.html	60.49 KB	-rw-r--r--
email.generator.html	48.79 KB	-rw-r--r--
email.header.html	37.61 KB	-rw-r--r--
email.headerregistry.html	66.26 KB	-rw-r--r--
email.html	30.75 KB	-rw-r--r--
email.iterators.html	18.23 KB	-rw-r--r--
email.message.html	99.75 KB	-rw-r--r--
email.mime.html	44.89 KB	-rw-r--r--
email.parser.html	57.39 KB	-rw-r--r--
email.policy.html	84.24 KB	-rw-r--r--
email.utils.html	42.57 KB	-rw-r--r--
ensurepip.html	23.9 KB	-rw-r--r--
enum.html	151 KB	-rw-r--r--
errno.html	60.17 KB	-rw-r--r--
exceptions.html	108.44 KB	-rw-r--r--
faulthandler.html	31.5 KB	-rw-r--r--
fcntl.html	36.67 KB	-rw-r--r--
filecmp.html	32.08 KB	-rw-r--r--
fileformats.html	13.52 KB	-rw-r--r--
fileinput.html	40.37 KB	-rw-r--r--
filesys.html	16.78 KB	-rw-r--r--
fnmatch.html	21.02 KB	-rw-r--r--
fractions.html	35.29 KB	-rw-r--r--
frameworks.html	16.15 KB	-rw-r--r--
ftplib.html	71.97 KB	-rw-r--r--
functional.html	12.19 KB	-rw-r--r--
functions.html	260.33 KB	-rw-r--r--
functools.html	92.96 KB	-rw-r--r--
gc.html	40.97 KB	-rw-r--r--
getopt.html	29.4 KB	-rw-r--r--
getpass.html	16.01 KB	-rw-r--r--
gettext.html	98.02 KB	-rw-r--r--
glob.html	27.2 KB	-rw-r--r--
graphlib.html	34.82 KB	-rw-r--r--
grp.html	16.03 KB	-rw-r--r--
gzip.html	45.65 KB	-rw-r--r--
hashlib.html	93.19 KB	-rw-r--r--
heapq.html	42.43 KB	-rw-r--r--
hmac.html	24.74 KB	-rw-r--r--
html.entities.html	14.91 KB	-rw-r--r--
html.html	14.81 KB	-rw-r--r--
html.parser.html	47.7 KB	-rw-r--r--
http.client.html	85.63 KB	-rw-r--r--
http.cookiejar.html	113.94 KB	-rw-r--r--
http.cookies.html	47.64 KB	-rw-r--r--
http.html	45.52 KB	-rw-r--r--
http.server.html	73.05 KB	-rw-r--r--
i18n.html	13.44 KB	-rw-r--r--
idle.html	77.18 KB	-rw-r--r--
imaplib.html	87.08 KB	-rw-r--r--
imghdr.html	17.94 KB	-rw-r--r--
imp.html	54.32 KB	-rw-r--r--
importlib.html	239.96 KB	-rw-r--r--
importlib.metadata.html	43.14 KB	-rw-r--r--
index.html	75.06 KB	-rw-r--r--
inspect.html	168.74 KB	-rw-r--r--
internet.html	29.89 KB	-rw-r--r--
intro.html	13.81 KB	-rw-r--r--
io.html	154.15 KB	-rw-r--r--
ipaddress.html	137.75 KB	-rw-r--r--
ipc.html	12.6 KB	-rw-r--r--
itertools.html	153.27 KB	-rw-r--r--
json.html	98.9 KB	-rw-r--r--
keyword.html	14.88 KB	-rw-r--r--
language.html	16.71 KB	-rw-r--r--
linecache.html	18.09 KB	-rw-r--r--
locale.html	77.35 KB	-rw-r--r--
logging.config.html	100.3 KB	-rw-r--r--
logging.handlers.html	146.28 KB	-rw-r--r--
logging.html	169.67 KB	-rw-r--r--
lzma.html	66.89 KB	-rw-r--r--
mailbox.html	176.34 KB	-rw-r--r--
mailcap.html	20.86 KB	-rw-r--r--
markup.html	22.31 KB	-rw-r--r--
marshal.html	24.43 KB	-rw-r--r--
math.html	85.82 KB	-rw-r--r--
mimetypes.html	40.27 KB	-rw-r--r--
mm.html	11.16 KB	-rw-r--r--
mmap.html	55.53 KB	-rw-r--r--
modulefinder.html	23.67 KB	-rw-r--r--
modules.html	15.88 KB	-rw-r--r--
msilib.html	78.38 KB	-rw-r--r--
msvcrt.html	29.22 KB	-rw-r--r--
multiprocessing.html	405.24 KB	-rw-r--r--
multiprocessing.shared_memory....	60 KB	-rw-r--r--
netdata.html	20.24 KB	-rw-r--r--
netrc.html	20.39 KB	-rw-r--r--
nis.html	16.76 KB	-rw-r--r--
nntplib.html	84.93 KB	-rw-r--r--
numbers.html	45.67 KB	-rw-r--r--
numeric.html	19.29 KB	-rw-r--r--
operator.html	107.32 KB	-rw-r--r--
optparse.html	256.96 KB	-rw-r--r--
os.html	594.39 KB	-rw-r--r--
os.path.html	65.54 KB	-rw-r--r--
ossaudiodev.html	56.35 KB	-rw-r--r--
pathlib.html	170.01 KB	-rw-r--r--
pdb.html	68.67 KB	-rw-r--r--
persistence.html	19.13 KB	-rw-r--r--
pickle.html	154.45 KB	-rw-r--r--
pickletools.html	22.92 KB	-rw-r--r--
pipes.html	21.7 KB	-rw-r--r--
pkgutil.html	42.76 KB	-rw-r--r--
platform.html	45.08 KB	-rw-r--r--
plistlib.html	30.06 KB	-rw-r--r--
poplib.html	41.42 KB	-rw-r--r--
posix.html	20.96 KB	-rw-r--r--
pprint.html	55.35 KB	-rw-r--r--
profile.html	84.63 KB	-rw-r--r--
pty.html	23.7 KB	-rw-r--r--
pwd.html	16.84 KB	-rw-r--r--
py_compile.html	29 KB	-rw-r--r--
pyclbr.html	24.06 KB	-rw-r--r--
pydoc.html	19.59 KB	-rw-r--r--
pyexpat.html	104.38 KB	-rw-r--r--
python.html	22.46 KB	-rw-r--r--
queue.html	43.39 KB	-rw-r--r--
quopri.html	18.64 KB	-rw-r--r--
random.html	86.31 KB	-rw-r--r--
re.html	214.24 KB	-rw-r--r--
readline.html	50.19 KB	-rw-r--r--
reprlib.html	30.85 KB	-rw-r--r--
resource.html	48.26 KB	-rw-r--r--
rlcompleter.html	18.06 KB	-rw-r--r--
runpy.html	30.99 KB	-rw-r--r--
sched.html	27.04 KB	-rw-r--r--
secrets.html	30.2 KB	-rw-r--r--
security_warnings.html	16.21 KB	-rw-r--r--
select.html	74.58 KB	-rw-r--r--
selectors.html	41.91 KB	-rw-r--r--
shelve.html	36.54 KB	-rw-r--r--
shlex.html	61.03 KB	-rw-r--r--
shutil.html	100.13 KB	-rw-r--r--
signal.html	95.39 KB	-rw-r--r--
site.html	38.16 KB	-rw-r--r--
smtpd.html	44.09 KB	-rw-r--r--
smtplib.html	81.4 KB	-rw-r--r--
sndhdr.html	16.4 KB	-rw-r--r--
socket.html	256.95 KB	-rw-r--r--
socketserver.html	91.95 KB	-rw-r--r--
spwd.html	16.71 KB	-rw-r--r--
sqlite3.html	225.51 KB	-rw-r--r--
ssl.html	328.83 KB	-rw-r--r--
stat.html	57.79 KB	-rw-r--r--
statistics.html	123.22 KB	-rw-r--r--
stdtypes.html	615.43 KB	-rw-r--r--
string.html	108.03 KB	-rw-r--r--
stringprep.html	24.94 KB	-rw-r--r--
struct.html	70.58 KB	-rw-r--r--
subprocess.html	199.03 KB	-rw-r--r--
sunau.html	39.84 KB	-rw-r--r--
superseded.html	26.21 KB	-rw-r--r--
symtable.html	33.26 KB	-rw-r--r--
sys.html	198.83 KB	-rw-r--r--
sysconfig.html	39.81 KB	-rw-r--r--
syslog.html	27.36 KB	-rw-r--r--
tabnanny.html	16.18 KB	-rw-r--r--
tarfile.html	161.92 KB	-rw-r--r--
telnetlib.html	38.21 KB	-rw-r--r--
tempfile.html	58.39 KB	-rw-r--r--
termios.html	22.86 KB	-rw-r--r--
test.html	222.85 KB	-rw-r--r--
text.html	16.8 KB	-rw-r--r--
textwrap.html	48.83 KB	-rw-r--r--
threading.html	128.33 KB	-rw-r--r--
time.html	107.46 KB	-rw-r--r--
timeit.html	52.63 KB	-rw-r--r--
tk.html	28.08 KB	-rw-r--r--
tkinter.colorchooser.html	14.49 KB	-rw-r--r--
tkinter.dnd.html	17.09 KB	-rw-r--r--
tkinter.font.html	22.21 KB	-rw-r--r--
tkinter.html	106.85 KB	-rw-r--r--
tkinter.messagebox.html	20.09 KB	-rw-r--r--
tkinter.scrolledtext.html	14.52 KB	-rw-r--r--
tkinter.tix.html	59.69 KB	-rw-r--r--
tkinter.ttk.html	138.37 KB	-rw-r--r--
token.html	45.73 KB	-rw-r--r--
tokenize.html	39.86 KB	-rw-r--r--
trace.html	38.85 KB	-rw-r--r--
traceback.html	75.61 KB	-rw-r--r--
tracemalloc.html	122.33 KB	-rw-r--r--
tty.html	14.46 KB	-rw-r--r--
turtle.html	271.71 KB	-rw-r--r--
types.html	64.85 KB	-rw-r--r--
typing.html	315.69 KB	-rw-r--r--
unicodedata.html	27.3 KB	-rw-r--r--
unittest.html	310.01 KB	-rw-r--r--
unittest.mock-examples.html	177.75 KB	-rw-r--r--
unittest.mock.html	363.51 KB	-rw-r--r--
unix.html	13.46 KB	-rw-r--r--
urllib.error.html	18.56 KB	-rw-r--r--
urllib.html	12.92 KB	-rw-r--r--
urllib.parse.html	104.65 KB	-rw-r--r--
urllib.request.html	208.87 KB	-rw-r--r--
urllib.robotparser.html	22.63 KB	-rw-r--r--
uu.html	18.2 KB	-rw-r--r--
uuid.html	42.88 KB	-rw-r--r--
venv.html	90.43 KB	-rw-r--r--
warnings.html	69.13 KB	-rw-r--r--
wave.html	36.12 KB	-rw-r--r--
weakref.html	73.36 KB	-rw-r--r--
webbrowser.html	33.98 KB	-rw-r--r--
windows.html	12.32 KB	-rw-r--r--
winreg.html	89.48 KB	-rw-r--r--
winsound.html	26.3 KB	-rw-r--r--
wsgiref.html	111.52 KB	-rw-r--r--
xdrlib.html	42.07 KB	-rw-r--r--
xml.dom.html	114.66 KB	-rw-r--r--
xml.dom.minidom.html	49.6 KB	-rw-r--r--
xml.dom.pulldom.html	30.06 KB	-rw-r--r--
xml.etree.elementtree.html	186.49 KB	-rw-r--r--
xml.html	22.34 KB	-rw-r--r--
xml.sax.handler.html	55.78 KB	-rw-r--r--
xml.sax.html	31.74 KB	-rw-r--r--
xml.sax.reader.html	56.23 KB	-rw-r--r--
xml.sax.utils.html	22.28 KB	-rw-r--r--
xmlrpc.client.html	79.73 KB	-rw-r--r--
xmlrpc.html	11.9 KB	-rw-r--r--
xmlrpc.server.html	63.56 KB	-rw-r--r--
zipapp.html	52.45 KB	-rw-r--r--
zipfile.html	116.59 KB	-rw-r--r--
zipimport.html	33.76 KB	-rw-r--r--
zlib.html	42.29 KB	-rw-r--r--
zoneinfo.html	57.25 KB	-rw-r--r--

Code Editor : enum.html

<!DOCTYPE html>

<title>enum — Support for enumerations &#8212; Python 3.10.12 documentation</title><meta name="viewport" content="width=device-width, initial-scale=1.0">
 
 <link rel="stylesheet" type="text/css" href="../_static/pygments.css" />
 <link rel="stylesheet" type="text/css" href="../_static/pydoctheme.css?2022.1" />
 
 <script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js"></script>
 <script src="../_static/jquery.js"></script>
 <script src="../_static/underscore.js"></script>
 <script src="../_static/doctools.js"></script>
 
 <script src="../_static/sidebar.js"></script>
 
 <link rel="search" type="application/opensearchdescription+xml"
 title="Search within Python 3.10.12 documentation"
 href="../_static/opensearch.xml"/>
 <link rel="author" title="About these documents" href="../about.html" />
 <link rel="index" title="Index" href="../genindex.html" />
 <link rel="search" title="Search" href="../search.html" />
 <link rel="copyright" title="Copyright" href="../copyright.html" />
 <link rel="next" title="graphlib — Functionality to operate with graph-like structures" href="graphlib.html" />
 <link rel="prev" title="reprlib — Alternate repr() implementation" href="reprlib.html" />
 <link rel="canonical" href="file:///usr/share/doc/python3.10/html/library/enum.html" />

</head>
<body>
<div class="mobile-nav">
 <input type="checkbox" id="menuToggler" class="toggler__input" aria-controls="navigation"
 aria-pressed="false" aria-expanded="false" role="button" aria-label="Menu" />
 <label for="menuToggler" class="toggler__label">
 
 </label>
 <nav class="nav-content" role="navigation">
 <a href="https://www.python.org/" class="nav-logo">
 <img src="../_static/py.svg" alt="Logo"/>
 </a>
 <div class="version_switcher_placeholder"></div>
 <form role="search" class="search" action="../search.html" method="get">
 <svg xmlns="http://www.w3.org/2000/svg" width="20" height="20" viewBox="0 0 24 24" class="search-icon">
 <path fill-rule="nonzero"
 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" fill="#444"></path>
 </svg>
 <input type="text" name="q" aria-label="Quick search"/>
 <input type="submit" value="Go"/>
 </form>
 </nav>
 <div class="menu-wrapper">
 <nav class="menu" role="navigation" aria-label="main navigation">
 <div class="language_switcher_placeholder"></div>
 <h3><a href="../contents.html">Table of Contents</a></h3>
 <ul>
<li><a class="reference internal" href="#"><code class="xref py py-mod docutils literal notranslate">enum</code> — Support for enumerations</a><ul>
<li><a class="reference internal" href="#module-contents">Module Contents</a></li>
<li><a class="reference internal" href="#creating-an-enum">Creating an Enum</a></li>
<li><a class="reference internal" href="#programmatic-access-to-enumeration-members-and-their-attributes">Programmatic access to enumeration members and their attributes</a></li>
<li><a class="reference internal" href="#duplicating-enum-members-and-values">Duplicating enum members and values</a></li>
<li><a class="reference internal" href="#ensuring-unique-enumeration-values">Ensuring unique enumeration values</a></li>
<li><a class="reference internal" href="#using-automatic-values">Using automatic values</a></li>
<li><a class="reference internal" href="#iteration">Iteration</a></li>
<li><a class="reference internal" href="#comparisons">Comparisons</a></li>
<li><a class="reference internal" href="#allowed-members-and-attributes-of-enumerations">Allowed members and attributes of enumerations</a></li>
<li><a class="reference internal" href="#restricted-enum-subclassing">Restricted Enum subclassing</a></li>
<li><a class="reference internal" href="#pickling">Pickling</a></li>
<li><a class="reference internal" href="#functional-api">Functional API</a></li>
<li><a class="reference internal" href="#derived-enumerations">Derived Enumerations</a><ul>
<li><a class="reference internal" href="#intenum">IntEnum</a></li>
<li><a class="reference internal" href="#intflag">IntFlag</a></li>
<li><a class="reference internal" href="#flag">Flag</a></li>
<li><a class="reference internal" href="#others">Others</a></li>
</ul>
</li>
<li><a class="reference internal" href="#when-to-use-new-vs-init">When to use <code class="xref py py-meth docutils literal notranslate">__new__()</code> vs. <code class="xref py py-meth docutils literal notranslate">__init__()</code></a></li>
<li><a class="reference internal" href="#interesting-examples">Interesting examples</a><ul>
<li><a class="reference internal" href="#omitting-values">Omitting values</a><ul>
<li><a class="reference internal" href="#using-auto">Using <code class="xref py py-class docutils literal notranslate">auto</code></a></li>
<li><a class="reference internal" href="#using-object">Using <code class="xref py py-class docutils literal notranslate">object</code></a></li>
<li><a class="reference internal" href="#using-a-descriptive-string">Using a descriptive string</a></li>
<li><a class="reference internal" href="#using-a-custom-new">Using a custom <code class="xref py py-meth docutils literal notranslate">__new__()</code></a></li>
</ul>
</li>
<li><a class="reference internal" href="#orderedenum">OrderedEnum</a></li>
<li><a class="reference internal" href="#duplicatefreeenum">DuplicateFreeEnum</a></li>
<li><a class="reference internal" href="#planet">Planet</a></li>
<li><a class="reference internal" href="#timeperiod">TimePeriod</a></li>
</ul>
</li>
<li><a class="reference internal" href="#how-are-enums-different">How are Enums different?</a><ul>
<li><a class="reference internal" href="#enum-classes">Enum Classes</a></li>
<li><a class="reference internal" href="#enum-members-aka-instances">Enum Members (aka instances)</a></li>
<li><a class="reference internal" href="#finer-points">Finer Points</a><ul>
<li><a class="reference internal" href="#supported-dunder-names">Supported <code class="docutils literal notranslate">__dunder__</code> names</a></li>
<li><a class="reference internal" href="#supported-sunder-names">Supported <code class="docutils literal notranslate">_sunder_</code> names</a></li>
<li><a class="reference internal" href="#private-names">_Private__names</a></li>
<li><a class="reference internal" href="#enum-member-type"><code class="docutils literal notranslate">Enum</code> member type</a></li>
<li><a class="reference internal" href="#boolean-value-of-enum-classes-and-members">Boolean value of <code class="docutils literal notranslate">Enum</code> classes and members</a></li>
<li><a class="reference internal" href="#enum-classes-with-methods"><code class="docutils literal notranslate">Enum</code> classes with methods</a></li>
<li><a class="reference internal" href="#combining-members-of-flag">Combining members of <code class="docutils literal notranslate">Flag</code></a></li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>

<div class="related" role="navigation" aria-label="related navigation">
 <h3>Navigation</h3>
 <ul>
 <li class="right" style="margin-right: 10px">
 <a href="../genindex.html" title="General Index"
 accesskey="I">index</a></li>
 <li class="right" >
 <a href="../py-modindex.html" title="Python Module Index"
 >modules</a> |</li>
 <li class="right" >
 <a href="graphlib.html" title="graphlib — Functionality to operate with graph-like structures"
 accesskey="N">next</a> |</li>
 <li class="right" >
 <a href="reprlib.html" title="reprlib — Alternate repr() implementation"
 accesskey="P">previous</a> |</li>

<li><img src="../_static/py.svg" alt="python logo" style="vertical-align: middle; margin-top: -1px"/></li>
 <li><a href="https://www.python.org/">Python</a> &#187;</li>
 <li class="switchers">
 <div class="language_switcher_placeholder"></div>
 <div class="version_switcher_placeholder"></div>
 </li>
 <li>
 
 </li>
 <li id="cpython-language-and-version">
 <a href="../index.html">3.10.12 Documentation</a> &#187;
 </li>

<li class="nav-item nav-item-1"><a href="index.html" >The Python Standard Library</a> &#187;</li>
 <li class="nav-item nav-item-2"><a href="datatypes.html" accesskey="U">Data Types</a> &#187;</li>
 <li class="nav-item nav-item-this"><a href=""><code class="xref py py-mod docutils literal notranslate">enum</code> — Support for enumerations</a></li>
 <li class="right">

<div class="document">
 <div class="documentwrapper">
 <div class="bodywrapper">
 <div class="body" role="main">
 
 <section id="module-enum">
<h1><a class="reference internal" href="#module-enum" title="enum: Implementation of an enumeration class."><code class="xref py py-mod docutils literal notranslate">enum</code></a> — Support for enumerations<a class="headerlink" href="#module-enum" title="Permalink to this headline">¶</a></h1>
<div class="versionadded">
New in version 3.4.
</div>
Source code: <a class="reference external" href="https://github.com/python/cpython/tree/3.10/Lib/enum.py">Lib/enum.py</a>
<hr class="docutils" />
An enumeration is a set of symbolic names (members) bound to unique,
constant values. Within an enumeration, the members can be compared
by identity, and the enumeration itself can be iterated over.
<div class="admonition note">
Note
Case of Enum Members
Because Enums are used to represent constants we recommend using
UPPER_CASE names for enum members, and will be using that style
in our examples.
</div>
<section id="module-contents">
<h2>Module Contents<a class="headerlink" href="#module-contents" title="Permalink to this headline">¶</a></h2>
This module defines four enumeration classes that can be used to define unique
sets of names and values: <a class="reference internal" href="#enum.Enum" title="enum.Enum"><code class="xref py py-class docutils literal notranslate">Enum</code></a>, <a class="reference internal" href="#enum.IntEnum" title="enum.IntEnum"><code class="xref py py-class docutils literal notranslate">IntEnum</code></a>, <a class="reference internal" href="#enum.Flag" title="enum.Flag"><code class="xref py py-class docutils literal notranslate">Flag</code></a>, and
<a class="reference internal" href="#enum.IntFlag" title="enum.IntFlag"><code class="xref py py-class docutils literal notranslate">IntFlag</code></a>. It also defines one decorator, <a class="reference internal" href="#enum.unique" title="enum.unique"><code class="xref py py-func docutils literal notranslate">unique()</code></a>, and one
helper, <a class="reference internal" href="#enum.auto" title="enum.auto"><code class="xref py py-class docutils literal notranslate">auto</code></a>.
<dl class="py class">
<dt class="sig sig-object py" id="enum.Enum">
class enum.Enum<a class="headerlink" href="#enum.Enum" title="Permalink to this definition">¶</a></dt>
<dd>Base class for creating enumerated constants. See section
<a class="reference internal" href="#functional-api">Functional API</a> for an alternate construction syntax.
</dd></dl>

<dl class="py class">
<dt class="sig sig-object py" id="enum.IntEnum">
class enum.IntEnum<a class="headerlink" href="#enum.IntEnum" title="Permalink to this definition">¶</a></dt>
<dd>Base class for creating enumerated constants that are also
subclasses of <a class="reference internal" href="functions.html#int" title="int"><code class="xref py py-class docutils literal notranslate">int</code></a>.
</dd></dl>

<dl class="py class">
<dt class="sig sig-object py" id="enum.IntFlag">
class enum.IntFlag<a class="headerlink" href="#enum.IntFlag" title="Permalink to this definition">¶</a></dt>
<dd>Base class for creating enumerated constants that can be combined using
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">IntFlag</code></a> membership.
<a class="reference internal" href="#enum.IntFlag" title="enum.IntFlag"><code class="xref py py-class docutils literal notranslate">IntFlag</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">int</code></a>.
</dd></dl>

<dl class="py class">
<dt class="sig sig-object py" id="enum.Flag">
class enum.Flag<a class="headerlink" href="#enum.Flag" title="Permalink to this definition">¶</a></dt>
<dd>Base class for creating enumerated constants that can be combined using
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">Flag</code></a> membership.
</dd></dl>

<dl class="py function">
<dt class="sig sig-object py">
enum.unique()</dt>
<dd>Enum class decorator that ensures only one name is bound to any one value.
</dd></dl>

<dl class="py class">
<dt class="sig sig-object py" id="enum.auto">
class enum.auto<a class="headerlink" href="#enum.auto" title="Permalink to this definition">¶</a></dt>
<dd>Instances are replaced with an appropriate value for Enum members. By default, the initial value starts at 1.
</dd></dl>

<div class="versionadded">
New in version 3.6: <code class="docutils literal notranslate">Flag</code>, <code class="docutils literal notranslate">IntFlag</code>, <code class="docutils literal notranslate">auto</code>
</div>
</section>
<section id="creating-an-enum">
<h2>Creating an Enum<a class="headerlink" href="#creating-an-enum" title="Permalink to this headline">¶</a></h2>
Enumerations are created using the <a class="reference internal" href="../reference/compound_stmts.html#class"><code class="xref std std-keyword docutils literal notranslate">class</code></a> syntax, which makes them
easy to read and write. An alternative creation method is described in
<a class="reference internal" href="#functional-api">Functional API</a>. To define an enumeration, subclass <a class="reference internal" href="#enum.Enum" title="enum.Enum"><code class="xref py py-class docutils literal notranslate">Enum</code></a> as
follows:
<div class="highlight-python3 notranslate"><div class="highlight"><pre>&gt;&gt;&gt; from enum import Enum
&gt;&gt;&gt; class Color(Enum):
... RED = 1
... GREEN = 2
... BLUE = 3
...
</pre></div>
</div>
<div class="admonition note">
Note
Enum member values
Member values can be anything: <a class="reference internal" href="functions.html#int" title="int"><code class="xref py py-class docutils literal notranslate">int</code></a>, <a class="reference internal" href="stdtypes.html#str" title="str"><code class="xref py py-class docutils literal notranslate">str</code></a>, etc.. If
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">auto</code></a> instances and an
appropriate value will be chosen for you. Care must be taken if you mix
<a class="reference internal" href="#enum.auto" title="enum.auto"><code class="xref py py-class docutils literal notranslate">auto</code></a> with other values.
</div>
<div class="admonition note">
Note
Nomenclature
<ul class="simple">
<li>The class <code class="xref py py-class docutils literal notranslate">Color</code> is an enumeration (or enum)</li>
<li>The attributes <code class="xref py py-attr docutils literal notranslate">Color.RED</code>, <code class="xref py py-attr docutils literal notranslate">Color.GREEN</code>, etc., are
enumeration members (or enum members) and are functionally constants.</li>
<li>The enum members have names and values (the name of
<code class="xref py py-attr docutils literal notranslate">Color.RED</code> is <code class="docutils literal notranslate">RED</code>, the value of <code class="xref py py-attr docutils literal notranslate">Color.BLUE</code> is
<code class="docutils literal notranslate">3</code>, etc.)</li>
</ul>
</div>
<div class="admonition note">
Note
Even though we use the <a class="reference internal" href="../reference/compound_stmts.html#class"><code class="xref std std-keyword docutils literal notranslate">class</code></a> syntax to create Enums, Enums
are not normal Python classes. See <a class="reference internal" href="#how-are-enums-different">How are Enums different?</a> for
more details.
</div>
Enumeration members have human readable string representations:
<div class="highlight-python3 notranslate"><div class="highlight"><pre>&gt;&gt;&gt; print(Color.RED)
Color.RED
</pre></div>
</div>
…while their <code class="docutils literal notranslate">repr</code> has more information:
<div class="highlight-python3 notranslate"><div class="highlight"><pre>&gt;&gt;&gt; print(repr(Color.RED))
&lt;Color.RED: 1&gt;
</pre></div>
</div>
The type of an enumeration member is the enumeration it belongs to:
<div class="highlight-python3 notranslate"><div class="highlight"><pre>&gt;&gt;&gt; type(Color.RED)
&lt;enum &#39;Color&#39;&gt;
&gt;&gt;&gt; isinstance(Color.GREEN, Color)
True
&gt;&gt;&gt;
</pre></div>
</div>
Enum members also have a property that contains just their item name:
<div class="highlight-python3 notranslate"><div class="highlight"><pre>&gt;&gt;&gt; print(Color.RED.name)
RED
</pre></div>
</div>
Enumerations support iteration, in definition order:
<div class="highlight-python3 notranslate"><div class="highlight"><pre>&gt;&gt;&gt; class Shake(Enum):
... VANILLA = 7
... CHOCOLATE = 4
... COOKIES = 9
... MINT = 3
...
&gt;&gt;&gt; for shake in Shake:
... print(shake)
...
Shake.VANILLA
Shake.CHOCOLATE
Shake.COOKIES
Shake.MINT
</pre></div>
</div>
Enumeration members are hashable, so they can be used in dictionaries and sets:
<div class="highlight-python3 notranslate"><div class="highlight"><pre>&gt;&gt;&gt; apples = {}
&gt;&gt;&gt; apples[Color.RED] = &#39;red delicious&#39;
&gt;&gt;&gt; apples[Color.GREEN] = &#39;granny smith&#39;
&gt;&gt;&gt; apples == {Color.RED: &#39;red delicious&#39;, Color.GREEN: &#39;granny smith&#39;}
True
</pre></div>
</div>
</section>
<section id="programmatic-access-to-enumeration-members-and-their-attributes">
<h2>Programmatic access to enumeration members and their attributes<a class="headerlink" href="#programmatic-access-to-enumeration-members-and-their-attributes" title="Permalink to this headline">¶</a></h2>
Sometimes it’s useful to access members in enumerations programmatically (i.e.
situations where <code class="docutils literal notranslate">Color.RED</code> won’t do because the exact color is not known
at program-writing time). <code class="docutils literal notranslate">Enum</code> allows such access:
<div class="highlight-python3 notranslate"><div class="highlight"><pre>&gt;&gt;&gt; Color(1)
&lt;Color.RED: 1&gt;
&gt;&gt;&gt; Color(3)
&lt;Color.BLUE: 3&gt;
</pre></div>
</div>
If you want to access enum members by name, use item access:
<div class="highlight-python3 notranslate"><div class="highlight"><pre>&gt;&gt;&gt; Color[&#39;RED&#39;]
&lt;Color.RED: 1&gt;
&gt;&gt;&gt; Color[&#39;GREEN&#39;]
&lt;Color.GREEN: 2&gt;
</pre></div>
</div>
If you have an enum member and need its <code class="xref py py-attr docutils literal notranslate">name</code> or <code class="xref py py-attr docutils literal notranslate">value</code>:
<div class="highlight-python3 notranslate"><div class="highlight"><pre>&gt;&gt;&gt; member = Color.RED
&gt;&gt;&gt; member.name
&#39;RED&#39;
&gt;&gt;&gt; member.value
1
</pre></div>
</div>
</section>
<section id="duplicating-enum-members-and-values">
<h2>Duplicating enum members and values<a class="headerlink" href="#duplicating-enum-members-and-values" title="Permalink to this headline">¶</a></h2>
Having two enum members with the same name is invalid:
<div class="highlight-python3 notranslate"><div class="highlight"><pre>&gt;&gt;&gt; class Shape(Enum):
... SQUARE = 2
... SQUARE = 3
...
Traceback (most recent call last):
...
TypeError: Attempted to reuse key: &#39;SQUARE&#39;
</pre></div>
</div>
However, two enum members are allowed to have the same value. Given two members
A and B with the same value (and A defined first), B is an alias to A. By-value
lookup of the value of A and B will return A. By-name lookup of B will also
return A:
<div class="highlight-python3 notranslate"><div class="highlight"><pre>&gt;&gt;&gt; class Shape(Enum):
... SQUARE = 2
... DIAMOND = 1
... CIRCLE = 3
... ALIAS_FOR_SQUARE = 2
...
&gt;&gt;&gt; Shape.SQUARE
&lt;Shape.SQUARE: 2&gt;
&gt;&gt;&gt; Shape.ALIAS_FOR_SQUARE
&lt;Shape.SQUARE: 2&gt;
&gt;&gt;&gt; Shape(2)
&lt;Shape.SQUARE: 2&gt;
</pre></div>
</div>
<div class="admonition note">
Note
Attempting to create a member with the same name as an already
defined attribute (another member, a method, etc.) or attempting to create
an attribute with the same name as a member is not allowed.
</div>
</section>
<section id="ensuring-unique-enumeration-values">
<h2>Ensuring unique enumeration values<a class="headerlink" href="#ensuring-unique-enumeration-values" title="Permalink to this headline">¶</a></h2>
By default, enumerations allow multiple names as aliases for the same value.
When this behavior isn’t desired, the following decorator can be used to
ensure each value is used only once in the enumeration:
<dl class="py function">
<dt class="sig sig-object py" id="enum.unique">
&#64;enum.unique<a class="headerlink" href="#enum.unique" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

A <a class="reference internal" href="../reference/compound_stmts.html#class"><code class="xref std std-keyword docutils literal notranslate">class</code></a> decorator specifically for enumerations. It searches an
enumeration’s <code class="xref py py-attr docutils literal notranslate">__members__</code> gathering any aliases it finds; if any are
found <a class="reference internal" href="exceptions.html#ValueError" title="ValueError"><code class="xref py py-exc docutils literal notranslate">ValueError</code></a> is raised with the details:
<div class="highlight-python3 notranslate"><div class="highlight"><pre>&gt;&gt;&gt; from enum import Enum, unique
&gt;&gt;&gt; @unique
... class Mistake(Enum):
... ONE = 1
... TWO = 2
... THREE = 3
... FOUR = 3
...
Traceback (most recent call last):
...
ValueError: duplicate values found in &lt;enum &#39;Mistake&#39;&gt;: FOUR -&gt; THREE
</pre></div>
</div>
</section>
<section id="using-automatic-values">
<h2>Using automatic values<a class="headerlink" href="#using-automatic-values" title="Permalink to this headline">¶</a></h2>
If the exact value is unimportant you can use <a class="reference internal" href="#enum.auto" title="enum.auto"><code class="xref py py-class docutils literal notranslate">auto</code></a>:
<div class="highlight-python3 notranslate"><div class="highlight"><pre>&gt;&gt;&gt; from enum import Enum, auto
&gt;&gt;&gt; class Color(Enum):
... RED = auto()
... BLUE = auto()
... GREEN = auto()
...
&gt;&gt;&gt; list(Color)
[&lt;Color.RED: 1&gt;, &lt;Color.BLUE: 2&gt;, &lt;Color.GREEN: 3&gt;]
</pre></div>
</div>
The values are chosen by <code class="xref py py-func docutils literal notranslate">_generate_next_value_()</code>, which can be
overridden:
<div class="highlight-python3 notranslate"><div class="highlight"><pre>&gt;&gt;&gt; class AutoName(Enum):
... def _generate_next_value_(name, start, count, last_values):
... return name
...
&gt;&gt;&gt; class Ordinal(AutoName):
... NORTH = auto()
... SOUTH = auto()
... EAST = auto()
... WEST = auto()
...
&gt;&gt;&gt; list(Ordinal)
[&lt;Ordinal.NORTH: &#39;NORTH&#39;&gt;, &lt;Ordinal.SOUTH: &#39;SOUTH&#39;&gt;, &lt;Ordinal.EAST: &#39;EAST&#39;&gt;, &lt;Ordinal.WEST: &#39;WEST&#39;&gt;]
</pre></div>
</div>
<div class="admonition note">
Note
The goal of the default <code class="xref py py-meth docutils literal notranslate">_generate_next_value_()</code> method is to provide
the next <a class="reference internal" href="functions.html#int" title="int"><code class="xref py py-class docutils literal notranslate">int</code></a> in sequence with the last <a class="reference internal" href="functions.html#int" title="int"><code class="xref py py-class docutils literal notranslate">int</code></a> provided, but
the way it does this is an implementation detail and may change.
</div>
<div class="admonition note">
Note
The <code class="xref py py-meth docutils literal notranslate">_generate_next_value_()</code> method must be defined before any members.
</div>
</section>
<section id="iteration">
<h2>Iteration<a class="headerlink" href="#iteration" title="Permalink to this headline">¶</a></h2>
Iterating over the members of an enum does not provide the aliases:
<div class="highlight-python3 notranslate"><div class="highlight"><pre>&gt;&gt;&gt; list(Shape)
[&lt;Shape.SQUARE: 2&gt;, &lt;Shape.DIAMOND: 1&gt;, &lt;Shape.CIRCLE: 3&gt;]
</pre></div>
</div>
The special attribute <code class="docutils literal notranslate">__members__</code> is a read-only ordered mapping of names
to members. It includes all names defined in the enumeration, including the
aliases:
<div class="highlight-python3 notranslate"><div class="highlight"><pre>&gt;&gt;&gt; for name, member in Shape.__members__.items():
... name, member
...
(&#39;SQUARE&#39;, &lt;Shape.SQUARE: 2&gt;)
(&#39;DIAMOND&#39;, &lt;Shape.DIAMOND: 1&gt;)
(&#39;CIRCLE&#39;, &lt;Shape.CIRCLE: 3&gt;)
(&#39;ALIAS_FOR_SQUARE&#39;, &lt;Shape.SQUARE: 2&gt;)
</pre></div>
</div>
The <code class="docutils literal notranslate">__members__</code> attribute can be used for detailed programmatic access to
the enumeration members. For example, finding all the aliases:
<div class="highlight-python3 notranslate"><div class="highlight"><pre>&gt;&gt;&gt; [name for name, member in Shape.__members__.items() if member.name != name]
[&#39;ALIAS_FOR_SQUARE&#39;]
</pre></div>
</div>
</section>
<section id="comparisons">
<h2>Comparisons<a class="headerlink" href="#comparisons" title="Permalink to this headline">¶</a></h2>
Enumeration members are compared by identity:
<div class="highlight-python3 notranslate"><div class="highlight"><pre>&gt;&gt;&gt; Color.RED is Color.RED
True
&gt;&gt;&gt; Color.RED is Color.BLUE
False
&gt;&gt;&gt; Color.RED is not Color.BLUE
True
</pre></div>
</div>
Ordered comparisons between enumeration values are not supported. Enum
members are not integers (but see <a class="reference internal" href="#intenum">IntEnum</a> below):
<div class="highlight-python3 notranslate"><div class="highlight"><pre>&gt;&gt;&gt; Color.RED &lt; Color.BLUE
Traceback (most recent call last):
 File &quot;&lt;stdin&gt;&quot;, line 1, in &lt;module&gt;
TypeError: &#39;&lt;&#39; not supported between instances of &#39;Color&#39; and &#39;Color&#39;
</pre></div>
</div>
Equality comparisons are defined though:
<div class="highlight-python3 notranslate"><div class="highlight"><pre>&gt;&gt;&gt; Color.BLUE == Color.RED
False
&gt;&gt;&gt; Color.BLUE != Color.RED
True
&gt;&gt;&gt; Color.BLUE == Color.BLUE
True
</pre></div>
</div>
Comparisons against non-enumeration values will always compare not equal
(again, <a class="reference internal" href="#enum.IntEnum" title="enum.IntEnum"><code class="xref py py-class docutils literal notranslate">IntEnum</code></a> was explicitly designed to behave differently, see
below):
<div class="highlight-python3 notranslate"><div class="highlight"><pre>&gt;&gt;&gt; Color.BLUE == 2
False
</pre></div>
</div>
</section>
<section id="allowed-members-and-attributes-of-enumerations">
<h2>Allowed members and attributes of enumerations<a class="headerlink" href="#allowed-members-and-attributes-of-enumerations" title="Permalink to this headline">¶</a></h2>
The examples above use integers for enumeration values. Using integers is
short and handy (and provided by default by the <a class="reference internal" href="#functional-api">Functional API</a>), but not
strictly enforced. In the vast majority of use-cases, one doesn’t care what
the actual value of an enumeration is. But if the value is important,
enumerations can have arbitrary values.
Enumerations are Python classes, and can have methods and special methods as
usual. If we have this enumeration:
<div class="highlight-python3 notranslate"><div class="highlight"><pre>&gt;&gt;&gt; class Mood(Enum):
... FUNKY = 1
... HAPPY = 3
...
... def describe(self):
... # self is the member here
... return self.name, self.value
...
... def __str__(self):
... return &#39;my custom str! {0}&#39;.format(self.value)
...
... @classmethod
... def favorite_mood(cls):
... # cls here is the enumeration
... return cls.HAPPY
...
</pre></div>
</div>
Then:
<div class="highlight-python3 notranslate"><div class="highlight"><pre>&gt;&gt;&gt; Mood.favorite_mood()
&lt;Mood.HAPPY: 3&gt;
&gt;&gt;&gt; Mood.HAPPY.describe()
(&#39;HAPPY&#39;, 3)
&gt;&gt;&gt; str(Mood.FUNKY)
&#39;my custom str! 1&#39;
</pre></div>
</div>
The rules for what is allowed are as follows: names that start and end with
a single underscore are reserved by enum and cannot be used; all other
attributes defined within an enumeration will become members of this
enumeration, with the exception of special methods (<code class="xref py py-meth docutils literal notranslate">__str__()</code>,
<code class="xref py py-meth docutils literal notranslate">__add__()</code>, etc.), descriptors (methods are also descriptors), and
variable names listed in <code class="xref py py-attr docutils literal notranslate">_ignore_</code>.
Note: if your enumeration defines <code class="xref py py-meth docutils literal notranslate">__new__()</code> and/or <code class="xref py py-meth docutils literal notranslate">__init__()</code> then
any value(s) given to the enum member will be passed into those methods.
See <a class="reference internal" href="#planet">Planet</a> for an example.
</section>
<section id="restricted-enum-subclassing">
<h2>Restricted Enum subclassing<a class="headerlink" href="#restricted-enum-subclassing" title="Permalink to this headline">¶</a></h2>
A new <a class="reference internal" href="#enum.Enum" title="enum.Enum"><code class="xref py py-class docutils literal notranslate">Enum</code></a> class must have one base Enum class, up to one concrete
data type, and as many <a class="reference internal" href="functions.html#object" title="object"><code class="xref py py-class docutils literal notranslate">object</code></a>-based mixin classes as needed. The
order of these base classes is:
<div class="highlight-python3 notranslate"><div class="highlight"><pre>class EnumName([mix-in, ...,] [data-type,] base-enum):
 pass
</pre></div>
</div>
Also, subclassing an enumeration is allowed only if the enumeration does not define
any members. So this is forbidden:
<div class="highlight-python3 notranslate"><div class="highlight"><pre>&gt;&gt;&gt; class MoreColor(Color):
... PINK = 17
...
Traceback (most recent call last):
...
TypeError: MoreColor: cannot extend enumeration &#39;Color&#39;
</pre></div>
</div>
But this is allowed:
<div class="highlight-python3 notranslate"><div class="highlight"><pre>&gt;&gt;&gt; class Foo(Enum):
... def some_behavior(self):
... pass
...
&gt;&gt;&gt; class Bar(Foo):
... HAPPY = 1
... SAD = 2
...
</pre></div>
</div>
Allowing subclassing of enums that define members would lead to a violation of
some important invariants of types and instances. On the other hand, it makes
sense to allow sharing some common behavior between a group of enumerations.
(See <a class="reference internal" href="#orderedenum">OrderedEnum</a> for an example.)
</section>
<section id="pickling">
<h2>Pickling<a class="headerlink" href="#pickling" title="Permalink to this headline">¶</a></h2>
Enumerations can be pickled and unpickled:
<div class="highlight-python3 notranslate"><div class="highlight"><pre>&gt;&gt;&gt; from test.test_enum import Fruit
&gt;&gt;&gt; from pickle import dumps, loads
&gt;&gt;&gt; Fruit.TOMATO is loads(dumps(Fruit.TOMATO))
True
</pre></div>
</div>
The usual restrictions for pickling apply: picklable enums must be defined in
the top level of a module, since unpickling requires them to be importable
from that module.
<div class="admonition note">
Note
With pickle protocol version 4 it is possible to easily pickle enums
nested in other classes.
</div>
It is possible to modify how Enum members are pickled/unpickled by defining
<code class="xref py py-meth docutils literal notranslate">__reduce_ex__()</code> in the enumeration class.
</section>
<section id="functional-api">
<h2>Functional API<a class="headerlink" href="#functional-api" title="Permalink to this headline">¶</a></h2>
The <a class="reference internal" href="#enum.Enum" title="enum.Enum"><code class="xref py py-class docutils literal notranslate">Enum</code></a> class is callable, providing the following functional API:
<div class="highlight-python3 notranslate"><div class="highlight"><pre>&gt;&gt;&gt; Animal = Enum(&#39;Animal&#39;, &#39;ANT BEE CAT DOG&#39;)
&gt;&gt;&gt; Animal
&lt;enum &#39;Animal&#39;&gt;
&gt;&gt;&gt; Animal.ANT
&lt;Animal.ANT: 1&gt;
&gt;&gt;&gt; Animal.ANT.value
1
&gt;&gt;&gt; list(Animal)
[&lt;Animal.ANT: 1&gt;, &lt;Animal.BEE: 2&gt;, &lt;Animal.CAT: 3&gt;, &lt;Animal.DOG: 4&gt;]
</pre></div>
</div>
The semantics of this API resemble <a class="reference internal" href="collections.html#collections.namedtuple" title="collections.namedtuple"><code class="xref py py-class docutils literal notranslate">namedtuple</code></a>. The first
argument of the call to <a class="reference internal" href="#enum.Enum" title="enum.Enum"><code class="xref py py-class docutils literal notranslate">Enum</code></a> is the name of the enumeration.
The second argument is the source of enumeration member names. It can be a
whitespace-separated string of names, a sequence of names, a sequence of
2-tuples with key/value pairs, or a mapping (e.g. dictionary) of names to
values. The last two options enable assigning arbitrary values to
enumerations; the others auto-assign increasing integers starting with 1 (use
the <code class="docutils literal notranslate">start</code> parameter to specify a different starting value). A
new class derived from <a class="reference internal" href="#enum.Enum" title="enum.Enum"><code class="xref py py-class docutils literal notranslate">Enum</code></a> is returned. In other words, the above
assignment to <code class="xref py py-class docutils literal notranslate">Animal</code> is equivalent to:
<div class="highlight-python3 notranslate"><div class="highlight"><pre>&gt;&gt;&gt; class Animal(Enum):
... ANT = 1
... BEE = 2
... CAT = 3
... DOG = 4
...
</pre></div>
</div>
The reason for defaulting to <code class="docutils literal notranslate">1</code> as the starting number and not <code class="docutils literal notranslate">0</code> is
that <code class="docutils literal notranslate">0</code> is <code class="docutils literal notranslate">False</code> in a boolean sense, but enum members all evaluate
to <code class="docutils literal notranslate">True</code>.
Pickling enums created with the functional API can be tricky as frame stack
implementation details are used to try and figure out which module the
enumeration is being created in (e.g. it will fail if you use a utility
function in separate module, and also may not work on IronPython or Jython).
The solution is to specify the module name explicitly as follows:
<div class="highlight-python3 notranslate"><div class="highlight"><pre>&gt;&gt;&gt; Animal = Enum(&#39;Animal&#39;, &#39;ANT BEE CAT DOG&#39;, module=__name__)
</pre></div>
</div>
<div class="admonition warning">
Warning
If <code class="docutils literal notranslate">module</code> is not supplied, and Enum cannot determine what it is,
the new Enum members will not be unpicklable; to keep errors closer to
the source, pickling will be disabled.
</div>
The new pickle protocol 4 also, in some circumstances, relies on
<a class="reference internal" href="stdtypes.html#definition.__qualname__" title="definition.__qualname__"><code class="xref py py-attr docutils literal notranslate">__qualname__</code></a> being set to the location where pickle will be able
to find the class. For example, if the class was made available in class
SomeData in the global scope:
<div class="highlight-python3 notranslate"><div class="highlight"><pre>&gt;&gt;&gt; Animal = Enum(&#39;Animal&#39;, &#39;ANT BEE CAT DOG&#39;, qualname=&#39;SomeData.Animal&#39;)
</pre></div>
</div>
The complete signature is:
<div class="highlight-python3 notranslate"><div class="highlight"><pre>Enum(value=&#39;NewEnumName&#39;, names=&lt;...&gt;, *, module=&#39;...&#39;, qualname=&#39;...&#39;, type=&lt;mixed-in class&gt;, start=1)
</pre></div>
</div>
<dl class="field-list">
<dt class="field-odd">value</dt>
<dd class="field-odd">What the new Enum class will record as its name.
</dd>
<dt class="field-even">names</dt>
<dd class="field-even">The Enum members. This can be a whitespace or comma separated string
(values will start at 1 unless otherwise specified):
<div class="highlight-python3 notranslate"><div class="highlight"><pre>&#39;RED GREEN BLUE&#39; | &#39;RED,GREEN,BLUE&#39; | &#39;RED, GREEN, BLUE&#39;
</pre></div>
</div>
or an iterator of names:
<div class="highlight-python3 notranslate"><div class="highlight"><pre>[&#39;RED&#39;, &#39;GREEN&#39;, &#39;BLUE&#39;]
</pre></div>
</div>
or an iterator of (name, value) pairs:
<div class="highlight-python3 notranslate"><div class="highlight"><pre>[(&#39;CYAN&#39;, 4), (&#39;MAGENTA&#39;, 5), (&#39;YELLOW&#39;, 6)]
</pre></div>
</div>
or a mapping:
<div class="highlight-python3 notranslate"><div class="highlight"><pre>{&#39;CHARTREUSE&#39;: 7, &#39;SEA_GREEN&#39;: 11, &#39;ROSEMARY&#39;: 42}
</pre></div>
</div>
</dd>
<dt class="field-odd">module</dt>
<dd class="field-odd">name of module where new Enum class can be found.
</dd>
<dt class="field-even">qualname</dt>
<dd class="field-even">where in module new Enum class can be found.
</dd>
<dt class="field-odd">type</dt>
<dd class="field-odd">type to mix in to new Enum class.
</dd>
<dt class="field-even">start</dt>
<dd class="field-even">number to start counting at if only names are passed in.
</dd>
</dl>
<div class="versionchanged">
Changed in version 3.5: The start parameter was added.
</div>
</section>
<section id="derived-enumerations">
<h2>Derived Enumerations<a class="headerlink" href="#derived-enumerations" title="Permalink to this headline">¶</a></h2>
<section id="intenum">
<h3>IntEnum<a class="headerlink" href="#intenum" title="Permalink to this headline">¶</a></h3>
The first variation of <a class="reference internal" href="#enum.Enum" title="enum.Enum"><code class="xref py py-class docutils literal notranslate">Enum</code></a> that is provided is also a subclass of
<a class="reference internal" href="functions.html#int" title="int"><code class="xref py py-class docutils literal notranslate">int</code></a>. Members of an <a class="reference internal" href="#enum.IntEnum" title="enum.IntEnum"><code class="xref py py-class docutils literal notranslate">IntEnum</code></a> can be compared to integers;
by extension, integer enumerations of different types can also be compared
to each other:
<div class="highlight-python3 notranslate"><div class="highlight"><pre>&gt;&gt;&gt; from enum import IntEnum
&gt;&gt;&gt; class Shape(IntEnum):
... CIRCLE = 1
... SQUARE = 2
...
&gt;&gt;&gt; class Request(IntEnum):
... POST = 1
... GET = 2
...
&gt;&gt;&gt; Shape == 1
False
&gt;&gt;&gt; Shape.CIRCLE == 1
True
&gt;&gt;&gt; Shape.CIRCLE == Request.POST
True
</pre></div>
</div>
However, they still can’t be compared to standard <a class="reference internal" href="#enum.Enum" title="enum.Enum"><code class="xref py py-class docutils literal notranslate">Enum</code></a> enumerations:
<div class="highlight-python3 notranslate"><div class="highlight"><pre>&gt;&gt;&gt; class Shape(IntEnum):
... CIRCLE = 1
... SQUARE = 2
...
&gt;&gt;&gt; class Color(Enum):
... RED = 1
... GREEN = 2
...
&gt;&gt;&gt; Shape.CIRCLE == Color.RED
False
</pre></div>
</div>
<a class="reference internal" href="#enum.IntEnum" title="enum.IntEnum"><code class="xref py py-class docutils literal notranslate">IntEnum</code></a> values behave like integers in other ways you’d expect:
<div class="highlight-python3 notranslate"><div class="highlight"><pre>&gt;&gt;&gt; int(Shape.CIRCLE)
1
&gt;&gt;&gt; [&#39;a&#39;, &#39;b&#39;, &#39;c&#39;][Shape.CIRCLE]
&#39;b&#39;
&gt;&gt;&gt; [i for i in range(Shape.SQUARE)]
[0, 1]
</pre></div>
</div>
</section>
<section id="intflag">
<h3>IntFlag<a class="headerlink" href="#intflag" title="Permalink to this headline">¶</a></h3>
The next variation of <a class="reference internal" href="#enum.Enum" title="enum.Enum"><code class="xref py py-class docutils literal notranslate">Enum</code></a> provided, <a class="reference internal" href="#enum.IntFlag" title="enum.IntFlag"><code class="xref py py-class docutils literal notranslate">IntFlag</code></a>, is also based
on <a class="reference internal" href="functions.html#int" title="int"><code class="xref py py-class docutils literal notranslate">int</code></a>. The difference being <a class="reference internal" href="#enum.IntFlag" title="enum.IntFlag"><code class="xref py py-class docutils literal notranslate">IntFlag</code></a> members can be combined
using the bitwise operators (&amp;, |, ^, ~) and the result is still an
<a class="reference internal" href="#enum.IntFlag" title="enum.IntFlag"><code class="xref py py-class docutils literal notranslate">IntFlag</code></a> member. However, as the name implies, <a class="reference internal" href="#enum.IntFlag" title="enum.IntFlag"><code class="xref py py-class docutils literal notranslate">IntFlag</code></a>
members also subclass <a class="reference internal" href="functions.html#int" title="int"><code class="xref py py-class docutils literal notranslate">int</code></a> and can be used wherever an <a class="reference internal" href="functions.html#int" title="int"><code class="xref py py-class docutils literal notranslate">int</code></a> is
used. Any operation on an <a class="reference internal" href="#enum.IntFlag" title="enum.IntFlag"><code class="xref py py-class docutils literal notranslate">IntFlag</code></a> member besides the bit-wise
operations will lose the <a class="reference internal" href="#enum.IntFlag" title="enum.IntFlag"><code class="xref py py-class docutils literal notranslate">IntFlag</code></a> membership.
<div class="versionadded">
New in version 3.6.
</div>
Sample <a class="reference internal" href="#enum.IntFlag" title="enum.IntFlag"><code class="xref py py-class docutils literal notranslate">IntFlag</code></a> class:
<div class="highlight-python3 notranslate"><div class="highlight"><pre>&gt;&gt;&gt; from enum import IntFlag
&gt;&gt;&gt; class Perm(IntFlag):
... R = 4
... W = 2
... X = 1
...
&gt;&gt;&gt; Perm.R | Perm.W
&lt;Perm.R|W: 6&gt;
&gt;&gt;&gt; Perm.R + Perm.W
6
&gt;&gt;&gt; RW = Perm.R | Perm.W
&gt;&gt;&gt; Perm.R in RW
True
</pre></div>
</div>
It is also possible to name the combinations:
<div class="highlight-python3 notranslate"><div class="highlight"><pre>&gt;&gt;&gt; class Perm(IntFlag):
... R = 4
... W = 2
... X = 1
... RWX = 7
&gt;&gt;&gt; Perm.RWX
&lt;Perm.RWX: 7&gt;
&gt;&gt;&gt; ~Perm.RWX
&lt;Perm.-8: -8&gt;
</pre></div>
</div>
Another important difference between <a class="reference internal" href="#enum.IntFlag" title="enum.IntFlag"><code class="xref py py-class docutils literal notranslate">IntFlag</code></a> and <a class="reference internal" href="#enum.Enum" title="enum.Enum"><code class="xref py py-class docutils literal notranslate">Enum</code></a> is that
if no flags are set (the value is 0), its boolean evaluation is <a class="reference internal" href="constants.html#False" title="False"><code class="xref py py-data docutils literal notranslate">False</code></a>:
<div class="highlight-python3 notranslate"><div class="highlight"><pre>&gt;&gt;&gt; Perm.R &amp; Perm.X
&lt;Perm.0: 0&gt;
&gt;&gt;&gt; bool(Perm.R &amp; Perm.X)
False
</pre></div>
</div>
Because <a class="reference internal" href="#enum.IntFlag" title="enum.IntFlag"><code class="xref py py-class docutils literal notranslate">IntFlag</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">int</code></a> they can
be combined with them:
<div class="highlight-python3 notranslate"><div class="highlight"><pre>&gt;&gt;&gt; Perm.X | 8
&lt;Perm.8|X: 9&gt;
</pre></div>
</div>
</section>
<section id="flag">
<h3>Flag<a class="headerlink" href="#flag" title="Permalink to this headline">¶</a></h3>
The last variation is <a class="reference internal" href="#enum.Flag" title="enum.Flag"><code class="xref py py-class docutils literal notranslate">Flag</code></a>. Like <a class="reference internal" href="#enum.IntFlag" title="enum.IntFlag"><code class="xref py py-class docutils literal notranslate">IntFlag</code></a>, <a class="reference internal" href="#enum.Flag" title="enum.Flag"><code class="xref py py-class docutils literal notranslate">Flag</code></a>
members can be combined using the bitwise operators (&amp;, |, ^, ~). Unlike
<a class="reference internal" href="#enum.IntFlag" title="enum.IntFlag"><code class="xref py py-class docutils literal notranslate">IntFlag</code></a>, they cannot be combined with, nor compared against, any
other <a class="reference internal" href="#enum.Flag" title="enum.Flag"><code class="xref py py-class docutils literal notranslate">Flag</code></a> enumeration, nor <a class="reference internal" href="functions.html#int" title="int"><code class="xref py py-class docutils literal notranslate">int</code></a>. While it is possible to
specify the values directly it is recommended to use <a class="reference internal" href="#enum.auto" title="enum.auto"><code class="xref py py-class docutils literal notranslate">auto</code></a> as the
value and let <a class="reference internal" href="#enum.Flag" title="enum.Flag"><code class="xref py py-class docutils literal notranslate">Flag</code></a> select an appropriate value.
<div class="versionadded">
New in version 3.6.
</div>
Like <a class="reference internal" href="#enum.IntFlag" title="enum.IntFlag"><code class="xref py py-class docutils literal notranslate">IntFlag</code></a>, if a combination of <a class="reference internal" href="#enum.Flag" title="enum.Flag"><code class="xref py py-class docutils literal notranslate">Flag</code></a> members results in no
flags being set, the boolean evaluation is <a class="reference internal" href="constants.html#False" title="False"><code class="xref py py-data docutils literal notranslate">False</code></a>:
<div class="highlight-python3 notranslate"><div class="highlight"><pre>&gt;&gt;&gt; from enum import Flag, auto
&gt;&gt;&gt; class Color(Flag):
... RED = auto()
... BLUE = auto()
... GREEN = auto()
...
&gt;&gt;&gt; Color.RED &amp; Color.GREEN
&lt;Color.0: 0&gt;
&gt;&gt;&gt; bool(Color.RED &amp; Color.GREEN)
False
</pre></div>
</div>
Individual flags should have values that are powers of two (1, 2, 4, 8, …),
while combinations of flags won’t:
<div class="highlight-python3 notranslate"><div class="highlight"><pre>&gt;&gt;&gt; class Color(Flag):
... RED = auto()
... BLUE = auto()
... GREEN = auto()
... WHITE = RED | BLUE | GREEN
...
&gt;&gt;&gt; Color.WHITE
&lt;Color.WHITE: 7&gt;
</pre></div>
</div>
Giving a name to the “no flags set” condition does not change its boolean
value:
<div class="highlight-python3 notranslate"><div class="highlight"><pre>&gt;&gt;&gt; class Color(Flag):
... BLACK = 0
... RED = auto()
... BLUE = auto()
... GREEN = auto()
...
&gt;&gt;&gt; Color.BLACK
&lt;Color.BLACK: 0&gt;
&gt;&gt;&gt; bool(Color.BLACK)
False
</pre></div>
</div>
<div class="admonition note">
Note
For the majority of new code, <a class="reference internal" href="#enum.Enum" title="enum.Enum"><code class="xref py py-class docutils literal notranslate">Enum</code></a> and <a class="reference internal" href="#enum.Flag" title="enum.Flag"><code class="xref py py-class docutils literal notranslate">Flag</code></a> are strongly
recommended, since <a class="reference internal" href="#enum.IntEnum" title="enum.IntEnum"><code class="xref py py-class docutils literal notranslate">IntEnum</code></a> and <a class="reference internal" href="#enum.IntFlag" title="enum.IntFlag"><code class="xref py py-class docutils literal notranslate">IntFlag</code></a> break some
semantic promises of an enumeration (by being comparable to integers, and
thus by transitivity to other unrelated enumerations). <a class="reference internal" href="#enum.IntEnum" title="enum.IntEnum"><code class="xref py py-class docutils literal notranslate">IntEnum</code></a>
and <a class="reference internal" href="#enum.IntFlag" title="enum.IntFlag"><code class="xref py py-class docutils literal notranslate">IntFlag</code></a> should be used only in cases where <a class="reference internal" href="#enum.Enum" title="enum.Enum"><code class="xref py py-class docutils literal notranslate">Enum</code></a> and
<a class="reference internal" href="#enum.Flag" title="enum.Flag"><code class="xref py py-class docutils literal notranslate">Flag</code></a> will not do; for example, when integer constants are replaced
with enumerations, or for interoperability with other systems.
</div>
</section>
<section id="others">
<h3>Others<a class="headerlink" href="#others" title="Permalink to this headline">¶</a></h3>
While <a class="reference internal" href="#enum.IntEnum" title="enum.IntEnum"><code class="xref py py-class docutils literal notranslate">IntEnum</code></a> is part of the <a class="reference internal" href="#module-enum" title="enum: Implementation of an enumeration class."><code class="xref py py-mod docutils literal notranslate">enum</code></a> module, it would be very
simple to implement independently:
<div class="highlight-python3 notranslate"><div class="highlight"><pre>class IntEnum(int, Enum):
 pass
</pre></div>
</div>
This demonstrates how similar derived enumerations can be defined; for example
a <code class="xref py py-class docutils literal notranslate">StrEnum</code> that mixes in <a class="reference internal" href="stdtypes.html#str" title="str"><code class="xref py py-class docutils literal notranslate">str</code></a> instead of <a class="reference internal" href="functions.html#int" title="int"><code class="xref py py-class docutils literal notranslate">int</code></a>.
Some rules:
<ol class="arabic simple">
<li>When subclassing <a class="reference internal" href="#enum.Enum" title="enum.Enum"><code class="xref py py-class docutils literal notranslate">Enum</code></a>, mix-in types must appear before
<a class="reference internal" href="#enum.Enum" title="enum.Enum"><code class="xref py py-class docutils literal notranslate">Enum</code></a> itself in the sequence of bases, as in the <a class="reference internal" href="#enum.IntEnum" title="enum.IntEnum"><code class="xref py py-class docutils literal notranslate">IntEnum</code></a>
example above.</li>
<li>While <a class="reference internal" href="#enum.Enum" title="enum.Enum"><code class="xref py py-class docutils literal notranslate">Enum</code></a> can have members of any type, once you mix in an
additional type, all the members must have values of that type, e.g.
<a class="reference internal" href="functions.html#int" title="int"><code class="xref py py-class docutils literal notranslate">int</code></a> above. This restriction does not apply to mix-ins which only
add methods and don’t specify another type.</li>
<li>When another data type is mixed in, the <code class="xref py py-attr docutils literal notranslate">value</code> attribute is not the
same as the enum member itself, although it is equivalent and will compare
equal.</li>
<li>%-style formatting: <cite>%s</cite> and <cite>%r</cite> call the <a class="reference internal" href="#enum.Enum" title="enum.Enum"><code class="xref py py-class docutils literal notranslate">Enum</code></a> class’s
<code class="xref py py-meth docutils literal notranslate">__str__()</code> and <code class="xref py py-meth docutils literal notranslate">__repr__()</code> respectively; other codes (such as
<cite>%i</cite> or <cite>%h</cite> for IntEnum) treat the enum member as its mixed-in type.</li>
<li><a class="reference internal" href="../reference/lexical_analysis.html#f-strings">Formatted string literals</a>, <a class="reference internal" href="stdtypes.html#str.format" title="str.format"><code class="xref py py-meth docutils literal notranslate">str.format()</code></a>,
and <a class="reference internal" href="functions.html#format" title="format"><code class="xref py py-func docutils literal notranslate">format()</code></a> will use the mixed-in type’s <code class="xref py py-meth docutils literal notranslate">__format__()</code>
unless <code class="xref py py-meth docutils literal notranslate">__str__()</code> or <code class="xref py py-meth docutils literal notranslate">__format__()</code> is overridden in the subclass,
in which case the overridden methods or <a class="reference internal" href="#enum.Enum" title="enum.Enum"><code class="xref py py-class docutils literal notranslate">Enum</code></a> methods will be used.
Use the !s and !r format codes to force usage of the <a class="reference internal" href="#enum.Enum" title="enum.Enum"><code class="xref py py-class docutils literal notranslate">Enum</code></a> class’s
<code class="xref py py-meth docutils literal notranslate">__str__()</code> and <code class="xref py py-meth docutils literal notranslate">__repr__()</code> methods.</li>
</ol>
</section>
</section>
<section id="when-to-use-new-vs-init">
<h2>When to use <code class="xref py py-meth docutils literal notranslate">__new__()</code> vs. <code class="xref py py-meth docutils literal notranslate">__init__()</code><a class="headerlink" href="#when-to-use-new-vs-init" title="Permalink to this headline">¶</a></h2>
<code class="xref py py-meth docutils literal notranslate">__new__()</code> must be used whenever you want to customize the actual value of
the <a class="reference internal" href="#enum.Enum" title="enum.Enum"><code class="xref py py-class docutils literal notranslate">Enum</code></a> member. Any other modifications may go in either
<code class="xref py py-meth docutils literal notranslate">__new__()</code> or <code class="xref py py-meth docutils literal notranslate">__init__()</code>, with <code class="xref py py-meth docutils literal notranslate">__init__()</code> being preferred.
For example, if you want to pass several items to the constructor, but only
want one of them to be the value:
<div class="highlight-python3 notranslate"><div class="highlight"><pre>&gt;&gt;&gt; class Coordinate(bytes, Enum):
... &quot;&quot;&quot;
... Coordinate with binary codes that can be indexed by the int code.
... &quot;&quot;&quot;
... def __new__(cls, value, label, unit):
... obj = bytes.__new__(cls, [value])
... obj._value_ = value
... obj.label = label
... obj.unit = unit
... return obj
... PX = (0, &#39;P.X&#39;, &#39;km&#39;)
... PY = (1, &#39;P.Y&#39;, &#39;km&#39;)
... VX = (2, &#39;V.X&#39;, &#39;km/s&#39;)
... VY = (3, &#39;V.Y&#39;, &#39;km/s&#39;)
...

&gt;&gt;&gt; print(Coordinate[&#39;PY&#39;])
Coordinate.PY

&gt;&gt;&gt; print(Coordinate(3))
Coordinate.VY
</pre></div>
</div>
</section>
<section id="interesting-examples">
<h2>Interesting examples<a class="headerlink" href="#interesting-examples" title="Permalink to this headline">¶</a></h2>
While <a class="reference internal" href="#enum.Enum" title="enum.Enum"><code class="xref py py-class docutils literal notranslate">Enum</code></a>, <a class="reference internal" href="#enum.IntEnum" title="enum.IntEnum"><code class="xref py py-class docutils literal notranslate">IntEnum</code></a>, <a class="reference internal" href="#enum.IntFlag" title="enum.IntFlag"><code class="xref py py-class docutils literal notranslate">IntFlag</code></a>, and <a class="reference internal" href="#enum.Flag" title="enum.Flag"><code class="xref py py-class docutils literal notranslate">Flag</code></a> are
expected to cover the majority of use-cases, they cannot cover them all. Here
are recipes for some different types of enumerations that can be used directly,
or as examples for creating one’s own.
<section id="omitting-values">
<h3>Omitting values<a class="headerlink" href="#omitting-values" title="Permalink to this headline">¶</a></h3>
In many use-cases one doesn’t care what the actual value of an enumeration
is. There are several ways to define this type of simple enumeration:
<ul class="simple">
<li>use instances of <a class="reference internal" href="#enum.auto" title="enum.auto"><code class="xref py py-class docutils literal notranslate">auto</code></a> for the value</li>
<li>use instances of <a class="reference internal" href="functions.html#object" title="object"><code class="xref py py-class docutils literal notranslate">object</code></a> as the value</li>
<li>use a descriptive string as the value</li>
<li>use a tuple as the value and a custom <code class="xref py py-meth docutils literal notranslate">__new__()</code> to replace the
tuple with an <a class="reference internal" href="functions.html#int" title="int"><code class="xref py py-class docutils literal notranslate">int</code></a> value</li>
</ul>
Using any of these methods signifies to the user that these values are not
important, and also enables one to add, remove, or reorder members without
having to renumber the remaining members.
Whichever method you choose, you should provide a <a class="reference internal" href="functions.html#repr" title="repr"><code class="xref py py-meth docutils literal notranslate">repr()</code></a> that also hides
the (unimportant) value:
<div class="highlight-python3 notranslate"><div class="highlight"><pre>&gt;&gt;&gt; class NoValue(Enum):
... def __repr__(self):
... return &#39;&lt;%s.%s&gt;&#39; % (self.__class__.__name__, self.name)
...
</pre></div>
</div>
<section id="using-auto">
<h4>Using <a class="reference internal" href="#enum.auto" title="enum.auto"><code class="xref py py-class docutils literal notranslate">auto</code></a><a class="headerlink" href="#using-auto" title="Permalink to this headline">¶</a></h4>
Using <a class="reference internal" href="#enum.auto" title="enum.auto"><code class="xref py py-class docutils literal notranslate">auto</code></a> would look like:
<div class="highlight-python3 notranslate"><div class="highlight"><pre>&gt;&gt;&gt; class Color(NoValue):
... RED = auto()
... BLUE = auto()
... GREEN = auto()
...
&gt;&gt;&gt; Color.GREEN
&lt;Color.GREEN&gt;
</pre></div>
</div>
</section>
<section id="using-object">
<h4>Using <a class="reference internal" href="functions.html#object" title="object"><code class="xref py py-class docutils literal notranslate">object</code></a><a class="headerlink" href="#using-object" title="Permalink to this headline">¶</a></h4>
Using <a class="reference internal" href="functions.html#object" title="object"><code class="xref py py-class docutils literal notranslate">object</code></a> would look like:
<div class="highlight-python3 notranslate"><div class="highlight"><pre>&gt;&gt;&gt; class Color(NoValue):
... RED = object()
... GREEN = object()
... BLUE = object()
...
&gt;&gt;&gt; Color.GREEN
&lt;Color.GREEN&gt;
</pre></div>
</div>
</section>
<section id="using-a-descriptive-string">
<h4>Using a descriptive string<a class="headerlink" href="#using-a-descriptive-string" title="Permalink to this headline">¶</a></h4>
Using a string as the value would look like:
<div class="highlight-python3 notranslate"><div class="highlight"><pre>&gt;&gt;&gt; class Color(NoValue):
... RED = &#39;stop&#39;
... GREEN = &#39;go&#39;
... BLUE = &#39;too fast!&#39;
...
&gt;&gt;&gt; Color.GREEN
&lt;Color.GREEN&gt;
&gt;&gt;&gt; Color.GREEN.value
&#39;go&#39;
</pre></div>
</div>
</section>
<section id="using-a-custom-new">
<h4>Using a custom <code class="xref py py-meth docutils literal notranslate">__new__()</code><a class="headerlink" href="#using-a-custom-new" title="Permalink to this headline">¶</a></h4>
Using an auto-numbering <code class="xref py py-meth docutils literal notranslate">__new__()</code> would look like:
<div class="highlight-python3 notranslate"><div class="highlight"><pre>&gt;&gt;&gt; class AutoNumber(NoValue):
... def __new__(cls):
... value = len(cls.__members__) + 1
... obj = object.__new__(cls)
... obj._value_ = value
... return obj
...
&gt;&gt;&gt; class Color(AutoNumber):
... RED = ()
... GREEN = ()
... BLUE = ()
...
&gt;&gt;&gt; Color.GREEN
&lt;Color.GREEN&gt;
&gt;&gt;&gt; Color.GREEN.value
2
</pre></div>
</div>
To make a more general purpose <code class="docutils literal notranslate">AutoNumber</code>, add <code class="docutils literal notranslate">*args</code> to the signature:
<div class="highlight-python3 notranslate"><div class="highlight"><pre>&gt;&gt;&gt; class AutoNumber(NoValue):
... def __new__(cls, *args): # this is the only change from above
... value = len(cls.__members__) + 1
... obj = object.__new__(cls)
... obj._value_ = value
... return obj
...
</pre></div>
</div>
Then when you inherit from <code class="docutils literal notranslate">AutoNumber</code> you can write your own <code class="docutils literal notranslate">__init__</code>
to handle any extra arguments:
<div class="highlight-python3 notranslate"><div class="highlight"><pre>&gt;&gt;&gt; class Swatch(AutoNumber):
... def __init__(self, pantone=&#39;unknown&#39;):
... self.pantone = pantone
... AUBURN = &#39;3497&#39;
... SEA_GREEN = &#39;1246&#39;
... BLEACHED_CORAL = () # New color, no Pantone code yet!
...
&gt;&gt;&gt; Swatch.SEA_GREEN
&lt;Swatch.SEA_GREEN&gt;
&gt;&gt;&gt; Swatch.SEA_GREEN.pantone
&#39;1246&#39;
&gt;&gt;&gt; Swatch.BLEACHED_CORAL.pantone
&#39;unknown&#39;
</pre></div>
</div>
<div class="admonition note">
Note
The <code class="xref py py-meth docutils literal notranslate">__new__()</code> method, if defined, is used during creation of the Enum
members; it is then replaced by Enum’s <code class="xref py py-meth docutils literal notranslate">__new__()</code> which is used after
class creation for lookup of existing members.
</div>
</section>
</section>
<section id="orderedenum">
<h3>OrderedEnum<a class="headerlink" href="#orderedenum" title="Permalink to this headline">¶</a></h3>
An ordered enumeration that is not based on <a class="reference internal" href="#enum.IntEnum" title="enum.IntEnum"><code class="xref py py-class docutils literal notranslate">IntEnum</code></a> and so maintains
the normal <a class="reference internal" href="#enum.Enum" title="enum.Enum"><code class="xref py py-class docutils literal notranslate">Enum</code></a> invariants (such as not being comparable to other
enumerations):
<div class="highlight-python3 notranslate"><div class="highlight"><pre>&gt;&gt;&gt; class OrderedEnum(Enum):
... def __ge__(self, other):
... if self.__class__ is other.__class__:
... return self.value &gt;= other.value
... return NotImplemented
... def __gt__(self, other):
... if self.__class__ is other.__class__:
... return self.value &gt; other.value
... return NotImplemented
... def __le__(self, other):
... if self.__class__ is other.__class__:
... return self.value &lt;= other.value
... return NotImplemented
... def __lt__(self, other):
... if self.__class__ is other.__class__:
... return self.value &lt; other.value
... return NotImplemented
...
&gt;&gt;&gt; class Grade(OrderedEnum):
... A = 5
... B = 4
... C = 3
... D = 2
... F = 1
...
&gt;&gt;&gt; Grade.C &lt; Grade.A
True
</pre></div>
</div>
</section>
<section id="duplicatefreeenum">
<h3>DuplicateFreeEnum<a class="headerlink" href="#duplicatefreeenum" title="Permalink to this headline">¶</a></h3>
Raises an error if a duplicate member name is found instead of creating an
alias:
<div class="highlight-python3 notranslate"><div class="highlight"><pre>&gt;&gt;&gt; class DuplicateFreeEnum(Enum):
... def __init__(self, *args):
... cls = self.__class__
... if any(self.value == e.value for e in cls):
... a = self.name
... e = cls(self.value).name
... raise ValueError(
... &quot;aliases not allowed in DuplicateFreeEnum: %r --&gt; %r&quot;
... % (a, e))
...
&gt;&gt;&gt; class Color(DuplicateFreeEnum):
... RED = 1
... GREEN = 2
... BLUE = 3
... GRENE = 2
...
Traceback (most recent call last):
...
ValueError: aliases not allowed in DuplicateFreeEnum: &#39;GRENE&#39; --&gt; &#39;GREEN&#39;
</pre></div>
</div>
<div class="admonition note">
Note
This is a useful example for subclassing Enum to add or change other
behaviors as well as disallowing aliases. If the only desired change is
disallowing aliases, the <a class="reference internal" href="#enum.unique" title="enum.unique"><code class="xref py py-func docutils literal notranslate">unique()</code></a> decorator can be used instead.
</div>
</section>
<section id="planet">
<h3>Planet<a class="headerlink" href="#planet" title="Permalink to this headline">¶</a></h3>
If <code class="xref py py-meth docutils literal notranslate">__new__()</code> or <code class="xref py py-meth docutils literal notranslate">__init__()</code> is defined the value of the enum member
will be passed to those methods:
<div class="highlight-python3 notranslate"><div class="highlight"><pre>&gt;&gt;&gt; class Planet(Enum):
... MERCURY = (3.303e+23, 2.4397e6)
... VENUS = (4.869e+24, 6.0518e6)
... EARTH = (5.976e+24, 6.37814e6)
... MARS = (6.421e+23, 3.3972e6)
... JUPITER = (1.9e+27, 7.1492e7)
... SATURN = (5.688e+26, 6.0268e7)
... URANUS = (8.686e+25, 2.5559e7)
... NEPTUNE = (1.024e+26, 2.4746e7)
... def __init__(self, mass, radius):
... self.mass = mass # in kilograms
... self.radius = radius # in meters
... @property
... def surface_gravity(self):
... # universal gravitational constant (m3 kg-1 s-2)
... G = 6.67300E-11
... return G * self.mass / (self.radius * self.radius)
...
&gt;&gt;&gt; Planet.EARTH.value
(5.976e+24, 6378140.0)
&gt;&gt;&gt; Planet.EARTH.surface_gravity
9.802652743337129
</pre></div>
</div>
</section>
<section id="timeperiod">
<h3>TimePeriod<a class="headerlink" href="#timeperiod" title="Permalink to this headline">¶</a></h3>
An example to show the <code class="xref py py-attr docutils literal notranslate">_ignore_</code> attribute in use:
<div class="highlight-python3 notranslate"><div class="highlight"><pre>&gt;&gt;&gt; from datetime import timedelta
&gt;&gt;&gt; class Period(timedelta, Enum):
... &quot;different lengths of time&quot;
... _ignore_ = &#39;Period i&#39;
... Period = vars()
... for i in range(367):
... Period[&#39;day_%d&#39; % i] = i
...
&gt;&gt;&gt; list(Period)[:2]
[&lt;Period.day_0: datetime.timedelta(0)&gt;, &lt;Period.day_1: datetime.timedelta(days=1)&gt;]
&gt;&gt;&gt; list(Period)[-2:]
[&lt;Period.day_365: datetime.timedelta(days=365)&gt;, &lt;Period.day_366: datetime.timedelta(days=366)&gt;]
</pre></div>
</div>
</section>
</section>
<section id="how-are-enums-different">
<h2>How are Enums different?<a class="headerlink" href="#how-are-enums-different" title="Permalink to this headline">¶</a></h2>
Enums have a custom metaclass that affects many aspects of both derived Enum
classes and their instances (members).
<section id="enum-classes">
<h3>Enum Classes<a class="headerlink" href="#enum-classes" title="Permalink to this headline">¶</a></h3>
The <code class="xref py py-class docutils literal notranslate">EnumMeta</code> metaclass is responsible for providing the
<code class="xref py py-meth docutils literal notranslate">__contains__()</code>, <code class="xref py py-meth docutils literal notranslate">__dir__()</code>, <code class="xref py py-meth docutils literal notranslate">__iter__()</code> and other methods that
allow one to do things with an <a class="reference internal" href="#enum.Enum" title="enum.Enum"><code class="xref py py-class docutils literal notranslate">Enum</code></a> class that fail on a typical
class, such as <cite>list(Color)</cite> or <cite>some_enum_var in Color</cite>. <code class="xref py py-class docutils literal notranslate">EnumMeta</code> is
responsible for ensuring that various other methods on the final <a class="reference internal" href="#enum.Enum" title="enum.Enum"><code class="xref py py-class docutils literal notranslate">Enum</code></a>
class are correct (such as <code class="xref py py-meth docutils literal notranslate">__new__()</code>, <code class="xref py py-meth docutils literal notranslate">__getnewargs__()</code>,
<code class="xref py py-meth docutils literal notranslate">__str__()</code> and <code class="xref py py-meth docutils literal notranslate">__repr__()</code>).
</section>
<section id="enum-members-aka-instances">
<h3>Enum Members (aka instances)<a class="headerlink" href="#enum-members-aka-instances" title="Permalink to this headline">¶</a></h3>
The most interesting thing about Enum members is that they are singletons.
<code class="xref py py-class docutils literal notranslate">EnumMeta</code> creates them all while it is creating the <a class="reference internal" href="#enum.Enum" title="enum.Enum"><code class="xref py py-class docutils literal notranslate">Enum</code></a>
class itself, and then puts a custom <code class="xref py py-meth docutils literal notranslate">__new__()</code> in place to ensure
that no new ones are ever instantiated by returning only the existing
member instances.
</section>
<section id="finer-points">
<h3>Finer Points<a class="headerlink" href="#finer-points" title="Permalink to this headline">¶</a></h3>
<section id="supported-dunder-names">
<h4>Supported <code class="docutils literal notranslate">__dunder__</code> names<a class="headerlink" href="#supported-dunder-names" title="Permalink to this headline">¶</a></h4>
<code class="xref py py-attr docutils literal notranslate">__members__</code> is a read-only ordered mapping of <code class="docutils literal notranslate">member_name</code>:<code class="docutils literal notranslate">member</code>
items. It is only available on the class.
<code class="xref py py-meth docutils literal notranslate">__new__()</code>, if specified, must create and return the enum members; it is
also a very good idea to set the member’s <code class="xref py py-attr docutils literal notranslate">_value_</code> appropriately. Once
all the members are created it is no longer used.
</section>
<section id="supported-sunder-names">
<h4>Supported <code class="docutils literal notranslate">_sunder_</code> names<a class="headerlink" href="#supported-sunder-names" title="Permalink to this headline">¶</a></h4>
<ul class="simple">
<li><code class="docutils literal notranslate">_name_</code> – name of the member</li>
<li><code class="docutils literal notranslate">_value_</code> – value of the member; can be set / modified in <code class="docutils literal notranslate">__new__</code></li>
<li><code class="docutils literal notranslate">_missing_</code> – a lookup function used when a value is not found; may be
overridden</li>
<li><code class="docutils literal notranslate">_ignore_</code> – 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">list</code></a> or a <a class="reference internal" href="stdtypes.html#str" title="str"><code class="xref py py-class docutils literal notranslate">str</code></a>,
that will not be transformed into members, and will be removed from the final
class</li>
<li><code class="docutils literal notranslate">_order_</code> – used in Python 2/3 code to ensure member order is consistent
(class attribute, removed during class creation)</li>
<li><code class="docutils literal notranslate">_generate_next_value_</code> – used by the <a class="reference internal" href="#functional-api">Functional API</a> and by
<a class="reference internal" href="#enum.auto" title="enum.auto"><code class="xref py py-class docutils literal notranslate">auto</code></a> to get an appropriate value for an enum member; may be
overridden</li>
</ul>
<div class="versionadded">
New in version 3.6: <code class="docutils literal notranslate">_missing_</code>, <code class="docutils literal notranslate">_order_</code>, <code class="docutils literal notranslate">_generate_next_value_</code>
</div>
<div class="versionadded">
New in version 3.7: <code class="docutils literal notranslate">_ignore_</code>
</div>
To help keep Python 2 / Python 3 code in sync an <code class="xref py py-attr docutils literal notranslate">_order_</code> attribute can
be provided. It will be checked against the actual order of the enumeration
and raise an error if the two do not match:
<div class="highlight-python3 notranslate"><div class="highlight"><pre>&gt;&gt;&gt; class Color(Enum):
... _order_ = &#39;RED GREEN BLUE&#39;
... RED = 1
... BLUE = 3
... GREEN = 2
...
Traceback (most recent call last):
...
TypeError: member order does not match _order_
</pre></div>
</div>
<div class="admonition note">
Note
In Python 2 code the <code class="xref py py-attr docutils literal notranslate">_order_</code> attribute is necessary as definition
order is lost before it can be recorded.
</div>
</section>
<section id="private-names">
<h4>_Private__names<a class="headerlink" href="#private-names" title="Permalink to this headline">¶</a></h4>
<a class="reference internal" href="../reference/expressions.html#private-name-mangling">Private names</a> will be normal attributes in Python
3.11 instead of either an error or a member (depending on if the name ends with
an underscore). Using these names in 3.10 will issue a <a class="reference internal" href="exceptions.html#DeprecationWarning" title="DeprecationWarning"><code class="xref py py-exc docutils literal notranslate">DeprecationWarning</code></a>.
</section>
<section id="enum-member-type">
<h4><code class="docutils literal notranslate">Enum</code> member type<a class="headerlink" href="#enum-member-type" title="Permalink to this headline">¶</a></h4>
<a class="reference internal" href="#enum.Enum" title="enum.Enum"><code class="xref py py-class docutils literal notranslate">Enum</code></a> members are instances of their <a class="reference internal" href="#enum.Enum" title="enum.Enum"><code class="xref py py-class docutils literal notranslate">Enum</code></a> class, and are
normally accessed as <code class="docutils literal notranslate">EnumClass.member</code>. Under certain circumstances they
can also be accessed as <code class="docutils literal notranslate">EnumClass.member.member</code>, but you should never do
this as that lookup may fail or, worse, return something besides the
<a class="reference internal" href="#enum.Enum" title="enum.Enum"><code class="xref py py-class docutils literal notranslate">Enum</code></a> member you are looking for (this is another good reason to use
all-uppercase names for members):
<div class="highlight-python3 notranslate"><div class="highlight"><pre>&gt;&gt;&gt; class FieldTypes(Enum):
... name = 0
... value = 1
... size = 2
...
&gt;&gt;&gt; FieldTypes.value.size
&lt;FieldTypes.size: 2&gt;
&gt;&gt;&gt; FieldTypes.size.value
2
</pre></div>
</div>
<div class="admonition note">
Note
This behavior is deprecated and will be removed in 3.11.
</div>
<div class="versionchanged">
Changed in version 3.5.
</div>
</section>
<section id="boolean-value-of-enum-classes-and-members">
<h4>Boolean value of <code class="docutils literal notranslate">Enum</code> classes and members<a class="headerlink" href="#boolean-value-of-enum-classes-and-members" title="Permalink to this headline">¶</a></h4>
<a class="reference internal" href="#enum.Enum" title="enum.Enum"><code class="xref py py-class docutils literal notranslate">Enum</code></a> members that are mixed with non-<a class="reference internal" href="#enum.Enum" title="enum.Enum"><code class="xref py py-class docutils literal notranslate">Enum</code></a> types (such as
<a class="reference internal" href="functions.html#int" title="int"><code class="xref py py-class docutils literal notranslate">int</code></a>, <a class="reference internal" href="stdtypes.html#str" title="str"><code class="xref py py-class docutils literal notranslate">str</code></a>, etc.) are evaluated according to the mixed-in
type’s rules; otherwise, all members evaluate as <a class="reference internal" href="constants.html#True" title="True"><code class="xref py py-data docutils literal notranslate">True</code></a>. To make your
own Enum’s boolean evaluation depend on the member’s value add the following to
your class:
<div class="highlight-python3 notranslate"><div class="highlight"><pre>def __bool__(self):
 return bool(self.value)
</pre></div>
</div>
<a class="reference internal" href="#enum.Enum" title="enum.Enum"><code class="xref py py-class docutils literal notranslate">Enum</code></a> classes always evaluate as <a class="reference internal" href="constants.html#True" title="True"><code class="xref py py-data docutils literal notranslate">True</code></a>.
</section>
<section id="enum-classes-with-methods">
<h4><code class="docutils literal notranslate">Enum</code> classes with methods<a class="headerlink" href="#enum-classes-with-methods" title="Permalink to this headline">¶</a></h4>
If you give your <a class="reference internal" href="#enum.Enum" title="enum.Enum"><code class="xref py py-class docutils literal notranslate">Enum</code></a> subclass extra methods, like the <a class="reference internal" href="#planet">Planet</a>
class above, those methods will show up in a <a class="reference internal" href="functions.html#dir" title="dir"><code class="xref py py-func docutils literal notranslate">dir()</code></a> of the member,
but not of the class:
<div class="highlight-python3 notranslate"><div class="highlight"><pre>&gt;&gt;&gt; dir(Planet)
[&#39;EARTH&#39;, &#39;JUPITER&#39;, &#39;MARS&#39;, &#39;MERCURY&#39;, &#39;NEPTUNE&#39;, &#39;SATURN&#39;, &#39;URANUS&#39;, &#39;VENUS&#39;, &#39;__class__&#39;, &#39;__doc__&#39;, &#39;__members__&#39;, &#39;__module__&#39;]
&gt;&gt;&gt; dir(Planet.EARTH)
[&#39;__class__&#39;, &#39;__doc__&#39;, &#39;__module__&#39;, &#39;mass&#39;, &#39;name&#39;, &#39;radius&#39;, &#39;surface_gravity&#39;, &#39;value&#39;]
</pre></div>
</div>
</section>
<section id="combining-members-of-flag">
<h4>Combining members of <code class="docutils literal notranslate">Flag</code><a class="headerlink" href="#combining-members-of-flag" title="Permalink to this headline">¶</a></h4>
If a combination of Flag members is not named, the <a class="reference internal" href="functions.html#repr" title="repr"><code class="xref py py-func docutils literal notranslate">repr()</code></a> will include
all named flags and all named combinations of flags that are in the value:
<div class="highlight-python3 notranslate"><div class="highlight"><pre>&gt;&gt;&gt; class Color(Flag):
... RED = auto()
... GREEN = auto()
... BLUE = auto()
... MAGENTA = RED | BLUE
... YELLOW = RED | GREEN
... CYAN = GREEN | BLUE
...
&gt;&gt;&gt; Color(3) # named combination
&lt;Color.YELLOW: 3&gt;
&gt;&gt;&gt; Color(7) # not named combination
&lt;Color.CYAN|MAGENTA|BLUE|YELLOW|GREEN|RED: 7&gt;
</pre></div>
</div>
<div class="admonition note">
Note
In 3.11 unnamed combinations of flags will only produce the canonical flag
members (aka single-value flags). So <code class="docutils literal notranslate">Color(7)</code> will produce something
like <code class="docutils literal notranslate">&lt;Color.BLUE|GREEN|RED: 7&gt;</code>.
</div>
</section>
</section>
</section>
</section>

<div class="clearer"></div>
 </div>
 </div>
 </div>
 <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
 <div class="sphinxsidebarwrapper">
 <h3><a href="../contents.html">Table of Contents</a></h3>
 <ul>
<li><a class="reference internal" href="#"><code class="xref py py-mod docutils literal notranslate">enum</code> — Support for enumerations</a><ul>
<li><a class="reference internal" href="#module-contents">Module Contents</a></li>
<li><a class="reference internal" href="#creating-an-enum">Creating an Enum</a></li>
<li><a class="reference internal" href="#programmatic-access-to-enumeration-members-and-their-attributes">Programmatic access to enumeration members and their attributes</a></li>
<li><a class="reference internal" href="#duplicating-enum-members-and-values">Duplicating enum members and values</a></li>
<li><a class="reference internal" href="#ensuring-unique-enumeration-values">Ensuring unique enumeration values</a></li>
<li><a class="reference internal" href="#using-automatic-values">Using automatic values</a></li>
<li><a class="reference internal" href="#iteration">Iteration</a></li>
<li><a class="reference internal" href="#comparisons">Comparisons</a></li>
<li><a class="reference internal" href="#allowed-members-and-attributes-of-enumerations">Allowed members and attributes of enumerations</a></li>
<li><a class="reference internal" href="#restricted-enum-subclassing">Restricted Enum subclassing</a></li>
<li><a class="reference internal" href="#pickling">Pickling</a></li>
<li><a class="reference internal" href="#functional-api">Functional API</a></li>
<li><a class="reference internal" href="#derived-enumerations">Derived Enumerations</a><ul>
<li><a class="reference internal" href="#intenum">IntEnum</a></li>
<li><a class="reference internal" href="#intflag">IntFlag</a></li>
<li><a class="reference internal" href="#flag">Flag</a></li>
<li><a class="reference internal" href="#others">Others</a></li>
</ul>
</li>
<li><a class="reference internal" href="#when-to-use-new-vs-init">When to use <code class="xref py py-meth docutils literal notranslate">__new__()</code> vs. <code class="xref py py-meth docutils literal notranslate">__init__()</code></a></li>
<li><a class="reference internal" href="#interesting-examples">Interesting examples</a><ul>
<li><a class="reference internal" href="#omitting-values">Omitting values</a><ul>
<li><a class="reference internal" href="#using-auto">Using <code class="xref py py-class docutils literal notranslate">auto</code></a></li>
<li><a class="reference internal" href="#using-object">Using <code class="xref py py-class docutils literal notranslate">object</code></a></li>
<li><a class="reference internal" href="#using-a-descriptive-string">Using a descriptive string</a></li>
<li><a class="reference internal" href="#using-a-custom-new">Using a custom <code class="xref py py-meth docutils literal notranslate">__new__()</code></a></li>
</ul>
</li>
<li><a class="reference internal" href="#orderedenum">OrderedEnum</a></li>
<li><a class="reference internal" href="#duplicatefreeenum">DuplicateFreeEnum</a></li>
<li><a class="reference internal" href="#planet">Planet</a></li>
<li><a class="reference internal" href="#timeperiod">TimePeriod</a></li>
</ul>
</li>
<li><a class="reference internal" href="#how-are-enums-different">How are Enums different?</a><ul>
<li><a class="reference internal" href="#enum-classes">Enum Classes</a></li>
<li><a class="reference internal" href="#enum-members-aka-instances">Enum Members (aka instances)</a></li>
<li><a class="reference internal" href="#finer-points">Finer Points</a><ul>
<li><a class="reference internal" href="#supported-dunder-names">Supported <code class="docutils literal notranslate">__dunder__</code> names</a></li>
<li><a class="reference internal" href="#supported-sunder-names">Supported <code class="docutils literal notranslate">_sunder_</code> names</a></li>
<li><a class="reference internal" href="#private-names">_Private__names</a></li>
<li><a class="reference internal" href="#enum-member-type"><code class="docutils literal notranslate">Enum</code> member type</a></li>
<li><a class="reference internal" href="#boolean-value-of-enum-classes-and-members">Boolean value of <code class="docutils literal notranslate">Enum</code> classes and members</a></li>
<li><a class="reference internal" href="#enum-classes-with-methods"><code class="docutils literal notranslate">Enum</code> classes with methods</a></li>
<li><a class="reference internal" href="#combining-members-of-flag">Combining members of <code class="docutils literal notranslate">Flag</code></a></li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>

<h4>Previous topic</h4>
 <a href="reprlib.html"
 title="previous chapter"><code class="xref py py-mod docutils literal notranslate">reprlib</code> — Alternate <code class="xref py py-func docutils literal notranslate">repr()</code> implementation</a>
 <h4>Next topic</h4>
 <a href="graphlib.html"
 title="next chapter"><code class="xref py py-mod docutils literal notranslate">graphlib</code> — Functionality to operate with graph-like structures</a>
 <div role="note" aria-label="source link">
 <h3>This Page</h3>
 <ul class="this-page-menu">
 <li><a href="../bugs.html">Report a Bug</a></li>
 <li>
 <a href="https://github.com/python/cpython/blob/3.10/Doc/library/enum.rst"
 rel="nofollow">Show Source
 </a>
 </li>
 </ul>
 </div>
 </div>
 </div>
 <div class="clearer"></div>
 </div> 
 <div class="related" role="navigation" aria-label="related navigation">
 <h3>Navigation</h3>
 <ul>
 <li class="right" style="margin-right: 10px">
 <a href="../genindex.html" title="General Index"
 >index</a></li>
 <li class="right" >
 <a href="../py-modindex.html" title="Python Module Index"
 >modules</a> |</li>
 <li class="right" >
 <a href="graphlib.html" title="graphlib — Functionality to operate with graph-like structures"
 >next</a> |</li>
 <li class="right" >
 <a href="reprlib.html" title="reprlib — Alternate repr() implementation"
 >previous</a> |</li>

<li class="nav-item nav-item-1"><a href="index.html" >The Python Standard Library</a> &#187;</li>
 <li class="nav-item nav-item-2"><a href="datatypes.html" >Data Types</a> &#187;</li>
 <li class="nav-item nav-item-this"><a href=""><code class="xref py py-mod docutils literal notranslate">enum</code> — Support for enumerations</a></li>
 <li class="right">

<div class="inline-search" role="search">
 <form class="inline-search" action="../search.html" method="get">
 <input placeholder="Quick search" aria-label="Quick search" type="text" name="q" />
 <input type="submit" value="Go" />
 <input type="hidden" name="check_keywords" value="yes" />
 <input type="hidden" name="area" value="default" />
 </form>
 </div>
 |
 </li>
 
 </ul>
 </div> 
 <div class="footer">
 &copy; <a href="../copyright.html">Copyright</a> 2001-2026, Python Software Foundation.
 
 This page is licensed under the Python Software Foundation License Version 2.
 
 Examples, recipes, and other code in the documentation are additionally licensed under the Zero Clause BSD License.
 
 See <a href="/license.html">History and License</a> for more information.

The Python Software Foundation is a non-profit corporation.
<a href="https://www.python.org/psf/donations/">Please donate.</a>

Last updated on January 26, 2026.
 <a href="/bugs.html">Found a bug</a>?

Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 4.3.2.
 </div>

</body>
</html>

${this.title}

Code Editor : enum.html