Pylint

Author: mshukuno

popsborder/effectiveness.py

@@ -1,3 +1,22 @@
+# Simulation of contaminated consignments and their inspections
+# Copyright (C) 2018-2022 Vaclav Petras and others (see below)
+
+# This program is free software; you can redistribute it and/or modify it under
+# the terms of the GNU General Public License as published by the Free Software
+# Foundation; either version 2 of the License, or (at your option) any later
+# version.
+
+# This program is distributed in the hope that it will be useful, but WITHOUT
+# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+# FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
+# details.
+
+# You should have received a copy of the GNU General Public License along with
+# this program; if not, see https://www.gnu.org/licenses/gpl-2.0.html
+
+"""Effectiveness configuration and validation"""
+
+
 def validate_effectiveness(config, verbose=False):
     """Set the effectiveness of the inspector.
 
@@ -7,20 +26,16 @@ def validate_effectiveness(config, verbose=False):
     :param config: Configuration file
     :param verbose: Print the message if True
     """
-    try:
-        if isinstance(config, dict):
-            effectiveness = 1
-            if "effectiveness" in config["inspection"]:
-                if 0 <= config["inspection"]["effectiveness"] <= 1:
-                    effectiveness = config["inspection"]["effectiveness"]
-                else:
-                    if verbose:
-                        print(
-                            "Effectiveness out of range: it should be between "
-                            "0 and 1."
-                        )
+    effectiveness = 1
+
+    if isinstance(config, dict):
+        if "effectiveness" in config["inspection"]:
+            if 0 <= config["inspection"]["effectiveness"] <= 1:
+                effectiveness = config["inspection"]["effectiveness"]
             else:
                 if verbose:
-                    print("Effectiveness not set in the configuration file.")
-    finally:
-        return effectiveness
+                    print(
+                        "Effectiveness out of range: it should be between "
+                        "0 and 1."
+                    )
+    return effectiveness

popsborder/inspections.py

@@ -435,7 +435,6 @@ def inspect(config, consignment, n_units_to_inspect, detailed):
         config, consignment, n_units_to_inspect
     )
 
-    # TODO May not be needing this if default effectiveness is added to config.
     effectiveness = validate_effectiveness(config)
 
     # Inspect selected boxes, count opened boxes, inspected items,

tests/test_effectiveness.py

@@ -64,7 +64,7 @@
     items_inspected_detection=0,
     contaminated_items_completion=0,
     contaminated_items_detection=0,
-    contaminated_items_missed=0
+    contaminated_items_missed=0,
 )
 
 config = load_configuration_yaml_from_text(CONFIG)