CommandlineScript

abstract class commandlinetools.CommandlineScript

Object-oriented model of a developer script.

CommandlineScript is the abstract parent from which concrete developer scripts inherit.

Developer scripts can be called from the command line, generally via the ajv command.

Developer scripts can be instantiated by other developer scripts in order to share functionality.

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_abjadbooktools { graph [label=abjadbooktools]; "abjad.tools.abjadbooktools.AbjadBookScript.AbjadBookScript" [color=2, group=1, label=AbjadBookScript, shape=box]; } subgraph cluster_commandlinetools { graph [label=commandlinetools]; "abjad.tools.commandlinetools.AbjDevScript.AbjDevScript" [color=4, group=3, label=AbjDevScript, shape=box]; "abjad.tools.commandlinetools.BuildApiScript.BuildApiScript" [color=4, group=3, label=BuildApiScript, shape=box]; "abjad.tools.commandlinetools.CheckClassSections.CheckClassSections" [color=4, group=3, label=CheckClassSections, shape=box]; "abjad.tools.commandlinetools.CleanScript.CleanScript" [color=4, group=3, label=CleanScript, shape=box]; "abjad.tools.commandlinetools.CommandlineScript.CommandlineScript" [color=black, fontcolor=white, group=3, label=<<B>CommandlineScript</B>>, shape=oval, style="filled, rounded"]; "abjad.tools.commandlinetools.DoctestScript.DoctestScript" [color=4, group=3, label=DoctestScript, shape=box]; "abjad.tools.commandlinetools.ManageBuildTargetScript.ManageBuildTargetScript" [color=4, group=3, label=ManageBuildTargetScript, shape=box]; "abjad.tools.commandlinetools.ManageMaterialScript.ManageMaterialScript" [color=4, group=3, label=ManageMaterialScript, shape=box]; "abjad.tools.commandlinetools.ManageScoreScript.ManageScoreScript" [color=4, group=3, label=ManageScoreScript, shape=box]; "abjad.tools.commandlinetools.ManageSegmentScript.ManageSegmentScript" [color=4, group=3, label=ManageSegmentScript, shape=box]; "abjad.tools.commandlinetools.ReplaceScript.ReplaceScript" [color=4, group=3, label=ReplaceScript, shape=box]; "abjad.tools.commandlinetools.ScorePackageScript.ScorePackageScript" [color=4, group=3, label=ScorePackageScript, shape=oval, style=bold]; "abjad.tools.commandlinetools.StatsScript.StatsScript" [color=4, group=3, label=StatsScript, shape=box]; "abjad.tools.commandlinetools.CommandlineScript.CommandlineScript" -> "abjad.tools.commandlinetools.AbjDevScript.AbjDevScript"; "abjad.tools.commandlinetools.CommandlineScript.CommandlineScript" -> "abjad.tools.commandlinetools.BuildApiScript.BuildApiScript"; "abjad.tools.commandlinetools.CommandlineScript.CommandlineScript" -> "abjad.tools.commandlinetools.CheckClassSections.CheckClassSections"; "abjad.tools.commandlinetools.CommandlineScript.CommandlineScript" -> "abjad.tools.commandlinetools.CleanScript.CleanScript"; "abjad.tools.commandlinetools.CommandlineScript.CommandlineScript" -> "abjad.tools.commandlinetools.DoctestScript.DoctestScript"; "abjad.tools.commandlinetools.CommandlineScript.CommandlineScript" -> "abjad.tools.commandlinetools.ReplaceScript.ReplaceScript"; "abjad.tools.commandlinetools.CommandlineScript.CommandlineScript" -> "abjad.tools.commandlinetools.ScorePackageScript.ScorePackageScript"; "abjad.tools.commandlinetools.CommandlineScript.CommandlineScript" -> "abjad.tools.commandlinetools.StatsScript.StatsScript"; "abjad.tools.commandlinetools.ScorePackageScript.ScorePackageScript" -> "abjad.tools.commandlinetools.ManageBuildTargetScript.ManageBuildTargetScript"; "abjad.tools.commandlinetools.ScorePackageScript.ScorePackageScript" -> "abjad.tools.commandlinetools.ManageMaterialScript.ManageMaterialScript"; "abjad.tools.commandlinetools.ScorePackageScript.ScorePackageScript" -> "abjad.tools.commandlinetools.ManageScoreScript.ManageScoreScript"; "abjad.tools.commandlinetools.ScorePackageScript.ScorePackageScript" -> "abjad.tools.commandlinetools.ManageSegmentScript.ManageSegmentScript"; } subgraph cluster_builtins { graph [label=builtins]; "builtins.object" [color=3, group=2, label=object, shape=box]; } "abjad.tools.abctools.AbjadObject.AbjadObject" -> "abjad.tools.commandlinetools.CommandlineScript.CommandlineScript"; "abjad.tools.commandlinetools.CommandlineScript.CommandlineScript" -> "abjad.tools.abjadbooktools.AbjadBookScript.AbjadBookScript"; "builtins.object" -> "abjad.tools.abctools.AbjadObject.AbstractBase"; }

Bases

Attribute summary

argument_parser The script’s instance of argparse.ArgumentParser.
formatted_help Formatted help of developer script.
formatted_usage Formatted usage of developer script.
formatted_version Formatted version of developer script.
list_commandline_script_classes() Returns a list of all developer script classes.
program_name The name of the script, callable from the command line.
__call__([args]) Calls developer script.
__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

CommandlineScript.argument_parser

The script’s instance of argparse.ArgumentParser.

CommandlineScript.formatted_help

Formatted help of developer script.

CommandlineScript.formatted_usage

Formatted usage of developer script.

CommandlineScript.formatted_version

Formatted version of developer script.

CommandlineScript.program_name

The name of the script, callable from the command line.

Class & static methods

static CommandlineScript.list_commandline_script_classes()

Returns a list of all developer script classes.

Special methods

CommandlineScript.__call__(args=None)

Calls developer script.

Returns none.

(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.