Merge branch 'master' into pr/1242

Author: mscuthbert

.pylintrc

@@ -62,7 +62,6 @@ disable=
     fixme,  # obviously known
     superfluous-parens,  # nope -- if they make things clearer...
     too-many-statements,  # someday
-    no-member,  # important, but too many false positives
     too-many-arguments,  # definitely! but takes too long to get a fix now...
     too-many-public-methods,  # maybe...
     too-many-branches,  # yes, someday
@@ -273,11 +272,7 @@ ignored-modules=
 
 # List of classes names for which member attributes should not be checked
 # (useful for classes with attributes dynamically set).
-ignored-classes=SQLObject
-
-# When zope mode is activated, add a predefined set of Zope acquired attributes
-# to generated-members.
-# zope=no
+ignored-classes=StreamCore
 
 # List of members which are set dynamically and missed by pylint inference
 # system, and so shouldn't trigger E0201 when accessed. Python regular

music21/base.py

@@ -1910,7 +1910,7 @@ def contextSites(
             callerFirst = self
             if self.isStream and self not in memo:
                 streamSelf = t.cast('music21.stream.Stream', self)
-                recursionType = streamSelf.recursionType
+                recursionType = streamSelf.recursionType  # pylint: disable=no-member
                 environLocal.printDebug(
                     f'Caller first is {callerFirst} with offsetAppend {offsetAppend}')
                 if returnSortTuples:

music21/chord/__init__.py

@@ -177,7 +177,7 @@ def __deepcopy__(self: _ChordBaseType, memo=None) -> _ChordBaseType:
         # after copying, if a Volume exists, it is linked to the old object
         # look at _volume so as not to create object if not already there
         # noinspection PyProtectedMember
-        for d in new._notes:
+        for d in new._notes:  # pylint: disable=no-member
             # if .volume is called, a new Volume obj will be created
             if d.hasVolumeInformation():
                 d.volume.client = new  # update with new instance
@@ -379,6 +379,9 @@ def remove(self, removeItem):
         except ValueError:
             raise ValueError('Chord.remove(x), x not in chord')
 
+    @property
+    def notes(self) -> t.Tuple[note.NotRest, ...]:
+        return ()
 
     @property
     def tie(self):
@@ -5182,7 +5185,7 @@ def multisetCardinality(self):
         return len(self.pitchClasses)
 
     @property
-    def notes(self):
+    def notes(self) -> t.Tuple[note.Note, ...]:
         '''
         Return a tuple (immutable) of the notes contained in the chord.
 
@@ -5244,7 +5247,7 @@ def notes(self):
         return tuple(self._notes)
 
     @notes.setter
-    def notes(self, newNotes):
+    def notes(self, newNotes: t.Iterable[note.Note]) -> None:
         '''
         sets notes to an iterable of Note objects
         '''
@@ -5805,9 +5808,9 @@ def scaleDegrees(self):
         '''
         from music21 import scale
         # roman numerals have this built in as the key attribute
-        if hasattr(self, 'key') and self.key is not None:
+        if hasattr(self, 'key') and self.key is not None:  # pylint: disable=no-member
             # Key is a subclass of scale.DiatonicScale
-            sc = self.key
+            sc = self.key  # pylint: disable=no-member
         else:
             sc = self.getContextByClass(scale.Scale, sortByCreationTime=True)
             if sc is None:

music21/clef.py

@@ -247,8 +247,9 @@ def getStemDirectionForPitches(
             relevantPitches = pitchList
 
         differenceSum = 0
+        # pylint: disable-next=no-member
         if isinstance(self, (PercussionClef, PitchClef)) and self.lowestLine is not None:
-            midLine = self.lowestLine + 4
+            midLine = self.lowestLine + 4  # pylint: disable=no-member
         else:
             midLine = 35  # assume TrebleClef-like.
 

music21/converter/subConverters.py

@@ -357,7 +357,8 @@ def show(self, obj, fmt, app=None, subformats=None, **keywords):  # pragma: no c
             subformats = ['vexflow']
 
         if subformats and subformats[0] == 'vexflow':
-            return self.vfshow(obj)
+            raise NotImplementedError
+            # return self.vfshow(obj)
             # subformats = ['lilypond', 'png']
         if subformats:
             helperFormat = subformats[0]
@@ -1340,7 +1341,7 @@ def parseData(self, strData, number=None):
         from music21.capella import fromCapellaXML
         ci = fromCapellaXML.CapellaImporter()
         ci.parseXMLText(strData)
-        scoreObj = ci.systemScoreFromScore(self.mainDom.documentElement)
+        scoreObj = ci.systemScoreFromScore(ci.mainDom.documentElement)
         partScore = ci.partScoreFromSystemScore(scoreObj)
         self.stream = partScore
 

music21/expressions.py

@@ -1426,6 +1426,93 @@ def numberOfMarks(self, num):
             raise TremoloException('Number of marks must be a number from 0 to 8') from ve
 
 
+class ArpeggioMark(Expression):
+    '''
+    ArpeggioMark must be applied to a Chord (not to a single Note).
+
+    The parameter arpeggioType can be 'normal' (a squiggly line), 'up' (a squiggly line
+    with an up arrow), 'down' (a squiggly line with a down arrow), or 'non-arpeggio' (a
+    bracket instead of a squiggly line, used to indicate a non-arpeggiated chord
+    intervening in a sequence of arpeggiated ones).
+
+    >>> am = expressions.ArpeggioMark('normal')
+    >>> am.type
+    'normal'
+
+    >>> am = expressions.ArpeggioMark('down')
+    >>> am.type
+    'down'
+    '''
+    def __init__(self, arpeggioType: t.Optional[str] = None):
+        super().__init__()
+        if arpeggioType is None:
+            arpeggioType = 'normal'
+        if arpeggioType not in ('normal', 'up', 'down', 'non-arpeggio'):
+            raise ValueError(
+                'Arpeggio type must be "normal", "up", "down", or "non-arpeggio"'
+            )
+        self.type = arpeggioType
+
+
+class ArpeggioMarkSpanner(spanner.Spanner):
+    '''
+    ArpeggioMarkSpanner is a multi-staff or multi-voice (i.e. multi-chord) arpeggio.
+    The spanner should contain all the simultaneous Chords that are to be
+    arpeggiated together.  If there is only one arpeggiated note in a particular staff
+    or voice (i.e. the rest are in other staves/voices), then in that case only the
+    spanner can contain a Note.  Do not ever put a Note that is within a Chord into a
+    spanner; put the Chord in instead.  And do not ever put an ArpeggioMark in a note
+    or chord's .expressions.
+
+    The parameter arpeggioType can be 'normal' (a squiggly line), 'up' (a squiggly line
+    with an up arrow), 'down' (a squiggly line with a down arrow), or 'non-arpeggio' (a
+    bracket instead of a squiggly line, used to indicate a non-arpeggiated multi-chord
+    intervening in a sequence of arpeggiated ones).
+
+    >>> ams = expressions.ArpeggioMarkSpanner(arpeggioType='non-arpeggio')
+    >>> c1 = chord.Chord('C3 E3 G3')
+    >>> c2 = chord.Chord('C4 E4 G4')
+    >>> ams.addSpannedElements([c1, c2])
+    >>> ams.type
+    'non-arpeggio'
+    >>> ams
+    <music21.expressions.ArpeggioMarkSpanner
+     <music21.chord.Chord C3 E3 G3><music21.chord.Chord C4 E4 G4>>
+    '''
+    def __init__(self, *arguments, **keywords):
+        super().__init__(*arguments, **keywords)
+        arpeggioType: t.Optional[str] = keywords.get('arpeggioType', None)
+        if arpeggioType is None:
+            arpeggioType = 'normal'
+        if arpeggioType not in ('normal', 'up', 'down', 'non-arpeggio'):
+            raise ValueError(
+                'Arpeggio type must be "normal", "up", "down", or "non-arpeggio"'
+            )
+        self.type = arpeggioType
+
+    def noteExtremes(self) -> t.Tuple[t.Optional['music21.note.Note'],
+                                      t.Optional['music21.note.Note']]:
+        '''
+        Return the lowest and highest note spanned by the element,
+        extracting them from Chords if need be.
+
+        >>> ch = chord.Chord(['C4', 'E4', 'G4'])
+        >>> n = note.Note('C#3')
+        >>> nonArp = expressions.ArpeggioMarkSpanner([ch, n])
+        >>> nonArp.noteExtremes()
+        (<music21.note.Note C#>, <music21.note.Note G>)
+        '''
+        from music21 import chord
+        from music21 import note
+        notes = []
+        for n_or_ch in self:
+            if isinstance(n_or_ch, note.Note):
+                notes.append(n_or_ch)
+            elif isinstance(n_or_ch, chord.Chord):
+                notes.extend(n_or_ch.notes)
+        return (min(notes), max(notes))
+
+
 # ------------------------------------------------------------------------------
 class Test(unittest.TestCase):
 

music21/features/outputFormats.py

@@ -25,6 +25,9 @@ def getHeaderLines(self):
         '''
         pass  # define in subclass
 
+    def getString(self, includeClassLabel=True, includeId=True, lineBreak=None):
+        pass  # define in subclass
+
     def write(self, fp=None, includeClassLabel=True, includeId=True):
         '''
         Write the file. If not file path is given, a temporary file will be written.

music21/freezeThaw.py

@@ -927,7 +927,7 @@ def open(self, fp, zipType=None):
                     try:
                         storage = pickle.loads(uncompressed)
                     except AttributeError as e:
-                        common.restoreWindowsAfterUnpickling()
+                        common.restorePathClassesAfterUnpickling()
                         raise FreezeThawException(
                             f'Problem in decoding: {e}'
                         ) from e

music21/graph/plot.py

@@ -50,6 +50,10 @@
 from music21 import environment
 environLocal = environment.Environment('graph.plot')
 
+# Graph uses setattr, which PyLint can't infer from currently
+# https://github.com/PyCQA/pylint/issues/2878
+# pylint: disable=no-member
+
 
 # ------------------------------------------------------------------------------
 # graphing utilities that operate on streams

music21/humdrum/questions.py

@@ -270,7 +270,7 @@ def xtest015(self):
             if thisInt.name != "P1":
                 intervals2[thisInt.name] += 1
 
-        for key in intervals2.sort(key='simpleName'):
+        for key in intervals2.keys().sort(key='simpleName'):
             print(key, intervals2[key])
 
     def test016(self):