rh%SSKJr /SQrSSKJr SSKrSSKrSSKrSSKrSSK r SSK r SSK r SSK Jr SSKJr SSK Jr SSK Jr SS K Jr \ R((a SS KJr SS KJr \R2"S 5r"S S\R65r"SS\R:5r"SS\R:5r0r S\!S'SSjr""SS\ RF5r$\\4r%\&S:XaSSK r \ RN"\$5 gg)) annotations) MetadataEntryMetadataBundleMetadataBundleException) OrderedDictN)common)readPickleGzip) environment) exceptions21)prebase)Iterable)Metadatazmetadata.bundlesc\rSrSrSrg)r/N)__name__ __module__ __qualname____firstlineno____static_attributes__rR/home/james-whalen/.local/lib/python3.13/site-packages/music21/metadata/bundles.pyrr/srrc\rSrSrSrSSSjjrSrSrSrSr SS jr SS jr \ S 5r \ S 5r\ S 5r\ S5r\ S5rSrg)r5a An entry in a metadata bundle. The metadata entry holds information about the source of the metadata, and can be parsed to reconstitute the score object the metadata was derived from: >>> #_DOCS_SHOW coreBundle = corpus.corpora.CoreCorpus().metadataBundle >>> coreBundle = metadata.bundles.demo_bundle('core') #_DOCS_HIDE >>> metadataEntry = coreBundle.search('bwv66.6')[0] >>> metadataEntry The sourcePath of the metadata entry refers to the file path at which its score file is found, but it is usually a relative path to the top of the corpus directory. It is a pathlib object. >>> metadataEntry.sourcePath PosixPath('bach/bwv66.6.mxl') The metadata property contains its :class:`~music21.metadata.RichMetadata` object: >>> metadataEntry.metadata Note that the id is not necessarily the current memory location. And the metadata entry can be parsed: >>> metadataEntry.parse() NcH[U5UlX lX0lX@lgN)str _sourcePath_number_metadataPayload _corpusName)self sourcePathnumbermetadataPayload corpusNames r__init__MetadataEntry.__init__Ys!!$J /%rcHURURUR4$)z This is all the information that is needed for pickling. Specifically do not include _corpusName. Note do not pickle Pathlib objects, so make sure to do ._sourcePath not .sourcePath )rmetadatar$r"s r__getnewargs__MetadataEntry.__getnewargs__fs%    MM KK  rc,[UR5$r)repr corpusPathr+s r _reprInternalMetadataEntry._reprInternaltsDOO$$rcUR$)a Allows MetadataEntries to be used where file paths are being employed, so it can be used with opening and closing, etc. Returns self.sourcePath() as a string >>> mde1 = metadata.bundles.MetadataEntry(sourcePath='/tmp/myFile.xml') >>> mde1.__fspath__() '/tmp/myFile.xml' )rr+s r __fspath__MetadataEntry.__fspath__wsrcSSKJn URb$URURURS9$URUR5$)Nrcorpus)r$)music21r8r$parser#)r"r8s rr:MetadataEntry.parses=" ;; "<< <D D<<0 0rcFUR5nURU5 gr)r:show)r" showFormatscores rr=MetadataEntry.shows  :rc <URR"X40UD6$r)r*search)r"queryfieldkeywordss rrBMetadataEntry.searchs}}##E=H==rcV[RURUR5$)zN Returns the sourcePath as a string, with _number appended if it is not None. )rcorpusPathToKeyr#r$r+s rr0MetadataEntry.corpusPaths --doot{{KKrcUR$)z; Returns the Metadata object that is stored in the bundle. )r r+s rr*MetadataEntry.metadatas $$$rcUR$r)rr+s rr$MetadataEntry.numbers ||rcB[R"UR5$r)pathlibPathrr+s rr#MetadataEntry.sourcePaths||D,,--rcUR$r)r!r+s rr&MetadataEntry.corpusNamesr)r!r rr)NNrT)r#str | pathlib.Pathr$ int | Noner%zMetadata | Noner&rrNN)rrrr__doc__r'r,r1r4r:r=rBpropertyr0r*r$r#r&rrrrrr5sH13$(26#% &- &! &#0 &! &  %  1>LL %% ..  rrc\rSrSrSrS*S+SjjrS,SjrSrS,SjrSr S,S jr S,S jr S r S,S jr S rSrSrSrS-SjrSr\S5r\R,S5r\S.Sj5r\S5rS/SjrSr\S*S0Sjj5rS1SjrSrSrSr Sr!Sr"\S 5r#S*S!jr$S2S"S#.S3S$jjjr%S%r&S&r'S'r(S*S(jr)S)r*g)4ra An object that provides access to, searches within, and stores and loads multiple Metadata objects. >>> #_DOCS_SHOW coreBundle = corpus.corpora.CoreCorpus().metadataBundle >>> coreBundle = metadata.bundles.demo_bundle('core') #_DOCS_HIDE >>> coreBundle (The coreBundle has around 15100 entries; I've put '...' in the docs so I don't need to rewrite them every time we add a new piece) >>> #_DOCS_SHOW searchResults = coreBundle.search('bach', field='composer') >>> searchResults = metadata.bundles.demo_bundle('bach') #_DOCS_HIDE >>> searchResults >>> resultsEntries = searchResults.search('3/4') >>> resultsEntries Results are ordered by their source path: >>> resultsEntries[0] To get a score out of the entry, call .parse() >>> resultsEntries[0].parse() Or pass it into converter: >>> converter.parse(resultsEntries[0]) A metadata bundle can be instantiated in three ways, (1) from a ``Corpus`` instance, or (2) a string indicating which corpus name to draw from, and then calling .read() or (3) by calling .metadataBundle on a corpus object. This calls `.read()` automatically: Method 1: >>> coreCorpus = corpus.corpora.CoreCorpus() >>> coreBundle = metadata.bundles.MetadataBundle(coreCorpus) >>> localCorpus = corpus.corpora.LocalCorpus() >>> localBundle = metadata.bundles.MetadataBundle(localCorpus) Method 2: >>> coreBundle = metadata.bundles.MetadataBundle('core') >>> localBundle = metadata.bundles.MetadataBundle('local') After calling these you'll need to call ``read()``: >>> coreBundle >>> coreBundle.read() >>> coreBundle Method 3: >>> coreBundle = corpus.corpora.CoreCorpus().metadataBundle >>> localBundle = corpus.corpora.LocalCorpus().metadataBundle >>> coreBundle Additionally, any two metadata bundles can be operated on together as though they were sets, allowing us to build up more complex searches: >>> #_DOCS_SHOW coreBundle = corpus.corpora.CoreCorpus().metadataBundle >>> coreBundle = metadata.bundles.demo_bundle('core') #_DOCS_HIDE >>> #_DOCS_SHOW bachBundle = coreBundle.search('bach', 'composer') >>> bachBundle = metadata.bundles.demo_bundle('bach') #_DOCS_HIDE >>> bachBundle >>> #_DOCS_SHOW tripleMeterBundle = coreBundle.search('3/4') >>> tripleMeterBundle = metadata.bundles.demo_bundle('3/4') #_DOCS_HIDE >>> tripleMeterBundle >>> bachBundle.intersection(tripleMeterBundle) Finally, a metadata bundle need not be associated with any corpus at all, and can be populated ad hoc: >>> anonymousBundle = metadata.bundles.MetadataBundle() >>> mdb = corpus.corpora.CoreCorpus().search('monteverdi')[:4] >>> paths = [common.getCorpusFilePath() / x.sourcePath for x in mdb] >>> failedPaths = anonymousBundle.addFromPaths( ... paths, useMultiprocessing=False) >>> failedPaths [] >>> anonymousBundle NcRSSKJn [5Ul[ U[ UR R[S545(d [S5eSUl U [ XR R5(aURUl XlgXl SUlg)Nrr7z4Need to take a string, corpus, or None as expression) r9r8r_metadataEntries isinstancercorporaCorpustyper_corpusname_name)r"exprr8s rr'MetadataBundle.__init__%sx"AL$fnn&;&;T$Z HII)*`a a37  dNN11 2 2DJKJDKrc&URUS5$)a Compute the set-wise `and` of two metadata bundles: >>> #_DOCS_SHOW coreBundle = corpus.corpora.CoreCorpus().metadataBundle >>> coreBundle = metadata.bundles.demo_bundle('core') #_DOCS_HIDE >>> #_DOCS_SHOW bachBundle = coreBundle.search('bach', 'composer') >>> bachBundle = metadata.bundles.demo_bundle('bach') #_DOCS_HIDE >>> bachBundle >>> #_DOCS_SHOW tripleMeterBundle = coreBundle.search('3/4') >>> tripleMeterBundle = metadata.bundles.demo_bundle('3/4') #_DOCS_HIDE >>> tripleMeterBundle >>> bachBundle & tripleMeterBundle Returns a new metadata bundle. __and___apply_set_operationr"metadataBundles rrhMetadataBundle.__and__8s&((    rc\[US5(aURUR:Xagg)a True if `expr` is of the same type, and contains an identical set of entries, otherwise false: >>> #_DOCS_SHOW coreBundle = corpus.corpora.CoreCorpus().metadataBundle >>> coreBundle = metadata.bundles.demo_bundle('core') #_DOCS_HIDE >>> #_DOCS_SHOW bachBundle = coreBundle.search('bach', 'composer') >>> bachBundle = metadata.bundles.demo_bundle('bach') #_DOCS_HIDE >>> #_DOCS_SHOW corelliBundle = coreBundle.search('corelli', 'composer') >>> corelliBundle = metadata.bundles.demo_bundle('corelli') #_DOCS_HIDE >>> bachBundle == corelliBundle False >>> bachBundle == coreBundle.search( ... 'bach', ... field='composer', ... ) True >>> bachBundle == 'foo' False r]TF)hasattrr])r"others r__eq__MetadataBundle.__eq__Ps,, 5, - -$$(>(>>rc&URUS5$)aY True when one metadata bundle is either a superset or an identical set to another bundle: >>> #_DOCS_SHOW coreBundle = corpus.corpora.CoreCorpus().metadataBundle >>> coreBundle = metadata.bundles.demo_bundle('core') #_DOCS_HIDE >>> #_DOCS_SHOW bachBundle = coreBundle.search('bach', 'composer') >>> bachBundle = metadata.bundles.demo_bundle('bach') #_DOCS_HIDE >>> #_DOCS_SHOW corelliBundle = coreBundle.search('corelli', 'composer') >>> corelliBundle = metadata.bundles.demo_bundle('corelli') #_DOCS_HIDE >>> bachBundle >= bachBundle True >>> bachBundle >= corelliBundle False >>> bachBundle >= coreBundle False >>> corelliBundle >= bachBundle False >>> corelliBundle >= corelliBundle True >>> corelliBundle >= coreBundle False >>> coreBundle >= bachBundle True >>> coreBundle >= corelliBundle True >>> coreBundle >= coreBundle True Returns boolean. __ge___apply_set_predicaterks rrtMetadataBundle.__ge__k@((BBrcN[URR55U$r)listr]values)r"is r __getitem__MetadataBundle.__getitem__s!D))0023A66rc&URUS5$)aR True when one metadata bundle is either a subset or an identical set to another bundle: >>> #_DOCS_SHOW coreBundle = corpus.corpora.CoreCorpus().metadataBundle >>> coreBundle = metadata.bundles.demo_bundle('core') #_DOCS_HIDE >>> #_DOCS_SHOW bachBundle = coreBundle.search('bach', 'composer') >>> bachBundle = metadata.bundles.demo_bundle('bach') #_DOCS_HIDE >>> #_DOCS_SHOW corelliBundle = coreBundle.search('corelli', 'composer') >>> corelliBundle = metadata.bundles.demo_bundle('corelli') #_DOCS_HIDE >>> bachBundle > bachBundle False >>> bachBundle > corelliBundle False >>> bachBundle > coreBundle False >>> corelliBundle > bachBundle False >>> corelliBundle > corelliBundle False >>> corelliBundle > coreBundle False >>> coreBundle > bachBundle True >>> coreBundle > corelliBundle True >>> coreBundle > coreBundle False Returns boolean. __gt__rurks rrMetadataBundle.__gt__sB((BBrc&URUS5$)aW True when one metadata bundle is either a subset or an identical set to another bundle: >>> #_DOCS_SHOW coreBundle = corpus.corpora.CoreCorpus().metadataBundle >>> coreBundle = metadata.bundles.demo_bundle('core') #_DOCS_HIDE >>> #_DOCS_SHOW bachBundle = coreBundle.search('bach', 'composer') >>> bachBundle = metadata.bundles.demo_bundle('bach') #_DOCS_HIDE >>> #_DOCS_SHOW corelliBundle = coreBundle.search('corelli', 'composer') >>> corelliBundle = metadata.bundles.demo_bundle('corelli') #_DOCS_HIDE >>> bachBundle <= bachBundle True >>> bachBundle <= corelliBundle False >>> bachBundle <= coreBundle True >>> corelliBundle <= bachBundle False >>> corelliBundle <= corelliBundle True >>> corelliBundle <= coreBundle True >>> coreBundle <= bachBundle False >>> coreBundle <= corelliBundle False >>> coreBundle <= coreBundle True Returns boolean. __le__rurks rrMetadataBundle.__le__rxrc,[UR5$r)lenr]r+s r__len__MetadataBundle.__len__s4(())rc&URUS5$)a5 True when one metadata bundle is a subset of another bundle: >>> #_DOCS_SHOW coreBundle = corpus.corpora.CoreCorpus().metadataBundle >>> coreBundle = metadata.bundles.demo_bundle('core') #_DOCS_HIDE >>> #_DOCS_SHOW bachBundle = coreBundle.search('bach', 'composer') >>> bachBundle = metadata.bundles.demo_bundle('bach') #_DOCS_HIDE >>> #_DOCS_SHOW corelliBundle = coreBundle.search('corelli', 'composer') >>> corelliBundle = metadata.bundles.demo_bundle('corelli') #_DOCS_HIDE >>> bachBundle < bachBundle False >>> bachBundle < corelliBundle False >>> bachBundle < coreBundle True >>> corelliBundle < bachBundle False >>> corelliBundle < corelliBundle False >>> corelliBundle < coreBundle True >>> coreBundle < bachBundle False >>> coreBundle < corelliBundle False >>> coreBundle < coreBundle False Return boolean. __lt__rurks rrMetadataBundle.__lt__s>((BBrc&URUS5$)a Compute the set-wise `or` of two metadata bundles: >>> #_DOCS_SHOW coreBundle = corpus.corpora.CoreCorpus().metadataBundle >>> coreBundle = metadata.bundles.demo_bundle('core') #_DOCS_HIDE >>> #_DOCS_SHOW bachBundle = coreBundle.search('bach', 'composer') >>> bachBundle = metadata.bundles.demo_bundle('bach') #_DOCS_HIDE >>> bachBundle >>> #_DOCS_SHOW corelliBundle = coreBundle.search('corelli', 'composer') >>> corelliBundle = metadata.bundles.demo_bundle('corelli') #_DOCS_HIDE >>> corelliBundle >>> bachBundle | corelliBundle Returns a new metadata bundle. __or__rirks rrMetadataBundle.__or__s&((    rc[U5S:XaSnOS[[U55-S-nURbUR<SU3nU$)Nz {1 entry}{z entries}z: )rrrc)r"statuss rr1MetadataBundle._reprInternalsL t9> F3s4y>)K7F 99  }Bvh/F rc&URUS5$)a9 Compute the set-wise `subtraction` of two metadata bundles: >>> #_DOCS_SHOW coreBundle = corpus.corpora.CoreCorpus().metadataBundle >>> coreBundle = metadata.bundles.demo_bundle('core') #_DOCS_HIDE >>> #_DOCS_SHOW bachBundle = coreBundle.search('bach', 'composer') >>> bachBundle = metadata.bundles.demo_bundle('bach') #_DOCS_HIDE >>> bachBundle >>> #_DOCS_SHOW tripleMeterBundle = coreBundle.search('3/4') >>> tripleMeterBundle = metadata.bundles.demo_bundle('3/4') #_DOCS_HIDE >>> tripleMeterBundle >>> bachBundle - tripleMeterBundle Returns a new metadata bundle. >>> bachBundle - bachBundle __sub__rirks rrMetadataBundle.__sub__s,((    rc&URUS5$)a Compute the set-wise `exclusive or` of two metadata bundles: >>> #_DOCS_SHOW coreBundle = corpus.corpora.CoreCorpus().metadataBundle >>> coreBundle = metadata.bundles.demo_bundle('core') #_DOCS_HIDE >>> #_DOCS_SHOW bachBundle = coreBundle.search('bach', 'composer') >>> bachBundle = metadata.bundles.demo_bundle('bach') #_DOCS_HIDE >>> bachBundle >>> #_DOCS_SHOW tripleMeterBundle = coreBundle.search('3/4') >>> tripleMeterBundle = metadata.bundles.demo_bundle('3/4') #_DOCS_HIDE >>> tripleMeterBundle >>> bachBundle ^ tripleMeterBundle Returns a new metadata bundle. __xor__rirks rrMetadataBundle.__xor__6s(((    rc [U[U55(d [S5e[URR 55n[URR 55n[ X25"U5n[U5"5nUH?nXpR;aURUnOURUnXRU'MA [URR55n [[U SS95UlU$)N'metadataBundle must be a MetadataBundlec USR$Nrr#mdes r5MetadataBundle._apply_set_operation..cs3q6K\K\rkey) r^rarsetr]keysgetattrrzitemsrsorted) r"rloperatorselfKeys otherKeys resultKeys resultBundler metadataEntrymdbItemss rrj#MetadataBundle._apply_set_operationQs.$t*55)*ST Tt,,113477<<>? ' ;I F '+Dz| C+++ $ 5 5c : . ? ? D 1> ) )# . 599V9V9\9\9^4_(3F8?\5^)_ %rc[U[U55(d [S5e[URR 55n[URR 55n[ X25"U5$)zJ Applies a predicate such as '__or__' to self and another metadataBundle. r)r^rarrr]rr)r"rl predicaterrs rrv#MetadataBundle._apply_set_predicatefsc.$t*55)*ST Tt,,113477<<>? x+I66rcURb%[R"UR5nUbU$URcgSSKJn UR UR5$)ah The `corpus.corpora.Corpus` object associated with the metadata bundle's name. >>> #_DOCS_SHOW coreBundle = corpus.corpora.CoreCorpus().metadataBundle >>> coreBundle = metadata.bundles.demo_bundle('core') #_DOCS_HIDE >>> coreBundle >>> coreBundle.corpus Nr)manager)rbr unwrapWeakrefrcmusic21.corpusrfromName)r"cObjrs rr8MetadataBundle.corpustsR << #'' 5D 99 * **rc:[R"U5Ulgr)r wrapWeakrefrb)r" newCorpuss rr8rs)))4 rcURnUcgURn[U[R5(d[R"U5$U$)aV The filesystem name of the cached metadata bundle, if the metadata bundle's name is not None. >>> ccPath = corpus.corpora.CoreCorpus().metadataBundle.filePath >>> ccPath.name 'core.p.gz' >>> '_metadataCache' in ccPath.parts True >>> localPath = corpus.corpora.LocalCorpus().metadataBundle.filePath >>> localPath.name 'local.p.gz' Local corpora metadata is stored in the scratch dir, not the corpus directory >>> '_metadataCache' in localPath.parts False >>> funkCorpus = corpus.corpora.LocalCorpus('funk') >>> funkPath = funkCorpus.metadataBundle.filePath >>> funkPath.name 'local-funk.p.gz' N)r8 cacheFilePathr^rOrP)r"ccfps rfilePathMetadataBundle.filePathsC6 KK 9//Cc7<<00||C(( rcUR$)a The name of the metadata bundle. Can be 'core', 'local', '{name}' where name is the name of a named local corpus or None. The names 'core' and 'local' refer to the core and local corpora respectively: (virtual corpus is currently offline) >>> metadata.bundles.MetadataBundle().name is None True >>> corpus.corpora.CoreCorpus().metadataBundle.name 'core' >>> funkCorpus = corpus.corpora.LocalCorpus('funk') >>> funkCorpus.metadataBundle.name 'funk' Return string or None. )rdr+s rrcMetadataBundle.names,zzrc SSKJn /n/n/n URbDURR5(a%URR 5R n O[ R "5n SU 3n USLa[RU 5 O[RU 5 Sn Sn UHnURU5nXR;a'UR 5R nUU :aU S- n MJU S- n URnUcSnURS5(aUS SnURRUU UUS 9nUR!U5 M SnS U S 3n USLa[RU 5 O[RU 5 U(a!URR"R$nO URR"R&nU"U5HnURR"R)[+U5US US[+U 55n USLa[RU 5 O[RU 5 US- nUR-US5 U R-US5 USHnUURUR.'M US-S:XdMUSLdMUR15 M UR35 USLaUR15 U $)au Parse and store metadata from numerous files. If any files cannot be loaded, their file paths will be collected in a list that is returned. Returns a list of file paths with errors and stores the extracted metadata in `self._metadataEntries`. >>> metadataBundle = metadata.bundles.MetadataBundle() >>> p = corpus.corpora.CoreCorpus().getWorkList('bach/bwv66.6') >>> metadataBundle.addFromPaths( ... p, ... parseUsingCorpus=False, ... useMultiprocessing=False, ... storeOnDisk=False, #_DOCS_HIDE ... ) [] >>> len(metadataBundle._metadataEntries) 1 Set Verbose to True to get updates even if debug is off. r)r*Nz"MetadataBundle Modification Time: Trcorezlocal-) jobNumberparseUsingCorpusr&zSkipped z sources already in cache. remainingJobsrmetadataEntrieserrors2)r9r*rexistsstatst_ctimetime environLocalwarn printDebugrHr]rc startswithcachingMetadataCachingJobappend JobProcessorprocess_parallelprocess_serial_reportrextendr0writevalidate)r"pathsruseMultiprocessing storeOnDiskverboser*jobsaccumulatedResultsaccumulatedErrorsmetadataBundleModificationTimemessagecurrentJobNumberskippedJobsCountpathrpathModificationTimer&jobcurrentIteration jobProcessorresultrs r addFromPathsMetadataBundle.addFromPathss> % == $)=)=)?)?-1]]-?-?-A-J-J *-1YY[ *67U6VW d?   g &  # #G ,D&&t,C+++'+yy{';';$'*HH$)$  ! J!# $$X..'^ ""55*!1% 6C KK +,-..HI d?   g &  # #G , #++88IIL#++88GGL"4(F&&33;;D 'z"%& G $!!'*''0  !   % %f->&? @  $ $VH%5 6!'(9!: BO%%m&>&>?"; 2%* t0C %)&  $  JJL  rc8URR5 g)a Clear all keys in a metadata bundle: >>> #_DOCS_SHOW coreBundle = corpus.corpora.CoreCorpus().metadataBundle >>> coreBundle = metadata.bundles.demo_bundle('core') #_DOCS_HIDE >>> bachBundle = coreBundle.search('bach', 'composer') >>> bachBundle >>> bachBundle.clear() >>> bachBundle Returns None. OMIT_FROM_DOCS Do not use the cached bach on this -- the .clear() manipulates the metadata bundle. N)r]clearr+s rrMetadataBundle.clear9s( ##%rcR[U[R5(acUR[R "5S- 5nURnUSS:Xa[U5S:aUSSnSRU5nOxSU;aURS5SnOUnUR[R5(aUSSnURSS5nUR[RS5nURSS5nUbUSU3$U$![ a Nf=f) a Given a file path or corpus path, return the metadata key: >>> mb = metadata.bundles.MetadataBundle() >>> key = mb.corpusPathToKey('bach/bwv1007/prelude') >>> key.endswith('bach_bwv1007_prelude') True >>> key = mb.corpusPathToKey('corelli/opus3no1/1grave.xml') >>> key.endswith('corelli_opus3no1_1grave_xml') True Numbers are appended if given >>> key = mb.corpusPathToKey('corelli/opus3no1/1grave.xml', number=3) >>> key.endswith('corelli_opus3no1_1grave_xml_3') True r8r/rN_.)r^rOrP relative_torgetSourceFilePath ValueErrorpartsrjoinsplitrossepreplace)rr$rr0s rrHMetadataBundle.corpusPathToKeyOs( h - - #//0H0H0JX0UVNNEQx33u:>ab %J8#%^^H5b9 % $$RVV,,'^ #++C5J#++BFFC8J''S1    \6(+ +3  s'D D&%D&cURb;URR5(aURR5 ggg)zw Delete the filesystem cache of a named metadata bundle. Does not delete the in-memory metadata bundle. Return None. N)rrunlinkr+s rdeleteMetadataBundle.deletes; == $}}##%% $$&& %rc&URUS5$)a Compute the set-wise difference of two metadata bundles: >>> #_DOCS_SHOW coreBundle = corpus.corpora.CoreCorpus().metadataBundle >>> coreBundle = metadata.bundles.demo_bundle('core') #_DOCS_HIDE >>> #_DOCS_SHOW bachBundle = coreBundle.search('bach', 'composer') >>> bachBundle = metadata.bundles.demo_bundle('bach') #_DOCS_HIDE >>> bachBundle >>> #_DOCS_SHOW tripleMeterBundle = coreBundle.search('3/4') >>> tripleMeterBundle = metadata.bundles.demo_bundle('3/4') #_DOCS_HIDE >>> tripleMeterBundle >>> bachBundle.difference(tripleMeterBundle) Returns a new metadata bundle. differencerirks rr MetadataBundle.differences*((    rc&URUS5$)a Compute the set-wise intersection of two metadata bundles: >>> #_DOCS_SHOW coreBundle = corpus.corpora.CoreCorpus().metadataBundle >>> coreBundle = metadata.bundles.demo_bundle('core') #_DOCS_HIDE >>> #_DOCS_SHOW bachBundle = coreBundle.search('bach', 'composer') >>> bachBundle = metadata.bundles.demo_bundle('bach') #_DOCS_HIDE >>> bachBundle >>> #_DOCS_SHOW tripleMeterBundle = coreBundle.search('3/4') >>> tripleMeterBundle = metadata.bundles.demo_bundle('3/4') #_DOCS_HIDE >>> tripleMeterBundle >>> bachBundle.intersection(tripleMeterBundle) Returns a new MetadataBundle. intersectionrirks rrMetadataBundle.intersections*((    rc&URUS5$)a True if the set of keys in one metadata bundle are disjoint with the set of keys in another: >>> #_DOCS_SHOW coreBundle = corpus.corpora.CoreCorpus().metadataBundle >>> coreBundle = metadata.bundles.demo_bundle('core') #_DOCS_HIDE >>> #_DOCS_SHOW bachBundle = coreBundle.search('bach', 'composer') >>> bachBundle = metadata.bundles.demo_bundle('bach') #_DOCS_HIDE >>> bachBundle >>> #_DOCS_SHOW corelliBundle = coreBundle.search('corelli', 'composer') >>> corelliBundle = metadata.bundles.demo_bundle('corelli') #_DOCS_HIDE >>> corelliBundle >>> bachBundle.isdisjoint(corelliBundle) True >>> #_DOCS_SHOW tripleMeterBundle = coreBundle.search('3/4') >>> tripleMeterBundle = metadata.bundles.demo_bundle('3/4') #_DOCS_HIDE >>> tripleMeterBundle >>> bachBundle.isdisjoint(tripleMeterBundle) False Returns boolean. isdisjointrurks rrMetadataBundle.isdisjoints<((FFrc&URUS5$)a True if the set of keys in one metadata bundle are a subset of the keys in another: >>> #_DOCS_SHOW coreBundle = corpus.corpora.CoreCorpus().metadataBundle >>> coreBundle = metadata.bundles.demo_bundle('core') #_DOCS_HIDE >>> #_DOCS_SHOW bachBundle = coreBundle.search('bach', 'composer') >>> bachBundle = metadata.bundles.demo_bundle('bach') #_DOCS_HIDE >>> bachBundle >>> tripleMeterBachBundle = bachBundle.search('3/4') >>> tripleMeterBachBundle >>> tripleMeterBachBundle.issubset(bachBundle) True >>> bachBundle.issubset(tripleMeterBachBundle) False Returns boolean. issubsetrurks rrMetadataBundle.issubsets0((DDrc&URUS5$)a True if the set of keys in one metadata bundle are a superset of the keys in another: >>> #_DOCS_SHOW coreBundle = corpus.corpora.CoreCorpus().metadataBundle >>> coreBundle = metadata.bundles.demo_bundle('core') #_DOCS_HIDE >>> #_DOCS_SHOW bachBundle = coreBundle.search('bach', 'composer') >>> bachBundle = metadata.bundles.demo_bundle('bach') #_DOCS_HIDE >>> bachBundle >>> tripleMeterBachBundle = bachBundle.search('3/4') >>> tripleMeterBachBundle >>> tripleMeterBachBundle.issuperset(bachBundle) False >>> bachBundle.issuperset(tripleMeterBachBundle) True Returns boolean. issupersetrurks rrMetadataBundle.issupersets0((FFrcSSKJn SSKJn [[ UR UR -[UR5-55$)a List all available search field names: >>> for field in metadata.bundles.MetadataBundle.listSearchFields(): ... field ... 'abstract' 'accessRights' 'accompanyingMaterialWriter' ... 'composer' 'composerAlias' 'composerCorporate' 'conceptor' 'conductor' ... 'dateCreated' 'dateFirstPublished' 'dateIssued' 'dateModified' 'dateSubmitted' 'dateValid' ... 'tempoFirst' 'tempos' 'textLanguage' 'textOriginalLanguage' 'timeSignatureFirst' 'timeSignatures' 'title' ... r) properties) RichMetadata) music21.metadatarrtuplerALL_UNIQUE_NAMESALL_MUSIC21_WORK_IDSrz additionalRichMetadataAttributes)rrs rlistSearchFieldsMetadataBundle.listSearchFieldssJD 01V  ' '-- .<@@A B   rc t[R"5nUR5 Uc URnUc#URc[ R "S5e[U[R5(d[R"U5nUR5(d;[RSRURUR55 U$[U5nURUl[RSURU"5S[!UR5/5 U$)a Load cached metadata from the file path suggested by the name of this MetadataBundle ('core', 'local', or a name). If a specific filepath is given with the `filePath` keyword, attempt to load cached metadata from the file at that location. If `filePath` is None, and `self.filePath` is also None, do nothing. >>> #_DOCS_SHOW coreBundle = metadata.bundles.MetadataBundle('core').read() If a metadata is unnamed, and no file path is specified, an exception will be thrown: >>> anonymousBundle = metadata.bundles.MetadataBundle().read() Traceback (most recent call last): music21.exceptions21.MetadataException: Unnamed MetadataBundles have no default file path to read from. z?Unnamed MetadataBundles have no default file path to read from.zQno metadata found for: {0!r}; try building cache with corpus.cacheMetadata({1!r})zMetadataBundle: loading time:z md items:)rTimerstartrrcr MetadataExceptionr^rOrPrrrformatr r]r)r"rtimernewMdbs rreadMetadataBundle.read?s*   }}H   100 (GLL11||H-H   # #%ZZ`Z`(, 499[> ?K) & 7 7 + II G  %% & !   rr)fileExtensionsc vSSKJn [URU55n[ 5nUc'Uc$U(d [ S5eUR 5up!URR5HsupU RcMU Rn U(aU RU;aM9XR;aMJU RX5S(dMeXRU'Mu [[[URR55SS95UlU(aUR"S0UD6$U$)aw Perform search, on all stored metadata, permit regular expression matching. >>> workList = corpus.corpora.CoreCorpus().getWorkList('ciconia') >>> metadataBundle = metadata.bundles.MetadataBundle() >>> failedPaths = metadataBundle.addFromPaths( ... workList, ... parseUsingCorpus=False, ... useMultiprocessing=False, ... storeOnDisk=False, #_DOCS_HIDE ... ) >>> failedPaths [] >>> searchResult = metadataBundle.search( ... 'cicon', ... field='composer' ... ) >>> searchResult >>> len(searchResult) 1 >>> searchResult[0] >>> searchResult = metadataBundle.search( ... 'cicon', ... field='composer', ... fileExtensions=('.krn',), ... ) >>> len(searchResult) # no files in this format 0 >>> searchResult = metadataBundle.search( ... 'cicon', ... field='composer', ... fileExtensions=('.xml',), ... ) >>> len(searchResult) 1 Searches can also use keyword args: >>> metadataBundle.search(composer='cicon') r)r`zQuery cannot be emptyc USR$rrrs rr'MetadataBundle.search..s3q6#4#4rrr)music21.corpus.corporar`rtranslateExtensionsrrpopitemr]rr*r#suffixrBrrrz) r"rCrDr-rEr`acceptable_extensionsnewMetadataBundlerrsps rrBMetadataBundle.searchqsp 2*-f.H.H.X*Y*, =U]-.EFF#++-LE"&"7"7"="="? C%%-))B$:O)O888##E1!44:G2237#@.9 4)::@@BC4 6.7* $++7h7 7  rc&URUS5$)a Compute the set-wise symmetric difference of two metadata bundles: >>> #_DOCS_SHOW coreBundle = corpus.corpora.CoreCorpus().metadataBundle >>> coreBundle = metadata.bundles.demo_bundle('core') #_DOCS_HIDE >>> #_DOCS_SHOW bachBundle = coreBundle.search('bach', 'composer') >>> bachBundle = metadata.bundles.demo_bundle('bach') #_DOCS_HIDE >>> bachBundle >>> #_DOCS_SHOW tripleMeterBundle = coreBundle.search('3/4') >>> tripleMeterBundle = metadata.bundles.demo_bundle('3/4') #_DOCS_HIDE >>> tripleMeterBundle >>> bachBundle.symmetric_difference(tripleMeterBundle) Returns a new MetadataBundle. symmetric_differencerirks rr:#MetadataBundle.symmetric_differences&((  "  rc&URUS5$)a Compute the set-wise union of two metadata bundles: >>> #_DOCS_SHOW coreBundle = corpus.corpora.CoreCorpus().metadataBundle >>> coreBundle = metadata.bundles.demo_bundle('core') #_DOCS_HIDE >>> #_DOCS_SHOW bachBundle = coreBundle.search('bach', 'composer') >>> bachBundle = metadata.bundles.demo_bundle('bach') #_DOCS_HIDE >>> bachBundle >>> beethovenBundle = coreBundle.search( ... 'beethoven', ... field='composer', ... ) >>> beethovenBundle >>> bachBundle.union(beethovenBundle) Returns a new MetadataBundle. unionrirks rr=MetadataBundle.unions,((    rc6[R"5nUR5 [R S/5 /n[ 5nUR R5HupEURnXc;aM[U[5(a3URS5(aURUR5 M`[U[5(a[R"U5nUR5(d[R "5U- nUR#5(dUR%U5 URUR5 M UHnUR U M SUS3n[R U5 ['U5$)z Validate each metadata entry in a metadata bundle. If the entry represents a non-virtual corpus asset, test that its source path is locatable on disk. If not, remove the metadata entry from the metadata bundle. zMetadataBundle: validating...zhttp:z'MetadataBundle: finished validating in z seconds.)rr%r&rrrr]rr#r^rraddrOrP is_absolutegetCorpusFilePathrrr)r"r)invalidatedKeysvalidatedPathsrrr#rs rrMetadataBundle.validatesL  !@ AB"&"7"7"="="? C'11J+*c**z/D/DW/M/M""=#;#;<J,,$\\*5 ))++#557*D $$&&&&s+   }77 8'#@(#C%%c*#;E7)L(?##rcpU=(d URnURbURn[RSU/5 URnSUl[R "USS9n[ R"US5nURU5 SSS5 X lU$!,(df  N=f)aG Write the metadata bundle to disk as a pickle file. If `filePath` is None, use `self.filePath`. Returns the metadata bundle. >>> #_DOCS_SHOW bachBundle = coreBundle.search('bach', 'composer') >>> bachBundle = metadata.bundles.demo_bundle('bach') #_DOCS_HIDE >>> bachBundle >>> bachBundle.filePath is None True >>> import os >>> e = environment.Environment() >>> tempFilePath = e.getTempFile() >>> bachBundle.write(filePath=tempFilePath) >>> os.remove(tempFilePath) NzMetadataBundle: writing:)protocolwb) rrrrbpickledumpsgzipopenr)r"rstoredCorpusClient uncompressedoutFps rrMetadataBundle.write$s,,t}} == $}}H  # #%?$J K!% DL"<<q9L8T*e L)+-L +*s B'' B5)rbr]rdr8r)rez,'music21.corpus.corpora.Corpus' | str | None)rlr)rlrrr)returnzpathlib.Path | None)FTTF)rrUr$rV)rRNonerW)rCz str | Noner-z Iterable[str])+rrrrrXr'rhrqrtr}rrrrrr1rrrjrvrYr8setterrrcrr staticmethodrHr r rrrrr"r+rBr:r=rrrrrrrrs`hX& 06 CD7!CF CD*CB 0 6 6*7++. ]]55""H8 h!T&,//b ' 4 4G@E4G4' ' R0hW! )+ W!W! & W!r 0 6%$N/rrzdict[str, MetadataBundle] _test_bundlescU[;a [U$US:Xa'SSKJn U"5R[S'[S$US:Xa&[ S5R SS5nU[S'U$US:Xa$[ S5R SSS9nU[S'U$US:Xa%[ S5R S5nU[S'U$[ S U<35e) z- This helps with testing by reusing bundles. rr CoreCorpusbachcomposercorellirDz3/4zno demo bundle called )rVr1rYrl demo_bundlerBr)whichrY bachBundle corelliBundletripleMeterBundles rr^r^`s U## 5 * ; ; fV$$  (// C * f #F+229J2O #0 i  ~'/66u=0 e  -eY7 88rc \rSrSrSrSrSrg)Testi|cSSKJn U"5nURnURS5SnUR [ U5S5 g)NrrXzbwv66.6z;)r1rYrlrB assertEqualr/)r"rYcc coreBundlers rtestOneFromCorpusTest.testOneFromCorpus~sE5 \&& ")))4Q7  m,V XrcSSKJn U"5nURS5n[5nUR USSSS9nUR U5 UR SSS9nUR[U5S 5 UR[US5S 5 UR SSS S 9nUR[U5S5 UR SSS S 9nUR[U5S 5 g)NrrXciconiaF)rrrciconr[r]rzD)z.krn)rDr-)z.xml) r1rY getWorkListrr assertFalserBrfrr/)r"rYrgworkListmdb failedPaths searchResults rtestFileExtensionsTest.testFileExtensionss5 \>>),&& "$ ' %zz "  \*A. l1o._ azz $" \*A.zz $" \*A.rrN)rrrrrirtrrrrrdrd|s X/rrd__main__)r_r)( __future__r__all__ collectionsrrLrrOrJrtypingtunittestr9rmusic21.common.fileToolsr r r r TYPE_CHECKINGcollections.abcr rr EnvironmentrMusic21ExceptionrProtoM21ObjectrrrV__annotations__r^TestCaserd _DOC_ORDERrmainTestrrrrs#  $  3 ??()&&'9:  l;; } G**} F[W++[L%,. (-98(/8  (/\  z Tr