Merge pull request #214 from kneasle/different-py-version

kneasle · web-flow · commit b24bf0b9fdd5 · 2023-02-21T21:28:03.000Z
Test Python 3.6, 3.8, 3.11 on CI
diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml
@@ -19,7 +19,7 @@ jobs:
       fail-fast: false
       matrix:
         os: [ubuntu-20.04, windows-latest]
-        python-version: [3.6, 3.9]
+        python-version: [3.6, 3.8, 3.11]
 
     steps:
       - uses: actions/checkout@v1
diff --git a/.pylintrc b/.pylintrc
@@ -1,6 +1,7 @@
 [MESSAGES CONTROL]
 
 disable=broad-except,len-as-condition,logging-fstring-interpolation,logging-not-lazy,unexpected-line-ending-format,duplicate-code
+load-plugins=pylint.extensions.no_self_use
 
 [FORMAT]
 
diff --git a/doctests.py b/doctests.py
@@ -160,7 +160,7 @@ def main():
         return
 
     print("ERRORS FOUND:")
-    for (location, command, e) in errors:
+    for location, command, e in errors:
         print("\n")
         print(f" >>> {location}: {command}")
 
diff --git a/requirements.txt b/requirements.txt
@@ -1,16 +1,23 @@
+black==22.8.0
 certifi==2022.12.7
-chardet==3.0.4
-idna==2.9
-numpy==1.23.4; python_version >= '3.8'
+chardet==5.0.0
+idna==3.4
+numpy==1.24.2; python_version >= '3.8'
 numpy==1.19.5; python_version < '3.8'
-mypy==0.790
-mypy-extensions==0.4.3
-pylint==2.8.3
-pytest==5.4.3
-black==21.4b1
+mypy==1.0.1; python_version >= '3.8'
+mypy-extensions==1.0.0; python_version >= '3.8'
+mypy==0.790; python_version < '3.8'
+mypy-extensions==0.4.3; python_version < '3.8'
+pylint==2.16.2; python_version >= '3.8'
+pylint==2.13.9; python_version < '3.8'
+pytest==7.2.1; python_version >= '3.8'
+pytest==7.0.1; python_version < '3.8'
 python-engineio==3.14.2
 python-socketio==4.6.1
-requests==2.25.0
-six==1.15.0
-urllib3==1.26.5
-websocket-client==0.57.0
+requests==2.27.1
+six==1.16.0
+types-requests==2.28.11.14
+types-urllib3==1.26.25.7
+urllib3==1.26.14
+websocket-client==1.5.1; python_version >= '3.8'
+websocket-client==1.3.1; python_version < '3.8'
diff --git a/run-checks.py b/run-checks.py
@@ -4,7 +4,9 @@
 
 import mypy.api
 import pytest
-from pylint import epylint as lint
+from io import StringIO
+from pylint.lint import Run as run_pylint
+from pylint.reporters.text import TextReporter
 import sys
 
 import doctests
@@ -78,13 +80,18 @@ def __exit__(self, exc_type, exc_val, exc_tb):
 if run_all or parsed_args.lint:
     with Check("Linting"):
         print("python -m pylint wheatley")
-        pylint_args = "wheatley"
+        pylint_args = ["wheatley"]
         if os.name != "nt":
-            pylint_args += " --enable=unexpected-line-ending-format"
-        (pylint_stdout, pylint_stderr) = lint.py_run(pylint_args, return_std=True)
-        output = pylint_stdout.getvalue()
+            pylint_args.append("--enable=unexpected-line-ending-format")
+
+        # Custom open stream
+        pylint_output = StringIO()
+        reporter = TextReporter(pylint_output)
+
+        run_pylint(pylint_args, reporter=reporter, exit=False)
+
+        output = pylint_output.getvalue()
         print(output)
-        print(pylint_stderr.getvalue(), file=sys.stderr)
         success = output.find("Your code has been rated at 10")
         if success == -1:
             exit(1)
diff --git a/setup.py b/setup.py
@@ -27,8 +27,8 @@
     ],
     python_requires=">=3.6",
     install_requires=[
-        'numpy<=1.19.3; platform_system == "Windows"',
-        'numpy; platform_system != "Windows"',
+        'numpy==1.19.5; python_version < "3.8"',
+        'numpy; python_version >= "3.8"',
         "requests",
         "python-socketio<5",
         "python-engineio<4",
diff --git a/tests/row_generation/test_ComplibCompositionRowGenerator.py b/tests/row_generation/test_ComplibCompositionRowGenerator.py
@@ -7,7 +7,7 @@
 
 class CompLibGeneratorTests(TestCase):
     def test_comp_fetching(self):
-        for (url, expected_title) in [
+        for url, expected_title in [
             ("complib.org/composition/62355", "5040 Plain Bob Major by Ben White-Horne"),
             ("www.complib.org/composition/62355", "5040 Plain Bob Major by Ben White-Horne"),
             ("https://www.complib.org/composition/71994", "110 2-Spliced Major"),
diff --git a/tests/row_generation/test_Helpers.py b/tests/row_generation/test_Helpers.py
@@ -73,7 +73,7 @@ def test_convert_pn(self):
             (".-.-.1.-.2", [_CROSS_PN, _CROSS_PN, [1], _CROSS_PN, [2]]),
         ]
 
-        for (input_pn, expected_output_pn) in test_cases:
+        for input_pn, expected_output_pn in test_cases:
             with self.subTest(input_pn=input_pn, expected_output_pn=expected_output_pn):
                 self.assertEqual(convert_pn(input_pn), expected_output_pn)
 
diff --git a/tests/row_generation/test_MethodPlaceNotationGenerator.py b/tests/row_generation/test_MethodPlaceNotationGenerator.py
@@ -86,7 +86,7 @@ def test_grandsire__all_stages_above_4(self):
             ("Grandsire Maximus", 12),
         ]
 
-        for (method_title, expected_stage) in test_cases:
+        for method_title, expected_stage in test_cases:
             with self.subTest(method_title=method_title, expected_stage=expected_stage):
                 generator = generator_from_special_title(method_title)
                 self.assertIsInstance(generator, PlaceNotationGenerator)
@@ -112,7 +112,7 @@ def test_stedman__odd_stages(self):
             ("Stedman Cinques", 11),
         ]
 
-        for (method_title, expected_stage) in test_cases:
+        for method_title, expected_stage in test_cases:
             with self.subTest(method_title=method_title, expected_stage=expected_stage):
                 generator = generator_from_special_title(method_title)
                 self.assertIsInstance(generator, PlaceNotationGenerator)
@@ -149,7 +149,7 @@ def test_plain_hunt__all_stages(self):
             ("Plain Hunt Maximus", 12),
         ]
 
-        for (method_title, expected_stage) in test_cases:
+        for method_title, expected_stage in test_cases:
             with self.subTest(method_title=method_title, expected_stage=expected_stage):
                 generator = generator_from_special_title(method_title)
                 self.assertIsInstance(generator, PlainHuntGenerator)
diff --git a/tests/test_parsing.py b/tests/test_parsing.py
@@ -27,7 +27,7 @@ def test_peal_speed_parsing(self):
             (" 2 h 30 m ", 150),
         ]
 
-        for (input_arg, expected_minutes) in test_cases:
+        for input_arg, expected_minutes in test_cases:
             with self.subTest(input=input_arg, expected_minutes=expected_minutes):
                 self.assertEqual(expected_minutes, parse_peal_speed(input_arg))
 
@@ -47,7 +47,7 @@ def test_peal_speed_parsing_errors(self):
             ("\nXX   X ", "The minute value 'XX   X' is not an integer."),
         ]
 
-        for (input_arg, expected_message) in test_cases:
+        for input_arg, expected_message in test_cases:
             with self.subTest(input=input_arg, expected_message=expected_message):
                 with self.assertRaises(PealSpeedParseError) as e:
                     parse_peal_speed(input_arg)
@@ -62,7 +62,7 @@ def test_call_parsing(self):
             ("20: 70/ 14", {20: "70", 0: "14"}),
         ]
 
-        for (input_arg, expected_call_dict) in test_cases:
+        for input_arg, expected_call_dict in test_cases:
             with self.subTest(input=input_arg, expected_call_dict=expected_call_dict):
                 self.assertEqual(CallDef(expected_call_dict), parse_call(input_arg))
 
@@ -75,7 +75,7 @@ def test_call_parsing_errors(self):
             (":::  /", "Call specification ':::' should contain at most one ':'."),
         ]
 
-        for (input_arg, expected_message) in test_cases:
+        for input_arg, expected_message in test_cases:
             with self.subTest(input=input_arg, expected_message=expected_message):
                 with self.assertRaises(CallParseError) as e:
                     parse_call(input_arg)
@@ -84,7 +84,7 @@ def test_call_parsing_errors(self):
     def test_place_notation_parsing(self):
         test_cases = [("5:5.1.5.1.5", (5, "5.1.5.1.5")), ("6:x16,12", (6, "x16,12"))]
 
-        for (input_arg, expected_tuple) in test_cases:
+        for input_arg, expected_tuple in test_cases:
             with self.subTest(input=input_arg, expected_tuple=expected_tuple):
                 self.assertEqual(expected_tuple, parse_place_notation(input_arg))
 
@@ -95,7 +95,7 @@ def test_place_notation_parsing_errors(self):
             ("6:z16x16x16,12", "Place notation is invalid"),
         ]
 
-        for (input_arg, expected_message) in test_cases:
+        for input_arg, expected_message in test_cases:
             with self.subTest(input=input_arg, expected_message=expected_message):
                 with self.assertRaises(PlaceNotationError) as e:
                     parse_place_notation(input_arg)
@@ -196,7 +196,7 @@ def test_url_conversion_errors(self):
     def test_parse_start_row(self):
         test_cases = [("654321", 6), ("1", 1)]
 
-        for (input_arg, expected_output) in test_cases:
+        for input_arg, expected_output in test_cases:
             with self.subTest(input=input_arg, expected_output=expected_output):
                 output = parse_start_row(input_arg)
                 self.assertEqual(output, expected_output)
@@ -209,7 +209,7 @@ def test_parse_start_row_errors(self):
             ("654326", "Start row contains bell 6 mutiple times"),
         ]
 
-        for (input_arg, expected_message) in test_cases:
+        for input_arg, expected_message in test_cases:
             with self.subTest(input=input_arg, expected_message=expected_message):
                 with self.assertRaises(StartRowParseError) as e:
                     parse_start_row(input_arg)
diff --git a/wheatley/bot.py b/wheatley/bot.py
@@ -258,10 +258,13 @@ def look_to_has_been_called(self, call_time: float) -> None:
         """Callback called when a user calls 'Look To'."""
         self._rhythm.return_to_mainloop()
 
-        treble = self._rounds[0]
+        # Pylint doesn't seem to understand "Row" is a list here
+        treble = self._rounds[0]  # pylint: disable=unsubscriptable-object
 
         # Count number of user controlled bells
-        number_of_user_controlled_bells = sum(1 for bell in self._rounds if self._user_assigned_bell(bell))
+        number_of_user_controlled_bells = sum(
+            1 for bell in self._rounds if self._user_assigned_bell(bell)  # pylint: disable=not-an-iterable
+        )
 
         self._rhythm.initialise_line(
             self.number_of_bells,
@@ -316,7 +319,7 @@ def _on_go(self) -> None:
             # because the rows on which these calls should have been called have already passed.
             # Therefore, we simply get them out as quickly as possible so they have the best chance
             # of being heard.
-            for (_, c) in early_calls:
+            for _, c in early_calls:
                 self._make_calls(c)
 
     def _on_bob(self) -> None:
@@ -444,7 +447,7 @@ def start_next_row(self, is_first_row: bool) -> None:
         # Generate the next row, and tell the rhythm detection where the next row's bells are
         # expected to ring
         self.generate_next_row()
-        for (index, bell) in enumerate(self._row):
+        for index, bell in enumerate(self._row):
             self.expect_bell(index, bell)
 
     def tick(self) -> None:
diff --git a/wheatley/main.py b/wheatley/main.py
@@ -115,7 +115,7 @@ def get_version_number() -> str:
     try:
         version_file_path = os.path.join(os.path.split(__file__)[0], "version.txt")
 
-        with open(version_file_path) as f:
+        with open(version_file_path) as f:  # pylint: disable=unspecified-encoding
             return f.read()
     except IOError:
         return "<NO VERSION FILE FOUND>"
diff --git a/wheatley/page_parser.py b/wheatley/page_parser.py
@@ -49,7 +49,7 @@ def get_load_balancing_url(tower_id: int, unfixed_http_server_url: str) -> str:
     url = urllib.parse.urljoin(http_server_url, str(tower_id))  # type: ignore
 
     try:
-        html = requests.get(url).text
+        html = requests.get(url, timeout=30).text
     except requests.exceptions.ConnectionError as e:
         raise InvalidURLError(http_server_url) from e
 
diff --git a/wheatley/rhythm/abstract_rhythm.py b/wheatley/rhythm/abstract_rhythm.py
@@ -63,6 +63,6 @@ def initialise_line(
     ) -> None:
         """Allow the Rhythm object to initialise itself when 'Look to' is called."""
 
-    def sleep(self, seconds: float) -> None:  #  pylint: disable=no-self-use
+    def sleep(self, seconds: float) -> None:  # pylint: disable=no-self-use
         """Sleeps for given number of seconds. Allows mocking in tests"""
         time.sleep(seconds)
diff --git a/wheatley/rhythm/regression.py b/wheatley/rhythm/regression.py
@@ -137,7 +137,7 @@ def _add_data_point(self, row_number: int, place: int, real_time: float, weight:
         # Wheatley is ringing)
         blow_time = self.index_to_blow_time(row_number, place)
         self.data_set.append((blow_time, real_time, weight))
-        for (b, r, w) in self.data_set:
+        for b, r, w in self.data_set:
             self.logger.debug(f"Datapoint: {b:4.1f} {r - self._real_start_time:8.3f}s {w:.3f}")
         # Filter out datapoints with extremely low weights
         self.data_set = list(filter(lambda d: d[2] > WEIGHT_REJECTION_THRESHOLD, self.data_set))
diff --git a/wheatley/row_generation/complib_composition_generator.py b/wheatley/row_generation/complib_composition_generator.py
@@ -138,7 +138,7 @@ def process_call_string(calls: str) -> List[str]:
         if query_sections:
             url += "?" + "&".join(query_sections)
         # Create an HTTP request for the rows, and deal with potential error codes
-        request_rows = requests.get(url)
+        request_rows = requests.get(url, timeout=30)
         if request_rows.status_code == 404:
             raise InvalidCompError(comp_id)
         if request_rows.status_code == 403:
diff --git a/wheatley/row_generation/dixonoids_generator.py b/wheatley/row_generation/dixonoids_generator.py
@@ -19,9 +19,9 @@ class DixonoidsGenerator(RowGenerator):
     def __init__(
         self,
         stage: int,
-        plain_rules: Dict[int, List[str]] = None,
-        bob_rules: Dict[int, List[str]] = None,
-        single_rules: Dict[int, List[str]] = None,
+        plain_rules: Optional[Dict[int, List[str]]] = None,
+        bob_rules: Optional[Dict[int, List[str]]] = None,
+        single_rules: Optional[Dict[int, List[str]]] = None,
         start_row: Optional[str] = None,
     ) -> None:
         """
diff --git a/wheatley/row_generation/method_place_notation_generator.py b/wheatley/row_generation/method_place_notation_generator.py
@@ -58,6 +58,20 @@ def __str__(self) -> str:
         return f"No method with title '{self._name}' found."
 
 
+class PlaceNotationNotFoundError(ValueError):
+    """
+    An error class to store the error thrown when a no place notation is found for a method
+    """
+
+    def __init__(self, name: str) -> None:
+        super().__init__()
+
+        self._name = name
+
+    def __str__(self) -> str:
+        return f"No place notation for method with title '{self._name}' found."
+
+
 class MethodPlaceNotationGenerator(PlaceNotationGenerator):
     """A class to generate rows given a method title."""
 
@@ -110,12 +124,12 @@ def _parse_xml(method_xml: str) -> Tuple[str, int, str]:
             assert notation is not None
             return notation, stage, title
 
-        raise Exception("Place notation not found")
+        raise PlaceNotationNotFoundError(title)
 
     @staticmethod
     def _fetch_method(method_title: str) -> str:
         params = {"title": method_title, "fields": "title|pn|stage"}
-        source = requests.get("http://methods.ringing.org/cgi-bin/simple.pl", params=params)
+        source = requests.get("http://methods.ringing.org/cgi-bin/simple.pl", params=params, timeout=30)
         source.raise_for_status()
 
         return source.text
diff --git a/wheatley/row_generation/place_notation_generator.py b/wheatley/row_generation/place_notation_generator.py
@@ -21,8 +21,8 @@ def __init__(
         self,
         stage: int,
         method: str,
-        bob: CallDef = None,
-        single: CallDef = None,
+        bob: Optional[CallDef] = None,
+        single: Optional[CallDef] = None,
         start_index: int = 0,
         start_row: Optional[str] = None,
     ) -> None:
diff --git a/wheatley/tower.py b/wheatley/tower.py
@@ -14,6 +14,10 @@
 from wheatley.stroke import Stroke, HANDSTROKE
 
 
+class RingingRoomTowerConnectError(Exception):
+    """A class for error in logic connecting."""
+
+
 class RingingRoomTower:
     """A class representing a tower, which will handle a single ringing-room session."""
 
@@ -45,7 +49,7 @@ def __enter__(self) -> Any:
         self.logger.debug("ENTER")
 
         if self._socket_io_client is not None:
-            raise Exception("Trying to connect twice")
+            raise RingingRoomTowerConnectError("Trying to connect twice")
 
         self._create_client()
 

Original file line number	Diff line number	Diff line change
`@@ -73,7 +73,7 @@ def test_convert_pn(self):`
`73`	`73`	`(".-.-.1.-.2", [_CROSS_PN, _CROSS_PN, [1], _CROSS_PN, [2]]),`
`74`	`74`	`]`
`75`	`75`
`76`		`- for (input_pn, expected_output_pn) in test_cases:`
	`76`	`+ for input_pn, expected_output_pn in test_cases:`
`77`	`77`	`with self.subTest(input_pn=input_pn, expected_output_pn=expected_output_pn):`
`78`	`78`	`self.assertEqual(convert_pn(input_pn), expected_output_pn)`
`79`	`79`