LilyPondComment

class indicatortools.LilyPondComment(contents_string=None, format_slot=None)

A LilyPond comment.

Example 1. Two-word comment:

>>> note = Note("c'4")
>>> comment = indicatortools.LilyPondComment('a comment')
>>> attach(comment, note)
>>> show(note) 

Example 2. Three-word comment:

>>> note = Note("c'4")
>>> comment = indicatortools.LilyPondComment('yet another comment')
>>> attach(comment, note)
>>> show(note) 

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.AbjadValueObject.AbjadValueObject" [color=1, group=0, label=AbjadValueObject, shape=box]; "abjad.tools.abctools.AbjadObject.AbjadObject" -> "abjad.tools.abctools.AbjadValueObject.AbjadValueObject"; "abjad.tools.abctools.AbjadObject.AbstractBase" -> "abjad.tools.abctools.AbjadObject.AbjadObject"; } subgraph cluster_indicatortools { graph [label=indicatortools]; "abjad.tools.indicatortools.LilyPondComment.LilyPondComment" [color=black, fontcolor=white, group=2, label=<<B>LilyPondComment</B>>, shape=box, style="filled, rounded"]; } subgraph cluster_builtins { graph [label=builtins]; "builtins.object" [color=2, group=1, label=object, shape=box]; } "abjad.tools.abctools.AbjadValueObject.AbjadValueObject" -> "abjad.tools.indicatortools.LilyPondComment.LilyPondComment"; "builtins.object" -> "abjad.tools.abctools.AbjadObject.AbstractBase"; }

Bases

Attribute summary

contents_string Contents string of LilyPond comment.
format_slot Format slot of LilyPond comment.
list_allowable_format_slots() Lists allowable format slots.
__copy__(\*args) Copies Abjad value object.
__eq__(expr) Is true when all initialization values of Abjad value object equal the initialization values of expr.
__format__([format_specification]) Formats Abjad object.
__hash__() Hashes Abjad value object.
__ne__(expr) Is true when Abjad object does not equal expr.
__repr__() Gets interpreter representation of Abjad object.
__str__() Gets string representation of LilyPond comment.

Read-only properties

LilyPondComment.contents_string

Contents string of LilyPond comment.

Example 1. Two-word comment:

>>> comment = indicatortools.LilyPondComment('a comment')
>>> comment.contents_string
'a comment'

Example 2. Three-word comment:

>>> comment = indicatortools.LilyPondComment('yet another comment')
>>> comment.contents_string
'yet another comment'

Returns string.

LilyPondComment.format_slot

Format slot of LilyPond comment.

Example 1. Two-word comment:

>>> comment = indicatortools.LilyPondComment('a comment')
>>> comment.format_slot
'before'

Example 2. Three-word comment:

>>> comment = indicatortools.LilyPondComment('yet another comment')
>>> comment.format_slot
'before'

Defaults to 'before'.

Set to allowable format slot string.

Returns string.

Class & static methods

static LilyPondComment.list_allowable_format_slots()

Lists allowable format slots.

Example 1. Default:

>>> commands = indicatortools.LilyPondComment.list_allowable_format_slots()
>>> for command in commands:
...     command
... 
'after'
'before'
'closing'
'opening'
'right'

Returns tuple of strings.

Special methods

(AbjadValueObject).__copy__(*args)

Copies Abjad value object.

Returns new Abjad value object.

(AbjadValueObject).__eq__(expr)

Is true when all initialization values of Abjad value object equal the initialization values of expr.

Returns true or false.

(AbjadObject).__format__(format_specification='')

Formats Abjad object.

Set format_specification to ‘’ or ‘storage’. Interprets ‘’ equal to ‘storage’.

Returns string.

(AbjadValueObject).__hash__()

Hashes Abjad value object.

Returns integer.

(AbjadObject).__ne__(expr)

Is true when Abjad object does not equal expr. Otherwise false.

Returns true or false.

(AbjadObject).__repr__()

Gets interpreter representation of Abjad object.

Returns string.

LilyPondComment.__str__()

Gets string representation of LilyPond comment.

Example 1. Two-word comment:

>>> comment = indicatortools.LilyPondComment('a comment')
>>> str(comment)
'% a comment'

Example 2. Three-word comment:

>>> comment = indicatortools.LilyPondComment('yet another comment')
>>> str(comment)
'% yet another comment'

Returns string.