pymusicxml.score_components.KeySignature

class pymusicxml.score_components.KeySignature

Bases: MusicXMLComponent

Abstract base class for traditional and non-traditional key signatures. Also contains the “parse” method for parsing a string into a key signature.

Methods

parse(interpretable_as_key_signature)	Parses several kinds of input into a TraditionalKeySignature or NonTraditionalKeySignature object.
render()	Renders this component to a tuple of ElementTree.Element.
wrap_as_score()	Wraps this component in a Score so that it can be exported and viewed

Inherited Methods

export_to_file(file_path[, pretty_print])	Exports this musical object (wrapped as a score) to the given file path.
to_xml([pretty_print])	Renders this component to MusicXML, adding a version tag, but not wrapping it up as a full score.
view_in_software(command)	Uses the given terminal command to create a score out of this musical object, and open it in music notation software.

Attributes

mode_fifth_alterations

mode_fifth_alterations = {'ionian': 0, 'major': 0, 'dorian': -2, 'phrygian': -4, 'lydian': 1, 'mixolydian': -1, 'aeolian': -3, 'minor': -3, 'locrian': -4, None: 0}

static parse(interpretable_as_key_signature: KeySignature | int | str) → KeySignature

Parses several kinds of input into a TraditionalKeySignature or NonTraditionalKeySignature object.

Parameters:

interpretable_as_key_signature – either a KeySignature object, an integer representing the number of sharps (or flats if negative), or a string to be parsed into a key signature, such as “G major”, “F# lydian”, or “C#, Ab” (which produces a non-traditional key-signature), etc.

abstract render() → Sequence[Element]

Renders this component to a tuple of ElementTree.Element. (The reason for making it a tuple is that musical objects like chords are represented by several notes side by side, with all but the first containing a </chord> tag.)

wrap_as_score() → Score

Wraps this component in a Score so that it can be exported and viewed

export_to_file(file_path: str, pretty_print: bool = True) → None

Exports this musical object (wrapped as a score) to the given file path.

Parameters:

• file_path – The path of the file we want to write to.

• pretty_print – If True, breaks the MusicXML onto multiple lines, with indentation

to_xml(pretty_print: bool = False) → str

Renders this component to MusicXML, adding a version tag, but not wrapping it up as a full score.

Parameters:

pretty_print – If True, breaks the MusicXML onto multiple lines, with indentation

view_in_software(command: str) → None

Uses the given terminal command to create a score out of this musical object, and open it in music notation software.

Parameters:

command – The terminal command corresponding to the software with which we want to open the score.