util.persistence package

Persistence: databases of objects that are saved to and read from files (or URLs), and refer to one another – across files – by reference:

• util.persistence.pRef: the databases (PRDb), their objects (PRObject) and references to them (PReference).

• util.persistence.serialize: how objects describe themselves for saving (InstantiationInfo), and the SerializationStrategy that writes and reads them – in XML (serializeXML, and the more compact serializeXML2), JSON (serializeJSON) or property lists (serializePlist).

Submodules

• util.persistence.pRef module
  • DuplicateNameError
  • MalformedIDError
  • CircularReferenceError
  • PRObject
    • PRObject.__init__()
    • PRObject._db
    • PRObject._id
    • PRObject.getInstantiationInfo()
    • PRObject.id
    • PRObject.db
    • PRObject.name
    • PRObject.getPRef()
    • PRObject.torepr()
    • PRObject.__str__()
    • PRObject.tostring()
    • PRObject._dbUrl()
  • PRContainer
    • PRContainer.getMembers()
  • PRDbContainer
    • PRDbContainer.getMembers()
    • PRDbContainer.name
  • PRDb
    • PRDb.AllDBs
    • PRDb.aliases
    • PRDb.namedURLs
    • PRDb._namesOf
    • PRDb.readProgress
    • PRDb.READ_PROGRESS_STEP
    • PRDb._readingURLs
    • PRDb._initCache()
    • PRDb.getDB()
    • PRDb._read()
    • PRDb.readFile()
    • PRDb._wasRead()
    • PRDb._bases
    • PRDb.basedOn()
    • PRDb.isRelativeURL()
    • PRDb.absoluteURL()
    • PRDb.MAX_UP
    • PRDb.relativeURL()
    • PRDb._readFrames
    • PRDb._relocated
    • PRDb.FILE_SCHEMES
    • PRDb.resolveURL()
    • PRDb._alias()
    • PRDb._relocate()
    • PRDb.serializationHeader()
    • PRDb.objectCount()
    • PRDb.__init__()
    • PRDb.reading
    • PRDb.superDBs
    • PRDb._missingSuperDBs
    • PRDb.url
    • PRDb._db
    • PRDb.nextID
    • PRDb.previousURL
    • PRDb.getInstantiationInfo()
    • PRDb.allSuperDBs()
    • PRDb.addSuperDB()
    • PRDb.removeSuperDB()
    • PRDb.name
    • PRDb.save()
    • PRDb.writeLocked()
    • PRDb._register()
    • PRDb._unregister()
    • PRDb.setDirty()
    • PRDb.isDirty()
    • PRDb.findByName()
    • PRDb._resolve()
    • PRDb.__getitem__()
    • PRDb._makeDBContainer()
    • PRDb.getall()
    • PRDb.get()
    • PRDb.keys()
    • PRDb.values()
    • PRDb.items()
    • PRDb.torepr()
    • PRDb.__str__()
    • PRDb.tostring()
  • PReference
    • PReference.__init__()
    • PReference.url
    • PReference.name
    • PReference.id
    • PReference.obj
    • PReference.__call__()
    • PReference.tostring()
    • PReference.__str__()
    • PReference.torepr()
    • PReference.formatForURL()
    • PReference.eval()
    • PReference._isValidID_old()
    • PReference._isValidID()
  • db
  • a
  • b
  • c
• util.persistence.serialize module
  • VERSION
  • HEAD
  • BODY
  • OLD_HEADER
  • OLD_ROOT
  • HEAD_FORMAT
  • HEAD_FORMAT_VERSION
  • HEAD_SERIALIZATION_VERSION
  • HEAD_APPLICATION
  • HEAD_APPLICATION_VERSION
  • HEAD_TYPE
  • HEAD_SAVED
  • HeadValue
  • isHeadValue()
  • Serializable
    • Serializable.getInstantiationInfo()
  • strdict
    • strdict.__init__()
    • strdict.__setitem__()
  • InstantiationInfo
    • InstantiationInfo.class_
    • InstantiationInfo.conArgs
    • InstantiationInfo.conKWArgs
    • InstantiationInfo.postconSetters
    • InstantiationInfo.finalSetters
    • InstantiationInfo.className
    • InstantiationInfo.__init__()
  • getInstantiationInfo()
  • ParamInfo
    • ParamInfo.__init__()
    • ParamInfo.name
    • ParamInfo.typ
    • ParamInfo.getter
    • ParamInfo.setter
    • ParamInfo.unique
    • ParamInfo.optional
    • ParamInfo.inHead
  • PropertyInfo
    • PropertyInfo.__init__()
    • PropertyInfo.name
    • PropertyInfo.typ
    • PropertyInfo.getter
    • PropertyInfo.setter
    • PropertyInfo.unique
    • PropertyInfo.optional
    • PropertyInfo.omitIfNone
    • PropertyInfo.inHead
  • DEFAULT_STRATEGY
  • SerializationStrategy
    • SerializationStrategy.Strategy
      • SerializationStrategy.Strategy.name
      • SerializationStrategy.Strategy.extension
      • SerializationStrategy.Strategy.cls
      • SerializationStrategy.Strategy._asdict()
      • SerializationStrategy.Strategy._field_defaults
      • SerializationStrategy.Strategy._fields
      • SerializationStrategy.Strategy._make()
      • SerializationStrategy.Strategy._replace()
    • SerializationStrategy._MemStrategy
      • SerializationStrategy._MemStrategy.name
      • SerializationStrategy._MemStrategy.extension
      • SerializationStrategy._MemStrategy.cls
      • SerializationStrategy._MemStrategy.obj
      • SerializationStrategy._MemStrategy.__init__()
    • SerializationStrategy.knownStrategies
    • SerializationStrategy.__init__()
    • SerializationStrategy._finalMethodsList
    • SerializationStrategy.header
    • SerializationStrategy.getAvailableStrategies()
    • SerializationStrategy.preferred
    • SerializationStrategy.appName
    • SerializationStrategy.appVersion
    • SerializationStrategy.serializationStrategyVersion
    • SerializationStrategy.version
    • SerializationStrategy._byPreference()
    • SerializationStrategy.findStrategy()
    • SerializationStrategy.tostringx()
    • SerializationStrategy.fromstringx()
    • SerializationStrategy.writex()
    • SerializationStrategy.readx()
    • SerializationStrategy._tryInOrder()
    • SerializationStrategy._start()
    • SerializationStrategy.peekTypex()
    • SerializationStrategy.defaultExtension()
    • SerializationStrategy.protocolName()
    • SerializationStrategy.protocolVersion()
    • SerializationStrategy.write()
    • SerializationStrategy.read()
    • SerializationStrategy._fetchContents()
    • SerializationStrategy.peekType()
    • SerializationStrategy.peekString()
    • SerializationStrategy.peekStringx()
    • SerializationStrategy.tostring()
    • SerializationStrategy.makeHead()
    • SerializationStrategy._tostringDocument()
    • SerializationStrategy._fromstringDocument()
    • SerializationStrategy._documentParts()
    • SerializationStrategy.fromstring()
    • SerializationStrategy.readHead()
    • SerializationStrategy.readHeadx()
    • SerializationStrategy._abc_impl
    • SerializationStrategy.SNIFF_SIZE
    • SerializationStrategy.sniff()
    • SerializationStrategy._tostring()
    • SerializationStrategy._fromstring()
    • SerializationStrategy._encodeStr()
    • SerializationStrategy._decodeStr()
    • SerializationStrategy._encodeList()
    • SerializationStrategy._decodeList()
    • SerializationStrategy._setAttr()
    • SerializationStrategy._getAttr()
    • SerializationStrategy._appendItem()
    • SerializationStrategy._getItems()
    • SerializationStrategy._setKVPair()
    • SerializationStrategy._getKVPairs()
    • SerializationStrategy._getKVPair()
    • SerializationStrategy._encodeInt()
    • SerializationStrategy._decodeInt()
    • SerializationStrategy._encodeNone()
    • SerializationStrategy._decodeNone()
    • SerializationStrategy._encodeFloat()
    • SerializationStrategy._decodeFloat()
    • SerializationStrategy._encodeBool()
    • SerializationStrategy._decodeBool()
    • SerializationStrategy._encodeTuple()
    • SerializationStrategy._decodeTuple()
    • SerializationStrategy._encodeSet()
    • SerializationStrategy._decodeSet()
    • SerializationStrategy._encodeDict()
    • SerializationStrategy._decodeDict()
    • SerializationStrategy._encodeStrdict()
    • SerializationStrategy._decodeStrdict()
    • SerializationStrategy._encodeSerializable()
    • SerializationStrategy._decodeSerializable()
    • SerializationStrategy._encode_()
    • SerializationStrategy._decode_()
  • _Reference
    • _Reference.__init__()
    • _Reference.referenceID
    • _Reference.getInstantiationInfo()
• util.persistence.serializeJSON module
  • JSONSerializationStrategy
    • JSONSerializationStrategy.defaultExtension()
    • JSONSerializationStrategy.sniff()
    • JSONSerializationStrategy.protocolName()
    • JSONSerializationStrategy.protocolVersion()
    • JSONSerializationStrategy._tostring()
    • JSONSerializationStrategy._fromstring()
    • JSONSerializationStrategy._encodeStr()
    • JSONSerializationStrategy._decodeStr()
    • JSONSerializationStrategy._encodeInt()
    • JSONSerializationStrategy._decodeInt()
    • JSONSerializationStrategy._encodeFloat()
    • JSONSerializationStrategy._decodeFloat()
    • JSONSerializationStrategy._encodeBool()
    • JSONSerializationStrategy._decodeBool()
    • JSONSerializationStrategy._encodeList()
    • JSONSerializationStrategy._decodeList()
    • JSONSerializationStrategy._encodeStrdict()
    • JSONSerializationStrategy._decodeStrdict()
    • JSONSerializationStrategy._setAttr()
    • JSONSerializationStrategy._getAttr()
    • JSONSerializationStrategy._setKVPair()
    • JSONSerializationStrategy._getKVPairs()
    • JSONSerializationStrategy._appendItem()
    • JSONSerializationStrategy._getItems()
    • JSONSerializationStrategy._abc_impl
• util.persistence.serializePlist module
  • PlistSerializationStrategy
    • PlistSerializationStrategy.defaultExtension()
    • PlistSerializationStrategy.sniff()
    • PlistSerializationStrategy.protocolName()
    • PlistSerializationStrategy.protocolVersion()
    • PlistSerializationStrategy._tostring()
    • PlistSerializationStrategy._fromstring()
    • PlistSerializationStrategy._abc_impl
• util.persistence.serializeXML module
  • XMLSerializationStrategy
    • XMLSerializationStrategy.SerializableTypesInAttrs
    • XMLSerializationStrategy.SerializableTypesInSubs
    • XMLSerializationStrategy.protocolName()
    • XMLSerializationStrategy.protocolVersion()
    • XMLSerializationStrategy.defaultExtension()
    • XMLSerializationStrategy._encodeStr()
    • XMLSerializationStrategy._decodeStr()
    • XMLSerializationStrategy._encodeList()
    • XMLSerializationStrategy._decodeList()
    • XMLSerializationStrategy._setAttr()
    • XMLSerializationStrategy._getAttr()
    • XMLSerializationStrategy._appendItem()
    • XMLSerializationStrategy._getItems()
    • XMLSerializationStrategy._setKVPair()
    • XMLSerializationStrategy._getKVPair()
    • XMLSerializationStrategy._getKVPairs()
    • XMLSerializationStrategy._tostring()
    • XMLSerializationStrategy._fromstring()
    • XMLSerializationStrategy._abc_impl
• util.persistence.serializeXML2 module
  • XML2SerializationStrategy
    • XML2SerializationStrategy.preferred
    • XML2SerializationStrategy.PACKED_TYPES
    • XML2SerializationStrategy.MAX_PACKED_STR
    • XML2SerializationStrategy.ATTR_REF
    • XML2SerializationStrategy.REF_ID
    • XML2SerializationStrategy.protocolName()
    • XML2SerializationStrategy.protocolVersion()
    • XML2SerializationStrategy._refID()
    • XML2SerializationStrategy._abc_impl
    • XML2SerializationStrategy._packable()
    • XML2SerializationStrategy._unpacked()
    • XML2SerializationStrategy._setKVPair()
    • XML2SerializationStrategy._getKVPair()
    • XML2SerializationStrategy._getKVPairs()
• util.persistence.serializeXML3 module
  • TAG_DOCUMENT
  • TAG_HEAD
  • TAG_ITEM
  • XML3SerializationStrategy
    • XML3SerializationStrategy.preferred
    • XML3SerializationStrategy.protocolName()
    • XML3SerializationStrategy.protocolVersion()
    • XML3SerializationStrategy.sniff()
    • XML3SerializationStrategy._headValue()
    • XML3SerializationStrategy._fromHeadValue()
    • XML3SerializationStrategy._abc_impl
    • XML3SerializationStrategy._head()
    • XML3SerializationStrategy._tostringDocument()
    • XML3SerializationStrategy._documentParts()
    • XML3SerializationStrategy.readHead()