rh^e^SSKJr SSKrSSKrSSKrSSKJr SSKJr SSKJr SSSSS S S S S SSS. r /SQr S/r SSSSSSSSS.r SSSSSSSSS SSSSSS!.r "S"S#\R5r"S$S%\R 5r"S&S'\R5r0SS_SS(_SS_SS(_SS)_S*S+_S,S-_S.S_S/S0_S1S2_S3S_SS4_S5S_S6S_S7S_S8S_S9S)_r"S:S;\R5r"S<S=\R 5rS>r\\\/r"S?S@\R05r\SA:XaSSKr\R6"\5 gg)B) annotationsN) exceptions21)pitch)prebase))r)rr) r rr) r r rr) r r r rr)r rr)r r)r r) N)r)r )r )r )r )r )r r)rr)rr)r)+#++##\rb♮rbb/r)sharpflatnatural double-sharp flat-flat backslashslashcrossrrrrrr r)rrrrrrr♯r♭⃥̸𝄪𝄫c r\rSrSr%Sr/SQrSSSSSS S S S .rS \S'SSSjjrSr Sr Sr Sr SSjr Srg)Notation@u Breaks apart and stores the information in a figured bass notation column, which is a string of figures, each associated with a number and an optional modifier. The figures are delimited using commas. Examples include '7,5,#3', '6,4', and '6,4+,2'. Valid modifiers include those accepted by :class:`~music21.pitch.Accidental`, such as #, -, and n, as well as those which can correspond to one, such as +, /, and b. .. note:: If a figure has a modifier but no number, the number is assumed to be 3. Notation also translates many forms of shorthand notation into longhand. It understands all the forms of shorthand notation listed below. This is true even if a number is accompanied by a modifier, or if a stand-alone modifier implies a 3. * None, '' or '5' -> '5,3' * '6' -> '6,3' * '7' -> '7,5,3' * '6,5' -> '6,5,3' * '4,3' -> '6,4,3' * '4,2' or '2' -> '6,4,2' * '9' -> '9,7,5,3' * '11' -> '11,9,7,5,3' * '13' -> '13,11,9,7,5,3' * '_' -> treated as an extender Figures are saved in order from left to right as found in the notationColumn. >>> from music21.figuredBass import notation >>> n1 = notation.Notation('4+,2') >>> n1 >>> n1.notationColumn '4+,2' >>> n1.figureStrings ['4+', '2'] >>> n1.origNumbers (4, 2) >>> n1.origModStrings ('+', None) >>> n1.numbers (6, 4, 2) >>> n1.modifierStrings (None, '+', None) >>> n1.modifiers (, , ) >>> n1.figures[0] > >>> n1.figures[1] > >>> n1.figures[2] > Here, a stand-alone '#' is being passed to Notation. >>> n2 = notation.Notation('#') >>> n2.numbers (5, 3) >>> n2.modifiers (, ) >>> n2.figures[0] > >>> n2.figures[1] > Now, a stand-alone b is being passed to Notation as part of a larger notationColumn. >>> n3 = notation.Notation('b6,b') >>> n3.numbers (6, 3) >>> n3.modifiers (, ) >>> n3.figures[0] > >>> n3.figures[1] > >>> n3.extenders [False, False] >>> n3.hasExtenders False Here we will use the unicode symbol for double-flat for the extender: >>> n4 = notation.Notation('b6, 𝄫_, #') >>> n4.figures [>, >, >] >>> n4.figuresFromNotationColumn [>, >, >] >>> n4.extenders [False, True, False] >>> n4.hasExtenders True )notationColumn figureStringsnumbers modifiersfigures origNumbersorigModStringsmodifierStringsz A tuple of :class:`~music21.figuredBass.notation.Modifier` objects associated with the expanded :attr:`~music21.figuredBass.notation.Notation.notationColumn`. z A string of figures delimited by commas, each associated with a number and an optional modifier. z The modifiers associated with the expanded :attr:`~music21.figuredBass.notation.Notation.notationColumn`, as strings. z A list of figures derived from the original :attr:`~music21.figuredBass.notation.Notation.notationColumn`. z The numbers associated with the original :attr:`~music21.figuredBass.notation.Notation.notationColumn`. z The numbers associated with the expanded :attr:`~music21.figuredBass.notation.Notation.notationColumn`. z The modifiers associated with the original :attr:`~music21.figuredBass.notation.Notation.notationColumn`, as strings. z A list of :class:`~music21.figuredBass.notation.Figure` objects associated with figures in the expanded :attr:`~music21.figuredBass.notation.Notation.notationColumn`. )r.r+r2r,r0r-r1r/dict[str, str] _DOC_ATTRc0U=(d SUl/UlSUlSUl/UlSUl/UlSUlUR5 UR5 SUl /Ul /Ul UR5 UR5 g)NF)r+r,r0r1r-r2 extenders hasExtenders_parseNotationColumn_translateToLonghandr.r/figuresFromNotationColumn _getModifiers _getFigures)selfr+s V/home/james-whalen/.local/lib/python3.13/site-packages/music21/figuredBass/notation.py__init__Notation.__init__s#1#7R(*1346"$ 57%'"' !!# !!#02%' 79&  c,[UR5$r)strr+r?s r@ _reprInternalNotation._reprInternals4&&''rCcSn[R"XR5nSnSn/n/n/nUGHnUR5nUR U5 [R "X85n [R "XH5n [ U RS55Hn U RS5 M [ U RS55Hn U RS5 M [U 5S::d[U 5S::d[SU-5eSn Sn SnU (a^S U ;a S Ul S n S nOLS U S ;a'S Ul S n[U S RS 55n O[U S R55n U (aU S R5n UR U 5 UR U 5 URR U5 GM [U5n[U5nXPlXPlX`lX`lXplg) ai Given a notation column below a pitch, defines both self.numbers and self.modifierStrings, which provide the intervals above the bass and (if necessary) how to modify the corresponding pitches accordingly. `_parseNotationColumn` is called from `__init__` and thus is not explicitly demonstrated below. >>> from music21.figuredBass import notation as n >>> notation1 = n.Notation('#6, 5') The figureStrings are left alone: >>> notation1.figureStrings ['#6', '5'] And in this case the original numbers (`origNumbers`) are the same: >>> notation1.origNumbers (6, 5) Since 6 has a sharp on it, it has something in the original modifier strings (`origModStrings`) >>> notation1.origModStrings ('#', None) A second example of flat 6 and flat 3: >>> notation2 = n.Notation('-6, -') >>> notation2.figureStrings ['-6', '-'] >>> notation2.origNumbers (6, None) >>> notation2.origModStrings ('-', '-') An example of a seventh chord with extender: >>> notation3 = n.Notation('7_') `hasExtenders` is set True if an underscore is parsed within a notation string >>> notation3.hasExtenders True >>> notation2.hasExtenders False z[,]z ([0-9_]*)z ([^0-9_]*)r6zInvalid Notation: NF_Tr)resplitr+stripappendfindallrangecountremovelenNotationExceptionr9intr8tupler0r-r1r2r,)r? delimiterr/ patternA1 patternA2r-r2r,figurem1m2inumbermodifierStringextenders r@r:Notation._parseNotationColumnsh ((9&9&9:   F\\^F   (I.BI.B288B<( " )288B<( " )GqLCGqL'( 2 NN ! !( +EH.0" -.*rCc.URnUnURnUn[Un/n[U5n/nUH*nUcUR S5 MUR U5 M, [ U5nUH0nSnXa;aUR U5nX8nUR U5 M2 [ U5nX lX@lg![aK [U5n/nUH*nUcUR S5 MUR U5 M, [ U5nNaf=f)a Provided the numbers and modifierStrings of a parsed notation column, translates it to longhand. >>> from music21.figuredBass import notation as n >>> notation1 = n.Notation('#6,5') # __init__ method calls _parseNotationColumn() >>> str(notation1.origNumbers) + ' -> ' + str(notation1.numbers) '(6, 5) -> (6, 5, 3)' >>> str(notation1.origModStrings) + ' -> ' + str(notation1.modifierStrings) "('#', None) -> ('#', None, None)" >>> notation2 = n.Notation('-6,-') >>> notation2.numbers (6, 3) >>> notation2.modifierStrings ('-', '-') Nr)r-r2shorthandNotationlistrOrWindexKeyError) r? oldNumbers newNumbersoldModifierStringsnewModifierStringstempr_newModifierStringmodifierStringIndexs r@r;Notation._translateToLonghandPs$"\\  !11/ %*:6J!# j)JD$>KKNKK' % tJ$$(!'*4*:*:6*B'(:(O%"))*;< %"''9!: " 1 %j)JD$>KKNKK' % tJ %sBB??ADDc/n[[UR55H.nURUn[ U5nUR U5 M0 [ U5Ulg)a Turns the modifier strings into Modifier objects. A modifier object keeps track of both the modifier string and its corresponding pitch Accidental. The `__init__` method calls `_getModifiers()` so it is not called below. >>> from music21.figuredBass import notation as n >>> notation1 = n.Notation('#4,2+') >>> notation1.modifiers[0] >>> notation1.modifiers[1] >>> notation1.modifiers[2] N)rQrTr-r2ModifierrOrWr.)r?r.r^r`modifiers r@r=Notation._getModifierssW" s4<<()A!11!4N/H   X &* y)rCc/n[[UR55HwnURUnURUnSnUR(a(U[UR5:aURUn[ X4US9nUR U5 My Xl/n[UR5H0up(URUn[ X5nUR U5 M2 Xpl g)a Turns the numbers and Modifier objects into Figure objects, each corresponding to a number with its Modifier. >>> from music21.figuredBass import notation as n >>> notation2 = n.Notation('-6,-') #__init__ method calls _getFigures() >>> notation2.figures[0] > >>> notation2.figures[1] > FraN) rQrTr-r2r8FigurerOr/ enumerater0r1r<) r?r/r^r_r`rar[figuresFromNotaCol origNumbers r@r>Notation._getFiguress!#s4<<()A\\!_F!11!4NH~~!c$..&9"9>>!,FXFF NN6 "* &t'7'78MA!003NJ7F  % %f -9 *<&rC) r8r,r/r<r9r2r.r+r-r1r0N)r6)r+rEreturnNone)r{r|)__name__ __module__ __qualname____firstlineno____doc__ _DOC_ORDERr4__annotations__rArGr:r;r=r>__static_attributes__r7rCr@r)r)@sigPQJ =#!I~#J((g+R82t*4!>> from music21.figuredBass import notation >>> f1 = notation.Figure(4, '+') >>> f1 > >>> f1.number 4 >>> f1.modifierString '+' >>> f1.modifier >>> f1.hasExtender False >>> f1.isPureExtender False >>> f2 = notation.Figure(6, '#', extender=True) >>> f2.hasExtender True >>> f2.isPureExtender False >>> f3 = notation.Figure(extender=True) >>> f3.isPureExtender True >>> f3.hasExtender True z A number associated with an expanded :attr:`~music21.figuredBass.notation.Notation.notationColumn`. A modifier string associated with an expanded :attr:`~music21.figuredBass.notation.Notation.notationColumn`. z A :class:`~music21.figuredBass.notation.Modifier` associated with an expanded :attr:`~music21.figuredBass.notation.Notation.notationColumn`. z A bool value that indicates whether an extender is part of the figure. It is set by a keyword argument. )r_r`rr hasExtenderr3r4FrucHXlX l[U5UlX0lgr)r_r`rqrrr)r?r_r`ras r@rAFigure.__init__s!!' (6"*>": !)rCcFURS:H=(a UR$)a Read-only boolean property that returns True if an extender is part of the figure but no number is given (a number of 1 means no-number). It is a pure extender. >>> from music21.figuredBass import notation >>> n = notation.Figure(1, '#', extender=True) >>> n.isPureExtender True >>> n > >>> n.number = 2 >>> n.isPureExtender False >>> n > rJ)r_rrFs r@isPureExtenderFigure.isPureExtenders&{{a4D$4$44rCcUR(aSnSnO*[UR5nUR(aSOSn[ UR 5R SS5nUUSU3$)Nz pure-extenderr6z (extender)zmusic21.figuredBass.notation. )rrEr_rreprrrreplace)r?numextmods r@rGFigure._reprInternal$sc   !CCdkk"C"&"2"2,C4==!))*I2Nse1SE""rC)rrrr`r_N)rJr6)r_z int | Noner`z str | Nonerabool)r{r) r}r~rrrr4rrApropertyrrGrr7rCr@rvrvsv@ !I~,#% *  * *! *  *55(#rCrv-z--bbbz---bbbbz-----rz+++z###z++++z####r"nr#r$r%r&r'cX\rSrSr%SrSSS.rS\S'SS jrS rS r S r S S.Sjr Sr g)rqiEa> Turns a modifierString (a modifier in a :attr:`~music21.figuredBass.notation.Notation.notationColumn`) to an :class:`~music21.pitch.Accidental`. A ModifierException is raised if the modifierString is not valid. Accepted inputs are those accepted by Accidental, as well as the following: * '+' or '\' -> '#' * 'b' or '/' -> '-' >>> from music21.figuredBass import notation >>> m1a = notation.Modifier('#') >>> m1a >>> m1a.modifierString '#' >>> m1a.accidental Providing a + in place of a sharp, we get the same result for the accidental. >>> m2a = notation.Modifier('+') >>> m2a >>> m2a.accidental If None or '' is provided for modifierString, then the accidental is None. >>> m3a = notation.Modifier(None) >>> m3a >>> m3a.accidental is None True >>> m3b = notation.Modifier('') >>> m3b >>> m3b.accidental is None True rz A :class:`~music21.pitch.Accidental` corresponding to :attr:`~music21.figuredBass.notation.Modifier.modifierString`. )r` accidentalr3r4Nc:XlUR5Ulgr)r` _toAccidentalr)r?r`s r@rAModifier.__init__|s,,,.rCcpURbURRnOSnURSU3$)Nr)rnamer`)r?accs r@rGModifier._reprInternals8 ?? &//&&CC%%&au--rCcZUR(dg[R"5nURUR5 U$![RaP [ URnO&![ a [SUR35ef=fURU5 U$f=f)a >>> from music21.figuredBass import notation as n >>> m1 = n.Modifier('#') >>> m2 = n.Modifier('-') >>> m3 = n.Modifier('n') >>> m4 = n.Modifier('+') # Raises pitch by semitone >>> m5 = n.Modifier('b') # acceptable for flat since note names not allowed >>> m1.accidental >>> m2.accidental >>> m3.accidental >>> m4.accidental >>> m5.accidental Nz(Figure modifier unsupported in music21: )r`r AccidentalsetAccidentalExceptionspecialModifiersrgModifierException)r?arms r@rModifier._toAccidentals(""     % EE$%% &(( % $4T5H5H$I! '>t?R?R>ST  EE# $ %s)AB*A/.B*/#BB*)B*cf[R"U5nURUSS9 UR$)a Given a pitch name, modify its accidental given the Modifier's :attr:`~music21.figuredBass.notation.Modifier.accidental`. >>> from music21.figuredBass import notation >>> m1 = notation.Modifier('#') >>> m2 = notation.Modifier('-') >>> m3 = notation.Modifier('n') >>> m1.modifyPitchName('D') # Sharp 'D#' >>> m2.modifyPitchName('F') # Flat 'F-' >>> m3.modifyPitchName('C#') # Natural 'C' TinPlace)rPitch modifyPitchr)r?pitchNameToAlter pitchToAlters r@modifyPitchNameModifier.modifyPitchNames2 {{#34  t4   rCFrcU(d[R"U5nURcU$URRS:Xd URc&[R"UR5UlOZ[R "5nURRURR-nUR U5 X1lU(dU$g![Ra [S5ef=f)a Given a :class:`~music21.pitch.Pitch`, modify its :attr:`~music21.pitch.Pitch.accidental` given the Modifier's :attr:`~music21.figuredBass.notation.Modifier.accidental`. >>> from music21.figuredBass import notation >>> m1 = notation.Modifier('#') >>> m2 = notation.Modifier('-') >>> m3 = notation.Modifier('n') >>> p1a = pitch.Pitch('D5') >>> m1.modifyPitch(p1a) # Sharp >>> m2.modifyPitch(p1a) # Flat >>> p1b = pitch.Pitch('D#5') >>> m3.modifyPitch(p1b) OMIT_FROM_DOCS >>> m4 = notation.Modifier('##') >>> m5 = notation.Modifier('--') >>> p2 = pitch.Pitch('F5') >>> m4.modifyPitch(p2) # Double Sharp >>> m5.modifyPitch(p2) # Double Flat Ngz2Resulting pitch accidental unsupported in music21.) copydeepcopyralterrrrrr)r?rr newAccidentalnewAlters r@rModifier.modifyPitchs6==6L ?? "  ?? C '<+B+B+J&*mmDOO&DL #!,,.M#..44t7L7LLH ^!!(+*7' ,, ^'(\]] ^s =C C>)rr`r) r}r~rrrr4rrArGrrrrr7rCr@rqrqEsD*X !I~ /.#J!(49+ + rCrqc\rSrSrSrg)rir7Nrr7rCr@rrrrCrc[U[R5(aU$[U[5(a[R"U5$[ SU-S-5e! [ SU-S-5e=f)a( Converts a pitchString to a :class:`~music21.pitch.Pitch`, only if necessary. >>> from music21.figuredBass import notation >>> pitchStr = 'C5' >>> notation.convertToPitch(pitchStr) >>> notation.convertToPitch(pitch.Pitch('E4')) # does nothing zCannot convert string z to a music21 Pitch.zCannot convert ) isinstancerrrE ValueError TypeError) pitchStrings r@convertToPitchrsu+u{{+++s## ^;;{+ + % 36LL MM ^5 CF\\] ]s AA2c\rSrSrSrg)Testir7Nrr7rCr@rrrrCr__main__) __future__rrrLunittestmusic21rrrrdprefixessuffixesmodifiersDictXmlToM21modifiersDictM21ToXmlProtoM21Objectr)Music21ExceptionrUrvrrqrrrTestCaserr}mainTestr7rCr@rs"#  $!!$',0&&&$  " 6            "E