Merge pull request #1821 from cuthbertLab/init_refactor

Refactor init / RichMD.scoreQuarterLength / rm networkX

Author: mscuthbert

music21/__init__.py

@@ -20,10 +20,10 @@
 
 The development of music21 was supported by grants
 from the Seaver Institute and the NEH/Digging into Data Challenge,
-with the support of the MIT
-Music and Theater Arts section and the School of Humanities, Arts,
-and Social Sciences.  Portions of music21 were originally part of
-the PMusic (Perl) library, developed by Cuthbert prior to arriving at MIT.
+with the support of the MIT Music and Theater Arts section
+and the School of Humanities, Arts, and Social Sciences.
+Portions of music21 were originally part of the PMusic (Perl) library,
+developed by Cuthbert prior to arriving at MIT.
 
 music21 outputs a subset of XML data defined by the MusicXML 4.0
 standard, Copyright © 2004-2022 W3C, open source.
@@ -35,7 +35,7 @@
 
 import sys
 
-minPythonVersion = (3, 10)
+minPythonVersion = (3, 11)
 minPythonVersionStr = '.'.join([str(x) for x in minPythonVersion])
 if sys.version_info < minPythonVersion:
     # DO NOT CHANGE THIS TO AN f-String -- it needs to run on old python.
@@ -48,6 +48,7 @@
     Use music21 v6.7 to run on Python 3.6.
     Use music21 v7.3 to run on Python 3.7
     Use music21 v8.1 to run on Python 3.8/3.9
+    Use music21 v9.9 to run on Python 3.10.
 
     If you have the wrong version there are several options for getting
     the right one.
@@ -273,4 +274,3 @@
 from music21 import voiceLeading  # noqa: E402
 from music21 import volpiano  # noqa: E402
 from music21 import volume  # noqa: E402
-

music21/abcFormat/__init__.py

@@ -48,18 +48,35 @@
 from __future__ import annotations
 
 __all__ = [
-    'translate',
-    'testFiles',
-    'ABCTokenException', 'ABCHandlerException', 'ABCFileException',
+    'ABCAccent',
+    'ABCBar',
+    'ABCBrokenRhythmMarker',
+    'ABCChord',
+    'ABCCrescStart',
+    'ABCDimStart',
+    'ABCDownbow',
+    'ABCFile',
+    'ABCFileException',
+    'ABCGraceStart',
+    'ABCGraceStop',
+    'ABCHandler',
+    'ABCHandlerBar',
+    'ABCHandlerException',
+    'ABCMetadata',
+    'ABCNote',
+    'ABCParenStop',
+    'ABCSlurStart',
+    'ABCStaccato',
+    'ABCStraccent',
+    'ABCTenuto',
+    'ABCTie',
     'ABCToken',
-    'ABCMetadata', 'ABCBar', 'ABCTuplet', 'ABCTie',
-    'ABCSlurStart', 'ABCParenStop', 'ABCCrescStart', 'ABCDimStart',
-    'ABCStaccato', 'ABCUpbow', 'ABCDownbow', 'ABCAccent', 'ABCStraccent',
-    'ABCTenuto', 'ABCGraceStart', 'ABCGraceStop', 'ABCBrokenRhythmMarker',
-    'ABCNote', 'ABCChord',
-    'ABCHandler', 'ABCHandlerBar',
+    'ABCTokenException',
+    'ABCTuplet',
+    'ABCUpbow',
     'mergeLeadingMetaData',
-    'ABCFile',
+    'testFiles',
+    'translate',
 ]
 
 from collections.abc import Sequence

music21/analysis/__init__.py

@@ -2,12 +2,23 @@
 from __future__ import annotations
 
 __all__ = [
-    'correlate', 'discrete', 'elements', 'enharmonics',
-    'floatingKey', 'harmonicFunction', 'metrical', 'neoRiemannian',
-    'patel', 'pitchAnalysis',
-    'reduceChords', 'reduceChordsOld', 'reduction', 'segmentByRests',
-    'transposition', 'windowed',
     'AnalysisException',
+    'correlate',
+    'discrete',
+    'elements',
+    'enharmonics',
+    'floatingKey',
+    'harmonicFunction',
+    'metrical',
+    'neoRiemannian',
+    'patel',
+    'pitchAnalysis',
+    'reduceChords',
+    'reduceChordsOld',
+    'reduction',
+    'segmentByRests',
+    'transposition',
+    'windowed',
 ]
 
 # this is necessary to get these names available with a

music21/audioSearch/__init__.py

@@ -19,21 +19,26 @@
 from __future__ import annotations
 
 __all__ = [
-    'transcriber', 'recording', 'scoreFollower',
-    'histogram', 'autocorrelationFunction',
-    'prepareThresholds', 'interpolation',
-    'normalizeInputFrequency', 'pitchFrequenciesToObjects',
-    'getFrequenciesFromMicrophone',
+    'AudioSearchException',
+    'autocorrelationFunction',
+    'decisionProcess',
+    'detectPitchFrequencies',
     'getFrequenciesFromAudioFile',
+    'getFrequenciesFromMicrophone',
     'getFrequenciesFromPartialAudioFile',
-    'detectPitchFrequencies',
-    'smoothFrequencies',
+    'histogram',
+    'interpolation',
     'joinConsecutiveIdenticalPitches',
+    'normalizeInputFrequency',
+    'notesAndDurationsToStream',
+    'pitchFrequenciesToObjects',
+    'prepareThresholds',
     'quantizeDuration',
     'quarterLengthEstimation',
-    'notesAndDurationsToStream',
-    'decisionProcess',
-    'AudioSearchException',
+    'recording',
+    'scoreFollower',
+    'smoothFrequencies',
+    'transcriber',
 ]
 
 import copy

music21/beam.py

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

music21/chord/__init__.py

@@ -15,15 +15,23 @@
 '''
 from __future__ import annotations
 
-__all__ = ['tools', 'tables', 'Chord', 'ChordException', 'fromIntervalVector', 'fromForteClass']
+__all__ = [
+    'Chord',
+    'ChordBase',
+    'ChordException',
+    'fromForteClass',
+    'fromIntervalVector',
+    'tables',
+    'tools',
+]
 
 from collections.abc import Iterable, Sequence
 import copy
 import typing as t
-from typing import overload  # pycharm bug
+# pycharm bug - need to import overload separately. typing.overload doesn't work
+from typing import overload
 import unittest
 
-from music21 import beam
 from music21 import common
 from music21.common.decorators import cacheMethod
 from music21 import derivation
@@ -42,7 +50,6 @@
 
 if t.TYPE_CHECKING:
     from music21 import stream
-    from music21.style import Style
 
 environLocal = environment.Environment('chord')
 
@@ -468,7 +475,7 @@ def volume(self) -> 'music21.volume.Volume':  # do NOT change to volume.Volume,
 
 
     @volume.setter
-    def volume(self, expr: None|'music21.volume.Volume'|int|float):
+    def volume(self, expr: 'None|music21.volume.Volume|int|float'):
         # Do NOT change typing to volume.Volume  w/o quotes because it will take the property as
         # its name and be really confused.
         if isinstance(expr, volume.Volume):
@@ -4072,8 +4079,7 @@ def semiClosedPosition(
             c2 = self
 
         if t.TYPE_CHECKING:
-            from music21.stream import Stream
-            assert isinstance(c2, Stream)
+            assert isinstance(c2, stream.Stream)
         # startOctave = c2.bass().octave
         remainingPitches = copy.copy(c2.pitches)  # no deepcopy needed
 
@@ -6134,8 +6140,7 @@ def testCopyAndDeepcopy(self):
         testCopyAll(self, globals())
 
 
-
-_DOC_ORDER = [Chord]
+_DOC_ORDER = [Chord, ChordBase, fromForteClass, fromIntervalVector]
 
 
 if __name__ == '__main__':

music21/common/__init__.py

@@ -34,12 +34,11 @@
     'objects',
     'pathTools',
     'parallel',
+    'stringTools',
     'types',
     'weakrefTools',
 ]
 
-from music21 import defaults
-from music21 import exceptions21
 from music21.common.classTools import *  # including isNum, isListLike
 from music21.common.decorators import *  # gives the deprecated decorator
 from music21.common.enums import *

music21/corpus/__init__.py

@@ -36,41 +36,43 @@
 >>> cb[0].parse()
 <music21.stream.Score airdsAirs/book1.abc>
 '''
+
 from __future__ import annotations
 from collections.abc import Iterable
 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
-from music21.exceptions21 import CorpusException
 
 __all__ = [
-    'chorales', 'corpora', 'manager',
-    # virtual
-    'work',
-    'parse',
-    'getCorePaths',
-    # 'getVirtualPaths',
-    'getLocalPaths',
+    'CorpusException',
     'addPath',
-    'getPaths',
     'cacheMetadata',
+    'chorales',
+    'corpora',
     'getComposer',
-    'noCorpus',
+    'getCorePaths',
+    'getLocalPaths',
+    'getPaths',
+    # 'getVirtualPaths',
     'getWork',
-
+    'manager',
+    'noCorpus',
+    'parse',
+    # virtual
+    'search',
+    'work',
 ]
 
-
 if t.TYPE_CHECKING:
     import pathlib
 

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()