Job

digraph InheritanceGraph { graph [bgcolor=transparent, color=lightsteelblue2, fontname=Arial, fontsize=10, outputorder=edgesfirst, overlap=prism, penwidth=2, rankdir=LR, splines=spline, style="dashed, rounded", truecolor=true]; node [colorscheme=pastel19, fontname=Arial, fontsize=10, height=0, penwidth=2, shape=box, style="filled, rounded", width=0]; edge [color=lightslategrey, penwidth=1]; subgraph "cluster_abjad.segments" { graph [label="abjad.segments"]; node [color=1]; "abjad.segments.Job.Job" [URL="../api/abjad/segments/Job.html#abjad.segments.Job.Job", color=black, fontcolor=white, label=Job, target=_top]; } subgraph "cluster_abjad.system" { graph [label="abjad.system"]; node [color=2]; "abjad.system.AbjadObject.AbjadObject" [URL="../api/abjad/segments/../system/AbjadObject.html#abjad.system.AbjadObject.AbjadObject", label="Abjad\nObject", target=_top]; } subgraph cluster_builtins { graph [label=builtins]; node [color=3]; "builtins.object" [URL="https://docs.python.org/3.6/library/functions.html#object", label=object, target=_top]; } "abjad.system.AbjadObject.AbjadObject" -> "abjad.segments.Job.Job"; "builtins.object" -> "abjad.system.AbjadObject.AbjadObject"; }

class abjad.segments.Job.Job(activate=None, deactivate=None, deactivate_first=None, message_zero=None, path=None, title=None)

Job.


Attributes Summary

__call__ Calls job on job path.
activate Gets activate match / message pair.
color_clefs Colors clefs.
color_dynamics Colors dynamics.
color_instruments Colors instruments.
color_margin_markup Colors margin markup.
color_metronome_marks Colors metronome marks.
color_persistent_indicators Color persistent indicators.
color_staff_lines Colors staff lines.
color_stage_number_markup Colors stage number markup.
color_time_signatures Colors time signatures.
deactivate Gets deactivate match / message pair.
deactivate_first Is true when deactivate runs first.
handle_edition_tags Handles edition tags.
handle_fermata_bar_lines Handles EOL fermata bar lines.
handle_shifted_clefs Handles shifted clefs.
hide_default_clefs Hides default clefs.
join_broken_spanners Joins broken spanners.
message_zero Is true when job returns messages even when no matches are found.
path Gets path.
show_clock_time_markup Makes clock time markup job.
show_figure_name_markup Shows figure name markup.
show_local_measure_number_markup Shows local measure number markup.
show_measure_index_markup Shows measure index markup.
show_measure_number_markup Shows measure number markup.
show_music_annotations Shows music annotations.
show_spacing_markup Shows spacing markup.
title Gets title.

Special methods

__call__()

Calls job on job path.

Return type:List[String]
(AbjadObject).__format__(format_specification='')

Formats Abjad object.

Set format_specification to '' or 'storage'. Interprets '' equal to 'storage'.

Returns string.

(AbjadObject).__repr__()

Gets interpreter representation of Abjad object.

Returns string.


Class & static methods

static color_clefs(path, undo=False)

Colors clefs.

Return type:Job
static color_dynamics(path, undo=False)

Colors dynamics.

Return type:Job
static color_instruments(path, undo=False)

Colors instruments.

Return type:Job
static color_margin_markup(path, undo=False)

Colors margin markup.

Return type:Job
static color_metronome_marks(path, undo=False)

Colors metronome marks.

Return type:Job
static color_persistent_indicators(path, undo=False)

Color persistent indicators.

Return type:Job
static color_staff_lines(path, undo=False)

Colors staff lines.

Return type:Job
static color_stage_number_markup(path, undo=False)

Colors stage number markup.

Return type:Job
static color_time_signatures(path, undo=False)

Colors time signatures.

Return type:Job
static handle_edition_tags(path)

Handles edition tags.

The logic here is important:

  • deactivations run first:

    -TAG (where TAG is either my directory or my buildtype)

    +TAG (where TAG is neither my directory nor my buildtype)

  • activations run afterwards:

    TAG_SET such that there exists at least one build-forbid

    -TAG (equal to neither my directory nor my buildtype) in TAG_SET and such that there exists no -TAG (equal to either my directory or my buildtype) in TAG_SET

    +TAG (where TAG is either my directory or my buildtype)

Notionally: first we deactivate anything that is tagged EITHER specifically against me OR specifically for another build; then we activate anything that is deactivated for editions other than me; then we activate anything is tagged specifically for me.

Return type:Job
static handle_fermata_bar_lines(path)

Handles EOL fermata bar lines.

Return type:Job
static handle_shifted_clefs(path)

Handles shifted clefs.

Return type:Job
static hide_default_clefs(path, undo=False)

Hides default clefs.

Return type:Job
static join_broken_spanners(path)

Joins broken spanners.

Return type:Job
static show_clock_time_markup(path, undo=False)

Makes clock time markup job.

Return type:Job
static show_figure_name_markup(path, undo=False)

Shows figure name markup.

Return type:Job
static show_local_measure_number_markup(path, undo=False)

Shows local measure number markup.

Return type:Job
static show_measure_index_markup(path, undo=False)

Shows measure index markup.

Return type:Job
static show_measure_number_markup(path, undo=False)

Shows measure number markup.

Return type:Job
static show_music_annotations(path, undo=False)

Shows music annotations.

Return type:Job
static show_spacing_markup(path, undo=False)

Shows spacing markup.

Return type:Job

Read-only properties

activate

Gets activate match / message pair.

Return type:Optional[Tuple[Union[str, Callable, None], str]]
deactivate

Gets deactivate match / message pair.

Return type:Optional[Tuple[Union[str, Callable, None], str]]
deactivate_first

Is true when deactivate runs first.

Return type:Optional[bool]
message_zero

Is true when job returns messages even when no matches are found.

Return type:Optional[bool]
path

Gets path.

Return type:Optional[Path]
title

Gets title.

Return type:Optional[str]