TypedCollection

abstract class datastructuretools.TypedCollection(items=None, item_class=None)

Typed collection.

Abstract base class for typed collections.

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_abctools { graph [label=abctools]; "abjad.tools.abctools.AbjadObject.AbjadObject" [color=1, group=0, label=AbjadObject, shape=box]; "abjad.tools.abctools.AbjadObject.AbstractBase" [color=1, group=0, label=AbstractBase, shape=box]; "abjad.tools.abctools.AbjadObject.AbstractBase" -> "abjad.tools.abctools.AbjadObject.AbjadObject"; } subgraph cluster_datastructuretools { graph [label=datastructuretools]; "abjad.tools.datastructuretools.TypedCollection.TypedCollection" [color=black, fontcolor=white, group=2, label=<<B>TypedCollection</B>>, shape=oval, style="filled, rounded"]; } subgraph cluster_builtins { graph [label=builtins]; "builtins.object" [color=2, group=1, label=object, shape=box]; } "abjad.tools.abctools.AbjadObject.AbjadObject" -> "abjad.tools.datastructuretools.TypedCollection.TypedCollection"; "builtins.object" -> "abjad.tools.abctools.AbjadObject.AbstractBase"; }

Bases

Attribute summary

item_class Gets item class of collection.
items Gets items in collection.
__contains__(item) Is true when typed collection contains item.
__eq__(argument) Is true when argument is a typed collection with items that compare equal to those of this typed collection.
__format__([format_specification]) Formats Abjad object.
__hash__() Hashes typed collection.
__iter__() Iterates typed collection.
__len__() Gets length of typed collection.
__ne__(argument) Is true when argument is not a typed collection with items equal to this typed collection.
__repr__() Gets interpreter representation of Abjad object.

Read-only properties

TypedCollection.item_class

Gets item class of collection.

Collection coerces items according to item_class.

Returns class.

TypedCollection.items

Gets items in collection.

Returns list.

Special methods

TypedCollection.__contains__(item)

Is true when typed collection contains item. Otherwise false.

Returns true or false.

TypedCollection.__eq__(argument)

Is true when argument is a typed collection with items that compare equal to those of this typed collection. Otherwise false.

Returns true or false.

(AbjadObject).__format__(format_specification='')

Formats Abjad object.

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

Returns string.

TypedCollection.__hash__()

Hashes typed collection.

Required to be explicitly redefined on Python 3 if __eq__ changes.

Returns integer.

TypedCollection.__iter__()

Iterates typed collection.

Returns generator.

TypedCollection.__len__()

Gets length of typed collection.

Returns nonnegative integer.

TypedCollection.__ne__(argument)

Is true when argument is not a typed collection with items equal to this typed collection. Otherwise false.

Returns true or false.

(AbjadObject).__repr__()

Gets interpreter representation of Abjad object.

Returns string.