lint and fraction

Author: mscuthbert

documentation/source/developerReference/developerGuidelines.ipynb

@@ -145,14 +145,17 @@
     "Conventions:\n",
     "\n",
     "  - **Strings MUST be 'single-quoted', but \"double quotes\" are allowed internally**\n",
-    "    - This rule applies to triple quotes and doc strings also, contrary to PEP 257.\n",
-    "    - Docstrings must begin and end on their own lines.  No one-line doc-strings or text\n",
+    "    - This rule applies to triple quotes and docstrings also, contrary to PEP 257.\n",
+    "    - Docstrings must begin and end on their own lines.  No one-line docstrings or text\n",
     "      immediately following the triple quotes.\n",
     "    - When there is a hyphen or single quote in the string, double quotes should be used,\n",
     "      not escaping/backslashing.\n",
     "    - For long streams of TinyNotation or Lilypond code, which both use single quotes to indicate octave,\n",
     "       triple single quotes around the string are better than double quotes.  Internal whitespace\n",
     "       rarely matters in those formats.\n",
+    "    - Before v10 concatenating strings without a plus sign was discouraged. I've changed my mind,\n",
+    "       and am \"letting Python be Python\" now especially when three or more lines are involved.\n",
+    "       However, use a + sign if concatenation is mixed with different comma-separated arguments.\n",
     "    - Documentation should follow quoting in American English grammar when not\n",
     "       discussing code.  So for instance, a quotation in documentation is in double quotes.\n",
     "  - Variable names:\n",
@@ -163,7 +166,8 @@
     "  - Line lengths are capped at 100, but if approaching this limit, look for ways to avoid one-lining.\n",
     "    - if it's easy to split your line into two which are both under 80 characters, do so.\n",
     "  - Line continuation characters (`\\`) are not allowed; use open parentheses.\n",
-    "  - Prefer f-strings to `.format()`.  The `%` interpolation is no longer allowed.\n",
+    "  - Greatly prefer f-strings to `.format()`.  The `%` interpolation is no longer allowed.\n",
+    "    - `.format()` is only to be used when a repeated format string is involved.\n",
     "  - Annotating types is **required** in new code, and encouraged to be added to older code.\n",
     "    - e.g. `self.counter: int = 0` or `def makeNoises() -> list['noise.Noise']:`\n",
     "    - The typing library should always be imported as `t`.\n",
@@ -193,7 +197,8 @@
     "      manipulation of the original object.  When `inPlace` is True, nothing should be returned\n",
     "      (not true for `music21j` since passing through objects is so expected in JavaScript thanks\n",
     "      to JQuery and other libraries).  Use the `@overload` decorator to show how this parameter\n",
-    "      affects the return value -- Python makes this a bit hard, but see for instance, :meth:`~music21.stream.base.Stream.getElementsByClass` for an example of how to use this.\n",
+    "      affects the return value -- Python makes this a bit hard, but see for\n",
+    "      instance, :meth:`~music21.stream.base.Stream.getElementsByClass` for an example of how to use this.\n",
     "  - Use descriptive pull request titles (rather than GitHub's default \"Update pitch.py\")\n",
     "    - Do not have a PR title so long that it cannot be seen in one line.  Simplify and\n",
     "      rewrite and go into more detail in the description.  I depend on skimming PR titles\n",

music21/abcFormat/__init__.py

@@ -2621,7 +2621,7 @@ def tokenProcess(self) -> None:
                 else:
                     environLocal.printDebug(
                         ['broken rhythm marker '
-                         + f'({token.src}) not positioned between two notes or chords'])
+                         f'({token.src}) not positioned between two notes or chords'])
 
             # need to update tuplets with currently active meter
             if isinstance(token, ABCTuplet):
@@ -2698,7 +2698,7 @@ def tokenProcess(self) -> None:
                 if lastDefaultQL is None:
                     raise ABCHandlerException(
                         'no active default note length provided for note processing. '
-                        + f'tPrev: {tPrev}, token: {token}, tNext: {tNext}'
+                        f'tPrev: {tPrev}, token: {token}, tNext: {tNext}'
                     )
                 token.activeDefaultQuarterLength = lastDefaultQL
                 token.activeKeySignature = lastKeySignature

music21/analysis/correlate.py

@@ -131,7 +131,7 @@ def pitchToDynamic(self, dataPoints=True):
             dstCheck = self.streamObj.recurse().getElementsByClass(objName)
             if not dstCheck:
                 raise CorrelateException('cannot create correlation: an object '
-                                         + f'that is not found in the Stream: {objName}')
+                                         f'that is not found in the Stream: {objName}')
 
         self._findActive(objNameSrc, objNameDst)
 

music21/analysis/reduction.py

@@ -1095,7 +1095,7 @@ def _matchWeightedData(self, match, target):
                     dataMatch[2],
                     dataTarget[2],
                     msg=(f'for partId {partId}, entry {i}: '
-                         + f'should be {dataMatch[2]} <-> was {dataTarget[2]}')
+                         f'should be {dataMatch[2]} <-> was {dataTarget[2]}')
                 )
 
     def testPartReductionB(self, show=False):

music21/audioSearch/__init__.py

@@ -140,7 +140,7 @@ def autocorrelationFunction(recordedSignal, recordSampleRateIn):
         # len(_missingImport) > 0:
         raise AudioSearchException(
             'Cannot run autocorrelationFunction without '
-            + f'numpy installed (scipy recommended).  Missing {bmi}')
+            f'numpy installed (scipy recommended).  Missing {bmi}')
     import numpy
     convolve = None
     try:

music21/base.py

@@ -245,7 +245,7 @@ class Groups(list):  # no need to inherit from slotted object
     def _validName(self, value: str) -> None:
         if not isinstance(value, str):
             raise exceptions21.GroupException('Only strings can be used as group names, '
-                                              + f'not {value!r}')
+                                              f'not {value!r}')
         # if ' ' in value:
         #     raise exceptions21.GroupException('Spaces are not allowed as group names')
 
@@ -2110,7 +2110,7 @@ def contextSites(
             memo.add(siteObj)
             environLocal.printDebug(
                 f'looking in contextSites for {siteObj}'
-                + f' with position {positionInStream.shortRepr()}')
+                f' with position {positionInStream.shortRepr()}')
             for topLevel, inStreamPos, recurType in siteObj.contextSites(
                 callerFirst=callerFirst,
                 memo=memo,
@@ -2144,7 +2144,7 @@ def contextSites(
             for derivedObject in topLevel.derivation.chain():
                 environLocal.printDebug(
                     'looking now in derivedObject, '
-                    + f'{derivedObject} with offsetAppend {offsetAppend}')
+                    f'{derivedObject} with offsetAppend {offsetAppend}')
                 for derivedCsTuple in derivedObject.contextSites(
                         callerFirst=None,
                         memo=memo,
@@ -2441,7 +2441,7 @@ def _setActiveSite(self, site: stream.Stream|None):
             except SitesException as se:
                 raise SitesException(
                     'activeSite cannot be set for '
-                    + f'object {self} not in the Stream {site}'
+                    f'object {self} not in the Stream {site}'
                 ) from se
 
             self._activeSiteStoredOffset = storedOffset
@@ -3219,7 +3219,7 @@ def splitAtQuarterLength(
         if quarterLength > self.duration.quarterLength:
             raise DurationException(
                 f'cannot split a duration ({self.duration.quarterLength}) '
-                + f'at this quarterLength ({quarterLength})'
+                f'at this quarterLength ({quarterLength})'
             )
 
         if retainOrigin is True:
@@ -3379,8 +3379,8 @@ def splitByQuarterLengths(
         if opFrac(sum(quarterLengthList)) != self.duration.quarterLength:
             raise Music21ObjectException(
                 'cannot split by quarter length list whose sum is not '
-                + 'equal to the quarterLength duration of the source: '
-                + f'{quarterLengthList}, {self.duration.quarterLength}'
+                'equal to the quarterLength duration of the source: '
+                f'{quarterLengthList}, {self.duration.quarterLength}'
             )
 
         # if nothing to do

music21/braille/basic.py

@@ -204,7 +204,7 @@ def chordToBraille(music21Chord, descending=True, showOctave=True):
         except KeyError:
             environRules.warn(
                 f'Accidental {currentPitch.accidental} of '
-                + f'chord {music21Chord} cannot be transcribed to braille.'
+                f'chord {music21Chord} cannot be transcribed to braille.'
             )
         intervalDistance = interval.notesToGeneric(basePitch, currentPitch).undirected
         if intervalDistance > 8:
@@ -1115,7 +1115,7 @@ def timeSigToBraille(m21TimeSignature):
         brailleSig = ''.join(timeSigTrans)
         m21TimeSignature.editorial.brailleEnglish.append(
             f'Time Signature {m21TimeSignature.numerator}/{m21TimeSignature.denominator} '
-            + f'{brailleSig}'
+            f'{brailleSig}'
         )
         return brailleSig
     except (BrailleBasicException, KeyError) as unused_error:  # pragma: no cover

music21/braille/segment.py

@@ -442,9 +442,9 @@ def __str__(self):
             for k, g in zip(allKeys, allGroupings)
         )
         out = '\n'.join(['---begin segment---',
-                          name,
-                          allElementGroupings,
-                          '---end segment---'])
+                         name,
+                         allElementGroupings,
+                         '---end segment---'])
         return out
 
     def transcribe(self):
@@ -1138,8 +1138,10 @@ def __str__(self):
             else:
                 leftFull = ''
             allPairs.append('\n'.join([rightFull, leftFull, '====\n']))
-        out = '\n'.join(['---begin grand segment---', name, ''.join(allPairs),
-                           '---end grand segment---'])
+        out = '\n'.join(['---begin grand segment---',
+                         name,
+                         ''.join(allPairs),
+                         '---end grand segment---'])
         return out
 
     def yieldCombinedGroupingKeys(self):
@@ -1253,10 +1255,10 @@ def matchOther(thisKey_inner, otherKey):
     #                 except ValueError as ve:
     #                     raise BrailleSegmentException(
     #                         'Misaligned braille groupings: '
-    #                         + f'groupingKeyLeft was {gkLeft} '
-    #                         + f'groupingKeyRight was {gkRight} '
-    #                         + f'rightSegment was {rightSegment}, '
-    #                         + f'leftSegment was {leftSegment}'
+    #                         f'groupingKeyLeft was {gkLeft} '
+    #                         f'groupingKeyRight was {gkRight} '
+    #                         f'rightSegment was {rightSegment}, '
+    #                         f'leftSegment was {leftSegment}'
     #                     ) from ve
     #
     #                 try:
@@ -2369,15 +2371,15 @@ def splitMeasure(music21Measure, beatDivisionOffset=0, useTimeSignature=None):
         if abs(beatDivisionOffset) > len(ts.beatDivisionDurations):
             raise BrailleSegmentException(
                 f'beatDivisionOffset {beatDivisionOffset} is outside '
-                + f'of ts.beatDivisionDurations {ts.beatDivisionDurations}'
+                f'of ts.beatDivisionDurations {ts.beatDivisionDurations}'
             )
         duration_index = len(ts.beatDivisionDurations) - abs(beatDivisionOffset)
         try:
             offset += opFrac(ts.beatDivisionDurations[duration_index].quarterLength)
             offset = opFrac(offset)
         except IndexError:
             environRules.warn('Problem in converting a time signature in measure '
-                              + f'{music21Measure.number}, offset may be wrong')
+                              f'{music21Measure.number}, offset may be wrong')
     bs = copy.deepcopy(ts.beatSequence)
 
     numberOfPartitions = 2

music21/clef.py

@@ -858,7 +858,7 @@ def clefFromString(clefString, octaveShift=0) -> Clef:
 
     if lineNum < 1 or lineNum > 5:
         raise ClefException('line number (second character) must be 1-5; do not use this '
-                            + f'function for clefs on special staves such as {xnStr!r}')
+                            f'function for clefs on special staves such as {xnStr!r}')
 
     clefObj: Clef
     if thisType in CLASS_FROM_TYPE:

music21/corpus/chorales.py

@@ -1273,7 +1273,7 @@ def _returnChorale(self, choraleIndex=None):
                 try:
                     nextIndex = self._currentIndex + 1
                     riemenschneiderName = ('bach/choraleAnalyses/'
-                                           + f'riemenschneider{nextIndex:03d}.rntxt')
+                                           f'riemenschneider{nextIndex:03d}.rntxt')
                     analysis = corpus.parse(riemenschneiderName)
                     if analysis is not None:
                         chorale.insert(0, analysis.parts[0])
@@ -1582,7 +1582,7 @@ def currentNumber(self, value):
                 else:
                     raise BachException(
                         f'{value} does not correspond to a chorale in the '
-                        + f'{self.numberingSystem} numbering system'
+                        f'{self.numberingSystem} numbering system'
                     )
 
         elif self._iterationType == 'index':
@@ -1699,7 +1699,7 @@ def highestNumber(self, value):
                 else:
                     raise BachException(
                         f'{value} does not correspond to a chorale in the '
-                        + f'{self.numberingSystem} numbering system'
+                        f'{self.numberingSystem} numbering system'
                     )
 
     # - Return Type