Merge pull request 'v0.5.0' (#87) from dev into master

Reviewed-on: #87

.gitea/workflows/tests.yml

@@ -11,11 +11,11 @@ on:
 
 jobs:
   test:
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-latest-de
     container: catthehacker/ubuntu:act-latest
     strategy:
       matrix:
-        python-version: ["3.8", "3.9", "3.10", "3.11"]
+        python-version: ["3.9", "3.10", "3.11", "3.12"]
 
     steps:
       - uses: actions/checkout@v3

.gitignore

@@ -154,6 +154,7 @@ cython_debug/
 
 
 # Custom
+.mise.toml
 .vscode/
 .venv_linux/
 .venv_windows/

.renovaterc

@@ -3,6 +3,15 @@
     "extends": [
         "config:base"
     ],
+    "baseBranches": [
+        "dev"
+    ],
+    "pip_requirements": {
+        "fileMatch": [
+            "requirements/.*\\.txt$"
+        ],
+        "enabled": true
+    },
     "packageRules": [
         {
             "matchUpdateTypes": [

README.md

@@ -10,7 +10,7 @@ Small module that makes your journey with RMV REST API somehow easier. Based ful
 ## Requirements
 
 * RMV API key (Get it [here](https://opendata.rmv.de/site/start.html))
-* Python 3.8+
+* Python 3.9+
 * git (Only for installation from source)
 
 ## Installation

pyproject.toml

@@ -9,18 +9,18 @@ authors = [{ name = "Profitroll", email = "profitroll@end-play.xyz" }]
 maintainers = [{ name = "Profitroll", email = "profitroll@end-play.xyz" }]
 description = "Small module that makes your journey with RMV REST API somehow easier."
 readme = "README.md"
-requires-python = ">=3.8"
-license = { text = "GPL3" }
+requires-python = ">=3.9"
+license = { text = "MIT" }
 classifiers = [
     "Development Status :: 3 - Alpha",
     "Intended Audience :: Developers",
     "License :: OSI Approved :: MIT License",
     "Operating System :: OS Independent",
     "Programming Language :: Python :: 3",
-    "Programming Language :: Python :: 3.8",
     "Programming Language :: Python :: 3.9",
     "Programming Language :: Python :: 3.10",
     "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
     "Topic :: Software Development :: Libraries :: Python Modules",
     "Topic :: Utilities",
 ]
@@ -38,13 +38,14 @@ dependencies = { file = "requirements/_.txt" }
 
 [tool.setuptools.dynamic.optional-dependencies]
 dev = { file = "requirements/dev.txt" }
+dist = { file = "requirements/dist.txt" }
 speed = { file = "requirements/speed.txt" }
 
 [tool.setuptools.packages.find]
 where = ["src"]
 
 [tool.black]
-target-version = ['py38', 'py39', 'py310', 'py311']
+target-version = ['py39', 'py310', 'py311', 'py312']
 line-length = 94
 
 [tool.isort]
@@ -64,7 +65,7 @@ show_error_codes = true
 
 [tool.pylint.main]
 extension-pkg-whitelist = ["ujson"]
-py-version = 3.8
+py-version = 3.9
 
 [tool.coverage.run]
 source = ["pyrmv"]

requirements/_.txt

@@ -1,3 +1,3 @@
-requests~=2.31.0
-xmltodict~=0.13.0
-isodate~=0.6.1
+requests~=2.32.3
+xmltodict~=0.14.0
+isodate~=0.7.0

requirements/dev.txt

@@ -1,12 +1,12 @@
-black==23.11.0
-build==1.1.1
-isort==5.12.0
-mypy==1.7.0
-pylint==3.0.2
-pytest-asyncio==0.22.0
-pytest-cov==4.1.0
-pytest==7.4.4
-tox==4.11.3
-twine==4.0.2
-types-aiofiles==23.2.0.20240311
-types-ujson==5.9.0.0
+black~=25.1.0
+isort==5.13.2
+mypy~=1.15.0
+pylint==3.3.7,<3.4.0
+pytest-cov~=6.1.0
+pytest~=8.3.2
+tox==4.25.0
+types-ujson~=5.10.0.20240515
+
+# Disabled async libraries for now
+# types-aiofiles~=24.1.0.20240626
+# pytest-asyncio~=0.24.0

requirements/dist.txt

@@ -0,0 +1,2 @@
+build==1.2.2.post1
+twine~=6.1.0

requirements/speed.txt

@@ -1 +1 @@
-ujson~=5.8.0
+ujson~=5.10.0

src/pyrmv/__init__.py

@@ -21,7 +21,7 @@ trip = client.trip_find(origin_id=origin.id, dest_id=destination.id)
 """
 
 __name__ = "pyrmv"
-__version__ = "0.4.0-rc.2"
+__version__ = "0.5.0"
 __license__ = "MIT License"
 __author__ = "Profitroll"
 

src/pyrmv/classes/__init__.py

@@ -3,6 +3,7 @@ from .gis import Gis
 from .journey import Journey
 from .leg import Leg
 from .message import Channel, Message, Url
+from .platform_type import PlatformType
 from .stop import Stop, StopTrip
 from .ticket import Ticket
 from .trip import Trip

src/pyrmv/classes/board.py

@@ -1,10 +1,10 @@
 from datetime import datetime
 from typing import Any, List, Mapping, Union
 
-from pyrmv.classes.journey import Journey
-from pyrmv.classes.message import Message
-from pyrmv.classes.stop import Stop
-from pyrmv.utility import ref_upgrade
+from ..classes.journey import Journey
+from ..classes.message import Message
+from ..classes.stop import Stop
+from ..utility import ref_upgrade
 
 
 class LineArrival:

src/pyrmv/classes/client.py

@@ -1,7 +1,7 @@
 from datetime import datetime, timedelta
 from typing import List, OrderedDict, Union
 
-from pyrmv.classes import (
+from ..classes import (
     BoardArrival,
     BoardDeparture,
     Journey,
@@ -10,7 +10,7 @@ from pyrmv.classes import (
     StopTrip,
     Trip,
 )
-from pyrmv.enums import (
+from ..enums import (
     AffectedJourneyMode,
     AffectedJourneyStopMode,
     BoardArrivalType,
@@ -22,15 +22,15 @@ from pyrmv.enums import (
     SearchMode,
     SelectionMode,
 )
-from pyrmv.raw import board_arrival as raw_board_arrival
-from pyrmv.raw import board_departure as raw_board_departure
-from pyrmv.raw import him_search as raw_him_search
-from pyrmv.raw import journey_detail as raw_journey_detail
-from pyrmv.raw import stop_by_coords as raw_stop_by_coords
-from pyrmv.raw import stop_by_name as raw_stop_by_name
-from pyrmv.raw import trip_find as raw_trip_find
-from pyrmv.raw import trip_recon as raw_trip_recon
-from pyrmv.utility import find_exception
+from ..raw import board_arrival as raw_board_arrival
+from ..raw import board_departure as raw_board_departure
+from ..raw import him_search as raw_him_search
+from ..raw import journey_detail as raw_journey_detail
+from ..raw import stop_by_coords as raw_stop_by_coords
+from ..raw import stop_by_name as raw_stop_by_name
+from ..raw import trip_find as raw_trip_find
+from ..raw import trip_recon as raw_trip_recon
+from ..utility import find_exception
 
 try:
     from typing import Literal
@@ -150,7 +150,7 @@ class Client:
             boardType=board_type.code,
         )
 
-        find_exception(board_raw)
+        find_exception(board_raw.copy())
 
         return BoardArrival(
             board_raw,
@@ -219,7 +219,7 @@ class Client:
             boardType=board_type.code,
         )
 
-        find_exception(board_raw)
+        find_exception(board_raw.copy())
 
         return BoardDeparture(
             board_raw,
@@ -343,7 +343,7 @@ class Client:
             minprio=priority_min,
         )
 
-        find_exception(messages_raw)
+        find_exception(messages_raw.copy())
 
         if "Message" in messages_raw:
             messages.extend(Message(message) for message in messages_raw["Message"])
@@ -402,7 +402,7 @@ class Client:
             toIdx=to_index,
         )
 
-        find_exception(journey_raw)
+        find_exception(journey_raw.copy())
 
         return Journey(journey_raw)
 
@@ -481,7 +481,7 @@ class Client:
             locationSelectionMode=selection_mode,  # type: ignore
         )
 
-        find_exception(stops_raw)
+        find_exception(stops_raw.copy())
 
         if "stopLocationOrCoordLocation" in stops_raw:
             for stop in stops_raw["stopLocationOrCoordLocation"]:
@@ -536,7 +536,7 @@ class Client:
             accessId=self.access_id, inputString=query, lang=lang.code, maxNo=1
         )
 
-        find_exception(stops_raw)
+        find_exception(stops_raw.copy())
 
         if len(stops_raw["stopLocationOrCoordLocation"]) <= 0:
             return None
@@ -642,7 +642,7 @@ class Client:
             filterMode=filter_mode.code,
         )
 
-        find_exception(stops_raw)
+        find_exception(stops_raw.copy())
 
         if "stopLocationOrCoordLocation" in stops_raw:
             for stop in stops_raw["stopLocationOrCoordLocation"]:
@@ -833,7 +833,7 @@ class Client:
             withFreq=frequency,
         )
 
-        find_exception(trips_raw)
+        find_exception(trips_raw.copy())
 
         if "Trip" in trips_raw:
             trips.extend(Trip(trip) for trip in trips_raw["Trip"])
@@ -913,7 +913,7 @@ class Client:
             trafficMessages=messages,
         )
 
-        find_exception(trips_raw)
+        find_exception(trips_raw.copy())
 
         if "Trip" in trips_raw:
             trips.extend(Trip(trip) for trip in trips_raw["Trip"])

src/pyrmv/classes/journey.py

@@ -1,8 +1,8 @@
 from typing import Any, List, Mapping, Union
 
-from pyrmv.classes.message import Message
-from pyrmv.classes.stop import Stop
-from pyrmv.utility import ref_upgrade
+from ..classes.message import Message
+from ..classes.stop import Stop
+from ..utility import ref_upgrade
 
 
 class Journey:

src/pyrmv/classes/leg.py

@@ -3,9 +3,9 @@ from typing import Any, List, Mapping, Union
 
 from isodate import Duration, parse_duration
 
-from pyrmv.classes.gis import Gis
-from pyrmv.classes.message import Message
-from pyrmv.classes.stop import StopTrip
+from ..classes.gis import Gis
+from ..classes.message import Message
+from ..classes.stop import StopTrip
 
 
 class Leg:

src/pyrmv/classes/message.py

@@ -3,7 +3,7 @@ from typing import Any, List, Mapping, Union
 
 from isodate import Duration, parse_duration
 
-from pyrmv.classes.stop import Stop
+from ..classes.stop import Stop
 
 
 class Url:
@@ -59,9 +59,9 @@ class Message:
         self.channels.extend(Channel(channel) for channel in data["channel"])
         self.id: str = data["id"]
         self.active: bool = data["act"]
-        self.head: str = data["head"]
-        self.lead: str = data["lead"]
-        self.text: str = data["text"]
+        self.head: str = "" if "head" not in data else data["head"]
+        self.lead: str = "" if "lead" not in data else data["lead"]
+        self.text: str = "" if "text" not in data else data["text"]
         self.company: Union[str, None] = data.get("company")
         self.category: Union[str, None] = data.get("category")
         self.priority: Union[int, None] = data.get("priority")
@@ -81,8 +81,10 @@ class Message:
                 f"{data['validToDate']} {data['validToTime']}", "%Y-%m-%d %H:%M:%S"
             )
         )
-        self.date_start_alt: str = data["altStart"]
-        self.date_end_alt: str = data["altEnd"]
+        self.date_start_alt: Union[str, None] = (
+            None if "altStart" not in data else data["altStart"]
+        )
+        self.date_end_alt: Union[str, None] = None if "altEnd" not in data else data["altEnd"]
         self.time_modified: Union[datetime, None] = (
             None
             if "modDate" not in data or "modTime" not in data

src/pyrmv/classes/platform_type.py

@@ -0,0 +1,17 @@
+from typing import Any, Mapping, Union
+
+from ..enums.platform_type_type import PlatformTypeType
+
+
+class PlatformType:
+    """Platform information."""
+
+    def __init__(self, data: Mapping[str, Any]):
+        self.type: PlatformTypeType = (
+            PlatformTypeType.U if "type" not in data else PlatformTypeType(data.get("type"))
+        )
+        self.text: Union[str, None] = data.get("text")
+        self.hidden: bool = bool(data.get("hidden"))
+        self.lon: float = data["lon"]
+        self.lat: float = data["lat"]
+        self.alt: int = data["alt"]

src/pyrmv/classes/trip.py

@@ -3,8 +3,8 @@ from typing import List, Union
 
 from isodate import Duration, parse_duration
 
-from pyrmv.classes.leg import Leg
-from pyrmv.classes.stop import StopTrip
+from ..classes.leg import Leg
+from ..classes.stop import StopTrip
 
 
 class Trip:
@@ -19,8 +19,10 @@ class Trip:
         self.index: int = data["idx"]
         self.id: str = data["tripId"]
         self.ctx_recon: str = data["ctxRecon"]
-        self.duration: Union[Duration, timedelta] = parse_duration(data["duration"])
-        self.real_time_duration: Union[Duration, timedelta] = (
+        self.duration: Union[Duration, timedelta, None] = (
+            None if "duration" not in data else parse_duration(data["duration"])
+        )
+        self.real_time_duration: Union[Duration, timedelta, None] = (
             None if "rtDuration" not in data else parse_duration(data["rtDuration"])
         )
         self.checksum: str = data["checksum"]

src/pyrmv/enums/__init__.py

@@ -4,6 +4,7 @@ from .board_type import BoardArrivalType, BoardDepartureType
 from .filter_mode import FilterMode
 from .lang import Language
 from .location_type import LocationType
+from .platform_type_type import PlatformTypeType
 from .product import Product
 from .rt_mode import RealTimeMode
 from .search_mode import SearchMode

src/pyrmv/enums/auto_name.py

@@ -3,7 +3,7 @@
 
 from enum import Enum
 
-from pyrmv.const import PRODUCTS
+from ..const import PRODUCTS
 
 
 class AutoName(Enum):

src/pyrmv/enums/platform_type_type.py

@@ -0,0 +1,51 @@
+from enum import Enum, auto
+
+
+class PlatformTypeType(Enum):
+    """Enumeration used to declare types of platform type.
+
+    * U - Undefined
+    * PL - Platform/track at train station
+    * ST - Stop at bus or tram station
+    * GA - Terminal/Gate at airport
+    * PI - Pier if ship or ferry
+    * SL - Slot/parking space if bike or car
+    * FL - Floor in buildings or at footpath
+    * CI - Check-in/entrance
+    * CO - Check-out/exit
+    * X - No explicit type
+    * H - Hide platform information
+    """
+
+    U = auto()
+    "Undefined"
+
+    PL = auto()
+    "Platform/track at train station"
+
+    ST = auto()
+    "Stop at bus or tram station"
+
+    GA = auto()
+    "Terminal/Gate at airport"
+
+    PI = auto()
+    "Pier if ship or ferry"
+
+    SL = auto()
+    "Slot/parking space if bike or car"
+
+    FL = auto()
+    "Floor in buildings or at footpath"
+
+    CI = auto()
+    "Check-in/entrance"
+
+    CO = auto()
+    "Check-out/exit"
+
+    X = auto()
+    "No explicit type"
+
+    H = auto()
+    "Hide platform information"

src/pyrmv/raw/board_arrival.py

@@ -64,7 +64,7 @@ def board_arrival(
     payload = {}
     headers = {"Accept": "application/json"} if json else {"Accept": "application/xml"}
 
-    for var, val in locals().items():
+    for var, val in locals().copy().items():
         if str(var) == "date":
             if val != None:
                 if isinstance(val, datetime):

src/pyrmv/raw/board_departure.py

@@ -65,7 +65,7 @@ def board_departure(
     payload = {}
     headers = {"Accept": "application/json"} if json else {"Accept": "application/xml"}
 
-    for var, val in locals().items():
+    for var, val in locals().copy().items():
         if str(var) == "date":
             if val != None:
                 if isinstance(val, datetime):

src/pyrmv/raw/him_search.py

@@ -4,7 +4,7 @@ from typing import OrderedDict, Union
 from requests import get
 from xmltodict import parse as xmlparse
 
-from pyrmv.utility import weekdays_bitmask
+from ..utility import weekdays_bitmask
 
 try:
     from typing import Literal
@@ -97,7 +97,7 @@ def him_search(
     payload = {}
     headers = {"Accept": "application/json"} if json else {"Accept": "application/xml"}
 
-    for var, val in locals().items():
+    for var, val in locals().copy().items():
         if str(var) in {"dateB", "dateE"}:
             if val != None:
                 if isinstance(val, datetime):

src/pyrmv/raw/journey_detail.py

@@ -55,7 +55,7 @@ def journey_detail(
     payload = {}
     headers = {"Accept": "application/json"} if json else {"Accept": "application/xml"}
 
-    for var, val in locals().items():
+    for var, val in locals().copy().items():
         if str(var) == "rtMode":
             if val != None:
                 payload["rtMode"] = val.upper()

src/pyrmv/raw/stop_by_coords.py

@@ -54,7 +54,7 @@ def stop_by_coords(
     payload = {}
     headers = {"Accept": "application/json"} if json else {"Accept": "application/xml"}
 
-    for var, val in locals().items():
+    for var, val in locals().copy().items():
         if str(var) == "stopType":
             if val != None:
                 payload["type"] = val.upper()

src/pyrmv/raw/stop_by_name.py

@@ -65,7 +65,7 @@ def stop_by_name(
     payload = {}
     headers = {"Accept": "application/json"} if json else {"Accept": "application/xml"}
 
-    for var, val in locals().items():
+    for var, val in locals().copy().items():
         if str(var) == "inputString":
             if val != None:
                 payload["input"] = val

src/pyrmv/raw/trip_find.py

@@ -201,7 +201,7 @@ def trip_find(
     payload = {}
     headers = {"Accept": "application/json"} if json else {"Accept": "application/xml"}
 
-    for var, val in locals().items():
+    for var, val in locals().copy().items():
         if str(var) == "date":
             if val != None:
                 if isinstance(val, datetime):

src/pyrmv/raw/trip_recon.py

@@ -87,7 +87,7 @@ def trip_recon(
     payload = {}
     headers = {"Accept": "application/json"} if json else {"Accept": "application/xml"}
 
-    for var, val in locals().items():
+    for var, val in locals().copy().items():
         if str(var) == "date":
             if val != None:
                 if isinstance(val, datetime):

src/pyrmv/utility/find_exception.py

@@ -1,4 +1,4 @@
-from pyrmv.errors import (
+from ..errors import (
     ApiAuthError,
     ApiFormatError,
     ApiParamError,
@@ -26,6 +26,7 @@ from pyrmv.errors import (
     SvcNoResultError,
     SvcProductError,
     SvcSearchError,
+    SvcParamError,
     UnknownError,
 )
 
@@ -86,6 +87,9 @@ def find_exception(data: dict):
         elif data["errorCode"] == "SVC_CTX":
             raise SvcContextError()
 
+        elif data["errorCode"] == "SVC_PARAM":
+            raise SvcParamError(errorCode=data["errorCode"], errorText=data["errorText"])
+
         elif data["errorCode"] == "SVC_NO_RESULT":
             raise SvcNoResultError()
 

tests/test_client.py

@@ -20,9 +20,12 @@ def test_board_departure(api_client: Client, sample_stop_id: str):
 
 
 def test_him_search(api_client: Client):
-    assert isinstance(
-        api_client.him_search(time_end=datetime.now() + timedelta(days=10))[0], Message
-    )
+    response = api_client.him_search(time_end=datetime.now() + timedelta(days=10))
+
+    if len(response) != 0:
+        assert isinstance(response[0], Message)
+    else:
+        assert isinstance(response, list)
 
 
 def test_journey_detail(api_client: Client, sample_journey_id: str):

tox.ini

@@ -1,14 +1,14 @@
 [tox]
-minversion = 3.8.0
-envlist = py38, py39, py310, py311
+minversion = 3.9.0
+envlist = py39, py310, py311, py312
 isolated_build = true
 
 [gh-actions]
-python = 
-    3.8: py38
+python =
     3.9: py39
     3.10: py310
     3.11: py311
+    3.12: py312
 
 [testenv]
 setenv = 
@@ -21,4 +21,3 @@ deps =
     -r{toxinidir}/requirements/speed.txt
 commands =
     pytest --basetemp={envtmpdir} --cov=pyrmv --cov-report term-missing
-