Formatting fixes

Author: MrClock8163

examples/morse.py

@@ -8,7 +8,7 @@
 
 
 def morse_beep(tps: TPS1200P, message: str, intensity: int):
-    def letter_beep(tps: TPS1200P, l: str, intensity: int):
+    def letter_beep(tps: TPS1200P, letter: str, intensity: int):
         lookup = {
             "a": ".-",
             "b": "-...",
@@ -47,7 +47,7 @@ def letter_beep(tps: TPS1200P, l: str, intensity: int):
             "9": "----.",
             "0": "-----"
         }
-        code = lookup[l]
+        code = lookup[letter]
         for i, signal in enumerate(code):
             tps.bmm.beep_on(intensity)
             match signal:
@@ -58,7 +58,7 @@ def letter_beep(tps: TPS1200P, l: str, intensity: int):
             tps.bmm.beep_off()
             if i != len(code) - 1:
                 sleep(unit)
-        
+
     unit = 0.05
     words = message.lower().split(" ")
     for i, word in enumerate(words):
@@ -79,7 +79,7 @@ def cli():
     parser.add_argument("message", help="message to encode", type=str)
 
     args = parser.parse_args()
-    
+
     port = Serial(args.port)
     with SerialConnection(port) as conn:
         ts = TPS1200P(conn)

src/geocompy/__init__.py

@@ -12,7 +12,7 @@
 The package provides
     1. Utility data types for handling instrument responses
     2. Instrument software specific low level commands
-    3. Instrument-agnostic higher level functions for instrument types 
+    3. Instrument-agnostic higher level functions for instrument types
 
 Documentation
 -------------
@@ -58,8 +58,8 @@
 
 try:
     from ._version import __version__
-except:
-    __version__ = "0.0.0" # Placeholder value for source installs
+except Exception:
+    __version__ = "0.0.0"  # Placeholder value for source installs
 
 
 _T = TypeVar("_T")
@@ -163,6 +163,7 @@ class GeoComProtocol:
     Base class for GeoCom protocol versions.
 
     """
+
     def __init__(
         self,
         connection: Connection,
@@ -176,7 +177,7 @@ def __init__(
             (usually :class:`~communication.SerialConnection`).
         logger : ~logging.Logger | None, optional
             Logger to log all requests and responses, by default None
-        
+
         """
         self._conn: Connection = connection
         if logger is None:
@@ -217,7 +218,7 @@ def request(
         ------
         NotImplementedError
             If the method is not implemented on the child class.
-        
+
         """
         raise NotImplementedError()
 
@@ -250,13 +251,14 @@ def parse_response(
         ------
         NotImplementedError
             If the method is not implemented on the child class.
-            
+
         """
         raise NotImplementedError()
 
 
 class GsiOnlineResponse(Generic[_T]):
     """Container class for parsed GSI Online responses."""
+
     def __init__(
         self,
         desc: str,
@@ -293,7 +295,7 @@ def __init__(
         executed command."""
         self.comment: str = comment
         """Additional comment (e.g. explanation of an error)."""
-    
+
     def __str__(self) -> str:
         success = (
             "success"
@@ -306,7 +308,7 @@ def __str__(self) -> str:
             f"value: {self.value}, "
             f"(cmd: '{self.cmd}', response: '{self.response}')"
         )
-    
+
     def __bool__(self) -> bool:
         return self.value is not None
 
@@ -315,6 +317,7 @@ class GsiOnlineProtocol:
     """
     Base class for GSI Online protocol versions.
     """
+
     def __init__(
         self,
         connection: Connection,
@@ -334,7 +337,7 @@ def __init__(
             logger = Logger("/dev/null")
             logger.addHandler(NullHandler())
         self._logger: Logger = logger
-    
+
     def setrequest(
         self,
         param: int,
@@ -418,7 +421,7 @@ def putrequest(
             If the method is not implemented on the child class.
         """
         raise NotImplementedError()
-    
+
     def getrequest(
         self,
         mode: Literal['I', 'M', 'C'],

src/geocompy/communication.py

@@ -287,7 +287,9 @@ def receive(self) -> str:
         eoabytes = self.eoa.encode("ascii")
         answer = self._port.read_until(eoabytes)
         if not answer.endswith(eoabytes):
-            raise SerialTimeoutException("serial connection timed out on 'receive'")
+            raise SerialTimeoutException(
+                "serial connection timed out on 'receive'"
+            )
 
         return answer.decode("ascii").removesuffix(self.eoa)
 

src/geocompy/data.py

@@ -69,7 +69,7 @@ def parsestr(value: str) -> str:
     """
     if value[0] == value[-1] == "\"":
         return value[1:-1]
-    
+
     return value
 
 
@@ -95,7 +95,7 @@ def toenum(e: type[_E], value: _E | str) -> _E:
     Examples
     --------
     >>> from enum import Enum
-    >>> 
+    >>>
     >>> class MyEnum(Enum):
     ...     ONE = 1
     ...     TWO = 2
@@ -107,13 +107,13 @@ def toenum(e: type[_E], value: _E | str) -> _E:
     """
     if isinstance(value, str):
         return e[value]
-    
+
     if value not in e:
         raise ValueError(
             f"given member ({value}) is not a member "
             f"of the target enum: {e}"
         )
-    
+
     return value
 
 
@@ -126,18 +126,18 @@ def enumparser(e: type[_E]) -> Callable[[str], _E]:
     ----------
     e: Enum
         Target enum type.
-    
+
     Returns
     -------
     Callable
         Parser function, that takes a string as input, and returns an
         enum member.
-    
+
     Examples
     --------
 
     >>> from enum import Enum
-    >>> 
+    >>>
     >>> class MyEnum(Enum):
     ...     ONE = 1
     ...     TWO = 2
@@ -149,7 +149,7 @@ def enumparser(e: type[_E]) -> Callable[[str], _E]:
     """
     def parseenum(value: str) -> _E:
         return e(int(value))
-    
+
     return parseenum
 
 
@@ -426,11 +426,11 @@ def __str__(self) -> str:
 
     def __repr__(self) -> str:
         return f"{type(self).__name__:s}({self.asunit(AngleUnit.DMS):s})"
-    
+
     def __eq__(self, other: object) -> bool:
         if type(other) is not Angle:
             return False
-        
+
         return math.isclose(self._value, other._value)
 
     def __pos__(self) -> Angle:
@@ -621,7 +621,7 @@ def parse(cls, string: str) -> Byte:
 class Vector:
     """
     Utility type to represent a position with 3D cartesian coordinates.
-    
+
     Supported arithmetic operations:
         - \\+ `Vector`
         - \\- `Vector`
@@ -679,7 +679,7 @@ def __getitem__(self, idx: int) -> float:
 
         coords = (self.x, self.y, self.z)
         return coords[idx]
-    
+
     def __eq__(self, other) -> bool:
         if type(other) is not type(self):
             return False
@@ -689,77 +689,77 @@ def __eq__(self, other) -> bool:
             and math.isclose(self.y, other.y)
             and math.isclose(self.z, other.z)
         )
-    
+
     def __pos__(self) -> Self:
         return type(self)(
             self.x,
             self.y,
             self.z
         )
-    
+
     def __neg__(self) -> Self:
         return type(self)(
             -self.x,
             -self.y,
             -self.z
         )
-    
+
     def __add__(self, other: Self) -> Self:
         if type(other) is not type(self):
             raise TypeError(
                 f"unsupported operand type(s) for +: "
                 f"'{type(self).__name__}' and "
                 f"'{type(other).__name__}'"
             )
-        
+
         return type(self)(
             self.x + other.x,
             self.y + other.y,
             self.z + other.z
         )
-    
+
     def __sub__(self, other: Self) -> Self:
         if type(other) is not type(self):
             raise TypeError(
                 f"unsupported operand type(s) for -: "
                 f"'{type(self).__name__}' and "
                 f"'{type(other).__name__}'"
             )
-        
+
         return type(self)(
             self.x - other.x,
             self.y - other.y,
             self.z - other.z
         )
-    
+
     def __mul__(self, other: int | float) -> Self:
         if type(other) not in (int, float):
             raise TypeError(
                 f"unsupported operand type(s) for *: "
                 f"'{type(self).__name__}' and "
                 f"'{type(other).__name__}'"
             )
-        
+
         return type(self)(
             self.x * other,
             self.y * other,
             self.z * other
         )
-    
+
     def __truediv__(self, other: int | float) -> Self:
         if type(other) not in (int, float):
             raise TypeError(
                 f"unsupported operand type(s) for /: "
                 f"'{type(self).__name__}' and "
                 f"'{type(other).__name__}'"
             )
-        
+
         return type(self)(
             self.x / other,
             self.y / other,
             self.z / other
         )
-    
+
     def length(self) -> float:
         """
         Calculates the length of the vector.
@@ -778,7 +778,7 @@ def length(self) -> float:
                 )
             )
         )
-    
+
     def normalized(self) -> Self:
         """
         Returns a copy of the vector, normalized to unit length.
@@ -788,17 +788,17 @@ def normalized(self) -> Self:
         Self
             Normalized vector.
         """
-        l = self.length()
-        if l == 0:
+        length = self.length()
+        if length == 0:
             return +self
-        
-        return self / l
+
+        return self / length
 
 
 class Coordinate(Vector):
     """
     Utility type to represent a position with 3D cartesian coordinates.
-    
+
     Supported arithmetic operations:
         - \\+ `Coordinate`
         - \\- `Coordinate`