rh3*SrSSKJr SSKJr SSKrSSKrSSKJ r "SS5r C"SS \R5r \ S :XaSSKr\R"\ 5 gg) z Classes for pseudo-m21 objects to inherit from. The most import attributes that nearly everything in music21 -- not just things that live in streams -- should inherit from are given below. Concept borrowed from m21j. ) annotations)SequenceN) deprecatedc\rSrSr%SrSS/r0rS\S'0rS\S'0r S \S 'S r S \S '\ "SSS5SSj5r \ SSj5r\ SSj5rSSjrSSjrS rg)ProtoM21Objecta A class for pseudo-m21 objects to inherit from. Any object can inherit from ProtoM21Object, and it makes sense for anything a user is likely to encounter to inherit from it. Certain translators, etc. can choose to skip it. >>> class PitchCounter(prebase.ProtoM21Object): ... def _reprInternal(self): ... return 'no pitches' >>> pc = PitchCounter() >>> pc.classes ('PitchCounter', 'ProtoM21Object', 'object') >>> PitchCounter in pc.classSet True >>> 'Note' in pc.classSet False For a True/False intersection check against an iterable, use `classSet.isdisjoint`: >>> classList = ('music21.note.Note', 'music21.note.Rest') >>> pc.classSet.isdisjoint(classList) True >>> repr(pc) '' ProtoM21Objects, like other Python primitives, cannot be put into streams -- this is what base.Music21Object does. A ProtoM21Object defines several methods relating to unified representation and keeping track of the classes of the object. It has no instance attributes or properties, and thus adds a very small creation time impact: recent tests show that an empty object with an empty `__init__()` method can be created in about 175ns while an empty object that subclasses ProtoM21Object with the same empty `__init__()` takes only 180ns, or a 5ns impact. On real objects, the creation time percentage hit is usually much smaller. ProtoM21Objects have no __init__() defined, so do not call super().__init__() on objects that only inherit from ProtoM21Object unless you like wasting 200ns. classesclassSetzdict[str, str] _DOC_ATTRzdict[type, tuple[str, ...]]_classTupleCacheDictz!dict[type, frozenset[str | type]]_classSetCacheDicttuple[str, ...] __slots__v7v10zUuse `someClass in .classSet`or for intersection: `not classSet.isdisjoint(classList)`cBURRU5(+$)a Given a class filter list (a list or tuple must be submitted), which may have strings or class objects, determine if this class is of the provided classes or a subclasses. NOTE: this is a performance critical operation for performance, only accept lists or tuples DEPRECATED in v7 -- prefer `someClass in el.classSet` or `not el.classSet.isdisjoint(classList)` instead. >>> n = note.Note() >>> #_DOCS_SHOW n.isClassOrSubclass(('Note',)) True >>> #_DOCS_SHOW n.isClassOrSubclass(('GeneralNote',)) True >>> #_DOCS_SHOW n.isClassOrSubclass((note.Note,)) True >>> #_DOCS_SHOW n.isClassOrSubclass((note.Rest,)) False >>> #_DOCS_SHOW n.isClassOrSubclass((note.Note, note.Rest)) True >>> #_DOCS_SHOW n.isClassOrSubclass(('Rest', 'Note')) True )r isdisjoint)selfclassFilterLists I/home/james-whalen/.local/lib/python3.13/site-packages/music21/prebase.pyisClassOrSubclass ProtoM21Object.isClassOrSubclassUs8==++O<<<cURUR$![aG [SURR 555nXRUR'Us$f=f)a Returns a tuple containing the names (strings, not objects) of classes that this object belongs to -- starting with the object's class name and going up the mro() for the object. Notes are Music21Objects: >>> n = note.Note('C#') >>> n.classes ('Note', 'NotRest', 'GeneralNote', 'Music21Object', 'ProtoM21Object', 'object') Durations are not, but they inherit from ProtoM21Object >>> d = duration.Duration('half') >>> d.classes ('Duration', 'ProtoM21Object', 'SlottedObjectMixin', 'object') Having quick access to these things as strings makes it easier to do comparisons: Example: find GClefs that are not Treble clefs (or treble 8vb, etc.): >>> s = stream.Stream() >>> s.insert(10, clef.GClef()) >>> s.insert(20, clef.TrebleClef()) >>> s.insert(30, clef.FrenchViolinClef()) >>> s.insert(40, clef.Treble8vbClef()) >>> s.insert(50, clef.BassClef()) >>> s2 = stream.Stream() >>> for thing in s: ... if isinstance(thing, clef.GClef) and not isinstance(thing, clef.TrebleClef): ... s2.insert(thing) >>> s2.show('text') {10.0} {30.0} `Changed 2015 Sep`: returns a tuple, not a list. c38# UHoRv M g7f)N)__name__).0xs r )ProtoM21Object.classes..sH3Gazz3Gs)r __class__KeyErrortuplemro)r classTuples rr ProtoM21Object.classesssaP ,,T^^< < H4>>3E3E3GHHJ8B % %dnn 5  sAA,+A,c@URUR$![a [UR5nUR URR 55 URR 5Vs/sHo"RS-UR-PM Os snfnnUR U5 UVs/sHo"RSS5PM Os snfnnUR U5 [U5nXPRUR'Us$f=f)aT Returns a set (that is, unordered, but indexed) of all classes that this class belongs to, including string names, fullyQualified string names, and objects themselves. It's cached on a per-class basis, so makes for a really fast way of checking to see if something belongs to a particular class when you don't know if the user has given a string, a fully qualified string name, or an object. Did I mention it's fast? It's a drop in substitute for the deprecated `.isClassOrSubclass`. It's not as fast as x in n.classes or isinstance(n, x) if you know whether it's a string or class, but this is good and safe. >>> n = note.Note() >>> 'Note' in n.classSet True >>> 'music21.note.Note' in n.classSet True >>> note.Note in n.classSet True >>> 'Rest' in n.classSet False >>> note.Rest in n.classSet False >>> object in n.classSet True >>> sorted([s for s in n.classSet if isinstance(s, str)]) ['GeneralNote', 'Music21Object', 'NotRest', 'Note', 'ProtoM21Object', 'base.Music21Object', 'builtins.object', 'music21.base.Music21Object', 'music21.note.GeneralNote', 'music21.note.NotRest', 'music21.note.Note', 'music21.prebase.ProtoM21Object', 'note.GeneralNote', 'note.NotRest', 'note.Note', 'object', 'prebase.ProtoM21Object'] >>> sorted([s for s in n.classSet if not isinstance(s, str)], key=lambda x: x.__name__) [, , , , , ] * Changed in v8: partially qualified objects such as 'note.Note' have been added. .zmusic21.) r r"r#listr extendr% __module__rreplace frozenset)r classListrfullyQualifiedStringspartiallyQualifiedStringsr s rr ProtoM21Object.classSetsz **4>>: : (,T\\(:I   T^^//1 2NRnnN`N`Nb$cNb\\C%7!**%DNb$c !$c   2 3La(bLaq:r)BLa(b %(b   6 7 +H6> # #DNN 3O s(A$D?%B%$DC>DDcTSnURS:waXRS-- nXRR- nSU;aSU;aURSS5nUR 5nU(aUR S5(dUS - nU(aXR 5- nUS -$) a Defines the default representation for a ProtoM21Object which includes the module name, the class name, and additional information, such as the memory location: >>> p = prebase.ProtoM21Object() >>> repr(p) '' The additional information is defined in the `_reprInternal` method, so objects inheriting from ProtoM21Object (such as Music21Object) should change `_reprInternal` and not `__repr__`. <__main__r)z.base.z music21.basez.baser*: >)r-r" __qualname__r. _reprInternal startswithstrip)rreprHeadstrReprs r__repr__ProtoM21Object.__repr__s ??j ( #- -HNN/// x N($B''4H$$& 7--c22 OH    'H#~rc0S[[U553$)a. Defines the insides of the representation. Overload this method for most objects. A default representation: >>> p = prebase.ProtoM21Object() >>> p._reprInternal() 'object at 0x112590380' A more complex `_reprInternal` that handles the case of objects with `.id` defined is found in Music21Object. z object at )hexid)rs rr;ProtoM21Object._reprInternalsC4M?++rN)rrreturnbool)rFr)rFzfrozenset[str | type])rFstr)rr-r:__firstlineno____doc__ _DOC_ORDERr __annotations__r r rrrpropertyr r r@r;__static_attributes__rrrrrs'V J !#I~" 9;5::<7) music21.baserXrDrepr assertEqual)rrXbrs rtest_reprInternalTest.test_reprInternal"s-. O G CDrrN)rr-r:rIrUr_rNrrrrPrPs %ErrPr6)rJ __future__rcollections.abcrtypingtunittestmusic21.commonrrTestCaserPrmusic21mainTestrrrrjsa#$%},},@ E8   E z Tr