Skip to main content

Simple "symbol" type, useful for enumerations or sentinels

Project description

Installing SymbolType (using "easy_install SymbolType" or "setup.py install") gives you access to the peak.util.symbols module, previously available only by installing the full PEAK toolkit. peak.util.symbols provides a Symbol type and two built-in symbols that are used by PEAK: NOT_FOUND and NOT_GIVEN. You can create your own symbol objects using the Symbol type, by giving it the symbol name and the name of the module where the symbol is being created:

>>> from peak.util.symbols import Symbol
>>> AN_EXAMPLE = Symbol('AN_EXAMPLE', __name__)

The resulting object’s repr() and str() forms are the same as the name you passed in:

>>> AN_EXAMPLE
AN_EXAMPLE

>>> str(AN_EXAMPLE)
'AN_EXAMPLE'

But symbols compare equal only to themselves; they are not equal to strings:

>>> AN_EXAMPLE == 'AN_EXAMPLE'
False

>>> AN_EXAMPLE == AN_EXAMPLE
True

A symbol’s __name__ and __module__ attributes are the original name and module used to create the symbol:

>>> from peak.util.symbols import NOT_FOUND

>>> NOT_FOUND.__name__
'NOT_FOUND'

>>> NOT_FOUND.__module__
'peak.util.symbols'

The reason that symbols want to know their defining module is that this allows them to be pickled and unpickled correctly:

>>> import pickle
>>> pickle.loads(pickle.dumps(NOT_FOUND))
NOT_FOUND

Specifically, it’s so that the result of unpickling a symbol is exactly the same object as the original symbol:

>>> pickle.loads(pickle.dumps(NOT_FOUND)) is NOT_FOUND
True

Note that this means the symbol must be defined at module level within its module, with the same name that’s passed in to it, or else pickle will not be able to find it when unpickling.

Last, but not least, symbol objects are immutable and cannot be changed in any way:

>>> AN_EXAMPLE.foo = "bar"
Traceback (most recent call last):
...
TypeError: Symbols are immutable

Mailing List

Please direct questions regarding this package to the PEAK mailing list; see http://www.eby-sarna.com/mailman/listinfo/PEAK/ for details.

Project details


Release history Release notifications | RSS feed

This version

1.0

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for SymbolType, version 1.0
Filename, size File type Python version Upload date Hashes
Filename, size SymbolType-1.0-py2.3.egg (7.8 kB) File type Egg Python version 2.3 Upload date Hashes View
Filename, size SymbolType-1.0-py2.4.egg (4.1 kB) File type Egg Python version 2.4 Upload date Hashes View
Filename, size SymbolType-1.0.zip (9.5 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring DigiCert DigiCert EV certificate Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page