rh, S SK Jr S SKrS SKrS SKJr S SKJ r S SKJ
r
S SK J r S SKJ
r
\R ( a S SKJr S SKJs Jr S S KJr S
S .SS jjrS
rSS jrSS jrSS jrSS jrS S jr S S jr S S S jjr S S S jjr \ S:X a S SKr\RB " 5 gg)! ) annotationsN)tostring)common)meter)
xmlObjects)prebase)Callable)
Music21ObjectF)noCopyc h USL a [ R " U 5 nOU n[ U5 UR 5 HZ nUR n[ U5 S: d M [
UR 5 5 nUR 5 UR U5 M\ [ USS9nUR 5 nU$ )ux
wrapper around xml.etree.ElementTree that returns a string
in every case and indents tags and sorts attributes.
>>> from music21.musicxml.m21ToXml import Element
>>> from music21.musicxml.helpers import dumpString
>>> e = Element('accidental')
>>> dumpString(e)
''
>>> e.text = '∆'
>>> e.text == '∆'
True
>>> dumpString(e)
'∆'
F unicode)encoding) copydeepcopyindentiterattriblensorteditemsclearupdate et_tostringrstrip)objr xmlElelr attribsxStrs R/home/james-whalen/.local/lib/python3.13/site-packages/music21/musicxml/helpers.py
dumpStringr" s $
c"
5Mjjl v;? V\\^,G LLN MM' "
uy 1D ;;=D K c , [ [ U 5 5 g)ux
wrapper around xml.etree.ElementTree that prints a string
in every case and indents tags and sorts attributes. (Prints, does not return)
>>> from music21.musicxml.helpers import dump
>>> from xml.etree.ElementTree import Element
>>> e = Element('accidental')
>>> dump(e)
>>> e.text = '∆'
>>> e.text == '∆'
True
>>> dump(e)
∆
N)printr" )r s r! dumpr& B s $
*S/r# c X SUS- - n[ U 5 nU( a U R ( a U R R 5 ( d
US- U l U R ( a U R R 5 ( d X l SnU H n[ XAS- 5 M Ub X$l U R ( a U R R 5 ( d SUS- - U l ggU( a8 U R ( a U R R 5 ( d X l ggg)z,
helper method, indent an element in place:
z Nr
)r textstriptailr )elemlevelilenLsubElems r! r r W s
ut|A t9D yy 1 1DDIyy 1 1IG 7AI & Lyy 1 1 ut|+DI !2 $))499??+<+<I ,=5r# c U( d U R U5 g[ U 5 1n[ U R S5 5 H( u pEUR U; d M UR U5 M* U R
[ U5 U5 g)a
Insert element `insert` into element `root` at the earliest position
of any instance of a child tag given in `tagList`. Append the element
if `tagList` is `None`.
>>> from xml.etree.ElementTree import fromstring as El
>>> from music21.musicxml.helpers import insertBeforeElements, dump
>>> root = El('G4')
>>> insert = El('')
>>> insertBeforeElements(root, insert, tagList=['line'])
>>> dump(root)
G
4
Now insert another element at the end by not specifying a tag list:
>>> insert2 = El('')
>>> insertBeforeElements(root, insert2)
>>> dump(root)
G
4
N*)appendr enumeratefindalltagaddinsertmin)rootr8 tagList
insertIndicesr. childs r! insertBeforeElementsr> p sk @ FYKM dll3 /0 99 a 1 KKM"F+r# c S nX:X a gU" U 5 u p4U" U5 u pV[ U5 [ U5 :w a [ U5 [ U5 : $ [ XF/5 nXGS L $ )a
Determine whether `measureNumber1` strictly precedes
`measureNumber2` given that they could involve suffixes.
Equal values return False.
>>> from music21.musicxml.helpers import measureNumberComesBefore
>>> measureNumberComesBefore('23', '24')
True
>>> measureNumberComesBefore('23', '23')
False
>>> measureNumberComesBefore('23', '23a')
True
>>> measureNumberComesBefore('23a', '23b')
True
>>> measureNumberComesBefore('23b', '23a')
False
>>> measureNumberComesBefore('23b', '24a')
True
>>> measureNumberComesBefore('23b', '23b')
False
c p SnU H nUR 5 ( a X-
nM O U [ U5 S nX4$ )N ) isnumericr )
measureNumbernumbercharsuffixs r! splitSuffix-measureNumberComesBefore..splitSuffix sB !D~~ "
s6{|,~ r# Fr )intr )mNum1mNum2rG m1Numericm1Suffix m2Numericm2SuffixsortedSuffixess r! measureNumberComesBeforerQ si ,
~%e,I%e,I
9~Y '9~I.. 45!,,,r# c SnU R S; a SnU$ U R S:X aV U R [ R 5 nU( a0 UR R
U R R
:X a SnU$ )NF)TalwaysTauto) fullMeasuregetContextByClassr
TimeSignature barDuration
quarterLengthduration)r
isFullMeasure tsContexts r! isFullMeasureRestr^ sp M}}((
& ''(;(;< ..<<
@X@XX M r# c D U R SS5 nU( d gX!l g)aF
MusicXML 3.1 defines the id attribute
(%optional-unique-id)
on many elements which is perfect for setting as .id on
a music21 element.
bye
>>> from xml.etree.ElementTree import fromstring as El
>>> e = El('')
>>> f = expressions.Fermata()
>>> musicxml.helpers.synchronizeIdsToM21(e, f)
>>> f.id
'fermata1'
Does not change the id if the id is not specified:
>>> e = El('')
>>> f = expressions.Fermata()
>>> f.id = 'doNotOverwrite'
>>> musicxml.helpers.synchronizeIdsToM21(e, f)
>>> f.id
'doNotOverwrite'
idN)getr` )element m21ObjectnewIds r! synchronizeIdsToM21re s 2
KKd #E Lr# c [ U[ R 5 ( d g[ US5 ( d gUR nUc g[
R " U5 ( d gU R SU5 g)aH
MusicXML 3.1 defines the id attribute (entity: %optional-unique-id)
on many elements which is perfect for getting from .id on
a music21 element.
>>> from xml.etree.ElementTree import fromstring as El
>>> e = El('')
>>> f = expressions.Fermata()
>>> f.id = 'fermata1'
>>> musicxml.helpers.synchronizeIdsToXML(e, f)
>>> e.get('id')
'fermata1'
Does not set attr: id if el.id is not valid or default:
>>> e = El('')
>>> f = expressions.Fermata()
>>> musicxml.helpers.synchronizeIdsToXML(e, f)
>>> e.get('id', None) is None
True
>>> f.id = '123456' # invalid for MusicXML id
>>> musicxml.helpers.synchronizeIdsToXML(e, f)
>>> e.get('id', None) is None
True
None can be passed in instead of a m21object.
>>> e = El('')
>>> musicxml.helpers.synchronizeIdsToXML(e, None)
>>> e.get('id', 'no idea')
'no idea'
Nr` )
isinstancer ProtoM21Objecthasattrr` r isValidXSDIDset)rb rc m21Ids r! synchronizeIdsToXMLrm s^ N i!7!7 8 8 9d # # LLE } " "5 ) ) KKe r# c UR U5 nUc gUb U" U5 nUc [ R " U5 n[ XU5 g)aX
If xmlEl has at least one element of tag==tag with some text. If
it does, set the attribute either with the same name (with "foo-bar" changed to
"fooBar") or with attributeName to the text contents.
Pass a function or lambda function as transform to transform the value before setting it
>>> from xml.etree.ElementTree import fromstring as El
>>> e = El('')
>>> setb = musicxml.helpers.setM21AttributeFromAttribute
>>> pl = layout.PageLayout()
>>> setb(pl, e, 'page-number')
>>> pl.pageNumber
'4'
>>> setb(pl, e, 'new-page', 'isNew')
>>> pl.isNew
'yes'
Transform the pageNumber value to an int.
>>> setb(pl, e, 'page-number', transform=int)
>>> pl.pageNumber
4
More complex:
>>> convBool = musicxml.xmlObjects.yesNoToBoolean
>>> setb(pl, e, 'new-page', 'isNew', transform=convBool)
>>> pl.isNew
True
N)ra r hyphenToCamelCasesetattrm21Elr xmlAttributeName
attributeName transformvalues r! setM21AttributeFromAttributerw & sM R
II& 'E } % 001AB
E%(r# c Uc [ R " U5 n[ XS5 nUc gUb U" U5 nUR U[ U5 5 g)a
If m21El has at least one element of tag==tag with some text. If
it does, set the attribute either with the same name (with "foo-bar" changed to
"fooBar") or with attributeName to the text contents.
Pass a function or lambda function as transform to transform the value before setting it
>>> from xml.etree.ElementTree import fromstring as El
>>> e = El('')
>>> setb = musicxml.helpers.setXMLAttributeFromAttribute
>>> pl = layout.PageLayout()
>>> pl.pageNumber = 4
>>> pl.isNew = True
>>> setb(pl, e, 'page-number')
>>> e.get('page-number')
'4'
>>> XB = musicxml.m21ToXml.XMLExporterBase()
>>> XB.dump(e)
>>> setb(pl, e, 'new-page', 'isNew')
>>> e.get('new-page')
'True'
Transform the isNew value to 'yes'.
>>> convBool = musicxml.xmlObjects.booleanToYesNo
>>> setb(pl, e, 'new-page', 'isNew', transform=convBool)
>>> e.get('new-page')
'yes'
N)r ro getattrrk strrq s r! setXMLAttributeFromAttributer{ [ sS T 001AB
E$ /E } % II E
+r# __main__)returnrz )r )N)rJ rz rK rz r} bool)r[ z'music21.note.Rest'r} r~ )rb
ET.Elementrc r
)rb r rc z prebase.ProtoM21Object | Noner} None)NN) rr t.Anyr r rs rz rt
str | Noneru z Callable[[str], t.Any] | Noner} r )
rr r r r rs rz rt r ru z Callable[[t.Any], t.Any] | None)"
__future__r r typingtxml.etree.ElementTreer r music21r r music21.musicxmlr r
TYPE_CHECKINGcollections.abcr etree ElementTreeET music21.baser
r" r& r r> rQ r^ re rm rw r{ __name__mainTest r# r! r s # 9 ' ??(&&* $ !H*2(,V(-V <3
3 *3
3 v #-1 2) 2) 2) 2) 2)
+ 2)
2)r #/3 4, 4, 4, 4, 4,
- 4,p z r#