AbjadBookScript

class abjadbooktools.AbjadBookScript

Entry point script for abjad-book.

>>> from abjad.tools import abjadbooktools
>>> script = abjadbooktools.AbjadBookScript()
>>> print(script.formatted_help)
usage: abjad-book [-h] [--version] [-c] [-o OUTPUT_FILE_PATH] [-s] [-v]
                  [-y STYLESHEET] [-a ASSETS_DIRECTORY]
                  [-l LATEX_ROOT_DIRECTORY] [-g CONFIG]
                  input_file_path [input_file_path ...]

Preprocess LaTeX files with Abjad.

positional arguments:
  input_file_path       LaTeX file to process

optional arguments:
  -h, --help            show this help message and exit
  --version             show program's version number and exit
  -c, --clean           remove all output blocks
  -o OUTPUT_FILE_PATH, --output-file-path OUTPUT_FILE_PATH
                        optional output file path
  -s, --skip-rendering  skip all image rendering and simply execute the code
  -v, --verbose         verbose output
  -y STYLESHEET, --stylesheet STYLESHEET
                        optional LilyPond stylesheet
  -a ASSETS_DIRECTORY, --assets-directory ASSETS_DIRECTORY
                        optional assets directory
  -l LATEX_ROOT_DIRECTORY, --latex-root-directory LATEX_ROOT_DIRECTORY
                        optional LaTeX root directory
  -g CONFIG, --config CONFIG
                        path to config file

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=black, fontcolor=white, group=1, label=<<B>AbjadBookScript</B>>, shape=box, style="filled, rounded"]; } subgraph cluster_commandlinetools { graph [label=commandlinetools]; "abjad.tools.commandlinetools.CommandlineScript.CommandlineScript" [color=4, group=3, label=CommandlineScript, shape=oval, style=bold]; } 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__([arguments]) Calls developer script.
__eq__(argument) Is true when ID of argument equals ID of Abjad object.
__format__([format_specification]) Formats Abjad object.
__hash__() Hashes Abjad object.
__ne__(argument) Is true when Abjad object does not equal argument.
__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__(arguments=None)

Calls developer script.

Returns none.

(AbjadObject).__eq__(argument)

Is true when ID of argument 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__(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.