3jtDdZddlmZddlZddlmZddlZddlZddl m Z ddl m Z ddl mZddlmZmZmZdd lmZdd lmZdd lmZmZdd lmZmZej8rdd lmZGdde ZGddej@Z!e"dk(rddlZejFe!yy)a the Stream Core Mixin handles the core attributes of streams that should be thought of almost as private values and not used except by advanced programmers who need the highest speed in programming. Nothing here promises to be stable. The music21 team can make any changes here for efficiency reasons while being considered backwards compatible so long as the public methods that call these methods remain stable. All functions here will eventually begin with `.core`. ) annotationsN)Fraction) Music21Object) OffsetSpecial)opFrac)OffsetQLOffsetQLSpecial M21ObjType)spanner)tree)StreamExceptionImmutableStreamException)StreamIteratorRecursiveIterator)StreamceZdZdZdfd Zddd ddZdd ddZddd  dd Zddd dd  d d Zddd d!dZ dZ dddZ d"dZ e dZdd ddZdZdd ddddZdddd d d#dZxZS)$ StreamCorez Core aspects of a Stream's behavior. Any of these can change at any time. Users are encouraged only to create stream.Stream objects. c jt|di|i|_g|_g|_d|_d|_y)NT)super__init__ _offsetDict _elements _endElementsisSortedisFlat)selfkeywords __class__s @/DATA/.local/lib/python3.12/site-packages/music21/stream/core.pyrzStreamCore.__init__1s@ $8$ NP/124  FT) ignoreSort setActiveSitecd}|sz|jdurl|j}||krd}nX||k(rS|jsd}nD|jdj}|jj |}||krd}|j ||d||j j||jj||S)a N.B. -- a "core" method, not to be used by general users. Run .insert() instead. A faster way of inserting elements that performs no checks, just insertion. Only be used in contexts that we know we have a proper, single Music21Object. Best for usage when taking objects in a known Stream and creating a new Stream When using this method, the caller is responsible for calling Stream.coreElementsChanged after all operations are completed. Do not mix coreInsert with coreAppend operations. Returns boolean if the Stream (assuming it was sorted before) is still guaranteed to be sorted. (False doesn't mean that it's not sorted, just that we can't guarantee it.) If you don't care and plan to sort the stream later, then use `ignoreSort=True`. No need to opFrac before getting here -- the inner routine will do it for us. FT)offset addElementr#) r highestTimer sortTuplemodifycoreSetElementOffsetsitesaddappend) rr&elementr"r# storeSortedhthighestSortTuple thisSortTuples r coreInsertzStreamCore.coreInsertGs@  }}$%%;"&K6\>>&* +/>>"+=+G+G+I((/(9(9(;(B(B&(B(Q +m;*.K !!  ' "  $ g&r!)r#c8|j}|j||d|jj||r|j ||j j ||jt||jjzy)ar N.B. -- a "core" method, not to be used by general users. Run .append() instead. Low level appending; like `coreInsert` does not error check, determine elements changed, or similar operations. When using this method, the caller is responsible for calling Stream.coreElementsChanged after all operations are completed. Tr(N) r)r,r-r.coreSelfActiveSiterr/_setHighestTimerduration quarterLength)rr0r#r2s r coreAppendzStreamCore.coreAppends"   !!'2$!? $   # #G , g& VB)9)9)G)G$GHIr!r'c  t|}t |}|s ||j vrtd|d|d||f|j |<|r|j |yy#t$r$}|tvrtd|d||Yd}~{d}~wwxYw)a Sets the Offset for an element, very quickly. Caller is responsible for calling :meth:`~music21.stream.core.coreElementsChanged` afterward. >>> s = stream.Stream() >>> s.id = 'Stream1' >>> n = note.Note('B-4') >>> s.insert(10, n) >>> n.offset 10.0 >>> s.coreSetElementOffset(n, 20.0) >>> n.offset 20.0 >>> n.getOffsetBySite(s) 20.0 zCannot set offset to z for Nz"Cannot set the offset for element z, not in Stream .)r TypeErrorrr idrr8)rr0r&r(r#teidEls r r,zStreamCore.coreSetElementOffsets6 `F^F '{d$*:*::!4WI=MdVSTUW W"('!2   # #G ,  `]*%(=fZuWI&VW]__+ `s A B )BB N) updateIsFlat clearIsSortedmemo keepIndexct|dds td|g}t||vry|jt||jT|jj }|dvr:t jd|jj}|j|jD]}|j||rd|_ |r-d|_ |jD]}|jsd|_ n|j rGd} |rd |j vr|j d } |j|r| | |j d <yyyy) a NB -- a "core" stream method that is not necessary for most users. This method is called automatically any time the elements in the Stream are changed. However, it may be called manually in case sites or other advanced features of an element have been modified. It was previously a private method and for most users should still be treated as such. The various arguments permit optimizing the clearing of cached data in situations when completely dropping all cached data is excessive. >>> a = stream.Stream() >>> a.isFlat True Here we manipulate the private `._elements` storage (which generally shouldn't be done) using coreAppend and thus need to call `.coreElementsChanged` directly. >>> a.coreAppend(stream.Stream()) >>> a.isFlat # this is wrong. True >>> a.coreElementsChanged() >>> a.isFlat False _mutableTzBcoreElementsChanged should not be triggered on an immutable streamN)flatsemiflatzmusic21.stream.Stream)rEFindex)getattrrr@r/ _derivationmethodtcastorigin clearCacher-coreElementsChangedrrrisStream_cache) rrCrDrErFsdmrQ livingSitee indexCaches r rSzStreamCore.coreElementsChangedsQFtZ.*T  <D d8t   BtH    '""))C**23&&9P9=9I9I9P9P3R!!# **J  * * * 5% !DM DK^^::"'DK $ ;;JW 3![[1  OO Z3'1 G$4y r!)recursedeepcddlm}|rtj|}ntj|}||j_|r+|r)t ||jr|j|d|S)a *This is a Core method that most users will not need to use.* Make a copy of this stream with the proper derivation set. >>> s = stream.Stream() >>> n = note.Note() >>> s.append(n) >>> s2 = s.coreCopyAsDerivation('exampleCopy') >>> s2.derivation.method 'exampleCopy' >>> s2.derivation.origin is s True >>> s2[0].derivation.method 'exampleCopy' r)streamT)rZ) music21r]copydeepcopy derivationrN isinstancersetDerivationMethod)r methodNamerZr[r]posts r coreCopyAsDerivationzStreamCore.coreCopyAsDerivation3s[( # ==&D99T?D!+ t 4 ?  $ $Z $ > r!c|jD]}t||k(s|cS|jD]}t||k(s|cSy)aW NB -- a "core" stream method that is not necessary for most users. Low-level tool to get an element based only on the object id. This is not the same as getElementById, which refers to the id attribute which may be manually set and not unique. However, some implementations of python will reuse object locations, sometimes quickly, so don't keep these around. Used by spanner and variant. >>> s = stream.Stream() >>> n1 = note.Note('g') >>> n2 = note.Note('g#') >>> s.append(n1) >>> s.coreGetElementByMemoryLocation(id(n1)) is n1 True >>> s.coreGetElementByMemoryLocation(id(n2)) is None True >>> b = bar.Barline() >>> s.storeAtEnd(b) >>> s.coreGetElementByMemoryLocation(id(b)) is b True N)rr@r)robjIdrXs r coreGetElementByMemoryLocationz)StreamCore.coreGetElementByMemoryLocationSsI:A!u~ ""A!u~#r!)checkRedundancyc||ur tdt|ts0t|tr tdtd|ddzdz|rxt |}||j vr_|j |jfD]7}|D]0}||ustd|dt |d |dt |d 9|j |=|jy ) a/ Before adding an element, this method performs important checks on that element. Used by: - :meth:`~music21.stream.Stream.insert` - :meth:`~music21.stream.Stream.append` - :meth:`~music21.stream.Stream.storeAtEnd` - `Stream.__init__()` Returns None or raises a StreamException >>> s = stream.Stream() >>> s.coreGuardBeforeAddElement(s) Traceback (most recent call last): music21.exceptions21.StreamException: this Stream cannot be contained within itself >>> s.append(s.iter()) Traceback (most recent call last): music21.exceptions21.StreamException: cannot insert StreamIterator into a Stream Iterate over it instead (User's Guide chs. 6 and 26) >>> s.insert(4, 3.14159) Traceback (most recent call last): music21.exceptions21.StreamException: The object you tried to add to the Stream, 3.14159, is not a Music21Object. Use an ElementWrapper object if this is what you intend. z-this Stream cannot be contained within itselfz_cannot insert StreamIterator into a Stream Iterate over it instead (User's Guide chs. 6 and 26)z+The object you tried to add to the Stream, z, z6is not a Music21Object. Use an ElementWrapper object zif this is what you intend.z the object (z, id()=z" is already found in this Stream ()N) r rbrrr@rrrpurgeLocations)rr0rj idElement search_place eInStreams r coreGuardBeforeAddElementz$StreamCore.coreGuardBeforeAddElementys> d?!"QR R'=1'>2%KLL"=g[KJK/01 1 7 ID,,,&*^^T5F5F$GL%1 $/"1".wkG NDDH87SUVZS[R\\]!_#&2%H$$Y/  r!c|j|tjd|jj ||r|j ||j j|y)z NB -- this is a "core" method. General users should use .storeAtEnd() instead. Core method for adding end elements. To be called by other methods. Tr7N)r,rAT_ENDr-r.r8rr/)rr0r#s r coreStoreAtEndzStreamCore.coreStoreAtEndsV !!'=+?+?D!Q $   # #G ,   )r!cd|jvs|jdM|jtjfd}tjt ||jd<|jdS)zZ A low-level object for Spanner management. This is a read-only property. spannerBundleF) classFilterrestoreActiveSites)rUrZr Spanner SpannerBundlelist)rspannerss r rvzStreamCore.spannerBundlesd $++ -_1M1U||0BW\|]H+2+@+@h+PDKK ({{?++r!flatten classListc tt|xsd|f}dt|z}||jvs|j|1tj j |||}||j|<|j|S)a Convert stream to a :class:`~music21.tree.trees.TimespanTree` instance, a highly optimized data structure for searching through elements and offsets. >>> score = tree.examples.makeExampleScore() >>> scoreTree = score.asTimespans() >>> print(scoreTree) > > > > > > > > > > > > > > > > > > > > > r timespanTreer})hashtuplestrrUr fromStream asTimespans)rr~rhashedAttributescacheKeyhashedTimespanTrees r rzStreamCore.asTimespanss> yB!7 AB!C(8$99 4;; &$++h*?*G!%!>> score = tree.examples.makeExampleScore() >>> scoreTree = score.asTree(flatten=True) >>> scoreTree to 8.0) > r elementTreer) rO TYPE_CHECKINGrbrrrrrUr rasTree)rr~rrrrrhashedElementTrees r rzStreamCore.asTrees ??dF+ ++yB!7!(!-!-!/0!3'7#88 4;; &$++h*?*G $ 6 6t?FAJDPDP !7!R  %6DKK !{{8$$r!)rZrequireAllPresentinsertconstrainingSpannerBundlec|j}|r|j}n|j}g}t|D]]}|j D]H} | |vr| |vr || |vr|r"d} | j D] } | |vsd} n| s8|j | J_|s|S|r+|D]} |jd| |jdy)a find all spanners that are referenced by elements in the (recursed if recurse=True) stream and either inserts them in the Stream (if insert is True) or returns them if insert is False. If requireAllPresent is True (default) then only those spanners whose complete spanned elements are in the Stream are returned. Because spanners are stored weakly in .sites this is only guaranteed to find the spanners in cases where the spanner is in another stream that is still active. Here's a little helper function since we'll make the same Stream several times, with two slurred notes, but without the slur itself. Python's garbage collection will get rid of the slur if we do not prevent it >>> preventGarbageCollection = [] >>> def getStream(): ... s = stream.Stream() ... n = note.Note('C') ... m = note.Note('D') ... sl = spanner.Slur(n, m) ... preventGarbageCollection.append(sl) ... s.append([n, m]) ... return s Okay now we have a Stream with two slurred notes, but without the slur. `coreGatherMissingSpanners()` will put it in at the beginning. >>> s = getStream() >>> s.show('text') {0.0} {1.0} >>> s.coreGatherMissingSpanners() >>> s.show('text') {0.0} {0.0} > {1.0} Now, the same Stream, but insert is False, so it will return a list of Spanners that should be inserted, rather than inserting them. >>> s = getStream() >>> spList = s.coreGatherMissingSpanners(insert=False) >>> spList [>] >>> s.show('text') {0.0} {1.0} Now we'll remove the second note so not all elements of the Slur are present. This, by default, will not insert the Slur: >>> s = getStream() >>> s.remove(s[-1]) >>> s.show('text') {0.0} >>> s.coreGatherMissingSpanners() >>> s.show('text') {0.0} But with `requireAllPresent=False`, the spanner appears! >>> s.coreGatherMissingSpanners(requireAllPresent=False) >>> s.show('text') {0.0} {0.0} > With `recurse=False`, then spanners are not gathered inside the inner stream: >>> part = stream.Part() >>> s = getStream() >>> part.insert(0, s) >>> part.coreGatherMissingSpanners(recurse=False) >>> part.show('text') {0.0} {0.0} {1.0} But the default acts with recursion: >>> part.coreGatherMissingSpanners() >>> part.show('text') {0.0} {0.0} {1.0} {0.0} > Spanners already in the stream are not put there again: >>> s = getStream() >>> sl = s.notes.first().getSpannerSites()[0] >>> sl > >>> s.insert(0, sl) >>> s.coreGatherMissingSpanners() >>> s.show('text') {0.0} {0.0} > {1.0} Also does not happen with recursion. >>> part = stream.Part() >>> s = getStream() >>> sl = s.notes.first().getSpannerSites()[0] >>> s.insert(0, sl) >>> part.insert(0, s) >>> part.coreGatherMissingSpanners() >>> part.show('text') {0.0} {0.0} {0.0} > {1.0} If `constrainingSpannerBundle` is set then only spanners also present in that spannerBundle are added. This can be useful, for instance, in restoring spanners from an excerpt that might already have spanners removed. In Jacob Tyler Walls's brilliant phrasing, it prevents regrowing zombie spanners that you thought you had killed. Here we will constrain only to spanners also present in another Stream: >>> s = getStream() >>> s2 = stream.Stream() >>> s.coreGatherMissingSpanners(constrainingSpannerBundle=s2.spannerBundle) >>> s.show('text') {0.0} {1.0} Now with the same constraint, but we will put the Slur into the other stream. >>> sl = s.notes.first().getSpannerSites()[0] >>> s2.insert(0, sl) >>> s.coreGatherMissingSpanners(constrainingSpannerBundle=s2.spannerBundle) >>> s.show('text') {0.0} {0.0} > {1.0} NTFr)rC) rvrZiterr{getSpannerSitesgetSpannedElementsr/r5rS) rrZrrrsbsIter collectListrspallFoundspannedElements r coreGatherMissingSpannersz$StreamCore.coreGatherMissingSpanners sh   LLNEIIKE u+B((*8$,8RG`=`$%)H*,*?*?*A)6',H!+B$ ""2&+$  !2&"  $ $% $ 8r!)returnNone)r&rr0rrbool)r0rrr)r0rr&z&int | float | Fraction | OffsetSpecialrr) rCrrDrrEzlist[int] | NonerFrrr)rr rdrrr )T) rZrrrrrrzspanner.SpannerBundle | Nonerzlist[spanner.Spanner] | None)__name__ __module__ __qualname____doc__rr5r<r,rSrfrirqrtpropertyrvrr8rr __classcell__)rs@r rr,s6 ??? ?J JJ  JL (-(-1(- (-Z""# ]2]2 ]2  ]2  ]2 ]2D&*"&),,6@#LEI?!B* ,,&*T&%P!&EX]%<"&@D uu u  u $> u $ur!rc eZdZy)TestN)rrrrr!r rrsr!r__main__)$r __future__rr_ fractionsrtypingrOunittest music21.basermusic21.common.enumsrmusic21.common.numberToolsrmusic21.common.typesrr r r^r r music21.exceptions21r rmusic21.stream.iteratorrrrmusic21.streamrrTestCaserrmainTestrr!r rs # &.-FFJE??%i i h 8    zGTr!