3j+ h d dl mZ d dlZd dlZd dlmZ d dlm Z d dlm
Z
d dl m Z d dlm
Z
ej rd dlmZ d dlmc mZ d d lmZ d
d dd Zd
ZddZddZddZddZd dZ d dZ d d dZ d d dZ e dk( rd dlZ ejB yy)! ) annotationsN)tostring)common)meter)
xmlObjects)prebase)Callable)
Music21ObjectF)noCopyc b |du rt j | }n| }t | |j D ]W }|j }t | dkD s t
|j }|j |j | Y t |d }|j }|S )u
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 E/DATA/.local/lib/python3.12/site-packages/music21/musicxml/helpers.py
dumpStringr" s $
c"
5Mjjl v;? V\\^,G LLN MM' "
uy 1D ;;=D K c , t t | y)u
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& A s $
*S/r# c d|dz z }t | }|r| j r| j j s
|dz | _ | j r| j j s|| _ d}| D ] }t ||dz |||_ | j r| j j sd|dz z | _ yy|r/| j r| j j s|| _ yyy)z4
helper method, indent an element in place:
z Nr
)r textstriptailr )elemlevelilenLsubElems r! r r V s
ut|A t9D yy 1DDIyy 1DIG 7EAI & GLyy 1 ut|+DI !2 $))499??+<DI ,=5r# c |s| j | yt | h}t | j d D ]% \ }}|j |v s|j | ' | j
t | | y)aH
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> o sm @ FYKM dll3 /05 99 a 1 KKM"F+r# c d }| |k( ry || \ }} || \ }}t | t | k7 rt | t | k S t ||g }||d u S )ag
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 f d}| D ] }|j r||z
} n | t | d }||fS )N ) isnumericr )
measureNumbernumbercharsuffixs r! splitSuffixz-measureNumberComesBefore..splitSuffix sC !D~~ $ "
s6{|,v~ r# Fr )intr )mNum1mNum2rG m1Numericm1Suffix m2Numericm2SuffixsortedSuffixess r! measureNumberComesBeforerP ss ,
~%e,Ix%e,Ix
9~Y '9~I.. 8 45>!,,,r# c d}| j dv rd}|S | j dk( rP| j t j }|r/|j j
| j j
k( rd}|S )NF)TalwaysTauto) fullMeasuregetContextByClassr
TimeSignature barDuration
quarterLengthduration)r
isFullMeasure tsContexts r! isFullMeasureRestr] sp M}}((
& ''(;(;< ..<<
@X@XX M r# c < | j dd }|sy||_ y)a
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! synchronizeIdsToM21rd s! 2
KKd #E ILr# c t |t j syt |d sy|j }|yt j | sy| j d| y)a
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)ra rb m21Ids r! synchronizeIdsToXMLrl sU N i!7!7 8 9d # LLE } " "5 ) KKe r# c |j | }|y| || }|t j | }t | || y)a
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)r` r hyphenToCamelCasesetattrm21Elr xmlAttributeName
attributeName transformvalues r! setM21AttributeFromAttributerv % sO P
II& 'E } % 001AB
E=%(r# c |t j | }t | |d }|y| || }|j |t | y)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 rn getattrrj strrp s r! setXMLAttributeFromAttributerz Y sU R 001AB
E=$ /E } % II E
+r# __main__)returnry )r )N)rI ry rJ ry r| bool)rZ z'music21.note.Rest'r| r} )ra
ET.Elementrb r
)ra r~ rb z prebase.ProtoM21Object | Noner| None)NN) rq t.Anyr r~ rr ry rs
str | Nonert z Callable[[str], t.Any] | Noner| r )
rq r r r~ rr ry rs r rt 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> rP r] rd rl rv rz __name__mainTest r# r! r s # 9 ' ??(&&* $ !H*2(,V(-V <3
3 *3
3 v #-1 1) 1) 1) 1) 1)
+ 1)
1)p #/3 3, 3, 3, 3, 3,
- 3,n zG r#