get¶

Classes

Lineage

Lineage of a component.

class abjad.get.Lineage(component=None)[source]¶

Lineage of a component.

>>> score = abjad.Score()
>>> staff = abjad.Staff(
...     r"""\new Voice = "Treble_Voice" { c'4 }""",
...     name="Treble_Staff",
... )
>>> score.append(staff)
>>> bass = abjad.Staff(
...     r"""\new Voice = "Bass_Voice" { b,4 }""",
...     name="Bass_Staff",
... )
>>> score.append(bass)

>>> for component in abjad.get.lineage(score):
...     component
... 
Score("{ { c'4 } } { { b,4 } }", simultaneous=True)
Staff("{ c'4 }", name='Treble_Staff')
Voice("c'4", name='Treble_Voice')
Note("c'4")
Staff('{ b,4 }', name='Bass_Staff')
Voice('b,4', name='Bass_Voice')
Note('b,4')

>>> bass_voice = score["Bass_Voice"]
>>> for component in abjad.get.lineage(bass_voice):
...     component
... 
Score("{ { c'4 } } { { b,4 } }", simultaneous=True)
Staff('{ b,4 }', name='Bass_Staff')
Voice('b,4', name='Bass_Voice')
Note('b,4')

Attributes Summary

`__eq__`	Is true when `argument` lineage with components of same id.
`__getitem__`	Gets `argument`.
`__len__`	Gets length of lineage.
`component`	The component from which the lineage was derived.
`components`	Gets components.

Special methods

classmethod (Iterable).__class_getitem__()¶

Represent a PEP 585 generic type

E.g. for t = list[int], t.__origin__ is list and t.__args__ is (int,).

(Sequence).__contains__(value)¶

overridden __eq__(argument)[source]¶

Is true when argument lineage with components of same id.

Return type:: bool

overridden __getitem__(argument)[source]¶

Gets argument.

Returns component or tuple.

(Sequence).__iter__()¶

overridden __len__()[source]¶

Gets length of lineage.

Returns int.

(Sequence).__reversed__()¶

Methods

(Sequence).count(value) → integer -- return number of occurrences of value¶

(Sequence).index(value[, start[, stop]]) → integer -- return first index of value.¶

Raises ValueError if the value is not present.

Supporting start and stop arguments is optional, but recommended.

Read-only properties

component¶: The component from which the lineage was derived.

components¶

Gets components.

Returns tuple.

Functions

`after_grace_container`	Gets after grace containers attached to component.
`annotation`	Gets annotation.
`annotation_wrappers`	Gets annotation wrappers.
`bar_line_crossing`	Is true when `argument` crosses bar line.
`before_grace_container`	Gets before-grace container attached to leaf.
`contents`	Gets contents.
`descendants`	Gets descendants.
`duration`	Gets duration.
`effective`	Gets effective indicator.
`effective_staff`	Gets effective staff.
`effective_wrapper`	Gets effective wrapper.
`grace`	Is true when `argument` is grace music.
`has_effective_indicator`	Is true when `argument` has effective indicator.
`has_indicator`	Is true when `argument` has one or more indicators.
`indicator`	Gets indicator.
`indicators`	Get indicators.
`leaf`	Gets leaf `n`.
`lineage`	Gets lineage.
`logical_tie`	Gets logical tie.
`markup`	Gets markup.
`measure_number`	Gets measure number.
`parentage`	Gets parentage.
`pitches`	Gets pitches.
`sounding_pitch`	Gets sounding pitch of note.
`sounding_pitches`	Gets sounding pitches.
`sustained`	Is true when `argument` is sustained.
`timespan`	Gets timespan.
`wrapper`	Gets wrapper.
`wrappers`	Gets wrappers.

abjad.get.after_grace_container(argument)[source]¶

Gets after grace containers attached to component.

REGRESSION. Works with grace notes (and containers):

>>> music_voice = abjad.Voice("c'4 d' e' f'", name="MusicVoice")
>>> container = abjad.BeforeGraceContainer("cs'16")
>>> abjad.attach(container, music_voice[1])
>>> container = abjad.on_beat_grace_container("g'16 gs' a' as'", music_voice[2:3])
>>> abjad.attach(abjad.Articulation(">"), container[0])
>>> container = abjad.AfterGraceContainer("fs'16")
>>> abjad.attach(container, music_voice[3])
>>> staff = abjad.Staff([music_voice])
>>> lilypond_file = abjad.LilyPondFile([r'\include "abjad.ily"', staff])
>>> abjad.show(lilypond_file)  

>>> for component in abjad.select.components(staff):
...     container = abjad.get.after_grace_container(component)
...     print(f"{repr(component):30} {repr(container)}")
... 
Staff("{ c'4 d'4 { { <e' g'>16 gs'16 a'16 as'16 } { e'4 } } f'4 }") None
Voice("c'4 d'4 { { <e' g'>16 gs'16 a'16 as'16 } { e'4 } } f'4", name='MusicVoice') None
Note("c'4")                    None
BeforeGraceContainer("cs'16")  None
Note("cs'16")                  None
Note("d'4")                    None
Container("{ <e' g'>16 gs'16 a'16 as'16 } { e'4 }") None
OnBeatGraceContainer("<e' g'>16 gs'16 a'16 as'16") None
Chord("<e' g'>16")             None
Note("gs'16")                  None
Note("a'16")                   None
Note("as'16")                  None
Voice("e'4", name='MusicVoice') None
Note("e'4")                    None
Note("f'4")                    AfterGraceContainer("fs'16")
AfterGraceContainer("fs'16")   None
Note("fs'16")                  None

abjad.get.annotation(argument, annotation, default=None, unwrap=True)[source]¶

Gets annotation.

>>> staff = abjad.Staff("c'4 e' e' f'")
>>> abjad.annotate(staff[0], "default_instrument", abjad.Cello())
>>> abjad.show(staff)  

>>> string = "default_instrument"
>>> abjad.get.annotation(staff[0], string)
Cello(clefs=('bass', 'tenor', 'treble'), context='Staff', middle_c_sounding_pitch=NamedPitch("c'"), pitch_range=PitchRange(range_string='[C2, G5]'), tuning=Tuning(pitches=(NamedPitch('c,'), NamedPitch('g,'), NamedPitch('d'), NamedPitch('a'))))

>>> abjad.get.annotation(staff[1], string) is None
True

>>> abjad.get.annotation(staff[2], string) is None
True

>>> abjad.get.annotation(staff[3], string) is None
True

Returns default when no annotation is found:

>>> abjad.get.annotation(staff[3], string, abjad.Violin())
Violin(clefs=('treble',), context='Staff', middle_c_sounding_pitch=NamedPitch("c'"), pitch_range=PitchRange(range_string='[G3, G7]'), tuning=Tuning(pitches=(NamedPitch('g'), NamedPitch("d'"), NamedPitch("a'"), NamedPitch("e''"))))

REGRESSION: annotation is not picked up as effective indicator:

>>> prototype = abjad.Instrument
>>> abjad.get.effective(staff[0], prototype) is None
True

>>> abjad.get.effective(staff[1], prototype) is None
True

>>> abjad.get.effective(staff[2], prototype) is None
True

>>> abjad.get.effective(staff[3], prototype) is None
True

Return type:: Any

abjad.get.annotation_wrappers(argument)[source]¶

Gets annotation wrappers.

>>> staff = abjad.Staff("c'4 e' e' f'")
>>> abjad.annotate(staff[0], "default_instrument", abjad.Cello())
>>> abjad.annotate(staff[0], "default_clef", abjad.Clef("tenor"))
>>> abjad.show(staff)  

>>> for wrapper in abjad.get.annotation_wrappers(staff[0]):
...     wrapper
... 
Wrapper(annotation='default_instrument', context=None, deactivate=False, direction=None, indicator=Cello(clefs=('bass', 'tenor', 'treble'), context='Staff', middle_c_sounding_pitch=NamedPitch("c'"), pitch_range=PitchRange(range_string='[C2, G5]'), tuning=Tuning(pitches=(NamedPitch('c,'), NamedPitch('g,'), NamedPitch('d'), NamedPitch('a')))), synthetic_offset=None, tag=Tag(string=''))
Wrapper(annotation='default_clef', context=None, deactivate=False, direction=None, indicator=Clef(name='tenor', hide=False), synthetic_offset=None, tag=Tag(string=''))

abjad.get.bar_line_crossing(argument)[source]¶

Is true when argument crosses bar line.

>>> staff = abjad.Staff("c'4 d'4 e'4")
>>> score = abjad.Score([staff], name="Score")
>>> time_signature = abjad.TimeSignature((3, 8))
>>> abjad.attach(time_signature, staff[0])
>>> abjad.show(staff)  

>>> for note in staff:
...     result = abjad.get.bar_line_crossing(note)
...     print(note, result)
... 
Note("c'4") False
Note("d'4") True
Note("e'4") False

Return type:: bool

abjad.get.before_grace_container(argument)[source]¶

Gets before-grace container attached to leaf.

REGRESSION. Works with grace notes (and containers):

>>> music_voice = abjad.Voice("c'4 d' e' f'", name="MusicVoice")
>>> container = abjad.BeforeGraceContainer("cs'16")
>>> abjad.attach(container, music_voice[1])
>>> container = abjad.on_beat_grace_container("g'16 gs' a' as'", music_voice[2:3])
>>> abjad.attach(abjad.Articulation(">"), container[0])
>>> container = abjad.AfterGraceContainer("fs'16")
>>> abjad.attach(container, music_voice[3])
>>> staff = abjad.Staff([music_voice])
>>> lilypond_file = abjad.LilyPondFile([r'\include "abjad.ily"', staff])
>>> abjad.show(lilypond_file)  

>>> for component in abjad.select.components(staff):
...     container = abjad.get.before_grace_container(component)
...     print(f"{repr(component):30} {repr(container)}")
... 
Staff("{ c'4 d'4 { { <e' g'>16 gs'16 a'16 as'16 } { e'4 } } f'4 }") None
Voice("c'4 d'4 { { <e' g'>16 gs'16 a'16 as'16 } { e'4 } } f'4", name='MusicVoice') None
Note("c'4")                    None
BeforeGraceContainer("cs'16")  None
Note("cs'16")                  None
Note("d'4")                    BeforeGraceContainer("cs'16")
Container("{ <e' g'>16 gs'16 a'16 as'16 } { e'4 }") None
OnBeatGraceContainer("<e' g'>16 gs'16 a'16 as'16") None
Chord("<e' g'>16")             None
Note("gs'16")                  None
Note("a'16")                   None
Note("as'16")                  None
Voice("e'4", name='MusicVoice') None
Note("e'4")                    None
Note("f'4")                    None
AfterGraceContainer("fs'16")   None
Note("fs'16")                  None

abjad.get.contents(argument)[source]¶

Gets contents.

REGRESSION. Works with grace notes (and containers):

>>> music_voice = abjad.Voice("c'4 d' e' f'", name="MusicVoice")
>>> container = abjad.BeforeGraceContainer("cs'16")
>>> abjad.attach(container, music_voice[1])
>>> container = abjad.on_beat_grace_container("g'16 gs' a' as'", music_voice[2:3])
>>> abjad.attach(abjad.Articulation(">"), container[0])
>>> container = abjad.AfterGraceContainer("fs'16")
>>> abjad.attach(container, music_voice[3])
>>> staff = abjad.Staff([music_voice])
>>> lilypond_file = abjad.LilyPondFile([r'\include "abjad.ily"', staff])
>>> abjad.show(lilypond_file)  

>>> for component in abjad.select.components(staff):
...     contents = abjad.get.contents(component)
...     print(f"{repr(component)}:")
...     for component_ in contents:
...         print(f"    {repr(component_)}")
... 
Staff("{ c'4 d'4 { { <e' g'>16 gs'16 a'16 as'16 } { e'4 } } f'4 }"):
    Staff("{ c'4 d'4 { { <e' g'>16 gs'16 a'16 as'16 } { e'4 } } f'4 }")
    Voice("c'4 d'4 { { <e' g'>16 gs'16 a'16 as'16 } { e'4 } } f'4", name='MusicVoice')
Voice("c'4 d'4 { { <e' g'>16 gs'16 a'16 as'16 } { e'4 } } f'4", name='MusicVoice'):
    Voice("c'4 d'4 { { <e' g'>16 gs'16 a'16 as'16 } { e'4 } } f'4", name='MusicVoice')
    Note("c'4")
    Note("d'4")
    Container("{ <e' g'>16 gs'16 a'16 as'16 } { e'4 }")
    Note("f'4")
Note("c'4"):
    Note("c'4")
BeforeGraceContainer("cs'16"):
    BeforeGraceContainer("cs'16")
    Note("cs'16")
Note("cs'16"):
    Note("cs'16")
Note("d'4"):
    Note("d'4")
Container("{ <e' g'>16 gs'16 a'16 as'16 } { e'4 }"):
    Container("{ <e' g'>16 gs'16 a'16 as'16 } { e'4 }")
    OnBeatGraceContainer("<e' g'>16 gs'16 a'16 as'16")
    Voice("e'4", name='MusicVoice')
OnBeatGraceContainer("<e' g'>16 gs'16 a'16 as'16"):
    OnBeatGraceContainer("<e' g'>16 gs'16 a'16 as'16")
    Chord("<e' g'>16")
    Note("gs'16")
    Note("a'16")
    Note("as'16")
Chord("<e' g'>16"):
    Chord("<e' g'>16")
Note("gs'16"):
    Note("gs'16")
Note("a'16"):
    Note("a'16")
Note("as'16"):
    Note("as'16")
Voice("e'4", name='MusicVoice'):
    Voice("e'4", name='MusicVoice')
    Note("e'4")
Note("e'4"):
    Note("e'4")
Note("f'4"):
    Note("f'4")
AfterGraceContainer("fs'16"):
    AfterGraceContainer("fs'16")
    Note("fs'16")
Note("fs'16"):
    Note("fs'16")

REGRESSSION. Works with tremolo containers:

>>> staff = abjad.Staff()
>>> staff.append(abjad.TremoloContainer(2, "c'16 e'"))
>>> staff.append("cs'4")
>>> staff.append(abjad.TremoloContainer(2, "d'16 f'"))
>>> staff.append("ds'4")
>>> abjad.show(staff)  

>>> for component in abjad.select.components(staff):
...     contents = abjad.get.contents(component)
...     print(f"{repr(component)}:")
...     for component_ in contents:
...         print(f"    {repr(component_)}")
... 
Staff("{ c'16 e'16 } cs'4 { d'16 f'16 } ds'4"):
    Staff("{ c'16 e'16 } cs'4 { d'16 f'16 } ds'4")
    TremoloContainer("c'16 e'16")
    Note("cs'4")
    TremoloContainer("d'16 f'16")
    Note("ds'4")
TremoloContainer("c'16 e'16"):
    TremoloContainer("c'16 e'16")
    Note("c'16")
    Note("e'16")
Note("c'16"):
    Note("c'16")
Note("e'16"):
    Note("e'16")
Note("cs'4"):
    Note("cs'4")
TremoloContainer("d'16 f'16"):
    TremoloContainer("d'16 f'16")
    Note("d'16")
    Note("f'16")
Note("d'16"):
    Note("d'16")
Note("f'16"):
    Note("f'16")
Note("ds'4"):
    Note("ds'4")

Return type:: list[Component]

abjad.get.descendants(argument)[source]¶

Gets descendants.

REGRESSION. Works with grace notes (and containers):

>>> music_voice = abjad.Voice("c'4 d' e' f'", name="MusicVoice")
>>> container = abjad.BeforeGraceContainer("cs'16")
>>> abjad.attach(container, music_voice[1])
>>> container = abjad.on_beat_grace_container("g'16 gs' a' as'", music_voice[2:3])
>>> abjad.attach(abjad.Articulation(">"), container[0])
>>> container = abjad.AfterGraceContainer("fs'16")
>>> abjad.attach(container, music_voice[3])
>>> staff = abjad.Staff([music_voice])
>>> lilypond_file = abjad.LilyPondFile([r'\include "abjad.ily"', staff])
>>> abjad.show(lilypond_file)  

>>> for component in abjad.select.components(staff):
...     descendants = abjad.get.descendants(component)
...     print(f"{repr(component)}:")
...     for component_ in descendants:
...         print(f"    {repr(component_)}")
... 
Staff("{ c'4 d'4 { { <e' g'>16 gs'16 a'16 as'16 } { e'4 } } f'4 }"):
    Staff("{ c'4 d'4 { { <e' g'>16 gs'16 a'16 as'16 } { e'4 } } f'4 }")
    Voice("c'4 d'4 { { <e' g'>16 gs'16 a'16 as'16 } { e'4 } } f'4", name='MusicVoice')
    Note("c'4")
    BeforeGraceContainer("cs'16")
    Note("cs'16")
    Note("d'4")
    Container("{ <e' g'>16 gs'16 a'16 as'16 } { e'4 }")
    OnBeatGraceContainer("<e' g'>16 gs'16 a'16 as'16")
    Chord("<e' g'>16")
    Note("gs'16")
    Note("a'16")
    Note("as'16")
    Voice("e'4", name='MusicVoice')
    Note("e'4")
    Note("f'4")
    AfterGraceContainer("fs'16")
    Note("fs'16")
Voice("c'4 d'4 { { <e' g'>16 gs'16 a'16 as'16 } { e'4 } } f'4", name='MusicVoice'):
    Voice("c'4 d'4 { { <e' g'>16 gs'16 a'16 as'16 } { e'4 } } f'4", name='MusicVoice')
    Note("c'4")
    BeforeGraceContainer("cs'16")
    Note("cs'16")
    Note("d'4")
    Container("{ <e' g'>16 gs'16 a'16 as'16 } { e'4 }")
    OnBeatGraceContainer("<e' g'>16 gs'16 a'16 as'16")
    Chord("<e' g'>16")
    Note("gs'16")
    Note("a'16")
    Note("as'16")
    Voice("e'4", name='MusicVoice')
    Note("e'4")
    Note("f'4")
    AfterGraceContainer("fs'16")
    Note("fs'16")
Note("c'4"):
    Note("c'4")
BeforeGraceContainer("cs'16"):
    BeforeGraceContainer("cs'16")
    Note("cs'16")
Note("cs'16"):
    Note("cs'16")
Note("d'4"):
    Note("d'4")
Container("{ <e' g'>16 gs'16 a'16 as'16 } { e'4 }"):
    Container("{ <e' g'>16 gs'16 a'16 as'16 } { e'4 }")
    OnBeatGraceContainer("<e' g'>16 gs'16 a'16 as'16")
    Chord("<e' g'>16")
    Note("gs'16")
    Note("a'16")
    Note("as'16")
    Voice("e'4", name='MusicVoice')
    Note("e'4")
OnBeatGraceContainer("<e' g'>16 gs'16 a'16 as'16"):
    OnBeatGraceContainer("<e' g'>16 gs'16 a'16 as'16")
    Chord("<e' g'>16")
    Note("gs'16")
    Note("a'16")
    Note("as'16")
Chord("<e' g'>16"):
    Chord("<e' g'>16")
Note("gs'16"):
    Note("gs'16")
Note("a'16"):
    Note("a'16")
Note("as'16"):
    Note("as'16")
Voice("e'4", name='MusicVoice'):
    Voice("e'4", name='MusicVoice')
    Note("e'4")
Note("e'4"):
    Note("e'4")
Note("f'4"):
    Note("f'4")
AfterGraceContainer("fs'16"):
    AfterGraceContainer("fs'16")
    Note("fs'16")
Note("fs'16"):
    Note("fs'16")

Return type:: list[Component]

abjad.get.duration(argument, in_seconds=False, preprolated=False)[source]¶

Gets duration.

REGRESSION. Works with grace notes (and containers):

>>> music_voice = abjad.Voice("c'4 d' e' f'", name="MusicVoice")
>>> container = abjad.BeforeGraceContainer("cs'16")
>>> abjad.attach(container, music_voice[1])
>>> container = abjad.on_beat_grace_container("g'16 gs' a' as'", music_voice[2:3])
>>> abjad.attach(abjad.Articulation(">"), container[0])
>>> container = abjad.AfterGraceContainer("fs'16")
>>> abjad.attach(container, music_voice[3])
>>> staff = abjad.Staff([music_voice])
>>> lilypond_file = abjad.LilyPondFile([r'\include "abjad.ily"', staff])
>>> abjad.show(lilypond_file)  

>>> for component in abjad.select.components(staff):
...     duration = abjad.get.duration(component)
...     print(f"{repr(component):30} {repr(duration)}")
... 
Staff("{ c'4 d'4 { { <e' g'>16 gs'16 a'16 as'16 } { e'4 } } f'4 }") Duration(1, 1)
Voice("c'4 d'4 { { <e' g'>16 gs'16 a'16 as'16 } { e'4 } } f'4", name='MusicVoice') Duration(1, 1)
Note("c'4")                    Duration(1, 4)
BeforeGraceContainer("cs'16")  Duration(1, 16)
Note("cs'16")                  Duration(1, 16)
Note("d'4")                    Duration(1, 4)
Container("{ <e' g'>16 gs'16 a'16 as'16 } { e'4 }") Duration(1, 4)
OnBeatGraceContainer("<e' g'>16 gs'16 a'16 as'16") Duration(1, 4)
Chord("<e' g'>16")             Duration(1, 16)
Note("gs'16")                  Duration(1, 16)
Note("a'16")                   Duration(1, 16)
Note("as'16")                  Duration(1, 16)
Voice("e'4", name='MusicVoice') Duration(1, 4)
Note("e'4")                    Duration(1, 4)
Note("f'4")                    Duration(1, 4)
AfterGraceContainer("fs'16")   Duration(1, 16)
Note("fs'16")                  Duration(1, 16)

REGRESSSION. Works with tremolo containers:

>>> staff = abjad.Staff()
>>> staff.append(abjad.TremoloContainer(2, "c'16 e'"))
>>> staff.append("cs'4")
>>> staff.append(abjad.TremoloContainer(2, "d'16 f'"))
>>> staff.append("ds'4")
>>> abjad.show(staff)  

>>> for component in abjad.select.components(staff):
...     duration = abjad.get.duration(component)
...     print(f"{repr(component):30} {repr(duration)}")
... 
Staff("{ c'16 e'16 } cs'4 { d'16 f'16 } ds'4") Duration(1, 1)
TremoloContainer("c'16 e'16")  Duration(1, 4)
Note("c'16")                   Duration(1, 8)
Note("e'16")                   Duration(1, 8)
Note("cs'4")                   Duration(1, 4)
TremoloContainer("d'16 f'16")  Duration(1, 4)
Note("d'16")                   Duration(1, 8)
Note("f'16")                   Duration(1, 8)
Note("ds'4")                   Duration(1, 4)

REGRESSION. Works with selections:

>>> staff = abjad.Staff("c'4 d' e' f'")
>>> abjad.show(staff)  

>>> selection = staff[:3]
>>> abjad.get.duration(selection)
Duration(3, 4)

Gets preprolated duration:

>>> staff = abjad.Staff(r"\times 2/3 { c'4 ~ c' } \times 2/3 { d' ~ d' }")
>>> abjad.show(staff)  

>>> for lt in abjad.select.logical_ties(staff):
...     duration = abjad.get.duration(lt)
...     preprolated = abjad.get.duration(lt, preprolated=True)
...     lt, duration, preprolated
... 
(LogicalTie(items=[Note("c'4"), Note("c'4")]), Duration(1, 3), Duration(1, 2))
(LogicalTie(items=[Note("d'4"), Note("d'4")]), Duration(1, 3), Duration(1, 2))

Return type:: Duration

abjad.get.effective(argument, prototype, *, attributes=None, default=None, n=0, unwrap=True)[source]¶

Gets effective indicator.

REGRESSION. Works with grace notes (and containers):

>>> music_voice = abjad.Voice("c'4 d' e' f'", name="MusicVoice")
>>> staff = abjad.Staff([music_voice])
>>> container = abjad.BeforeGraceContainer("cs'16")
>>> abjad.attach(container, music_voice[1])
>>> container = abjad.on_beat_grace_container("g'16 gs' a' as'", music_voice[2:3])
>>> abjad.attach(abjad.Clef("alto"), container[0])
>>> abjad.attach(abjad.Articulation(">"), container[0])
>>> container = abjad.AfterGraceContainer("fs'16")
>>> abjad.attach(container, music_voice[3])
>>> lilypond_file = abjad.LilyPondFile([r'\include "abjad.ily"', staff])
>>> abjad.show(lilypond_file)  

>>> for component in abjad.select.components(staff):
...     clef = abjad.get.effective(component, abjad.Clef)
...     print(f"{repr(component):30} {repr(clef)}")
... 
Staff("{ c'4 d'4 { { <e' g'>16 gs'16 a'16 as'16 } { e'4 } } f'4 }") None
Voice("c'4 d'4 { { <e' g'>16 gs'16 a'16 as'16 } { e'4 } } f'4", name='MusicVoice') None
Note("c'4")                    None
BeforeGraceContainer("cs'16")  None
Note("cs'16")                  None
Note("d'4")                    None
Container("{ <e' g'>16 gs'16 a'16 as'16 } { e'4 }") Clef(name='alto', hide=False)
OnBeatGraceContainer("<e' g'>16 gs'16 a'16 as'16") Clef(name='alto', hide=False)
Chord("<e' g'>16")             Clef(name='alto', hide=False)
Note("gs'16")                  Clef(name='alto', hide=False)
Note("a'16")                   Clef(name='alto', hide=False)
Note("as'16")                  Clef(name='alto', hide=False)
Voice("e'4", name='MusicVoice') Clef(name='alto', hide=False)
Note("e'4")                    Clef(name='alto', hide=False)
Note("f'4")                    Clef(name='alto', hide=False)
AfterGraceContainer("fs'16")   Clef(name='alto', hide=False)
Note("fs'16")                  Clef(name='alto', hide=False)

REGRESSSION. Works with tremolo containers:

>>> staff = abjad.Staff()
>>> staff.append(abjad.TremoloContainer(2, "c'16 e'"))
>>> staff.append("cs'4")
>>> staff.append(abjad.TremoloContainer(2, "d'16 f'"))
>>> abjad.attach(abjad.Clef("alto"), staff[-1][0])
>>> staff.append("ds'4")
>>> abjad.show(staff)  

>>> for component in abjad.select.components(staff):
...     clef = abjad.get.effective(component, abjad.Clef)
...     print(f"{repr(component):30} {repr(clef)}")
... 
Staff("{ c'16 e'16 } cs'4 { d'16 f'16 } ds'4") None
TremoloContainer("c'16 e'16")  None
Note("c'16")                   None
Note("e'16")                   None
Note("cs'4")                   None
TremoloContainer("d'16 f'16")  Clef(name='alto', hide=False)
Note("d'16")                   Clef(name='alto', hide=False)
Note("f'16")                   Clef(name='alto', hide=False)
Note("ds'4")                   Clef(name='alto', hide=False)

Arbitrary objects (like strings) can be contexted:

>>> staff = abjad.Staff("c'8 d'8 e'8 f'8")
>>> abjad.attach("color", staff[1], context="Staff")
>>> abjad.show(staff)  

>>> for component in abjad.iterate.components(staff):
...     string = abjad.get.effective(component, str)
...     print(component, repr(string))
... 
Staff("c'8 d'8 e'8 f'8") None
Note("c'8") None
Note("d'8") 'color'
Note("e'8") 'color'
Note("f'8") 'color'

Scans forwards or backwards when n is set:

>>> staff = abjad.Staff("c'8 d'8 e'8 f'8 g'8")
>>> abjad.attach("red", staff[0], context="Staff")
>>> abjad.attach("blue", staff[2], context="Staff")
>>> abjad.attach("yellow", staff[4], context="Staff")
>>> abjad.show(staff)  

>>> for n in (-1, 0, 1):
...     color = abjad.get.effective(staff[0], str, n=n)
...     print(n, repr(color))
... 
-1 None
0 'red'
1 'blue'

>>> for n in (-1, 0, 1):
...     color = abjad.get.effective(staff[1], str, n=n)
...     print(n, repr(color))
... 
-1 None
0 'red'
1 'blue'

>>> for n in (-1, 0, 1):
...     color = abjad.get.effective(staff[2], str, n=n)
...     print(n, repr(color))
... 
-1 'red'
0 'blue'
1 'yellow'

>>> for n in (-1, 0, 1):
...     color = abjad.get.effective(staff[3], str, n=n)
...     print(n, repr(color))
... 
-1 'red'
0 'blue'
1 'yellow'

>>> for n in (-1, 0, 1):
...     color = abjad.get.effective(staff[4], str, n=n)
...     print(n, repr(color))
... 
-1 'blue'
0 'yellow'
1 None

Use synthetic offsets to hide a clef before the start of a staff like this:

>>> staff = abjad.Staff("c'4 d'4 e'4 f'4")
>>> abjad.attach(
...     abjad.Clef("treble", hide=True),
...     staff[0],
...     synthetic_offset=abjad.Offset(-1),
... )
>>> abjad.attach(abjad.Clef("alto"), staff[0])
>>> abjad.show(staff)  

>>> for leaf in staff:
...     clef = abjad.get.effective(leaf, abjad.Clef)
...     (leaf, clef)
... 
(Note("c'4"), Clef(name='alto', hide=False))
(Note("d'4"), Clef(name='alto', hide=False))
(Note("e'4"), Clef(name='alto', hide=False))
(Note("f'4"), Clef(name='alto', hide=False))

>>> abjad.get.effective(staff[0], abjad.Clef)
Clef(name='alto', hide=False)

>>> abjad.get.effective(staff[0], abjad.Clef, n=-1)
Clef(name='treble', hide=True)

>>> abjad.get.effective(staff[0], abjad.Clef, n=-2) is None
True

Note that hide=True is set on the offset clef to prevent duplicate clef commands in LilyPond output.

Note also that the order of attachment (offset versus non-offset) makes no difference.

Here’s how to hide a clef after the end of a staff:

>>> staff = abjad.Staff("c'4 d'4 e'4 f'4")
>>> abjad.attach(abjad.Clef("treble"), staff[0])
>>> abjad.attach(
...     abjad.Clef("alto", hide=True),
...     staff[-1],
...     synthetic_offset=abjad.Offset(1),
... )
>>> abjad.show(staff)  

>>> for leaf in staff:
...     clef = abjad.get.effective(leaf, abjad.Clef)
...     (leaf, clef)
... 
(Note("c'4"), Clef(name='treble', hide=False))
(Note("d'4"), Clef(name='treble', hide=False))
(Note("e'4"), Clef(name='treble', hide=False))
(Note("f'4"), Clef(name='treble', hide=False))

>>> abjad.get.effective(staff[-1], abjad.Clef)
Clef(name='treble', hide=False)

>>> abjad.get.effective(staff[-1], abjad.Clef, n=1)
Clef(name='alto', hide=True)

>>> abjad.get.effective(staff[-1], abjad.Clef, n=2) is None
True

Gets effective time signature:

>>> staff = abjad.Staff("c'4 d' e' f'")
>>> score = abjad.Score([staff], name="Score")
>>> leaves = abjad.select.leaves(staff)
>>> abjad.attach(abjad.TimeSignature((3, 8)), leaves[0])
>>> abjad.show(staff)  

>>> prototype = abjad.TimeSignature
>>> for component in abjad.iterate.components(staff):
...     time_signature = abjad.get.effective(component, prototype)
...     print(component, time_signature)
... 
Staff("c'4 d'4 e'4 f'4") TimeSignature(pair=(3, 8), hide=False, partial=None)
Note("c'4") TimeSignature(pair=(3, 8), hide=False, partial=None)
Note("d'4") TimeSignature(pair=(3, 8), hide=False, partial=None)
Note("e'4") TimeSignature(pair=(3, 8), hide=False, partial=None)
Note("f'4") TimeSignature(pair=(3, 8), hide=False, partial=None)

Test attributes like this:

>>> voice = abjad.Voice("c'4 d' e' f'")
>>> staff = abjad.Staff([voice])
>>> start_text_span = abjad.StartTextSpan()
>>> abjad.attach(start_text_span, voice[0])
>>> stop_text_span = abjad.StopTextSpan()
>>> abjad.attach(stop_text_span, voice[2])
>>> abjad.show(staff)  

>>> for note in abjad.select.notes(staff):
...     note, abjad.get.effective(note, abjad.StartTextSpan)
... 
(Note("c'4"), StartTextSpan(command='\\startTextSpan', concat_hspace_left=0.5, concat_hspace_right=None, left_broken_text=None, left_text=None, right_padding=None, right_text=None, style=None))
(Note("d'4"), StartTextSpan(command='\\startTextSpan', concat_hspace_left=0.5, concat_hspace_right=None, left_broken_text=None, left_text=None, right_padding=None, right_text=None, style=None))
(Note("e'4"), StartTextSpan(command='\\startTextSpan', concat_hspace_left=0.5, concat_hspace_right=None, left_broken_text=None, left_text=None, right_padding=None, right_text=None, style=None))
(Note("f'4"), StartTextSpan(command='\\startTextSpan', concat_hspace_left=0.5, concat_hspace_right=None, left_broken_text=None, left_text=None, right_padding=None, right_text=None, style=None))

>>> for note in abjad.select.notes(staff):
...     note, abjad.get.effective(note, abjad.StopTextSpan)
... 
(Note("c'4"), None)
(Note("d'4"), None)
(Note("e'4"), StopTextSpan(command='\\stopTextSpan', leak=False))
(Note("f'4"), StopTextSpan(command='\\stopTextSpan', leak=False))

>>> attributes = {"parameter": "TEXT_SPANNER"}
>>> for note in abjad.select.notes(staff):
...     indicator = abjad.get.effective(
...         note,
...         object,
...         attributes=attributes,
...     )
...     print(f"{note!r}:")
...     print(f"    {indicator!r}")
... 
Note("c'4"):
    StartTextSpan(command='\\startTextSpan', concat_hspace_left=0.5, concat_hspace_right=None, left_broken_text=None, left_text=None, right_padding=None, right_text=None, style=None)
Note("d'4"):
    StartTextSpan(command='\\startTextSpan', concat_hspace_left=0.5, concat_hspace_right=None, left_broken_text=None, left_text=None, right_padding=None, right_text=None, style=None)
Note("e'4"):
    StopTextSpan(command='\\stopTextSpan', leak=False)
Note("f'4"):
    StopTextSpan(command='\\stopTextSpan', leak=False)

REGRESSION. Matching start-beam and stop-beam indicators work correctly:

>>> voice = abjad.Voice("c'8 d'8 e'8 f'8 g'4 a'4")
>>> abjad.attach(abjad.StartBeam(), voice[0])
>>> abjad.attach(abjad.StopBeam(), voice[3])
>>> abjad.show(voice)  

>>> for leaf in abjad.select.leaves(voice):
...     start_beam = abjad.get.effective(leaf, abjad.StartBeam)
...     stop_beam = abjad.get.effective(leaf, abjad.StopBeam)
...     leaf, start_beam, stop_beam
... 
(Note("c'8"), StartBeam(), None)
(Note("d'8"), StartBeam(), None)
(Note("e'8"), StartBeam(), None)
(Note("f'8"), StartBeam(), StopBeam(leak=False))
(Note("g'4"), StartBeam(), StopBeam(leak=False))
(Note("a'4"), StartBeam(), StopBeam(leak=False))

REGRESSION. Bar lines work like this:

>>> voice = abjad.Voice("c'2 d'2 e'2 f'2")
>>> score = abjad.Score([voice])
>>> abjad.attach(abjad.BarLine("||"), voice[1])
>>> abjad.show(score)  

>>> for leaf in abjad.select.leaves(score):
...     bar_line = abjad.get.effective(leaf, abjad.BarLine)
...     leaf, bar_line
... 
(Note("c'2"), None)
(Note("d'2"), BarLine(abbreviation='||', site='after'))
(Note("e'2"), BarLine(abbreviation='||', site='after'))
(Note("f'2"), BarLine(abbreviation='||', site='after'))

Return type:: Any

abjad.get.effective_staff(argument)[source]¶

Gets effective staff.

REGRESSION. Works with grace notes (and containers):

>>> music_voice = abjad.Voice("c'4 d' e' f'", name="MusicVoice")
>>> container = abjad.BeforeGraceContainer("cs'16")
>>> abjad.attach(container, music_voice[1])
>>> container = abjad.on_beat_grace_container("g'16 gs' a' as'", music_voice[2:3])
>>> abjad.attach(abjad.Articulation(">"), container[0])
>>> container = abjad.AfterGraceContainer("fs'16")
>>> abjad.attach(container, music_voice[3])
>>> staff = abjad.Staff([music_voice])
>>> lilypond_file = abjad.LilyPondFile([r'\include "abjad.ily"', staff])
>>> abjad.show(lilypond_file)  

>>> for component in abjad.select.components(staff):
...     staff = abjad.get.effective_staff(component)
...     print(f"{component!r}:")
...     print(f"    {staff!r}")
... 
Staff("{ c'4 d'4 { { <e' g'>16 gs'16 a'16 as'16 } { e'4 } } f'4 }"):
    Staff("{ c'4 d'4 { { <e' g'>16 gs'16 a'16 as'16 } { e'4 } } f'4 }")
Voice("c'4 d'4 { { <e' g'>16 gs'16 a'16 as'16 } { e'4 } } f'4", name='MusicVoice'):
    Staff("{ c'4 d'4 { { <e' g'>16 gs'16 a'16 as'16 } { e'4 } } f'4 }")
Note("c'4"):
    Staff("{ c'4 d'4 { { <e' g'>16 gs'16 a'16 as'16 } { e'4 } } f'4 }")
BeforeGraceContainer("cs'16"):
    Staff("{ c'4 d'4 { { <e' g'>16 gs'16 a'16 as'16 } { e'4 } } f'4 }")
Note("cs'16"):
    Staff("{ c'4 d'4 { { <e' g'>16 gs'16 a'16 as'16 } { e'4 } } f'4 }")
Note("d'4"):
    Staff("{ c'4 d'4 { { <e' g'>16 gs'16 a'16 as'16 } { e'4 } } f'4 }")
Container("{ <e' g'>16 gs'16 a'16 as'16 } { e'4 }"):
    Staff("{ c'4 d'4 { { <e' g'>16 gs'16 a'16 as'16 } { e'4 } } f'4 }")
OnBeatGraceContainer("<e' g'>16 gs'16 a'16 as'16"):
    Staff("{ c'4 d'4 { { <e' g'>16 gs'16 a'16 as'16 } { e'4 } } f'4 }")
Chord("<e' g'>16"):
    Staff("{ c'4 d'4 { { <e' g'>16 gs'16 a'16 as'16 } { e'4 } } f'4 }")
Note("gs'16"):
    Staff("{ c'4 d'4 { { <e' g'>16 gs'16 a'16 as'16 } { e'4 } } f'4 }")
Note("a'16"):
    Staff("{ c'4 d'4 { { <e' g'>16 gs'16 a'16 as'16 } { e'4 } } f'4 }")
Note("as'16"):
    Staff("{ c'4 d'4 { { <e' g'>16 gs'16 a'16 as'16 } { e'4 } } f'4 }")
Voice("e'4", name='MusicVoice'):
    Staff("{ c'4 d'4 { { <e' g'>16 gs'16 a'16 as'16 } { e'4 } } f'4 }")
Note("e'4"):
    Staff("{ c'4 d'4 { { <e' g'>16 gs'16 a'16 as'16 } { e'4 } } f'4 }")
Note("f'4"):
    Staff("{ c'4 d'4 { { <e' g'>16 gs'16 a'16 as'16 } { e'4 } } f'4 }")
AfterGraceContainer("fs'16"):
    Staff("{ c'4 d'4 { { <e' g'>16 gs'16 a'16 as'16 } { e'4 } } f'4 }")
Note("fs'16"):
    Staff("{ c'4 d'4 { { <e' g'>16 gs'16 a'16 as'16 } { e'4 } } f'4 }")

Return type:: Optional[Staff]

abjad.get.effective_wrapper(argument, prototype, *, attributes=None, n=0)[source]¶

Gets effective wrapper.

REGRESSION. Works with grace notes (and containers):

>>> music_voice = abjad.Voice("c'4 d' e' f'", name="MusicVoice")
>>> staff = abjad.Staff([music_voice])
>>> container = abjad.BeforeGraceContainer("cs'16")
>>> abjad.attach(container, music_voice[1])
>>> container = abjad.on_beat_grace_container("g'16 gs' a' as'", music_voice[2:3])
>>> abjad.attach(abjad.Clef("alto"), container[0])
>>> abjad.attach(abjad.Articulation(">"), container[0])
>>> container = abjad.AfterGraceContainer("fs'16")
>>> abjad.attach(container, music_voice[3])
>>> lilypond_file = abjad.LilyPondFile([r'\include "abjad.ily"', staff])
>>> abjad.show(lilypond_file)  

>>> for component in abjad.select.components(staff):
...     wrapper = abjad.get.effective_wrapper(component, abjad.Clef)
...     print(f"{repr(component):}")
...     print(f"    {repr(wrapper)}")
... 
Staff("{ c'4 d'4 { { <e' g'>16 gs'16 a'16 as'16 } { e'4 } } f'4 }")
    None
Voice("c'4 d'4 { { <e' g'>16 gs'16 a'16 as'16 } { e'4 } } f'4", name='MusicVoice')
    None
Note("c'4")
    None
BeforeGraceContainer("cs'16")
    None
Note("cs'16")
    None
Note("d'4")
    None
Container("{ <e' g'>16 gs'16 a'16 as'16 } { e'4 }")
    Wrapper(annotation=None, context='Staff', deactivate=False, direction=None, indicator=Clef(name='alto', hide=False), synthetic_offset=None, tag=Tag(string=''))
OnBeatGraceContainer("<e' g'>16 gs'16 a'16 as'16")
    Wrapper(annotation=None, context='Staff', deactivate=False, direction=None, indicator=Clef(name='alto', hide=False), synthetic_offset=None, tag=Tag(string=''))
Chord("<e' g'>16")
    Wrapper(annotation=None, context='Staff', deactivate=False, direction=None, indicator=Clef(name='alto', hide=False), synthetic_offset=None, tag=Tag(string=''))
Note("gs'16")
    Wrapper(annotation=None, context='Staff', deactivate=False, direction=None, indicator=Clef(name='alto', hide=False), synthetic_offset=None, tag=Tag(string=''))
Note("a'16")
    Wrapper(annotation=None, context='Staff', deactivate=False, direction=None, indicator=Clef(name='alto', hide=False), synthetic_offset=None, tag=Tag(string=''))
Note("as'16")
    Wrapper(annotation=None, context='Staff', deactivate=False, direction=None, indicator=Clef(name='alto', hide=False), synthetic_offset=None, tag=Tag(string=''))
Voice("e'4", name='MusicVoice')
    Wrapper(annotation=None, context='Staff', deactivate=False, direction=None, indicator=Clef(name='alto', hide=False), synthetic_offset=None, tag=Tag(string=''))
Note("e'4")
    Wrapper(annotation=None, context='Staff', deactivate=False, direction=None, indicator=Clef(name='alto', hide=False), synthetic_offset=None, tag=Tag(string=''))
Note("f'4")
    Wrapper(annotation=None, context='Staff', deactivate=False, direction=None, indicator=Clef(name='alto', hide=False), synthetic_offset=None, tag=Tag(string=''))
AfterGraceContainer("fs'16")
    Wrapper(annotation=None, context='Staff', deactivate=False, direction=None, indicator=Clef(name='alto', hide=False), synthetic_offset=None, tag=Tag(string=''))
Note("fs'16")
    Wrapper(annotation=None, context='Staff', deactivate=False, direction=None, indicator=Clef(name='alto', hide=False), synthetic_offset=None, tag=Tag(string=''))

abjad.get.grace(argument)[source]¶

Is true when argument is grace music.

Grace music defined equal to grace container, after-grace container and contents of those containers.

REGRESSION. Works with grace notes (and containers):

>>> music_voice = abjad.Voice("c'4 d' e' f'", name="MusicVoice")
>>> container = abjad.BeforeGraceContainer("cs'16")
>>> abjad.attach(container, music_voice[1])
>>> container = abjad.on_beat_grace_container("g'16 gs' a' as'", music_voice[2:3])
>>> abjad.attach(abjad.Articulation(">"), container[0])
>>> container = abjad.AfterGraceContainer("fs'16")
>>> abjad.attach(container, music_voice[3])
>>> staff = abjad.Staff([music_voice])
>>> lilypond_file = abjad.LilyPondFile([r'\include "abjad.ily"', staff])
>>> abjad.show(lilypond_file)  

>>> for component in abjad.select.components(staff):
...     result = abjad.get.grace(component)
...     print(f"{repr(component):30} {repr(result)}")
... 
Staff("{ c'4 d'4 { { <e' g'>16 gs'16 a'16 as'16 } { e'4 } } f'4 }") False
Voice("c'4 d'4 { { <e' g'>16 gs'16 a'16 as'16 } { e'4 } } f'4", name='MusicVoice') False
Note("c'4")                    False
BeforeGraceContainer("cs'16")  True
Note("cs'16")                  True
Note("d'4")                    False
Container("{ <e' g'>16 gs'16 a'16 as'16 } { e'4 }") False
OnBeatGraceContainer("<e' g'>16 gs'16 a'16 as'16") True
Chord("<e' g'>16")             True
Note("gs'16")                  True
Note("a'16")                   True
Note("as'16")                  True
Voice("e'4", name='MusicVoice') False
Note("e'4")                    False
Note("f'4")                    False
AfterGraceContainer("fs'16")   True
Note("fs'16")                  True

Return type:: bool

abjad.get.has_effective_indicator(argument, prototype=None, *, attributes=None)[source]¶

Is true when argument has effective indicator.

REGRESSION. Works with grace notes (and containers):

>>> music_voice = abjad.Voice("c'4 d' e' f'", name="MusicVoice")
>>> staff = abjad.Staff([music_voice])
>>> container = abjad.BeforeGraceContainer("cs'16")
>>> abjad.attach(container, music_voice[1])
>>> container = abjad.on_beat_grace_container("g'16 gs' a' as'", music_voice[2:3])
>>> abjad.attach(abjad.Clef("alto"), container[0])
>>> abjad.attach(abjad.Articulation(">"), container[0])
>>> container = abjad.AfterGraceContainer("fs'16")
>>> abjad.attach(container, music_voice[3])
>>> lilypond_file = abjad.LilyPondFile([r'\include "abjad.ily"', staff])
>>> abjad.show(lilypond_file)  

>>> for component in abjad.select.components(staff):
...     function = abjad.get.has_effective_indicator
...     result = function(component, abjad.Clef)
...     print(f"{repr(component):30} {repr(result)}")
... 
Staff("{ c'4 d'4 { { <e' g'>16 gs'16 a'16 as'16 } { e'4 } } f'4 }") False
Voice("c'4 d'4 { { <e' g'>16 gs'16 a'16 as'16 } { e'4 } } f'4", name='MusicVoice') False
Note("c'4")                    False
BeforeGraceContainer("cs'16")  False
Note("cs'16")                  False
Note("d'4")                    False
Container("{ <e' g'>16 gs'16 a'16 as'16 } { e'4 }") True
OnBeatGraceContainer("<e' g'>16 gs'16 a'16 as'16") True
Chord("<e' g'>16")             True
Note("gs'16")                  True
Note("a'16")                   True
Note("as'16")                  True
Voice("e'4", name='MusicVoice') True
Note("e'4")                    True
Note("f'4")                    True
AfterGraceContainer("fs'16")   True
Note("fs'16")                  True

REGRESSSION. Works with tremolo containers:

>>> staff = abjad.Staff()
>>> staff.append(abjad.TremoloContainer(2, "c'16 e'"))
>>> staff.append("cs'4")
>>> staff.append(abjad.TremoloContainer(2, "d'16 f'"))
>>> abjad.attach(abjad.Clef("alto"), staff[-1][0])
>>> staff.append("ds'4")
>>> abjad.show(staff)  

>>> for component in abjad.select.components(staff):
...     function = abjad.get.has_effective_indicator
...     result = function(component, abjad.Clef)
...     print(f"{repr(component):30} {repr(result)}")
... 
Staff("{ c'16 e'16 } cs'4 { d'16 f'16 } ds'4") False
TremoloContainer("c'16 e'16")  False
Note("c'16")                   False
Note("e'16")                   False
Note("cs'4")                   False
TremoloContainer("d'16 f'16")  True
Note("d'16")                   True
Note("f'16")                   True
Note("ds'4")                   True

Return type:: bool

abjad.get.has_indicator(argument, prototype=None, *, attributes=None)[source]¶

Is true when argument has one or more indicators.

REGRESSION. Works with grace notes (and containers):

>>> music_voice = abjad.Voice("c'4 d' e' f'", name="MusicVoice")
>>> staff = abjad.Staff([music_voice])
>>> container = abjad.BeforeGraceContainer("cs'16")
>>> abjad.attach(container, music_voice[1])
>>> container = abjad.on_beat_grace_container("g'16 gs' a' as'", music_voice[2:3])
>>> abjad.attach(abjad.Clef("alto"), container[0])
>>> abjad.attach(abjad.Articulation(">"), container[0])
>>> container = abjad.AfterGraceContainer("fs'16")
>>> abjad.attach(container, music_voice[3])
>>> lilypond_file = abjad.LilyPondFile([r'\include "abjad.ily"', staff])
>>> abjad.show(lilypond_file)  

>>> for component in abjad.select.components(staff):
...     result = abjad.get.has_indicator(component, abjad.Clef)
...     print(f"{repr(component):30} {repr(result)}")
... 
Staff("{ c'4 d'4 { { <e' g'>16 gs'16 a'16 as'16 } { e'4 } } f'4 }") False
Voice("c'4 d'4 { { <e' g'>16 gs'16 a'16 as'16 } { e'4 } } f'4", name='MusicVoice') False
Note("c'4")                    False
BeforeGraceContainer("cs'16")  False
Note("cs'16")                  False
Note("d'4")                    False
Container("{ <e' g'>16 gs'16 a'16 as'16 } { e'4 }") False
OnBeatGraceContainer("<e' g'>16 gs'16 a'16 as'16") False
Chord("<e' g'>16")             True
Note("gs'16")                  False
Note("a'16")                   False
Note("as'16")                  False
Voice("e'4", name='MusicVoice') False
Note("e'4")                    False
Note("f'4")                    False
AfterGraceContainer("fs'16")   False
Note("fs'16")                  False

REGRESSSION. Works with tremolo containers:

>>> staff = abjad.Staff()
>>> staff.append(abjad.TremoloContainer(2, "c'16 e'"))
>>> staff.append("cs'4")
>>> staff.append(abjad.TremoloContainer(2, "d'16 f'"))
>>> abjad.attach(abjad.Clef("alto"), staff[-1][0])
>>> staff.append("ds'4")
>>> abjad.show(staff)  

>>> for component in abjad.select.components(staff):
...     result = abjad.get.has_indicator(component, abjad.Clef)
...     print(f"{repr(component):30} {repr(result)}")
... 
Staff("{ c'16 e'16 } cs'4 { d'16 f'16 } ds'4") False
TremoloContainer("c'16 e'16")  False
Note("c'16")                   False
Note("e'16")                   False
Note("cs'4")                   False
TremoloContainer("d'16 f'16")  False
Note("d'16")                   True
Note("f'16")                   False
Note("ds'4")                   False

Set attributes dictionary to test indicator attributes:

>>> voice = abjad.Voice("c'4 c'4 c'4 c'4")
>>> staff = abjad.Staff([voice], name="Staff")
>>> abjad.attach(abjad.Clef("treble"), voice[0])
>>> abjad.attach(abjad.Clef("alto"), voice[2])
>>> abjad.show(voice)  

>>> attributes = {"name": "alto"}
>>> abjad.get.has_indicator(voice[0], abjad.Clef)
True

>>> abjad.get.has_indicator(
...     voice[0],
...     abjad.Clef,
...     attributes=attributes,
... )
False

>>> abjad.get.has_indicator(voice[2], abjad.Clef)
True

>>> abjad.get.has_indicator(
...     voice[2],
...     abjad.Clef,
...     attributes=attributes,
... )
True

Return type:: bool

abjad.get.indicator(argument, prototype=None, *, default=None, unwrap=True)[source]¶

Gets indicator.

REGRESSION. Works with grace notes (and containers):

>>> music_voice = abjad.Voice("c'4 d' e' f'", name="MusicVoice")
>>> staff = abjad.Staff([music_voice])
>>> container = abjad.BeforeGraceContainer("cs'16")
>>> abjad.attach(container, music_voice[1])
>>> container = abjad.on_beat_grace_container("g'16 gs' a' as'", music_voice[2:3])
>>> abjad.attach(abjad.Clef("alto"), container[0])
>>> abjad.attach(abjad.Articulation(">"), container[0])
>>> container = abjad.AfterGraceContainer("fs'16")
>>> abjad.attach(container, music_voice[3])
>>> lilypond_file = abjad.LilyPondFile([r'\include "abjad.ily"', staff])
>>> abjad.show(lilypond_file)  

>>> for component in abjad.select.components(staff):
...     result = abjad.get.indicator(component, abjad.Clef)
...     print(f"{repr(component):30} {repr(result)}")
... 
Staff("{ c'4 d'4 { { <e' g'>16 gs'16 a'16 as'16 } { e'4 } } f'4 }") None
Voice("c'4 d'4 { { <e' g'>16 gs'16 a'16 as'16 } { e'4 } } f'4", name='MusicVoice') None
Note("c'4")                    None
BeforeGraceContainer("cs'16")  None
Note("cs'16")                  None
Note("d'4")                    None
Container("{ <e' g'>16 gs'16 a'16 as'16 } { e'4 }") None
OnBeatGraceContainer("<e' g'>16 gs'16 a'16 as'16") None
Chord("<e' g'>16")             Clef(name='alto', hide=False)
Note("gs'16")                  None
Note("a'16")                   None
Note("as'16")                  None
Voice("e'4", name='MusicVoice') None
Note("e'4")                    None
Note("f'4")                    None
AfterGraceContainer("fs'16")   None
Note("fs'16")                  None

REGRESSSION. Works with tremolo containers:

>>> staff = abjad.Staff()
>>> staff.append(abjad.TremoloContainer(2, "c'16 e'"))
>>> staff.append("cs'4")
>>> staff.append(abjad.TremoloContainer(2, "d'16 f'"))
>>> abjad.attach(abjad.Clef("alto"), staff[-1][0])
>>> staff.append("ds'4")
>>> abjad.show(staff)  

>>> for component in abjad.select.components(staff):
...     result = abjad.get.indicator(component, abjad.Clef)
...     print(f"{repr(component):30} {repr(result)}")
... 
Staff("{ c'16 e'16 } cs'4 { d'16 f'16 } ds'4") None
TremoloContainer("c'16 e'16")  None
Note("c'16")                   None
Note("e'16")                   None
Note("cs'4")                   None
TremoloContainer("d'16 f'16")  None
Note("d'16")                   Clef(name='alto', hide=False)
Note("f'16")                   None
Note("ds'4")                   None

Raises exception when more than one indicator of prototype attach to argument.

Returns default when no indicator of prototype attaches to argument.

Return type:: Any

abjad.get.indicators(argument, prototype=None, *, attributes=None, unwrap=True)[source]¶

Get indicators.

REGRESSION. Works with grace notes (and containers):

>>> music_voice = abjad.Voice("c'4 d' e' f'", name="MusicVoice")
>>> staff = abjad.Staff([music_voice])
>>> container = abjad.BeforeGraceContainer("cs'16")
>>> abjad.attach(container, music_voice[1])
>>> container = abjad.on_beat_grace_container("g'16 gs' a' as'", music_voice[2:3])
>>> abjad.attach(abjad.Clef("alto"), container[0])
>>> abjad.attach(abjad.Articulation(">"), container[0])
>>> container = abjad.AfterGraceContainer("fs'16")
>>> abjad.attach(container, music_voice[3])
>>> for note in abjad.select.notes(staff):
...     abjad.attach(abjad.Articulation("."), note)
... 

>>> lilypond_file = abjad.LilyPondFile([r'\include "abjad.ily"', staff])
>>> abjad.show(lilypond_file)  

>>> for component in abjad.select.components(staff):
...     result = abjad.get.indicators(component)
...     print(f"{component!r}:")
...     print(f"    {result!r}")
... 
Staff("{ c'4 d'4 { { <e' g'>16 gs'16 a'16 as'16 } { e'4 } } f'4 }"):
    []
Voice("c'4 d'4 { { <e' g'>16 gs'16 a'16 as'16 } { e'4 } } f'4", name='MusicVoice'):
    []
Note("c'4"):
    [Articulation(name='.')]
BeforeGraceContainer("cs'16"):
    []
Note("cs'16"):
    [Articulation(name='.')]
Note("d'4"):
    [Articulation(name='.')]
Container("{ <e' g'>16 gs'16 a'16 as'16 } { e'4 }"):
    []
OnBeatGraceContainer("<e' g'>16 gs'16 a'16 as'16"):
    []
Chord("<e' g'>16"):
    [LilyPondLiteral(argument='\\set fontSize = #-3', site='before', directed=False), StartBeam(), LilyPondLiteral(argument='\\slash', site='before', directed=False), StartSlur(), VoiceNumber(n=1, leak=False), Clef(name='alto', hide=False), Articulation(name='>')]
Note("gs'16"):
    [Articulation(name='.')]
Note("a'16"):
    [Articulation(name='.')]
Note("as'16"):
    [StopBeam(leak=False), StopSlur(leak=False), Articulation(name='.')]
Voice("e'4", name='MusicVoice'):
    []
Note("e'4"):
    [VoiceNumber(n=2, leak=False), Articulation(name='.')]
Note("f'4"):
    [VoiceNumber(n=None, leak=False), Articulation(name='.')]
AfterGraceContainer("fs'16"):
    []
Note("fs'16"):
    [Articulation(name='.')]

REGRESSSION. Works with tremolo containers:

>>> staff = abjad.Staff()
>>> staff.append(abjad.TremoloContainer(2, "c'16 e'"))
>>> staff.append("cs'4")
>>> staff.append(abjad.TremoloContainer(2, "d'16 f'"))
>>> abjad.attach(abjad.Clef("alto"), staff[-1][0])
>>> staff.append("ds'4")
>>> for note in abjad.select.notes(staff):
...     abjad.attach(abjad.Articulation("."), note)
... 

>>> abjad.show(staff)  

>>> for component in abjad.select.components(staff):
...     result = abjad.get.indicators(component)
...     print(f"{repr(component):30} {repr(result)}")
... 
Staff("{ c'16 e'16 } cs'4 { d'16 f'16 } ds'4") []
TremoloContainer("c'16 e'16")  []
Note("c'16")                   [Articulation(name='.')]
Note("e'16")                   [Articulation(name='.')]
Note("cs'4")                   [Articulation(name='.')]
TremoloContainer("d'16 f'16")  []
Note("d'16")                   [Clef(name='alto', hide=False), Articulation(name='.')]
Note("f'16")                   [Articulation(name='.')]
Note("ds'4")                   [Articulation(name='.')]

Return type:: list

abjad.get.leaf(argument, n=0)[source]¶

Gets leaf n.

n constrained to -1, 0, 1 for previous, current, next leaf.

>>> staff = abjad.Staff()
>>> staff.append(abjad.Voice("c'8 d'8 e'8 f'8"))
>>> staff.append(abjad.Voice("g'8 a'8 b'8 c''8"))
>>> abjad.show(staff)  

Gets leaf FROM argument when argument is a leaf:

>>> leaf = staff[0][1]

>>> abjad.get.leaf(leaf, -1)
Note("c'8")

>>> abjad.get.leaf(leaf, 0)
Note("d'8")

>>> abjad.get.leaf(leaf, 1)
Note("e'8")

Gets leaf IN argument when argument is a container:

>>> voice = staff[0]

>>> abjad.get.leaf(voice, -1)
Note("f'8")

>>> abjad.get.leaf(voice, 0)
Note("c'8")

>>> abjad.get.leaf(voice, 1)
Note("d'8")

REGRESSION. Works with grace notes (and containers):

>>> music_voice = abjad.Voice("c'4 d' e' f'", name="MusicVoice")
>>> staff = abjad.Staff([music_voice])
>>> container = abjad.BeforeGraceContainer("cs'16")
>>> abjad.attach(container, music_voice[1])
>>> container = abjad.on_beat_grace_container("g'16 gs' a' as'", music_voice[2:3])
>>> abjad.attach(abjad.Clef("alto"), container[0])
>>> abjad.attach(abjad.Articulation(">"), container[0])
>>> container = abjad.AfterGraceContainer("fs'16")
>>> abjad.attach(container, music_voice[3])
>>> lilypond_file = abjad.LilyPondFile([r'\include "abjad.ily"', staff])
>>> abjad.show(lilypond_file)  

>>> for current_leaf in abjad.select.leaves(staff):
...     previous_leaf = abjad.get.leaf(current_leaf, -1)
...     next_leaf = abjad.get.leaf(current_leaf, 1)
...     print(f"previous leaf: {repr(previous_leaf)}")
...     print(f"current leaf:  {repr(current_leaf)}")
...     print(f"next leaf:     {repr(next_leaf)}")
...     print("---")
... 
previous leaf: None
current leaf:  Note("c'4")
next leaf:     Note("cs'16")
---
previous leaf: Note("c'4")
current leaf:  Note("cs'16")
next leaf:     Note("d'4")
---
previous leaf: Note("cs'16")
current leaf:  Note("d'4")
next leaf:     Chord("<e' g'>16")
---
previous leaf: Note("d'4")
current leaf:  Chord("<e' g'>16")
next leaf:     Note("gs'16")
---
previous leaf: Chord("<e' g'>16")
current leaf:  Note("gs'16")
next leaf:     Note("a'16")
---
previous leaf: Note("gs'16")
current leaf:  Note("a'16")
next leaf:     Note("as'16")
---
previous leaf: Note("a'16")
current leaf:  Note("as'16")
next leaf:     Note("e'4")
---
previous leaf: Note("as'16")
current leaf:  Note("e'4")
next leaf:     Note("f'4")
---
previous leaf: Note("e'4")
current leaf:  Note("f'4")
next leaf:     Note("fs'16")
---
previous leaf: Note("f'4")
current leaf:  Note("fs'16")
next leaf:     None
---

REGRESSSION. Works with tremolo containers:

>>> staff = abjad.Staff()
>>> staff.append(abjad.TremoloContainer(2, "c'16 e'"))
>>> staff.append("cs'4")
>>> staff.append(abjad.TremoloContainer(2, "d'16 f'"))
>>> staff.append("ds'4")
>>> abjad.show(staff)  

>>> for current_leaf in abjad.select.leaves(staff):
...     previous_leaf = abjad.get.leaf(current_leaf, -1)
...     next_leaf = abjad.get.leaf(current_leaf, 1)
...     print(f"previous leaf: {repr(previous_leaf)}")
...     print(f"current leaf:  {repr(current_leaf)}")
...     print(f"next leaf:     {repr(next_leaf)}")
...     print("---")
... 
previous leaf: None
current leaf:  Note("c'16")
next leaf:     Note("e'16")
---
previous leaf: Note("c'16")
current leaf:  Note("e'16")
next leaf:     Note("cs'4")
---
previous leaf: Note("e'16")
current leaf:  Note("cs'4")
next leaf:     Note("d'16")
---
previous leaf: Note("cs'4")
current leaf:  Note("d'16")
next leaf:     Note("f'16")
---
previous leaf: Note("d'16")
current leaf:  Note("f'16")
next leaf:     Note("ds'4")
---
previous leaf: Note("f'16")
current leaf:  Note("ds'4")
next leaf:     None
---

Return type:: Optional[Leaf]

abjad.get.lineage(argument)[source]¶

Gets lineage.

REGRESSION. Works with grace notes (and containers):

>>> music_voice = abjad.Voice("c'4 d' e' f'", name="MusicVoice")
>>> container = abjad.BeforeGraceContainer("cs'16")
>>> abjad.attach(container, music_voice[1])
>>> container = abjad.on_beat_grace_container("g'16 gs' a' as'", music_voice[2:3])
>>> abjad.attach(abjad.Articulation(">"), container[0])
>>> container = abjad.AfterGraceContainer("fs'16")
>>> abjad.attach(container, music_voice[3])
>>> staff = abjad.Staff([music_voice])
>>> lilypond_file = abjad.LilyPondFile([r'\include "abjad.ily"', staff])
>>> abjad.show(lilypond_file)  

>>> for component in abjad.select.components(staff):
...     lineage = abjad.get.lineage(component)
...     print(f"{repr(component)}:")
...     for component_ in lineage:
...         print(f"    {repr(component_)}")
... 
Staff("{ c'4 d'4 { { <e' g'>16 gs'16 a'16 as'16 } { e'4 } } f'4 }"):
    Staff("{ c'4 d'4 { { <e' g'>16 gs'16 a'16 as'16 } { e'4 } } f'4 }")
    Voice("c'4 d'4 { { <e' g'>16 gs'16 a'16 as'16 } { e'4 } } f'4", name='MusicVoice')
    Note("c'4")
    BeforeGraceContainer("cs'16")
    Note("cs'16")
    Note("d'4")
    Container("{ <e' g'>16 gs'16 a'16 as'16 } { e'4 }")
    OnBeatGraceContainer("<e' g'>16 gs'16 a'16 as'16")
    Chord("<e' g'>16")
    Note("gs'16")
    Note("a'16")
    Note("as'16")
    Voice("e'4", name='MusicVoice')
    Note("e'4")
    Note("f'4")
    AfterGraceContainer("fs'16")
    Note("fs'16")
Voice("c'4 d'4 { { <e' g'>16 gs'16 a'16 as'16 } { e'4 } } f'4", name='MusicVoice'):
    Staff("{ c'4 d'4 { { <e' g'>16 gs'16 a'16 as'16 } { e'4 } } f'4 }")
    Voice("c'4 d'4 { { <e' g'>16 gs'16 a'16 as'16 } { e'4 } } f'4", name='MusicVoice')
    Note("c'4")
    BeforeGraceContainer("cs'16")
    Note("cs'16")
    Note("d'4")
    Container("{ <e' g'>16 gs'16 a'16 as'16 } { e'4 }")
    OnBeatGraceContainer("<e' g'>16 gs'16 a'16 as'16")
    Chord("<e' g'>16")
    Note("gs'16")
    Note("a'16")
    Note("as'16")
    Voice("e'4", name='MusicVoice')
    Note("e'4")
    Note("f'4")
    AfterGraceContainer("fs'16")
    Note("fs'16")
Note("c'4"):
    Staff("{ c'4 d'4 { { <e' g'>16 gs'16 a'16 as'16 } { e'4 } } f'4 }")
    Voice("c'4 d'4 { { <e' g'>16 gs'16 a'16 as'16 } { e'4 } } f'4", name='MusicVoice')
    Note("c'4")
BeforeGraceContainer("cs'16"):
    Staff("{ c'4 d'4 { { <e' g'>16 gs'16 a'16 as'16 } { e'4 } } f'4 }")
    Voice("c'4 d'4 { { <e' g'>16 gs'16 a'16 as'16 } { e'4 } } f'4", name='MusicVoice')
    BeforeGraceContainer("cs'16")
    Note("cs'16")
Note("cs'16"):
    Staff("{ c'4 d'4 { { <e' g'>16 gs'16 a'16 as'16 } { e'4 } } f'4 }")
    Voice("c'4 d'4 { { <e' g'>16 gs'16 a'16 as'16 } { e'4 } } f'4", name='MusicVoice')
    BeforeGraceContainer("cs'16")
    Note("cs'16")
Note("d'4"):
    Staff("{ c'4 d'4 { { <e' g'>16 gs'16 a'16 as'16 } { e'4 } } f'4 }")
    Voice("c'4 d'4 { { <e' g'>16 gs'16 a'16 as'16 } { e'4 } } f'4", name='MusicVoice')
    Note("d'4")
Container("{ <e' g'>16 gs'16 a'16 as'16 } { e'4 }"):
    Staff("{ c'4 d'4 { { <e' g'>16 gs'16 a'16 as'16 } { e'4 } } f'4 }")
    Voice("c'4 d'4 { { <e' g'>16 gs'16 a'16 as'16 } { e'4 } } f'4", name='MusicVoice')
    Container("{ <e' g'>16 gs'16 a'16 as'16 } { e'4 }")
    OnBeatGraceContainer("<e' g'>16 gs'16 a'16 as'16")
    Chord("<e' g'>16")
    Note("gs'16")
    Note("a'16")
    Note("as'16")
    Voice("e'4", name='MusicVoice')
    Note("e'4")
OnBeatGraceContainer("<e' g'>16 gs'16 a'16 as'16"):
    Staff("{ c'4 d'4 { { <e' g'>16 gs'16 a'16 as'16 } { e'4 } } f'4 }")
    Voice("c'4 d'4 { { <e' g'>16 gs'16 a'16 as'16 } { e'4 } } f'4", name='MusicVoice')
    Container("{ <e' g'>16 gs'16 a'16 as'16 } { e'4 }")
    OnBeatGraceContainer("<e' g'>16 gs'16 a'16 as'16")
    Chord("<e' g'>16")
    Note("gs'16")
    Note("a'16")
    Note("as'16")
Chord("<e' g'>16"):
    Staff("{ c'4 d'4 { { <e' g'>16 gs'16 a'16 as'16 } { e'4 } } f'4 }")
    Voice("c'4 d'4 { { <e' g'>16 gs'16 a'16 as'16 } { e'4 } } f'4", name='MusicVoice')
    Container("{ <e' g'>16 gs'16 a'16 as'16 } { e'4 }")
    OnBeatGraceContainer("<e' g'>16 gs'16 a'16 as'16")
    Chord("<e' g'>16")
Note("gs'16"):
    Staff("{ c'4 d'4 { { <e' g'>16 gs'16 a'16 as'16 } { e'4 } } f'4 }")
    Voice("c'4 d'4 { { <e' g'>16 gs'16 a'16 as'16 } { e'4 } } f'4", name='MusicVoice')
    Container("{ <e' g'>16 gs'16 a'16 as'16 } { e'4 }")
    OnBeatGraceContainer("<e' g'>16 gs'16 a'16 as'16")
    Note("gs'16")
Note("a'16"):
    Staff("{ c'4 d'4 { { <e' g'>16 gs'16 a'16 as'16 } { e'4 } } f'4 }")
    Voice("c'4 d'4 { { <e' g'>16 gs'16 a'16 as'16 } { e'4 } } f'4", name='MusicVoice')
    Container("{ <e' g'>16 gs'16 a'16 as'16 } { e'4 }")
    OnBeatGraceContainer("<e' g'>16 gs'16 a'16 as'16")
    Note("a'16")
Note("as'16"):
    Staff("{ c'4 d'4 { { <e' g'>16 gs'16 a'16 as'16 } { e'4 } } f'4 }")
    Voice("c'4 d'4 { { <e' g'>16 gs'16 a'16 as'16 } { e'4 } } f'4", name='MusicVoice')
    Container("{ <e' g'>16 gs'16 a'16 as'16 } { e'4 }")
    OnBeatGraceContainer("<e' g'>16 gs'16 a'16 as'16")
    Note("as'16")
Voice("e'4", name='MusicVoice'):
    Staff("{ c'4 d'4 { { <e' g'>16 gs'16 a'16 as'16 } { e'4 } } f'4 }")
    Voice("c'4 d'4 { { <e' g'>16 gs'16 a'16 as'16 } { e'4 } } f'4", name='MusicVoice')
    Container("{ <e' g'>16 gs'16 a'16 as'16 } { e'4 }")
    Voice("e'4", name='MusicVoice')
    Note("e'4")
Note("e'4"):
    Staff("{ c'4 d'4 { { <e' g'>16 gs'16 a'16 as'16 } { e'4 } } f'4 }")
    Voice("c'4 d'4 { { <e' g'>16 gs'16 a'16 as'16 } { e'4 } } f'4", name='MusicVoice')
    Container("{ <e' g'>16 gs'16 a'16 as'16 } { e'4 }")
    Voice("e'4", name='MusicVoice')
    Note("e'4")
Note("f'4"):
    Staff("{ c'4 d'4 { { <e' g'>16 gs'16 a'16 as'16 } { e'4 } } f'4 }")
    Voice("c'4 d'4 { { <e' g'>16 gs'16 a'16 as'16 } { e'4 } } f'4", name='MusicVoice')
    Note("f'4")
AfterGraceContainer("fs'16"):
    Staff("{ c'4 d'4 { { <e' g'>16 gs'16 a'16 as'16 } { e'4 } } f'4 }")
    Voice("c'4 d'4 { { <e' g'>16 gs'16 a'16 as'16 } { e'4 } } f'4", name='MusicVoice')
    AfterGraceContainer("fs'16")
    Note("fs'16")
Note("fs'16"):
    Staff("{ c'4 d'4 { { <e' g'>16 gs'16 a'16 as'16 } { e'4 } } f'4 }")
    Voice("c'4 d'4 { { <e' g'>16 gs'16 a'16 as'16 } { e'4 } } f'4", name='MusicVoice')
    AfterGraceContainer("fs'16")
    Note("fs'16")

Return type:: Lineage

abjad.get.logical_tie(argument)[source]¶

Gets logical tie.

REGRESSION. Works with grace notes (and containers):

>>> music_voice = abjad.Voice("c'4 d' e' f'", name="MusicVoice")
>>> container = abjad.BeforeGraceContainer("cs'16")
>>> abjad.attach(container, music_voice[1])
>>> container = abjad.on_beat_grace_container("g'16 gs' a' as'", music_voice[2:3])
>>> abjad.attach(abjad.Articulation(">"), container[0])
>>> container = abjad.AfterGraceContainer("fs'16")
>>> abjad.attach(container, music_voice[3])
>>> staff = abjad.Staff([music_voice])
>>> lilypond_file = abjad.LilyPondFile([r'\include "abjad.ily"', staff])
>>> abjad.show(lilypond_file)  

>>> for leaf in abjad.select.leaves(staff):
...     lt = abjad.get.logical_tie(leaf)
...     print(f"{repr(leaf):30} {repr(lt)}")
... 
Note("c'4")                    LogicalTie(items=[Note("c'4")])
Note("cs'16")                  LogicalTie(items=[Note("cs'16")])
Note("d'4")                    LogicalTie(items=[Note("d'4")])
Chord("<e' g'>16")             LogicalTie(items=[Chord("<e' g'>16")])
Note("gs'16")                  LogicalTie(items=[Note("gs'16")])
Note("a'16")                   LogicalTie(items=[Note("a'16")])
Note("as'16")                  LogicalTie(items=[Note("as'16")])
Note("e'4")                    LogicalTie(items=[Note("e'4")])
Note("f'4")                    LogicalTie(items=[Note("f'4")])
Note("fs'16")                  LogicalTie(items=[Note("fs'16")])

REGRESSSION. Works with tremolo containers:

>>> staff = abjad.Staff()
>>> staff.append(abjad.TremoloContainer(2, "c'16 e'"))
>>> staff.append("cs'4")
>>> staff.append(abjad.TremoloContainer(2, "d'16 f'"))
>>> staff.append("ds'4")
>>> abjad.show(staff)  

>>> for leaf in abjad.select.leaves(staff):
...     lt = abjad.get.logical_tie(leaf)
...     print(f"{repr(leaf):30} {repr(lt)}")
... 
Note("c'16")                   LogicalTie(items=[Note("c'16")])
Note("e'16")                   LogicalTie(items=[Note("e'16")])
Note("cs'4")                   LogicalTie(items=[Note("cs'4")])
Note("d'16")                   LogicalTie(items=[Note("d'16")])
Note("f'16")                   LogicalTie(items=[Note("f'16")])
Note("ds'4")                   LogicalTie(items=[Note("ds'4")])

REGRESSSION. Omits spurious rest when user ties from note to rest:

>>> staff = abjad.Staff("c'4 r4")
>>> # user error; shouldn't tie note to rest:
>>> abjad.attach(abjad.Tie(), staff[0])
>>> abjad.show(staff)  

>>> abjad.get.logical_tie(staff[0])
LogicalTie(items=[Note("c'4")])

>>> abjad.get.logical_tie(staff[1])
LogicalTie(items=[Rest('r4')])

Omits spurious rest when user repeat-ties into rest from note:

>>> voice = abjad.Voice("r4 c'4", name="Voice")
>>> # user error; shouldn't tie note to rest:
>>> abjad.attach(abjad.RepeatTie(), voice[1])
>>> abjad.show(voice)  

>>> abjad.get.logical_tie(voice[0])
LogicalTie(items=[Rest('r4')])

>>> abjad.get.logical_tie(voice[1])
LogicalTie(items=[Note("c'4")])

Return type:: LogicalTie

abjad.get.markup(argument, *, direction=None)[source]¶

Gets markup.

Return type:: list[Markup]

abjad.get.measure_number(argument)[source]¶

Gets measure number.

REGRESSION. Works with grace notes (and containers):

>>> music_voice = abjad.Voice("c'4 d' e' f'", name="MusicVoice")
>>> container = abjad.BeforeGraceContainer("cs'16")
>>> abjad.attach(container, music_voice[1])
>>> container = abjad.on_beat_grace_container("g'16 gs' a' as'", music_voice[2:3])
>>> abjad.attach(abjad.Articulation(">"), container[0])
>>> container = abjad.AfterGraceContainer("fs'16")
>>> abjad.attach(container, music_voice[3])
>>> staff = abjad.Staff([music_voice])
>>> lilypond_file = abjad.LilyPondFile([r'\include "abjad.ily"', staff])
>>> abjad.show(lilypond_file)  

>>> for component in abjad.select.components(staff):
...     measure_number = abjad.get.measure_number(component)
...     print(f"{repr(component):30} {measure_number}")
... 
Staff("{ c'4 d'4 { { <e' g'>16 gs'16 a'16 as'16 } { e'4 } } f'4 }") 1
Voice("c'4 d'4 { { <e' g'>16 gs'16 a'16 as'16 } { e'4 } } f'4", name='MusicVoice') 1
Note("c'4")                    1
BeforeGraceContainer("cs'16")  1
Note("cs'16")                  1
Note("d'4")                    1
Container("{ <e' g'>16 gs'16 a'16 as'16 } { e'4 }") 1
OnBeatGraceContainer("<e' g'>16 gs'16 a'16 as'16") 1
Chord("<e' g'>16")             1
Note("gs'16")                  1
Note("a'16")                   1
Note("as'16")                  1
Voice("e'4", name='MusicVoice') 1
Note("e'4")                    1
Note("f'4")                    1
AfterGraceContainer("fs'16")   1
Note("fs'16")                  1

REGRESSION. Measure number of score-initial grace notes is set equal to 0:

>>> voice = abjad.Voice("c'4 d' e' f'")
>>> container = abjad.BeforeGraceContainer("b16")
>>> abjad.attach(container, voice[0])
>>> abjad.show(voice)  

>>> for component in abjad.select.components(voice):
...     measure_number = abjad.get.measure_number(component)
...     print(f"{repr(component):30} {measure_number}")
... 
Voice("c'4 d'4 e'4 f'4")       1
BeforeGraceContainer('b16')    0
Note('b16')                    0
Note("c'4")                    1
Note("d'4")                    1
Note("e'4")                    1
Note("f'4")                    1

REGRESSSION. Works with tremolo containers:

>>> staff = abjad.Staff()
>>> staff.append(abjad.TremoloContainer(2, "c'16 e'"))
>>> staff.append("cs'4")
>>> staff.append(abjad.TremoloContainer(2, "d'16 f'"))
>>> staff.append("ds'4")
>>> abjad.show(staff)  

>>> for component in abjad.select.components(staff):
...     measure_number = abjad.get.measure_number(component)
...     print(f"{repr(component):30} {measure_number}")
... 
Staff("{ c'16 e'16 } cs'4 { d'16 f'16 } ds'4") 1
TremoloContainer("c'16 e'16")  1
Note("c'16")                   1
Note("e'16")                   1
Note("cs'4")                   1
TremoloContainer("d'16 f'16")  1
Note("d'16")                   1
Note("f'16")                   1
Note("ds'4")                   1

Return type:: int

abjad.get.parentage(argument)[source]¶

Gets parentage.

>>> music_voice = abjad.Voice("c'4 d' e' f'", name="MusicVoice")
>>> container = abjad.BeforeGraceContainer("cs'16")
>>> abjad.attach(container, music_voice[1])
>>> container = abjad.on_beat_grace_container("g'16 gs' a' as'", music_voice[2:3])
>>> abjad.attach(abjad.Articulation(">"), container[0])
>>> container = abjad.AfterGraceContainer("fs'16")
>>> abjad.attach(container, music_voice[3])
>>> staff = abjad.Staff([music_voice])
>>> lilypond_file = abjad.LilyPondFile([r'\include "abjad.ily"', staff])
>>> abjad.show(lilypond_file)  

>>> for component in abjad.select.components(staff):
...     parentage = abjad.get.parentage(component)
...     print(f"{repr(component)}:")
...     for component_ in parentage[:]:
...         print(f"    {repr(component_)}")
... 
Staff("{ c'4 d'4 { { <e' g'>16 gs'16 a'16 as'16 } { e'4 } } f'4 }"):
    Staff("{ c'4 d'4 { { <e' g'>16 gs'16 a'16 as'16 } { e'4 } } f'4 }")
Voice("c'4 d'4 { { <e' g'>16 gs'16 a'16 as'16 } { e'4 } } f'4", name='MusicVoice'):
    Voice("c'4 d'4 { { <e' g'>16 gs'16 a'16 as'16 } { e'4 } } f'4", name='MusicVoice')
    Staff("{ c'4 d'4 { { <e' g'>16 gs'16 a'16 as'16 } { e'4 } } f'4 }")
Note("c'4"):
    Note("c'4")
    Voice("c'4 d'4 { { <e' g'>16 gs'16 a'16 as'16 } { e'4 } } f'4", name='MusicVoice')
    Staff("{ c'4 d'4 { { <e' g'>16 gs'16 a'16 as'16 } { e'4 } } f'4 }")
BeforeGraceContainer("cs'16"):
    BeforeGraceContainer("cs'16")
    Voice("c'4 d'4 { { <e' g'>16 gs'16 a'16 as'16 } { e'4 } } f'4", name='MusicVoice')
    Staff("{ c'4 d'4 { { <e' g'>16 gs'16 a'16 as'16 } { e'4 } } f'4 }")
Note("cs'16"):
    Note("cs'16")
    BeforeGraceContainer("cs'16")
    Voice("c'4 d'4 { { <e' g'>16 gs'16 a'16 as'16 } { e'4 } } f'4", name='MusicVoice')
    Staff("{ c'4 d'4 { { <e' g'>16 gs'16 a'16 as'16 } { e'4 } } f'4 }")
Note("d'4"):
    Note("d'4")
    Voice("c'4 d'4 { { <e' g'>16 gs'16 a'16 as'16 } { e'4 } } f'4", name='MusicVoice')
    Staff("{ c'4 d'4 { { <e' g'>16 gs'16 a'16 as'16 } { e'4 } } f'4 }")
Container("{ <e' g'>16 gs'16 a'16 as'16 } { e'4 }"):
    Container("{ <e' g'>16 gs'16 a'16 as'16 } { e'4 }")
    Voice("c'4 d'4 { { <e' g'>16 gs'16 a'16 as'16 } { e'4 } } f'4", name='MusicVoice')
    Staff("{ c'4 d'4 { { <e' g'>16 gs'16 a'16 as'16 } { e'4 } } f'4 }")
OnBeatGraceContainer("<e' g'>16 gs'16 a'16 as'16"):
    OnBeatGraceContainer("<e' g'>16 gs'16 a'16 as'16")
    Container("{ <e' g'>16 gs'16 a'16 as'16 } { e'4 }")
    Voice("c'4 d'4 { { <e' g'>16 gs'16 a'16 as'16 } { e'4 } } f'4", name='MusicVoice')
    Staff("{ c'4 d'4 { { <e' g'>16 gs'16 a'16 as'16 } { e'4 } } f'4 }")
Chord("<e' g'>16"):
    Chord("<e' g'>16")
    OnBeatGraceContainer("<e' g'>16 gs'16 a'16 as'16")
    Container("{ <e' g'>16 gs'16 a'16 as'16 } { e'4 }")
    Voice("c'4 d'4 { { <e' g'>16 gs'16 a'16 as'16 } { e'4 } } f'4", name='MusicVoice')
    Staff("{ c'4 d'4 { { <e' g'>16 gs'16 a'16 as'16 } { e'4 } } f'4 }")
Note("gs'16"):
    Note("gs'16")
    OnBeatGraceContainer("<e' g'>16 gs'16 a'16 as'16")
    Container("{ <e' g'>16 gs'16 a'16 as'16 } { e'4 }")
    Voice("c'4 d'4 { { <e' g'>16 gs'16 a'16 as'16 } { e'4 } } f'4", name='MusicVoice')
    Staff("{ c'4 d'4 { { <e' g'>16 gs'16 a'16 as'16 } { e'4 } } f'4 }")
Note("a'16"):
    Note("a'16")
    OnBeatGraceContainer("<e' g'>16 gs'16 a'16 as'16")
    Container("{ <e' g'>16 gs'16 a'16 as'16 } { e'4 }")
    Voice("c'4 d'4 { { <e' g'>16 gs'16 a'16 as'16 } { e'4 } } f'4", name='MusicVoice')
    Staff("{ c'4 d'4 { { <e' g'>16 gs'16 a'16 as'16 } { e'4 } } f'4 }")
Note("as'16"):
    Note("as'16")
    OnBeatGraceContainer("<e' g'>16 gs'16 a'16 as'16")
    Container("{ <e' g'>16 gs'16 a'16 as'16 } { e'4 }")
    Voice("c'4 d'4 { { <e' g'>16 gs'16 a'16 as'16 } { e'4 } } f'4", name='MusicVoice')
    Staff("{ c'4 d'4 { { <e' g'>16 gs'16 a'16 as'16 } { e'4 } } f'4 }")
Voice("e'4", name='MusicVoice'):
    Voice("e'4", name='MusicVoice')
    Container("{ <e' g'>16 gs'16 a'16 as'16 } { e'4 }")
    Voice("c'4 d'4 { { <e' g'>16 gs'16 a'16 as'16 } { e'4 } } f'4", name='MusicVoice')
    Staff("{ c'4 d'4 { { <e' g'>16 gs'16 a'16 as'16 } { e'4 } } f'4 }")
Note("e'4"):
    Note("e'4")
    Voice("e'4", name='MusicVoice')
    Container("{ <e' g'>16 gs'16 a'16 as'16 } { e'4 }")
    Voice("c'4 d'4 { { <e' g'>16 gs'16 a'16 as'16 } { e'4 } } f'4", name='MusicVoice')
    Staff("{ c'4 d'4 { { <e' g'>16 gs'16 a'16 as'16 } { e'4 } } f'4 }")
Note("f'4"):
    Note("f'4")
    Voice("c'4 d'4 { { <e' g'>16 gs'16 a'16 as'16 } { e'4 } } f'4", name='MusicVoice')
    Staff("{ c'4 d'4 { { <e' g'>16 gs'16 a'16 as'16 } { e'4 } } f'4 }")
AfterGraceContainer("fs'16"):
    AfterGraceContainer("fs'16")
    Voice("c'4 d'4 { { <e' g'>16 gs'16 a'16 as'16 } { e'4 } } f'4", name='MusicVoice')
    Staff("{ c'4 d'4 { { <e' g'>16 gs'16 a'16 as'16 } { e'4 } } f'4 }")
Note("fs'16"):
    Note("fs'16")
    AfterGraceContainer("fs'16")
    Voice("c'4 d'4 { { <e' g'>16 gs'16 a'16 as'16 } { e'4 } } f'4", name='MusicVoice')
    Staff("{ c'4 d'4 { { <e' g'>16 gs'16 a'16 as'16 } { e'4 } } f'4 }")

REGRESSSION. Works with tremolo containers:

>>> staff = abjad.Staff()
>>> staff.append(abjad.TremoloContainer(2, "c'16 e'"))
>>> staff.append("cs'4")
>>> staff.append(abjad.TremoloContainer(2, "d'16 f'"))
>>> staff.append("ds'4")
>>> abjad.show(staff)  

>>> for component in abjad.select.components(staff):
...     parentage = abjad.get.parentage(component)
...     print(f"{repr(component)}:")
...     print(f"    {repr(parentage[:])}")
... 
Staff("{ c'16 e'16 } cs'4 { d'16 f'16 } ds'4"):
    (Staff("{ c'16 e'16 } cs'4 { d'16 f'16 } ds'4"),)
TremoloContainer("c'16 e'16"):
    (TremoloContainer("c'16 e'16"), Staff("{ c'16 e'16 } cs'4 { d'16 f'16 } ds'4"))
Note("c'16"):
    (Note("c'16"), TremoloContainer("c'16 e'16"), Staff("{ c'16 e'16 } cs'4 { d'16 f'16 } ds'4"))
Note("e'16"):
    (Note("e'16"), TremoloContainer("c'16 e'16"), Staff("{ c'16 e'16 } cs'4 { d'16 f'16 } ds'4"))
Note("cs'4"):
    (Note("cs'4"), Staff("{ c'16 e'16 } cs'4 { d'16 f'16 } ds'4"))
TremoloContainer("d'16 f'16"):
    (TremoloContainer("d'16 f'16"), Staff("{ c'16 e'16 } cs'4 { d'16 f'16 } ds'4"))
Note("d'16"):
    (Note("d'16"), TremoloContainer("d'16 f'16"), Staff("{ c'16 e'16 } cs'4 { d'16 f'16 } ds'4"))
Note("f'16"):
    (Note("f'16"), TremoloContainer("d'16 f'16"), Staff("{ c'16 e'16 } cs'4 { d'16 f'16 } ds'4"))
Note("ds'4"):
    (Note("ds'4"), Staff("{ c'16 e'16 } cs'4 { d'16 f'16 } ds'4"))

Return type:: Parentage

abjad.get.pitches(argument)[source]¶

Gets pitches.

REGRESSION. Works with grace notes (and containers):

>>> music_voice = abjad.Voice("c'4 d' e' f'", name="MusicVoice")
>>> container = abjad.BeforeGraceContainer("cs'16")
>>> abjad.attach(container, music_voice[1])
>>> container = abjad.on_beat_grace_container("g'16 gs' a' as'", music_voice[2:3])
>>> abjad.attach(abjad.Articulation(">"), container[0])
>>> container = abjad.AfterGraceContainer("fs'16")
>>> abjad.attach(container, music_voice[3])
>>> staff = abjad.Staff([music_voice])
>>> lilypond_file = abjad.LilyPondFile([r'\include "abjad.ily"', staff])
>>> abjad.show(lilypond_file)  

>>> for component in abjad.select.components(staff):
...     pitches = abjad.get.pitches(component)
...     component
...     for _ in sorted(pitches):
...         print(f"    {_!r}")
... 
Staff("{ c'4 d'4 { { <e' g'>16 gs'16 a'16 as'16 } { e'4 } } f'4 }")
    NamedPitch("c'")
    NamedPitch("cs'")
    NamedPitch("d'")
    NamedPitch("e'")
    NamedPitch("f'")
    NamedPitch("fs'")
    NamedPitch("g'")
    NamedPitch("gs'")
    NamedPitch("a'")
    NamedPitch("as'")
Voice("c'4 d'4 { { <e' g'>16 gs'16 a'16 as'16 } { e'4 } } f'4", name='MusicVoice')
    NamedPitch("c'")
    NamedPitch("cs'")
    NamedPitch("d'")
    NamedPitch("e'")
    NamedPitch("f'")
    NamedPitch("fs'")
    NamedPitch("g'")
    NamedPitch("gs'")
    NamedPitch("a'")
    NamedPitch("as'")
Note("c'4")
    NamedPitch("c'")
BeforeGraceContainer("cs'16")
    NamedPitch("cs'")
Note("cs'16")
    NamedPitch("cs'")
Note("d'4")
    NamedPitch("d'")
Container("{ <e' g'>16 gs'16 a'16 as'16 } { e'4 }")
    NamedPitch("e'")
    NamedPitch("g'")
    NamedPitch("gs'")
    NamedPitch("a'")
    NamedPitch("as'")
OnBeatGraceContainer("<e' g'>16 gs'16 a'16 as'16")
    NamedPitch("e'")
    NamedPitch("g'")
    NamedPitch("gs'")
    NamedPitch("a'")
    NamedPitch("as'")
Chord("<e' g'>16")
    NamedPitch("e'")
    NamedPitch("g'")
Note("gs'16")
    NamedPitch("gs'")
Note("a'16")
    NamedPitch("a'")
Note("as'16")
    NamedPitch("as'")
Voice("e'4", name='MusicVoice')
    NamedPitch("e'")
Note("e'4")
    NamedPitch("e'")
Note("f'4")
    NamedPitch("f'")
AfterGraceContainer("fs'16")
    NamedPitch("fs'")
Note("fs'16")
    NamedPitch("fs'")

Return type:: set[NamedPitch]

abjad.get.sounding_pitch(argument)[source]¶

Gets sounding pitch of note.

>>> staff = abjad.Staff("d''8 e''8 f''8 g''8")
>>> piccolo = abjad.Piccolo()
>>> abjad.attach(piccolo, staff[0])
>>> abjad.iterpitches.transpose_from_sounding_pitch(staff)
>>> abjad.show(staff)  

>>> for note in abjad.select.notes(staff):
...     pitch = abjad.get.sounding_pitch(note)
...     print(f"{repr(note):10} {repr(pitch)}")
... 
Note("d'8") NamedPitch("d''")
Note("e'8") NamedPitch("e''")
Note("f'8") NamedPitch("f''")
Note("g'8") NamedPitch("g''")

Return type:: NamedPitch

abjad.get.sounding_pitches(argument)[source]¶

Gets sounding pitches.

>>> staff = abjad.Staff("<c''' e'''>4 <d''' fs'''>4")
>>> glockenspiel = abjad.Glockenspiel()
>>> abjad.attach(glockenspiel, staff[0])
>>> abjad.iterpitches.transpose_from_sounding_pitch(staff)
>>> abjad.show(staff)  

>>> for chord in abjad.select.chords(staff):
...     pitches = abjad.get.sounding_pitches(chord)
...     chord
...     for _ in sorted(pitches):
...         print(f"    {_!r}")
... 
Chord("<c' e'>4")
    NamedPitch("c'''")
    NamedPitch("e'''")
Chord("<d' fs'>4")
    NamedPitch("d'''")
    NamedPitch("fs'''")

Return type:: set[NamedPitch]

abjad.get.sustained(argument)[source]¶

Is true when argument is sustained.

>>> tuplet = abjad.Tuplet((3, 2), "c'4 ~ c' ~ c'")
>>> abjad.show(tuplet)  

>>> string = abjad.lilypond(tuplet)
>>> print(string)
\tweak text #tuplet-number::calc-fraction-text
\times 3/2
{
    c'4
    ~
    c'4
    ~
    c'4
}

>>> abjad.get.sustained(tuplet)
True

Return type:: bool

abjad.get.timespan(argument, in_seconds=False)[source]¶

Gets timespan.

REGRESSION. Works with grace notes (and containers):

>>> music_voice = abjad.Voice("c'4 d' e' f'", name="MusicVoice")
>>> container = abjad.BeforeGraceContainer("cs'16")
>>> abjad.attach(container, music_voice[1])
>>> container = abjad.on_beat_grace_container("g'16 gs' a' as'", music_voice[2:3])
>>> abjad.attach(abjad.Articulation(">"), container[0])
>>> container = abjad.AfterGraceContainer("fs'16")
>>> abjad.attach(container, music_voice[3])
>>> staff = abjad.Staff([music_voice])
>>> lilypond_file = abjad.LilyPondFile([r'\include "abjad.ily"', staff])
>>> abjad.show(lilypond_file)  

>>> for component in abjad.select.components(staff):
...     timespan = abjad.get.timespan(component)
...     print(f"{component!r}:")
...     print(f"    {timespan!r}")
... 
Staff("{ c'4 d'4 { { <e' g'>16 gs'16 a'16 as'16 } { e'4 } } f'4 }"):
    Timespan(Offset((0, 1)), Offset((1, 1)))
Voice("c'4 d'4 { { <e' g'>16 gs'16 a'16 as'16 } { e'4 } } f'4", name='MusicVoice'):
    Timespan(Offset((0, 1)), Offset((1, 1)))
Note("c'4"):
    Timespan(Offset((0, 1)), Offset((1, 4)))
BeforeGraceContainer("cs'16"):
    Timespan(Offset((1, 4), displacement=Duration(-1, 16)), Offset((1, 4)))
Note("cs'16"):
    Timespan(Offset((1, 4), displacement=Duration(-1, 16)), Offset((1, 4)))
Note("d'4"):
    Timespan(Offset((1, 4)), Offset((1, 2)))
Container("{ <e' g'>16 gs'16 a'16 as'16 } { e'4 }"):
    Timespan(Offset((1, 2)), Offset((3, 4)))
OnBeatGraceContainer("<e' g'>16 gs'16 a'16 as'16"):
    Timespan(Offset((1, 2)), Offset((1, 2), displacement=Duration(1, 4)))
Chord("<e' g'>16"):
    Timespan(Offset((1, 2)), Offset((1, 2), displacement=Duration(1, 16)))
Note("gs'16"):
    Timespan(Offset((1, 2), displacement=Duration(1, 16)), Offset((1, 2), displacement=Duration(1, 8)))
Note("a'16"):
    Timespan(Offset((1, 2), displacement=Duration(1, 8)), Offset((1, 2), displacement=Duration(3, 16)))
Note("as'16"):
    Timespan(Offset((1, 2), displacement=Duration(3, 16)), Offset((1, 2), displacement=Duration(1, 4)))
Voice("e'4", name='MusicVoice'):
    Timespan(Offset((1, 2)), Offset((3, 4)))
Note("e'4"):
    Timespan(Offset((1, 2), displacement=Duration(1, 4)), Offset((3, 4)))
Note("f'4"):
    Timespan(Offset((3, 4)), Offset((1, 1)))
AfterGraceContainer("fs'16"):
    Timespan(Offset((1, 1), displacement=Duration(-1, 16)), Offset((1, 1)))
Note("fs'16"):
    Timespan(Offset((1, 1), displacement=Duration(-1, 16)), Offset((1, 1)))

REGRESSSION. Works with tremolo containers:

>>> staff = abjad.Staff()
>>> staff.append(abjad.TremoloContainer(2, "c'16 e'"))
>>> staff.append("cs'4")
>>> staff.append(abjad.TremoloContainer(2, "d'16 f'"))
>>> staff.append("ds'4")
>>> abjad.show(staff)  

>>> for component in abjad.select.components(staff):
...     timespan = abjad.get.timespan(component)
...     print(f"{repr(component):30} {repr(timespan)}")
... 
Staff("{ c'16 e'16 } cs'4 { d'16 f'16 } ds'4") Timespan(Offset((0, 1)), Offset((1, 1)))
TremoloContainer("c'16 e'16")  Timespan(Offset((0, 1)), Offset((1, 4)))
Note("c'16")                   Timespan(Offset((0, 1)), Offset((1, 8)))
Note("e'16")                   Timespan(Offset((1, 8)), Offset((1, 4)))
Note("cs'4")                   Timespan(Offset((1, 4)), Offset((1, 2)))
TremoloContainer("d'16 f'16")  Timespan(Offset((1, 2)), Offset((3, 4)))
Note("d'16")                   Timespan(Offset((1, 2)), Offset((5, 8)))
Note("f'16")                   Timespan(Offset((5, 8)), Offset((3, 4)))
Note("ds'4")                   Timespan(Offset((3, 4)), Offset((1, 1)))

REGRESION. Works with selection:

>>> staff = abjad.Staff("c'4 d' e' f'")
>>> abjad.show(staff)  

>>> abjad.get.timespan(staff[:3])
Timespan(Offset((0, 1)), Offset((3, 4)))

Return type:: Timespan

abjad.get.wrapper(argument, prototype=None, *, attributes=None)[source]¶

Gets wrapper.

>>> music_voice = abjad.Voice("c'4 d' e' f'", name="MusicVoice")
>>> staff = abjad.Staff([music_voice])
>>> container = abjad.BeforeGraceContainer("cs'16")
>>> abjad.attach(container, music_voice[1])
>>> container = abjad.on_beat_grace_container("g'16 gs' a' as'", music_voice[2:3])
>>> abjad.attach(abjad.Clef("alto"), container[0])
>>> abjad.attach(abjad.Articulation(">"), container[0])
>>> container = abjad.AfterGraceContainer("fs'16")
>>> abjad.attach(container, music_voice[3])
>>> for note in abjad.select.notes(staff):
...     abjad.attach(abjad.Articulation("."), note)
... 

>>> lilypond_file = abjad.LilyPondFile([r'\include "abjad.ily"', staff])
>>> abjad.show(lilypond_file)  

REGRESSION. Works with grace notes (and containers):

>>> for component in abjad.select.components(staff):
...     wrapper = abjad.get.wrapper(component, abjad.Articulation)
...     print(f"{component!r}:")
...     print(f"    {wrapper!r}")
... 
Staff("{ c'4 d'4 { { <e' g'>16 gs'16 a'16 as'16 } { e'4 } } f'4 }"):
    None
Voice("c'4 d'4 { { <e' g'>16 gs'16 a'16 as'16 } { e'4 } } f'4", name='MusicVoice'):
    None
Note("c'4"):
    Wrapper(annotation=None, context=None, deactivate=False, direction=None, indicator=Articulation(name='.'), synthetic_offset=None, tag=Tag(string=''))
BeforeGraceContainer("cs'16"):
    None
Note("cs'16"):
    Wrapper(annotation=None, context=None, deactivate=False, direction=None, indicator=Articulation(name='.'), synthetic_offset=None, tag=Tag(string=''))
Note("d'4"):
    Wrapper(annotation=None, context=None, deactivate=False, direction=None, indicator=Articulation(name='.'), synthetic_offset=None, tag=Tag(string=''))
Container("{ <e' g'>16 gs'16 a'16 as'16 } { e'4 }"):
    None
OnBeatGraceContainer("<e' g'>16 gs'16 a'16 as'16"):
    None
Chord("<e' g'>16"):
    Wrapper(annotation=None, context=None, deactivate=False, direction=None, indicator=Articulation(name='>'), synthetic_offset=None, tag=Tag(string=''))
Note("gs'16"):
    Wrapper(annotation=None, context=None, deactivate=False, direction=None, indicator=Articulation(name='.'), synthetic_offset=None, tag=Tag(string=''))
Note("a'16"):
    Wrapper(annotation=None, context=None, deactivate=False, direction=None, indicator=Articulation(name='.'), synthetic_offset=None, tag=Tag(string=''))
Note("as'16"):
    Wrapper(annotation=None, context=None, deactivate=False, direction=None, indicator=Articulation(name='.'), synthetic_offset=None, tag=Tag(string=''))
Voice("e'4", name='MusicVoice'):
    None
Note("e'4"):
    Wrapper(annotation=None, context=None, deactivate=False, direction=None, indicator=Articulation(name='.'), synthetic_offset=None, tag=Tag(string=''))
Note("f'4"):
    Wrapper(annotation=None, context=None, deactivate=False, direction=None, indicator=Articulation(name='.'), synthetic_offset=None, tag=Tag(string=''))
AfterGraceContainer("fs'16"):
    None
Note("fs'16"):
    Wrapper(annotation=None, context=None, deactivate=False, direction=None, indicator=Articulation(name='.'), synthetic_offset=None, tag=Tag(string=''))

Raises exception when more than one indicator of prototype attach to argument.

abjad.get.wrappers(argument, prototype=None, *, attributes=None)[source]¶

Gets wrappers.

REGRESSION. Works with grace notes (and containers):

>>> music_voice = abjad.Voice("c'4 d' e' f'", name="MusicVoice")
>>> staff = abjad.Staff([music_voice])
>>> container = abjad.BeforeGraceContainer("cs'16")
>>> abjad.attach(container, music_voice[1])
>>> container = abjad.on_beat_grace_container("g'16 gs' a' as'", music_voice[2:3])
>>> abjad.attach(abjad.Clef("alto"), container[0])
>>> abjad.attach(abjad.Articulation(">"), container[0])
>>> container = abjad.AfterGraceContainer("fs'16")
>>> abjad.attach(container, music_voice[3])
>>> for note in abjad.select.notes(staff):
...     abjad.attach(abjad.Articulation("."), note)
... 

>>> lilypond_file = abjad.LilyPondFile([r'\include "abjad.ily"', staff])
>>> abjad.show(lilypond_file)  

>>> for component in abjad.select.components(staff):
...     result = abjad.get.wrappers(component, abjad.Articulation)
...     print(f"{component!r}:")
...     print(f"    {result!r}")
... 
Staff("{ c'4 d'4 { { <e' g'>16 gs'16 a'16 as'16 } { e'4 } } f'4 }"):
    []
Voice("c'4 d'4 { { <e' g'>16 gs'16 a'16 as'16 } { e'4 } } f'4", name='MusicVoice'):
    []
Note("c'4"):
    [Wrapper(annotation=None, context=None, deactivate=False, direction=None, indicator=Articulation(name='.'), synthetic_offset=None, tag=Tag(string=''))]
BeforeGraceContainer("cs'16"):
    []
Note("cs'16"):
    [Wrapper(annotation=None, context=None, deactivate=False, direction=None, indicator=Articulation(name='.'), synthetic_offset=None, tag=Tag(string=''))]
Note("d'4"):
    [Wrapper(annotation=None, context=None, deactivate=False, direction=None, indicator=Articulation(name='.'), synthetic_offset=None, tag=Tag(string=''))]
Container("{ <e' g'>16 gs'16 a'16 as'16 } { e'4 }"):
    []
OnBeatGraceContainer("<e' g'>16 gs'16 a'16 as'16"):
    []
Chord("<e' g'>16"):
    [Wrapper(annotation=None, context=None, deactivate=False, direction=None, indicator=Articulation(name='>'), synthetic_offset=None, tag=Tag(string=''))]
Note("gs'16"):
    [Wrapper(annotation=None, context=None, deactivate=False, direction=None, indicator=Articulation(name='.'), synthetic_offset=None, tag=Tag(string=''))]
Note("a'16"):
    [Wrapper(annotation=None, context=None, deactivate=False, direction=None, indicator=Articulation(name='.'), synthetic_offset=None, tag=Tag(string=''))]
Note("as'16"):
    [Wrapper(annotation=None, context=None, deactivate=False, direction=None, indicator=Articulation(name='.'), synthetic_offset=None, tag=Tag(string=''))]
Voice("e'4", name='MusicVoice'):
    []
Note("e'4"):
    [Wrapper(annotation=None, context=None, deactivate=False, direction=None, indicator=Articulation(name='.'), synthetic_offset=None, tag=Tag(string=''))]
Note("f'4"):
    [Wrapper(annotation=None, context=None, deactivate=False, direction=None, indicator=Articulation(name='.'), synthetic_offset=None, tag=Tag(string=''))]
AfterGraceContainer("fs'16"):
    []
Note("fs'16"):
    [Wrapper(annotation=None, context=None, deactivate=False, direction=None, indicator=Articulation(name='.'), synthetic_offset=None, tag=Tag(string=''))]