.. _moduleKey:

music21.key
===========

.. WARNING: DO NOT EDIT THIS FILE:
   AUTOMATICALLY GENERATED.
   PLEASE EDIT THE .py FILE DIRECTLY.

.. automodule:: music21.key

KeySignature
------------

.. autoclass:: music21.key.KeySignature

.. rubric:: :class:`~music21.key.KeySignature` bases

- :class:`~music21.base.Music21Object`
- :class:`~music21.prebase.ProtoM21Object`

.. rubric:: :class:`~music21.key.KeySignature` read-only properties

.. autoattribute:: music21.key.KeySignature.isNonTraditional

Read-only properties inherited from :class:`~music21.base.Music21Object`:

.. hlist::
   :columns: 3

   - :attr:`~music21.base.Music21Object.beat`
   - :attr:`~music21.base.Music21Object.beatDuration`
   - :attr:`~music21.base.Music21Object.beatStr`
   - :attr:`~music21.base.Music21Object.beatStrength`
   - :attr:`~music21.base.Music21Object.hasEditorialInformation`
   - :attr:`~music21.base.Music21Object.hasStyleInformation`
   - :attr:`~music21.base.Music21Object.measureNumber`

Read-only properties inherited from :class:`~music21.prebase.ProtoM21Object`:

.. hlist::
   :columns: 3

   - :attr:`~music21.prebase.ProtoM21Object.classSet`
   - :attr:`~music21.prebase.ProtoM21Object.classes`

.. rubric:: :class:`~music21.key.KeySignature` read/write properties

.. autoattribute:: music21.key.KeySignature.alteredPitches

.. autoattribute:: music21.key.KeySignature.sharps

Read/write properties inherited from :class:`~music21.base.Music21Object`:

.. hlist::
   :columns: 3

   - :attr:`~music21.base.Music21Object.activeSite`
   - :attr:`~music21.base.Music21Object.derivation`
   - :attr:`~music21.base.Music21Object.duration`
   - :attr:`~music21.base.Music21Object.editorial`
   - :attr:`~music21.base.Music21Object.id`
   - :attr:`~music21.base.Music21Object.offset`
   - :attr:`~music21.base.Music21Object.priority`
   - :attr:`~music21.base.Music21Object.quarterLength`
   - :attr:`~music21.base.Music21Object.seconds`
   - :attr:`~music21.base.Music21Object.style`

.. rubric:: :class:`~music21.key.KeySignature` methods

.. automethod:: music21.key.KeySignature.accidentalByStep

.. automethod:: music21.key.KeySignature.asKey

.. automethod:: music21.key.KeySignature.getScale

.. automethod:: music21.key.KeySignature.transpose

.. automethod:: music21.key.KeySignature.transposePitchFromC

Methods inherited from :class:`~music21.base.Music21Object`:

.. hlist::
   :columns: 3

   - :meth:`~music21.base.Music21Object.__eq__`
   - :meth:`~music21.base.Music21Object.clearCache`
   - :meth:`~music21.base.Music21Object.containerHierarchy`
   - :meth:`~music21.base.Music21Object.contextSites`
   - :meth:`~music21.base.Music21Object.getAllContextsByClass`
   - :meth:`~music21.base.Music21Object.getContextByClass`
   - :meth:`~music21.base.Music21Object.getOffsetBySite`
   - :meth:`~music21.base.Music21Object.getOffsetInHierarchy`
   - :meth:`~music21.base.Music21Object.getSpannerSites`
   - :meth:`~music21.base.Music21Object.informSites`
   - :meth:`~music21.base.Music21Object.mergeAttributes`
   - :meth:`~music21.base.Music21Object.next`
   - :meth:`~music21.base.Music21Object.previous`
   - :meth:`~music21.base.Music21Object.purgeLocations`
   - :meth:`~music21.base.Music21Object.purgeOrphans`
   - :meth:`~music21.base.Music21Object.setOffsetBySite`
   - :meth:`~music21.base.Music21Object.show`
   - :meth:`~music21.base.Music21Object.sortTuple`
   - :meth:`~music21.base.Music21Object.splitAtDurations`
   - :meth:`~music21.base.Music21Object.splitAtQuarterLength`
   - :meth:`~music21.base.Music21Object.splitByQuarterLengths`
   - :meth:`~music21.base.Music21Object.write`

Methods inherited from :class:`~music21.prebase.ProtoM21Object`:

.. hlist::
   :columns: 3

   - :meth:`~music21.prebase.ProtoM21Object.isClassOrSubclass`

.. rubric:: :class:`~music21.key.KeySignature` instance variables

Instance variables inherited from :class:`~music21.base.Music21Object`:

.. hlist::
   :columns: 3

   - :attr:`~music21.base.Music21Object.classSortOrder`
   - :attr:`~music21.base.Music21Object.groups`
   - :attr:`~music21.base.Music21Object.isStream`
   - :attr:`~music21.base.Music21Object.sites`

Key
---

.. autoclass:: music21.key.Key

.. rubric:: :class:`~music21.key.Key` bases

- :class:`~music21.key.KeySignature`
- :class:`~music21.scale.DiatonicScale`
- :class:`~music21.scale.ConcreteScale`
- :class:`~music21.scale.Scale`
- :class:`~music21.base.Music21Object`
- :class:`~music21.prebase.ProtoM21Object`

.. rubric:: :class:`~music21.key.Key` read-only properties

.. autoattribute:: music21.key.Key.parallel

.. autoattribute:: music21.key.Key.relative

.. autoattribute:: music21.key.Key.tonicPitchNameWithCase

Read-only properties inherited from :class:`~music21.key.KeySignature`:

.. hlist::
   :columns: 3

   - :attr:`~music21.key.KeySignature.isNonTraditional`

Read-only properties inherited from :class:`~music21.scale.ConcreteScale`:

.. hlist::
   :columns: 3

   - :attr:`~music21.scale.ConcreteScale.chord`
   - :attr:`~music21.scale.ConcreteScale.isConcrete`
   - :attr:`~music21.scale.ConcreteScale.name`
   - :attr:`~music21.scale.ConcreteScale.pitches`

Read-only properties inherited from :class:`~music21.base.Music21Object`:

.. hlist::
   :columns: 3

   - :attr:`~music21.base.Music21Object.beat`
   - :attr:`~music21.base.Music21Object.beatDuration`
   - :attr:`~music21.base.Music21Object.beatStr`
   - :attr:`~music21.base.Music21Object.beatStrength`
   - :attr:`~music21.base.Music21Object.hasEditorialInformation`
   - :attr:`~music21.base.Music21Object.hasStyleInformation`
   - :attr:`~music21.base.Music21Object.measureNumber`

Read-only properties inherited from :class:`~music21.prebase.ProtoM21Object`:

.. hlist::
   :columns: 3

   - :attr:`~music21.prebase.ProtoM21Object.classSet`
   - :attr:`~music21.prebase.ProtoM21Object.classes`

.. rubric:: :class:`~music21.key.Key` read/write properties

Read/write properties inherited from :class:`~music21.key.KeySignature`:

.. hlist::
   :columns: 3

   - :attr:`~music21.key.KeySignature.alteredPitches`
   - :attr:`~music21.key.KeySignature.sharps`

Read/write properties inherited from :class:`~music21.scale.ConcreteScale`:

.. hlist::
   :columns: 3

   - :attr:`~music21.scale.ConcreteScale.abstract`

Read/write properties inherited from :class:`~music21.base.Music21Object`:

.. hlist::
   :columns: 3

   - :attr:`~music21.base.Music21Object.activeSite`
   - :attr:`~music21.base.Music21Object.derivation`
   - :attr:`~music21.base.Music21Object.duration`
   - :attr:`~music21.base.Music21Object.editorial`
   - :attr:`~music21.base.Music21Object.id`
   - :attr:`~music21.base.Music21Object.offset`
   - :attr:`~music21.base.Music21Object.priority`
   - :attr:`~music21.base.Music21Object.quarterLength`
   - :attr:`~music21.base.Music21Object.seconds`
   - :attr:`~music21.base.Music21Object.style`

.. rubric:: :class:`~music21.key.Key` methods

.. automethod:: music21.key.Key.__eq__

.. automethod:: music21.key.Key.deriveByDegree

.. automethod:: music21.key.Key.tonalCertainty

.. automethod:: music21.key.Key.transpose

Methods inherited from :class:`~music21.key.KeySignature`:

.. hlist::
   :columns: 3

   - :meth:`~music21.key.KeySignature.accidentalByStep`
   - :meth:`~music21.key.KeySignature.asKey`
   - :meth:`~music21.key.KeySignature.getScale`
   - :meth:`~music21.key.KeySignature.transposePitchFromC`

Methods inherited from :class:`~music21.scale.DiatonicScale`:

.. hlist::
   :columns: 3

   - :meth:`~music21.scale.DiatonicScale.getDominant`
   - :meth:`~music21.scale.DiatonicScale.getLeadingTone`
   - :meth:`~music21.scale.DiatonicScale.getParallelMajor`
   - :meth:`~music21.scale.DiatonicScale.getParallelMinor`
   - :meth:`~music21.scale.DiatonicScale.getRelativeMajor`
   - :meth:`~music21.scale.DiatonicScale.getRelativeMinor`
   - :meth:`~music21.scale.DiatonicScale.getTonic`

Methods inherited from :class:`~music21.scale.ConcreteScale`:

.. hlist::
   :columns: 3

   - :meth:`~music21.scale.ConcreteScale.derive`
   - :meth:`~music21.scale.ConcreteScale.deriveAll`
   - :meth:`~music21.scale.ConcreteScale.deriveRanked`
   - :meth:`~music21.scale.ConcreteScale.findMissing`
   - :meth:`~music21.scale.ConcreteScale.getChord`
   - :meth:`~music21.scale.ConcreteScale.getDegreeMaxUnique`
   - :meth:`~music21.scale.ConcreteScale.getPitches`
   - :meth:`~music21.scale.ConcreteScale.getScalaData`
   - :meth:`~music21.scale.ConcreteScale.getScaleDegreeAndAccidentalFromPitch`
   - :meth:`~music21.scale.ConcreteScale.getScaleDegreeFromPitch`
   - :meth:`~music21.scale.ConcreteScale.intervalBetweenDegrees`
   - :meth:`~music21.scale.ConcreteScale.isNext`
   - :meth:`~music21.scale.ConcreteScale.match`
   - :meth:`~music21.scale.ConcreteScale.next`
   - :meth:`~music21.scale.ConcreteScale.nextPitch`
   - :meth:`~music21.scale.ConcreteScale.pitchFromDegree`
   - :meth:`~music21.scale.ConcreteScale.pitchesFromScaleDegrees`
   - :meth:`~music21.scale.ConcreteScale.romanNumeral`
   - :meth:`~music21.scale.ConcreteScale.show`
   - :meth:`~music21.scale.ConcreteScale.solfeg`
   - :meth:`~music21.scale.ConcreteScale.tune`
   - :meth:`~music21.scale.ConcreteScale.write`

Methods inherited from :class:`~music21.scale.Scale`:

.. hlist::
   :columns: 3

   - :meth:`~music21.scale.Scale.extractPitchList`

Methods inherited from :class:`~music21.base.Music21Object`:

.. hlist::
   :columns: 3

   - :meth:`~music21.base.Music21Object.clearCache`
   - :meth:`~music21.base.Music21Object.containerHierarchy`
   - :meth:`~music21.base.Music21Object.contextSites`
   - :meth:`~music21.base.Music21Object.getAllContextsByClass`
   - :meth:`~music21.base.Music21Object.getContextByClass`
   - :meth:`~music21.base.Music21Object.getOffsetBySite`
   - :meth:`~music21.base.Music21Object.getOffsetInHierarchy`
   - :meth:`~music21.base.Music21Object.getSpannerSites`
   - :meth:`~music21.base.Music21Object.informSites`
   - :meth:`~music21.base.Music21Object.mergeAttributes`
   - :meth:`~music21.base.Music21Object.previous`
   - :meth:`~music21.base.Music21Object.purgeLocations`
   - :meth:`~music21.base.Music21Object.purgeOrphans`
   - :meth:`~music21.base.Music21Object.setOffsetBySite`
   - :meth:`~music21.base.Music21Object.sortTuple`
   - :meth:`~music21.base.Music21Object.splitAtDurations`
   - :meth:`~music21.base.Music21Object.splitAtQuarterLength`
   - :meth:`~music21.base.Music21Object.splitByQuarterLengths`

Methods inherited from :class:`~music21.prebase.ProtoM21Object`:

.. hlist::
   :columns: 3

   - :meth:`~music21.prebase.ProtoM21Object.isClassOrSubclass`

.. rubric:: :class:`~music21.key.Key` instance variables

Instance variables inherited from :class:`~music21.base.Music21Object`:

.. hlist::
   :columns: 3

   - :attr:`~music21.base.Music21Object.classSortOrder`
   - :attr:`~music21.base.Music21Object.groups`
   - :attr:`~music21.base.Music21Object.isStream`
   - :attr:`~music21.base.Music21Object.sites`

Functions
---------

.. autofunction:: music21.key.convertKeyStringToMusic21KeyString

.. autofunction:: music21.key.pitchToSharps

.. autofunction:: music21.key.sharpsToPitch