rh|T%SrSSKJr SSKrSSKrSSKrSSKrSSKrSSK J r SSK J r SSK J r SSK Jr SSK Jr SS K Jr SS KJr SS K Jr SS K Jr SS K Jr SSK Jr SSK Jr SSK Jr \ "S/SQ5r\ "S/SQ5r\R8"S5r\R<"SSS9r\R@"S5r!\R@"S5r"0r#S\$S'0r%S\$S'\RL"5r'Sr(S \$S!'SS"jr)0S#S$_S%S$_S&S'_S(S)_S*S)_S+S)_S,S-_S.S-_S/S-_S0S-_S1S-_S2S-_S3S4_S5S6_S7S8_S9S:_S;S<_S=S.Er*00S?.r+S@\$SA'0SBSC_SDSE_SFSG_SHSI_SJSK_SLSM_SNSO_SPSQ_SRSS_STSU_SVSW_SXSY_SZS[_S\S]_S^S__S`Sa_SbSc_0SdSe_SfSg_ShSi_SjSk_SlSm_SnSo_SpSq_SrSs_StSu_SvSw_SxSy_SzS{_S|S}_S~S_SS_SS_SS_ESSSSSSSSSSSSSSS.Er,S\$S'Sr-Sr.SSjr/SSjr0SSjr1SSjr2SSSjjr3SSjr4SSSjjr5"SS\Rl5r7"SS\Rp5r9"SS\:\95r;"SS\Rx5r=S\=R|l"SS\R~5r@"SS\R~5rA\=/rB\CS:XaSSK r \ R"\@5 gg)z7 Music21 class for dealing with Roman Numeral analysis ) annotationsN) namedtuple)chord)common)defaults) environment) exceptions21)notation)harmony)intervalkey)note)pitch)scale FigureTuple) aboveBassalterprefixChordFigureTuple)rrrrromanT RomanNumeral)boundz#*-*b*o*[1-9xyz]z[b\-]$zdict[str, scale.ConcreteScale] _scaleCachezdict[str, key.Key] _keyCache)))r)r)rr)rr )rrr)rr)rr)rr!)r!)rr r)rr rr)rrrr!)r"r rr!) r"rr r)r"rr rr)r#rr rr)r#r"rrr)r"rr rr!ztuple[tuple[int, ...], ...]FIGURES_IMPLYING_ROOTcU[;a[R"[U5nU$[R"U5nU[UR'U$)zl get a key from the cache if it is there; otherwise create a new key and put it in the cache and return it. )rcopyrKeytonicPitchNameWithCase)keyStrkeyObjs G/home/james-whalen/.local/lib/python3.13/site-packages/music21/roman.py_getKeyFromCacher,LsL  9V,- M39 &//0 M5336367537757397539975953979593653656b536b56434364242bb7b5b3o7uø7)b7b5b3bb7b53b7b53majorminorzdict[str, dict]figureShorthandsModeIdiZV7PVFV65DI6AV6?V43=I64<IV;i6:viio79V427viio655viio64z#viio653ii2z#viio61ii650ii43/ii42.IV6-ii6+VI*#VI)vi(viio'z#viio&iio%iio42$bII6#It6"Ger65!iio43  )iio65Fr43z#vioz#vio6IIISw43vVIIVII7IV65IV7iiiiii6vi6zdict[str, int]functionalityScorescHURSS5n[RU5(aUS- n[R"SSU5n[R"SSU5n[R"SS U5n[ R U5n[U5S :Xa US RS5(aS US /n/nUH\n[R"SSU5n[R"SSU5n[R"S SU5nURU5 M^ U$) a Expands shorthand notation into a list with all figures expanded: >>> roman.expandShortHand('64') ['6', '4'] >>> roman.expandShortHand('973') ['9', '7', '3'] >>> roman.expandShortHand('11b3') ['11', 'b3'] >>> roman.expandShortHand('b13#9-6') ['b13', '#9', '-6'] >>> roman.expandShortHand('-') ['5', '-3'] Slashes don't matter: >>> roman.expandShortHand('6/4') ['6', '4'] Note that this is not where abbreviations get expanded: >>> roman.expandShortHand('') [] >>> roman.expandShortHand('7') # not 7, 5, 3 ['7'] >>> roman.expandShortHand('4/3') # not 6, 4, 3 ['4', '3'] Note that this is ['6'] not ['6', '3']: >>> roman.expandShortHand('6') ['6'] Returns a list of individual shorthands. /r/r011x13y15zr5) replaceENDWITHFLAT_REmatchresub SHORTHAND_REfindalllenendswithappend) shorthandshorthandGroups shGroupOutshs r+expandShortHandrsH!!#r*II&&S tS),ItS),ItS),I"**95O ?q _Q%7%@%@%E%E 23J VVCr " VVCr " VVCr ""  r-cURS5nUS:XaSnO US:XaSnOSnU(a`URS5(dBURS5(d,URS5(dURS 5(aUS:XaSnURS 5nU(aUS:XaUS :Xa US:XaS nX1-$US :waX1-$) z Correct a given inversionString suffix given a chord of various qualities. >>> c = chord.Chord('E3 C4 G4') >>> roman.correctSuffixForChordQuality(c, '6') '6' >>> c = chord.Chord('E3 C4 G-4') >>> roman.correctSuffixForChordQuality(c, '6') 'o6' r ro+r/°/oør"rr#)semitonesFromChordStep startswith)chordObjinversionString fifthType qualityName seventhTypes r+correctSuffixForChordQualityrs//2IA~ a  O66s;;.99$??.99$??.99$?? # K11!4KyA~ " !3K  ((A    ((r-cZUc$[R"UR55n[X5nUSRn/nUR nUR nURnUS:waSnSn Sn ObUR5n U (aSOUR5n U =(d0 U =(d' UR5=(d UR5n[USS9Hn U Rn U RS:wa U RULaU (dU (aSn O(U RS:waU RULa U(aSn U RS:Xa:U RU:wa(U S:wa U S-n X;aUR!SU 5 MMMMU [#U R5-n X;dMUR%U 5 M SR'U5nUR(nU[*;aU[*U;a [*UnOU[,;a [,UnUS ;aS n[/X5nU$) a" (Note: this will become a private function by v10.) Returns the post-RN figure for a given chord in a given key. If keyObj is none, it uses the root as a major key: >>> roman.postFigureFromChordAndKey( ... chord.Chord(['F#2', 'D3', 'A-3', 'C#4']), ... key.Key('C'), ... ) 'o6#5b3' The function substitutes shorthand (e.g., '6' not '63') >>> roman.postFigureFromChordAndKey( ... chord.Chord(['E3', 'C4', 'G4']), ... key.Key('C'), ... ) '6' >>> roman.postFigureFromChordAndKey( ... chord.Chord(['E3', 'C4', 'G4', 'B-5']), ... key.Key('F'), ... ) '65' >>> roman.postFigureFromChordAndKey( ... chord.Chord(['E3', 'C4', 'G4', 'B-5']), ... key.Key('C'), ... ) '6b5' We reduce common omissions from seventh chords to be '7' instead of '75', '73', etc. >>> roman.postFigureFromChordAndKey( ... chord.Chord(['A3', 'E-4', 'G-4']), ... key.Key('b-'), ... ) 'o7' OMIT_FROM_DOCS Fails on German Augmented 6th chords in root position. Calls them half-diminished chords. (This is in OMIT_FROM_etc.) rrFcbSUR-URURR4$)N)rrrps)tups r++postFigureFromChordAndKey..bs b3==&8#))SYY\\%Rr-r rr/8)r5r6r4)rr'root figureTuplesrthirdfifthpitchClassCardinality isMajorTriad isMinorTriadisDiminishedTriadisAugmentedTriadsortedrrrinsertstrrjoinmoderNfigureShorthandsr)rr*chordFigureTuplesbassFigureAlterallFigureStringListrrchordCardinalitychordObjIsStandardTriadrrftr figureStringallFigureStringkey_modes r+postFigureFromChordAndKeyrsd~)$X6'*00O NNE NNE 551"'  ,,. ,u(2G2G2I  + +))+ +((* &RT <<1 U!2|lla((e#)F <<1 xx?*v|%| :'..q,?;0<*"C $55L6#**<85T8gg12O{{H''O?ST\?],].? , ,*?;,&28MO r-c/nUR5nURHLn[XAU5n[URUR UR U5nURU5 MN U$)aI (This will become a private function in v10) Return a set of tuplets for each pitch showing the presence of a note, its interval above the bass its alteration (float) from a step in the given key, an `alterationString`, and the pitch object. Note though that for roman numerals, the applicable key is almost always the root. For instance, in C major, F# D A- C# would be: >>> roman.figureTuples( ... chord.Chord(['F#2', 'D3', 'A-3', 'C#4']), ... key.Key('C'), ... ) [ChordFigureTuple(aboveBass=1, alter=1.0, prefix='#', pitch=), ChordFigureTuple(aboveBass=6, alter=0.0, prefix='', pitch=), ChordFigureTuple(aboveBass=3, alter=-1.0, prefix='b', pitch=), ChordFigureTuple(aboveBass=5, alter=1.0, prefix='#', pitch=)] In c-minor, the A- is a normal note, so the prefix is '' not 'b'. The natural minor is used exclusively. >>> roman.figureTuples( ... chord.Chord(['F#2', 'D3', 'A-3', 'C#4']), ... key.Key('c'), ... ) [ChordFigureTuple(aboveBass=1, alter=1.0, prefix='#', pitch=), ChordFigureTuple(aboveBass=6, alter=0.0, prefix='', pitch=), ChordFigureTuple(aboveBass=3, alter=0.0, prefix='', pitch=), ChordFigureTuple(aboveBass=5, alter=1.0, prefix='#', pitch=)] A C dominant-seventh chord in c minor alters the bass but not the 7th degree >>> roman.figureTuples( ... chord.Chord(['E3', 'C4', 'G4', 'B-5']), ... key.Key('c'), ... ) [ChordFigureTuple(aboveBass=1, alter=1.0, prefix='#', pitch=), ChordFigureTuple(aboveBass=6, alter=0.0, prefix='', pitch=), ChordFigureTuple(aboveBass=3, alter=0.0, prefix='', pitch=), ChordFigureTuple(aboveBass=5, alter=0.0, prefix='', pitch=)] >>> roman.figureTuples( ... chord.Chord(['C4', 'E4', 'G4', 'C#4']), ... key.Key('C'), ... ) [ChordFigureTuple(aboveBass=1, alter=0.0, prefix='', pitch=), ChordFigureTuple(aboveBass=3, alter=0.0, prefix='', pitch=), ChordFigureTuple(aboveBass=5, alter=0.0, prefix='', pitch=), ChordFigureTuple(aboveBass=1, alter=1.0, prefix='#', pitch=)] )basspitchesfigureTupleSolorrrrr) chordObject keyObjectresultr thisPitch shortTuple appendTuples r+rrsplF    D (( $Y4@ &z';';'1'7'7'1'8'8'02   k" ) Mr-c(URU5up4[R"X 5nURRR nUcSnSnO4UR n[U5n U S:a SSU --nOU S:aSU -nOSn[XhU5n U $)a Return a single tuple for a pitch and key showing the interval above the bass, its alteration from a step in the given key, an alteration string, and the pitch object. For instance, in C major, an A-3 above an F# bass would be: >>> roman.figureTupleSolo( ... pitch.Pitch('A-3'), ... key.Key('C'), ... pitch.Pitch('F#2'), ... ) FigureTuple(aboveBass=3, alter=-1.0, prefix='b') These figures can be more complex in minor, so this is a good reference, showing that natural minor is always used. >>> c = key.Key('c') >>> c_as_bass = pitch.Pitch('C3') >>> for name in ('E--', 'E-', 'E', 'E#', 'A--', 'A-', 'A', 'A#', 'B--', 'B-', 'B', 'B#'): ... ft = roman.figureTupleSolo(pitch.Pitch(name + '4'), c, c_as_bass) ... print(f'{name:4s} {ft}') E-- FigureTuple(aboveBass=3, alter=-1.0, prefix='b') E- FigureTuple(aboveBass=3, alter=0.0, prefix='') E FigureTuple(aboveBass=3, alter=1.0, prefix='#') E# FigureTuple(aboveBass=3, alter=2.0, prefix='##') A-- FigureTuple(aboveBass=6, alter=-1.0, prefix='b') A- FigureTuple(aboveBass=6, alter=0.0, prefix='') A FigureTuple(aboveBass=6, alter=1.0, prefix='#') A# FigureTuple(aboveBass=6, alter=2.0, prefix='##') B-- FigureTuple(aboveBass=7, alter=-1.0, prefix='b') B- FigureTuple(aboveBass=7, alter=0.0, prefix='') B FigureTuple(aboveBass=7, alter=1.0, prefix='#') B# FigureTuple(aboveBass=7, alter=2.0, prefix='##') Returns a namedtuple called a FigureTuple. r/rbr#) $getScaleDegreeAndAccidentalFromPitchr Intervaldiatonicgenericmod7rintr) pitchObjr*runused_scaleStepscaleAccidental thisIntervalrrootAlterationString alterDiffrrs r+rrsT)/(S(ST\(]%$$T4L%%--22I! #)) I 19#&"u*#5 QY#&; #% i4HIK r-c[U[[45(a[R"U5nO*[U[R5(d [ S5e/nUR HnURUR5 M URS5nURS5nSnSnURU;aSnOURU;aSnO[SU5R n[SU5R n /n UHnU RUR5 M /n U HnU RUR5 M [[U 5[U5-5n [[U 5[U5-5n X:aSnO X:aSnOgU(aY[R"S5nURS:XaUR!5nOUR#5nUR%U5 O0U(a([R"S5nUR%U5 OgU['U5-$) a Returns the roman numeral string expression (either tonic or dominant) that best matches the inChord. Useful when you know inChord is either tonic or dominant, but only two pitches are provided in the chord. If neither tonic nor dominant is possibly correct, False is returned >>> roman.identifyAsTonicOrDominant(['B2', 'F5'], key.Key('C')) 'V65' >>> roman.identifyAsTonicOrDominant(['B3', 'G4'], key.Key('g')) 'i6' >>> roman.identifyAsTonicOrDominant(['C3', 'B-4'], key.Key('f')) 'V7' Notice that this -- with B-natural is also identified as V7 because it is returning the roman numeral root and the inversion name, not yet checking for correctness. >>> roman.identifyAsTonicOrDominant(['C3', 'B4'], key.Key('f')) 'V7' >>> roman.identifyAsTonicOrDominant(['D3'], key.Key('f')) False z,inChord must be a Chord or a list of stringsrr FTI7rSrM) isinstancelisttuplerChord ValueErrorrrnamepitchFromDegreerrsetrtoRomanrlowerupperrromanInversionName)inChordinKey pitchNameListroneRootfiveRootoneChordIdentifiedfiveChordIdentified oneRomanChordfiveRomanChordonePitchNameListfivePitchNameList oneMatches fiveMatches rootScaleDegs r+identifyAsTonicOrDominantr*s:'D%=))++g&  - -GHHM __QVV$##A&G$$Q'H||}$! - '"$T5199 %dE2::A  # #AFF +A  $ $QVV , -.]1CCD #/03}3EEF  #!%   %"& ~~a( :: '--/L'--/L W ~~a(  X ,W5 55r-cRUcUR5nUR5(d URbUS:XagUS:XagUS:XagUS:Xagg UR5(d*UR 5(dUR 5(aUS:Xag US:Xag US:Xag g g ) a< Extremely similar to Chord's inversionName() method, but returns string values and allows incomplete triads. >>> roman.romanInversionName(chord.Chord('E4 G4 C5')) '6' >>> roman.romanInversionName(chord.Chord('G4 B4 C5 E5')) '43' Manually set the inversion to see what would happen. >>> roman.romanInversionName(chord.Chord('C5 E5 G5'), inv=2) '64' >>> roman.romanInversionName(chord.Chord('C5 E5 G5'), inv=0) '' Uncommon/unusual chords return an empty string >>> roman.romanInversionName(chord.Chord('C5 C#4')) '' Does not return ninth or eleventh chord figures. rr4rr?r!rCrrEr/r264) inversion isSeventhseventhisTriadisIncompleteMajorTriadisIncompleteMinorTriad)rinvs r+rrbs8 {!goo9 !8 AX AX AX //  --//--// !8 AX AXr-c URS:waU$URS;aU$URnURnUS:XaSnSnO'US:XaSnSnOUS:a US- nUSS nO US:aSU-n[ URX#5$) aq (This will become a private function in version 10) Takes in a FigureTuple and a Key object and returns the same or a new FigureTuple correcting for the fact that, for instance, Ab in c minor is VI not vi. Works properly only if the note is the root of the chord. Used in RomanNumeralFromChord These return new FigureTuple objects >>> ft5 = roman.FigureTuple(aboveBass=6, alter=-1, prefix='') >>> ft5a = roman.correctRNAlterationForMinor(ft5, key.Key('c')) >>> ft5a FigureTuple(aboveBass=6, alter=-1, prefix='b') >>> ft5a is ft5 False >>> ft6 = roman.FigureTuple(aboveBass=6, alter=0, prefix='') >>> roman.correctRNAlterationForMinor(ft6, key.Key('c')) FigureTuple(aboveBass=6, alter=0, prefix='b') >>> ft7 = roman.FigureTuple(aboveBass=7, alter=1, prefix='#') >>> roman.correctRNAlterationForMinor(ft7, key.Key('c')) FigureTuple(aboveBass=7, alter=0, prefix='') Does nothing for major and passes in the original Figure Tuple unchanged: >>> ft1 = roman.FigureTuple(aboveBass=6, alter=-1, prefix='b') >>> ft2 = roman.correctRNAlterationForMinor(ft1, key.Key('C')) >>> ft2 FigureTuple(aboveBass=6, alter=-1, prefix='b') >>> ft1 is ft2 True Does nothing for steps other than 6 or 7: >>> ft3 = roman.FigureTuple(aboveBass=4, alter=-1, prefix='b') >>> ft4 = roman.correctRNAlterationForMinor(ft3, key.Key('c')) >>> ft4 FigureTuple(aboveBass=4, alter=-1, prefix='b') >>> ft3 is ft4 True rMrr"g?rr/rrrN)rrrrr) figureTupler*rr s r+correctRNAlterationForMinorr7s`{{gF*   E&-- |! #"  3AB7 "%99 {,,e JJr-c* 0SS_SS_SS_SS_SS_S S _S S _S S _SS_SS_SS_SS_SS_SS_SS_SS_SS_SSSSSSSSS S S!. EnSSSS S SSSSSSSSSS".nS#S$S%S&S'.nS(S)S*S+S,S)S*S+S-.nUS.LnUR(d [5$UR5nURS/5n U S0:XaS1n OS2n UcQU (a$[ UR R 55n O#[ UR R55n U nO+[U[5(a[R"U5n[XUR5n [X5n U RS3:Xa URn Od[ R""[ R$"S45[ R&"U R55nUR)UR5n UR*S5:XaU R R 5nOU R R5n[ U5n[,R."U R05nU (aOU (dUR5n[3UU5nU R4U-U-nU (d3UU;a-UR7S65(aU R4U-UU-nGO*U (d2UU;a,UR7S75(aU R4U-UU-nOU(d UU;aUR9S1S89(aUUnOU(aUU;aUR9S1S89(aUUnUS.S9nUS:;aJUR:n[<R>(aUce[ UR R55nOOUS;;aIUR@n[<R>(aUce[ UR R55nU(aUS<:waURC5(dURE5(aUR5RGS=5R nURIU5nU(aE[UUS2S>9RJn[MU[R"U5S2S>9RNnUS?U3n[UUS2[PRR[PRRS@9nURUlU$![TRVa!n[YSAR[UXU55eS.nAff=f)Bu# Takes a chord object and returns an appropriate chord name. If keyObj is omitted, the root of the chord is considered the key (if the chord has a major third, it's major; otherwise it's minor). >>> rn = roman.romanNumeralFromChord( ... chord.Chord(['E-3', 'C4', 'G-6']), ... key.Key('g#'), ... ) >>> rn The pitches remain the same with the same octaves: >>> for p in rn.pitches: ... p >>> romanNumeral2 = roman.romanNumeralFromChord( ... chord.Chord(['E3', 'C4', 'G4', 'B-4', 'E5', 'G5']), ... key.Key('F'), ... ) >>> romanNumeral2 Note that vi and vii in minor, by default, signifies what you might think of alternatively as #vi and #vii: >>> romanNumeral3 = roman.romanNumeralFromChord( ... chord.Chord(['A4', 'C5', 'E-5']), ... key.Key('c'), ... ) >>> romanNumeral3 >>> romanNumeral4 = roman.romanNumeralFromChord( ... chord.Chord(['A-4', 'C5', 'E-5']), ... key.Key('c'), ... ) >>> romanNumeral4 >>> romanNumeral4.sixthMinor >>> romanNumeral5 = roman.romanNumeralFromChord( ... chord.Chord(['B4', 'D5', 'F5']), ... key.Key('c'), ... ) >>> romanNumeral5 >>> romanNumeral6 = roman.romanNumeralFromChord( ... chord.Chord(['B-4', 'D5', 'F5']), ... key.Key('c'), ... ) >>> romanNumeral6 Diminished and half-diminished seventh chords can omit the third and still be diminished: (n.b. we also demonstrate that chords can be created from a string): >>> romanNumeralDim7 = roman.romanNumeralFromChord( ... chord.Chord('A3 E-4 G-4'), ... key.Key('b-'), ... ) >>> romanNumeralDim7 For reference, odder notes: >>> romanNumeral7 = roman.romanNumeralFromChord( ... chord.Chord(['A--4', 'C-5', 'E--5']), ... key.Key('c'), ... ) >>> romanNumeral7 >>> romanNumeral8 = roman.romanNumeralFromChord( ... chord.Chord(['A#4', 'C#5', 'E#5']), ... key.Key('c'), ... ) >>> romanNumeral8 >>> romanNumeral10 = roman.romanNumeralFromChord( ... chord.Chord(['F#3', 'A3', 'E4', 'C5']), ... key.Key('d'), ... ) >>> romanNumeral10 Augmented 6ths without key context >>> roman.romanNumeralFromChord( ... chord.Chord('E-4 G4 C#5'), ... ) >>> roman.romanNumeralFromChord( ... chord.Chord('E-4 G4 B-4 C#5'), ... ) >>> roman.romanNumeralFromChord( ... chord.Chord('E-4 G4 A4 C#5'), ... ) >>> roman.romanNumeralFromChord( ... chord.Chord('E-4 G4 A#4 C#5'), ... ) With correct key context: >>> roman.romanNumeralFromChord( ... chord.Chord('E-4 G4 C#5'), ... key.Key('G') ... ) With incorrect key context does not find an augmented 6th chord: >>> roman.romanNumeralFromChord( ... chord.Chord('E-4 G4 C#5'), ... key.Key('C') ... ) Empty chords, including :class:`~music21.harmony.NoChord` objects, give empty RomanNumerals: >>> roman.romanNumeralFromChord(harmony.NoChord()) Augmented 6th chords in other inversions do not currently find correct roman numerals * Changed in v7: i7 is given for a tonic or subdominant minor-seventh chord in major: >>> roman.romanNumeralFromChord( ... chord.Chord('C4 E-4 G4 B-4'), ... key.Key('C')) >>> roman.romanNumeralFromChord( ... chord.Chord('E-4 G4 B-4 C5'), ... key.Key('G')) minor-Major chords are written with a [#7] modifier afterwards: >>> roman.romanNumeralFromChord( ... chord.Chord('C4 E-4 G4 B4'), ... key.Key('C')) >>> roman.romanNumeralFromChord( ... chord.Chord('E-4 G4 B4 C5'), ... key.Key('C')) Former bugs that are now fixed: >>> romanNumeral11 = roman.romanNumeralFromChord( ... chord.Chord(['E4', 'G4', 'B4', 'D5']), ... key.Key('C'), ... ) >>> romanNumeral11 >>> roman.romanNumeralFromChord(chord.Chord('A3 C4 E-4 G4'), key.Key('c')) >>> roman.romanNumeralFromChord(chord.Chord('A3 C4 E-4 G4'), key.Key('B-')) >>> romanNumeral9 = roman.romanNumeralFromChord( ... chord.Chord(['C4', 'E5', 'G5', 'C#6']), ... key.Key('C'), ... ) >>> romanNumeral9 Not an augmented 6th: >>> roman.romanNumeralFromChord( ... chord.Chord('E4 G4 B-4 C#5') ... ) The preferSecondaryDominants option defaults to False, but if set to True, then certain rare figures are swapped with their more common secondary dominant equivalent to produce Roman numerals like 'V/V' instead of 'II'. This has no effect on most chords. A change is triggered if and only if: * the chord is a major triad or dominant seventh * the chord is not diatonic to the primary key (i.e., chromatically altered) * the root of secondary key is diatonic to the primary key. So first without setting preferSecondaryDominants: >>> cd = chord.Chord('D F# A') >>> rn = roman.romanNumeralFromChord(cd, 'C') >>> rn.figure 'II' And now with preferSecondaryDominants=True: >>> rn = roman.romanNumeralFromChord(cd, 'C', preferSecondaryDominants=True) >>> rn.figure 'V/V' Dominant sevenths must be spelt correctly (see conditions at :meth:`~music21.chord.Chord.isDominantSeventh`). So let's try D dominant seventh in various contexts. >>> cd = chord.Chord('F#4 A4 C5 D5') In G major this still comes out without recourse to a secondary, whether preferSecondaryDominants is True or False. >>> rn = roman.romanNumeralFromChord(cd, 'G') >>> rn.figure 'V65' >>> rn = roman.romanNumeralFromChord(cd, 'G', preferSecondaryDominants=True) >>> rn.figure 'V65' In C major it does come through as a secondary >>> rn = roman.romanNumeralFromChord(cd, 'C', preferSecondaryDominants=True) >>> rn.figure 'V65/V' "German Augmented sixth" chords are left intact, without change. This is thanks to the constraints on spelling and on the root of the secondary degree. >>> cd = chord.Chord('Ab4 C5 Eb5 F#5') >>> rn = roman.romanNumeralFromChord(cd, 'C', preferSecondaryDominants=True) >>> rn.figure 'Ger65' Let's check that with a dominant seventh spelling and minor key context: >>> cd = chord.Chord('Ab4 C5 Eb5 Gb5') >>> rn = roman.romanNumeralFromChord(cd, 'c', preferSecondaryDominants=True) >>> rn.figure 'bVIb753' So that's a context in which the root is diatonic, but the possible secondary root is not. Now let's do the opposite case with a root that is not diatonic and a secondary that is. >>> cd = chord.Chord('Ab4 C5 Eb5 Gb5') >>> rn = roman.romanNumeralFromChord(cd, 'c', preferSecondaryDominants=True) >>> rn.figure 'bVIb753' Watch out, because there are still a lot of chords that preferSecondaryDominants will alter. This is deliberate: this option defaults to false so it does not run unless a user specifically initiates it and actively wants to make modifications. Power users could create more specific conditions in which to call it, e.g., before/after specific chords, and they can only do so if it errs on the side of more changes. For example, in minor, 'I' will be mapped to 'V/iv'. >>> cd = chord.Chord('F4 A4 C5') >>> rn = roman.romanNumeralFromChord(cd, 'f') >>> rn.figure 'I' >>> cd = chord.Chord('F4 A4 C5') >>> rn = roman.romanNumeralFromChord(cd, 'f', preferSecondaryDominants=True) >>> rn.figure 'V/iv' This might be appropriate in the middle of a progression like i, V/iv, iv. By contrast, it's probably not wanted for a tierce de picardie at the end iv6, V, I. This kind of context-sensitivity is not currently included. OMIT_FROM_DOCS Note that this should be III+642 gives III+#642 (# before 6 is unnecessary) # >>> roman.romanNumeralFromChord(chord.Chord('B3 D3 E-3 G3'), key.Key('c')) # These two are debatable -- is the harmonic minor or the natural minor used as the basis? # >>> roman.romanNumeralFromChord(chord.Chord('F4 A4 C5 E-5'), key.Key('c')) # # # >>> roman.romanNumeralFromChord(chord.Chord('F4 A4 C5 E5'), key.Key('c')) # # (This is in OMIT_FROM_etc.) z#ivo6b3rz#ivob64It64z#ivobb64z#ivob5b3It53z #ivob5bb3uIIø#643ruIIø75#3Fr7u IIø7b5#3uIIø6#42Fr42u IIøb6#42uIIø65Fr65uIIø65b3z#ii64b3ru#iiø7Sw7z #iib7bb53z#iib642Sw42z#iibb642Sw65rGer43Ger42Ger7) z#ii6b5b3z #ii6b5bb3z #ivo6b5b3z #ivo6bb5b3z #ivob64b3z #ivobb64bb3z #ivob6b42z #ivob6bb42u#ivø7z #ivobb7b5bb3)io6b3iob64iob5b3uIø64b3uIøb7b53uIøb642uIø6b5b3i64b3ib7bb53ibb642i6b5bb3io6b5b3iob64b3iob6b42r4r?rCrE)b75b3rAb64b36b42z7[#7]z65[#7]z43[#7]z42[#7]z#7)75b3r?b643rPz#753z6#53z64#3rENrrTFrrrL)rrr"r)rrr" )permitAnyInversionr!)ItGeFrSwrUP4)preferSecondaryDominantsr) updatePitches sixthMinor seventhMinorz;Could not parse {0} from chord {1} as an RN in key {2}: {3}).rrrrr,rrrrrrr'rtonicr7rr intervalFromGenericAndChromaticGenericIntervalChromaticIntervaltransposePitchrrrrrrisSeventhOfTypeisAugmentedSixthrt TYPE_CHECKINGr/isDominantSeventhr transposegetScaleDegreeFromPitchromanNumeralAloneromanNumeralFromChordfigureMinor67Default CAUTIONARY fbNotationModifierExceptionRomanNumeralExceptionformat)rr*r[aug6subsaug6NoKeyObjectSubsminorSeventhSubsminorMajorSeventhSubs noKeyGivenr thirdType isMajorThird rootKeyObjr tonicPitchtransposeIntervaltonicPitchName alteredKeyObj stepRomanrrnStringnationalityStartrr/possibleSecondaryTonicdegreesecondaryAsRoman primaryFigurernstrerrors r+rlrlsbJ 56 F F  V  F E U F V & F 6 %!" U#$ 6%& F'(=HB%*  D.J   ~ ==?D//2IA~  ~ )$))//*;>> vi = lambda sixChord, quality: ' '.join(p.name for p in roman.RomanNumeral( ... sixChord, ... 'c', ... sixthMinor=quality).pitches) The default for new chords is `QUALITY`, which means that the chord quality (major, minor, diminished) determines what note is the root, lowered ^6 or raised ^6: >>> vi('vi', roman.Minor67Default.QUALITY) 'A C E' >>> vi('VI', roman.Minor67Default.QUALITY) 'A- C E-' The enumeration `FLAT` means that lowered ^6 is used for the root no matter what. (Note that `FLAT` does not mean that the root will have a flat sign on it, for instance, in f-sharp minor, lowered ^6 is D natural. and in a-sharp minor, lowered ^6 is F#.) >>> vi('vi', roman.Minor67Default.FLAT) 'A- C- E-' >>> vi('VI', roman.Minor67Default.FLAT) 'A- C E-' Conversely, `SHARP` implies that raised ^6 is used no matter what. >>> vi('vi', roman.Minor67Default.SHARP) 'A C E' >>> vi('VI', roman.Minor67Default.SHARP) 'A C# E' Since `FLAT` assumes lowered ^6 whether the chord is major or minor (or anything else), to get a raised ^6 with the `FLAT` enumeration add a sharp before the name: >>> vi('#vi', roman.Minor67Default.FLAT) 'A C E' Likewise, with `SHARP`, a flat sign is needed to get lowered ^6: >>> vi('bVI', roman.Minor67Default.SHARP) 'A- C E-' The enumeration of `CAUTIONARY` is identical to `QUALITY` except that it ignores the `#` in #vi and the `b` in bVI, allowing users to write these chords in two different way. `CAUTIONARY` is recommended in the case where users from different systems of training are working together, and no exotic chords (such as major triads on raised ^6) are used. >>> vi('#vi', roman.Minor67Default.CAUTIONARY) 'A C E' >>> vi('vi', roman.Minor67Default.CAUTIONARY) 'A C E' >>> vi('bVI', roman.Minor67Default.CAUTIONARY) 'A- C E-' >>> vi('VI', roman.Minor67Default.CAUTIONARY) 'A- C E-' Whereas `QUALITY` follows a strict interpretation of what preceeding sharp and flat signs mean. With `QUALITY`, since vi is already sharpened, #vi raises it even more. And since VI is already flattened, bVI lowers it even further: >>> vi('vi', roman.Minor67Default.QUALITY) 'A C E' >>> vi('#vi', roman.Minor67Default.QUALITY) 'A# C# E#' >>> vi('VI', roman.Minor67Default.QUALITY) 'A- C E-' >>> vi('bVI', roman.Minor67Default.QUALITY) 'A-- C- E--' If you are using the `CAUTIONARY` enum, these odd chords can still be created, but an additional sharp or flat should be used. >>> vi('##vi', roman.Minor67Default.CAUTIONARY) 'A# C# E#' >>> vi('bbVI', roman.Minor67Default.CAUTIONARY) 'A-- C- E--' For other odd chords that are contrary to the standard minor interpretation in the "wrong" direction, the interpretation is the same as `QUALITY`. For instance, here is a major triad on raised ^6 (what might be generally conceived of as V/ii), in the `QUALITY` and `CAUTIONARY` systems: >>> vi('#VI', roman.Minor67Default.QUALITY) 'A C# E' >>> vi('#VI', roman.Minor67Default.CAUTIONARY) 'A C# E' And a minor triad on lowered ^6. >>> vi('bvi', roman.Minor67Default.QUALITY) 'A- C- E-' >>> vi('bvi', roman.Minor67Default.CAUTIONARY) 'A- C- E-' All these examples use ^6, but the same concepts apply to ^7 using `seventhMinor` instead. This enumeration applies to secondary chords built on ^6 or ^7: >>> vi('V/vi', roman.Minor67Default.QUALITY) 'E G# B' >>> vi('V/VI', roman.Minor67Default.QUALITY) 'E- G B-' >>> vi('V/vi', roman.Minor67Default.FLAT) 'E- G B-' >>> vi('V/VI', roman.Minor67Default.FLAT) 'E- G B-' * Changed in v8: previously `sixthMinor` and `seventhMinor` did not carry over to secondary roman numerals. rr!rrN) __name__ __module__ __qualname____firstlineno____doc__QUALITYroSHARPFLAT__static_attributes__rr-r+rnrnszvGJ E Dr-rnc\rSrSrSrSrg)RomanExceptionikzN RomanException will be removed in v10. Catch RomanNumeralException instead. rN)rrrrrrrr-r+rrksr-rc\rSrSrSrg)rriqrN)rrrrrrr-r+rrrrqsr-rrcV^\rSrSr%SrSr\R"S5r\R"S5r \R"S5r \R"S5r \R"S5r \R"S 5r \R"S 5rS S S S S.r\R"S5r0SS_SS_SS_SS_SS_SS_SS_SS_S S!_S"S#_S$S%_S&S'_S(S)_S*S+_S,S-_S.S/_S0S1_S2S3S4S5S6.ErS7\S8'S^S9S9\R(\R(S:.S_U4S;jjjjrS<rS=rS>rS?rS`S@jrSaSAjrSbSBjrScSCjrSdSeSDjjrS`SEjrS`SFjr S`SGjr!S`SHjr"SfSIjr#SgSJjr$ShSKjr%SaSLjr&SMSN.SiU4SOjjjr'\(SjSPj5r)\)RTSkSQj5r)\(SjSRj5r+\+RTSlSSj5r+\(SjSTj5r,\(SU5r-\-RTSV5r-\(SmSWj5r.SdSnSXjjr/\(SoSYj5r0\0RTSpSZj5r0SqSrS[jjr1SsStS\jjr2S]r3U=r4$)urixu@ A RomanNumeral object is a specialized type of :class:`~music21.harmony.Harmony` object that stores the function and scale degree of a chord within a :class:`~music21.key.Key`. >>> ivInE = roman.RomanNumeral('IV', key.Key('E')) >>> ivInE.pitches (, , ) Octaves assigned are arbitrary (generally C-4 or above) and just exist to keep the pitches properly sorted. Major and minor are written with capital and lowercase numerals respectively. Inversions and seventh-, ninth-, etc. chords are specified by putting the figured bass symbols directly after the chord. Keys can be specified with Key objects or (less efficiently) a string. Dominant-seventh chord in c minor. >>> roman.RomanNumeral('V7', 'c').pitches (, , , ) Minor chord on the fifth scale degree, in second inversion: >>> roman.RomanNumeral('v64', 'c').pitches (, , ) If no Key is given then it exists as a theoretical, keyless RomanNumeral; e.g., V in any key. But when realized, keyless RomanNumerals are treated as if they are in C major. >>> V = roman.RomanNumeral('V') >>> V.quality 'major' >>> V.inversion() 0 >>> V.forteClass '3-11B' >>> V.scaleDegree 5 Default key is C Major >>> for p in V.pitches: ... p Neapolitan chords can be written as 'N6', 'bII6', or simply 'N' >>> neapolitan = roman.RomanNumeral('N6', 'c#') >>> neapolitan.key >>> neapolitan.isMajorTriad() True >>> neapolitan.scaleDegreeWithAlteration (2, ) >>> for p in neapolitan.pitches: ... p >>> neapolitan2 = roman.RomanNumeral('bII6', 'g#') >>> [str(p) for p in neapolitan2.pitches] ['C#5', 'E5', 'A5'] >>> neapolitan2.scaleDegree 2 Here's another dominant seventh chord in minor: >>> em = key.Key('e') >>> dominantV = roman.RomanNumeral('V7', em) >>> [str(p) for p in dominantV.pitches] ['B4', 'D#5', 'F#5', 'A5'] Now using the older terminology where the case does not determine the quality, it becomes a minor-seventh chord: >>> minorV = roman.RomanNumeral('V43', em, caseMatters=False) >>> [str(p) for p in minorV.pitches] ['F#4', 'A4', 'B4', 'D5'] (We will do this `str(p) for p in` thing enough that let's make a helper function:) >>> def cp(rn_in): # cp = chord pitches ... return [str(p) for p in rn_in.pitches] >>> cp(minorV) ['F#4', 'A4', 'B4', 'D5'] In minor -- VII and VI are assumed to refer to the flattened scale degree, while vii, viio, viio7, viiø7 and vi, vio, vio7, and viø7 all refer to the sharpened scale degree. To get a minor triad on lowered 6 for instance, you will need to use 'bvi' while to get a major triad on raised 6, use '#VI'. The actual rule is that if the chord implies minor, diminished, or half-diminished, an implied "#" is read before the figure. Anything else does not add the sharp. The lowered (natural minor) is the assumed basic chord. >>> majorFlatSeven = roman.RomanNumeral('VII', em) >>> cp(majorFlatSeven) ['D5', 'F#5', 'A5'] >>> minorSharpSeven = roman.RomanNumeral('vii', em) >>> cp(minorSharpSeven) ['D#5', 'F#5', 'A#5'] >>> majorFlatSix = roman.RomanNumeral('VI', em) >>> cp(majorFlatSix) ['C5', 'E5', 'G5'] >>> minorSharpSix = roman.RomanNumeral('vi', em) >>> cp(minorSharpSix) ['C#5', 'E5', 'G#5'] These rules can be changed by passing in a `sixthMinor` or `seventhMinor` parameter set to a member of :class:`music21.roman.Minor67Default`: >>> majorSharpSeven = roman.RomanNumeral('VII', em, seventhMinor=roman.Minor67Default.SHARP) >>> cp(majorSharpSeven) ['D#5', 'F##5', 'A#5'] For instance, if you prefer a harmonic minor context where VI (or vi) always refers to the lowered 6 and viio (or VII) always refers to the raised 7, send along `sixthMinor=roman.Minor67Default.FLAT` and `seventhMinor=roman.Minor67Default.SHARP` >>> dimHarmonicSeven = roman.RomanNumeral('viio', em, seventhMinor=roman.Minor67Default.SHARP) >>> cp(dimHarmonicSeven) ['D#5', 'F#5', 'A5'] >>> majHarmonicSeven = roman.RomanNumeral('bVII', em, seventhMinor=roman.Minor67Default.SHARP) >>> cp(majHarmonicSeven) ['D5', 'F#5', 'A5'] >>> majHarmonicSix = roman.RomanNumeral('VI', em, sixthMinor=roman.Minor67Default.FLAT) >>> cp(majHarmonicSix) ['C5', 'E5', 'G5'] >>> minHarmonicSix = roman.RomanNumeral('#vi', em, sixthMinor=roman.Minor67Default.FLAT) >>> cp(minHarmonicSix) ['C#5', 'E5', 'G#5'] See the docs for :class:`~music21.roman.Minor67Default` for more information on configuring sixth and seventh interpretation in minor along with the useful `CAUTIONARY` setting where CAUTIONARY sharp and flat accidentals are allowed but not required. Either of these is the same way of getting a minor iii in a minor key: >>> minoriii = roman.RomanNumeral('iii', em, caseMatters=True) >>> cp(minoriii) ['G4', 'B-4', 'D5'] >>> minoriiiB = roman.RomanNumeral('IIIb', em, caseMatters=False) >>> cp(minoriiiB) ['G4', 'B-4', 'D5'] `caseMatters=False` will prevent `sixthMinor` or `seventhMinor` from having effect. >>> vii = roman.RomanNumeral('viio', 'a', caseMatters=False, ... seventhMinor=roman.Minor67Default.QUALITY) >>> cp(vii) ['G5', 'B-5', 'D-6'] Can also take a scale object, here we build a first-inversion chord on the raised-three degree of D-flat major, that is, F#-major (late Schubert would be proud.) >>> sharp3 = roman.RomanNumeral('#III6', scale.MajorScale('D-')) >>> sharp3.scaleDegreeWithAlteration (3, ) >>> cp(sharp3) ['A#4', 'C#5', 'F#5'] >>> sharp3.figure '#III6' Figures can be changed and pitches will change. (Caution: there are still some bugs on this for extreme edge cases). >>> sharp3.figure = 'V' >>> cp(sharp3) ['A-4', 'C5', 'E-5'] A diminished chord is specified with an `o` (the letter-O) or `°` symbol: >>> leadingToneSeventh = roman.RomanNumeral( ... 'viio', scale.MajorScale('F')) >>> cp(leadingToneSeventh) ['E5', 'G5', 'B-5'] >>> cp(roman.RomanNumeral('vii°7', 'F')) ['E5', 'G5', 'B-5', 'D-6'] Note in the above example we passed in a Scale object not a Key. This can be used in the theoretical case of applying roman numerals in 7-note scales that are not major or minor. (see the documentation for the :attr:`~music21.roman.RomanNumeral.scaleCardinality` attribute for scales other than 7-note scales). Half-diminished seventh chords can be written with either `ø` or `/o` symbol: >>> cp(roman.RomanNumeral('viiø7', 'F')) ['E5', 'G5', 'B-5', 'D6'] >>> cp(roman.RomanNumeral('vii/o7', 'F')) ['E5', 'G5', 'B-5', 'D6'] RomanNumeral objects can also be created with an int (number) for the scale degree: >>> majorKeyObj = key.Key('C') >>> roman.RomanNumeral(1, majorKeyObj) >>> minorKeyObj = key.Key('c') >>> roman.RomanNumeral(1, minorKeyObj) A little modal mixture: >>> lessObviousDiminished = roman.RomanNumeral( ... 'vio', scale.MajorScale('c')) >>> for p in lessObviousDiminished.pitches: ... p >>> diminished7th = roman.RomanNumeral( ... 'vio7', scale.MajorScale('c')) >>> for p in diminished7th.pitches: ... p >>> diminished7th1stInv = roman.RomanNumeral( ... 'vio65', scale.MajorScale('c')) >>> for p in diminished7th1stInv.pitches: ... p >>> halfDim7th2ndInv = roman.RomanNumeral( ... 'ivø43', scale.MajorScale('F')) >>> for p in halfDim7th2ndInv.pitches: ... p >>> alteredChordHalfDim3rdInv = roman.RomanNumeral( ... 'biiø42', scale.MajorScale('F')) >>> cp(alteredChordHalfDim3rdInv) ['F-4', 'G-4', 'B--4', 'D--5'] >>> alteredChordHalfDim3rdInv.intervalVector [0, 1, 2, 1, 1, 1] >>> alteredChordHalfDim3rdInv.commonName 'half-diminished seventh chord' >>> alteredChordHalfDim3rdInv.romanNumeral 'bii' >>> alteredChordHalfDim3rdInv.romanNumeralAlone 'ii' Tones may be omitted by putting the number in a bracketed [noX] clause. These numbers refer to the note above the root, not above the bass: >>> openFifth = roman.RomanNumeral('V[no3]', key.Key('F')) >>> openFifth.pitches (, ) >>> openFifthInv = roman.RomanNumeral('V64[no3]', key.Key('F')) >>> openFifthInv.pitches (, ) Some theoretical traditions express a viio7 as a V9 chord with omitted root. Music21 allows that: >>> fiveOhNine = roman.RomanNumeral('V9[no1]', key.Key('g')) >>> cp(fiveOhNine) ['F#5', 'A5', 'C6', 'E-6'] Putting [no] or [add] should never change the root >>> fiveOhNine.root() Tones may be added by putting a number (with an optional accidental) in a bracketed [addX] clause: >>> susChord = roman.RomanNumeral('I[add4][no3]', key.Key('C')) >>> susChord.pitches (, , ) >>> susChord.root() Figures such as 'V54' give the same result: >>> anotherSus = roman.RomanNumeral('V54', key.Key('C')) >>> anotherSus.pitches (, , ) Putting it all together: >>> weirdChord = roman.RomanNumeral('V65[no5][add#6][b3]', key.Key('C')) >>> cp(weirdChord) ['B-4', 'E#5', 'F5', 'G5'] >>> weirdChord.root() Other scales besides major and minor can be used. Just for kicks (no worries if this is goobley-gook): >>> ots = scale.OctatonicScale('C2') >>> rn_I9 = roman.RomanNumeral('I9', ots, caseMatters=False) >>> cp(rn_I9) ['C2', 'E-2', 'G-2', 'A2', 'C3'] >>> romanNumeral2 = roman.RomanNumeral( ... 'V7#5b3', ots, caseMatters=False) >>> cp(romanNumeral2) ['G-2', 'A-2', 'C#3', 'E-3'] >>> rn_minor_64_secondary = roman.RomanNumeral('v64/V', key.Key('e')) >>> rn_minor_64_secondary >>> rn_minor_64_secondary.figure 'v64/V' >>> cp(rn_minor_64_secondary) ['C#5', 'F#5', 'A5'] >>> rn_minor_64_secondary.secondaryRomanNumeral Dominant 7ths can be specified by the character 'd' followed by the figure indicating the inversion of the chord: >>> r = roman.RomanNumeral('bVIId7', key.Key('B-')) >>> r.figure 'bVIId7' >>> cp(r) ['A-5', 'C6', 'E-6', 'G-6'] >>> r = roman.RomanNumeral('VId42') >>> r.figure 'VId42' >>> r.key = key.Key('B-') >>> cp(r) ['F5', 'G5', 'B5', 'D6'] >>> r = roman.RomanNumeral('IVd43', key.Key('B-')) >>> r.figure 'IVd43' >>> cp(r) ['B-4', 'D-5', 'E-5', 'G5'] >>> r2 = roman.RomanNumeral('V42/V7/vi', key.Key('C')) >>> cp(r2) ['A4', 'B4', 'D#5', 'F#5'] >>> r2.secondaryRomanNumeral >>> r2.secondaryRomanNumeral.secondaryRomanNumeral The I64 chord can also be specified as Cad64, which simply parses as I64: >>> r = roman.RomanNumeral('Cad64', key.Key('C')) >>> r >>> cp(r) ['G4', 'C5', 'E5'] >>> r = roman.RomanNumeral('Cad64', key.Key('c')) >>> r >>> cp(r) ['G4', 'C5', 'E-5'] Works also for secondary romans: >>> r = roman.RomanNumeral('Cad64/V', key.Key('c')) >>> r >>> cp(r) ['D5', 'G5', 'B5'] In a major context, i7 and iv7 and their inversions are treated as minor-7th chords: >>> r = roman.RomanNumeral('i7', 'C') >>> r >>> cp(r) ['C4', 'E-4', 'G4', 'B-4'] >>> r = roman.RomanNumeral('iv42', 'C') >>> cp(r) ['E-4', 'F4', 'A-4', 'C5'] For a minor-Major 7th chord in major, write it as i[add7] or i7[#7] or another inversion: >>> minorMajor = roman.RomanNumeral('i[add7]', 'C') >>> minorMajor >>> cp(minorMajor) ['C4', 'E-4', 'G4', 'B4'] >>> cp(roman.RomanNumeral('i7[#7]', 'C')) ['C4', 'E-4', 'G4', 'B4'] Note that this is not the same as i#7, which gives a rather unusual chord in major. >>> cp(roman.RomanNumeral('i#7', 'C')) ['C4', 'E-4', 'G4', 'B#4'] In minor, it's just fine. I mean, just as fine: >>> cp(roman.RomanNumeral('i#7', 'c')) ['C4', 'E-4', 'G4', 'B4'] >>> cp(roman.RomanNumeral('i42[#7]', 'C')) ['B4', 'C5', 'E-5', 'G5'] As noted above, Minor-Major 7th chords in minor have a different form in root position: >>> cp(roman.RomanNumeral('i#7', 'c')) ['C4', 'E-4', 'G4', 'B4'] (these are both the same) >>> cp(roman.RomanNumeral('i#753', 'c')) ['C4', 'E-4', 'G4', 'B4'] >>> cp(roman.RomanNumeral('i7[#7]', 'c')) ['C4', 'E-4', 'G4', 'B4'] Other inversions are the same as with major keys: >>> cp(roman.RomanNumeral('i65[#7]', 'c')) ['E-4', 'G4', 'B4', 'C5'] >>> cp(roman.RomanNumeral('i43[#7]', 'c')) ['G4', 'B4', 'C5', 'E-5'] The RomanNumeral constructor accepts a keyword 'updatePitches' which is passed to harmony.Harmony. By default, it is `True`, but can be set to `False` to initialize faster if pitches are not needed. >>> r = roman.RomanNumeral('vio', em, updatePitches=False) >>> r.pitches () **Equality** Two RomanNumerals compare equal if their `NotRest` components (noteheads, beams, expressions, articulations, etc.) are equal and if their figures and keys are equal: >>> c1 = chord.Chord('C4 E4 G4 C5') >>> c2 = chord.Chord('C3 E4 G4') >>> rn1 = roman.romanNumeralFromChord(c1, 'C') >>> rn2 = roman.romanNumeralFromChord(c2, 'C') >>> rn1 == rn2 True >>> rn1.duration.type = 'half' >>> rn1 == rn2 False >>> rn3 = roman.RomanNumeral('I', 'd') >>> rn2 == rn3 False >>> rn3.key = key.Key('C') >>> rn2 == rn3 True >>> rn4 = roman.RomanNumeral('ii', 'C') >>> rn2 == rn4 False >>> rn4.figure = 'I' >>> rn2 == rn4 True >>> rn5 = roman.RomanNumeral('bII6', 'c') >>> rn6 = roman.RomanNumeral('bII6', 'c') >>> rn5 == rn6 True >>> rn7 = roman.RomanNumeral('N6', 'c') >>> rn5 == rn7 False * Changed in v6.5: caseMatters is keyword only. It along with sixthMinor and seventhMinor are now the only allowable keywords to pass in. * Changed in v7: RomanNumeral.romanNumeral will always give a "b" for a flattened degree (i.e., '-II' becomes 'bII') as this is what people expect in looking at the figure. * Changed in v7.3: figures that are not normally used to indicate inversion such as V54 (a suspension) no longer give strange inversions. * Changed in v8: Figures are now validated as alphanumeric or containing one of the following symbols (after the example "V"): >>> specialCharacterFigure = roman.RomanNumeral('V#+-/[]') >>> specialCharacterFigure And degree symbols (`°`) convert to `o`: >>> dimSeventh = roman.RomanNumeral('vii°7', 'c') >>> dimSeventh Otherwise, an invalid figure raises `RomanNumeralException`: >>> roman.RomanNumeral("V64==53") Traceback (most recent call last): music21.roman.RomanNumeralException: Invalid figure: V64==53 OMIT_FROM_DOCS Things that were giving us trouble: >>> dminor = key.Key('d') >>> rn = roman.RomanNumeral('iiø65', dminor) >>> cp(rn) ['G4', 'B-4', 'D5', 'E5'] >>> rn.romanNumeral 'ii' >>> rn3 = roman.RomanNumeral('III', dminor) >>> cp(rn3) ['F4', 'A4', 'C5'] Should be the same as above no matter when the key is set: >>> r = roman.RomanNumeral('VId7', key.Key('B-')) >>> cp(r) ['G5', 'B5', 'D6', 'F6'] >>> r.key = key.Key('B-') >>> cp(r) ['G5', 'B5', 'D6', 'F6'] This was getting B-flat. >>> r = roman.RomanNumeral('VId7') >>> r.key = key.Key('B-') >>> cp(r) ['G5', 'B5', 'D6', 'F6'] >>> r = roman.RomanNumeral('IVd6/5') >>> r.key = key.Key('Eb') >>> cp(r) ['C5', 'E-5', 'G-5', 'A-5'] >>> r = roman.RomanNumeral('vio', em) >>> cp(r) ['C#5', 'E5', 'G5'] We can omit an arbitrary number of steps: >>> r = roman.RomanNumeral('Vd7[no3no5no7]', key.Key('C')) >>> cp(r) ['G4'] Was setting a root of D5: >>> r = roman.RomanNumeral('V754', key.Key('C')) >>> cp(r) ['G4', 'C5', 'D5', 'F5'] A symbol that looks like the degree symbol but isn't: >>> roman.RomanNumeral('viiº') (NOTE: all this is omitted -- look at OMIT_FROM_DOCS above) )rmrz ^(b+|-+|#+)z(\[(no[1-9]+)+]\s*)+z\[add(b*|-*|#*)(\d+)+]\s*z\[(b+|-+|#+)(\d+)]z(It|Ger|Fr|Sw)\+?z'(IV|I{1,3}|VI{0,2}|iv|i{1,3}|vi{0,2}|N)z(.*?)/([#a-np-zA-NP-Z].*)r2rCr?)rUrXGerrYz (\d)/(\d) addedStepsa Returns a list of the added steps, each as a tuple of modifier as a string (which might be empty) and a chord factor as an int. >>> rn = roman.RomanNumeral('V7[addb6]', 'C') >>> rn.addedSteps [('-', 6)] >>> rn.pitches (, , , , ) You can add multiple added steps: >>> strange = roman.RomanNumeral('V7[addb6][add#6][add-8]') >>> strange.addedSteps [('-', 6), ('#', 6), ('-', 8)] >>> ' '.join([p.nameWithOctave for p in strange.pitches]) 'G4 B4 D5 E-5 E#5 F5 G-5' NOTE: The modifier name is currently changed from 'b' to '-', but this might change in a future version to match `bracketedAlteration`. bracketedAlterationsa Returns a list of the bracketed alterations, each as a tuple of modifier as a string and a chord factor as an int. >>> rn = roman.RomanNumeral('V7[b5]') >>> rn.bracketedAlterations [('b', 5)] >>> rn.pitches (, , , ) NOTE: The bracketed alteration name is currently left as 'b', but this might change in a future version to match `addedSteps`. The difference between a bracketed alteration and just putting b5 in is that, a bracketed alteration changes notes already present in a chord and does not imply that the normally present notes would be missing. Here, the presence of 7 and b5 means that no 3rd should appear. >>> rn2 = roman.RomanNumeral('V7b5') >>> rn2.bracketedAlterations [] >>> len(rn2.pitches) 3 >>> [p.name for p in rn2.pitches] ['G', 'D-', 'F'] * Changed in v6.5: always returns a list, even if it is empty. caseMattersu5 Boolean to determine whether the case (upper or lowercase) of the figure determines whether it is major or minor. Defaults to True; not everything has been tested with False yet. >>> roman.RomanNumeral('viiø7', 'd').caseMatters True figuresWrittenu Returns a string containing any figured-bass figures as passed in: >>> roman.RomanNumeral('V65').figuresWritten '65' >>> roman.RomanNumeral('V').figuresWritten '' >>> roman.RomanNumeral('Fr43', 'c').figuresWritten '43' >>> roman.RomanNumeral('I7#5b3').figuresWritten '7#5b3' Note that the `o` and `ø` symbols are quality designations and not figures: >>> roman.RomanNumeral('viio6').figuresWritten '6' >>> roman.RomanNumeral('viiø7').figuresWritten '7' figuresNotationObja Returns a :class:`~music21.figuredBass.notation.Notation` object that represents the figures in a RomanNumeral >>> rn = roman.RomanNumeral('V65') >>> notationObj = rn.figuresNotationObj >>> notationObj >>> notationObj.numbers (6, 5, 3) >>> rn = roman.RomanNumeral('Ib75#3') >>> notationObj = rn.figuresNotationObj >>> notationObj.numbers (7, 5, 3) >>> notationObj.modifiers (, , ) frontAlterationAccidentala An optional :class:`~music21.pitch.Accidental` object representing the chromatic alteration of a RomanNumeral, if any >>> roman.RomanNumeral('bII43/vi', 'C').frontAlterationAccidental >>> roman.RomanNumeral('##IV').frontAlterationAccidental For most roman numerals this will be None: >>> roman.RomanNumeral('V', 'f#').frontAlterationAccidental Changing this value will not change existing pitches. * Changed in v6.5: always returns a string, never None frontAlterationStringa A string representing the chromatic alteration of a RomanNumeral, if any >>> roman.RomanNumeral('bII43/vi', 'C').frontAlterationString 'b' >>> roman.RomanNumeral('V', 'f#').frontAlterationString '' Changing this value will not change existing pitches. * Changed in v6.5: always returns a string, never None frontAlterationTransposeIntervala An optional :class:`~music21.interval.Interval` object representing the transposition of a chromatically altered chord from the normal scale degree: >>> sharpFour = roman.RomanNumeral('#IV', 'C') >>> sharpFour.frontAlterationTransposeInterval >>> sharpFour.frontAlterationTransposeInterval.niceName 'Augmented Unison' Flats, as in this Neapolitan (bII6) chord, are given as diminished unisons: >>> roman.RomanNumeral('N6', 'C').frontAlterationTransposeInterval Most RomanNumerals will have None and not a perfect unison for this value (this is for the speed of creating objects) >>> intv = roman.RomanNumeral('V', 'e-').frontAlterationTransposeInterval >>> intv is None True Changing this value will not change existing pitches. impliedQualityax The quality of the chord implied by the figure: >>> roman.RomanNumeral('V', 'C').impliedQuality 'major' >>> roman.RomanNumeral('ii65', 'C').impliedQuality 'minor' >>> roman.RomanNumeral('viio7', 'C').impliedQuality 'diminished' The impliedQuality can differ from the actual quality if there are not enough notes to satisfy the implied quality, as in this half-diminished chord on vii which does not also have a seventh: >>> incorrectSeventh = roman.RomanNumeral('vii/o', 'C') >>> incorrectSeventh.impliedQuality 'half-diminished' >>> incorrectSeventh.quality 'diminished' >>> powerChordMinor = roman.RomanNumeral('v[no3]', 'C') >>> powerChordMinor.impliedQuality 'minor' >>> powerChordMinor.quality 'other' If case does not matter then an empty quality is implied: >>> roman.RomanNumeral('II', 'C', caseMatters=False).impliedQuality '' impliedScaleaY If no key or scale is passed in as the second object, then impliedScale will be set to C major: >>> roman.RomanNumeral('V').impliedScale Otherwise this will be empty: >>> roman.RomanNumeral('V', key.Key('D')).impliedScale omittedStepsa A list of integers showing chord factors that have been specifically omitted: >>> emptyNinth = roman.RomanNumeral('V9[no7][no5]', 'C') >>> emptyNinth.omittedSteps [7, 5] >>> emptyNinth.pitches (, , ) Usually an empty list: >>> roman.RomanNumeral('IV6').omittedSteps [] pivotChorda Defaults to None; if not None, stores another interpretation of the same RN in a different key; stores a RomanNumeral object. While not enforced, for consistency the pivotChord should be the new interpretation going forward (to the right on the staff) >>> rn = roman.RomanNumeral('V7/IV', 'C') >>> rn.pivotChord is None True >>> rn.pivotChord = roman.RomanNumeral('V7', 'F') ra A string representing everything before the slash in a RomanNumeral with applied chords. In other roman numerals it is the same as `figure`: >>> rn = roman.RomanNumeral('bII43/vi', 'C') >>> rn.primaryFigure 'bII43' >>> rnSimple = roman.RomanNumeral('V6', 'a') >>> rnSimple.primaryFigure 'V6' Changing this value will not change existing pitches. rka Returns a string of just the roman numeral part (I-VII or i-vii) of the figure: >>> roman.RomanNumeral('V6').romanNumeralAlone 'V' Chromatic alterations and secondary numerals are omitted: >>> rn = roman.RomanNumeral('#II7/vi', 'C') >>> rn.romanNumeralAlone 'II' Neapolitan chords are changed to 'II': >>> roman.RomanNumeral('N6').romanNumeralAlone 'II' Currently augmented-sixth chords return the "national" base. But this behavior may change in future versions: >>> roman.RomanNumeral('It6').romanNumeralAlone 'It' >>> roman.RomanNumeral('Ger65').romanNumeralAlone 'Ger' This will be controversial in some circles, but it's based on a root in isolation, and does not imply tonic quality: >>> roman.RomanNumeral('Cad64').romanNumeralAlone 'I' scaleCardinalitya Stores how many notes are in the scale; defaults to 7 for diatonic, obviously. >>> roman.RomanNumeral('IV', 'a').scaleCardinality 7 Probably you should not need to change this. And most code is untested with other cardinalities. But it is (in theory) possible to create roman numerals on octatonic scales, etc. Changing this value will not change existing pitches. scaleDegreea An int representing what degree of the scale the figure (or primary figure in the case of secondary/applied numerals) is on. Discounts any front alterations: >>> roman.RomanNumeral('vi', 'E').scaleDegree 6 Note that this is 2, not 1.5 or 6 or 6.5 or something like that: >>> roman.RomanNumeral('bII43/vi', 'C').scaleDegree 2 Empty RomanNumeral objects have the special scaleDegree of 0: >>> roman.RomanNumeral().scaleDegree 0 Changing this value will not change existing pitches. * Changed in v6.5: empty RomanNumeral objects get scaleDegree 0, not None. secondaryRomanNumerala An optional roman.RomanNumeral object that represents the part after the slash in a secondary/applied RomanNumeral object. For instance, in the roman numeral, `C: V7/vi`, the `secondaryRomanNumeral` would be the roman numeral `C: vi`. The key of the `secondaryRomanNumeral` is the key of the original RomanNumeral. In cases such as V/V/V, the `secondaryRomanNumeral` can itself have a `secondaryRomanNumeral`. >>> rn = roman.RomanNumeral('V7/vi', 'C') >>> rn.secondaryRomanNumeral ab An optional key.Key object for secondary/applied RomanNumeral that represents the key that the part of the figure *before* the slash will be interpreted in. For instance in the roman numeral, `C: V7/vi`, the `secondaryRomanNumeralKey` would be `a minor`, since the vi (submediant) refers to an a-minor triad, and thus the `V7` part is to be read as the dominant seventh in `a minor`. >>> rn = roman.RomanNumeral('V7/vi', 'C') >>> rn.secondaryRomanNumeralKey a  How should vii, viio, and VII be parsed in minor? Defaults to Minor67Default.QUALITY. This value should be passed into the constructor initially. Changing it after construction will not change the pitches. a How should vi, vio and VI be parsed in minor? Defaults to Minor67Default.QUALITY. This value should be passed into the constructor initially. Changing it after construction will not change the pitches. z A boolean indicating whether an implied scale is being used: >>> roman.RomanNumeral('V').useImpliedScale True >>> roman.RomanNumeral('V', 'A').useImpliedScale False )secondaryRomanNumeralKeyr^r]useImpliedScalezdict[str, str] _DOC_ATTRT)rr\r]r^c .>SUlSUlSUlSUlX0lSUl[ U[5(a[R"U5nUR(aSn[ U[R5(a URnOd[ U[R5(a URnO8[ U[ 5(a#U(aUSR#5(aSOSnUS:XaUS;d US:XaUS;aUR%5n[ U[ 5(aO[&R("SS U5nUR+S S 5nUR+S S 5nUR+S S 5nO[-S[U535e[/SU55(d[1SU35eXlSUlSUlSUlSUlSUlSUlSUl [BUl"U(d[FRH"5Ul"SUl%SUl&SUl'/Ul(/Ul)/Ul*SUl+X l XPl,X`l-[\T U]"U4SU0UD6 SUl0SUl+SUl1SUl2g)Nr/r"rrLrM)IIrr{r)rOrrarUz(?(RomanNumeral.__init__.. s!KFD<<>7TZ%77Fs(*zInvalid figure: Fr\T)3rrrrrrrrrrrr'rr DiatonicScaletyperisupperrrrr TypeErrorallrr_figure_scalerrrrrkr_NOTATION_SINGLETONrrpNotationrrrrrr_parsingCompleter]r^super__init__ writeAsChord_functionalityScorefollowsKeyChange) selfrm keyOrScalerr\r]r^keywordsr __class__s r+rRomanNumeral.__init__S sH#%8<"6:%-1!,%& fc " "^^F+Fj#''22%??D E,?,?@@%??D C00Z&0m&;&;&=&=77DW_3M)MF6L,L#\\^F fc " "VVKf5F^^D#.F^^D#.F^^D$/F7V ~FG GKFKKK'*:6((CD D  !*,"HL-@D&&(#%7J&0&9&9&;D ##%6:%*;=!')13 %$( I}II  $-1 &+r-c@[RRX5$)z? Compare equality, just based on NotRest and on figure and key )rNotRest__eq__)rothers r+rRomanNumeral.__eq__ s ||""4//r-c[U5S- $)Nr)idrs r+__hash__RomanNumeral.__hash__ s$x1}r-cz[URS5(a[UR5$UR$)Nr_)hasattrrr figureAndKeyrmrs r+ _reprInternalRomanNumeral._reprInternal s. 488W % %t(() );; r-cJ[UR[5(d[SUR<35eUR(a UR nO UR nURU5up!US:Xa&[US5(aURS:XaSnOSnX l URU5nURU5nURU5n[R"SSU5n[R"S S U5n[R"S SU5nUR!U5nUR#X!5up!UR%U5nUR'X!5nX lS R+[-U55n[.R0"U5Ulg )zd Parse the .figure object into its component parts. Called from the superclass, Harmony.__init__() zgot a non-string figure: Cad64rrMi64r_z^N6rz^N53bIIz^N,N)rrrrrrrr _correctForSecondaryRomanNumeralrrr_parseOmittedSteps_parseAddedSteps_parseBracketedAlterationsrr_parseFrontAlterations_parseRNAloneAmidstAug6_setImpliedQualityFromString_adjustMinorVIandVIIByQualityrrrrprr)ruseScale workingFigureshFigs r+ _parseFigureRomanNumeral._parseFigure sd $,,,,'*CDLLCS(TU U   ((H{{H$($I$I($S! G #x((X]]g-E % % *// > --m< 77 F ufm< vum< tV]; 33MB "&">">}"W 99-H ::=S +78","5"5e"<r-cSnURS5(dURS5(a USSnSnGO'URS5(a USSnSnGOURS 5(aUSSnSnOURS 5(aUSSnS nOS U;aO[R"S U5nUc[SUS35eUR S5UR S5-nSnOwUR (a+UR R5UR :XaSnO;UR (a*UR R5UR :XaSnX l U$)Nr/rrr diminishedrr!half-diminishedrr augmenteddz/(?P.*)d(?P
7|6/?5|4/?3|4/?2|2)$z,Cannot make a dominant-seventh chord out of z3. Figure should be in ('7', '65', '43', '42', '2').leadingrmdominant-seventhrLrM) rrrrrgrouprrkrrr)rrrms r+r)RomanNumeral._setImpliedQualityFromString sc  # #C ( (M,D,DT,J,J)!"-M)N  % %d + +)!"-M.N  % %d + +)!"-M.N  % %c * *)!"-M(N M !K][Ay+B=/RHHIIGGI.1BBM/N   $"8"8">">"@DDZDZ"Z$N   $"8"8">">"@DDZDZ"Z$N,r-cUR(dgURHup[R"SSU5nURU5nUcM4[ R"U5nURcXClM_URRURRUR-5 M g![R a Mf=f)Nr-) rrr getChordSteprChordExceptionr Accidental accidentalrr)r alterNotation chordStep alterPitch newAccidentals r+_correctBracketedPitches%RomanNumeral._correctBracketedPitches s(( *.*C*C &]FF3];M !..y9 % % 0 0 ? ((0,9)))--j.C.C.I.IML_L_._`+D''  sB??CCcUS:XaSnU$US:XaSnU$US:XaSnU$US:XaSnU$US :XaS nU$US :XaS nU$US :XaSnU$SnU$)a Given an implied quality, return the number of semitones that should be included. Relies entirely on impliedQuality. Note that in the case of 'diminished' it could be either diminished triad or diminished seventh. We return for diminished seventh since a missing chordStep for the 7th degree doesn't affect the processing. Returns a tuple of 2 or 3 length showing the number of semitones for third, fifth, [seventh] or the empty tuple () if not found. >>> r = roman.RomanNumeral() >>> r._findSemitoneSizeForQuality('major') (4, 7) >>> r._findSemitoneSizeForQuality('minor') (3, 7) >>> r._findSemitoneSizeForQuality('half-diminished') (3, 6, 10) >>> r._findSemitoneSizeForQuality('augmented') (4, 8) >>> r._findSemitoneSizeForQuality('dominant-seventh') (4, 7, 10) >>> r._findSemitoneSizeForQuality('not-a-quality') () >>> r._findSemitoneSizeForQuality('diminished') (3, 6, 9) OMIT_FROM_DOCS This one is not currently used. >>> r._findSemitoneSizeForQuality('minor-seventh') (3, 7, 10) (This is in OMIT_FROM_etc.) rL)rr"rM)rr"r)rrr#r)rrrr)rrz minor-seventh)rr"rr)rr"rrr)rrcorrectSemitoness r+_findSemitoneSizeForQuality(RomanNumeral._findSemitoneSizeForQuality sL W $%   w &%  | +(  0 0)  { *%   .)    1 1)   " r-c,^S SjnS U4SjjnTRU5nSn[XT5HhupgU"U5(aMTRU5nUcM*X:XaM1Xx- n TRU5n [R (aU ceU"X5 Mj [ U5S:Xam[ TRR5S:aITRS:Xa8TRS5S :Xa"U"S5(dU"TRS 5 gggggg) ad Fixes notes that should be out of the scale based on what the chord "impliedQuality" (major, minor, augmented, diminished) by changing their accidental. An intermediary step in parsing figures. >>> r = roman.RomanNumeral() >>> r.pitches = ['C4', 'E4', 'G4'] >>> r._matchAccidentalsToQuality('minor') >>> ' '.join([p.name for p in r.pitches]) 'C E- G' >>> r._matchAccidentalsToQuality('augmented') >>> ' '.join([p.name for p in r.pitches]) 'C E G#' >>> r._matchAccidentalsToQuality('diminished') >>> ' '.join([p.name for p in r.pitches]) 'C E- G-' >>> r.pitches = ['C4', 'E4', 'G4', 'B4'] >>> r._matchAccidentalsToQuality('diminished') >>> ' '.join([p.name for p in r.pitches]) 'C E- G- B--' This was a problem before: >>> r.pitches = ['C4', 'E4', 'G4', 'B#4'] >>> r._matchAccidentalsToQuality('diminished') >>> ' '.join([p.name for p in r.pitches]) 'C E- G- B--' c(US:a SSU- -nO US::aUS- nURc[R"U5UlgURnU[UR5- nUS:a SSU- -nO US::aUS- nUR U5 g)Nrrri)rrrrrr) faultyPitchinner_correctedSemisaccs r+correctFaultyPitchCRomanNumeral._matchAccidentalsToQuality..correctFaultyPitchq s#q(')R2F-F'G$%+$*$%%-).)9)9:N)O &!,,$CII6$'1,+-6J1J+K()R/(B.(,-r-c>TRRHTnURU:XdMURRcM.URRR S:wdMT g g)z Skip adjusting chordSteps with explicit accidentals. For a figure like V7b5, make sure not to correct the b5 back, even though the implied quality requires a Perfect 5th. rTF)rfiguresnumbermodifierrr)rrmrs r+shouldSkipThisChordStepHRomanNumeral._matchAccidentalsToQuality..shouldSkipThisChordStep sW1199MMY."OO66B"OO66<<A : r-)rr r"Nr!rrMr"rSr)r pitch.Pitchrr)rrreturnbool) rziprrrfrgrrr rr/) rrrrrchordStepsToExamine thisChordStep thisCorrect thisSemiscorrectedSemischordStepNotNones ` r+_matchAccidentalsToQuality'RomanNumeral._matchAccidentalsToQualityR s> .$  ;;NK'+..A*T &M&}5533MBI '(4N#00? '333 / @+U  A %#d.E.E.M.M*NRS*S""g-$2M2Ma2PTV2V/q11&t||R823W-+T %r-c*Uc URnUbURRU5nOSnU(aURS5nURS5n[ UUUR UR URS9nX`lURS:XaSnO-URS:XaSnOURS5S:XaSnOSn[R"UR5RU5UlURnUnX4$UnX4$)a4 Creates .secondaryRomanNumeral object and .secondaryRomanNumeralKey Key object inside the RomanNumeral object (recursively in case of V/V/V/V etc.) and returns the figure and scale that should be used instead of figure for further working. Returns a tuple of (newFigure, newScale). In case there is no secondary slash, returns the original figure and the original scale. If figure is None, uses newFigure. >>> k = key.Key('C') >>> r = roman.RomanNumeral('I', k) # will not be used below >>> r._correctForSecondaryRomanNumeral(k) # uses 'I'. nothing should change ('I', ) >>> r.secondaryRomanNumeral is None True >>> r.secondaryRomanNumeralKey is None True >>> r._correctForSecondaryRomanNumeral(k, 'V/V') ('V', ) >>> r._correctForSecondaryRomanNumeral(k, 'V65/IV') ('V65', ) >>> r._correctForSecondaryRomanNumeral(k, 'viio/bVII') ('viio', ) >>> r._correctForSecondaryRomanNumeral(k, 'V9/vi') ('V9', ) >>> r.secondaryRomanNumeral >>> r.secondaryRomanNumeralKey Recursive: >>> r._correctForSecondaryRomanNumeral(k, 'V7/V/V') ('V7', ) >>> r.secondaryRomanNumeral >>> r.secondaryRomanNumeralKey >>> r.secondaryRomanNumeral.secondaryRomanNumeral >>> r.secondaryRomanNumeral.secondaryRomanNumeralKey Nrr!)rr]r^rMrLr)r_secondarySlashRegexrrrrr]r^rqualityrrr'rrr) rrrmrrsecondaryFigurer secondaryModers r+r-RomanNumeral._correctForSecondaryRomanNumeral sd >\\F  --33F;EE !KKNM#kk!nO$0 ,,??!.. % !*? &$,,7 ' &..'9 ' &==a@AE ' ' -0GG%**,11-D )44H)M((#M((r-c/nURRU5nU(aUR5nURSS5nURSS5nUSSR S5Vs/sH"oU(dM [ U5S-=(d SPM$ nnURR SU5nX lU$s snf)ar Remove omitted steps from a working figure and return the remaining figure, setting self.omittedSteps to the omitted parts >>> rn = roman.RomanNumeral() >>> rn._parseOmittedSteps('7[no5][no3]') '7' >>> rn.omittedSteps [5, 3] All omitted are mod 7: >>> rn = roman.RomanNumeral() >>> rn._parseOmittedSteps('13[no11][no9][no7]b3') '13b3' >>> rn.omittedSteps [4, 2, 7]  r/z][rrnor")_omittedStepsRegexsearchrrsplitrrr)rrrrrrs r+rRomanNumeral._parseOmittedSteps s( ''..}= KKMEMM#r*EMM$+E7=B>c6/nURRU5nUHSnURS5RSS5nURS5nU[ U54nUR U5 MU URR SU5nX lU$)a Remove added steps from a working figure and return the remaining figure, setting self.addedSteps to a list of tuples of alteration and number >>> rn = roman.RomanNumeral() >>> rn._parseAddedSteps('7[add6][add#2]') '7' >>> rn.addedSteps [('', 6), ('#', 2)] All added are not mod 7. Flat "b" becomes "-" >>> rn = roman.RomanNumeral() >>> rn._parseAddedSteps('13[addbb11]b3') '13b3' >>> rn.addedSteps [('--', 11)] rrrr!r/)_addedStepsRegexfinditerrrrrrr)rrrmatchesrmatchAlteration matchDegreeaddTuples r+rRomanNumeral._parseAddedSteps' s& ''00?Aggaj00c:O''!*K'[)9:H   h '  --11"mD $r-cURRU5nUHLnURS5n[URS55nXE4nURR U5 MN URR SU5nU$)z remove bracketed alterations from a figure and store them in `.bracketedAlterations` >>> rn = roman.RomanNumeral() >>> rn._parseBracketedAlterations('7[#5][b3]') '7' >>> rn.bracketedAlterations [('#', 5), ('b', 3)] rr!r/)_bracketedAlterationRegexr+rrrrr)rrr,rr-r.newTuples r+r'RomanNumeral._parseBracketedAlterationsF s~0099-HAggajOaggaj/K'5H  % % , ,X 6  66::2}M r-cSnSnSnURRU5nU(aUR5n[U5nUSS;aUS-n[R "[R "S5[R"U55n[R"U5nUnURRSU5nX l X0l X@l U$)a removes front alterations from a workingFigure and sets `.frontAlterationString`, `.frontAlterationTransposeInterval` and `.frontAlterationAccidental`. >>> rn = roman.RomanNumeral() >>> print(rn.frontAlterationTransposeInterval) None >>> rn._parseFrontAlterations('bVI') 'VI' >>> rn.frontAlterationString 'b' >>> rn.frontAlterationTransposeInterval >>> rn.frontAlterationAccidental r/Nr)rrrr)_alterationRegexrrrr r`rarbrrrrrr)rrrrrrr alterations r+r#RomanNumeral._parseFrontAlterationsZ s&!#+/($(!%%++M: KKMEUJQx:%b /7/W/W((+**:60 ,).(8(8(D %$) ! 1155b-HM%:"0P-)B&r-c4URRU5nURRU5nU(dU(d[SU<35eU(GaS[ U[ R 5(aURS:Xd<[ U[R5(aURS:XazURbm[ R "URS5nX l SUl URb2URRn[ R "US5UlURS5nUS;a#SUl["R$"S 5UlO6US :XaS UlO(US :Xa"S Ul["R$"S 5UlURR)S U5nUR*R)SU5nU(aUSR-5(dUR.UU-nORU(aKUS:waEUSS:Xa<[1U5S :dUSR-5(dUR.UUSS-nX`lUS :waSnUR4R7U5 US;aSnUR4R7U5 X4$[8R:(aUceURS5n[<R>"U5UlURR)S U5nXlX4$)a Sets and removes from workingFigure the roman numeral alone, possibly changing the useScale in the case of augmented sixths. Returns the remains of the figure alone with the scale to be used >>> useScale = key.Key('C') >>> rn = roman.RomanNumeral() >>> workingFig, outScale = rn._parseRNAloneAmidstAug6('V7', useScale) >>> workingFig '7' >>> outScale is useScale True >>> rn.romanNumeralAlone 'V' >>> rn = roman.RomanNumeral() >>> workingFig, outScale = rn._parseRNAloneAmidstAug6('Ger65', useScale) >>> workingFig '65' >>> rn.scaleDegreeWithAlteration (4, ) Working figures might be changed to defaults: >>> rn = roman.RomanNumeral() >>> workingFig, outScale = rn._parseRNAloneAmidstAug6('Fr+6', useScale) >>> workingFig '43' >>> outScale >>> rn.scaleDegree 2 >>> rn = roman.RomanNumeral() >>> workingFig, outScale = rn._parseRNAloneAmidstAug6('It6', scale.MajorScale('C')) >>> outScale zNo roman numeral found in rLNrMTr)rUrrsharprXr!rYr/z\1\2rrUr2)rrrW)rr) _romanNumeralAloneRegexr_augmentedSixthRegexrrrrr'rrrrr_rrrrrrrrr_slashedAug6Invisdigit_aug6defaultInversionsrrkrrrfrgr fromRoman) rrrromanNormalMatch aug6Matchsecondary_tonicaug6typefixTuplerks r+r$RomanNumeral._parseRNAloneAmidstAug6 s\ 77==mL--33MB  '*D]DU(VW W Hcgg..8==G3K"8U-@-@AA$MMW4$NN6778>>7;$,!'+$00<&*&C&C&I&IO47GGOW4UD1;D??1;MH=(#$ 161A1A'1J.T!#$ T!#$ 161A1A'1J. 5599"mLM 0044WmLM a(8(@(@(B(B $ ; ;H E U $&#A&#-=)A-,Q/7799 $ ; ;H E VWVXHY Y %- "4#))00:<'#))00:&&'333 0 6 6q 9 %//0ABD  88<>> rn = roman.RomanNumeral() >>> rn.scaleDegree = 6 >>> rn.impliedQuality = 'minor' >>> rn.adjustMinorVIandVIIByQuality(key.Key('c')) >>> rn.frontAlterationTransposeInterval >>> rn.frontAlterationAccidental >>> rn = roman.RomanNumeral() >>> rn.scaleDegree = 6 >>> rn.impliedQuality = 'major' >>> rn.adjustMinorVIandVIIByQuality(key.Key('c')) >>> rn.frontAlterationTransposeInterval is None True >>> rn.frontAlterationAccidental is None True * Changed in v6.4: public function became hook to private function having the actual guts r/N)r)rrunused_workingFigures r+adjustMinorVIandVIIByQuality)RomanNumeral.adjustMinorVIandVIIByQuality s: $AA"hOr-c^^S U4SjjnS U4Sjjm[USS5S:waU$TRS;aU$TR(dU$TRS:Xa TRnO TRnU[ R :XaU$TRS;nU[ R:XaU"U5$U[ R:XaU(dU$U"U5$TR(aTRRS :XaU(dU$U"U5$TRRnUS :a U(aU$US ::aU"U5$U$)a  Fix minor vi and vii to always be #vi and #vii if `.caseMatters`. Altering `workingFigure` became necessary to handle these chromatic figures: https://github.com/cuthbertLab/music21/issues/437 >>> rn = roman.RomanNumeral('viio#6', 'a') >>> ' '.join([p.name for p in rn.pitches]) 'B D G#' >>> rn = roman.RomanNumeral('viio6#4', 'a') >>> ' '.join([p.name for p in rn.pitches]) 'D G# B' >>> rn = roman.RomanNumeral('viio4#2', 'a') >>> ' '.join([p.name for p in rn.pitches]) 'F G# B D' >>> rn = roman.RomanNumeral('viio#853', 'a') >>> ' '.join([p.name for p in rn.pitches]) 'G# B D' >>> rn = roman.RomanNumeral('viio##853', 'a') >>> ' '.join([p.name for p in rn.pitches]) 'G# B D G##' * Changed in v6.4: Made private when `workingFigure` was added to the signature and returned. c6>T"[R"S5S5 SU;aURSS5nU$SU;aURSS5nU$SU;aURSS 5nU$S U;aURS S 5nU$URSS 5nU$) NA1rz##z##8z#8z#22z#44z#6r2r/)r rr)wFigchangeFrontAlterations r+sharpen;RomanNumeral._adjustMinorVIandVIIByQuality..sharpen- s !("3"3D"91 =t|||E40K||D#.K ||D#. K ||D#.K||D"-Kr-cn>TRnU(a[R"X /5nUTlTRc [ S5eTR=R U- slTRR S:XaSTlSTlggUTl[ R"U5Tlg)NzHCannot have a RN with frontAlterationTransposeInterval and no accidentalr)rr addrrrrr)intVrfatinewFatirs r+rQIRomanNumeral._adjustMinorVIandVIIByQuality..changeFrontAlteration? s88D",,|48?5119#b..44=411771<<@D959D2=9=5161A1A%1H.r-rNrMr5r)rMrrrrr)rPrrr)rVzinterval.Intervalrr) getattrrrr]r^rnrrrrrr)rrrrR minorDefaultnormallyRaised frontAlterrQs` @r+r*RomanNumeral._adjustMinorVIandVIIByQuality s:< $ I& 8VT *g 5   6 )     q ??L,,L >.. . ,,0ZZ >// /=) ) ^33 3!$$}--11T5S5S5Y5Y]^5^%(("=1177==JQ>$$r!}--$$r-c URb URnO7UR(aURb URnO URnSUR;aSUlOUR 5UlURUR5nURU[RRS9nU/nUn[URR5n[U5GHnXg- S- nUURRU-S- n URU [RRS9n URR UR#U R$5n [&R("U 5n U R*bU R*U lO[,R.U lU R0UR0:aU =R*S- slUR3U 5 U nGM UR4(aUR4R6S:wa[8R:R=[8R>"U55n U RASS5U RASS5U RASS5U RAS S54nUH$nX;dM UR4RCUS S 9 M& [EU5Ul#URR[H;aURKURM55 UROURP5 URS5 URT(dURV(aURKURK55 URT(a/nURTH4nURYU5nUcMUR3UR$5 M6 /nURFH&nUR$U;dMUR3U5 M( [EU5Ul#URV(Ga~URVGHmunnS U;aUR[S 5S -nOUR[S5nUR\U-S- n URU [RRS9nUR^b UR^=R`U- sl0O[&Rb"U5Ul/UR0UR0:a1U=R*S- slUR0UR0:aM1UR0UR0:Xa/URdURd:aU=R*S- slUURF;dGM\URgU5 GMp URF(d[iSURj<35eg)z? Utility function to update the pitches to the new figure etc. Nrr") directionrrr!rrTinPlacerrrz?_updatePitches() was unable to derive pitches from the figure: )6rrrrclassesrgetDegreeMaxUniquebassScaleDegreeFromNotationrrr Direction ASCENDINGrnumbersrange modifiersmodifyPitchNamerrPitchoctaver pitchOctaverrr semitonesrtools allChordStepsrgetrcrrr$rrrrrrrrcountrrrrdiatonicNoteNumrUrrrm)rrbassScaleDegree bassPitchr lastPitch numberNotesjrQthisScaleDegreenewPitch pitchName newNewPitch chord_map non_alterromittedPitchesthisCSp newPitches addAccidental stepNumberr7 addedPitchs r+_updatePitchesRomanNumeral._updatePitches~ s  ( ( 444H  ! !d&7&7&C((HxxH h.. .$%D !$,$?$?$AD !::4;R;RS,,_HaHa,b &/[ $1199: {#A!#A."&"9"9"A"A!"D E"# $O //:?//:S:S0UH//99!<LLX]][I++i0K*%-__ "%-%9%9 "~~ ,""a'" NN; '#I!$$  1 199CCqH 11%++g2FGI a& a& a& a& I % -99HH\`Ha%W~  " " * *2G G IIdiik " ''(;(;< %%'    IIdiik "   N++%%f-="))!&&1, J!\\ >>7%%i0*!,DL ???-1__) z-'!.!4!4S!9B!>J!.!4!4S!9J#'#3#3j#@1#D%55o@E@Y@Y6[ ((4))//:=/,1,<,[TU]XS9nU(d!URRUSS9UlU$URRUSS9Ulg)aP Overrides :meth:`~music21.harmony.Harmony.transpose` so that `key` attribute is transposed as well. >>> rn = roman.RomanNumeral('I', 'C') >>> rn >>> rn.transpose(4) >>> rn.transpose(-4, inPlace=True) >>> rn raFN)rrir)rvaluerbpostrs r+riRomanNumeral.transpose sXw  8xx))%)?DHKxx))%)?DHr-cURS;a UR$URc UR$URRRSS5UR-$)a` Read-only property that returns either the romanNumeralAlone (e.g. just II) or the frontAlterationAccidental.modifier (with 'b' for '-') + romanNumeralAlone (e.g. #II, bII) >>> rn = roman.RomanNumeral('#II7') >>> rn.romanNumeral '#II' >>> rn = roman.RomanNumeral('Ger+6') >>> rn.romanNumeral 'Ger' >>> rn = roman.RomanNumeral('bbII/V') >>> rn.romanNumeral 'bbII' >>> rn = roman.RomanNumeral('--II/V') >>> rn.romanNumeral 'bbII' OMIT_FROM_DOCS >>> rn.romanNumeral = 'V' Traceback (most recent call last): ValueError: Cannot set romanNumeral property of RomanNumeral objects (This is in OMIT_FROM_etc.) )rrYrUrXrr)rkrr rrs r+ romanNumeralRomanNumeral.romanNumeral sf<  ! !%> >)) )  ) ) 1)) )..77??SI(() *r-c[S5e)Nz8Cannot set romanNumeral property of RomanNumeral objects)rrrs r+rr/ sSTTr-c,UR=(d S$)zY Gets or sets the entire figure (the whole enchilada). (these docs are overridden below) r/)rrs r+rmRomanNumeral.figure3 s ||!r!r-cXlUR(a(/UlUR5 UR 5 ggN)rrrrr)r newFigures r+rmr; s5  (*D %        ! !r-c"URc UR$SnURRn[US5(a URn[URS5(aSURR -nOMURR RS:XaSnO&URR RS:XaSnUS:XaUR5nOUS:XaUR5nURS UU3$) z Returns the figure and the key and mode as a string >>> rn = roman.RomanNumeral('V65/V', 'e') >>> rn.figureAndKey 'V65/V in e minor' Without a key, it is the same as figure: >>> roman.RomanNumeral('V7').figureAndKey 'V7' r/rrr# MajorScalez major MinorScalez minorz in ) rrmr_rrrrrrr)rrr_s r+rRomanNumeral.figureAndKeyC s 88 ;;  5& ! !JJE 488V $ $&D XX   ( (L 8D XX   ( (L 8D 8 KKME X KKME++d5'$00r-cUR$)ac Gets or Sets the current Key (or Scale object) for a given RomanNumeral object. If a new key is set, then the pitches will probably change: >>> r1 = roman.RomanNumeral('V') (No key means an implicit C-major) >>> r1.key is None True >>> [str(p) for p in r1.pitches] ['G4', 'B4', 'D5'] Change to A major >>> r1.key = key.Key('A') >>> [str(p) for p in r1.pitches] ['E5', 'G#5', 'B5'] >>> r1 >>> r1.key >>> r1.key = key.Key('e') >>> [str(p) for p in r1.pitches] ['B4', 'D#5', 'F#5'] >>> r1 )rrs r+rRomanNumeral.keyf sJ{{r-cXR:XaUbg[U[5(a [U5nOUbURnSU;a(UR[;aU[UR'OSU;atURn[USS5(a8USRURVs/sHoDRPM sn5- nU[;a [UnOU[U'O[ SU<S 3S -5eXlUb"[US5(acUR (dRS UlURb"URR%S S 5UlO#[(R*"S 5UlOSUlUR,(aUR/5 gg! [ SR U55e=fs snf)zO Provide a new key or scale, and re-configure the RN with the existing figure. NzJCannot call classes on object {0!r}, send only Key or Scale Music21Objectsr'Scale isConcreteF_z"Cannot get a key from this object z , send only zKey or Scale objectsTrC)rrrr,rcrrrsr(rrrZrrnameWithOctaverrrrderiverrrrr)rr keyClasses scaleHashrs r+rr s  $)?  j# & &)*5J  # B'//  "44IECMIj??@J&'OO :|U;;3=3E3EF3Ea))3EF"I +!,Y!7J-7K *+8lS,-..   J 55&11#'D {{&$(KK$6$6q#$>!$)$4$4S$9!#(D      ! !U B+..4fZ.@BBGs F(1G (Gc2URUR4$)a Returns a two element tuple of the scale degree and the accidental that alters the scale degree for things such as #ii or bV. Note that vi and vii in minor have a frontAlterationAccidental of even if it is not preceded by a `#` sign. Has the same effect as setting .scaleDegree and .frontAlterationAccidental separately >>> v = roman.RomanNumeral('V', 'C') >>> v.scaleDegreeWithAlteration (5, None) >>> neapolitan = roman.RomanNumeral('N6', 'c#') >>> neapolitan.scaleDegreeWithAlteration (2, ) )rrrs r+scaleDegreeWithAlteration&RomanNumeral.scaleDegreeWithAlteration s*!?!???r-cUc URn[R"S5nSnU/nUR[;a UR $URHOnUS- nX6-n[ R"U5up[R"UU 35n URU 5 MQ [R"U5n U R5Rn X- n UR U - UR-nUS:Xa URnU$)a Given a notationObject from :class:`music21.figuredBass.notation.Notation` return the scaleDegree of the bass. >>> fbn = figuredBass.notation.Notation('6,3') >>> V = roman.RomanNumeral('V') >>> V.bassScaleDegreeFromNotation(fbn) 7 >>> fbn2 = figuredBass.notation.Notation('#6,4') >>> vi = roman.RomanNumeral('vi') >>> vi.bassScaleDegreeFromNotation(fbn2) 3 Can figure it out directly from an existing RomanNumeral: >>> ii65 = roman.RomanNumeral('ii65', 'C') >>> ii65.bassScaleDegreeFromNotation() 4 Simple test: >>> I = roman.RomanNumeral('I') >>> I.bassScaleDegreeFromNotation() 1 Figures that do not imply a bass like 54 just return the instance :attr:`scaleDegree`: >>> V = roman.RomanNumeral('V54') >>> V.bassScaleDegreeFromNotation() 5 C3rrr)rrrlrhr$rr convertDiatonicNumberToSteprrrrrtr)rnotationObjectccDNNrrQdistanceToMovenewDiatonicNumbernewStep newOctaver{ tempChordrootDNNstaffDistanceFromBassToRootbassSDs r+re(RomanNumeral.bassScaleDegreeFromNotation sN  !!44N KK #  ! !)> >## #''AUN!%!6 !)!E!E!"# G{{gYyk#:;H NN8 $(KK( .."22&-n###&AA''( Q;**F r-cPURb UR$UR(aBURRS5nSnUHn[US- nX$-nM [ U5$[URnU$![ a SnN7f=f![ a SnU$f=f)a Return or set a number from 1 to 100 representing the relative functionality of this RN.figure (possibly given the mode, etc.). Numbers are ordinal, not cardinal. >>> rn1 = roman.RomanNumeral('V7') >>> rn1.functionalityScore 80 >>> rn2 = roman.RomanNumeral('vi6') >>> rn2.functionalityScore 10 >>> rn2.functionalityScore = 99 >>> rn2.functionalityScore 99 For secondary dominants, the functionality scores are multiplied, reducing all but the first by 1/100th: >>> rn3 = roman.RomanNumeral('V') >>> rn3.functionalityScore 70 >>> rn4 = roman.RomanNumeral('vi') >>> rn4.functionalityScore 40 >>> rn5 = roman.RomanNumeral('V/vi') >>> rn5.functionalityScore 28 rgY@rPr)rrrmr'rKeyErrorr)rr scoref scoreParts r+functionalityScoreRomanNumeral.functionalityScore(sF  # # /++ +  % %kk'',GE" 3A 6 >> chd = chord.Chord(['F4', 'Ab4', 'Db5']) >>> rn = roman.romanNumeralFromChord(chd, 'C') >>> rn.isNeapolitan() True As this is key-dependent, changing the key changes the outcome. >>> rn = roman.romanNumeralFromChord(chd, 'Db') >>> rn.isNeapolitan() False The 'N', 'N6' and 'N53' shorthand forms are accepted. >>> rn = roman.RomanNumeral('N') >>> rn.isNeapolitan() True >>> rn = roman.RomanNumeral('N6') >>> rn.isNeapolitan() True Requiring first inversion is optional. >>> rn = roman.RomanNumeral('bII') >>> rn.isNeapolitan(require1stInversion=False) True >>> rn = roman.RomanNumeral('N53') >>> rn.isNeapolitan(require1stInversion=False) True r!FflatrLrT)rrrrr-)rrequire1stInversions r+ isNeapolitanRomanNumeral.isNeapolitancs_X   q --  ) ) . .& 8 <<7 " 4>>#3q#8r-cU(a*UR(aURRSS9$UR(dUR(dgUR(a)[ UR[R 5(dgURRnUS;agURnU[SS5;agURnUS;agUR(aURRnOSn1S kn1S knUS :Xa&X4U4U;agUS :XaUR5(aggUS :Xa%X4U4U;agUS :XaUR5(agg)u Checks if a RomanNumeral is an instance of 'modal mixture' in which the chord is not diatonic in the key specified, but would be in the parallel (German: variant) major / minor and can therefore be thought of as a 'mixture' of major and minor modes, or as a 'borrowing' from the one to the other. Examples include "i" in major or "I" in minor (*sic*). Specifically, this method returns True for all and only the following cases in any inversion: Major context (example of C major): * scale degree 1 and triad quality minor (minor tonic chord, c); * scale degree 2 and triad quality diminished (covers both iio and iiø7); * scale degree b3 and triad quality major (Eb); * scale degree 4 and triad quality minor (f); * scale degree 5 and triad quality minor (g, NB: potentially controversial); * scale degree b6 and triad quality major (Ab); * scale degree b7 and triad quality major (Bb); and * scale degree 7, and it is a diminished seventh (specifically b-d-f-ab). Minor context (example of c minor): * scale degree 1 and triad quality major (major tonic chord, C); * scale degree 2 and triad quality minor (d, not diminished); * scale degree #3 and triad quality minor (e); * scale degree 4 and triad quality major (F); * scale degree #6 and triad quality minor (a); and * scale degree 7, and it is a half-diminished seventh (specifically b-d-f-a). This list is broadly consistent with (and limited to) borrowing between the major and natural minor, except for excluding V (G-B-D) and viio (B-D-F) in minor. There are several borderline caes and this in-/exclusion is all open to debate, of course. The choices here reflect this method's primarily goal to aid anthologizing and pointing to clear cases of mixture in common practice Classical music. At least in that context, V and viio are not generally regarded as mixure. By way of example usage, here are both major and minor versions of the tonic and subdominant triads in the major context. >>> roman.RomanNumeral('I', 'D-').isMixture() False >>> roman.RomanNumeral('i', 'D-').isMixture() True >>> roman.RomanNumeral('IV', 'F').isMixture() False >>> roman.RomanNumeral('iv', 'F').isMixture() True For any cases extending beyond triad/seventh chords, major/minor keys, and the like, this method simply returns False. So when the mode is not major or minor (including when it's undefined), that's False. >>> rn = roman.RomanNumeral('iv', 'C') >>> rn.key.mode 'major' >>> rn.isMixture() True >>> rn.key.mode = 'hypomixolydian' >>> rn.isMixture() False A scale for a key never returns True for mixture. >>> rn = roman.RomanNumeral('i', scale.MajorScale('D')) # mode undefined >>> rn.isMixture() False Likewise, anything that's not a triad or seventh will return False: >>> rn = roman.romanNumeralFromChord(chord.Chord("C D E")) >>> rn.isMixture() False Note that Augmented sixth chords do count as sevenths but never indicate modal mixture (not least because those augmented sixths are the same in both major and minor). >>> rn = roman.RomanNumeral('Ger65') >>> rn.isSeventh() True >>> rn.isMixture() False False is also returned for any case in which the triad quality is not diminished, minor, or major: >>> rn = roman.RomanNumeral('bIII+') >>> rn.quality 'augmented' >>> rn.isMixture() False (That specific example of bIII+ in major is a borderline case that arguably ought to be included and may be added later without a deprecation cycle.) Naturally, really extended usages such as scale degrees beyond 7 (in the Octatonic mode, for instance) also return False. The evaluateSecondaryNumeral parameter allows users to choose whether to consider secondary Roman numerals (like V/vi) or to ignore them. When considered, exactly the same rules apply but recasting the comparison on the secondaryRomanNumeral. This is an extended usage that is open to debate and liable to change. >>> roman.RomanNumeral('V/bVI', 'E-').isMixture() False >>> roman.RomanNumeral('V/bVI', 'E-').isMixture(evaluateSecondaryNumeral=True) True In case of secondary numeral chains, read the last one for mixture. >>> roman.RomanNumeral('V/V/bVI', 'E-').isMixture(evaluateSecondaryNumeral=True) True OMIT_FROM_DOCS Test that the 'C' key has not had its mode permanently changed with the hypomixolydian change above: >>> roman.RomanNumeral('iv', 'C').key.mode 'major' (This is in OMIT_FROM_etc.) T)evaluateSecondaryNumeralFrKrr)rrMrLnatural>rrMrr!rrrrLrrrMrr rMrrrLrr"rLr>rrLrr!rMrrrMr:rrLrrrMr:rLr"rM)r isMixturer0r.rrr'rrrirrrisDiminishedSeventhisHalfDiminishedSeventh)rrrrrfrontAccidentalNamemajorKeyMixturesminorKeyMixturess r+rRomanNumeral.isMixturesDl $(B(B--77QU7V V t~~xxz$((CGG<<xx}} ) )&& eAqk ),, : :  ) )"&"@"@"E"E "+      7?&9:>NN")A)A)C)C W_&9:>NN")E)E)G)Gr-)rrrrrrrrrrrrrrrrrrrrrkrrrrr^r]rr)r/N)rmz str | intrz*key.Key | scale.ConcreteScale | str | None)rrrr)rNone)rrrztuple[int, ...])rrrrr)rkey.Key | scale.ConcreteScalermz str | Noner)tuple[str, key.Key | scale.ConcreteScale])rrrrrr)rrrr)rrrrrr)rrrzT | None)rr)rr)rr)rz#tuple[int, pitch.Accidental | None])rzfbNotation.Notation | Nonerr)rr)rr)T)rr)F)rr)5rrrrrequalityAttributesrcompiler6r%r*r2r<r;rr?r=r__annotations__rnrrrrrrrrrrrrrrrrrIrrripropertyrsetterrmrrrrerrrr __classcell__)rs@r+rrxs\^ ~+zz.1$;<zz">? " +@ A::&:; jj)ST::&BC$'tDMjj.Oj!j!4 !5j!t uj!D Ej!l mj!T $&Uj!x "yj!P +-Qj!B  Cj!D  Ej!Z [j!|  }j!T Uj!r sj!r  sj!J K j!v "w j!P %E j!I~j` ;?Q, !))#++Q,Q,9Q,Q,f0)=V#Ja"7 rY9~ W)-W)W) 1 W)r@>('Rk'k'.k' 1 k'ZP-P P>m%m%.m% m%^pd.32#*#*JUU"" ]]"" 1 1D$$L ZZ;";"F@@048>0> >@44l))266*.6r49Q,0QQr-u Gives a string representation of the roman numeral, which is usually the same as what you passed in as a string: >>> roman.RomanNumeral('bVII65/V', 'C').figure 'bVII65/V' There are a few exceptions. If the RomanNumeral is initialized with an int, then it is converted to a string: >>> roman.RomanNumeral(2).figure 'II' A `0` used for `o` in a diminished seventh chord is converted to `o`, and the `/o` form of half-diminished is converted to `ø`: >>> roman.RomanNumeral('vii07').figure 'viio7' >>> roman.RomanNumeral('vii/o7').figure 'viiø7' Changing this value will not change existing pitches. * Changed in v6.5: empty RomanNumerals now have figure of '' not None c\rSrSrSrSrSrSrSrSr Sr S r S r S r S rS rSrSrSrSrSrSrSrSrSrSrSrSrSrSrSrSrSr Sr!g )!Testic2SSKJn U"U[55 g)Nr) testCopyAll)music21.test.commonTestrglobals)rrs r+testCopyAndDeepcopyTest.testCopyAndDeepcopys7D')$r-c[R"S5n[S5nURU5nUR US5 g)Nz6,3rUr")rprrre assertEqual)rfbnrUsdbs r+testFBN Test.testFBNs<!!%(  ++C0 a r-c[S5nURURS5 URUR[R "/SQ5R5 [S5nURUR S5 URURRRS5 URURRRS5 [R"S5n[SU5nURU5 [R"S 5n[S U5nURUR[R "/S Q5R5 [S U5nURXV5 [S U5nURUR[R "SS/5R5 [SU5nURUR[R "SS/5R5 [SU5nURUR[R "S/5R5 [S[R"S55nURUR[R "S5R5 g)NrU)G4B4D5bbVI6r2z#Descending Doubly-Diminished Unisonrrnrzii/o65)rzB-4rE5uiiø65zV[no3]A4rzV[no5]zC#5z V[no3no5]z V13[no11]zG4 B4 D5 F5 A5 E5)rrrrrrr chromaticrordirectedNiceNamerrassertIsNotNonerr')rr1cMr2dminorr rnRealSlashrnOmits r+ testFigureTest.testFigures #  < @   c " $ # R  (F +  JJ KK1 2 : : #8V4  )h/ dD\)B)J)JKh/ dE])C)K)KLk62 dV)<)D)DEk3773<8 5H)I)Q)QRr-c[S5nUR[UR5S5 UR[UR5S5 g)Nz V9[b7][b5]z[('b', 7), ('b', 5)]z(, , , , ))rrrrr)rrs r+testBracketedAlterationsTest.testBracketedAlterationssG , ' R4457MN RZZR Sr-cSSKJn UR5nUR[R "S55 UR[ R"55 UR5nURU5 UR5nURU5 SnUR[US5U5 [R"U5nURH\nURUR5H:nUR[R 5HnUR!U5 M M< M^ UR[UR#5R[R 55S5 [R"U5nUR[UR#5R[R 55U5 UR#5R[R 5H:nUR$R'5Hn U cMU R!U5 M M< [R"U5n UR[U R#5R[R 55U5 U R)SS9HNn[+U[R 5(dM$UR,cM3UR,R!U5 MP [R"U5n UR[U R#5R[R 55U5 [/U R)SS95HVn [+XR05(dMU R[R 5HnU R!U5 M MX g) Nr)streamrr KeySignatureT) streamsOnlyF)music21r Measurerrr rNotePartScorerrr&deepcopypartsgetElementsByClassremoveflattensitesrrrecurser activeSiterStream) rr rrs targetCounts1es2sites3s4rs r+testYieldRemoveATest.testYieldRemoveAs" NN  !!!$%  KKM  LLN     .! "  ]]1 A))&..9--c.>.>?AHHQK@: RZZ\<.>?AHHQK@5r-c>SSKJn [R"S5nUR SU5nUR [ UR5S5 UR [ UR5S5 UR [ UR5S5 g)Nrrzf#rUzf# minorzQ(, , )z=[(5, None), (7, ), (2, None)]) r rrr'rrrr scaleDegrees)rrkrs r+testScaleDegreesATest.testScaleDegreesAsy! GGDM   Q ' RVVj1   O )   K r-cRSSKJn URS[R"S55nUR UR Vs/sHn[U5PM sn/SQ5 URnUR /SQU5 URnUR US5 gs snf)Nrr%zbii/o42F)zF-4zG-4zB--4zD--5)rrr!rrrzhalf-diminished seventh chord) r rrrrrrrintervalVector commonName)rralteredChordHalfDim3rdInvrivcns r+testNeapolitanAndHalfDiminished$Test.testNeapolitanAndHalfDiminished s!$)$6$6 u'',%.! 6>> ?>SV> ? * ' 5 5 +R0 & 1 1 <= @sB$cSSKJn [R"S5n[R "S5nUR X#5nURURS5 g)Nrr%z A3 E-4 G-4zb-re) r rrrrr'rlrrm)rrrr'rnDim7s r+testOmittedFifthTest.testOmittedFifthsD! KK % GGDM,,Q2 0r-c SSKJn Sn[R"S5nUR SU5nUR U"U5S5 UR SU5nUR U"U5S5 UR S U5nUR U"U5S 5 UR S U5nUR U"U5S 5 UR S U5nUR U"U5S5 UR SU5nUR U"U5S5 UR SU5nUR U"U5S5 UR SU5nUR U"U5S5 UR SU5nUR U"U5S5 UR SU5nUR U"U5S5 UR SU5nUR U"U5S5 UR SU5nUR U"U5S5 UR SU5nUR U"U5S5 UR SU5nUR U"U5S 5 UR S!U5nUR U"U5S"5 UR S#U5nUR U"U5S$5 UR S%U5nUR U"U5S&5 UR S'U5nUR U"U5S(5 UR S)U5nUR U"U5S*5 UR S+U5nUR U"U5S,5 UR S-U5nUR U"U5S.5 UR S/U5nUR U"U5S05 UR S1U5nUR U"U5S25 UR S3U5nUR U"U5S45 UR S5U5nUR U"U5S65 UR S7U5nUR U"U5S85 UR S9U5nUR U"U5S:5 UR S;U5nUR U"U5S<5 UR S=U5nUR U"U5S>5 g)?Nrr%cvSRURVs/sHoRPM sn5$s snfNr#rrrrrs r+r!Test.testAllFormsOfVII..p"+88qyyAy!--yAB BA6rrzB4 D5 F5rkzD4 F4 B4viio64zF4 B4 D5viiz B4 D5 F#5vii6z D4 F#4 B4vii64z F#4 B4 D5rez B4 D5 F5 A-5riz D4 F4 A-4 B4viio43z F4 A-4 B4 D5viio42z A-4 B4 D5 F5zvii/o7z B4 D5 F5 A5uviiø65z D4 F4 A4 B4uviiø43z F4 A4 B4 D5zvii/o42z A4 B4 D5 F5rz B-4 D5 F5VII6z D4 F4 B-4VII64z F4 B-4 D5bVIIz B--4 D-5 F-5bVII6z D-4 F-4 B--4bVII64z F-4 B--4 D-5bviiz B-4 D-5 F5bvii6z D-4 F4 B-4bvii64z F4 B-4 D-5bviioz B-4 D-5 F-5bviio6z D-4 F-4 B-4bviio64z F-4 B-4 D-5z#VIIz B4 D#5 F#5z#viiz B#4 D#5 F##5zVII+z B-4 D5 F#5r rrr'rrrrrr'rs r+testAllFormsOfVIITest.testAllFormsOfVIIsh! C GGCL    * 2 +    + 2 +   ! , 2 +   q ) 2 ,    * 2 ,    + 2 ,    + 2/   ! , 2/   ! , 2/   ! , 2/   ! , 2 .    1 - 2 .    1 - 2 .    1 - 2 .   q ) 2 ,    * 2 ,    + 2 ,    * 2/    + 2/   ! , 2/    * 2 -    + 2 -   ! , 2 -    + 2 .   ! , 2 .    1 - 2 .    * 2 -    * 2/    * 2 -r-c SSKJn Sn[R"S5nUR SU5nUR U"U5S5 UR SU5nUR U"U5S5 UR S U5nUR U"U5S 5 UR S U5nUR U"U5S 5 UR S U5nUR U"U5S5 UR SU5nUR U"U5S5 UR SU5nUR U"U5S5 UR SU5nUR U"U5S5 UR SU5nUR U"U5S5 UR SU5nUR U"U5S5 UR SU5nUR U"U5S5 UR SU5nUR U"U5S5 UR SU5nUR U"U5S5 UR SU5nUR U"U5S 5 UR S!U5nUR U"U5S"5 UR S#U5nUR U"U5S$5 UR S%U5nUR U"U5S&5 UR S'U5nUR U"U5S(5 UR S)U5nUR U"U5S*5 UR S+U5nUR U"U5S,5 UR S-U5nUR U"U5S.5 UR S/U5nUR U"U5S05 UR S1U5nUR U"U5S25 UR S3U5nUR U"U5S45 UR S5U5nUR U"U5S65 UR S7U5nUR U"U5S85 UR S9U5nUR U"U5S:5 UR S;U5nUR U"U5S<5 UR S=U5nUR U"U5S>5 g)?Nrr%cvSRURVs/sHoRPM sn5$s snfr9r:r;s r+r Test.testAllFormsOfVI..por=r>rvioz A4 C5 E-5vio6z C4 E-4 A4vio64z E-4 A4 C5rzA4 C5 E5rzC4 E4 A4vi64zE4 A4 C5vio7z A4 C5 E-5 G-5vio65z C4 E-4 G-4 A4vio43z E-4 G-4 A4 C5vio42z G-4 A4 C5 E-5viø7z A4 C5 E-5 G5zvi/o65z C4 E-4 G4 A4zvi/o43z E-4 G4 A4 C5uviø42z G4 A4 C5 E-5r{z A-4 C5 E-5VI6z C4 E-4 A-4VI64z E-4 A-4 C5bVIz A--4 C-5 E--5bVI6z C-4 E--4 A--4bVI64z E--4 A--4 C-5bviz A-4 C-5 E-5bvi6z C-4 E-4 A-4bvi64z E-4 A-4 C-5bvioz A-4 C-5 E--5bvio6z C-4 E--4 A-4bvio64z E--4 A-4 C-5r}z A4 C#5 E5z#viz A#4 C#5 E#5zVI+z A-4 C5 E5rPrQs r+testAllFormsOfVITest.testAllFormsOfVIlsh! C GGCL   q ) 2 ,    * 2 ,    + 2 ,   a ( 2 +   q ) 2 +    * 2 +    * 20    + 20    + 20    + 20    + 2/   ! , 2/   ! , 2/   ! , 2/   a ( 2 -   q ) 2 -    * 2 -   q ) 20    * 20    + 20   q ) 2 .    * 2 .    + 2 .    * 2/    + 2/   ! , 2/   q ) 2 ,   q ) 2 .   q ) 2 ,r-c^^^SSKJm SmS#UUU4SjjnU"SSS/S5 U"S /S QS 5 U"S /S QS5 U"S/S QS5 U"SS/SS5 U"SS/SS5 U"S S/SS5 U"S S/SS5 U"S S/SS5 U"S S/SS5 U"S S/SS5 U"S S/SS5 U"SS/S S5 U"SS/S!S5 U"SS/S"S5 g)$Nrr%cvSRURVs/sHoRPM sn5$s snfr9r:r;s r+rTest.testAugmented..pr=r>c>UHjnSHanX3R54HIn[R"U5nX-U-nT RX5n T R T "U 5U5 MK Mc Ml g)N)r/r)rrr'rr) country figure_listrkey_inrm with_pluskStrkey_objrn_strrrrrs r+ test_numeral(Test.testAugmented..test_numeralsh%!*I!' 8"%''$-!(!4v!="//@((27 !9"+&r-rUr2r/z F5 A5 D#6r)r/r2r?z6/5z F5 A5 C6 D#6rX)r/r2rCz4/3z F5 A5 B5 D#6rYz F5 A5 B#5 D#6r.z F#4 A-4 C5rr,z C4 F#4 A-4r4zF#4 A-4 C5 E-5rCzC4 E-4 F#4 A-4rEzE-4 F#4 A-4 C5z D4 F#4 A-4 C5r?z F#4 A-4 C5 D5z C4 D4 F#4 A-4zD#4 F#4 A-4 C5zF#4 A-4 C5 D#5zC4 D#4 F#4 A-4)a)r r)rrxrrs` @@r+ testAugmentedTest.testAugmenteds! C 8 8 TC9k2U2NCT1>BT1?C TD6<5TD6<5USE#3S9UTF$4c:UTF$4c:TC5/37TD6?C8TD6?C8TC5"2C8TD6#3S9TD6#3S9r-cr/SQn[R"S5n[R"S5nUGHn[XB5n[R"UR 5n[ U5nUS;aRURURURUSU35 URURRS5 [ Xb5nURURURUSU35 [ Xc5nURURURUSU35 GM g)N)rr9r:rrArBrCrr;r<r=rr>r?r@rr)rCr;z: ) rr'rrrrrlrrmr()raugTestsc_minorc_majoraug6rchrn_outs r+test_augmented_round_tripTest.test_augmented_round_trips ''#,''#,Dd,BRZZ(B*2.F?*  FMMdV2fX;NO  !B!BCH+27F   RYY $r&7J K*27F   RYY $r&7J Kr-c[S5nURnSUlURURU5 [S5nURnSUlURURU5 g)z9 Setting the figure again doesn't double the alterations rCz#IVN)rrrmr)rgerpitches_before sharp_fours r+testSetFigureAgainTest.testSetFigureAgainse6"  n5!%( #++!  ++^ cpSHUnUR[US5R55 UR[US5R55 MW SHUnUR[US5R55 UR[US5R55 MW g)N)rQrbIIIr/rrbrGrerrz)rOrnz#iiiraruviiø7)rrrr)rrs r+ testMixtureTest.testMixture]sJC OOLc2<<> ?   \#s3==? @ K =C   \#s3==? @ OOLc2<<> ? =r-cL[SS5nURVs/sHo"RPM nnURU/SQ5 [R "S5[R "S54H}n[ R"S5n[XT5nURURS5 [ R"S5n[Xt5nURURS5 M [R "S5[R "S 54H}n[ R"S 5n[Xt5nURURS 5 [ R"S 5n[Xt5nURURS 5 M gs snf)Ni7r)rE-rrrz C4 E-4 G4 B-4z E-4 G4 B-4 C5i65rgz G4 B-4 C5 E-5iv43z B-4 C5 E-5 G5iv42) rrrrrr'rrrlrm)rrr pitchStringsr'ch1rn2rs r+testMinorTonic7InMajorTest.testMinorTonic7InMajorjs. $ $(* 3 1 3 '=>''#, -A++o.C'/C   SZZ ._-B&r-B   RYY . .''#, -A_-B&r-B   RYY /_-B&r-B   RYY / .4sF!c^SU4Sjjn[SS5nURVs/sHo3RPM nnTRU/SQ5 [R "S5n[ US5nTRURS5 U"U5 [R "S5n[ US5nTRURS5 U"U5 [R "S5n [ U S 5n TRU RS 5 U"U S 5 [R "S 5n [ U S 5n TRU RS 5 U"U S 5 [ US 5nTRURS5 U"US 5 [ US 5nTRURS5 U"US 5 [R "S5n [ U S5n TRU RS 5 U"U S5 [R "S 5n [ U S5n TRU RS 5 U"U S5 gs snf)Nrc >URVs/sHo"RPM nn[URU5nURVs/sHo"RPM nnTR X5USUSU35 gs snfs snf)Nz not equal z for )rrrrmr)rn_inr'rp_oldrn_newp_newrs r+new_fig_equals_old_figure>Test.testMinorMajor7InMajor..new_fig_equals_old_figuresp%*]]3]VV]E3!%,,2F%+^^4^VV^E4   UeWKweE7+S T 44s A= Bzi7[#7])rrrrz C4 E-4 G4 B4z E-4 G4 B4 C5zi65[#7]z G4 B4 C5 E-5rziv43[#7]z B4 C5 E-5 G5ziv42[#7]rzi#7r)r)rrrrrrrlrm) rrrrrrrn1ch2rch3rn3ch4rn4s ` r+testMinorMajor7InMajorTest.testMinorMajor7InMajor~s U(C ((* 3 1 3 '<=kk.)#C- X.!#&kk.)#C- Y/!#&kk.)#C- Z0!#s+kk.)#C- Z0!#s+$C- U+!#s+#C- Y/!#s+kk.)#C- Z0!#s+kk.)#C- Z0!#s+I4sIc[SS5nURUR5RS5 URURVs/sHo"RPM sn/SQ5 gs snf)z Fixes issue #1369 z IV[add#7]rF4)rrrzE#5N)rrrrrrs r+test_addedPitch_sharp7Test.test_addedPitch_sharp7sY+s + 1148 BJJ?Jq**J?2 4?sA0c,[SS5nURURRS5 [SS5nURURRS5 [SS5nURURRS5 [SS[R S9nURURRS 5 [SS[R S9nURURRS 5 g) NbII7rrbII65rrbVII7)r^rr)rrr/rrnro)rrs r+test_sevenths_on_alteration Test.test_sevenths_on_alterations &# & #. '3 ' #.'3 ' #. '3^5N5N O $/ '3^5N5N O #.r-c[R"S5n[SU5nURURS5 [SUSS9nURURS5 [SS5nURURS5 [S [ R "S55nURURS 5 [SS 5nURURS 5 g )z< Fix for https://github.com/cuthbertLab/music21/issues/1450 rr!rnF)rrrr/rrrraN)rr'rrrmrr)r minorKeyObjrs r+test_int_figure_case_matters!Test.test_int_figure_case_matterssggcl ![ ) D) ![e < D) !S ! D) !U--c2 3 D)!S ! D)r-c[R"SSS9nURS5nURURVs/sHo3R PM sn/SQ5 [R"SSS9nURS5nURURVs/sHo3R PM sn/SQ5 gs snfs snf)Nr)rrEr+rrr)rr)r+rrr)rrrr+rrr)r+rruE♭)r ConcreteScalerrr unicodeName)rmcsrrs r+test_scale_cachingTest.test_scale_cachings!!#/RS   e $ <A--<>RS!!#/ST   e $ <A--<>UV==s B>CrN)"rrrrrrrrr"r(r1r5rRrkr{rrrrrrrrrrrrrrrrrrrrr-r+rrs% ! S>S6 p >1K.ZI-V :DL< = S, - / -OID!LF @0(-,^4 /*(Wr-rc\rSrSrSrSrSrg) TestExternaliTc.SSKJn URS5nUR5nUR S5n0nUR 5HWn[ U[R5(dM$[Xd5nURnX;aSXX'O XX==S- ss'Xl MY UR(a+[XURSS9n U Hn [XU 5 M UR!SU5 UR(aUR5 gg)Nr)corpuszbwv103.6rrT)rreverse)r rparsechordifyanalyzerrrrrlrmlyricshowrrrprintr) rrrrcKey figuresCacherrncrm sortedList thisFigures r+testFromChordifyTestExternal.testFromChordifys" LL $ JJLyy A!U[[))+A4-+,L( (A-(  99 2B2BDQJ( jz":;) A 99 FFH r-rN)rrrrrr rrr-r+rrs Dr-r__main__)r)rrkey.Keyr)r chord.Chordrrrzlist[ChordFigureTuple])rrr*rrrrr)rzlist | tuple | chord.Chordrrrzstr | t.Literal[False])rrr3z int | Nonerr)r6rr*rrr)NF)rrr*zkey.Key | str | Noner[rrr)Er __future__rr&enumrtypingrfunittest collectionsrr rrrrr music21.figuredBassr rpr r rrrrrr Environment environLocalTypeVarrrrrrrrrrr$r,rrNrrrrrrr*rr7rlEnumrnMusic21ExceptionrrrrHarmonyrrmTestCaserr _DOC_ORDERrmainTestrr-r+rs.# " 6(HI 02[\&&w/ IIc( zz-. I&/1 +0 " "!))+ 62 $" # 3   #   #  C 3 3 # # # 4 E 4  4!$t%& +2)o1'1'1' "1' 1'  2 1'  " 1' "1' 21' 21' "1' "1' R1' 21' b1' R1' r!1'" "#1'$ b%1'& B'1'( B)1'* B+1', 2-1'. 2/1'0 "11'2 231'4 "51'6 B71'8 R91': 2;1'< R=1'> B?1'@ 2A1'B RC1'D RE1'F        a1'^1n4n$)Nxv?D<< < < <~O6 #O6 O6O6d6rEKEK EKEKT $%*@@ @#@ @F TYY J\22  J t'7??t'pO   z Tr-