StorageFormatSpecification

class systemtools.StorageFormatSpecification(instance=None, repr_text=None, include_abjad_namespace=None, is_bracketed=False, is_indented=True, keyword_argument_names=None, positional_argument_values=None, storage_format_text=None)

Specifies the storage format of a given object.

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_systemtools { graph [label=systemtools]; "abjad.tools.systemtools.StorageFormatSpecification.StorageFormatSpecification" [color=black, fontcolor=white, group=2, label=<<B>StorageFormatSpecification</B>>, shape=box, 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.systemtools.StorageFormatSpecification.StorageFormatSpecification"; "builtins.object" -> "abjad.tools.abctools.AbjadObject.AbstractBase"; }

Bases

Attribute summary

include_abjad_namespace Is true when storage specification includes Abjad namespace.
instance Instance of storage specification.
is_bracketed Is true when storage specification is bracketed.
is_indented Is true when storage format is indented.
keyword_argument_names Keyword argument names of storage format.
positional_argument_values Positional argument values.
repr_text Body text of storage specification.
storage_format_text Storage format pieces.
__eq__(expr) Is true when ID of expr equals ID of Abjad object.
__format__([format_specification]) Formats Abjad object.
__hash__() Hashes Abjad object.
__ne__(expr) Is true when Abjad object does not equal expr.
__repr__() Gets interpreter representation of Abjad object.

Read-only properties

StorageFormatSpecification.include_abjad_namespace

Is true when storage specification includes Abjad namespace.

Returns true or false.

StorageFormatSpecification.instance

Instance of storage specification.

Returns string.

StorageFormatSpecification.is_bracketed

Is true when storage specification is bracketed. Otherwise false.

Returns true or false.

StorageFormatSpecification.is_indented

Is true when storage format is indented. Otherwise false.

Returns true or false.

StorageFormatSpecification.keyword_argument_names

Keyword argument names of storage format.

Returns tuple.

StorageFormatSpecification.positional_argument_values

Positional argument values.

Returns tuple.

StorageFormatSpecification.repr_text

Body text of storage specification.

Returns string.

StorageFormatSpecification.storage_format_text

Storage format pieces.

Returns tuple.

Special methods

(AbjadObject).__eq__(expr)

Is true when ID of expr equals ID of Abjad object. 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.

(AbjadObject).__hash__()

Hashes Abjad object.

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

Returns integer.

(AbjadObject).__ne__(expr)

Is true when Abjad object does not equal expr. Otherwise false.

Returns true or false.

(AbjadObject).__repr__()

Gets interpreter representation of Abjad object.

Returns string.