chore: use ruff linter, remove isort

Rogdham · Rogdham · commit d0edd5e560bf · 2023-04-22T14:48:17.000+02:00
diff --git a/.vscode/extensions.json b/.vscode/extensions.json
@@ -0,0 +1,7 @@
+{
+  "recommendations": [
+    "charliermarsh.ruff",
+    "esbenp.prettier-vscode",
+    "ms-python.python"
+  ]
+}
diff --git a/.vscode/settings.json b/.vscode/settings.json
@@ -5,7 +5,9 @@
     ".eggs": true,
     "**/*.egg-info": true,
     ".coverage": true,
+    ".mypy_cache": true,
     ".pytest_cache": true,
+    ".ruff_cache": true,
     ".tox": true
   },
   "editor.detectIndentation": false,
@@ -32,6 +34,5 @@
   "python.formatting.provider": "black",
   "python.linting.mypyEnabled": true,
   "python.linting.pylintEnabled": true,
-  "python.testing.pytestEnabled": true,
-  "python.sortImports.args": ["-sp .isort.cfg"]
+  "python.testing.pytestEnabled": true
 }
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -21,6 +21,7 @@ adheres to [Semantic Versioning](https://semver.org/).
 ### :house: Internal
 
 - Necessary code changes following dev dependency update: mypy
+- Use ruff for linting (and remove isort)
 
 ## [0.9.0] - 2022-11-06
 
diff --git a/dev-requirements.txt b/dev-requirements.txt
@@ -11,10 +11,10 @@ pytest-cov
 
 # lint
 pylint
+ruff==0.0.262
 
 # format
 black
-isort
 
 # publish
 setuptools_scm
diff --git a/docs/conftest.py b/docs/conftest.py
@@ -18,7 +18,7 @@
 
 
 @pytest.fixture(scope="module", autouse=True)
-def import_pytest(doctest_namespace: Dict[str, object]) -> None:
+def _import_pytest(doctest_namespace: Dict[str, object]) -> None:
     doctest_namespace["HandlerTypeHelper"] = HandlerTypeHelper
     doctest_namespace["Parser"] = Parser
     doctest_namespace["XMLElement"] = XMLElement
@@ -40,7 +40,7 @@ def import_pytest(doctest_namespace: Dict[str, object]) -> None:
 
 
 @pytest.fixture(scope="module", autouse=True)
-def create_files() -> Iterator[None]:
+def _create_files() -> Iterator[None]:
     cwd = getcwd()
     docs_path = Path(__file__).parent
     try:
diff --git a/ruff.toml b/ruff.toml
@@ -0,0 +1,30 @@
+select = ["ALL"]
+src = ["src"]
+target-version = "py37"
+
+ignore = [
+    "ANN101",
+    "ANN102",
+    "C901",
+    "COM812",
+    "D",
+    "E501",
+    "EM",
+    "ERA001",
+    "PLR0912",
+    "TRY003",
+    "TRY301",
+]
+
+[per-file-ignores]
+"docs/**" = ["D", "INP001", "PTH109"]
+"stubs/**" = ["D"]
+"tests/**" = ["D", "FBT", "INP001", "PLR2004", "S101", "SLF001"]
+
+[isort]
+force-sort-within-sections = true
+
+[flake8-pytest-style]
+fixture-parentheses = false
+mark-parentheses = false
+parametrize-names-type = "list"
diff --git a/src/bigxml/exceptions.py b/src/bigxml/exceptions.py
@@ -9,7 +9,7 @@
 class BigXmlError(ValueError):
     """Error parsing XML content"""
 
-    def __init__(self, msg: str, security: bool) -> None:
+    def __init__(self, msg: str, *, security: bool) -> None:
         # put only first letter of 'msg' in uppercase
         super().__init__(msg[:1].upper() + msg[1:])
         self.security = security
@@ -19,12 +19,12 @@ def rewrite_exceptions(iterable: Iterable[T]) -> Iterator[T]:
     try:
         yield from iterable
     except ParseError as ex:
-        raise BigXmlError(str(ex), False) from ex
+        raise BigXmlError(str(ex), security=False) from ex
     except DefusedXmlException as ex:
         # defusedxml has usable wording in it's exception's doc
         # except for base DefusedXmlException
         msg = (ex.__doc__ or "").strip()
         # pylint: disable-next=unidiomatic-typecheck
         if not msg or type(ex) is DefusedXmlException:
             msg = "Invalid XML"
-        raise BigXmlError(msg, True) from ex
+        raise BigXmlError(msg, security=True) from ex
diff --git a/src/bigxml/handle_mgr.py b/src/bigxml/handle_mgr.py
@@ -124,15 +124,15 @@ def iter_from(
     @overload
     def iter_from(
         self,
-        *handlers: Any,
+        *handlers: Any,  # noqa: ANN401
     ) -> Iterator[object]:
         ...
 
     def iter_from(self, *handlers: Any) -> Iterator[object]:
         if not self._handle:
             raise RuntimeError("No handle to use")
         handler = create_handler(*handlers)
-        return self._handle(handler)  # pylint: disable=not-callable
+        return self._handle(handler)  # pylint: disable=not-callable
 
     # return_from
 
diff --git a/src/bigxml/handler_creator.py b/src/bigxml/handler_creator.py
@@ -61,13 +61,14 @@ def add_handler(
         self,
         path: Tuple[str, ...],
         handler: object,
+        *,
         ignore_direct_marks: bool,
     ) -> None:
         # marked
         marks = () if ignore_direct_marks else get_marks(handler)
         if marks:
             for mark in marks:
-                self.add_handler(path + mark, handler, True)
+                self.add_handler(path + mark, handler, ignore_direct_marks=True)
             return
 
         # callable
@@ -81,7 +82,7 @@ def add_handler(
             if handler_name.startswith("__"):
                 continue
             for sub_path in get_marks(sub_handler):
-                self.add_handler(path + sub_path, sub_handler, True)
+                self.add_handler(path + sub_path, sub_handler, ignore_direct_marks=True)
                 found = True
         if found:
             return
@@ -95,7 +96,7 @@ def add_handler(
             self.add_handler(
                 path + handler,
                 _handler_identity,
-                True,  # does not matter as _handler_identity has no marks
+                ignore_direct_marks=True,  # does not matter as _handler_identity has no marks
             )
             return
 
@@ -111,8 +112,10 @@ def add_handler_callable(
             raise TypeError(f"{self.path}: catchall handler exists: {self.handler}")
         if path:
             if path[0] not in self.children:
-                self.children[path[0]] = _HandlerTree(self.path + (path[0],))
-            self.children[path[0]].add_handler(path[1:], handler, True)
+                self.children[path[0]] = _HandlerTree((*self.path, path[0]))
+            self.children[path[0]].add_handler(
+                path[1:], handler, ignore_direct_marks=True
+            )
         elif self.children:
             raise TypeError(f"{self.path}: handlers exist: {self.children}")
         else:
@@ -162,7 +165,7 @@ def _handle_from_class(  # type: ignore[misc]
         sub_tree = _HandlerTree()
         items: Iterable[object] = ()  # empty iterable
         try:
-            sub_tree.add_handler((), instance, True)
+            sub_tree.add_handler((), instance, ignore_direct_marks=True)
         except TypeError:
             pass  # no marks on public attributes
         else:
@@ -205,7 +208,7 @@ def _handle_from_class(  # type: ignore[misc]
                     f" Create a {CLASS_HANDLER_METHOD_NAME}"
                     " method to handle them properly."
                 )
-            warnings.warn(warning_msg, UserWarning)
+            warnings.warn(warning_msg, UserWarning, stacklevel=1)
 
         if wrapper is None:
             # no custom wrapper: only yield instance
@@ -218,5 +221,5 @@ def create_handler(
 ) -> Callable[[Union["XMLElement", "XMLText"]], Iterator[object]]:
     handler_tree = _HandlerTree()
     for arg in args:
-        handler_tree.add_handler((), arg, False)
+        handler_tree.add_handler((), arg, ignore_direct_marks=False)
     return handler_tree.handle
diff --git a/src/bigxml/handler_marker.py b/src/bigxml/handler_marker.py
@@ -15,7 +15,8 @@
 # plus xml_handle_text can be applied without parenthesis as well
 
 
-class ___xml_handle_xxx_wrapped(Protocol[T_co]):  # pylint: disable=invalid-name
+# pylint: disable-next=invalid-name
+class ___xml_handle_xxx_wrapped(Protocol[T_co]):  # noqa: N801
     # wrapper for classes
     @overload
     def __call__(
diff --git a/src/bigxml/nodes.py b/src/bigxml/nodes.py
@@ -31,9 +31,9 @@ def __init__(self, attributes: Mapping[str, str]) -> None:
             self._items[f"{{{namespace}}}{name}"] = (None, value)
             self._len += 1
             if namespace:
-                alternatives, value = self._items.get(name, (0, value))
-                if alternatives is not None:
-                    self._items[name] = (alternatives + 1, value)
+                alt_nb, alt_value = self._items.get(name, (0, value))
+                if alt_nb is not None:
+                    self._items[name] = (alt_nb + 1, alt_value)
             else:
                 self._items[name] = (None, value)
 
@@ -46,6 +46,7 @@ def __getitem__(self, key: str) -> str:
                     f" Specify namespace by using '{{namespace}}{key}' as the key."
                 ),
                 UserWarning,
+                stacklevel=1,
             )
         return value
 
@@ -73,7 +74,7 @@ def _handler_get_text(node: Union["XMLElement", "XMLText"]) -> Iterator[str]:
     elif isinstance(node, XMLElement):
         yield from node.iter_from(_handler_get_text)
     else:  # pragma: no cover
-        raise RuntimeError  # should not happen
+        raise TypeError  # should not happen
 
 
 @dataclass
diff --git a/src/bigxml/parser.py b/src/bigxml/parser.py
@@ -42,7 +42,9 @@ def create_node(elem: "Element", iteration: int) -> Union[XMLElement, XMLText]:
             name=elem.tag, attributes=XMLElementAttributes(elem.attrib), parents=parents
         )
         # pylint: disable=protected-access
-        node._handle = lambda h: _parse(iterator, h, parents + (node,), elem, iteration)
+        node._handle = lambda h: _parse(  # noqa: SLF001
+            iterator, h, (*parents, node), elem, iteration
+        )
         return node
 
     for action, elem in iterator:
diff --git a/src/bigxml/stream.py b/src/bigxml/stream.py
@@ -12,7 +12,7 @@ def _flatten_stream(stream: Streamable) -> Generator[Optional[memoryview], int,
     # bytes-like
     try:
         yield memoryview(cast(bytes, stream))
-        return
+        return  # noqa: TRY300
     except TypeError:
         pass
 
@@ -52,8 +52,7 @@ def _flatten_stream(stream: Streamable) -> Generator[Optional[memoryview], int,
         substreams = iter(cast(Iterable[Streamable], stream))
     except TypeError:
         # other types not supported
-        # pylint: disable=raise-missing-from
-        raise TypeError(f"Invalid stream type: {type(stream).__name__}")
+        raise TypeError(f"Invalid stream type: {type(stream).__name__}") from None
 
     for substream in substreams:
         yield from _flatten_stream(substream)
diff --git a/stubs/defusedxml/ElementTree.pyi b/stubs/defusedxml/ElementTree.pyi
@@ -2,6 +2,6 @@
 
 from xml.etree.ElementTree import Element, ParseError, iterparse
 
-class DefusedXmlException(ValueError): ...
+class DefusedXmlException(ValueError): ...  # noqa: N818
 
 __all__ = ("DefusedXmlException", "Element", "iterparse", "ParseError")
diff --git a/stubs/defusedxml/__init__.pyi b/stubs/defusedxml/__init__.pyi
@@ -1,6 +1,6 @@
 # note: only used items are defined here
 
-class DefusedXmlException(ValueError): ...
+class DefusedXmlException(ValueError): ...  # noqa: N818
 class NotSupportedError(DefusedXmlException): ...
 
 __all__ = ("DefusedXmlException", "NotSupportedError")
diff --git a/tests/conftest.py b/tests/conftest.py
@@ -7,7 +7,7 @@
 
 def pytest_collection_modifyitems(
     # pylint: disable=unused-argument
-    config: pytest.Config,
+    config: pytest.Config,  # noqa: ARG001
     items: List[pytest.Item],
 ) -> None:
     root = Path(__file__).parent.parent
diff --git a/tests/integration/test_encodings.py b/tests/integration/test_encodings.py
@@ -10,7 +10,7 @@
 
 @pytest.mark.parametrize(
     "xml",
-    (
+    [
         # UTF-8 and UTF-16 may omit XML declaration (in which case BOM is optional for UTF-8)
         # https://www.w3.org/TR/xml/#charencoding
         pytest.param(
@@ -53,7 +53,7 @@
             ("<?xml version='1.0' encoding='ISO-8859-1'?>" + XML_STR).encode("latin_1"),
             id="explicit ISO-8859-1",
         ),
-    ),
+    ],
 )
 def test_encoding(xml: bytes) -> None:
     @xml_handle_element("élément")
diff --git a/tests/integration/test_invalid_xml.py b/tests/integration/test_invalid_xml.py
@@ -4,7 +4,7 @@
 
 
 @pytest.mark.parametrize(
-    "xml, msg",
+    ["xml", "msg"],
     [
         pytest.param(
             b"",
diff --git a/tests/integration/test_namespaces.py b/tests/integration/test_namespaces.py
@@ -20,7 +20,6 @@
 
 def test_namespaces() -> None:
     class Handler:
-
         #
         # namespaces in element names
         #
diff --git a/tests/integration/test_security.py b/tests/integration/test_security.py
@@ -10,8 +10,8 @@ def handler_get_text(node: XMLText) -> Iterator[str]:
 
 
 @pytest.mark.parametrize(
-    "xml, msg",
-    (
+    ["xml", "msg"],
+    [
         pytest.param(
             (
                 b"<!DOCTYPE foobar [\n"
@@ -94,7 +94,7 @@ def handler_get_text(node: XMLText) -> Iterator[str]:
             "Entity definition is forbidden",
             id="resolution (expect)",
         ),
-    ),
+    ],
 )
 def test_external_entities(xml: bytes, msg: str) -> None:
     with pytest.raises(BigXmlError) as exc_info:
diff --git a/tests/integration/test_typing.py b/tests/integration/test_typing.py
@@ -20,7 +20,7 @@
     from typing_extensions import assert_type
 else:
 
-    def assert_type(val: Any, _: Any) -> Any:
+    def assert_type(val: Any, _: Any) -> Any:  # noqa: ANN401
         return val
 
 
diff --git a/tests/integration/test_wikipedia_export.py b/tests/integration/test_wikipedia_export.py
@@ -18,7 +18,7 @@ def handle_author(self, node: XMLText) -> None:
 
         @xml_handle_text("timestamp")
         def handle_date(self, node: XMLText) -> None:
-            self.date = datetime.strptime(node.text, "%Y-%m-%dT%H:%M:%SZ")
+            self.date = datetime.strptime(node.text, "%Y-%m-%dT%H:%M:%SZ").astimezone()
 
     with LZMAFile(Path(__file__).parent / "wikipedia_python_export.xml.xz") as stream:
         items = list(Parser(stream).iter_from(Revision))
diff --git a/tests/unit/test_exceptions.py b/tests/unit/test_exceptions.py
@@ -13,7 +13,7 @@ def generate(ex: Exception) -> Iterator[int]:
 
 
 @pytest.mark.parametrize(
-    "exception, msg, security",
+    ["exception", "msg", "security"],
     [
         pytest.param(
             ParseError(ValueError("something went wrong")),
diff --git a/tests/unit/test_handler_creator.py b/tests/unit/test_handler_creator.py
diff --git a/tests/unit/test_nodes_element_attributes.py b/tests/unit/test_nodes_element_attributes.py
diff --git a/tests/unit/test_nodes_element_get_text.py b/tests/unit/test_nodes_element_get_text.py
diff --git a/tests/unit/test_parser.py b/tests/unit/test_parser.py
diff --git a/tests/unit/test_stream.py b/tests/unit/test_stream.py
diff --git a/tests/unit/test_utils_get_mandatory_params.py b/tests/unit/test_utils_get_mandatory_params.py
diff --git a/tests/unit/test_utils_iterable.py b/tests/unit/test_utils_iterable.py
diff --git a/tox.ini b/tox.ini
