Merge pull request #91 from MrClock8163/refactor/parsing

Parsing functions cleanup

Author: MrClock8163

CHANGELOG.md

@@ -16,10 +16,14 @@ The project uses [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 - Reworked arithmetic operations supported by `Angle`
 - Reworked arithmetic operations supported by `Vector`
+- Renamed `parsestr` to `parse_string`
+- Renamed `parsebool` to `parse_bool`
+- Renamed `toenum` to `get_enum`
+- Renamed `enumparser` to `get_enum_parser`
 
 ### Fixed
 
-- GeoCom ING `set_telescopic_configuration` was missing the `prefix` parameter
+- GeoCom IMG `set_telescopic_configuration` was missing the `prefix` parameter
 - `Angle.to_dms` was sometimes returning incorrect value due to rounding
 
 ### Removed

src/geocompy/data.py

@@ -10,11 +10,10 @@
 Functions
 ---------
 
-- ``parsestr``
-- ``parsebool``
-- ``toenum``
-- ``enumparser``
-- ``gsiword``
+- ``parse_string``
+- ``parse_bool``
+- ``get_enum``
+- ``get_enum_parser``
 
 Types
 -----
@@ -49,7 +48,7 @@
 _E = TypeVar("_E", bound=Enum)
 
 
-def parsestr(value: str) -> str:
+def parse_string(value: str) -> str:
     """
     Returns a string value with the enclosing quote marks (``"..."``)
     removed.
@@ -77,7 +76,7 @@ def parsestr(value: str) -> str:
     return value
 
 
-def parsebool(value: str) -> bool:
+def parse_bool(value: str) -> bool:
     """
     Utility function to parse a serialized boolean value.
 
@@ -94,7 +93,7 @@ def parsebool(value: str) -> bool:
     return bool(int(value))
 
 
-def toenum(e: type[_E], value: _E | str) -> _E:
+def get_enum(e: type[_E], value: _E | str) -> _E:
     """
     Returns the member of an :class:`~enum.Enum` with the given name.
 
@@ -138,7 +137,7 @@ def toenum(e: type[_E], value: _E | str) -> _E:
     return value
 
 
-def enumparser(e: type[_E]) -> Callable[[str], _E]:
+def get_enum_parser(e: type[_E]) -> Callable[[str], _E]:
     """
     Returns a parser function that can parse the target enum from the
     serialized enum value.
@@ -168,10 +167,10 @@ def enumparser(e: type[_E]) -> Callable[[str], _E]:
     <MyEnum.ONE: 1>
 
     """
-    def parseenum(value: str) -> _E:
+    def parser(value: str) -> _E:
         return e(int(value))
 
-    return parseenum
+    return parser
 
 
 _AngleUnit = Literal['deg', 'rad', 'gon']

src/geocompy/geo/__init__.py

@@ -40,6 +40,7 @@
 from logging import Logger
 from traceback import format_exc
 from time import sleep
+from enum import Enum
 from typing import Any, Callable, Iterable, overload, TypeVar
 
 from serial import SerialException, SerialTimeoutException
@@ -279,22 +280,22 @@ def precision(self, value: int) -> None:
     def request(
         self,
         rpc: int,
-        params: Iterable[int | float | bool | str | Angle | Byte] = (),
+        params: Iterable[int | float | bool | str | Angle | Byte | Enum] = (),
         parsers: Callable[[str], _T] | None = None
     ) -> GeoComResponse[_T]: ...
 
     @overload
     def request(
         self,
         rpc: int,
-        params: Iterable[int | float | bool | str | Angle | Byte] = (),
+        params: Iterable[int | float | bool | str | Angle | Byte | Enum] = (),
         parsers: Iterable[Callable[[str], Any]] | None = None
     ) -> GeoComResponse[tuple[Any, ...]]: ...
 
     def request(
         self,
         rpc: int,
-        params: Iterable[int | float | bool | str | Angle | Byte] = (),
+        params: Iterable[int | float | bool | str | Angle | Byte | Enum] = (),
         parsers: (
             Iterable[Callable[[str], Any]]
             | Callable[[str], Any]
@@ -312,7 +313,7 @@ def request(
         ----------
         rpc: int
             Number of the RPC to execute.
-        params: Iterable[int | float | bool | str | Angle | Byte]
+        params: Iterable[int | float | bool | str | Angle | Byte | Enum]
             Parameters for the request, by default()
         parsers: Iterable[Callable[[str], Any]] \
                   | Callable[[str], Any] \
@@ -344,6 +345,8 @@ def request(
                     value = f"{item:d}"
                 case str():
                     value = f"\"{item}\""
+                case Enum():
+                    value = f"{item.value:d}"
                 case _:
                     raise TypeError(f"unexpected parameter type: {type(item)}")
 

src/geocompy/geo/aus.py

@@ -14,7 +14,7 @@
 """
 from __future__ import annotations
 
-from ..data import parsebool
+from ..data import parse_bool
 from .gctypes import (
     GeoComSubsystem,
     GeoComResponse
@@ -57,7 +57,7 @@ def get_user_atr_state(self) -> GeoComResponse[bool]:
         """
         return self._request(
             18006,
-            parsers=parsebool
+            parsers=parse_bool
         )
 
     def switch_user_atr(
@@ -117,7 +117,7 @@ def get_user_lock_state(self) -> GeoComResponse[bool]:
         """
         return self._request(
             18008,
-            parsers=parsebool
+            parsers=parse_bool
         )
 
     def switch_user_lock(
@@ -178,7 +178,7 @@ def get_rcs_search_status(self) -> GeoComResponse[bool]:
         """
         return self._request(
             18008,
-            parsers=parsebool
+            parsers=parse_bool
         )
 
     def switch_rcs_search(

src/geocompy/geo/aut.py

@@ -18,9 +18,9 @@
 
 from ..data import (
     Angle,
-    toenum,
-    enumparser,
-    parsebool
+    get_enum,
+    get_enum_parser,
+    parse_bool
 )
 from .gcdata import (
     Adjust,
@@ -78,7 +78,7 @@ def get_atr_status(self) -> GeoComResponse[bool]:
         """
         return self._request(
             9019,
-            parsers=parsebool
+            parsers=parse_bool
         )
 
     def switch_atr(
@@ -152,7 +152,7 @@ def get_lock_status(self) -> GeoComResponse[bool]:
         """
         return self._request(
             9021,
-            parsers=parsebool
+            parsers=parse_bool
         )
 
     def switch_lock(
@@ -369,11 +369,11 @@ def turn_to(
         com.get_timeout
         com.set_timeout
         """
-        _posmode = toenum(Position, posmode)
-        _atrmode = toenum(ATR, atrmode)
+        _posmode = get_enum(Position, posmode)
+        _atrmode = get_enum(ATR, atrmode)
         return self._request(
             9027,
-            [float(hz), float(v), _posmode.value, _atrmode.value, 0]
+            [float(hz), float(v), _posmode, _atrmode, 0]
         )
 
     def change_face(
@@ -428,11 +428,11 @@ def change_face(
         com.set_timeout
         tmc.get_face
         """
-        _posmode = toenum(Position, posmode)
-        _atrmode = toenum(ATR, atrmode)
+        _posmode = get_enum(Position, posmode)
+        _atrmode = get_enum(ATR, atrmode)
         return self._request(
             9028,
-            [_posmode.value, _atrmode.value, 0]
+            [_posmode, _atrmode, 0]
         )
 
     def fine_adjust(
@@ -550,7 +550,7 @@ def get_fine_adjust_mode(self) -> GeoComResponse[Adjust]:
         """
         return self._request(
             9030,
-            parsers=enumparser(Adjust)
+            parsers=get_enum_parser(Adjust)
         )
 
     def set_fine_adjust_mode(
@@ -577,10 +577,10 @@ def set_fine_adjust_mode(
         --------
         get_fine_adjust_mode
         """
-        _mode = toenum(Adjust, mode)
+        _mode = get_enum(Adjust, mode)
         return self._request(
             9031,
-            [_mode.value]
+            [_mode]
         )
 
     def lock_in(self) -> GeoComResponse[None]:
@@ -645,7 +645,7 @@ def get_search_area(
                 Angle.parse,
                 Angle.parse,
                 Angle.parse,
-                parsebool
+                parse_bool
             )
         )
 
@@ -881,10 +881,10 @@ def powersearch_next(
         switch_powersearch_range
         powersearch_window
         """
-        _direction = toenum(Turn, direction)
+        _direction = get_enum(Turn, direction)
         return self._request(
             9051,
-            [_direction.value, swing]
+            [_direction, swing]
         )
 
     def switch_lock_onthefly(
@@ -936,7 +936,7 @@ def get_lock_onthefly_status(self) -> GeoComResponse[bool]:
         """
         return self._request(
             9102,
-            parsers=parsebool
+            parsers=parse_bool
         )
 
     def aim_at_pixel(
@@ -970,8 +970,8 @@ def aim_at_pixel(
                 - ``AUT_SIDECOVER_ERR``: Sidecover is open.
 
         """
-        _camera = toenum(Camera, camera)
+        _camera = get_enum(Camera, camera)
         return self._request(
             9081,
-            [_camera.value, x, y]
+            [_camera, x, y]
         )