use ruff for linting

Author: vincentsarago

.flake8

@@ -1,6 +1,11 @@
 repos:
+  - repo: https://github.com/abravalheri/validate-pyproject
+    rev: v0.12.1
+    hooks:
+      - id: validate-pyproject
+
   - repo: https://github.com/psf/black
-    rev: 22.3.0
+    rev: 22.12.0
     hooks:
       - id: black
         language_version: python
@@ -11,19 +16,11 @@ repos:
       - id: isort
         language_version: python
 
-  - repo: https://github.com/PyCQA/flake8
-    rev: 3.8.3
-    hooks:
-      - id: flake8
-        language_version: python
-
-  - repo: https://github.com/PyCQA/pydocstyle
-    rev: 6.1.1
+  - repo: https://github.com/charliermarsh/ruff-pre-commit
+    rev: v0.0.238
     hooks:
-      - id: pydocstyle
-        language_version: python
-        additional_dependencies:
-          - toml
+      - id: ruff
+        args: ["--fix"]
 
   - repo: https://github.com/pre-commit/mirrors-mypy
     rev: v0.991

.pre-commit-config.yaml

@@ -92,6 +92,16 @@ exclude = [
 requires = ["hatchling"]
 build-backend = "hatchling.build"
 
+[tool.coverage.run]
+branch = true
+parallel = true
+
+[tool.coverage.report]
+exclude_lines = [
+  "no cov",
+  "if __name__ == .__main__.:",
+  "if TYPE_CHECKING:",
+]
 
 [tool.isort]
 profile = "black"
@@ -106,6 +116,16 @@ default_section = "THIRDPARTY"
 [tool.mypy]
 no_strict_optional = "True"
 
-[tool.pydocstyle]
-select = "D1"
-match = "(?!test).*.py"
+[tool.ruff]
+select = [
+    "D1",  # pydocstyle errors
+    "E",  # pycodestyle errors
+    "W",  # pycodestyle warnings
+    "C",  # flake8-comprehensions
+    "B",  # flake8-bugbear
+]
+ignore = [
+    "E501",  # line too long, handled by black
+    "B008",  # do not perform function calls in argument defaults
+    "B905",  # ignore zip() without an explicit strict= parameter, only support with python >3.10
+]

pyproject.toml

@@ -0,0 +1 @@
+"""TiPG tests."""

setup.py

@@ -5,6 +5,7 @@
 
 
 def test_geography_column(app):
+    """Test endpoints with table having geography column."""
     response = app.get("/collections/public.my_data_geo")
     assert response.status_code == 200
     assert response.headers["content-type"] == "application/json"

tests/__init__.py

@@ -21,18 +21,16 @@ def test_item(app):
     assert response.status_code == 200
     assert response.headers["content-type"] == "application/json"
     feat = response.json()
-    assert set(
-        [
-            "collectionId",
-            "itemId",
-            "id",
-            "pr",
-            "row",
-            "path",
-            "ogc_fid",
-            "geometry",
-        ]
-    ) == set(feat.keys())
+    assert {
+        "collectionId",
+        "itemId",
+        "id",
+        "pr",
+        "row",
+        "path",
+        "ogc_fid",
+        "geometry",
+    } == set(feat.keys())
 
     # not found
     response = app.get("/collections/public.landsat_wrs/items/50000")

tests/routes/test_geography.py

@@ -141,7 +141,7 @@ def test_items_properties(app):
     assert response.status_code == 200
     assert response.headers["content-type"] == "application/geo+json"
     body = response.json()
-    assert sorted(["path", "row"]) == sorted(list(body["features"][0]["properties"]))
+    assert sorted(["path", "row"]) == sorted(body["features"][0]["properties"])
 
     # no properties
     response = app.get("/collections/public.landsat_wrs/items?properties=")
@@ -301,6 +301,7 @@ def test_items_properties_filter_cql2(app):
 
 
 def test_items_geo_filter_cql2(app):
+    """Test CQL2 geo filter."""
     response = app.get(
         "/collections/public.landsat_wrs/items?filter-lang=cql2-text&filter=S_INTERSECTS(geom, POLYGON((-22.2153 79.6888,-22.2153 81.8555,-8.97407 81.8555,-8.97407 79.6888,-22.2153 79.6888)))"
     )
@@ -311,6 +312,7 @@ def test_items_geo_filter_cql2(app):
 
 
 def test_items_geo_filter_cql2_non_4326_crs(app):
+    """Test CQL2 non 4326 geo filter."""
     response = app.get(
         "/collections/public.minnesota/items?filter-lang=cql2-text&filter=S_INTERSECTS(geom, POLYGON((-95.5389899 47.5578719,-95.5018943 46.4902864,-94.1637708 46.4891952,-94.1277889 47.5804373,-95.5389899 47.5578719)))"
     )
@@ -322,6 +324,7 @@ def test_items_geo_filter_cql2_non_4326_crs(app):
 
 
 def test_items_function_filter_cql2(app):
+    """Test CQL2 filter with function."""
     response = app.get(
         "/collections/public.landsat_wrs/items?filter-lang=cql2-text&filter=left(pr,2)='13'"
     )
@@ -654,18 +657,16 @@ def test_output_response_type(app):
     body = response.json()
     assert len(body) == 10
     feat = body[0]
-    assert set(
-        [
-            "collectionId",
-            "itemId",
-            "id",
-            "pr",
-            "row",
-            "path",
-            "ogc_fid",
-            "geometry",
-        ]
-    ) == set(feat.keys())
+    assert {
+        "collectionId",
+        "itemId",
+        "id",
+        "pr",
+        "row",
+        "path",
+        "ogc_fid",
+        "geometry",
+    } == set(feat.keys())
 
     # json output no geometry
     response = app.get("/collections/public.landsat_wrs/items?f=json&geom-column=none")
@@ -692,18 +693,16 @@ def test_output_response_type(app):
     body = response.text.splitlines()
     assert len(body) == 10
     feat = json.loads(body[0])
-    assert set(
-        [
-            "collectionId",
-            "itemId",
-            "id",
-            "pr",
-            "row",
-            "path",
-            "ogc_fid",
-            "geometry",
-        ]
-    ) == set(feat.keys())
+    assert {
+        "collectionId",
+        "itemId",
+        "id",
+        "pr",
+        "row",
+        "path",
+        "ogc_fid",
+        "geometry",
+    } == set(feat.keys())
 
     response = app.get(
         "/collections/public.landsat_wrs/items",

tests/routes/test_item.py

@@ -59,7 +59,7 @@ def test_tile(app):
     decoded = mapbox_vector_tile.decode(response.content)
     assert len(decoded["default"]["features"]) == 1000
     assert sorted(["id", "pr", "row", "path", "ogc_fid"]) == sorted(
-        list(decoded["default"]["features"][0]["properties"])
+        decoded["default"]["features"][0]["properties"]
     )
 
     response = app.get(
@@ -68,7 +68,7 @@ def test_tile(app):
     assert response.status_code == 200
     decoded = mapbox_vector_tile.decode(response.content)
     assert sorted(["pr", "row", "path"]) == sorted(
-        list(decoded["default"]["features"][0]["properties"])
+        decoded["default"]["features"][0]["properties"]
     )
 
     response = app.get(f"/collections/public.{name}/tiles/0/0/0?geom-column=geom")
@@ -84,6 +84,7 @@ def test_tile(app):
 
 
 def test_tile_custom_name(app):
+    """Test custom layer name."""
     init_value = mvt_settings.set_mvt_layername
     mvt_settings.set_mvt_layername = True
 
@@ -116,7 +117,7 @@ def test_tile_tms(app):
     decoded = mapbox_vector_tile.decode(response.content)
     assert len(decoded["default"]["features"]) <= 1000
     assert sorted(["id", "pr", "row", "path", "ogc_fid"]) == sorted(
-        list(decoded["default"]["features"][0]["properties"])
+        decoded["default"]["features"][0]["properties"]
     )
 
     response = app.get(
@@ -125,13 +126,14 @@ def test_tile_tms(app):
     assert response.status_code == 200
     decoded = mapbox_vector_tile.decode(response.content)
     assert sorted(["pr", "row", "path"]) == sorted(
-        list(decoded["default"]["features"][0]["properties"])
+        decoded["default"]["features"][0]["properties"]
     )
 
     mvt_settings.set_mvt_layername = init_value
 
 
 def test_tile_tms_custom_name(app):
+    """test layername with tms."""
     init_value = mvt_settings.set_mvt_layername
     mvt_settings.set_mvt_layername = True
 

tests/routes/test_items.py

@@ -456,7 +456,7 @@ def _geom(
 
         return g
 
-    def _where(
+    def _where(  # noqa: C901
         self,
         ids: Optional[List[str]] = None,
         datetime: Optional[List[str]] = None,
@@ -577,9 +577,9 @@ def _datetime_filter_to_sql(self, interval: List[str], dt_name: str):
 
         else:
             start = (
-                parse_rfc3339(interval[0]) if not interval[0] in ["..", ""] else None
+                parse_rfc3339(interval[0]) if interval[0] not in ["..", ""] else None
             )
-            end = parse_rfc3339(interval[1]) if not interval[1] in ["..", ""] else None
+            end = parse_rfc3339(interval[1]) if interval[1] not in ["..", ""] else None
 
             if start is None and end is None:
                 raise InvalidDatetime(
@@ -731,9 +731,11 @@ async def features(
         bbox_only: Optional[bool] = None,
         simplify: Optional[float] = None,
         geom_as_wkt: bool = False,
-        function_parameters: Dict[str, str] = {},
+        function_parameters: Optional[Dict[str, str]] = None,
     ) -> Tuple[FeatureCollection, int]:
         """Build and run Pg query."""
+        function_parameters = function_parameters or {}
+
         if geom and geom.lower() != "none" and not self.get_geometry_column(geom):
             raise InvalidGeometryColumnName(f"Invalid Geometry Column: {geom}.")
 
@@ -872,7 +874,7 @@ def queryables(self) -> Dict:
 
 async def get_collection_index(  # noqa: C901
     db_pool: asyncpg.BuildPgPool,
-    schemas: Optional[List[str]] = ["public"],
+    schemas: Optional[List[str]] = None,
     tables: Optional[List[str]] = None,
     exclude_tables: Optional[List[str]] = None,
     exclude_table_schemas: Optional[List[str]] = None,
@@ -882,6 +884,7 @@ async def get_collection_index(  # noqa: C901
     spatial: bool = True,
 ) -> Database:
     """Fetch Table and Functions index."""
+    schemas = schemas or ["public"]
 
     query = """
         SELECT pg_temp.tipg_catalog(