3jUUddlmZgdZddlmZddlZddlZddlZddlZddl Z ddl Z ddl Z ddl mZddlmZddl mZddl mZdd l mZe j(r dd lmZdd lmZej2d ZGd dej6ZGddej:ZGddej:ZiZ de!d<ddZ"Gdde jFZ$eefZ%e&dk(rddl Z e jNe$yy)) annotations) MetadataEntryMetadataBundleMetadataBundleException) OrderedDictN)common)readPickleGzip) environment) exceptions21)prebase)Iterable)Metadatazmetadata.bundlesc eZdZy)rN)__name__ __module__ __qualname__E/DATA/.local/lib/python3.12/site-packages/music21/metadata/bundles.pyrr.srrceZdZdZ d ddZdZdZdZdZddZ dd Z e d Z e d Z e d Ze d Ze dZy)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() NcNt||_||_||_||_yN)str _sourcePath_number_metadataPayload _corpusName)self sourcePathnumbermetadataPayload corpusNames r__init__zMetadataEntry.__init__Xs'!$J /%rcH|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 )rmetadatar rs r__getnewargs__zMetadataEntry.__getnewargs__es%    MM KK  rc,t|jSr)repr corpusPathr&s r _reprInternalzMetadataEntry._reprInternalssDOO$$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' )rr&s r __fspath__zMetadataEntry.__fspath__vsrcddlm}|j'|j|j|jS|j|jS)Nrcorpus)r )music21r0r parser)rr0s rr2zMetadataEntry.parses=" ;; "<< <D D<<0 0rcF|j}|j|yr)r2show)r showFormatscores rr4zMetadataEntry.shows  :rc >|jj||fi|Sr)r%search)rqueryfieldkeywordss rr8zMetadataEntry.searchs #t}}##E5=H==rcVtj|j|jS)z^ Returns the sourcePath as a string, with _number appended if it is not None. )rcorpusPathToKeyrr r&s rr*zMetadataEntry.corpusPaths --doot{{KKrc|jS)zK Returns the Metadata object that is stored in the bundle. )rr&s rr%zMetadataEntry.metadatas $$$rc|jSr)rr&s rr zMetadataEntry.numbers ||rc@tj|jSr)pathlibPathrr&s rrzMetadataEntry.sourcePaths||D,,--rc|jSr)rr&s rr"zMetadataEntry.corpusNamesr)NNrD)rstr | pathlib.Pathr int | Noner!zMetadata | Noner"rrNN)rrr__doc__r#r'r+r-r2r4r8propertyr*r%r rr"rrrrr4sH13$(26#% &- &! &#0 &! &  %  1>LL %% ..  rrcleZdZdZd(d)dZd*dZdZd*dZdZd*dZ d*d Z d Z d*d Z d Z d ZdZdZd+dZdZedZej*dZed,dZedZ d-dZdZed(d.dZd/dZdZdZdZdZ dZ!edZ"d(d Z# d0d!d" d1d#Z$d$Z%d%Z&d&Z'd(d'Z(y)2ra 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 NcDddlm}t|_t |t |j jtdfs tdd|_ |t ||j jr|j|_ ||_y||_ d|_y)Nrr/z4Need to take a string, corpus, or None as expression) r1r0r_metadataEntries isinstancercorporaCorpustyper_corpusname_name)rexprr0s rr#zMetadataBundle.__init__sx"AL$fnn&;&;T$Z HI)*`a a37  dFNN11 2DJDKDJDKrc&|j|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_operationrmetadataBundles rrVzMetadataBundle.__and__2s&((    rcPt|dr|j|jk(ryy)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 rLTF)hasattrrL)rothers r__eq__zMetadataBundle.__eq__Js), 5, -$$(>(>>rc&|j|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_predicaterYs rr`zMetadataBundle.__ge__e@((BBrcNt|jj|Sr)listrLvalues)ris r __getitem__zMetadataBundle.__getitem__s!D))0023A66rc&|j|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__rarYs rrjzMetadataBundle.__gt__rcrc&|j|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__rarYs rrlzMetadataBundle.__le__rcrc,t|jSr)lenrLr&s r__len__zMetadataBundle.__len__s4(())rc&|j|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__rarYs rrqzMetadataBundle.__lt__s>((BBrc&|j|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__rWrYs rrszMetadataBundle.__or__s&((    rct|dk(rd}ndtt|zdz}|j|jd|}|S)Nz {1 entry}{z entries}z: )rnrrR)rstatuss rr+zMetadataBundle._reprInternal sL t9> F3s4y>)K7F 99  }Bvh/F rc&|j|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__rWrYs rryzMetadataBundle.__sub__s,((    rc&|j|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__rWrYs rr{zMetadataBundle.__xor__/s(((    rct|t|s tdt|jj }t|jj }t |||}t|}|D]>}||jvr|j|}n|j|}||j|<@t|jj} tt| d|_|S)N'metadataBundle must be a MetadataBundlec |djSNrurmdes rz5MetadataBundle._apply_set_operation..\s3q6K\K\rkey) rMrPrsetrLkeysgetattrreitemsrsorted) rrZoperatorselfKeys otherKeys resultKeys resultBundler metadataEntrymdbItemss rrXz#MetadataBundle._apply_set_operationJs.$t*5)*ST Tt,,113477<<>? ;( ;I F '1tDz| Cd+++ $ 5 5c : . ? ? D 1>L ) )# . 599V9V9\9\9^4_(3F8?\5^)_ %rct|t|s tdt|jj }t|jj }t |||S)zZ Applies a predicate such as '__or__' to self and another metadataBundle. r})rMrPrrrLrr)rrZ predicaterrs rrbz#MetadataBundle._apply_set_predicate_sd.$t*5)*ST Tt,,113477<<>? +wx+I66rc|j#tj|j}||S|jyddlm}|j |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)rQr unwrapWeakrefrRmusic21.corpusrfromName)rcObjrs rr0zMetadataBundle.corpusmsR << #'' 5D 99 * **rc8tj||_yr)r wrapWeakrefrQ)r newCorpuss rr0zMetadataBundle.corpuss)))4 rc|j}|y|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)r0 cacheFilePathrMrArB)rccfps rfilePathzMetadataBundle.filePaths@6 KK 9//Cc7<<0||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. )rSr&s rrRzMetadataBundle.names,zzrc ddlm}g}g}g} |j?|jjr%|jj j } nt j } d| } |durtj| ntj| d} d} |D]}|j|}||jvr%|j j }|| kr| dz } G| dz } |j}|d}|jdr|d d}|jj|| || }|j!|d}d | d } |durtj| ntj| |r!|jj"j$}n |jj"j&}||D]}|jj"j)t+||d |dt+| } |durtj| ntj| |dz }|j-|d| j-|d|dD]}||j|j.<|dzdk(s|dus|j1|j3|dur|j1| 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: Trucorezlocal-) jobNumberparseUsingCorpusr"zSkipped z sources already in cache. remainingJobsrmetadataEntrieserrors2)r1r%rexistsstatst_ctimetime environLocalwarn printDebugr=rLrR startswithcachingMetadataCachingJobappend JobProcessorprocess_parallelprocess_serial_reportrnextendr*writevalidate)rpathsruseMultiprocessing storeOnDiskverboser%jobsaccumulatedResultsaccumulatedErrorsmetadataBundleModificationTimemessagecurrentJobNumberskippedJobsCountpathrpathModificationTimer"jobcurrentIteration jobProcessorresultrs r addFromPathszMetadataBundle.addFromPathss> % == $)=)=)?-1]]-?-?-A-J-J *-1YY[ *67U6VW d?   g &  # #G ,D&&t,Cd+++'+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  rc8|jjy)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)rLclearr&s rrzMetadataBundle.clear2s( ##%rc0t|tjr` |jt j dz }|j}|ddk(rt|dkDr|dd}dj|}nqd|vr|jdd}n|}|jtjr|dd}|jdd}|jtjd}|jdd}||d|S|S#t $rYwxYw) 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 r0r/ruN_.)rMrArB relative_torgetSourceFilePath ValueErrorpartsrnjoinsplitrossepreplace)rr rr*s rr=zMetadataBundle.corpusPathToKeyHs( h - #//0H0H0JX0UVNNEQx33u:>ab %J8#%^^H5b9 % $$RVV,'^ #++C5J#++BFFC8J''S1    \6(+ +3  s&D DDc|j6|jjr|jjyyy)z Delete the filesystem cache of a named metadata bundle. Does not delete the in-memory metadata bundle. Return None. N)rrunlinkr&s rdeletezMetadataBundle.deletezs8 == $}}##% $$&& %rc&|j|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. differencerWrYs rrzMetadataBundle.differences*((    rc&|j|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. intersectionrWrYs rrzMetadataBundle.intersections*((    rc&|j|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. isdisjointrarYs rrzMetadataBundle.isdisjoints<((FFrc&|j|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. issubsetrarYs rrzMetadataBundle.issubsets0((DDrc&|j|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. issupersetrarYs rrzMetadataBundle.issupersets0((FFrcddlm}ddlm}tt |j |j zt|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_IDSre additionalRichMetadataAttributes)rrs rlistSearchFieldszMetadataBundle.listSearchFieldssJD 01V  ' '-- .<@@A B   rc Btj}|j| |j}|!|jt j dt|tjstj|}|js2tjd|jd|jd|St|}|j|_tjd|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. z?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:)rTimerstartrrRr MetadataExceptionrMrArBrrrr rLrn)rrtimernewMdbs rreadzMetadataBundle.read8s*   }}H   100 (GLL1||H-H  # #)$))7@@D }AO K) & 7 7 + II G  %% & !   rr)fileExtensionsc Dddlm}t|j|}t }|"| |s t d|j \}}|jjD]c\}} | j| j} |r| j|vr0||jvr?| j||dsU| |j|<ettt|jjd|_|r|jdi|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)rOzQuery cannot be emptyc |djSrrrs rrz'MetadataBundle.search..s3q6#4#4rrr)music21.corpus.corporarOrtranslateExtensionsrrpopitemrLrr%rsuffixr8rrre) rr9r:rr;rOacceptable_extensionsnewMetadataBundlerrsps rr8zMetadataBundle.searchks(p 2*-f.H.H.X*Y*, =U]-.EFF#++-LE5"&"7"7"="="? C%%-))B$:O)O'888##E51!4:G!2237#@.9 4)::@@BC4 6.7* +$++7h7 7  rc&|j|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_differencerWrYs rr z#MetadataBundle.symmetric_differences&((  "  rc&|j|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. unionrWrYs rr zMetadataBundle.unions,((    rctj}|jtj dgg}t }|j jD]\}}|j}||vrt|tr-|jdr|j|jTt|trtj|}|jstj |z }|j#s|j%||j|j|D]}|j |=d|d}tj |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.)rrrrrrrLrrrMrraddrArB is_absolutegetCorpusFilePathrrrn)rrinvalidatedKeysvalidatedPathsrrrrs rrzMetadataBundle.validatesA  !@ AB"&"7"7"="="? C'11J^+*c*z/D/DW/M""=#;#;<J,$\\*5 ))+#557*D $$&&&s+   }77 8'#@(#C%%c*#;E7)L(?##rc^|xs |j}|j|j}tjd|g|j}d|_t j |d}t j|d5}|j|ddd||_|S#1swYxYw)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) rrrrQpickledumpsgzipopenr)rrstoredCorpusClient uncompressedoutFps rrzMetadataBundle.writes,,t}} == $}}H  # #%?$J K!% DL"<<q9L8T*e L)+-DL +*s B##B,r)rTz,'music21.corpus.corpora.Corpus' | str | None)rZr)rZrrr)returnzpathlib.Path | None)FTTF)rrEr rF)rNonerG)r9z str | Nonerz Iterable[str]))rrrrHr#rVr^r`rhrjrlrorqrsr+ryr{rXrbrIr0setterrrRrr staticmethodr=rrrrrrrrr8r r rrrrrrrs`cN& 06 CD7 CD CD*CB 0 6 6*7++. ]]55""H8 h!T&,//b ' 4 4G@E4G4' ' R1jW! )+ W!W! & W!r 0 6%$N/rrzdict[str, MetadataBundle] _test_bundlesc|tvr t|S|dk(r'ddlm}|jtd<tdS|dk(r&t dj dd}|td<|S|dk(r't dj dd}|td<|S|dk(r%t dj d}|td<|St d |) z5 This helps with testing by reusing bundles. rr CoreCorpusbachcomposercorellir:z3/4zno demo bundle called )r!rr$rZ demo_bundler8r)whichr$ bachBundle corelliBundletripleMeterBundles rr)r)Zs U## 5 * ; ; fV$$  (// C * f #F+229J2O #0 i  ~'/66u=0 e  -eY7 88rceZdZdZdZy)Testcddlm}|}|j}|jdd}|j t |dy)Nrr#zbwv66.6z;)rr$rZr8 assertEqualr))rr$cc coreBundlers rtestOneFromCorpuszTest.testOneFromCorpusxsE5 \&& ")))4Q7  m,V Xrcddlm}|}|jd}t}|j |ddd}|j ||j dd}|jt|d |jt|dd |j ddd }|jt|d|j ddd }|jt|d y)Nrr#ciconiaF)rrrciconr&r(ruzD)z.krn)r:r)z.xml) rr$ getWorkListrr assertFalser8r1rnr))rr$r2workListmdb failedPaths searchResults rtestFileExtensionszTest.testFileExtensionss5 \>>),&& "$ ' %zz "  \*A. l1o._ azz $" \*A.zz $" \*A.rN)rrrr4r>rrrr/r/vs X/rr/__main__)r*r)( __future__r__all__ collectionsrrrrArrtypingtunittestr1rmusic21.common.fileToolsr r r r TYPE_CHECKINGcollections.abcr rr EnvironmentrMusic21ExceptionrProtoM21Objectrrr!__annotations__r)TestCaser/ _DOC_ORDERrmainTestrrrrPs#  $  3 ??()'{&&'9:  l;; } G**} FVW++VB%,. (-98(/8  (/\  zGTr