lint

Author: james-d-mitchell

Makefile

@@ -25,8 +25,8 @@ check: doctest
 	pytest -vv tests/test_*.py
 
 lint:
-	ruff check --exit-zero setup.py tests/*.py libsemigroups_pybind11/**/*.py docs/source/**/*.py
-	pylint --exit-zero setup.py tests/*.py libsemigroups_pybind11/**/*.py docs/source/**/*.py
+	ruff check --exit-zero setup.py tests/*.py libsemigroups_pybind11/*.py docs/source/*.py
+	pylint --exit-zero setup.py tests/*.py libsemigroups_pybind11/*.py libsemigroups_pybind11/**/*.py
 	cpplint src/*.hpp src/*.cpp
 
 coverage:

docs/source/conf.py

@@ -3,6 +3,7 @@
 """
 This provides configuration for the generation of the docs
 """
+# pylint: disable=invalid-name
 
 import importlib.metadata
 import sys
@@ -31,9 +32,7 @@
 source_suffix = ".rst"
 master_doc = "index"
 project = "libsemigroups_pybind11"
-copyright = (
-    "2021-2025, Joseph Edwards, James Mitchell, Maria Tsalakou, Murray Whyte"
-)
+copyright = "2021-2025, Joseph Edwards, James Mitchell, Maria Tsalakou, Murray Whyte"  # pylint: disable=redefined-builtin
 author = "Joseph Edwards, James Mitchell, Maria Tsalakou, Murray Whyte"
 # Use the version number of the installed project
 version = release = importlib.metadata.version(project)

libsemigroups_pybind11/action.py

@@ -6,8 +6,8 @@
 #
 # The full license is in the file LICENSE, distributed with this software.
 
-# pylint:disable=no-name-in-module, unused-import, protected-access,
-# pylint:disable=missing-function-docstring
+# pylint:disable=no-name-in-module, unused-import,
+# pylint:disable=missing-function-docstring,
 
 """
 This package provides the user-facing python part of libsemigroups_pybind11 for
@@ -177,6 +177,7 @@ class Action(_CxxWrapper):  # pylint: disable=missing-class-docstring
     # Special methods
     ########################################################################
 
+    # pylint: disable=redefined-outer-name
     def __init__(
         self: _Self, *args, generators=None, seeds=None, func=None, side=None
     ) -> None:
@@ -211,9 +212,7 @@ def __init__(
         if _to_cxx(self) is not None:
             return
         if len(args) != 0:
-            raise ValueError(
-                f"expected 0 positional arguments, but found {len(args)}"
-            )
+            raise ValueError(f"expected 0 positional arguments, but found {len(args)}")
         if not isinstance(generators, list):
             raise TypeError(
                 "expected the keyword argument 'generators' to be "
@@ -276,7 +275,7 @@ def generators(self: _Self) -> Iterator[Element]:
 
 _copy_cxx_mem_fns(_RightActionPPerm1PPerm1, Action)
 
-for _type in Action._py_template_params_to_cxx_type.values():
+for _type in Action._py_template_params_to_cxx_type.values():  # pylint: disable=protected-access
     _register_cxx_wrapped_type(_type, Action)
 
 ########################################################################
@@ -293,7 +292,7 @@ class RightAction(Action):
     :any:`ImageRightAction` and *side* given by :py:class:`side.right`.
     """
 
-    def __init__(self: _Self, *args, generators=[], seeds=[]) -> None:
+    def __init__(self: _Self, *args, generators=None, seeds=None) -> None:
         """
         :sig=(self: Action, generators=None, seeds=None, func=None, side=None) -> None:
 
@@ -335,7 +334,7 @@ class LeftAction(Action):
     :any:`ImageLeftAction` and *side* given by :py:class:`side.left`.
     """
 
-    def __init__(self: _Self, *args, generators=[], seeds=[]) -> None:
+    def __init__(self: _Self, *args, generators=None, seeds=None) -> None:
         """
         :sig=(self: Action, generators=None, seeds=None, func=None, side=None) -> None:
 

libsemigroups_pybind11/adapters.py

@@ -53,6 +53,16 @@ class _ImageAction(_CxxWrapper):
     """
 
     def __init__(self: _Self, *args, point=None, element=None) -> None:
+        """
+        Construct from sample element and sample point.
+
+        :Keyword Arguments:
+          * **element** (*Element*) -- a sample element.
+          * **point** (*Point*) -- a sample point.
+
+        :raises KeyError:
+            if the action defined by the arguments is not defined.
+        """
         super().__init__(
             *args,
             required_kwargs=("element", "point"),
@@ -62,9 +72,7 @@ def __init__(self: _Self, *args, point=None, element=None) -> None:
         if _to_cxx(self) is not None:
             return
         if len(args) != 0:
-            raise ValueError(
-                f"expected 0 positional arguments, but found {len(args)}"
-            )
+            raise ValueError(f"expected 0 positional arguments, but found {len(args)}")
         self.py_template_params = (
             type(_to_cxx(element)),
             type(_to_cxx(point)),
@@ -80,7 +88,7 @@ def __call__(self: _Self, *args):
 ########################################################################
 
 
-class ImageRightAction(_ImageAction):
+class ImageRightAction(_ImageAction):  # pylint: disable=missing-class-docstring
     Element = _TypeVar("Element")
     Point = _TypeVar("Point")
 
@@ -101,21 +109,6 @@ class ImageRightAction(_ImageAction):
 
     _all_wrapped_cxx_types = {*_py_template_params_to_cxx_type.values()}
 
-    def __init__(self: _Self, *args, point=None, element=None):
-        """
-        :sig=(self: ImageRightAction, element=None, point=None):
-
-        Construct from sample element and sample point.
-
-        :Keyword Arguments:
-          * **element** (*Element*) -- a sample element.
-          * **point** (*Point*) -- a sample point.
-
-        :raises KeyError:
-            if the action defined by the arguments is not defined.
-        """
-        super().__init__(*args, point=point, element=element)
-
     @_copydoc(_ImageRightActionPPerm1PPerm1.__call__)
     def __call__(self: _Self, pt: Point, x: Element) -> Point:
         return _to_py(_to_cxx(self)(_to_cxx(pt), _to_cxx(x)))
@@ -127,7 +120,7 @@ def __call__(self: _Self, pt: Point, x: Element) -> Point:
 
 _copy_cxx_mem_fns(_ImageRightActionPPerm1PPerm1, ImageRightAction)
 
-for _type in ImageRightAction._py_template_params_to_cxx_type.values():
+for _type in ImageRightAction._py_template_params_to_cxx_type.values():  # pylint:disable=protected-access
     _register_cxx_wrapped_type(_type, ImageRightAction)
 
 
@@ -136,7 +129,7 @@ def __call__(self: _Self, pt: Point, x: Element) -> Point:
 ########################################################################
 
 
-class ImageLeftAction(_ImageAction):
+class ImageLeftAction(_ImageAction):  # pylint: disable=missing-class-docstring
     Element = _TypeVar("Element")
     Point = _TypeVar("Point")
 
@@ -156,21 +149,6 @@ class ImageLeftAction(_ImageAction):
 
     _all_wrapped_cxx_types = {*_py_template_params_to_cxx_type.values()}
 
-    def __init__(self: _Self, *args, point=None, element=None):
-        """
-        :sig=(self: ImageLeftAction, element=None, point=None):
-
-        Construct from sample element and sample point.
-
-        :Keyword Arguments:
-          * **element** (*Element*) -- a sample element.
-          * **point** (*Point*) -- a sample point.
-
-        :raises KeyError:
-            if the action defined by the arguments is not defined.
-        """
-        super().__init__(*args, point=point, element=element)
-
     @_copydoc(_ImageLeftActionPPerm1PPerm1.__call__)
     def __call__(self: _Self, pt: Point, x: Element) -> Point:
         return _to_py(_to_cxx(self)(_to_cxx(pt), _to_cxx(x)))

libsemigroups_pybind11/froidure_pin.py

@@ -214,7 +214,7 @@ def sorted_elements(self: Self) -> Iterator:
 
 _copy_cxx_mem_fns(_FroidurePinBMat, FroidurePin)
 
-for _fp_type in FroidurePin._py_template_params_to_cxx_type.values():
+for _fp_type in FroidurePin._py_template_params_to_cxx_type.values():  # pylint:disable=protected-access
     _register_cxx_wrapped_type(_fp_type, FroidurePin)
 
 

libsemigroups_pybind11/is_obviously_infinite.py

@@ -9,11 +9,9 @@
 # The module doc string is what appears at the top of the helper function
 # doc page, and so is omitted.
 
-# pylint: disable=no-name-in-module
-# BECAUSE: pylint can't find any imports from _libsemigroups_pybind11
+"""Subpackage for importing is_obviously_infinite, and wrapping it."""
 
-
-from _libsemigroups_pybind11 import (
+from _libsemigroups_pybind11 import (  # pylint: disable=no-name-in-module
     is_obviously_infinite as _is_obviously_infinite,
 )
 

libsemigroups_pybind11/konieczny.py

@@ -15,8 +15,6 @@
 :any:`Konieczny`.
 """
 
-from copy import copy
-from functools import wraps
 from typing import TypeVar as _TypeVar, Iterator
 from typing_extensions import Self
 

libsemigroups_pybind11/sims.py

@@ -56,9 +56,7 @@ def __init__(self: Self, *args, **kwargs) -> None:
                 f"expected 0 or 1 positional arguments but found {len(args)}"
             )
         if len(kwargs) != 0:
-            raise TypeError(
-                f"expected 0 keyword arguments, but found {len(kwargs)}"
-            )
+            raise TypeError(f"expected 0 keyword arguments, but found {len(kwargs)}")
 
         if len(args) == 0:
             # self.Word = kwargs["Word"]
@@ -78,7 +76,7 @@ def __init__(self: Self, *args, **kwargs) -> None:
 ########################################################################
 
 
-class Sims1(_SimsBase):
+class Sims1(_SimsBase):  # pylint: disable=missing-class-docstring
     __doc__ = _Sims1.__doc__
 
     _py_template_params_to_cxx_type = {
@@ -107,7 +105,7 @@ def __init__(self: Self, *args, **kwargs) -> None:
 ########################################################################
 
 
-class Sims2(_SimsBase):
+class Sims2(_SimsBase):  # pylint: disable=missing-class-docstring
     __doc__ = _Sims2.__doc__
 
     _py_template_params_to_cxx_type = {
@@ -136,7 +134,7 @@ def __init__(self: Self, *args, **kwargs) -> None:
 ########################################################################
 
 
-class RepOrc(_SimsBase):
+class RepOrc(_SimsBase):  # pylint: disable=missing-class-docstring
     __doc__ = _RepOrc.__doc__
 
     _py_template_params_to_cxx_type = {
@@ -165,7 +163,7 @@ def __init__(self: Self, *args, **kwargs) -> None:
 ########################################################################
 
 
-class MinimalRepOrc(_SimsBase):
+class MinimalRepOrc(_SimsBase):  # pylint: disable=missing-class-docstring
     __doc__ = _MinimalRepOrc.__doc__
 
     _py_template_params_to_cxx_type = {
@@ -195,7 +193,7 @@ def __init__(self: Self, *args, **kwargs) -> None:
 ########################################################################
 
 
-class SimsRefinerIdeals(_SimsBase):
+class SimsRefinerIdeals(_SimsBase):  # pylint: disable=missing-class-docstring
     __doc__ = _SimsRefinerIdeals.__doc__
 
     _py_template_params_to_cxx_type = {
@@ -224,7 +222,7 @@ def __init__(self: Self, *args, **kwargs) -> None:
 ########################################################################
 
 
-class SimsRefinerFaithful(_CxxWrapper):
+class SimsRefinerFaithful(_CxxWrapper):  # pylint: disable=missing-class-docstring
     __doc__ = _SimsRefinerFaithful.__doc__
 
     _py_template_params_to_cxx_type = {
@@ -258,9 +256,7 @@ def __init__(self: Self, *args, **kwargs) -> None:
             ):
                 self.py_template_params = (List[int],)
             else:
-                raise TypeError(
-                    "expected the 1st argument to be a List[List[int]]"
-                )
+                raise TypeError("expected the 1st argument to be a List[List[int]]")
         self.init_cxx_obj(*args)
 
 

libsemigroups_pybind11/stephen.py

@@ -31,7 +31,7 @@
     words_accepted as _words_accepted,
 )
 
-from libsemigroups_pybind11 import (
+from .presentation import (
     Presentation as _Presentation,
     InversePresentation as _InversePresentation,
 )
@@ -51,7 +51,7 @@
 
 
 # TODO(2): Make this work with string presentations once it works
-class Stephen(_CxxWrapper):
+class Stephen(_CxxWrapper):  # pylint: disable=missing-class-docstring
     __doc__ = _StephenPresentationWords.__doc__
 
     _py_template_params_to_cxx_type = {

libsemigroups_pybind11/transf.py

@@ -6,7 +6,7 @@
 #
 # The full license is in the file LICENSE, distributed with this software.
 
-# pylint: disable=no-name-in-module
+# pylint: disable=invalid-name
 
 """
 This package provides a the user-facing python part of libsemigroups_pybind11
@@ -15,10 +15,10 @@
 
 import abc
 
-from typing import Any as _Any, Union, List
+from typing import Any as _Any, List
 from typing_extensions import Self
 
-from _libsemigroups_pybind11 import (
+from _libsemigroups_pybind11 import (  # pylint: disable=no-name-in-module
     PPerm1 as _PPerm1,
     PPerm2 as _PPerm2,
     PPerm4 as _PPerm4,
@@ -72,7 +72,7 @@ def __repr__(self: Self) -> str:
     def _py_template_params_from_degree(N: int) -> tuple[int]:
         if N < 2**8:
             return (2**8,)
-        elif N < 2**16:
+        if N < 2**16:
             return (2**16,)
         assert N <= 2**32
         return (2**32,)
@@ -134,7 +134,7 @@ def __mul__(self: Self, other: Self):
 
     @staticmethod
     @abc.abstractmethod
-    def one(N: int) -> Self:
+    def one(N: int) -> Self:  # pylint: disable=missing-function-docstring
         pass  # pragma: no cover
 
     def increase_degree_by(  # pylint: disable=missing-function-docstring