Add codespell in lint

data_validation_framework/task.py

@@ -175,7 +175,7 @@ def inputs(self):
         ),
     )
 
-    # User attributs
+    # User attributes
     output_columns = None
     """dict: A dict with names as keys and empty values as values for new columns created by the
     current task.
@@ -186,7 +186,7 @@ def inputs(self):
     :meth:`validation_function`.
     """
 
-    # Internal attributs
+    # Internal attributes
     nb_total = None
     """int: Total number of processed elements."""
     nb_valid = None
@@ -292,8 +292,8 @@ def kwargs(self):
     def read_dataset(self):
         """Import the dataset to a :class:`pandas.DataFrame`.
 
-        This method can be overriden to load custom data (e.g. GeoDataFrame, etc.).
-        The dataset should alway be loaded from the path given by `self.dataset_df`.
+        This method can be overridden to load custom data (e.g. GeoDataFrame, etc.).
+        The dataset should always be loaded from the path given by `self.dataset_df`.
         """
         return pd.read_csv(self.dataset_df, index_col=self.input_index_col)
 
@@ -653,7 +653,7 @@ def _process(self, df, *args, **kwargs):
 
 
 class SetValidationTask(BaseValidationTask):
-    """A class to validate an entire data set (usefull for global properties).
+    """A class to validate an entire data set (useful for global properties).
 
     The ``validation_function`` will receive the DataFrame and the output_path as first arguments.
 
@@ -807,8 +807,8 @@ def __init__(self, *args, **kwargs):
                 )
             else:
                 raise TypeError(
-                    "The SkippableMixin can only be associated with childs of ElementValidationTask"
-                    " or SetValidationTask"
+                    "The SkippableMixin can only be associated with children of "
+                    "ElementValidationTask or SetValidationTask"
                 )
             self._skippable_validation_function = self.validation_function
             self.validation_function = new_validation_function

tests/__init__.py

@@ -12,8 +12,11 @@ def check_files_exist(directory, pattern_list):
             assert re.match(str(pattern), path)
     except Exception as exc:
         raise RuntimeError(
-            f"Error when checking the files.\n\tThe directory is: {directory}\n"
-            f"\tThe found files are: {existing_files}\n"
-            f"\tThe patterns are: {pattern_list}"
+            "Error when checking the files.\n\t"
+            f"The directory is: {directory}\n"
+            "\t"
+            f"The found files are: {existing_files}\n"
+            "\t"
+            f"The patterns are: {pattern_list}"
         ) from exc
     return True

tests/test_task.py

@@ -2254,7 +2254,7 @@ class TestSkippableMixin:
 
     def test_fail_parent_type(self):
         err_msg = (
-            "The SkippableMixin can only be associated with childs of ElementValidationTask"
+            "The SkippableMixin can only be associated with children of ElementValidationTask"
             " or SetValidationTask"
         )
 

tox.ini

@@ -41,26 +41,29 @@ commands =
 [testenv:lint]
 basepython = python3.8
 deps =
+    black==21.4b2
+    codespell
+    isort
     pycodestyle
     pydocstyle
     pylint
-    isort
-    black==21.4b2
 commands =
+    codespell {[base]files}
     pycodestyle {[base]files}
     pydocstyle {[base]files}
     isort --check-only --diff {[base]files}
     black --check {[base]files}
-    pylint {[base]files}
+    pylint -j {env:PYLINT_NPROCS:1} {[base]files}
 
 [testenv:format]
 basepython = python3.8
 skip_install = true
 deps =
     black==21.4b2
+    codespell
     isort
-
 commands =
+    codespell -i 2 -w {[base]files}
     isort {[base]files}
     black {[base]files}