NodeIdAllocator

class supriya.tools.servertools.NodeIdAllocator(user_id=0, initial_node_id=1000)[source]

A node ID allocator.

>>> from supriya.tools import servertools
>>> allocator = servertools.NodeIdAllocator()
>>> for _ in range(3):
...     allocator.allocate_node_id()
...
1000
1001
1002
>>> for _ in range(3):
...     allocator.allocate_permanent_node_id()
...
1
2
3
>>> allocator.free_permanent_node_id(2)
>>> allocator.allocate_permanent_node_id()
2

Lineage

digraph InheritanceGraph { graph [background=transparent, bgcolor=transparent, color=lightslategrey, fontname=Arial, outputorder=edgesfirst, overlap=prism, penwidth=2, rankdir=LR, root="__builtin__.object", splines=spline, style="dotted, rounded", truecolor=true]; node [colorscheme=pastel19, fontname=Arial, fontsize=12, penwidth=2, style="filled, rounded"]; edge [color=lightsteelblue2, penwidth=2]; subgraph cluster_builtins { graph [label=builtins]; "builtins.object" [color=1, group=0, label=object, shape=box]; } subgraph cluster_servertools { graph [label=servertools]; "supriya.tools.servertools.NodeIdAllocator.NodeIdAllocator" [color=black, fontcolor=white, group=1, label=<<B>NodeIdAllocator</B>>, shape=box, style="filled, rounded"]; } subgraph cluster_systemtools { graph [label=systemtools]; "supriya.tools.systemtools.SupriyaObject.AbstractBase" [color=3, group=2, label=AbstractBase, shape=box]; "supriya.tools.systemtools.SupriyaObject.SupriyaObject" [color=3, group=2, label=SupriyaObject, shape=box]; "supriya.tools.systemtools.SupriyaObject.AbstractBase" -> "supriya.tools.systemtools.SupriyaObject.SupriyaObject"; } "builtins.object" -> "supriya.tools.systemtools.SupriyaObject.AbstractBase"; "supriya.tools.systemtools.SupriyaObject.SupriyaObject" -> "supriya.tools.servertools.NodeIdAllocator.NodeIdAllocator"; }

Bases

Attribute summary

allocate_node_id()
allocate_permanent_node_id()
free_permanent_node_id(node_id)
__eq__(expr) Is true when ID of expr equals ID of Supriya object.
__format__([format_specification]) Formats Supriya object.
__hash__() Hashes Supriya object.
__repr__() Gets interpreter representation of Supriya object.

Methods

NodeIdAllocator.allocate_node_id()[source]
NodeIdAllocator.allocate_permanent_node_id()[source]
NodeIdAllocator.free_permanent_node_id(node_id)[source]

Special methods

(SupriyaObject).__eq__(expr)

Is true when ID of expr equals ID of Supriya object. Otherwise false.

Returns boolean.

(SupriyaObject).__format__(format_specification='')

Formats Supriya object.

Set format_specification to ‘’ or ‘storage’. Interprets ‘’ equal to ‘storage’.

Returns string.

(SupriyaObject).__hash__()

Hashes Supriya object.

Required to be explicitely re-defined on Python 3 if __eq__ changes.

Returns integer.

(SupriyaObject).__repr__()

Gets interpreter representation of Supriya object.

Returns string.