jUUddlmZgdZddlmZddlZddlZddlZddlZddl Z ddl Z ddl Z ddl mZddlmZddl mZddl mZdd l mZe jr dd lmZdd lmZejd ZGd dejZGddejZGddejZiZ de!d<ddZ"Gdde j#Z$eefZ%e&dkrddl Z e j'e$dSdS)) annotations) MetadataEntryMetadataBundleMetadataBundleException) OrderedDictN)common)readPickleGzip) environment) exceptions21)prebase)Iterable)Metadatazmetadata.bundlesceZdZdS)rN)__name__ __module__ __qualname__/Users/tedpeters/Documents/Projects/Claude Projects/Misc Tools/notename-sheets/.venv/lib/python3.11/site-packages/music21/metadata/bundles.pyrr.sDrrceZdZdZ ddd Zd ZdZdZdZddZ ddZ e dZ e dZ e dZe dZe dZdS)raZ 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() N sourcePathstr | pathlib.Pathnumber int | NonemetadataPayloadMetadata | None corpusNamestrcXt||_||_||_||_dSN)r _sourcePath_number_metadataPayload _corpusName)selfrrrrs r__init__zMetadataEntry.__init__Xs/!$J /%rc*|j|j|jfS)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 )r"metadatarr&s r__getnewargs__zMetadataEntry.__getnewargs__es   M K  rc*t|jSr!)repr corpusPathr*s r _reprInternalzMetadataEntry._reprInternalssDO$$$rc|jS)aI 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' )r"r*s r __fspath__zMetadataEntry.__fspath__vs rcddlm}|j!||j|jS||jS)Nrcorpus)r)music21r4rparser)r&r4s rr6zMetadataEntry.parsesJ"""""" ; "<< <DD D<<00 0rcX|}||dSr!)r6show)r& showFormatscores rr8zMetadataEntry.shows'  :rc *|jj||fi|Sr!)r)search)r&queryfieldkeywordss rr<zMetadataEntry.searchs!#t}#E5==H===rcLt|j|jS)z^ Returns the sourcePath as a string, with _number appended if it is not None. )rcorpusPathToKeyrrr*s rr.zMetadataEntry.corpusPaths --dot{KKKrc|jS)zK Returns the Metadata object that is stored in the bundle. )r$r*s rr)zMetadataEntry.metadatas $$rc|jSr!)r#r*s rrzMetadataEntry.numbers |rc4tj|jSr!)pathlibPathr"r*s rrzMetadataEntry.sourcePaths|D,---rc|jSr!)r%r*s rrzMetadataEntry.corpusNames r)rNNr)rrrrrrrrr!NN)rrr__doc__r'r+r/r1r6r8r<propertyr.r)rrrrrrrr4s4H13$(26#% & & & & &    %%%    111>>>>LLXL %%X% X..X.  X   rrceZdZdZd:d;dZddZedZ d?dZd Zed:d@d%ZdAd'Zd(Zd)Zd*Zd+Z d,Z!ed-Z"d:d.Z# dBd/d0dCd5Z$d6Z%d7Z&d8Z'd:d9Z(dS)Dra 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 Nexpr,'music21.corpus.corpora.Corpus' | str | Nonec@ddlm}t|_t |t |jjtdfstdd|_ |t ||jjr|j |_ ||_dS||_ d|_dS)Nrr3z4Need to take a string, corpus, or None as expression) r5r4r_metadataEntries isinstancercorporaCorpustyper_corpusname_name)r&rLr4s rr'zMetadataBundle.__init__s""""""AL$fn&;T$ZZ HII b)*`aa a37   dFN1 2 2 DJDKKKDJDKKKrmetadataBundlec.||dS)aU 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&rWs rrYzMetadataBundle.__and__2s"&((     rcJt|dr|j|jkrdSdS)a7 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 rOTF)hasattrrO)r&others r__eq__zMetadataBundle.__eq__Js2, 5, - - $(>>>turc.||dS)a9 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_predicater\s rrbzMetadataBundle.__ge__e@((BBBrcZt|j|Sr!)listrOvalues)r&is r __getitem__zMetadataBundle.__getitem__s$D)002233A66rc.||dS)a1 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__rcr\s rrlzMetadataBundle.__gt__rerc.||dS)a7 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__rcr\s rrnzMetadataBundle.__le__rerc*t|jSr!)lenrOr*s r__len__zMetadataBundle.__len__s4()))rc.||dS)a  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__rcr\s rrszMetadataBundle.__lt__s>((BBBrc.||dS)aT 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__rZr\s rruzMetadataBundle.__or__s"&((     rct|dkrd}n"dtt|zdz}|j |jd|}|S)Nz {1 entry}{z entries}z: )rprrU)r&statuss rr/zMetadataBundle._reprInternal sU t99>> FF3s4yy>>)K7F 9  //v//F rc.||dS)a 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__rZr\s rr{zMetadataBundle.__sub__s",((     rc.||dS)aa 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__rZr\s rr}zMetadataBundle.__xor__/s"(((     roperatorrcPt|t|stdt|j}t|j}t |||}t|}|D]0}||jvr|j|}n |j|}||j|<1t|j} tt| d|_|S)N'metadataBundle must be a MetadataBundlec|djSNrwrmdes rz5MetadataBundle._apply_set_operation..\s 3q6K\rkey) rPrSrsetrOkeysgetattrrgitemsrsorted) r&rWr~selfKeys otherKeys resultKeys resultBundler metadataEntrymdbItemss rr[z#MetadataBundle._apply_set_operationJs).$t**55 U)*STT Tt,1133447<<>>?? ;( ; ;I F F '1tDzz||  ? ?Cd+++ $ 5c : . ? D 1>L )# . .599V9\9\9^9^4_4_(3F8?\?\5^5^5^)_)_ %rc$t|t|stdt|j}t|j}t |||S)zZ Applies a predicate such as '__or__' to self and another metadataBundle. r)rPrSrrrOrr)r&rW predicaterrs rrdz#MetadataBundle._apply_set_predicate_s~.$t**55 U)*STT Tt,1133447<<>>?? +wx++I666rc|jtj|j}||S|jdSddlm}||jS)a 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)rTr unwrapWeakrefrUmusic21.corpusrfromName)r&cObjrs rr4zMetadataBundle.corpusms^ < #' 55D 9 4****** ***rc8tj||_dSr!)r wrapWeakrefrT)r& newCorpuss rr4zMetadataBundle.corpuss))44 rreturnpathlib.Path | Nonec|j}|dS|j}t|tjstj|S|S)a 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)r4 cacheFilePathrPrErF)r&ccfps rfilePathzMetadataBundle.filePathsE6 K 94/Cc7<00 |C((( rc|jS)aM 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. )rVr*s rrUzMetadataBundle.names ,zrFTc ddlm}g}g}g} |j8|jr|jj} nt j} d| } |durt| nt | d} d} |D]}| |}||j vr%|j}|| kr| dz } E| dz } |j }|d}| dr |d d}|j|| || }||d}d | d } |durt| nt | |r|jjj}n|jjj}||D]}|jjt+||d |dt+| } |durt| nt | |dz }||d| |d|dD]}||j |j<|dzdkr|dur|||dur|| S)a 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: Trwcorezlocal-) jobNumberparseUsingCorpusrzSkipped z sources already in cache. remainingJobsrmetadataEntrieserrors2)r5r)rexistsstatst_ctimetime environLocalwarn printDebugrArOrU startswithcachingMetadataCachingJobappend JobProcessorprocess_parallelprocess_serial_reportrpextendr.writevalidate)r&pathsruseMultiprocessing storeOnDiskverboser)jobsaccumulatedResultsaccumulatedErrorsmetadataBundleModificationTimemessagecurrentJobNumberskippedJobsCountpathrpathModificationTimerjobcurrentIteration jobProcessorresultrs r addFromPathszMetadataBundle.addFromPathssM> %$$$$$ = $)=)=)?)? $-1]-?-?-A-A-J * *-1Y[[ *W7UWW d??   g & & & &  # #G , , ,  D&&t,,Cd+++'+yy{{';$'*HHH$)$  ! J!# $$X.. ,'^ "55*!1% 6C KK    I-III d??   g & & & &  # #G , , ,  H#+8ILL#+8GL"l4((  F&3;;D 'z"%&& G $!!'****''000  !   % %f->&? @ @ @  $ $VH%5 6 6 6!'(9!: P P BO%m&>?? 2%** t0C0C   $   JJLLL  rc8|jdS)ai 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)rOclearr*s rrzMetadataBundle.clear2s( ##%%%%%rrrrrc|t|tjr |t jdz }n#t $rYnwxYw|j}|ddkrt|dkr |dd}d |}nd|vr| dd}n|}| tj r |dd}|dd}|tj d}|dd}||d|S|S) aB 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 r4r/rwN_.)rPrErF relative_torgetSourceFilePath ValueErrorpartsrpjoinsplitrossepreplace)rrrr.s rrAzMetadataBundle.corpusPathToKeyHsR( h - - 9 #//0H0J0JX0UVV    NEQx33u::>>abb %JJ8##%^^H55b9 % $$RV,, ,'^ #++C55J#++BFC88J''S11    ++6++ +s)A AANonec|j4|jr|jdSdSdS)z Delete the filesystem cache of a named metadata bundle. Does not delete the in-memory metadata bundle. Return None. N)rrunlinkr*s rdeletezMetadataBundle.deletezsN = $}##%% ' $$&&&&& % $ ' 'rc.||dS)ag 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. differencerZr\s rrzMetadataBundle.differences"*((     rc.||dS)ai 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. intersectionrZr\s rrzMetadataBundle.intersections"*((     rc.||dS)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. isdisjointrcr\s rrzMetadataBundle.isdisjoints<((FFFrc.||dS)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. issubsetrcr\s rrzMetadataBundle.issubsets0((DDDrc.||dS)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. issupersetrcr\s rrzMetadataBundle.issupersets0((FFFrcddlm}ddlm}tt |j|jzt|jzS)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_IDSrg additionalRichMetadataAttributes)rrs rlistSearchFieldszMetadataBundle.listSearchFieldsslD 0/////111111V  '- .<@AA B     rc 0tj}|||j}||jt jdt|tj stj |}| s-t d|jd|jd|St|}|j|_t d|j|dt|jg|S)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. Nz?Unnamed MetadataBundles have no default file path to read from.zno metadata found for: z/; try building cache with corpus.cacheMetadata()zMetadataBundle: loading time:z md items:)rTimerstartrrUr MetadataExceptionrPrErFrrrr rOrp)r&rtimernewMdbs rreadzMetadataBundle.read8s1*   }H   10 (GL11 .|H--H     # #O$)OO@D OOO   K)) & 7 + I EGG  % & & !     rr)fileExtensionsr= str | Noner Iterable[str]c Lddlm}t||}t }|*|(|st d|\}}|jD]P\}} | j  | j } |r | j |vr ||jvr*| ||dr | |j|<Qttt|jd|_|r |j di|S|S)a 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)rRNzQuery cannot be emptyc|djSrrrs rrz'MetadataBundle.search..s 3q6#4rrr)music21.corpus.corporarRrtranslateExtensionsrrpopitemrOrr)rsuffixr<rrrg) r&r=r>rr?rRacceptable_extensionsnewMetadataBundlerrsps rr<zMetadataBundle.searchksvp 211111*-f.H.H.X.X*Y*Y*,, =U] G-.EFFF#++--LE5"&"7"="="?"? H H C%-)B$ :O)O)O'888##E511!4 H:G!237.9 4):@@BBCC44 6 6 6.7.7*  8+$+77h77 7  rc.||dS)ay 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_differencerZr\s rrz#MetadataBundle.symmetric_differences"&((  "   rc.||dS)aA 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. unionrZr\s rrzMetadataBundle.unions",((     rc*tj}|tdgg}t }|jD]\}}|j}||vrt|tr0| dr| |jVt|trtj|}|stj|z }|s||| |j|D] }|j|= d|d}t|t'|S)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.)rrrrrrrOrrrPrraddrErF is_absolutegetCorpusFilePathrrrp)r&rinvalidatedKeysvalidatedPathsrrrrs rrzMetadataBundle.validates  !@ ABBB"&"7"="="?"? 9 9 C'1J^++*c** 6z/D/DW/M/M 6""=#;<<<J,, 6$\*55 ))++ E#577*D $$&& ,&&s+++   }7 8 8 8 8" + +C%c**LELLL(((?###rcF|p|j}|j|j}td|g|j}d|_t j|d}t j|d5}||dddn #1swxYwY||_|S)a 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) rrrrTpickledumpsgzipopenr)r&rstoredCorpusClient uncompressedoutFps rrzMetadataBundle.writes,,t} = $}H  # #%?$J K K K!% DL"<q999L8T** *e L))) * * * * * * * * * * * * * * *-DL s-BBBr!)rLrM)rWr)rWrr~r)rr)FTTF)rrrr)rrrH)r=rrr))rrrrIr'rYr`rbrjrlrnrqrsrur/r{r}r[rdrJr4setterrrUrr staticmethodrArrrrrrrrr<rrrrrrrrrs"ccN&    06 C C C CD777 C C C CD C C C CD***CCCCB   0   6   6*777++X+. ]55]5"""X"HX8 h!h!h!h!T&&&,////\/b ' ' ' '   4   4GGG@EEE4GGG4' ' \' R1111jW! )+ W!W!W!W!W!W!r   0   6%$%$%$N//////rrzdict[str, MetadataBundle] _test_bundleswhichrc|tvr t|S|dkr*ddlm}|jtd<tdS|dkr/t ddd}|td<|S|dkr0t ddd}|td<|S|dkr.t dd}|td<|St d |) z5 This helps with testing by reusing bundles. rr CoreCorpusbachcomposercorellir>z3/4zno demo bundle called )r&rr*rW demo_bundler<r)r'r* bachBundle corelliBundletripleMeterBundles rr/r/Zs U## 555555 * ; fV$$  ((// CC * f #F++229J2OO #0 i  ~~'//66u==0 e  7e77 8 88rceZdZdZdZdS)Testcddlm}|}|j}|dd}|t |ddS)Nrr)zbwv66.6z;)rr*rWr< assertEqualr-)r&r*cc coreBundlers rtestOneFromCorpuszTest.testOneFromCorpusxss555555 Z\\& ")))44Q7  m,,V X X X X Xrczddlm}|}|d}t}||ddd}|||dd}|t|d |t|dd |ddd }|t|d|ddd }|t|d dS)Nrr)ciconiaF)rrrciconr,r.rwzD)z.krn)r>r)z.xml) rr* getWorkListrr assertFalser<r6rpr-)r&r*r7workListmdb failedPaths searchResults rtestFileExtensionszTest.testFileExtensionssi555555 Z\\>>),,&& "$ '  %%%zz "   \**A... l1o.._ a a azz $"  \**A...zz $"  \**A.....rN)rrrr9rCrrrr4r4vs5XXX/////rr4__main__)r'r)( __future__r__all__ collectionsrrrrErrtypingtunittestr5rmusic21.common.fileToolsr r r r TYPE_CHECKINGcollections.abcr rr EnvironmentrMusic21ExceptionrProtoM21Objectrrr&__annotations__r/TestCaser4 _DOC_ORDERrmainTestrrrrUsV#""""""    $#####  333333 ?*(((((())))))'{&'9::      l;   } } } } } G*} } } FVVVVVW+VVVB%,. ----99998(/(/(/(/(/8 (/(/(/\  zNNNGTr