rhZSrSSKJr SSKrSSKrSSKJr SSKJr SSK J r \R(aSSKJ r "SS \R5r"S S \R5r"S S \ 5r"SS\5r"SS\5r"SS\5r"SS\5r"SS\5r"SS\5r"SS\5r"SS\R25r"SS\R65r\S :XaSSKr\R<"\5 gg)!z The style module represents information about the style of a Note, Accidental, etc. such that precise positioning information, layout, size, etc. can be specified. ) annotationsN)common) exceptions21)ProtoM21Object editorialc\rSrSrSrg)TextFormatExceptionN__name__ __module__ __qualname____firstlineno____static_attributes__r G/home/james-whalen/.local/lib/python3.13/site-packages/music21/style.pyr r rr cP\rSrSrSrSrSrSrSrSr Sr S r S r S r S rS rSrSrSrSrg) Enclosure! rectanglesquareovalcirclebrackettrianglediamondpentagonhexagonheptagonoctagonnonagondecagonzinverted-bracketnoner N)rrrr RECTANGLESQUAREOVALCIRCLEBRACKETTRIANGLEDIAMONDPENTAGONHEXAGONHEPTAGONOCTAGONNONAGONDECAGONINVERTED_BRACKET NO_ENCLOSURErr rrrr!sNI F D FGHGHGHGGG)Lrrc\rSrSr%SrSSS.rS\S'SSjr\SS j5r \ RSS j5r S r S r \"\ \ S S9r Srg)Style3z A style object is a lightweight object that keeps track of information about the look of an object. >>> st = style.Style() >>> st.units 'tenths' >>> st.absoluteX is None True >>> st.absoluteX = 20.4 >>> st.absoluteX 20.4 z If set to `True`, the Music21Object will not print upon output (only used in MusicXML output at this point and in Lilypond output for notes, chords, and rests). z What distances are measured in. The default "tenths" is a concept borrowed from MusicXML which refers to 1/10th of the distance between two staff lines. It is currently also the only supported unit. )hideObjectOnPrintunitsdict[str, str] _DOC_ATTRcSUlSUlSUlSUlSUlSUlSUlSUlSUlSUl SUl SUl g)NtenthsF) size relativeX relativeY absoluteX _absoluteY _enclosurefontRepresentationcolorr:r9 dashLength spaceLengthselfs r__init__Style.__init__Ps_ )-)-)-+/+/#'# " ',*.+/rcUR$)as Get or set the enclosure as a style.Enclosure enum (or None, which means the enclosure is left unspecified). Valid names are: * "rectangle"/style.Enclosure.RECTANGLE, * "square"/style.Enclosure.SQUARE, * "oval"/style.Enclosure.OVAL, * "circle"/style.Enclosure.CIRCLE, * "bracket"/style.Enclosure.BRACKET, * "inverted-bracket"/style.Enclosure.INVERTED_BRACKET (output in musicxml 4 only) * "none"/style.Enclosure.NO_ENCLOSURE * None (i.e. enclosure is unspecified) or the following other shapes with their ALLCAPS Enclosure equivalents: triangle, diamond, pentagon, hexagon, heptagon, octagon, nonagon, or decagon. >>> tst = style.TextStyle() >>> tst.enclosure = None >>> tst.enclosure = style.Enclosure.RECTANGLE >>> tst.enclosure Setting as a string is still supported, but is converted to an enum. >>> tst.enclosure = 'octagon' >>> tst.enclosure Setting an invalid enclosure raises a TextFormatException >>> tst.enclosure = 'parabola' Traceback (most recent call last): music21.style.TextFormatException: Not a supported enclosure: 'parabola' OMIT_FROM_DOCS Similarly for non-strings: >>> tst.enclosure = 4 Traceback (most recent call last): music21.style.TextFormatException: Not a supported enclosure: 4 * Changed in v9.7: We now differentiate between no enclosure (Enclosure.NO_ENCLOSURE) and unspecified enclosure (None). )rDrIs r enclosureStyle.enclosureksnrcUcXlg[U[5(aXlg[U[5(a![UR 55nX lg[ SU<35e![ an[ SU<35UeSnAff=f)NzNot a supported enclosure: )rD isinstancerstrlower ValueErrorr )rJvalue enc_valueves rrNrOs =#O y ) )#O s # # [%ekkm4 (O&(CE9&MN N  [),Gy*QRXZZ [sA,, B 6BB cUR$N)rCrIs r _getAbsoluteYStyle._getAbsoluteYs rcUcSUlgUS:XaSUlgUS:XaSUlg[R"U5Ulg![an[ SU<35UeSnAff=f)Nabove belowiz$Not a supported absoluteY position: )rCrnumToIntOrFloatrTr rJrUrWs r _setAbsoluteYStyle._setAbsoluteYsm ="DO g  DO g !DO "("8"8"? ):5)D sA A$AA$a\ Get or set the vertical position, where 0 is the top line of the staff and units are whatever is defined in `.units`, generally "tenths", meaning 1/10th of a staff space. Other legal positions are 'above' and 'below' which are synonyms for 10 and -70 respectively (for 5-line staves; other staves are not yet implemented) This behavior may change in music21 v8 or after. >>> te = style.Style() >>> te.absoluteY = 10 >>> te.absoluteY 10 >>> te.absoluteY = 'below' >>> te.absoluteY -70 Setting an invalid position raises a TextFormatException >>> te.absoluteY = 'hello' Traceback (most recent call last): music21.style.TextFormatException: Not a supported absoluteY position: 'hello' doc) rCrDrBrFrGrEr9r@rAr?rHr:NreturnNone)rgzEnclosure | None)rUzEnclosure | str | None)rrrr__doc__r<__annotations__rKpropertyrNsetterrZrb absoluteYrr rrr7r73su   !I~ 0666pOO  &  Irr7cH^\rSrSr%SrSSSS.rS\S'S U4S jjrS rU=r $) NoteStylez A Style object that also includes stem and accidental style information. Beam style is stored on the Beams object. Lyric style is stored on the Lyric object. a An optional style.Style object describing what the stem looks like. >>> n = note.Note() >>> n.style.stemStyle is None True Note that stemStyle is not created automatically. Users must instantiate a :class:`~music21.style.Style` object. >>> n.style.stemStyle = style.Style() >>> n.style.stemStyle.color = 'red' a An optional style.Style object describing what the accidental looks like. >>> n = note.Note() >>> n.style.accidentalStyle is None True Note that accidentalStyle is not created automatically. Users must instantiate a :class:`~music21.style.Style` object. >>> n.style.accidentalStyle = style.Style() >>> n.style.accidentalStyle.relativeX = -2.0 Note: do not use .hideObjectOnPrint in accidentalStyle to hide the accidental. Set the displayType on the Accidental itself. This object may eventually move to Note.pitch.accidental.style. a  An optional string representing the size of the note as a type of note. Valid values are None (=normal), `'cue'`, `'grace'`, `'graceCue'`, and `'large'` (taken from MusicXML, with "graceCue" replacing "grace-cue"). ) stemStyleaccidentalStylenoteSizer;r<cL>[TU]5 SUlSUlSUlgrY)superrKrqrrrsrJ __class__s rrKNoteStyle.__init__s$ %)+/"& r)rrrsrqrf) rrrrrir<rjrKr __classcell__rws@rroros1 $A&!I~&P''rrocd^\rSrSrSrU4SjrSrSr\"\\SS9r Sr S r \"\ \ S S9r \SS j5r \ RSS j5r \SS j5r\RSSj5rSrSr\"\\SS9rSrSr\"\\SS9rSrSr\"\\SS9r\S5r\RS5rSrU=r$) TextStyleiz A Style object that also includes text formatting. >>> ts = style.TextStyle() >>> ts.classes ('TextStyle', 'Style', 'ProtoM21Object', 'object') c>[TU]5 SUlSUlSUlSUlSUlSUlSUlSUl SUl SUl SUl SUl SUlgrY)rurK _fontFamily _fontSize _fontStyle _fontWeight_letterSpacing lineHeight textDirection textRotationlanguagetextDecoration_justify_alignHorizontal_alignVerticalrvs rrKTextStyle.__init__%sq "!  " $"rcUR$rY)rrIs r_getAlignVerticalTextStyle._getAlignVertical8"""rc:US;aXlg[SU<35e)N)NtopmiddlebottombaselinezInvalid vertical align: )rr rJrUs r_setAlignVerticalTextStyle._setAlignVertical;s$ A A"' %(@ &JK Kra Get or set the vertical align. Valid values are top, middle, bottom, baseline or None >>> te = style.TextStyle() >>> te.alignVertical = 'top' >>> te.alignVertical 'top' Invalid vertical aligns raise a TextFormatException: >>> te.alignVertical = 'hello' Traceback (most recent call last): music21.style.TextFormatException: Invalid vertical align: 'hello' rdcUR$rY)rrIs r_getAlignHorizontalTextStyle._getAlignHorizontalUs$$$rc:US;aXlg[SU<35e)N)NleftrightcenterzInvalid horizontal align: )rr rs r_setAlignHorizontalTextStyle._setAlignHorizontalXs$ 5 5$) !%(B5)&LM Mra Get or set the horizontal alignment. Valid values are left, right, center, or None >>> te = style.TextStyle() >>> te.alignHorizontal = 'right' >>> te.alignHorizontal 'right' Invalid horizontal aligns raise a TextFormatException: >>> te.alignHorizontal = 'hello' Traceback (most recent call last): music21.style.TextFormatException: Invalid horizontal align: 'hello' cUR$)az Get or set the justification. Valid values are left, center, right, full (not supported by MusicXML), and None >>> tst = style.TextStyle() >>> tst.justify = 'center' >>> tst.justify 'center' Invalid values raise a TextFormatException >>> tst.justify = 'hello' Traceback (most recent call last): music21.style.TextFormatException: Not a supported justification: 'hello' )rrIs rjustifyTextStyle.justifyrs$}}rcUcSUlgUR5S;a[SU<35eUR5Ulg)N)rrrfullzNot a supported justification: )rrSr rs rrrs= = DM{{}$GG),KE9*UVV!KKMDMrcUR$)a Get or set the style, as normal, italic, bold, and bolditalic. None is currently an acceptable value which should be "normal". >>> tst = style.TextStyle() >>> tst.fontStyle = 'bold' >>> tst.fontStyle 'bold' Invalid values raise a TextFormatException >>> tst.fontStyle = 'hello' Traceback (most recent call last): music21.style.TextFormatException: Not a supported fontStyle: 'hello' )rrIs r fontStyleTextStyle.fontStyles$rcUcSUlgUR5S;a[SU<35eUR5Ulg)N)italicnormalbold bolditaliczNot a supported fontStyle: )rrSr rs rrrs= ="DO{{}$NN),Gy*QRR#kkmDOrcUR$rY)rrIs r _getWeightTextStyle._getWeightsrcUcSUlgUR5S;a[SU35eUR5Ulg)N)rrzNot a supported fontWeight: )rrSr rs r _setWeightTextStyle._setWeights? =#D {{}$66),H*PQQ${{}D rz Get or set the weight, as normal, or bold. >>> tst = style.TextStyle() >>> tst.fontWeight = 'bold' >>> tst.fontWeight 'bold' cUR$rY)rrIs r_getSizeTextStyle._getSizes ~~rcdUb[R"U5nXlg![a Nf=frY)rr`rTrrs r_setSizeTextStyle._setSizes8   ..u5  s " //z Get or set the size. Best, an int or float, but also a css font size >>> tst = style.TextStyle() >>> tst.fontSize = 20 >>> tst.fontSize 20 cUR$rY)rrIs r_getLetterSpacingTextStyle._getLetterSpacingrrc~US:waUb [U5nXlg![an[SU<35UeSnAff=f)NrzNot a supported letterSpacing: )floatrTr rras r_setLetterSpacingTextStyle._setLetterSpacingsQ H !2 e  $  )5eY? s  <7<z Get or set the letter spacing. >>> tst = style.TextStyle() >>> tst.letterSpacing = 20 >>> tst.letterSpacing 20.0 >>> tst.letterSpacing = 'normal' cBURc/UlUR$)a Returns a list of font family names associated with the style, or sets the font family name list. If a single string is passed then it is converted to a list. >>> ts = style.TextStyle() >>> ff = ts.fontFamily >>> ff [] >>> ff.append('Times') >>> ts.fontFamily ['Times'] >>> ts.fontFamily.append('Garamond') >>> ts.fontFamily ['Times', 'Garamond'] >>> ts.fontFamily = 'Helvetica, sans-serif' >>> ts.fontFamily ['Helvetica', 'sans-serif'] )r~rIs r fontFamilyTextStyle.fontFamilys$.    #!D rc[R"U5(aXlgURS5Vs/sHo"R 5PM snUlgs snf)N,)r isIterabler~splitstrip)rJ newFamilyfs rrrsB   Y ' '( 3[TU]5 SUlgrY)rurK placementrvs rrKTextStylePlacement.__init__s r)rrrrrrirKrryrzs@rrrsrrc,^\rSrSrSrU4SjrSrU=r$) BezierStylei#z From the MusicXML Definition. cv>[TU]5 SUlSUlSUlSUlSUlSUlgrY)rurK bezierOffset bezierOffset2bezierXbezierYbezierX2bezierY2rvs rrKBezierStyle.__init__(s:  !    r)rrrrrrrrzs@rrr#s  rrc,^\rSrSrSrU4SjrSrU=r$) LineStylei4z from the MusicXML Definition Defines lineShape ('straight', 'curved' or None) lineType ('solid', 'dashed', 'dotted', 'wavy' or None) dashLength (in tenths) spaceLength (in tenths) cZ>[TU]5 SUlSUlSUlSUlgrY)rurK lineShapelineTyperGrHrvs rrKLineStyle.__init__>s+  r)rGrrrHrrzs@rrr4s  rrc,^\rSrSrSrU4SjrSrU=r$) StreamStyleiGzr Includes several elements in the MusicXML tag in along with and c>[TU]5 /Ul/Ul/Ul/UlSUlSUl/Ul/Ul SUl SUl SUl SUl g)NT)rurK lineWidths noteSizes distancesotherAppearances musicFontwordFont lyricFontslyricLanguages printPartNameprintPartAbbreviationmeasureNumberingmeasureNumberStylervs rrKStreamStyle.__init__Msj  "  !%)"!%"&r) rrrrrrrrrrrrrrzs@rrrGs ''rrc,^\rSrSrSrU4SjrSrU=r$) BeamStyleiaz Style for beams c0>[TU]5 SUlgrY)rurKfanrvs rrKBeamStyle.__init__fs r)rrrzs@rrrasrrc\rSrSrSr\rSrS Sjr\ SSj5r \ SSj5r \ RSSj5r \ SSj5r \ SS j5r\RSS j5rS rg ) StyleMixinika Mixin for any class that wants to support style and editorial, since several non-music21 objects, such as Lyrics and Accidentals will support Style. Not used by Music21Objects because of the added trouble in copying etc. so there is code duplication with base.Music21Object _style _editorialc SUlSUlgrYrrIs rrKStyleMixin.__init__xs#' 48rcXUR URSL$![a Nf=f)a Returns True if there is a :class:`~music21.style.Style` object already associated with this object, False otherwise. Calling .style on an object will always create a new Style object, so even though a new Style object isn't too expensive to create, this property helps to prevent creating new Styles more than necessary. >>> lObj = note.Lyric('hello') >>> lObj.hasStyleInformation False >>> lObj.style >>> lObj.hasStyleInformation True N)rAttributeErrorrIs rhasStyleInformationStyleMixin.hasStyleInformation~s3&  KKKK4'(   s  ))cdURcURnU"5UlUR$)a= Returns (or Creates and then Returns) the Style object associated with this object, or sets a new style object. Different classes might use different Style objects because they might have different style needs (such as text formatting or bezier positioning) Eventually will also query the groups to see if they have any styles associated with them. >>> acc = pitch.Accidental() >>> st = acc.style >>> st >>> st.absoluteX = 20.0 >>> st.absoluteX 20.0 >>> acc.style = style.TextStyle() >>> acc.style.absoluteX is None True )r _styleClass)rJ styleClasss rstyleStyleMixin.styles,0 ;; ))J$,DK{{rcXlgrY)r)rJnewStyles rr r s rcURSL$)a Returns True if there is a :class:`~music21.editorial.Editorial` object already associated with this object, False otherwise. Calling .style on an object will always create a new Style object, so even though a new Style object isn't too expensive to create, this property helps to prevent creating new Styles more than necessary. >>> acc = pitch.Accidental('#') >>> acc.hasEditorialInformation False >>> acc.editorial >>> acc.hasEditorialInformation True NrrIs rhasEditorialInformation"StyleMixin.hasEditorialInformations&OOt+,rclSSKJn URcUR"5UlUR$)a a :class:`~music21.editorial.Editorial` object that stores editorial information (comments, footnotes, harmonic information, ficta). Created automatically as needed: >>> acc = pitch.Accidental() >>> acc.editorial >>> acc.editorial.ficta = pitch.Accidental('sharp') >>> acc.editorial.ficta >>> acc.editorial }> rr)music21rr Editorial)rJrs rrStyleMixin.editorials+$ & ?? "'113DOrcXlgrYr)rJeds rrrsr)rrNrf)rgbool)rgr7)r r7)rgeditorial.Editorial)rr)rrrrrir7r __slots__rKrkrr rlrrrr rrrrksK(I9 ))28 \\--(,rrc\rSrSrSrg)Testir Nr r rrrrrrr__main__)ri __future__rtypingtunittestrrrmusic21.prebaser TYPE_CHECKINGrMusic21Exceptionr StrEnumrr7ror|rrrrrSlottedObjectMixinrTestCaserrmainTestr rrr)s# *??! ,77 $p Np f3'3'lzIzIz%"  &'%'4|**|~ 8    z Tr