KeySignature

class indicatortools.KeySignature(tonic='c', mode='major')

A key signature.

Example 1. E major:

>>> staff = Staff("e'8 fs'8 gs'8 a'8")
>>> key_signature = KeySignature('e', 'major')
>>> attach(key_signature, staff)
>>> show(staff) 

Example 2. e minor:

>>> staff = Staff("e'8 fs'8 g'8 a'8")
>>> key_signature = KeySignature('e', 'minor')
>>> attach(key_signature, staff)
>>> show(staff) 

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.KeySignature.KeySignature" [color=black, fontcolor=white, group=2, label=<<B>KeySignature</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.KeySignature.KeySignature"; "builtins.object" -> "abjad.tools.abctools.AbjadObject.AbstractBase"; }

Bases

Attribute summary

default_scope Gets default scope of key signature.
mode Gets mode of key signature.
name Gets name of key signature.
tonic Gets tonic of key signature.
__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 key signature.

Read-only properties

KeySignature.default_scope

Gets default scope of key signature.

Example 1. E major:

>>> key_signature = KeySignature('e', 'major')
>>> key_signature.default_scope
<class 'abjad.tools.scoretools.Staff.Staff'>

Example 2. e minor:

>>> key_signature = KeySignature('e', 'minor')
>>> key_signature.default_scope
<class 'abjad.tools.scoretools.Staff.Staff'>

Key signatures are staff-scoped by default.

Returns staff.

KeySignature.mode

Gets mode of key signature.

Example 1. E major:

>>> key_signature = KeySignature('e', 'major')
>>> key_signature.mode
Mode(mode_name='major')

Example 2. e minor:

>>> key_signature = KeySignature('e', 'minor')
>>> key_signature.mode
Mode(mode_name='minor')

Returns mode.

KeySignature.name

Gets name of key signature.

Example 1. E major:

>>> key_signature = KeySignature('e', 'major')
>>> key_signature.name
'E major'

Example 2. e minor:

>>> key_signature = KeySignature('e', 'minor')
>>> key_signature.name
'e minor'

Returns string.

KeySignature.tonic

Gets tonic of key signature.

Example 1. E major:

>>> key_signature = KeySignature('e', 'major')
>>> key_signature.tonic
NamedPitchClass('e')

Example 2. e minor:

>>> key_signature = KeySignature('e', 'minor')
>>> key_signature.tonic
NamedPitchClass('e')

Returns named pitch-class.

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.

KeySignature.__str__()

Gets string representation of key signature.

Example 1. E major:

>>> str(KeySignature('e', 'major'))
'e-major'

Example 2. e minor:

>>> str(KeySignature('e', 'minor'))
'e-minor'

Returns string.