linted

Author: christophfink

pyproject.toml

@@ -31,21 +31,77 @@ license = {text = "GPL-3.0-or-later"}
 dynamic = ["version"]
 
 [project.optional-dependencies]
-docs = ["folium", "GitPython", "jupyterlab_myst", "mapclassify", "matplotlib",
-        "myst-nb", "nbsphinx", "pybtex-apa7-style", "sphinx", 
-        "sphinx-book-theme", "sphinx-design", "sphinxcontrib-bibtex",
-        "sphinxcontrib-images", "xyzservices"]
-tests = ["pytest", "pytest-cov", "pytest-lazy-fixtures"]
+dev = [
+    "black",
+    "flake8",
+    "flake8-bugbear",
+    "flake8-pyproject",
+    "isort",
+    "pydocstyle",
+    "pylint",
+]
+docs = [
+    "folium",
+    "GitPython",
+    "jupyterlab_myst",
+    "mapclassify",
+    "matplotlib",
+    "myst-nb",
+    "nbsphinx",
+    "pybtex-apa7-style",
+    "sphinx",
+    "sphinx-book-theme",
+    "sphinx-design",
+    "sphinxcontrib-bibtex",
+    "sphinxcontrib-images",
+    "xyzservices",
+]
+tests = [
+    "pytest",
+    "pytest-cov",
+    "pytest-lazy-fixtures",
+]
 
 [project.urls]
 Documentation = "https://python-cartogram.readthedocs.org/"
 Repository = "https://github.com/austromorph/python-cartogram"
 "Change log" =  "https://github.com/austromorph/python-cartogram/blob/main/CHANGELOG.md"
 "Bug tracker" = "https://github.com/austromorph/python-cartogram/issues"
 
+[tool.coverage.paths]
+equivalent_sources = [
+    "src/cartogram/",
+    ".virtualenv/lib/python*/site-packages/cartogram/",
+    "/opt/hostedtoolcache/Python/*/x64/lib/python*/site-packages/cartogram/",
+    "/Library/Frameworks/Python.framework/Versions/*/lib/python*/site-packages/cartogram/",
+    "C:/hostedtoolcache/windows/Python/*/x64/Lib/site-packages/cartogram/"
+]
+
+[tool.coverage.report]
+exclude_also = [
+    'if __name__ == .__main__.:',
+]
+
 [tool.coverage.run]
 omit = ["tests/*", ".virtualenv/**/*"]
 
+[tool.flake8]
+exclude = ["build", "dist", "docs/conf.py", ".virtualenv"]
+extent-ignore = ["E203", "E501", "E701"]
+extent-select = ["B950"]
+max-line-length = 88
+
+[tool.isort]
+profile = "black"
+skip = ["build", "dist", "docs/conf.py", ".virtualenv"]
+
+[tool.pydocstyle]
+#match-dir = "^(src|tests|build_backend).*"
+
+[tool.pylintrc]
+good-names = ["i", "j", "k", "e", "ex", "id", "Run", "_"]
+max-line-length = 88
+
 [tool.pytest.ini_options]
 addopts = "--cov=cartogram --cov-report term-missing --cov-report xml"
 pythonpath = ["src"]

src/cartogram/cartogram.py

@@ -13,7 +13,6 @@
 import pandas
 import shapely
 
-
 __all__ = ["Cartogram"]
 
 
@@ -39,15 +38,13 @@ class Cartogram(geopandas.GeoDataFrame):
     _constructor_sliced = pandas.Series
 
     @classmethod
-    def _geodataframe_constructor_with_fallback(
-        cls, *args, **kwargs
-    ):
+    def _geodataframe_constructor_with_fallback(cls, *args, **kwargs):
         """
-        A flexible constructor for Cartogram.
+        Provide a flexible constructor for Cartogram.
 
         Checks whether or not arguments of the child class are used.
         """
-        if "cartogram_attribute" in kwargs.keys():
+        if "cartogram_attribute" in kwargs:
             df = cls(*args, **kwargs)
         else:
             df = geopandas.GeoDataFrame(*args, **kwargs)
@@ -131,7 +128,8 @@ def _check_geodata(self):
         for geometry_type in geometry_types:
             if geometry_type not in ["MultiPolygon", "Polygon"]:
                 raise ValueError(
-                    f"Only POLYGON or MULTIPOLYGON geometries supported, found {geometry_type}."
+                    "Only POLYGON or MULTIPOLYGON geometries supported, "
+                    f"found {geometry_type}."
                 )
         self._input_is_multipolygon = "MultiPolygon" in geometry_types
 
@@ -179,15 +177,17 @@ def _feature_error(self, feature):
 
         return error
 
-    def _invalidate_cached_properties(self, properties=[]):
+    def _invalidate_cached_properties(self, properties=None):
         """Invalidate properties that were cached as `functools.cached_property`."""
         # https://stackoverflow.com/a/68316608
         if not properties:
             # # clear all as default
             # properties = [
             #     attribute
             #     for attribute in self.__dict__.keys()
-            #     if isinstance(getattr(self, attribute, None), functools.cached_property)
+            #     if isinstance(
+            #         getattr(self, attribute, None),
+            #         functools.cached_property)
             # ]
             properties = [
                 attr
@@ -215,7 +215,12 @@ def _transform(self):
             self.iteration < self.max_iterations
             and self.average_error > self.max_average_error
         ):
-            # self.geometry = self.geometry.apply(functools.partial(self._transform_geometry, features=self._cartogram_features))
+            # self.geometry = self.geometry.apply(
+            #     functools.partial(
+            #         self._transform_geometry,
+            #         features=self._cartogram_features
+            #     )
+            # )
             with joblib.Parallel(
                 verbose=(self.verbose * 10),
                 n_jobs=NUM_THREADS,
@@ -234,7 +239,8 @@ def _transform(self):
             self.iteration += 1
             if self.verbose:
                 print(
-                    f"{self.average_error:0.5f} error left after {self.iteration:d} iteration(s)"
+                    f"{self.average_error:0.5f} error left "
+                    f"after {self.iteration:d} iteration(s)"
                 )
 
         self.geometry = self.geometry.buffer(0.0)

tests/conftest.py

@@ -14,7 +14,6 @@
 import geopandas
 import pytest
 
-
 DATA_DIRECTORY = pathlib.Path(__file__).resolve().parent / "data"
 AUSTRIA_NUTS2_POPULATION = DATA_DIRECTORY / "Austria_PopulationByNUTS2.geojson"
 AUSTRIA_NUTS2_POPULATION_CARTOGRAM = (