Squashed commit of the following:

commit edb0f7115218637a118064dd9153b860892bbb87
Author: Georges Toth <georges@trypill.org>
Date:   Sun Nov 3 18:37:56 2024 +0100

    add location item and pointtype

commit 5031084ed94500ab0ebfe349d6dc4e6d0531413b
Author: Georges Toth <georges@trypill.org>
Date:   Sun Nov 3 18:37:17 2024 +0100

    add location item

.gitignore

@@ -2,6 +2,7 @@
 __pycache__/
 *.py[cod]
 *$py.class
+uv.lock
 
 # C extensions
 *.so
@@ -69,4 +70,3 @@ target/
 .mypy_cache
 .vscode
 venv
-venv

docker/openhab_conf/items/basic.items

@@ -17,3 +17,5 @@ String stringtest
 Number  floattest
 
 Color color_item  "Color item test"
+
+Location location_item

openhab/client.py

@@ -235,7 +235,7 @@ def get_item(self, name: str) -> openhab.items.Item:
 
     return self.json_to_item(json_data)
 
-  def json_to_item(self, json_data: dict) -> openhab.items.Item:
+  def json_to_item(self, json_data: dict) -> openhab.items.Item:  # noqa: PLR0911
     """This method takes as argument the RAW (JSON decoded) response for an openHAB item.
 
     It checks of what type the item is and returns a class instance of the
@@ -282,6 +282,9 @@ def json_to_item(self, json_data: dict) -> openhab.items.Item:
     if _type == 'Player':
       return openhab.items.PlayerItem(self, json_data)
 
+    if _type == 'Location':
+      return openhab.items.LocationItem(self, json_data)
+
     return openhab.items.Item(self, json_data)
 
   def get_item_raw(self, name: str) -> typing.Any:

openhab/command_types.py

@@ -73,7 +73,9 @@ def parse(cls, value: str) -> typing.Optional[typing.Any]:
   @classmethod
   @abc.abstractmethod
   def validate(cls, value: typing.Any) -> None:
-    """Value validation method. As this is the base class which should not be used\
+    """Value validation method.
+
+    As this is the base class which should not be used
     directly, we throw a NotImplementedError exception.
 
     Args:
@@ -304,7 +306,7 @@ def parse(cls, value: str) -> typing.Union[None, typing.Tuple[typing.Union[int,
     raise ValueError
 
   @classmethod
-  def validate(cls, value: typing.Union[int, float, typing.Tuple[typing.Union[int, float], str], str]) -> None:
+  def validate(cls, value: typing.Union[float, typing.Tuple[float, str], str]) -> None:
     """Value validation method.
 
     Valid values are any of data_type:
@@ -347,7 +349,7 @@ def parse(cls, value: str) -> typing.Optional[float]:
       raise ValueError(e) from e
 
   @classmethod
-  def validate(cls, value: typing.Union[float, int]) -> None:
+  def validate(cls, value: float) -> None:
     """Value validation method.
 
     Valid values are any of data_type ``float`` or ``int`` and must be greater of equal to 0
@@ -600,3 +602,74 @@ def validate(cls, value: str) -> None:
     super().validate(value)
 
     RewindFastforward.parse(value)
+
+
+class PointType(CommandType):
+  """PointType data_type class."""
+
+  TYPENAME = 'Point'
+  SUPPORTED_TYPENAMES = [TYPENAME]
+
+  @classmethod
+  def parse(cls, value: str) -> typing.Optional[typing.Tuple[float, float, float]]:
+    """Parse a given value."""
+    if value in PercentType.UNDEFINED_STATES:
+      return None
+
+    value_split = value.split(',', maxsplit=2)
+    if not len(value_split) == 3:
+      raise ValueError
+
+    try:
+      latitude = float(value_split[0])
+      longitude = float(value_split[1])
+      altitude = float(value_split[2])
+    except ArithmeticError as exc:
+      raise ValueError(exc) from exc
+
+    return latitude, longitude, altitude
+
+  @classmethod
+  def validate(
+    cls, value: typing.Optional[typing.Union[str, typing.Tuple[typing.Union[float, int], typing.Union[float, int], typing.Union[float, int]]]]
+  ) -> None:
+    """Value validation method.
+
+    A valid PointType is a tuple of three decimal values representing:
+      - latitude
+      - longitude
+      - altitude
+
+    Valid values are:
+      - a tuple of (``int`` or ``float``, ``int`` or ``float``, ``int`` or ``float``)
+      - a ``str`` that can be parsed to one of the above by ``DecimalType.parse``
+
+    Args:
+      value: The value to validate.
+
+    Raises:
+      ValueError: Raises ValueError if an invalid value has been specified.
+    """
+    if isinstance(value, str):
+      result = PointType.parse(value)
+      if result is None:
+        return
+
+      latitude, longitude, altitude = result
+
+    elif not (isinstance(value, tuple) and len(value) == 3):
+      raise ValueError
+
+    elif not (isinstance(value[0], (float, int)) and isinstance(value[1], (float, int)) and isinstance(value[2], (float, int))):
+      raise ValueError
+
+    else:
+      latitude, longitude, altitude = value
+
+    if not (-90 <= latitude <= 90):
+      msg = 'Latitude must be between -90 and 90, inclusive.'
+      raise ValueError(msg)
+
+    if not (-180 <= longitude <= 180):
+      msg = 'Longitude must be between -180 and 180, inclusive.'
+      raise ValueError(msg)

openhab/items.py

@@ -194,8 +194,8 @@ def _rest_format(self, value: str) -> typing.Union[str, bytes]:
 
   def is_undefined(self, value: str) -> bool:
     """Check if value is undefined."""
-    for aStateType in self.state_types:
-      if not aStateType.is_undefined(value):
+    for a_state_type in self.state_types:
+      if not a_state_type.is_undefined(value):
         return False
 
     return True
@@ -671,3 +671,41 @@ def down(self) -> None:
   def stop(self) -> None:
     """Set the state of the dimmer to OFF."""
     self.command(openhab.command_types.StopMoveType.STOP)
+
+
+class LocationItem(Item):
+  """LocationItem item type."""
+
+  TYPENAME = 'Location'
+  types = [openhab.command_types.PointType]
+  state_types = [openhab.command_types.PointType]
+
+  def _parse_rest(self, value: str) -> typing.Tuple[typing.Optional[typing.Tuple[float, float, float]], str]:  # type: ignore[override]
+    """Parse a REST result into a native object.
+
+    Args:
+      value (str): A string argument to be converted into a str object.
+
+    Returns:
+      Latitude, longitude and altitude components
+      Optional UoM
+    """
+    return openhab.command_types.PointType.parse(value), ''
+
+  def _rest_format(self, value: typing.Union[typing.Tuple[float, float, float], str]) -> str:
+    """Format a value before submitting to openHAB.
+
+    Args:
+      value: Either a string, an integer or a tuple of HSB components (int, int, float); in the latter two cases we have to cast it to a string.
+
+    Returns:
+      str: The string as possibly converted from the parameter.
+    """
+    if isinstance(value, tuple):
+      if len(value) == 3:
+        return f'{value[0]},{value[1]},{value[2]}'
+
+    if not isinstance(value, str):
+      return str(value)
+
+    return value

pyproject.toml

@@ -159,6 +159,7 @@ ignore = [
     "Q001", # bad-quotes-multiline-string
 ]
 
+
 [tool.ruff.format]
 quote-style = "single"
 

tests/test_basic.py

@@ -1,8 +1,11 @@
 import datetime
 import time
 
+import pytest
+
 import openhab
 
+
 # ruff: noqa: S101, ANN201, T201
 
 
@@ -111,3 +114,28 @@ def test_number_temperature(oh: openhab.OpenHAB):
   time.sleep(1)
   assert temperature_item.state == 100
   assert temperature_item.unit_of_measure == '°C'
+
+
+def test_location_item(oh: openhab.OpenHAB):
+  locationitem = oh.get_item('location_item')
+
+  locationitem.update_state_null()
+  assert locationitem.is_state_null()
+
+  locationitem.state = '1.1, 1.2, 1.3'
+  assert locationitem.state == (1.1, 1.2, 1.3)
+
+  locationitem.state = (1.1, 1.2, 1.3)
+  assert locationitem.state == (1.1, 1.2, 1.3)
+
+  locationitem.state = '30.1, -50.2, 7325.456'
+  assert locationitem.state == (30.1, -50.2, 7325.456)
+
+  locationitem.state = (30.1, -50.2, 7325.456)
+  assert locationitem.state == (30.1, -50.2, 7325.456)
+
+  with pytest.raises(ValueError):
+    locationitem.state = (91, 181, -10)
+
+  with pytest.raises(ValueError):
+    locationitem.state = '90 10 10'

tests/test_oauth.py

@@ -116,5 +116,5 @@ def test_number_temperature(oh_oauth2: openhab.OpenHAB):
   assert temperature_item.unit_of_measure == '°C'
 
 
-def test_session_logout(oh_oauth2: openhab.OpenHAB):
-  assert oh_oauth2.logout() is True
+# def test_session_logout(oh_oauth2: openhab.OpenHAB):
+#   assert oh_oauth2.logout() is True