wip

Author: ronanstokes-db

makefile

@@ -87,6 +87,14 @@ dev-test:
 	@echo "$(OK_COLOR)=> Running unit tests in directory $(PWD) $(NO_COLOR)"
 	pytest tests/ --cov $(PACKAGE_NAME) --cov-report=xml
 
+dev-lint-report:
+	@echo "$(OK_COLOR)=> Running Prospector lint reporting $(PWD) $(NO_COLOR)"
+	prospector --profile prospector.yaml > prospector_report.txt
+
+dev-lint:
+	@echo "$(OK_COLOR)=> Running Prospector lint reporting $(PWD) $(NO_COLOR)"
+	prospector --profile prospector.yaml
+
 dev-test-with-html-report:
 	@echo "$(OK_COLOR)=> Running unit tests with HTML test coverage report$(NO_COLOR)"
 	pytest --cov $(PACKAGE_NAME) --cov-report html -s

prospector.yaml

@@ -33,6 +33,9 @@ pylint:
     - too-many-branches
     - unnecessary-lambda
     - unused-variable  # TBD: this rule is actually a good one, we need to disable it and refactor code
+    - logging-fstring-interpolation # using f-strings for logging where cost of computing string is low
+    - unnecessary-lambda-assignment # in some cases, prefer using lambda rather than function for clarity / conciseness
+    - redefined-outer-name  # pylint flags use of pytest fixtures as redefinition
 
 pyflakes:
   disable:
@@ -53,6 +56,7 @@ pep8:
     - E128 # formatting only
     - E126 # formatting only
     - N815 # disabled as we use mixed case names following pyspark convention
+    - E731 # prefer use of lambda in some cases for clarity / conciseness
 
 mccabe:
   disable:

tests/test_text_templates.py

@@ -124,14 +124,14 @@ def test_rnd_compute(self, templateProvided, escapeSpecial, useTemplateObject):
         assert len(template_choices) == len(template_rnds)
         assert len(template_choices) == len(template_rnd_bounds)
 
-        for ix in range(len(template_choices)):
+        for ix, _ in enumerate(template_choices):
             bounds = template_rnd_bounds[ix]
             rnds = template_rnds[ix]
 
             assert len(bounds) == len(rnds)
 
-            for iy in range(len(bounds)):
-                assert bounds[iy] == -1 or (rnds[iy] < bounds[iy])
+            for iy, bounds_value in enumerate(bounds):
+                assert bounds_value == -1 or (rnds[iy] < bounds_value)
 
     @pytest.mark.parametrize("templateProvided, escapeSpecial, useTemplateObject",
                              [  # (r'\w \w|\w \v. \w', False, False),
@@ -221,14 +221,14 @@ def test_use_pandas(self, templateProvided, escapeSpecial, useTemplateObject):
         assert len(template_choices) == len(template_rnds)
         assert len(template_choices) == len(template_rnd_bounds)
 
-        for ix in range(len(template_choices)):
+        for ix, _ in enumerate(template_choices):
             bounds = template_rnd_bounds[ix]
             rnds = template_rnds[ix]
 
             assert len(bounds) == len(rnds)
 
-            for iy in range(len(bounds)):
-                assert bounds[iy] == -1 or (rnds[iy] < bounds[iy])
+            for iy, bounds_value in enumerate(bounds):
+                assert bounds_value == -1 or (rnds[iy] < bounds_value)
 
         results = template1.pandasGenerateText(arr)
         assert results is not None
@@ -238,14 +238,13 @@ def test_use_pandas(self, templateProvided, escapeSpecial, useTemplateObject):
         results_rows = len(results_list)
         assert results_rows == TEST_ROWS
 
-        for r in range(len(results)):
-            result_str = results[r]
+        for r, result_str in enumerate(results):
             assert result_str is not None and isinstance(result_str, str)
             assert len(result_str) >= 0
 
         print("results")
-        for i in range(len(results)):
-            print(f"{i}: '{results[i]}'")
+        for i, result_value in enumerate(results):
+            print(f"{i}: '{result_value}'")
 
     @pytest.mark.parametrize("templateProvided, escapeSpecial, useTemplateObject",
                              [(r'\n', False, True),
@@ -270,14 +269,14 @@ def test_sub_value1(self, templateProvided, escapeSpecial, useTemplateObject):
         assert len(template_choices) == len(template_rnds)
         assert len(template_choices) == len(template_rnd_bounds)
 
-        for ix in range(len(template_choices)):
+        for ix, _ in enumerate(template_choices):
             bounds = template_rnd_bounds[ix]
             rnds = template_rnds[ix]
 
             assert len(bounds) == len(rnds)
 
-            for iy in range(len(bounds)):
-                assert bounds[iy] == -1 or (rnds[iy] < bounds[iy])
+            for iy, bounds_value in enumerate(bounds):
+                assert bounds_value == -1 or (rnds[iy] < bounds_value)
 
         results = template1.pandasGenerateText(arr)
         assert results is not None
@@ -287,14 +286,13 @@ def test_sub_value1(self, templateProvided, escapeSpecial, useTemplateObject):
         results_rows = len(results_list)
         assert results_rows == TEST_ROWS
 
-        for r in range(len(results)):
-            result_str = results[r]
+        for r, result_str in enumerate(results):
             assert result_str is not None and isinstance(result_str, str)
             assert len(result_str) >= 0
 
         print("results")
-        for i in range(len(results)):
-            print(f"{i}: '{results[i]}'")
+        for i, result_value in enumerate(results):
+            print(f"{i}: '{result_value}'")
 
     @pytest.mark.parametrize("templateProvided, escapeSpecial, useTemplateObject",
                              [(r'\w aAdDkK \w', False, False),