Add doctests to test suites and fix them

Author: edudobay

mingus/core/chords.py

@@ -396,7 +396,7 @@ def dominant_flat_ninth(note):
     """Build a dominant flat ninth chord on note.
 
     Example:
-    >>> dominant_ninth('C')
+    >>> dominant_flat_ninth('C')
     ['C', 'E', 'G', 'Bb', 'Db']
     """
     res = dominant_ninth(note)
@@ -408,7 +408,7 @@ def dominant_sharp_ninth(note):
     """Build a dominant sharp ninth chord on note.
 
     Example:
-    >>> dominant_ninth('C')
+    >>> dominant_sharp_ninth('C')
     ['C', 'E', 'G', 'Bb', 'D#']
     """
     res = dominant_ninth(note)
@@ -953,11 +953,11 @@ def determine_triad(triad, shorthand=False, no_inversions=False, placeholder=Non
 
     Examples:
     >>> determine_triad(['A', 'C', 'E'])
-    'A minor triad'
+    ['A minor triad', 'C major sixth, second inversion']
     >>> determine_triad(['C', 'E', 'A'])
-    'A minor triad, first inversion'
+    ['C major sixth', 'A minor triad, first inversion']
     >>> determine_triad(['A', 'C', 'E'], True)
-    'Am'
+    ['Am', 'CM6']
     """
     if len(triad) != 3:
         # warning: raise exception: not a triad
@@ -1031,7 +1031,7 @@ def determine_seventh(
 
     Example:
     >>> determine_seventh(['C', 'E', 'G', 'B'])
-    ['C major seventh']
+    ['C major seventh', 'Em|CM']
     """
     if len(seventh) != 4:
         # warning raise exception: seventh chord is not a seventh chord

mingus/core/intervals.py

@@ -66,7 +66,7 @@ def unison(note, key=None):
     >>> unison('C')
     'C'
     """
-    return interval(key, note, 0)
+    return interval(note, note, 0)
 
 
 def second(note, key):

mingus/core/meter.py

@@ -55,9 +55,11 @@ def is_compound(meter):
 
     Examples:
     >>> is_compound((3,4))
-    True
+    False
     >>> is_compound((4,4))
     False
+    >>> is_compound((6,8))
+    True
     """
     return is_valid(meter) and meter[0] % 3 == 0 and 6 <= meter[0]
 

mingus/core/value.py

@@ -1,5 +1,3 @@
-# -*- coding: utf-8 -*-
-
 #    mingus - Music theory Python package, value module.
 #    Copyright (C) 2008-2009, Bart Spaans, Javier Palanca
 #
@@ -36,7 +34,7 @@
 
 Medieval backwards compatibility privided.
 """
-from __future__ import absolute_import
+from __future__ import absolute_import, division
 from six.moves import range
 
 longa = 0.25
@@ -156,12 +154,12 @@ def dots(value, nr=1):
     thirty second notes.
 
     Examples:
-    >>> dots(eighth)
-    5.3333333333333333
-    >>> dots(eighth, 2)
-    4.5714285714285712
-    >>> dots(quarter)
-    2.6666666666666665
+    >>> round(dots(eighth), 6)
+    5.333333
+    >>> round(dots(eighth, 2), 6)
+    4.571429
+    >>> round(dots(quarter), 6)
+    2.666667
     """
     return (0.5 * value) / (1.0 - 0.5 ** (nr + 1))
 
@@ -174,9 +172,9 @@ def triplet(value):
 
     Examples:
     >>> triplet(eighth)
-    12
+    12.0
     >>> triplet(4)
-    6
+    6.0
     """
     return tuplet(value, 3, 2)
 
@@ -189,9 +187,9 @@ def quintuplet(value):
 
     Examples:
     >>> quintuplet(8)
-    10
+    10.0
     >>> quintuplet(4)
-    5
+    5.0
     """
     return tuplet(value, 5, 4)
 
@@ -211,9 +209,9 @@ def septuplet(value, in_fourths=True):
 
     Examples:
     >>> septuplet(8)
-    14
+    14.0
     >>> septuplet(8, False)
-    7
+    7.0
     """
     if in_fourths:
         return tuplet(value, 7, 4)
@@ -231,7 +229,7 @@ def tuplet(value, rat1, rat2):
 
     Example:
     >>> tuplet(8, 3, 2)
-    12
+    12.0
     """
     return (rat1 * value) / float(rat2)
 

tests/unit/containers/test_note.py

@@ -1,8 +1,10 @@
 # -*- coding: utf-8 -*-
 from __future__ import absolute_import
 
+import doctest
 import unittest
 
+import mingus.containers.note
 from mingus.containers.mt_exceptions import NoteFormatError
 from mingus.containers.note import Note
 
@@ -136,3 +138,8 @@ def test_invalid_velocity(self):
             Note("A", 4, {"velocity": 200})
         with self.assertRaises(ValueError):
             Note("A", 4, {"velocity": -1})
+
+
+def load_tests(loader, tests, ignore):
+    tests.addTests(doctest.DocTestSuite(mingus.containers.note))
+    return tests

tests/unit/containers/test_track.py

@@ -1,8 +1,9 @@
-# -*- coding: utf-8 -*-
 from __future__ import absolute_import
 
+import doctest
 import unittest
 
+import mingus.containers.track
 from mingus.containers.instrument import Instrument, Piano, Guitar
 from mingus.containers.track import Track
 
@@ -26,3 +27,8 @@ def test_transpose(self):
         s + "E"
         s + "G#"
         self.assertEqual(s, t)
+
+
+def load_tests(loader, tests, ignore):
+    tests.addTests(doctest.DocTestSuite(mingus.containers.note))
+    return tests

tests/unit/core/test_chords.py

@@ -1,12 +1,10 @@
 from __future__ import absolute_import
 
-# -*- coding: utf-8 -*-
-import sys
+import doctest
+import unittest
 
-sys.path = ["../"] + sys.path
 import mingus.core.chords as chords
-from mingus.core.mt_exceptions import RangeError, FormatError, NoteFormatError
-import unittest
+from mingus.core.mt_exceptions import FormatError, NoteFormatError
 
 
 class test_chords(unittest.TestCase):
@@ -468,3 +466,8 @@ def test_determine_polychord(self):
             lambda x: chords.determine_polychords(x, True),
             "polychord naming",
         )
+
+
+def load_tests(loader, tests, ignore):
+    tests.addTests(doctest.DocTestSuite(chords))
+    return tests

tests/unit/core/test_intervals.py

@@ -1,6 +1,6 @@
-# -*- coding: utf-8 -*-
 from __future__ import absolute_import
 
+import doctest
 import unittest
 
 import mingus.core.intervals as intervals
@@ -394,3 +394,8 @@ def test_is_dissonant(self):
         self.assertTrue(intervals.is_dissonant("C", "F#"))
         self.assertTrue(intervals.is_dissonant("C", "Bb"))
         self.assertTrue(intervals.is_dissonant("C", "B"))
+
+
+def load_tests(loader, tests, ignore):
+    tests.addTests(doctest.DocTestSuite(intervals))
+    return tests

tests/unit/core/test_keys.py

@@ -1,6 +1,6 @@
-# -*- coding: utf-8 -*-
 from __future__ import absolute_import
 
+import doctest
 import unittest
 
 import mingus.core.keys as keys
@@ -68,3 +68,8 @@ def test_relative_minor(self):
                 "The minor of %s is not %s, expecting %s"
                 % (k, keys.relative_minor(k), known[k]),
             )
+
+
+def load_tests(loader, tests, ignore):
+    tests.addTests(doctest.DocTestSuite(keys))
+    return tests

tests/unit/core/test_meter.py

@@ -1,6 +1,6 @@
-# -*- coding: utf-8 -*-
 from __future__ import absolute_import
 
+import doctest
 import unittest
 
 from six.moves import range
@@ -95,3 +95,8 @@ def test_is_asymmetrical(self):
 
     def test_is_full(self):
         pass
+
+
+def load_tests(loader, tests, ignore):
+    tests.addTests(doctest.DocTestSuite(meter))
+    return tests