Reserved IDs

The mousetrap library sets aside some identifiers to signify certain things internally. These ids are defined in a dict in pymousetrap called reserved_ids.

The module function get_next_id starts its id numbering system after the last reserved identifier(RESERVED_LAST). If you wish to use your own identifier generation scheme, identifiers less than or equal to pymousetrap.reserved_ids['RESERVED_LAST'] will cause undesirable results.

pymousetrap.reserved_ids['TRANSPARENCY'] Used to denote transparency information in a mousetrap.
pymousetrap.reserved_ids['PLACEHOLDER'] Used for arbitrary things. Mostly internal, but also a failure value from the instance method lookup_id.
pymousetrap.reserved_ids['RESERVED_LAST'] Included to make client code work easily when/if more reserved IDs are added to the system.

Copyright © 2001 Ben Smith