Deploy script for Windows

utilities.py

@@ -8,23 +8,35 @@ from PyQt5.QtWidgets import QMessageBox
 
 from constants import Constants, Signal, Database, ChecksumWhat
 
+
 def resource_path(relative_path):
+    """Get absolute path to resource, works for dev and for PyInstaller."""
     try:
         base_path = sys._MEIPASS
     except Exception:
         base_path = os.path.abspath(".")
     return os.path.join(base_path, relative_path)
 
+
 def uncheck_and_emit(button):
+    """Set the button to the unchecked state and emit the clicked signal."""
     if button.isChecked():
         button.setChecked(False)
         button.clicked.emit()
 
+
 def pop_up(cls, title, text,
            informative_text=None,
            connection=None,
            is_question=False,
            default_btn=QMessageBox.Yes):
+    """Return a QMessageBox object.
+
+    Keyword arguments:
+    informative_text -- possible informative text to be displayed.
+    connection -- a callable to connect the message when emitting the finished signal.
+    is_question -- whether the message contains a question.
+    default_btn -- the default button for the possible answer to the question."""
     msg = QMessageBox(cls)
     msg.setWindowTitle(title)
     msg.setText(text)
@@ -38,7 +50,9 @@ def pop_up(cls, title, text,
     msg.adjustSize()
     return msg
 
+
 def checksum_ok(data, what):
+    """Check whether the checksum of the 'data' argument is correct."""
     code = hashlib.sha256()
     code.update(data)
     if what is ChecksumWhat.FOLDER:
@@ -56,7 +70,11 @@ def checksum_ok(data, what):
         raise
     return code.hexdigest() == reference
 
+
 def connect_events_to_func(events_to_connect, fun_to_connect, fun_args):
+    """Connect all elements of events_to_connect to the callable fun_to_connect.
+
+    fun_args is a list of fun_to_connect arguments."""
     if fun_args is not None:
         for event in events_to_connect:
             event.connect(partial(fun_to_connect, *fun_args))
@@ -64,22 +82,30 @@ def connect_events_to_func(events_to_connect, fun_to_connect, fun_args):
         for event in events_to_connect:
             event.connect(fun_to_connect)
 
+
 def filters_limit(spinbox, filter_unit, confidence, sign=1):
-        band_filter = spinbox.value() * Constants.CONVERSION_FACTORS[filter_unit.currentText()]
-        return band_filter + sign * (confidence.value() * band_filter) // 100
+    """Return the actual limit of a numerical filter."""
+    band_filter = spinbox.value() * Constants.CONVERSION_FACTORS[filter_unit.currentText()]
+    return band_filter + sign * (confidence.value() * band_filter) // 100
+
 
 def is_undef_freq(current_signal):
+    """Return whether the lower or upper frequency of a signal is undefined."""
     lower_freq = current_signal.at[Signal.INF_FREQ]
     upper_freq = current_signal.at[Signal.SUP_FREQ]
     return lower_freq == Constants.UNKNOWN or upper_freq == Constants.UNKNOWN
 
+
 def is_undef_band(current_signal):
+    """Return whether the lower or upper band of a signal is undefined."""
     lower_band = current_signal.at[Signal.INF_BAND]
     upper_band = current_signal.at[Signal.SUP_BAND]
     return lower_band == Constants.UNKNOWN or upper_band == Constants.UNKNOWN
 
-def _change_unit(num):
-    digits = len(num)
+
+def _change_unit(str_num):
+    """Return a scale factor given the number of digits of a numeric string."""
+    digits = len(str_num)
     if digits < 4:
         return 1
     elif digits < 7:
@@ -89,14 +115,16 @@ def _change_unit(num):
     else:
         return 10**9
 
+
 def format_numbers(lower, upper):
+    """Return the string which displays the numeric limits of a filter."""
     units = {1: 'Hz', 1000: 'kHz', 10**6: 'MHz', 10**9: 'GHz'}
     lower_factor = _change_unit(lower)
     upper_factor = _change_unit(upper)
     pre_lower = lower
     pre_upper = upper
-    lower = int(lower) / lower_factor
-    upper = int(upper) / upper_factor
+    lower = safe_cast(lower, int) / lower_factor
+    upper = safe_cast(upper, int) / upper_factor
     if lower.is_integer():
         lower = int(lower)
     else:
@@ -109,3 +137,19 @@ def format_numbers(lower, upper):
         return f"{lower:,} {units[lower_factor]} - {upper:,} {units[upper_factor]}"
     else:
         return f"{lower:,} {units[lower_factor]}"
+
+
+def safe_cast(value, cast_type, default=-1):
+    """Call 'cast_type(value)' and return the result.
+
+    If the operation fails return 'default'.
+    Should be used to perform 'safe casts'.
+    Keyword argument:
+    default -- default value returned if the cast fails.
+    """
+    try:
+        r = cast_type(value)
+    except Exception:
+        r = default
+    finally:
+        return r