StorageFormatAgent

class systemtools.StorageFormatAgent(client=None)

Manages Abjad object storage formats.

>>> import abjad
>>> from abjad.tools import rhythmmakertools

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

Bases

Attribute summary

client
format_specification
get_class_name_prefix(as_storage_format[, …])
get_hash_values()
get_import_statements() Gets import statements.
get_repr_format()
get_repr_keyword_dict()
get_repr_positional_values()
get_root_package_name()
get_storage_format()
get_storage_format_keyword_dict()
get_storage_format_positional_values()
get_template_dict()
get_tools_package_name()
inspect_signature(subject)
signature_accepts_args
signature_accepts_kwargs
signature_keyword_names
signature_names
signature_positional_names
__copy__(*arguments) Copies Abjad value object.
__eq__(argument) Is true when all initialization values of Abjad value object equal the initialization values of argument.
__format__([format_specification]) Formats Abjad object.
__hash__() Hashes Abjad value object.
__ne__(argument) Is true when Abjad object does not equal argument.
__repr__() Gets interpreter representation of Abjad object.

Read-only properties

StorageFormatAgent.client
StorageFormatAgent.format_specification
StorageFormatAgent.signature_accepts_args
StorageFormatAgent.signature_accepts_kwargs
StorageFormatAgent.signature_keyword_names
StorageFormatAgent.signature_names
StorageFormatAgent.signature_positional_names

Methods

StorageFormatAgent.get_class_name_prefix(as_storage_format, include_root_package=None)
StorageFormatAgent.get_hash_values()
StorageFormatAgent.get_import_statements()

Gets import statements.

>>> rhythm_maker = rhythmmakertools.TupletRhythmMaker(
...     tuplet_ratios=[(3, 2)],
...     division_masks=[
...         abjad.silence_every([1], period=2),
...         ],
...     )
>>> f(rhythm_maker)
rhythmmakertools.TupletRhythmMaker(
    tuplet_ratios=[
        abjad.Ratio((3, 2)),
        ],
    division_masks=abjad.PatternList(
        (
            rhythmmakertools.SilenceMask(
                pattern=abjad.Pattern(
                    indices=[1],
                    period=2,
                    ),
                ),
            )
        ),
    )
>>> agent = abjad.StorageFormatAgent(rhythm_maker)
>>> for line in agent.get_import_statements():
...     line
...
'from abjad.tools import datastructuretools'
'from abjad.tools import mathtools'
'from abjad.tools import rhythmmakertools'

Returns tuple of strings.

StorageFormatAgent.get_repr_format()
StorageFormatAgent.get_repr_keyword_dict()
StorageFormatAgent.get_repr_positional_values()
StorageFormatAgent.get_root_package_name()
StorageFormatAgent.get_storage_format()
StorageFormatAgent.get_storage_format_keyword_dict()
StorageFormatAgent.get_storage_format_positional_values()
StorageFormatAgent.get_template_dict()
StorageFormatAgent.get_tools_package_name()

Class & static methods

classmethod StorageFormatAgent.inspect_signature(subject)

Special methods

(AbjadValueObject).__copy__(*arguments)

Copies Abjad value object.

Returns new Abjad value object.

(AbjadValueObject).__eq__(argument)

Is true when all initialization values of Abjad value object equal the initialization values of argument.

Returns true or false.

(AbjadObject).__format__(format_specification='')

Formats Abjad object.

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

Returns string.

(AbjadValueObject).__hash__()

Hashes Abjad value object.

Returns integer.

(AbjadObject).__ne__(argument)

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

Returns true or false.

(AbjadObject).__repr__()

Gets interpreter representation of Abjad object.

Returns string.