ManageSegmentScript

class commandlinetools.ManageSegmentScript

Manages score package segments.

abjad$ ajv segment --help
usage: manage-segment [-h] [--version]
(--new NAME | --edit [PATTERN [PATTERN ...]] | --illustrate PATTERN [PATTERN ...] | --render PATTERN [PATTERN ...] | --collect | --stage | --list)
[--score-path SCORE] [--force] [-u]

Manage score package segments.

optional arguments:
-h, --help            show this help message and exit
--version             show program's version number and exit

actions:
--new NAME, -N NAME   create a new segment
--edit [PATTERN [PATTERN ...]], -E [PATTERN [PATTERN ...]]
edit segments
--illustrate PATTERN [PATTERN ...], -I PATTERN [PATTERN ...]
illustrate segments
--render PATTERN [PATTERN ...], -R PATTERN [PATTERN ...]
render segment illustrations
--collect, -C         collect segment illustrations
--stage, -T           stage segments for illustration
--list, -L            list segments

common options:
--score-path SCORE, -s SCORE
score path or package name
--force, -f           force overwriting
-u, --unstaged        Include segments not staged in segments/metadata.json

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_commandlinetools { graph [label=commandlinetools]; "abjad.tools.commandlinetools.CommandlineScript.CommandlineScript" [color=3, group=2, label=CommandlineScript, shape=oval, style=bold]; "abjad.tools.commandlinetools.ManageSegmentScript.ManageSegmentScript" [color=black, fontcolor=white, group=2, label=<<B>ManageSegmentScript</B>>, shape=box, style="filled, rounded"]; "abjad.tools.commandlinetools.ScorePackageScript.ScorePackageScript" [color=3, group=2, label=ScorePackageScript, shape=oval, style=bold]; "abjad.tools.commandlinetools.CommandlineScript.CommandlineScript" -> "abjad.tools.commandlinetools.ScorePackageScript.ScorePackageScript"; "abjad.tools.commandlinetools.ScorePackageScript.ScorePackageScript" -> "abjad.tools.commandlinetools.ManageSegmentScript.ManageSegmentScript"; } subgraph cluster_builtins { graph [label=builtins]; "builtins.object" [color=2, group=1, label=object, shape=box]; } "abjad.tools.abctools.AbjadObject.AbjadObject" -> "abjad.tools.commandlinetools.CommandlineScript.CommandlineScript"; "builtins.object" -> "abjad.tools.abctools.AbjadObject.AbstractBase"; }

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

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