3jYdZddlmZddlZddlZddlmZddlmZddl m Z ejrddlm Z Gdd ejZGd d ejZGd d e ZGddeZGddeZGddeZGddeZGddeZGddeZGddeZGddej2ZGddej6Zed k(rddlZej<eyy)!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 eZdZy)TextFormatExceptionN__name__ __module__ __qualname__:/DATA/.local/lib/python3.12/site-packages/music21/style.pyr r rr cHeZdZdZdZdZdZdZdZdZ dZ d Z d Z d Z d Zd ZdZdZy) Enclosure rectanglesquareovalcirclebrackettrianglediamondpentagonhexagonheptagonoctagonnonagondecagonzinverted-bracketnoneN)r r r RECTANGLESQUAREOVALCIRCLEBRACKETTRIANGLEDIAMONDPENTAGONHEXAGONHEPTAGONOCTAGONNONAGONDECAGONINVERTED_BRACKET NO_ENCLOSURErrrrr sNI F D FGHGHGHGGG)LrrceZdZUdZdddZded<ddZeddZejdd Zd Z d Z ee e d Z y)Stylea  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_ATTRcd|_d|_d|_d|_d|_d|_d|_d|_d|_d|_ d|_ d|_ y)NtenthsF) size relativeX relativeY absoluteX _absoluteY _enclosurefontRepresentationcolorr5r4 dashLength spaceLengthselfs r__init__zStyle.__init__Os_ )-)-)-+/+/#'# " ',*.+/rc|jS)a 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). )r?rDs r enclosurezStyle.enclosurejslrc|||_yt|tr||_yt|tr" t|j }||_yt d|#t $r}t d||d}~wwxYw)NzNot a supported enclosure: )r? isinstancerstrlower ValueErrorr )rEvalue enc_valueves rrHzStyle.enclosures =#DO y )#DO s # [%ekkm4 (DO&(CE9&MN N  [),Gy*QRXZZ [sA## B,A;;Bc|jSN)r>rDs r _getAbsoluteYzStyle._getAbsoluteYs rc|d|_y|dk(rd|_y|dk(rd|_y tj||_y#t$r}t d||d}~wwxYw)Nabove belowiz$Not a supported absoluteY position: )r>rnumToIntOrFloatrMr rErNrPs r _setAbsoluteYzStyle._setAbsoluteYsm ="DO g  DO g !DO "("8"8"? ):5)D sA A AAa\ 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' docNreturnNone)r^zEnclosure | None)rNzEnclosure | str | None) r r r__doc__r7__annotations__rFpropertyrHsetterrSrZ absoluteYrrrr3r32su   !I~ 0655nOO  &  Irr3c<eZdZUdZddddZded<d fd ZxZS) 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"). ) stemStyleaccidentalStylenoteSizer6r7cLt|d|_d|_d|_yrR)superrFrgrhrirE __class__s rrFzNoteStyle.__init__s$ %)+/"& rr])r r rr`r7rarF __classcell__rms@rrfrfs1 $A&!I~&P''rrfcpeZdZdZfdZdZdZeeedZdZ dZ ee e d Z edd Z e jdd Z edd Zejdd ZdZdZeeedZdZdZeeedZdZdZeeedZedZejdZxZS) TextStylez A Style object that also includes text formatting. >>> ts = style.TextStyle() >>> ts.classes ('TextStyle', 'Style', 'ProtoM21Object', 'object') ct|d|_d|_d|_d|_d|_d|_d|_d|_ d|_ d|_ d|_ d|_ d|_yrR)rkrF _fontFamily _fontSize _fontStyle _fontWeight_letterSpacing lineHeight textDirection textRotationlanguagetextDecoration_justify_alignHorizontal_alignVerticalrls rrFzTextStyle.__init__#sq "!  " $"rc|jSrR)rrDs r_getAlignVerticalzTextStyle._getAlignVertical6"""rc6|dvr||_ytd|)N)NtopmiddlebottombaselinezInvalid vertical align: )rr rErNs r_setAlignVerticalzTextStyle._setAlignVertical9s& A A"'D %(@ &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' r[c|jSrR)r~rDs r_getAlignHorizontalzTextStyle._getAlignHorizontalSs$$$rc6|dvr||_ytd|)N)NleftrightcenterzInvalid horizontal align: )r~r rs r_setAlignHorizontalzTextStyle._setAlignHorizontalVs& 5 5$)D !%(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' c|jS)a 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' )r}rDs rjustifyzTextStyle.justifyps$}}rc|d|_y|jdvrtd||j|_y)N)rrrfullzNot a supported justification: )r}rLr rs rrzTextStyle.justifys= = DM{{}$GG),KE9*UVV!KKMDMrc|jS)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' )rurDs r fontStylezTextStyle.fontStyles$rc|d|_y|jdvrtd||j|_y)N)italicnormalbold bolditaliczNot a supported fontStyle: )rurLr rs rrzTextStyle.fontStyles= ="DO{{}$NN),Gy*QRR#kkmDOrc|jSrR)rvrDs r _getWeightzTextStyle._getWeightsrc|d|_y|jdvrtd||j|_y)N)rrzNot a supported fontWeight: )rvrLr rs r _setWeightzTextStyle._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' c|jSrR)rtrDs r_getSizezTextStyle._getSizes ~~rc~| tj|}||_y||_y#t$r Y||_ywxYwrR)rrXrMrtrs r_setSizezTextStyle._setSizesG   ..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 c|jSrR)rwrDs r_getLetterSpacingzTextStyle._getLetterSpacingrrc|dk7r| t|}||_y||_y#t$r}td||d}~wwxYw)NrzNot a supported letterSpacing: )floatrMr rwrYs r_setLetterSpacingzTextStyle._setLetterSpacingsZ H !2 e  $e  )5eY? s $ A<Az Get or set the letter spacing. >>> tst = style.TextStyle() >>> tst.letterSpacing = 20 >>> tst.letterSpacing 20.0 >>> tst.letterSpacing = 'normal' c@|jg|_|jS)aH 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'] )rsrDs r fontFamilyzTextStyle.fontFamilys$.    #!D rctj|r||_y|jdDcgc]}|j c}|_ycc}w)N,)r isIterablerssplitstrip)rE newFamilyfs rrzTextStyle.fontFamilysC   Y '(D 3 tag in along with and ct|g|_g|_g|_g|_d|_d|_g|_g|_ d|_ d|_ d|_ d|_ y)NT)rkrF lineWidths noteSizes distancesotherAppearances musicFontwordFont lyricFontslyricLanguages printPartNameprintPartAbbreviationmeasureNumberingmeasureNumberStylerls rrFzStreamStyle.__init__Ksj  "  !%)"!%"&rrros@rrrEs ''rrc"eZdZdZfdZxZS) BeamStylez Style for beams c0t|d|_yrR)rkrFfanrls rrFzBeamStyle.__init__ds rrros@rrr_srrceZdZdZeZdZd dZed dZ ed dZ e jddZ ed dZ eddZ e jdd Z y ) StyleMixina( 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 d|_d|_yrRrrDs rrFzStyleMixin.__init__vs#' 48rc8t|dsy|jduS)aa 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 rFN)hasattrrrDs rhasStyleInformationzStyleMixin.hasStyleInformation|s &tX&{{$&&rcb|j|j}||_|jS)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)rE styleClasss rstylezStyleMixin.styles,0 ;; ))J$,DK{{rc||_yrR)r)rEnewStyles rrzStyleMixin.styles  rc|jduS)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 NrrDs rhasEditorialInformationz"StyleMixin.hasEditorialInformations&d**rcjddlm}|j|j|_|jS)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)rErs rrzStyleMixin.editorials-$ & ?? "1i113DOrc||_yrRr)rEeds rrzStyleMixin.editorials rNr])r^bool)r^r3)rr3)r^editorial.Editorial)rr)r r rr`r3r __slots__rFrbrrrcrrrrrrrisK(I9 '',8 \\++(,rrc eZdZy)TestNr rrrrrrrr__main__)r` __future__rtypingtunittestrrrmusic21.prebaser TYPE_CHECKINGrMusic21Exceptionr StrEnumrr3rfrqrrrrrSlottedObjectMixinrTestCaserr mainTestrrrrs# *??! ,77 $o No d3'3'lzIzIz%"  &'%'4y**yx 8    zGTr