New DublinCore-based metadata implementation

music21/_version.py

@@ -42,7 +42,7 @@
 Changing this number invalidates old pickles -- do it if the old pickles create a problem.
 '''
 
-__version_info__ = (8, 0, 0, 'a3')  # can be 4-tuple: (7, 0, 5, 'a2')
+__version_info__ = (8, 0, 0, 'a9')  # can be 4-tuple: (7, 0, 5, 'a2')
 
 v = '.'.join(str(x) for x in __version_info__[0:3])
 if len(__version_info__) > 3 and __version_info__[3]:  # type: ignore

music21/abcFormat/translate.py

@@ -402,24 +402,26 @@ def abcToStreamScore(abcHandler, inputM21=None):
         if isinstance(t, abcFormat.ABCMetadata):
             if t.isTitle():
                 if titleCount == 0:  # first
-                    md.title = t.data
-                    # environLocal.printDebug(['got metadata title', md.title])
+                    md.add('title', t.data)
+                    # environLocal.printDebug(['got metadata title', t.data])
                     titleCount += 1
                 # all other titles go in alternative field
                 else:
-                    md.alternativeTitle = t.data
-                    # environLocal.printDebug(['got alternative title', md.alternativeTitle])
+                    md.add('alternativeTitle', t.data)
+                    # environLocal.printDebug(['got alternative title', t.data])
                     titleCount += 1
+
             elif t.isComposer():
-                md.composer = t.data
+                md.add('composer', t.data)
+                # environLocal.printDebug(['got composer', t.data])
 
             elif t.isOrigin():
-                md.localeOfComposition = t.data
-                # environLocal.printDebug(['got local of composition', md.localOfComposition])
+                md.add('localeOfComposition', t.data)
+                # environLocal.printDebug(['got locale of composition', t.data])
 
             elif t.isReferenceNumber():
-                md.number = int(t.data)  # convert to int?
-                # environLocal.printDebug(['got work number', md.number])
+                md.add('number', int(t.data))
+                # environLocal.printDebug(['got work number', t.data])
 
     partHandlers = []
     tokenCollections = abcHandler.splitByVoice()

music21/base.py

@@ -28,7 +28,7 @@
 <class 'music21.base.Music21Object'>
 
 >>> music21.VERSION_STR
-'8.0.0a3'
+'8.0.0a9'
 
 Alternatively, after doing a complete import, these classes are available
 under the module "base":

music21/braille/examples.py

@@ -1176,7 +1176,8 @@ def testVoices(self):
 
         demo = corpus.parse('demos/two-voices')
         x = objectToBraille(demo, debug=True)
-        y = '''Movement Name: two-voices.xml
+        y = '''Composer: Music21
+Movement Name: two-voices.xml
 Title: Music21 Fragment
 ---begin segment---
 <music21.braille.segment BrailleSegment>

music21/braille/translate.py

@@ -472,24 +472,41 @@ def metadataToString(music21Metadata, returnBrailleUnicode=False):
     <class 'music21.metadata.Metadata'>
     >>> print(translate.metadataToString(mdObject))
     Alternative Title: 3.1
+    Composer: Claudio Monteverdi
     Title: La Giovinetta Pianta
 
     >>> print(translate.metadataToString(mdObject, returnBrailleUnicode=True))
     ⠠⠁⠇⠞⠑⠗⠝⠁⠞⠊⠧⠑⠀⠠⠞⠊⠞⠇⠑⠒⠀⠼⠉⠲⠁
+    ⠠⠉⠕⠍⠏⠕⠎⠑⠗⠒⠀⠠⠉⠇⠁⠥⠙⠊⠕⠀⠠⠍⠕⠝⠞⠑⠧⠑⠗⠙⠊
     ⠠⠞⠊⠞⠇⠑⠒⠀⠠⠇⠁⠀⠠⠛⠊⠕⠧⠊⠝⠑⠞⠞⠁⠀⠠⠏⠊⠁⠝⠞⠁
     '''
     allBrailleLines = []
-    for key in music21Metadata._workIds:
-        value = music21Metadata._workIds[key]
-        if value is not None:
-            n = ' '.join(re.findall(r'([A-Z]*[a-z]+)', key))
-            outString = f'{n.title()}: {value}'
-            if returnBrailleUnicode:
-                outTemp = []
-                for word in outString.split():
-                    outTemp.append(wordToBraille(word))
-                outString = alphabet[' '].join(outTemp)
-            allBrailleLines.append(outString)
+    for uniqueName, value in music21Metadata.all(returnPrimitives=True, returnSorted=False):
+        if value is None:
+            # we don't put None values in braille output
+            continue
+
+        if uniqueName == 'software':
+            # we don't put software versions in braille output
+            continue
+
+        namespaceName: t.Optional[str] = music21Metadata.uniqueNameToNamespaceName(uniqueName)
+        if not namespaceName:
+            # we don't put custom metadata in braille output
+            continue
+
+        if namespaceName.startswith('m21FileInfo:'):
+            # we don't put fileInfo in braille output
+            continue
+
+        n = ' '.join(re.findall(r'([A-Z]*[a-z]+)', uniqueName))
+        outString = f'{n.title()}: {value}'
+        if returnBrailleUnicode:
+            outTemp = []
+            for word in outString.split():
+                outTemp.append(wordToBraille(word))
+            outString = alphabet[' '].join(outTemp)
+        allBrailleLines.append(outString)
     return '\n'.join(sorted(allBrailleLines))
 
 

music21/converter/__init__.py

@@ -1732,7 +1732,7 @@ def testConversionMXMetadata(self):
         a = parse(testFiles.binchoisMagnificat)
         self.assertEqual(a.metadata.composer, 'Gilles Binchois')
         # this gets the best title available, even though this is movement title
-        self.assertEqual(a.metadata.title, 'Excerpt from Magnificat secundi toni')
+        self.assertEqual(a.metadata.bestTitle, 'Excerpt from Magnificat secundi toni')
 
     def testConversionMXBarlines(self):
         from music21 import bar

music21/converter/subConverters.py

@@ -818,7 +818,7 @@ def parseFile(self,
                   filePath: t.Union[pathlib.Path, str],
                   number: t.Optional[int] = None,
                   **keywords):
-        # noinspection SpellCheckingInspection
+        # noinspection SpellCheckingInspection,PyShadowingNames
         '''
         Open Noteworthy data (as nwctxt) from a file path.
 

music21/corpus/manager.py

@@ -362,17 +362,33 @@ def listSearchFields():
     >>> for field in corpus.manager.listSearchFields():
     ...     field
     ...
-    'actNumber'
-    'alternativeTitle'
-    'ambitus'
-    'associatedWork'
-    'collectionDesignation'
-    'commission'
+    'abstract'
+    'accessRights'
+    'accompanyingMaterialWriter'
+    ...
     'composer'
-    'copyright'
+    'composerAlias'
+    'composerCorporate'
+    'conceptor'
+    'conductor'
+    ...
+    'dateCreated'
+    'dateFirstPublished'
+    'dateIssued'
+    'dateModified'
+    'dateSubmitted'
+    'dateValid'
+    ...
+    'tempoFirst'
+    'tempos'
+    'textLanguage'
+    'textOriginalLanguage'
+    'timeSignatureFirst'
+    'timeSignatures'
+    'title'
     ...
     '''
-    return tuple(sorted(metadata.RichMetadata.searchAttributes))
+    return metadata.bundles.MetadataBundle.listSearchFields()
 
 # -----------------------------------------------------------------------------
 

music21/humdrum/spineParser.py

@@ -776,9 +776,8 @@ def parseMetadata(self, s=None):
         grToRemove = []
 
         for gr in s[GlobalReference]:
-            wasParsed = gr.updateMetadata(md)
-            if wasParsed:
-                grToRemove.append(gr)
+            gr.updateMetadata(md)
+            grToRemove.append(gr)
 
         if grToRemove:
             s.remove(grToRemove, recurse=True)
@@ -2727,6 +2726,116 @@ def __init__(self, codeOrAll='', valueOrNone=None):
         if '@' in self.code:
             self.code, self.language = self.code.split('@')
 
+    humdrumKeyToUniqueName: dict = {
+        # dict value is music21's unique name or '' (if there is no supported equivalent)
+        # Authorship information:
+        'COM': 'composer',              # composer's name
+        'COA': 'attributedComposer',    # attributed composer
+        'COS': 'suspectedComposer',     # suspected composer
+        'COL': 'composerAlias',         # composer's abbreviated, alias, or stage name
+        'COC': 'composerCorporate',     # composer's corporate name
+        'CDT': '',  # composer's birth and death dates (**zeit format)
+        'CBL': '',  # composer's birth location
+        'CDL': '',  # composer's death location
+        'CNT': '',  # composer's nationality
+        'LYR': 'lyricist',  # lyricist's name
+        'LIB': 'librettist',    # librettist's name
+        'LAR': 'arranger',  # music arranger's name
+        'LOR': 'orchestrator',  # orchestrator's name
+        'TXO': 'textOriginalLanguage',  # original language of vocal/choral text
+        'TXL': 'textLanguage',  # language of the encoded vocal/choral text
+        # Recording information (if the Humdrum encodes information pertaining
+        # to an audio recording)
+        'TRN': 'translator',  # translator of the text
+        'RTL': '',  # album title
+        'RMM': 'manufacturer',  # manufacturer or sponsoring company
+        'RC#': '',  # recording company's catalog number of album
+        'RRD': 'dateIssued',  # release date (**date format)
+        'RLC': '',  # place of recording
+        'RNP': 'producer',  # producer's name
+        'RDT': '',  # date of recording (**date format)
+        'RT#': '',  # track number
+        # Performance information (if the Humdrum encodes, say, a MIDI performance)
+        'MGN': '',  # ensemble's name
+        'MPN': '',  # performer's name
+        'MPS': '',  # suspected performer
+        'MRD': '',  # date of performance (**date format)
+        'MLC': '',  # place of performance
+        'MCN': 'conductor',  # conductor's name
+        'MPD': '',  # date of first performance (**date format)
+        'MDT': '',  # unknown, but I've seen 'em (another way to say date of performance?)
+        # Work identification information
+        'OTL': 'title',  # title
+        'OTP': 'popularTitle',  # popular title
+        'OTA': 'alternativeTitle',  # alternative title
+        'OPR': 'parentTitle',  # title of parent work
+        'OAC': 'actNumber',  # act number (e.g. '2' or 'Act 2')
+        'OSC': 'sceneNumber',  # scene number (e.g. '3' or 'Scene 3')
+        'OMV': 'movementNumber',  # movement number (e.g. '4', or 'mov. 4', or...)
+        'OMD': 'movementName',  # movement name
+        'OPS': 'opusNumber',  # opus number (e.g. '23', or 'Opus 23')
+        'ONM': 'number',  # number (e.g. number of song within ABC multi-song file)
+        'OVM': 'volumeNumber',  # volume number (e.g. '6' or 'Vol. 6')
+        'ODE': 'dedicatedTo',  # dedicated to
+        'OCO': 'commission',  # commissioned by
+        'OCL': 'transcriber',  # collected/transcribed by
+        'ONB': '',  # free form note (nota bene) related to title or identity of work
+        'ODT': 'dateCreated',  # date or period of composition (**date or **zeit format)
+        'OCY': 'countryOfComposition',  # country of composition
+        'OPC': 'localeOfComposition',  # city, town, or village of composition
+        # Group information
+        'GTL': 'groupTitle',  # group title (e.g. 'The Seasons')
+        'GAW': 'associatedWork',  # associated work, such as a play or film
+        'GCO': 'collectionDesignation',  # collection designation (e.g. 'Norton Scores')
+        # Imprint information
+        'PUB': '',  # publication status 'published'/'unpublished'
+        'PED': '',  # publication editor
+        'PPR': 'firstPublisher',  # first publisher
+        'PDT': 'dateFirstPublished',  # date first published (**date format)
+        'PTL': 'publicationTitle',  # publication (volume) title
+        'PPP': 'placeFirstPublished',  # place first published
+        'PC#': 'publishersCatalogNumber',  # publisher's catalog number (NOT scholarly catalog)
+        'SCT': 'scholarlyCatalogAbbreviation',  # scholarly catalog abbrev/number (e.g. 'BWV 551')
+        'SCA': 'scholarlyCatalogName',  # scholarly catalog (unabbreviated) (e.g. 'Koechel 117')
+        'SMS': 'manuscriptSourceName',  # unpublished manuscript source name
+        'SML': 'manuscriptLocation',  # unpublished manuscript location
+        'SMA': 'manuscriptAccessAcknowledgement',  # acknowledgment of manuscript access
+        'YEP': 'electronicPublisher',  # publisher of electronic edition
+        'YEC': 'copyright',  # date and owner of electronic copyright
+        'YER': 'electronicReleaseDate',  # date electronic edition released
+        'YEM': '',  # copyright message (e.g. 'All rights reserved')
+        'YEN': '',  # country of copyright
+        'YOR': '',  # original document from which encoded document was prepared
+        'YOO': 'originalDocumentOwner',  # original document owner
+        'YOY': '',  # original copyright year
+        'YOE': 'originalEditor',  # original editor
+        'EED': 'electronicEditor',  # electronic editor
+        'ENC': 'electronicEncoder',  # electronic encoder (person)
+        'END': '',  # encoding date
+        'EMD': '',  # electronic document modification description (one per modificiation)
+        'EEV': '',  # electronic edition version
+        'EFL': '',  # file number e.g. '1/4' for one of four
+        'EST': '',  # encoding status (free form, normally eliminated prior to distribution)
+        'VTS': '',  # checksum (excluding the VTS line itself)
+        # Analytic information
+        'ACO': '',  # collection designation
+        'AFR': '',  # form designation
+        'AGN': '',  # genre designation
+        'AST': '',  # style, period, or type of work designation
+        'AMD': '',  # mode classification e.g. '5; Lydian'
+        'AMT': '',  # metric classification, must be one of eight specific names
+        'AIN': '',  # instrumentation; alphabetically ordered list of *I abbrevs, space-delimited
+        'ARE': '',  # geographical region of origin (list of 'narrowing down' names of regions)
+        'ARL': '',  # geographical location of origin (lat/long)
+        # Historical and background information
+        'HAO': '',  # aural history (lots of text, stories about the work)
+        'HTX': '',  # freeform translation of vocal text
+        # Representation information
+        'RLN': '',  # Extended ASCII language code
+        'RNB': '',  # a note about the representation
+        'RWB': ''  # a warning about the representation
+    }
+
     def updateMetadata(self, md):
         '''
         update a metadata object according to information in this GlobalReference
@@ -2735,41 +2844,16 @@ def updateMetadata(self, md):
         '''
         c = self.code
         v = self.value
-        wasParsed = True
-
-        contributorNames = {
-            'COM': 'composer',
-            'COA': 'attributed composer',
-            'COS': 'suspected composer',
-            'COL': 'composer alias',
-            'COC': 'corporate composer',
-            'LYR': 'lyricist',
-            'LIB': 'librettist',
-            'LAR': 'arranger',
-            'LOR': 'orchestrator',
-            'TRN': 'translator',
-            'YOO': 'original document owner',
-            'YOE': 'original editor',
-            'EED': 'electronic editor',
-            'ENC': 'electronic encoder'
-        }
-
-        if c in contributorNames:
-            contrib = metadata.Contributor()
-            contrib.role = contributorNames[c]
-            contrib.name = v
-            md.addContributor(contrib)
-
-        elif c.lower() in md.workIdAbbreviationDict:
-            md.setWorkId(c, v)
-
-        elif c == 'YEC':  # electronic edition copyright.
-            md.copyright = metadata.Copyright(v)
 
+        uniqueName: str = self.humdrumKeyToUniqueName.get(c, '')
+        if uniqueName:
+            md.add(uniqueName, v)
+        elif c in self.humdrumKeyToUniqueName:
+            # it's a humdrum key, but unsupported
+            md.addCustom('humdrum:' + c, v)
         else:
-            wasParsed = False
-
-        return wasParsed
+            # it's a free-form key
+            md.addCustom(c, v)
 
     def _reprInternal(self):
         return f'{self.code} {self.value!r}'