Merge pull request #3670 from lonvia/flake-for-tests

Extend linting with flake to tests

Author: lonvia

.flake8

@@ -6,3 +6,6 @@ extend-ignore =
     E711
 per-file-ignores =
     __init__.py: F401
+    test/python/utils/test_json_writer.py: E131
+    test/python/conftest.py: E402
+    test/bdd/*: F821

.github/workflows/ci-tests.yml

@@ -100,7 +100,7 @@ jobs:
               run: ./venv/bin/pip install -U flake8
 
             - name: Python linting
-              run: ../venv/bin/python -m flake8 src
+              run: ../venv/bin/python -m flake8 src test/python test/bdd
               working-directory: Nominatim
 
             - name: Install mypy and typechecking info

Makefile

@@ -24,7 +24,7 @@ pytest:
 	pytest test/python
 
 lint:
-	flake8 src
+	flake8 src test/python test/bdd
 
 bdd:
 	cd test/bdd; behave -DREMOVE_TEMPLATE=1

test/bdd/environment.py

@@ -2,51 +2,53 @@
 #
 # This file is part of Nominatim. (https://nominatim.org)
 #
-# Copyright (C) 2024 by the Nominatim developer community.
+# Copyright (C) 2025 by the Nominatim developer community.
 # For a full list of authors see the git log.
 from pathlib import Path
 import sys
 
-from behave import *
+from behave import *  # noqa
 
 sys.path.insert(1, str(Path(__file__, '..', '..', '..', 'src').resolve()))
 
-from steps.geometry_factory import GeometryFactory
-from steps.nominatim_environment import NominatimEnvironment
+from steps.geometry_factory import GeometryFactory  # noqa: E402
+from steps.nominatim_environment import NominatimEnvironment  # noqa: E402
 
 TEST_BASE_DIR = Path(__file__, '..', '..').resolve()
 
 userconfig = {
-    'REMOVE_TEMPLATE' : False,
-    'KEEP_TEST_DB' : False,
-    'DB_HOST' : None,
-    'DB_PORT' : None,
-    'DB_USER' : None,
-    'DB_PASS' : None,
-    'TEMPLATE_DB' : 'test_template_nominatim',
-    'TEST_DB' : 'test_nominatim',
-    'API_TEST_DB' : 'test_api_nominatim',
-    'API_TEST_FILE'  : TEST_BASE_DIR / 'testdb' / 'apidb-test-data.pbf',
-    'TOKENIZER' : None, # Test with a custom tokenizer
-    'STYLE' : 'extratags',
+    'REMOVE_TEMPLATE': False,
+    'KEEP_TEST_DB': False,
+    'DB_HOST': None,
+    'DB_PORT': None,
+    'DB_USER': None,
+    'DB_PASS': None,
+    'TEMPLATE_DB': 'test_template_nominatim',
+    'TEST_DB': 'test_nominatim',
+    'API_TEST_DB': 'test_api_nominatim',
+    'API_TEST_FILE': TEST_BASE_DIR / 'testdb' / 'apidb-test-data.pbf',
+    'TOKENIZER': None,  # Test with a custom tokenizer
+    'STYLE': 'extratags',
     'API_ENGINE': 'falcon'
 }
 
-use_step_matcher("re")
+
+use_step_matcher("re")  # noqa: F405
+
 
 def before_all(context):
     # logging setup
     context.config.setup_logging()
     # set up -D options
-    for k,v in userconfig.items():
+    for k, v in userconfig.items():
         context.config.userdata.setdefault(k, v)
     # Nominatim test setup
     context.nominatim = NominatimEnvironment(context.config.userdata)
     context.osm = GeometryFactory()
 
 
 def before_scenario(context, scenario):
-    if not 'SQLITE' in context.tags \
+    if 'SQLITE' not in context.tags \
        and context.config.userdata['API_TEST_DB'].startswith('sqlite:'):
         context.scenario.skip("Not usable with Sqlite database.")
     elif 'DB' in context.tags:
@@ -56,6 +58,7 @@ def before_scenario(context, scenario):
     elif 'UNKNOWNDB' in context.tags:
         context.nominatim.setup_unknown_db()
 
+
 def after_scenario(context, scenario):
     if 'DB' in context.tags:
         context.nominatim.teardown_db(context)

test/bdd/steps/check_functions.py

@@ -2,7 +2,7 @@
 #
 # This file is part of Nominatim. (https://nominatim.org)
 #
-# Copyright (C) 2023 by the Nominatim developer community.
+# Copyright (C) 2025 by the Nominatim developer community.
 # For a full list of authors see the git log.
 """
 Collection of assertion functions used for the steps.
@@ -11,9 +11,10 @@
 import math
 import re
 
-OSM_TYPE = {'N' : 'node', 'W' : 'way', 'R' : 'relation',
-            'n' : 'node', 'w' : 'way', 'r' : 'relation',
-            'node' : 'n', 'way' : 'w', 'relation' : 'r'}
+
+OSM_TYPE = {'N': 'node', 'W': 'way', 'R': 'relation',
+            'n': 'node', 'w': 'way', 'r': 'relation',
+            'node': 'n', 'way': 'w', 'relation': 'r'}
 
 
 class OsmType:
@@ -23,11 +24,9 @@ class OsmType:
     def __init__(self, value):
         self.value = value
 
-
     def __eq__(self, other):
         return other == self.value or other == OSM_TYPE[self.value]
 
-
     def __str__(self):
         return f"{self.value} or {OSM_TYPE[self.value]}"
 
@@ -81,7 +80,6 @@ def __str__(self):
         return str(self.coord)
 
 
-
 def check_for_attributes(obj, attrs, presence='present'):
     """ Check that the object has the given attributes. 'attrs' is a
         string with a comma-separated list of attributes. If 'presence'
@@ -99,4 +97,3 @@ def _dump_json():
         else:
             assert attr in obj, \
                    f"No attribute '{attr}'. Full response:\n{_dump_json()}"
-