Reference

Interfaces

Interfaces for the unique id utility.

exception zope.intid.interfaces.IntIdMissingError[source]

Bases: KeyError

Raised when getId cannot find an intid.

exception zope.intid.interfaces.ObjectMissingError[source]

Bases: KeyError

Raised when getObject cannot find an object.

exception zope.intid.interfaces.IntIdsCorruptedError[source]

Bases: KeyError

Raised when internal corruption is detected in the utility.

Users should not need to catch this because this situation should not happen.

interface zope.intid.interfaces.IIntIdsQuery[source]

Query for IDs and objects

getObject(uid)

Return an object by its unique id

getId(ob)

Get a unique id of an object.

queryObject(uid, default=None)

Return an object by its unique id

Return the default if the uid isn’t registered

queryId(ob, default=None)

Get a unique id of an object.

Return the default if the object isn’t registered

__iter__()

Return an iteration on the ids

interface zope.intid.interfaces.IIntIdsSet[source]

Register and unregister objects.

register(ob)

Register an object and returns a unique id generated for it.

The object must be adaptable to IKeyReference.

If the object is already registered, its id is returned anyway.

unregister(ob)

Remove the object from the indexes.

IntIdMissingError is raised if ob is not registered previously.

interface zope.intid.interfaces.IIntIdsManage[source]

Some methods used by the view.

__len__()

Return the number of objects indexed.

items()

Return a list of (id, object) pairs.

interface zope.intid.interfaces.IIntIds[source]

Extends: zope.intid.interfaces.IIntIdsSet, zope.intid.interfaces.IIntIdsQuery, zope.intid.interfaces.IIntIdsManage

A utility that assigns unique ids to objects.

Allows to query object by id and id by object.

interface zope.intid.interfaces.IIntIdEvent[source]

Generic base interface for IntId-related events

object

The object related to this event

original_event

The ObjectEvent related to this event

interface zope.intid.interfaces.IIntIdRemovedEvent[source]

Extends: zope.intid.interfaces.IIntIdEvent

A unique id will be removed

The event is published before the unique id is removed from the utility so that the indexing objects can unindex the object.

class zope.intid.interfaces.IntIdRemovedEvent(object, event)[source]

Bases: object

The event which is published before the unique id is removed from the utility so that the catalogs can unindex the object.

interface zope.intid.interfaces.IIntIdAddedEvent[source]

Extends: zope.intid.interfaces.IIntIdEvent

A unique id has been added

The event gets sent when an object is registered in a unique id utility.

idmap

The dictionary that holds an (utility -> id) mapping of created ids

class zope.intid.interfaces.IntIdAddedEvent(object, event, idmap=None)[source]

Bases: object

The event which gets sent when an object is registered in a unique id utility.

Implementation

Unique id utility.

This utility assigns unique integer ids to objects and allows lookups by object and by id.

This functionality can be used in cataloging.

class zope.intid.IntIds(family=None)[source]

Bases: persistent.Persistent

This utility provides a two way mapping between objects and integer ids.

IKeyReferences to objects are stored in the indexes.

zope.intid.removeIntIdSubscriber(ob, event)[source]

A subscriber to ObjectRemovedEvent

Removes the unique ids registered for the object in all the unique id utilities.

zope.intid.addIntIdSubscriber(ob, event)[source]

A subscriber to ObjectAddedEvent

Registers the object added in all unique id utilities and fires an event for the catalogs.

zope.intid.intIdEventNotify(event)[source]

Event subscriber to dispatch IntIdEvent to interested adapters.