3j(0dZddlmZddlZddlmZddlZddlZddl Z ddl m Z ddl m Z ddl mZejrddl mZej"d Zd ZGd d e ZGd de j*ZegZedk(rddl Z e j2eyy)zn This module defines objects for tracking the derivation of one :class:`~music21.stream.Stream` from another. ) annotationsN) Generator)common)SlottedObjectMixin) environment)base derivationcBtjfd}|S)a This decorator can be used for creating a function that returns a new derivation. But is currently unused, since it does not take into account `inPlace=True`. `Stream.cloneEmpty(derivationMethod='derivationMethod')` is preferred for Streams. >>> from copy import deepcopy >>> @derivation.derivationMethod ... def allGreen(n): ... n2 = deepcopy(n) ... n2.style.color = 'green' ... return n2 >>> n = note.Note('C#') >>> n2 = allGreen(n) >>> n2.style.color 'green' >>> n2.name = 'D-' >>> n2.derivation from via 'allGreen'> cx|g|i|}||j_j|j_|SN)r origin__name__method)self argumentskeywordsresultfunctions ?/DATA/.local/lib/python3.12/site-packages/music21/derivation.pywrapperz!derivationMethod..wrapper;s>$77h7#' #+#4#4  ) functoolswraps)rrs` rderivationMethodr$s'.__X Nrc eZdZdZdZdddZddZdZdZdZ e dd Z e jdd Z dd Z e dd Zejdd Ze ddZejddZe ddZe ddZy) Derivationa A Derivation object keeps track of which Streams (or perhaps other Music21Objects) a Stream or other music21 object has come from and how. Derivation is automatically updated by many methods: >>> import copy >>> sOrig = stream.Stream(id='orig') >>> sNew = copy.deepcopy(sOrig) >>> sNew.id = 'copy' >>> sNew.derivation from via '__deepcopy__'> >>> sNew.derivation.client >>> sNew.derivation.client is sNew True >>> sNew.derivation.origin >>> sNew.derivation.method '__deepcopy__' >>> s1 = stream.Stream() >>> s1.id = 'DerivedStream' >>> d1 = derivation.Derivation(s1) >>> s2 = stream.Stream() >>> s2.id = 'OriginalStream' >>> d1.method = 'manual' >>> d1.origin = s2 >>> d1 from via 'manual'> >>> d1.origin is s2 True >>> d1.client is s1 True >>> import copy >>> d2 = copy.deepcopy(d1) >>> d2.origin is s2 True >>> d1.method = 'measure' >>> d1.method 'measure' Deleting the origin stream does not change the Derivation, since origin is held by strong ref: >>> import gc # Garbage collection >>> del s2 >>> unused = gc.collect() # ensure Garbage collection is run >>> d1 from via 'measure'> But deleting the client stream changes the Derivation, since client is held by weak ref, and will also delete the origin (so long as client was ever set) >>> del s1 >>> unused = gc.collect() # ensure Garbage collection is run >>> d1 )_client _clientId_method_origin _originIdNcXd|_d|_d|_d|_d|_||_yr )rrrr r!clientrr#s r__init__zDerivation.__init__s.37 #'!% 04 #' rcjt|}|j|_|j|_|S)z Manage deepcopying by creating a new reference to the same object. If the origin no longer exists, than origin is set to None )typer#r )rmemonews r __deepcopy__zDerivation.__deepcopy__s, d4jl[[ [[  rc|jj}|jrd|jnd}d|d|jd|j|dS)z2 representation of the Derivation z via ) __class__rrr#r )rklassvias r__repr__zDerivation.__repr__sR'')-dkk_%"5'dkk]& cU!DDrcttj|j|_tj|Sr )r unwrapWeakrefrr __getstate__rs rr5zDerivation.__getstate__s)++DLL9 !..t44rcxtj||tj|j|_yr )r __setstate__r wrapWeakrefr)rstates rr8zDerivation.__setstate__s(''e4))$,,7 rctj|j}|(|jd|_d|_d|_d|_|Sr )rr4rrr r!)rcs rr#zDerivation.clientsE   . 93!DNDLDL!DNrcz|d|_d|_yt||_tj||_yr )rridrr9r$s rr#zDerivation.clients4 >!DNDLZDN!--f5DLrc#dK|j}|||jj}|yyw)aR Iterator/Generator Yields the Streams which this Derivation's client Stream was derived from. This provides a way to obtain all Streams that the client passed through, such as those created by :meth:`~music21.stream.Stream.getElementsByClass` or :meth:`~music21.stream.Stream.flatten`. >>> s1 = stream.Stream() >>> s1.id = 's1' >>> s1.repeatAppend(note.Note(), 10) >>> s1.repeatAppend(note.Rest(), 10) >>> s2 = s1.notesAndRests.stream() >>> s2.id = 's2' >>> s3 = s2.getElementsByClass(note.Note).stream() >>> s3.id = 's3' >>> for y in s3.derivation.chain(): ... print(y) >>> list(s3.derivation.chain()) == [s2, s1] True N)r r )rorigs rchainzDerivation.chains34+/++J??))Ds+00c|jS)a Returns or sets the string of the method that was used to generate this Stream. >>> s = stream.Stream() >>> s.derivation.method is None True >>> sNotes = s.notes.stream() >>> sNotes.derivation.method 'notes' Some examples are 'getElementsByClass' etc. >>> s = stream.Stream() >>> s.id = 'lonelyStream' >>> s.append(clef.TrebleClef()) >>> s.append(note.Note()) >>> sNotes = s.notes.stream() >>> sNotes.derivation from via 'notes'> >>> derived = sNotes.derivation >>> derived.method 'notes' >>> derived.method = 'blah' >>> derived.method 'blah' >>> derived is sNotes.derivation True >>> sNotes.derivation.method 'blah' rr6s rrzDerivation.methodsL||rc||_yr rC)rrs rrzDerivation.methods  rc|jSr )r r6s rr zDerivation.origin!s ||rcT|d|_d|_yt||_||_yr )r!r r>)rr s rr zDerivation.origin%s) >!DNDLZDN!DLrc|jS)z Return the Python id (=memory location) of the origin. (Same as id(derivation.origin). Not the same as derivation.origin.ind) )r!r6s roriginIdzDerivation.originId0s ~~rcDt|j}|r|dSy)a Return a reference to the oldest source of this Stream; that is, chain calls to :attr:`~music21.stream.Stream.derivesFrom` until we get to a Stream that cannot be further derived. >>> s1 = stream.Stream() >>> s1.repeatAppend(note.Note(), 10) >>> s1.repeatAppend(note.Rest(), 10) >>> s2 = s1.notesAndRests.stream() >>> s3 = s2.getElementsByClass(note.Note).stream() >>> s3.derivation.rootDerivation is s1 True N)listrA)rderivationChains rrootDerivationzDerivation.rootDerivation8s%tzz|, "2& &rr )r#base.Music21Object | None)returnrN)rOz)Generator[base.Music21Object, None, None])rO str | None)rrP)r rN)rOz int | None)r __module__ __qualname____doc__ __slots__r%r*r2r5r8propertyr#setterrArr rHrMrrrrDsBLI E5 8 ]]66*>%%N ]] ]]""rrc eZdZy)TestN)rrQrRrWrrrYrYPsrrY__main__)rS __future__rweakrefcollections.abcrrtypingtunittestmusic21rmusic21.common.objectsrr TYPE_CHECKINGr Environment environLocalrrTestCaserY _DOC_ORDERrmainTestrWrrris#%5??'{&&|4 @G#GX 8   \  zGTr