fix all lint issues

Author: lvrfrc87

.travis.yml

@@ -4,7 +4,7 @@ stages:
   - "lint"
   - "test"
 
-if: "type IN (pull_request)" # Add in "branch" as an option if desired for branch testing as well
+if: "type IN (pull_request)"  # Add in "branch" as an option if desired for branch testing as well
 language: "python"
 services:
   - "docker"
@@ -30,7 +30,7 @@ jobs:
         - "pip install invoke toml"
       script:
         - "invoke black"
-        - "invoke bandit" # Bandit fails to function on > Py3.8 https://github.com/PyCQA/bandit/issues/639
+        - "invoke bandit"  # Bandit fails to function on > Py3.8 https://github.com/PyCQA/bandit/issues/639
         # - "invoke pydocstyle"
         - "invoke flake8"
         - "invoke yamllint"

netcompare/evaluator.py

@@ -1,4 +1,4 @@
-"Diff evaluator."
+"""Diff evaluator."""
 import re
 import sys
 from collections import defaultdict

netcompare/runner.py

@@ -1,4 +1,4 @@
-"Library wrapper for output parsing."
+"""Library wrapper for output parsing."""
 import re
 from typing import Mapping, List, Union
 import jmespath

netcompare/utils/filter_parsers.py

@@ -1,4 +1,4 @@
-"Filtering parsing."
+"""Filtering parsing."""
 from typing import Mapping, List
 
 

netcompare/utils/flatten.py

@@ -1,4 +1,4 @@
-"Flatten multi-nested list."
+"""Flatten multi-nested list."""
 from typing import List, Generator
 
 

netcompare/utils/jmspath_parsers.py

@@ -1,4 +1,4 @@
-"JMSPath expresion parsers."
+"""JMSPath expresion parsers."""
 import re
 
 

netcompare/utils/refkey.py

@@ -1,15 +1,14 @@
+"""Reference key utilities."""
 from typing import Mapping, List
 
 
 def keys_cleaner(wanted_reference_keys: Mapping) -> List[Mapping]:
-    """
-    Get every required reference key from output.
-    """
+    """Get every required reference key from output."""
     if isinstance(wanted_reference_keys, list):
         return wanted_reference_keys
 
-    elif isinstance(wanted_reference_keys, dict):
-        my_keys_list = list()
+    if isinstance(wanted_reference_keys, dict):
+        my_keys_list = []
 
         if isinstance(wanted_reference_keys, dict):
             for key in wanted_reference_keys.keys():
@@ -21,12 +20,12 @@ def keys_cleaner(wanted_reference_keys: Mapping) -> List[Mapping]:
 
         return my_keys_list
 
+    return None
+
 
 def keys_values_zipper(list_of_reference_keys: List, wanted_value_with_key: List) -> List:
-    """
-    Build dictionary zipping keys with relative values.
-    """
-    final_result = list()
+    """Build dictionary zipping keys with relative values."""
+    final_result = []
 
     if len(list_of_reference_keys) != len(wanted_value_with_key):
         raise ValueError("Keys len != from Values len")
@@ -38,10 +37,7 @@ def keys_values_zipper(list_of_reference_keys: List, wanted_value_with_key: List
 
 
 def associate_key_of_my_value(paths: str, wanted_value: List) -> List:
-    """
-    Associate each key defined in path to every value found in output.
-    """
-
+    """Associate each key defined in path to every value found in output."""
     # global.peers.*.[is_enabled,is_up] / result.[*].state
     find_the_key_of_my_values = paths.split(".")[-1]
 
@@ -53,10 +49,10 @@ def associate_key_of_my_value(paths: str, wanted_value: List) -> List:
     else:
         my_key_value_list = [find_the_key_of_my_values]
 
-    final_list = list()
+    final_list = []
 
     for items in wanted_value:
-        temp_dict = dict()
+        temp_dict = {}
 
         if len(items) != len(my_key_value_list):
             raise ValueError("Key's value len != from value len")

tasks.py

@@ -100,9 +100,9 @@ def rebuild(context):
 
 
 @task(help={"local": "Run locally or within the Docker container"})
-def pytest(context, local=INVOKE_LOCAL):
+def pytest(context, path=".", local=INVOKE_LOCAL):
     """Run pytest test cases."""
-    exec_cmd = "pytest"
+    exec_cmd = f"pytest {path}"
     run_cmd(context, exec_cmd, local)
 
 

tests/test_diff_generator.py

@@ -1,10 +1,11 @@
+"""Diff generator unit tests."""
 import pytest
-from .utility import load_json_file
 from netcompare.evaluator import diff_generator
 from netcompare.runner import extract_values_from_output
+from .utility import load_json_file
 
 
-assertion_failed_message = """Test output is different from expected output.
+ASSERTION_FAILED_MESSAGE = """Test output is different from expected output.
 output: {output}
 expected output: {expected_output}
 """
@@ -69,4 +70,4 @@ def test_eval(filename, path, exclude):
     post_value = extract_values_from_output(post_data, path, exclude)
     output = diff_generator(pre_value, post_value)
 
-    assert expected_output == output, assertion_failed_message.format(output=output, expected_output=expected_output)
+    assert expected_output == output, ASSERTION_FAILED_MESSAGE.format(output=output, expected_output=expected_output)

tests/test_filter_parsers.py

@@ -3,7 +3,7 @@
 from netcompare.utils.filter_parsers import exclude_filter
 
 
-assertion_failed_message = """Test output is different from expected output.
+ASSERTION_FAILED_MESSAGE = """Test output is different from expected output.
 output: {output}
 expected output: {expected_output}
 """
@@ -41,4 +41,4 @@
 @pytest.mark.parametrize("exclude, data, expected_output", exclude_filter_tests)
 def test_exclude_filter(exclude, data, expected_output):
     exclude_filter(data, exclude)
-    assert expected_output == data, assertion_failed_message.format(output=data, expected_output=expected_output)
+    assert expected_output == data, ASSERTION_FAILED_MESSAGE.format(output=data, expected_output=expected_output)