lint, scoreQuarterLength; rm networkx

Author: mscuthbert

music21/beam.py

@@ -219,7 +219,7 @@ class Beams(prebase.ProtoM21Object, EqualSlottedObjectMixin):
 
     # INITIALIZER #
 
-    def __init__(self):
+    def __init__(self) -> None:
         # no need for super() call w/ ProtoM21 and EqualSlottedObject
         self.beamsList: list[Beam] = []
         self.feathered: bool = False

music21/corpus/__init__.py

@@ -42,18 +42,19 @@
 import typing as t
 
 from music21 import common
+from music21.exceptions21 import CorpusException
 from music21 import metadata
 
 from music21.corpus import chorales
 from music21.corpus import corpora
 from music21.corpus import manager
 from music21.corpus import virtual
 from music21.corpus import work
-
 from music21.corpus.manager import search
 from music21 import environment
 
 __all__ = [
+    'CorpusException',
     'addPath',
     'cacheMetadata',
     'chorales',
@@ -68,6 +69,7 @@
     'noCorpus',
     'parse',
     # virtual
+    'search',
     'work',
 ]
 

music21/corpus/_metadataCache/core.p.gz

@@ -811,15 +811,14 @@ def addPath(self, directoryPath):
         Paths added in this way will not be persisted from session to session
         unless explicitly saved by a call to ``LocalCorpus.save()``.
         '''
-        from music21 import corpus
         if not isinstance(directoryPath, (str, pathlib.Path)):
-            raise corpus.CorpusException(
+            raise CorpusException(
                 f'an invalid file path has been provided: {directoryPath!r}')
 
         directoryPath = common.cleanpath(directoryPath, returnPathlib=True)
         if (not directoryPath.exists()
                 or not directoryPath.is_dir()):
-            raise corpus.CorpusException(
+            raise CorpusException(
                 f'an invalid file path has been provided: {directoryPath!r}')
         if self.name not in LocalCorpus._temporaryLocalPaths:
             LocalCorpus._temporaryLocalPaths[self.name] = set()

music21/corpus/corpora.py

@@ -579,93 +579,6 @@ def write(self, fp=None):  # pragma: no cover
             return self.figure
 
 
-class GraphNetworkxGraph(Graph):
-    '''
-    Grid a networkx graph -- which is a graph of nodes and edges.
-    Requires the optional networkx module.
-    '''
-    #
-    # >>> #_DOCS_SHOW g = graph.primitives.GraphNetworkxGraph()
-    #
-    # .. image:: images/GraphNetworkxGraph.*
-    #     :width: 600
-    _DOC_ATTR: dict[str, str] = {
-        'networkxGraph': '''An instance of a networkx graph object.''',
-        'hideLeftBottomSpines': 'bool to hide the left and bottom axis spines; default True',
-    }
-
-    graphType = 'networkx'
-    keywordConfigurables = Graph.keywordConfigurables + (
-        'networkxGraph', 'hideLeftBottomSpines',
-    )
-
-    def __init__(self, **keywords):
-        self.networkxGraph = None
-        self.hideLeftBottomSpines = True
-
-        super().__init__(**keywords)
-
-        extm = getExtendedModules()
-
-        if 'title' not in keywords:
-            self.title = 'Network Plot'
-
-        elif extm.networkx is not None:  # if we have this module
-            # testing default; temporary
-            try:  # pragma: no cover
-                g = extm.networkx.Graph()
-                # g.add_edge('a', 'b',weight=1.0)
-                # g.add_edge('b', 'c',weight=0.6)
-                # g.add_edge('c', 'd',weight=0.2)
-                # g.add_edge('d', 'e',weight=0.6)
-                self.networkxGraph = g
-            except NameError:
-                pass  # keep as None
-
-    def renderSubplot(self, subplot):  # pragma: no cover
-        # figure size can be set w/ figsize=(5,10)
-        extm = getExtendedModules()
-        networkx = extm.networkx
-
-        # positions for all nodes
-        # positions are stored in the networkx graph as a pos attribute
-        posNodes = {}
-        posNodeLabels = {}
-        # returns a data dictionary
-        for nId, nData in self.networkxGraph.nodes(data=True):
-            posNodes[nId] = nData['pos']
-            # shift labels off center of nodes
-            posNodeLabels[nId] = (nData['pos'][0] + 0.125, nData['pos'][1])
-
-        # environLocal.printDebug(['get position', posNodes])
-        # posNodes = networkx.spring_layout(self.networkxGraph, weighted=True)
-        # draw nodes
-        networkx.draw_networkx_nodes(self.networkxGraph, posNodes,
-                                     node_size=300, ax=subplot, node_color='#605C7F', alpha=0.5)
-
-        for (u, v, d) in self.networkxGraph.edges(data=True):
-            environLocal.printDebug(['GraphNetworkxGraph', (u, v, d)])
-            # print(u,v,d)
-            # adding one at a time to permit individual alpha settings
-            edgelist = [(u, v)]
-            networkx.draw_networkx_edges(self.networkxGraph, posNodes, edgelist=edgelist,
-                                         width=2, style=d['style'],
-                                         edge_color='#666666', alpha=d['weight'], ax=subplot)
-
-        # labels
-        networkx.draw_networkx_labels(self.networkxGraph, posNodeLabels,
-                                      font_size=self.labelFontSize,
-                                      font_family=self.fontFamily, font_color='#000000',
-                                      ax=subplot)
-
-        # remove all labels
-        self.setAxisLabel('y', '')
-        self.setAxisLabel('x', '')
-        self.setTicks('y', [])
-        self.setTicks('x', [])
-        # turn off grid
-        self.grid = False
-
 
 class GraphColorGrid(Graph):
     '''
@@ -1848,14 +1761,6 @@ def testGraphVerticalBar(self):
         g.data = data
         g.process()
 
-    def testGraphNetworkxGraph(self):
-        extm = getExtendedModules()
-
-        if extm.networkx is not None:  # pragma: no cover
-            b = GraphNetworkxGraph(doneAction=None)
-            # b = GraphNetworkxGraph()
-            b.process()
-
 
 if __name__ == '__main__':
     import music21

music21/graph/primitives.py

@@ -30,15 +30,15 @@
 
 
 ExtendedModules = namedtuple('ExtendedModules',
-                             ['matplotlib', 'Axes3D', 'collections', 'patches', 'plt', 'networkx'])
+                             ['matplotlib', 'Axes3D', 'collections', 'patches', 'plt'])
 
 
 def getExtendedModules():
     '''
     this is done inside a function, so that the slow import of matplotlib is not done
     in ``from music21 import *`` unless it's actually needed.
 
-    Returns a namedtuple: (matplotlib, Axes3D, collections, patches, plt, networkx)
+    Returns a namedtuple: (matplotlib, Axes3D, collections, patches, plt)
     '''
     if 'matplotlib' in _missingImport:
         raise GraphException(
@@ -62,13 +62,7 @@ def getExtendedModules():
     # from matplotlib.colors import colorConverter
     import matplotlib.pyplot as plt  # type: ignore
 
-    try:
-        # noinspection PyPackageRequirements
-        import networkx  # type: ignore
-    except ImportError:  # pragma: no cover
-        networkx = None  # use for testing
-
-    return ExtendedModules(matplotlib, Axes3D, collections, patches, plt, networkx)
+    return ExtendedModules(matplotlib, Axes3D, collections, patches, plt)
 
 # ------------------------------------------------------------------------------
 

music21/graph/utilities.py

@@ -56,7 +56,7 @@ def showImageThroughMuseScore(
         pngData = base64.b64decode(pngData64)
         # noinspection PyTypeChecker
         display(Image(data=pngData, retina=True))
-        return
+        return None
 
     # hack to make musescore excerpts -- fix with a converter class in MusicXML
     # or make a new keyword to ignoreTitles, etc.
@@ -75,7 +75,7 @@ def showImageThroughMuseScore(
                 multipageWidget=multipageWidget,
                 **keywords,
             )
-        return
+        return None
 
     fp = subConverter.write(
         obj,
@@ -86,7 +86,7 @@ def showImageThroughMuseScore(
     )
 
     if subformats[0] != 'png':
-        return
+        return None
 
     last_png = museScore.findLastPNGPath(fp)
     last_number, num_digits = museScore.findPNGRange(fp, last_png)
@@ -109,7 +109,7 @@ def showImageThroughMuseScore(
     else:
         # multi-page png -- use our widget.
         # noinspection PyPackageRequirements
-        from ipywidgets import interact  # type: ignore
+        from ipywidgets import interact  # type: ignore  # pylint: disable=import-error
 
         @interact(page=(1, last_number))
         def page_display(page=1):

music21/ipython21/converters.py

@@ -141,7 +141,6 @@
     'properties',
 ]
 
-from collections import namedtuple
 from collections.abc import Iterable
 import datetime
 import pathlib
@@ -151,6 +150,7 @@
 
 from music21 import base
 from music21 import common
+from music21.common.types import DocOrder, OffsetQL
 from music21 import defaults
 from music21 import environment
 from music21 import exceptions21
@@ -176,6 +176,13 @@
 from music21.metadata import properties
 from music21.metadata.properties import PropertyDescription
 
+
+if t.TYPE_CHECKING:
+    from music21 import key
+    from music21 import meter
+    from music21 import tempo
+
+
 # -----------------------------------------------------------------------------
 environLocal = environment.Environment('metadata')
 
@@ -2474,8 +2481,14 @@ class RichMetadata(Metadata):
 
     >>> richMetadata.additionalRichMetadataAttributes
     ('ambitus', 'keySignatureFirst', 'keySignatures', 'noteCount', 'numberOfParts',
-     'pitchHighest', 'pitchLowest', 'quarterLength', 'sourcePath', 'tempoFirst',
+     'pitchHighest', 'pitchLowest', 'scoreQuarterLength', 'sourcePath', 'tempoFirst',
      'tempos', 'timeSignatureFirst', 'timeSignatures')
+
+    Changed in v10: renamed `quarterLength` to `scoreQuarterLength`.
+       Because RichMetadata is a Music21Object, `quarterLength` is a property that must
+       return the length of the RichMetadata object itself and should not have been
+       ovewritten
+
     '''
 
     # CLASS VARIABLES #
@@ -2489,7 +2502,7 @@ class RichMetadata(Metadata):
         'numberOfParts',
         'pitchHighest',
         'pitchLowest',
-        'quarterLength',
+        'scoreQuarterLength',
         'sourcePath',
         'tempoFirst',
         'tempos',
@@ -2502,18 +2515,18 @@ class RichMetadata(Metadata):
     def __init__(self, **keywords) -> None:
         super().__init__(**keywords)
         self.ambitus: AmbitusShort|None = None
-        self.keySignatureFirst = None
-        self.keySignatures = []
-        self.noteCount = None
+        self.keySignatureFirst: key.KeySignature|None = None
+        self.keySignatures: list[key.KeySignature] = []
+        self.noteCount: int|None = None
         self.numberOfParts = None
         self.pitchHighest: str|None = None
         self.pitchLowest: str|None = None
-        self.quarterLength = None
+        self.scoreQuarterLength: OffsetQL = 0.0
         self.sourcePath = ''
-        self.tempoFirst = None
-        self.tempos = []
-        self.timeSignatureFirst = None
-        self.timeSignatures = []
+        self.tempoFirst: tempo.TempoIndication|None = None
+        self.tempos: list[tempo.TempoIndication] = []
+        self.timeSignatureFirst: meter.TimeSignature|None = None
+        self.timeSignatures: list[meter.TimeSignature] = []
 
     def _getPluralAttribute(self, attributeName) -> tuple[str, ...]:
         # we have to implement this to add the RichMetadata attributes, since
@@ -2657,7 +2670,7 @@ def update(self, streamObj):
             self.tempoFirst = self.tempos[0]
 
         self.noteCount = len(flat.notesAndRests)
-        self.quarterLength = flat.highestTime
+        self.scoreQuarterLength = flat.highestTime
 
         # commenting out temporarily due to memory error
         # with corpus/beethoven/opus132.xml
@@ -2805,7 +2818,7 @@ def _isStandardUniqueName(self, uniqueName: str) -> bool:
 
 # -----------------------------------------------------------------------------
 # tests are in test/test_metadata
-_DOC_ORDER: list[type] = [Metadata, RichMetadata, AmbitusShort]
+_DOC_ORDER: DocOrder = [Metadata, RichMetadata, AmbitusShort]
 
 
 if __name__ == '__main__':