Class IdManagerMixin

source code

object --+
         |
        IdManagerMixin

Known Subclasses:

• base.valuemappers.SerManager
• , web.metarender.ServiceInfoRenderer
• , formats.votablewrite.VOTableContext

A mixin for objects requiring unique IDs.

The primaray use case is XML generation, where you want stable IDs for objects, but IDs must be unique over an entire XML file.

The IdManagerMixin provides some methods for doing that:

• makeIdFor(object) -- returns an id for object, or None if makeIdFor has already been called for that object (i.e., it presumably already is in the document).
• getIdFor(object) -- returns an id for object if makeIdFor has already been called before. Otherwise, a NotFoundError is raised
• getOrMakeIdFor(object) -- returns an id for object; if object has been seen before, it's the same id as before. Identity is by equality for purposes of dictionaries.
• getForId(id) -- returns the object belonging to an id that has been handed out before. Raises a NotFoundError for unknown ids.
• cloneFrom(other) -- overwrites the self's id management dictionaries with those from other. You want this if two id managers must work on the same document.