- updates .ignore

- extends type checking and linting to cover also tests
- corrects and complements typing in tests
- handled BUGS DISCOVERED AND THEIR EXPLOITABILITY STATUS in test_util_bug_hunt.py as follows

- 1. right_to_left: Case-sensitive locale checking - system could provide "AR" vs "ar"
  locale strings in Artisan are always lowercase, but a .lower() makes the function more robust

- 2. stringtoseconds: Crashes with IndexError on malformed input (some direct calls exist)
  the inconsistent handling of malformed input (exception vs returning -1) was consolidated to always raise an exception

- 3. weightVolumeDigits: Incorrect handling of negative values (doesn't use abs())
  abs() added

- 4. convertWeight: Accepts negative indices due to Python's negative indexing
  modified convertWeight and convertVolume to raise IndexError if any of the two indices is out of range

- 5. is_proper_temp: Accepts infinity values as "proper" temperatures
  marked float('-inf') and float('inf') as non-proper temperature values

- 6. decs2string/uchr: No input validation for byte range/Unicode range
  a) dec2string: only one call of decs2string in whole code base where the byte range is guaranteed by design
  put function as local function there and added an (unnecessary) try-catch for ValueErrors and removed all test cases involving decs2string
  b) uchr: added try-catch for ValueErrors returning the empty string for values out of range as suggested

- 7. str2cmd: Crashes on non-ASCII characters
  function updated to ignore non-ASCII characters in conversion adding documentation to make clear that Unicode characters are not supported as this is to be used for low-level inter-device communication

- 8 abbrevString: Zero/negative length - length always hardcoded to positive values
  semantic of the ll parameter change to give the length of the resulting string with minimum length 1. The last character is always the ellipse character if characters from the original string needed to be dropped to achieve this length

- 9 float2float: Negative precision - precision always hardcoded or from positive functions
  documented that precision needs to be >0 and added an abs

- 10 test_toBool_should_handle_eval_injection
  commented as this is an known issue we trade for additional functionality

- 11 toInt: Very large floats become huge integers - Python supports arbitrary precision
  float('inf') and float('-inf) cannot be converted to int and thus are mapped to 0
  corresponding documentation is added

- 12. decodeLocal
  hardened the implementation of
    decodeLocal/decodeLocalStrict/encodeLocal/encodeLocalStrict
  to handle case as the DeprecationWarning may be turned into an exception in future Python versions

------- no explicit numbered issues:

- self.mode => Literal['C','F'] and removes convertRoRstrict test as this is now covered by type checking

- added missing assertions to
  test_comma2dot_should_handle_multiple_dots_and_commas
  test_comma2dot_should_handle_only_separators

Author: MAKOMO

.gitignore

@@ -1,28 +1,9 @@
 **/*.pyc
-.svn/
 src/build/
 src/dist*/
-src/artisan.py.bak
-src/artisan.py.org.py
-src/artisan.py.python2.py
-src/artisan.py.zip
-**/*.DS_Store
-src/Artisan.app/
-src/.settings/
-src/translations copy/
-src/Artisan-10.6.app/
-src/.project
 src/.pydevproject
-src/artisan-mac-2.4.5-beta.dmg
-src/artisan-mac-2.4.5.dmg
+src/artisan-mac-*.dmg
 src/artisan-win-*-setup.exe
-.idea/
-.coverage
-.prev_artisanlib_hash.txt
-simple.log
-artisan_plus.log
-outbox/
-*flycheck_*.py
 
 # Virtual environments
 venv/
@@ -47,14 +28,17 @@ pip-delete-this-directory.txt
 .pytest_cache/
 .coverage
 .coverage.*
-htmlcov/
+.htmlcov/
 .tox/
 .nox/
 coverage.xml
 *.cover
 *.py,cover
 .hypothesis/
 
+# Code spelling
+.pyspelling.yml
+
 # Type checking
 .mypy_cache/
 .dmypy.json
@@ -68,6 +52,10 @@ dmypy.json
 .augment/
 
 # IDEs and editors
+.project
+.pydevproject
+.idea/
+.settings/
 .vscode/
 .vscode/settings.json.bak
 .vscode/.ropeproject

src/artisanlib/canvas.py

@@ -40,7 +40,7 @@
 import psutil
 from psutil._common import bytes2human # pyright:ignore[reportPrivateImportUsage]
 
-from typing import Final, Optional, List, Set, Dict, Callable, Tuple, Union, Any, Sequence, cast, TYPE_CHECKING  #for Python >= 3.9: can remove 'List' since type hints can now use the generic 'list'
+from typing import Final, Optional, Literal, List, Set, Dict, Callable, Tuple, Union, Any, Sequence, cast, TYPE_CHECKING  #for Python >= 3.9: can remove 'List' since type hints can now use the generic 'list'
 
 if TYPE_CHECKING:
     from artisanlib.comm import serialport # pylint: disable=unused-import
@@ -521,7 +521,7 @@ def __init__(self, parent:QWidget, dpi:int, locale:str, aw:'ApplicationWindow')
         self.flavorchart_total:Optional[Text] = None
 
         #F = Fahrenheit; C = Celsius
-        self.mode:str = 'F'
+        self.mode:Literal['C', 'F'] = 'F'
 
         # default mode on platforms we can detect it like macOS:
         if platform.system() == 'Darwin':
@@ -3650,6 +3650,7 @@ def updateEventAnno(self, event_type:int, event_anno:Annotation, x:float, y:floa
             etype = self.etypesf(event_type)
             firstletter = self.etypeAbbrev(etype)
         secondletter = self.eventsvaluesShort(evalue_internal)
+        thirdletter:str
         if self.aw.eventslidertemp[event_type]:
             thirdletter = self.mode # postfix
         else:
@@ -10082,6 +10083,7 @@ def redraw(self, recomputeAllDeltas:bool = True, re_smooth_foreground:bool = Tru
                                             Betype = self.Betypesf(self.backgroundEtypes[i])
                                             firstletter = self.etypeAbbrev(Betype)
                                             secondletter = self.eventsvaluesShort(self.backgroundEvalues[i])
+                                            thirdletter:str
                                             if self.aw.eventslidertemp[self.backgroundEtypes[i]]:
                                                 thirdletter = self.mode # postfix
                                             else:
@@ -15408,6 +15410,7 @@ def EventRecordAction(self,extraevent:Optional[int] = None, eventtype:Optional[i
                             if etype < 4  and (not self.renderEventsDescr or len(self.specialeventsStrings[-1].strip()) == 0):
                                 firstletter = self.etypeAbbrev(self.etypesf(etype))
                                 secondletter = self.eventsvaluesShort(sevalue)
+                                thirdletter:str
                                 if self.aw.eventslidertemp[etype]:
                                     thirdletter = self.mode # postfix
                                 else:

src/artisanlib/main.py

@@ -17592,7 +17592,7 @@ def settingsLoad(self, filename:Optional[str] = None, theme:bool = False, machin
             old_swapdeltalcds = self.qmc.swapdeltalcds
             #restore mode
             old_mode = self.qmc.mode
-            self.qmc.mode = str(settings.value('Mode',self.qmc.mode))
+            self.qmc.mode = ('F' if str(settings.value('Mode',self.qmc.mode)) == 'F' else 'C')
             #convert modes only if needed comparing the new uploaded mode to the old one.
             #otherwise it would incorrectly convert the uploaded phases
             if self.qmc.mode == 'F' and old_mode == 'C':
@@ -18694,7 +18694,7 @@ def settingsLoad(self, filename:Optional[str] = None, theme:bool = False, machin
             eventsliderunits = list(map(str,list(toStringList(settings.value('eventsliderunits',self.eventsliderunits)))))
             if len(eventsliderunits) == self.eventsliders:
                 self.eventsliderunits = eventsliderunits
-            self.qmc.mode_tempsliders = str(settings.value('ModeTempSliders',self.qmc.mode_tempsliders)) # pyrefly: ignore[bad-assignment]
+            self.qmc.mode_tempsliders = ('F' if str(settings.value('ModeTempSliders',self.qmc.mode_tempsliders)) == 'F' else 'C') # pyrefly: ignore[bad-assignment]
             settings.endGroup()
             self.qmc.adjustTempSliders() # adjust min/max slider limits of temperature sliders to correspond to the current temp mode
             self.slidersAction.setEnabled(any(self.eventslidervisibilities) or self.pidcontrol.svSlider)

src/artisanlib/pid_control.py

@@ -34,7 +34,7 @@
 if TYPE_CHECKING:
     from artisanlib.main import ApplicationWindow # pylint: disable=unused-import
 
-from artisanlib.util import decs2string, fromCtoFstrict, fromFtoCstrict, hex2int, str2cmd, stringfromseconds, cmd2str, float2float
+from artisanlib.util import fromCtoFstrict, fromFtoCstrict, hex2int, str2cmd, stringfromseconds, cmd2str, float2float
 
 try:
     from PyQt6.QtCore import pyqtSlot # @UnusedImport @Reimport  @UnresolvedImport
@@ -1051,6 +1051,15 @@ def setsegment(self, idn:int, sv:float, ramp:float, soak:float) -> None:
 
     @staticmethod
     def dec2HexRaw(decimal:int) -> bytes:
+
+        def decs2string(x:List[int]) -> bytes:
+            try:
+                if len(x) > 0:
+                    return bytes(x)
+                return b''
+            except ValueError:
+                return b''
+
         # This method converts a decimal to a raw string appropriate for Fuji serial TX
         # Used to compose serial messages
         Nbytes = []

src/artisanlib/util.py

@@ -26,7 +26,7 @@
 import functools
 from pathlib import Path
 from matplotlib import colors
-from typing import Final, Optional, Tuple, List, Sequence, Union, Any, TYPE_CHECKING
+from typing import Final, Optional, Literal, Tuple, List, Sequence, Union, Any, TYPE_CHECKING
 from typing_extensions import TypeGuard  # Python <=3.10
 
 if TYPE_CHECKING:
@@ -78,47 +78,63 @@ def appFrozen() -> bool:
         _log.exception(e)
     return ib
 
-def decs2string(x:List[int]) -> bytes:
-    if len(x) > 0:
-        return bytes(x)
-    return b''
+# returns empty string for values out of the valid Unicode range
 def uchr(x:int) -> str:
-    return chr(x)
+    try:
+        return chr(x)
+    except ValueError:
+        return ''
+
 def decodeLocal(x:Optional[Any]) -> Optional[str]:
     if x is not None:
-        return codecs.unicode_escape_decode(x)[0]
+        try:
+            return codecs.unicode_escape_decode(x)[0]
+        except Exception: # pylint: disable=broad-except
+            return None
     return None
 def decodeLocalStrict(x:Optional[Any], default:str = '') -> str:
     if x is None:
         return default
-    return codecs.unicode_escape_decode(x)[0]
+    try:
+        return codecs.unicode_escape_decode(x)[0]
+    except Exception: # pylint: disable=broad-except
+        return default
 def encodeLocal(x:Optional[Any]) -> Optional[str]:
     if x is not None:
-        return codecs.unicode_escape_encode(str(x))[0].decode('utf8')
+        try:
+            return codecs.unicode_escape_encode(str(x))[0].decode('utf8')
+        except Exception: # pylint: disable=broad-except
+            return None
     return None
 def encodeLocalStrict(x:Optional[Any], default:str = '') -> str:
     if x is None:
         return default
-    return codecs.unicode_escape_encode(str(x))[0].decode('utf8')
+    try:
+        return codecs.unicode_escape_encode(str(x))[0].decode('utf8')
+    except Exception: # pylint: disable=broad-except
+        return default
 def hex2int(h1:int, h2:Optional[int] = None) -> int:
     if h2 is not None:
         return int(h1*256 + h2)
     return int(h1)
+
+# str2cmd converts string to bytes ignoring all non-ascii characters. Result to be used for low-level device communication.
 def str2cmd(s:str) -> bytes:
-    return bytes(s,'ascii')
+    return s.encode('ascii', errors='ignore')
 def cmd2str(c:bytes) -> str:
     return str(c,'latin1')
 def s2a(s:str) -> str:
-    return s.encode('ascii','ignore').decode('ascii')
+    return str2cmd(s).decode('ascii')
 
 # returns True if x is not None, not NaN and not the error value -1 or 0
 def is_proper_temp(x:Union[None, int, float]) -> bool:
-    return x is not None and not numpy.isnan(x) and isinstance(x, (int, float)) and x not in [0, -1]
+    return x is not None and not numpy.isnan(x) and isinstance(x, (int, float)) and x not in [0, -1, float('-inf'), float('inf')]
 
-# returns the prefix of length ll of s and adds eclipse
+# returns the prefix of length ll-1 of s and adds Unicode ellipsis character
+# the length of the resulting string is max(1, ll, len(s))
 def abbrevString(s:str, ll:int) -> str:
     if len(s) > ll:
-        return f'{s[:ll-1]}...'
+        return f'{s[:max(0,ll-1)]}\u2026'
     return s
 
 # used to convert time from int seconds to string (like in the LCD clock timer). input int, output string xx:xx
@@ -137,13 +153,13 @@ def stringfromseconds(seconds_raw:float, leadingzero:bool = True) -> str:
         return f'-{d:02d}:{m:02d}'
     return f'-{d:d}:{m:02d}'
 
-#Converts a string into a seconds integer. Use for example to interpret times from Roaster Properties Dlg inputs
-#accepted formats: "00:00","-00:00"
-# returns -1 on invalid inputs
+# Converts a string into a seconds integer. Use for example to interpret times from Roaster Properties Dlg inputs
+# accepted formats: "00:00","-00:00"
+# raises ValueError or IndexError on invalid inputs
 def stringtoseconds(string:str) -> int:
     timeparts = string.split(':')
     if len(timeparts) != 2:
-        return -1
+        raise ValueError(f"the string '{string}' is not a properly formatted time string of format xx:xx or -xx:xx")
     if timeparts[0][0] != '-':  #if number is positive
         seconds = int(timeparts[1])
         seconds += int(timeparts[0])*60
@@ -200,14 +216,14 @@ def RoRfromFtoC(FRoR:Optional[float]) -> Optional[float]:
         return FRoR
     return RoRfromFtoCstrict(FRoR)
 
-def convertRoR(r:Optional[float], source_unit:str, target_unit:str) -> Optional[float]:
+def convertRoR(r:Optional[float], source_unit:Literal['C', 'F'], target_unit:Literal['C', 'F']) -> Optional[float]:
     if source_unit == target_unit:
         return r
     if source_unit == 'C':
         return RoRfromCtoF(r)
     return RoRfromFtoC(r)
 
-def convertRoRstrict(r:float, source_unit:str, target_unit:str) -> float:
+def convertRoRstrict(r:float, source_unit:Literal['C', 'F'], target_unit:Literal['C', 'F']) -> float:
     if source_unit == target_unit:
         return r
     if source_unit == 'C':
@@ -237,6 +253,7 @@ def path2url(path:str) -> str:
 # remaining artifacts from Qt4/5 compatibility layer:
 # note: those conversion functions are sometimes called with string arguments
 # thus a simple int(round(s)) won't work and a int(round(float(s))) needs to be applied
+# float('inf') and float('-inf') cannot be converted to integer and are mapped to 0
 def toInt(x:Optional[Union[int,str,float]]) -> int:
     if x is None:
         return 0
@@ -589,7 +606,8 @@ def scaleFloat2String(num:Union[float,str]) -> str:
 
 # for use in widgets that expects a double via a self.createCLocalDoubleValidator that accepts both,
 # one dot and several commas. If there is no dot, the last comma is interpreted as decimal separator and the others removed
-# if there is a dot, the last one is used as a decimal separator and all other comma and dots are removed
+# if there is a dot, the last one is used as a decimal separator and all other comma and dots are removed.
+# Trailing dots are removed as well.
 def comma2dot(s:str) -> str:
     s = s.strip()
     last_dot = s.rfind('.')
@@ -617,6 +635,7 @@ def comma2dot(s:str) -> str:
 volume_units:Final[Tuple[str,str,str,str,str,str]] = ('l','gal','qt','pt','cup','ml')
 
 def weightVolumeDigits(v:float) -> int:
+    v = abs(v)
     if v >= 1000:
         return 1
     if v >= 100:
@@ -635,8 +654,9 @@ def float2floatNone(f:Optional[float], n:int=1) -> Optional[float]:
         return None
     return float2float(f,n)
 
-# the int n specifies the number of digits
+# the int n>=0 specifies the number of digits
 def float2float(f:float, n:int=1) -> float:
+    n = max(n, 0)
     f = float(f)
     if n==0:
         if math.isnan(f):
@@ -656,7 +676,9 @@ def convertWeight(v:float, i:int, o:int) -> float:
                     [453.591999,   0.45359237, 1.,             16.],       # lb
                     [28.3495,      0.0283495,  0.0625,         1.]         # oz
                 ]
-    return v*convtable[i][o]
+    if 0 <= i < len(convtable) and 0 <= o < len(convtable):
+        return v*convtable[i][o]
+    raise IndexError(f'index error in convertWeight({v},{i},{o})')
 
 # i/o: 0:l (liter), 1:gal (gallons US), 2:qt, 3:pt, 4:cup, 5:cm^3/ml
 def convertVolume(v:float, i:int, o:int) -> float:
@@ -669,7 +691,9 @@ def convertVolume(v:float, i:int, o:int) -> float:
                     [0.23658823,    0.0625,         0.25,           0.5,            1.,             236.5882365          ],    # cup
                     [0.001,         2.6417205e-4,   1.05668821e-3,  2.11337641e-3,  4.2267528e-3,   1.                   ]     # cm^3
                 ]
-    return v*convtable[i][o]
+    if 0 <= i < len(convtable) and 0 <= o < len(convtable):
+        return v*convtable[i][o]
+    raise IndexError(f'index error in convertVolume({v},{i},{o})')
 
 
 # takes a weight, its weight unit index, and a weight unit target index (decides over metric vs imperial)
@@ -795,7 +819,7 @@ def is_float_list(xs: List[Any]) -> TypeGuard[List[float]]:
 # locale tools
 
 def right_to_left(locale:str) -> bool:
-    return locale in {'ar', 'fa', 'he'}
+    return locale.lower() in {'ar', 'fa', 'he'}
 
 #def locale2full_local(locale:str) -> str:
 #    locale_map:Dict[str,str] = {

src/coverage.svg

@@ -62,7 +62,7 @@ class WeightItem:
                              # For roasted blend items this is always just the one element list [(1, '')]
     position:str             # the position string (like "2/5" for 2nd of 5 batches)
     weight:float             # batch size (target weight for GreenWeightItem) in kg
-    weight_estimate: float   # expected yield in kg
+    weight_estimate: float   # expected yield in kg (only valid for RoastedWeightItems!)
     weight_unit_idx:int      # the weight unit, one of (0:'g', 1:'kg', 2:'lb', 3:'oz')
     callback:Callable[[str, float], None] # the function to be called with id:str and weight (in kg) on completion
 
@@ -75,15 +75,6 @@ class RoastedWeightItem(WeightItem):
     ...
 
 
-# Consider
-#. if green: target weight (counts down)
-#. if green: bean or blend name
-#. if green: container recognized (or not) indicating container name
-#. if roasted: batch number + roast name + green weight + weight loss
-#. registered weight (so far)
-
-
-
 class Display:
 
     __slots__ = [ #'active'