From: Georg Brandl <georg@python.org>
Date: Fri, 28 Mar 2008 12:58:26 +0000 (+0000)
Subject: #2502: add example how to do enum types with named tuples.
X-Git-Tag: v2.6a2~54
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=d289ea6df96e9e24e17914070fd5c2594e44413e;p=python

#2502: add example how to do enum types with named tuples.
---

diff --git a/Doc/library/collections.rst b/Doc/library/collections.rst
index f07ac2535b..361da71430 100644
--- a/Doc/library/collections.rst
+++ b/Doc/library/collections.rst
@@ -567,6 +567,16 @@ by the :mod:`csv` or :mod:`sqlite3` modules::
    for emp in map(EmployeeRecord._make, cursor.fetchall()):
        print emp.name, emp.title
 
+Named tuples can also be used to generate enumerated constants:
+
+.. testcode::
+
+   def enum(*names):
+       return namedtuple('Enum', ' '.join(names))(*range(len(names)))
+   
+   Status = enum('open', 'pending', 'closed')
+   assert (0, 1, 2) == (Status.open, Status.pending, Status.closed)
+
 In addition to the methods inherited from tuples, named tuples support
 three additional methods and one attribute.  To prevent conflicts with
 field names, the method and attribute names start with an underscore.