apyefa 0.0.4__py3-none-any.whl → 0.0.6__py3-none-any.whl

apyefa/__init__.py

@@ -2,6 +2,7 @@ from apyefa.client import EfaClient
 from apyefa.data_classes import (
     Departure,
     Line,
+    LineRequestType,
     Location,
     LocationFilter,
     LocationType,
@@ -12,6 +13,7 @@ from apyefa.data_classes import (
 __all__ = [
     "LocationFilter",
     "Location",
+    "LineRequestType",
     "LocationType",
     "Departure",
     "SystemInfo",

apyefa/client.py

@@ -4,7 +4,6 @@ import aiohttp
 
 from apyefa.commands import (
     Command,
-    CommandAdditionalInfo,
     CommandDepartures,
     CommandServingLines,
     CommandStopFinder,
@@ -14,6 +13,7 @@ from apyefa.data_classes import (
     CoordFormat,
     Departure,
     Line,
+    LineRequestType,
     Location,
     LocationFilter,
     LocationType,
@@ -79,14 +79,13 @@ class EfaClient:
         _LOGGER.debug(f"limit: {limit}")
 
         command = CommandStopFinder("any", name)
-        command.add_param("anyMaxSizeHitList", limit)
 
         if filters:
             command.add_param("anyObjFilter_sf", sum(filters))
 
         response = await self._run_query(self._build_url(command))
 
-        return command.parse(response)
+        return command.parse(response)[:limit]
 
     async def location_by_coord(
         self,
@@ -113,11 +112,10 @@ class EfaClient:
         _LOGGER.debug(f"limit: {limit}")
 
         command = CommandStopFinder("coord", f"{coord_x}:{coord_y}:{format}")
-        command.add_param("anyMaxSizeHitList", limit)
 
         response = await self._run_query(self._build_url(command))
 
-        return command.parse(response)
+        return command.parse(response)[:limit]
 
     async def trip(self):
         raise NotImplementedError
@@ -163,20 +161,24 @@ class EfaClient:
 
         return command.parse(response)
 
-    async def lines_by_location(self, location: str | Location) -> list[Line]:
+    async def lines_by_location(
+        self, location: str | Location, req_types: list[LineRequestType] = []
+    ) -> list[Line]:
         """Search for lines that pass `location`. Location can be location ID like `de:08111:6221` or a `Location` object
 
         Args:
             location (str | Location): Location
+            req_types (list[LineRequestType], optional): List of types for the request. Defaults to empty.
 
         Raises:
-            ValueError: If not a stop location provided but e.g. POI or Address
+            ValueError: Wrong location type provided e.g. LocationType.POI or LocationType.ADDRESS
 
         Returns:
             list[Transport]: List of lines
         """
         _LOGGER.info("Request lines by location")
         _LOGGER.debug(f"location:{location}")
+        _LOGGER.debug(f"filters :{req_types}")
 
         if isinstance(location, Location):
             if location.loc_type != LocationType.STOP:
@@ -187,6 +189,9 @@ class EfaClient:
 
         command = CommandServingLines("odv", location)
 
+        if req_types:
+            command.add_param("lineReqType", sum(req_types))
+
         response = await self._run_query(self._build_url(command))
 
         return command.parse(response)
@@ -194,15 +199,6 @@ class EfaClient:
     async def locations_by_line(self, line: str | Line) -> list[Location]:
         raise NotImplementedError
 
-    async def additional_info(self):
-        _LOGGER.info("Request additional info")
-
-        command = CommandAdditionalInfo()
-
-        response = await self._run_query(self._build_url(command))
-
-        return command.parse(response)
-
     async def _run_query(self, query: str) -> str:
         _LOGGER.info(f"Run query {query}")
 

apyefa/commands/__init__.py

@@ -1,5 +1,4 @@
 from .command import Command
-from .command_add_info import CommandAdditionalInfo
 from .command_departures import CommandDepartures
 from .command_serving_lines import CommandServingLines
 from .command_stop_finder import CommandStopFinder
@@ -9,7 +8,6 @@ from .command_trip import CommandTrip
 __all__ = [
     "Command",
     "CommandDepartures",
-    "CommandAdditionalInfo",
     "CommandStopFinder",
     "CommandSystemInfo",
     "CommandTrip",

apyefa/commands/command.py

@@ -7,6 +7,8 @@ from apyefa.commands.parsers.rapid_json_parser import RapidJsonParser
 from apyefa.exceptions import EfaFormatNotSupported, EfaParameterError
 from apyefa.helpers import is_date, is_datetime, is_time
 
+from ..data_classes import CoordFormat
+
 _LOGGER = logging.getLogger(__name__)
 
 
@@ -18,7 +20,7 @@ class Command:
         self._format: str = output_format
 
         self.add_param("outputFormat", output_format)
-        self.add_param("coordOutputFormat", "WGS84")
+        self.add_param("coordOutputFormat", CoordFormat.WGS84.value)
 
     def add_param(self, param: str, value: str):
         if not param or not value:

apyefa/commands/command_departures.py

@@ -3,7 +3,7 @@ import logging
 from voluptuous import Any, Date, Datetime, Optional, Required, Schema
 
 from apyefa.commands.command import Command
-from apyefa.data_classes import Departure
+from apyefa.data_classes import CoordFormat, Departure
 
 _LOGGER = logging.getLogger(__name__)
 
@@ -32,7 +32,9 @@ class CommandDepartures(Command):
         return Schema(
             {
                 Required("outputFormat", default="rapidJSON"): Any("rapidJSON"),
-                Required("coordOutputFormat", default="WGS84"): Any("WGS84"),
+                Required("coordOutputFormat", default="WGS84"): Any(
+                    *[x.value for x in CoordFormat]
+                ),
                 Required("name_dm"): str,
                 Required("type_dm", default="stop"): Any("any", "stop"),
                 Required("mode", default="direct"): Any("any", "direct"),

apyefa/commands/command_serving_lines.py

@@ -1,9 +1,9 @@
 import logging
 
-from voluptuous import Any, Optional, Required, Schema
+from voluptuous import Any, Optional, Range, Required, Schema
 
 from apyefa.commands.command import Command
-from apyefa.data_classes import Line
+from apyefa.data_classes import CoordFormat, Line, LineRequestType
 
 _LOGGER = logging.getLogger(__name__)
 
@@ -41,14 +41,18 @@ class CommandServingLines(Command):
         return Schema(
             {
                 Required("outputFormat", default="rapidJSON"): Any("rapidJSON"),
-                Required("coordOutputFormat", default="WGS84"): Any("WGS84"),
+                Required("coordOutputFormat", default="WGS84"): Any(
+                    *[x.value for x in CoordFormat]
+                ),
                 Required("mode", default="line"): Any("odv", "line"),
                 # mode 'odv'
                 Optional("type_sl"): Any("stopID"),
                 Optional("name_sl"): str,
                 # mode 'line'
                 Optional("lineName"): str,
-                Optional("lineReqType"): list[0, 2, 4, 8, 16],
+                Optional("lineReqType"): Range(
+                    min=0, max=sum([x.value for x in LineRequestType])
+                ),
                 Optional("mergeDir"): Any("0", "1", 0, 1),
                 Optional("lsShowTrainsExplicit"): Any("0", "1", 0, 1),
                 Optional("line"): str,

apyefa/commands/command_stop_finder.py

@@ -3,7 +3,7 @@ import logging
 from voluptuous import Any, Optional, Range, Required, Schema
 
 from apyefa.commands.command import Command
-from apyefa.data_classes import Location, LocationFilter
+from apyefa.data_classes import CoordFormat, Location, LocationFilter
 
 _LOGGER = logging.getLogger(__name__)
 
@@ -33,7 +33,9 @@ class CommandStopFinder(Command):
         return Schema(
             {
                 Required("outputFormat", default="rapidJSON"): Any("rapidJSON"),
-                Required("coordOutputFormat", default="WGS84"): Any("WGS84"),
+                Required("coordOutputFormat", default="WGS84"): Any(
+                    *[x.value for x in CoordFormat]
+                ),
                 Required("type_sf", default="any"): Any("any", "coord"),
                 Required("name_sf"): str,
                 Optional("anyMaxSizeHitList"): int,

apyefa/commands/command_system_info.py

@@ -3,7 +3,7 @@ import logging
 from voluptuous import Any, Optional, Required, Schema
 
 from apyefa.commands.command import Command
-from apyefa.data_classes import SystemInfo
+from apyefa.data_classes import CoordFormat, SystemInfo
 
 _LOGGER = logging.getLogger(__name__)
 
@@ -23,6 +23,8 @@ class CommandSystemInfo(Command):
         return Schema(
             {
                 Required("outputFormat", default="rapidJSON"): Any("rapidJSON"),
-                Optional("coordOutputFormat", default="WGS84"): Any("WGS84"),
+                Optional("coordOutputFormat", default="WGS84"): Any(
+                    *[x.value for x in CoordFormat]
+                ),
             }
         )

apyefa/commands/command_trip.py

@@ -4,6 +4,8 @@ from voluptuous import Any, Optional, Required, Schema
 
 from apyefa.commands.command import Command
 
+from ..data_classes import CoordFormat
+
 _LOGGER = logging.getLogger(__name__)
 
 
@@ -18,7 +20,9 @@ class CommandTrip(Command):
         return Schema(
             {
                 Required("outputFormat", default="rapidJSON"): Any("rapidJSON"),
-                Required("coordOutputFormat", default="WGS84"): Any("WGS84"),
+                Required("coordOutputFormat", default="WGS84"): Any(
+                    *[x.value for x in CoordFormat]
+                ),
                 Required("type_origin", default="any"): Any("any", "coord"),
                 Required("name_origin"): str,
                 Required("type_destination", default="any"): Any("any", "coord"),

apyefa/data_classes.py

@@ -76,6 +76,15 @@ class LocationFilter(IntEnum):
     POST_CODES = 64
 
 
+class LineRequestType(IntEnum):
+    NONE = 0
+    DEPARTURE_MONITOR = 1
+    STOP_TIMETABLE = 2
+    TIMETABLE = 4
+    ROUTE_MAPS = 8
+    STATION_TIMETABLE = 16
+
+
 class CoordFormat(StrEnum):
     WGS84 = "WGS84[dd.ddddd]"
 

{apyefa-0.0.4.dist-info → apyefa-0.0.6.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: apyefa
-Version: 0.0.4
+Version: 0.0.6
 Summary: Python API for EFA(Elektronische Fahrplanauskunft) async requests
 Author-email: Alex Jung <jungdevelop@gmail.com>
 License: MIT License
@@ -185,16 +185,14 @@ async with EfaClient("https://efa.vgn.de/vgnExt_oeffi/") as client:
 ```
 
 ## locations_by_coord()
-Find localities by coordinates.
-
-> :x: Currently test endpoint does not sent any answers for this request
+Find localities by their coordinates.
 
 ### Arguments
 |Arguments|Type                |Required|Description|
 |---------|--------------------|--------|-----------|
 |coord_x  |float               |required|X-coordinate|
 |coord_y  |float               |required|Y-coordinate|
-|format   |[CoordFormat](#coordformat)|optional|Coordinates format used for request|
+|format   |[CoordFormat](#coordformat)|optional|Coordinates format used for request. Default to WGS84.|
 |limit    |int                 |optional|Max size of returned list. Default value is `10`|
 
 ### Return value
@@ -280,14 +278,13 @@ Find lines pass provided location.
 |Arguments|Type                |Required|Description|
 |---------|--------------------|--------|-----------|
 |location |str \| [Location](#location) |required|The location passed by searched line(s)|
+|req_types|list[[LineRequestType](#lineRequestType)]|optional|The result presentation type(s) can be defined with this argument. Default value is `[]`
 
 ### Return value
 |Type|Description|
 |----|-----------|
 |list[[Line](#line)]|List of lines found for provided location|
 
-> The attribute `origin` of returned `line` objects is None
-
 ### Examples
 ``` python
 async with EfaClient("https://efa.vgn.de/vgnExt_oeffi/") as client:
@@ -367,17 +364,37 @@ async with EfaClient("https://efa.vgn.de/vgnExt_oeffi/") as client:
 ## TransportType
 ```python
 class TransportType(IntEnum):
-    RAIL        = 0 
-    SUBURBAN    = 1
-    SUBWAY      = 2 
-    CITY_RAIL   = 3 
-    TRAM        = 4
-    BUS         = 5 
-    RBUS        = 6 
-    EXPRESS_BUS = 7
-    CABLE_TRAM  = 8
-    FERRY       = 9 
-    AST         = 10  # Anruf-Sammel-Taxi
+    TRAIN                      = 0  # Zug
+    SUBURBAN                   = 1  # S-Bahn
+    SUBWAY                     = 2  # U-Bahn
+    CITY_RAIL                  = 3  # Stadtbahn
+    TRAM                       = 4  # Straßenbahn
+    CITY_BUS                   = 5  # Stadtbus
+    REGIONAL_BUS               = 6  # Regionalbus
+    EXPRESS_BUS                = 7  # Schnellbus
+    CABLE_RAIL                 = 8  # Seilbahn
+    FERRY                      = 9  # Schief
+    AST                        = 10 # Anruf-Sammel-Taxi
+    SUSPENSION_RAIL            = 11 # Schwebebahn
+    AIRPLANE                   = 12 # Flugzeug
+    REGIONAL_TRAIN             = 13 # Reginalzug (z.B. IRE, RE und RB)
+    NATIONAL_TRAIN             = 14 # Nationaler Zug (z.B. IR und D)
+    INTERNATINAL_TRAIN         = 15 # Internationaler Zug (z.B. IC und EC)
+    HIGH_SPEED_TRAIN           = 16 # Hochgeschwindigkeitzüge (z.B. ICE)
+    RAIL_REPLACEMENT_TRANSPORT = 17 # Schienenersatzverkehr
+    SHUTTLE_TRAIN              = 18 # Schuttlezug
+    CITIZEN_BUS                = 19 # Bürgerbus
+```
+
+## LineRequestType
+```python
+class LineRequestType(IntEnum):
+    NONE              = 0
+    DEPARTURE_MONITOR = 1
+    STOP_TIMETABLE    = 2
+    TIMETABLE         = 4
+    ROUTE_MAPS        = 8
+    STATION_TIMETABLE = 16
 ```
 
 ## CoordFormat

apyefa-0.0.6.dist-info/RECORD

@@ -0,0 +1,21 @@
+apyefa/__init__.py,sha256=9LuZCm4L02Jz-rgvSyTSQ10fzMEZ0P2nWQQ6m3Z9Ab0,386
+apyefa/client.py,sha256=OP9HnzwufH9joS-Bx7r768yu185ILbpVFGuYV2APjQ0,6832
+apyefa/data_classes.py,sha256=Njt7r8ONEY5KxUz9uVFnPHU9qz9sp5RWmmhiR8ywDiY,11552
+apyefa/exceptions.py,sha256=Vhc8FEtI1xSxbVRLFXd3BlNTekY2w3byEvd3Jhhg8h4,240
+apyefa/helpers.py,sha256=EJyj-Pw3xDrn8WKGbpfqbnaUZjHtVrE2A2LYpTkACps,1695
+apyefa/commands/__init__.py,sha256=kC7Zr8IcahAN8xEOytDUS6WCADQ5oe_nqDIPAjlzxy4,425
+apyefa/commands/command.py,sha256=ruVb8kpvsShsfT4wrgwcCdxqlGnYs4jsXTEoYx873rk,3633
+apyefa/commands/command_departures.py,sha256=kYt6GbXD1XYXEbGpi61TEFBTznqShyOaqJmpRi0mHZ4,1811
+apyefa/commands/command_serving_lines.py,sha256=PSWjr0el4bhq20IaW_P56q8sJ3vNlfV-KpoAUjrsHqo,2212
+apyefa/commands/command_stop_finder.py,sha256=lUkubSe7mVu8M6rss-RumnCPOaJJo_v6qlRNF7n6R88,2019
+apyefa/commands/command_system_info.py,sha256=rhAoeOE8V9Wc3G6z7NDrB9pjcULDz1o7oo-idS4VyXQ,858
+apyefa/commands/command_trip.py,sha256=Mhqv7wR11DtvxfaZSmNF-hLZxgC3XFH3UgBuI2fFEBA,1197
+apyefa/commands/parsers/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+apyefa/commands/parsers/parser.py,sha256=1PSlLpfYrNeKRTpvCcYsCzAKlNrs0oHvSN7zpF4Xcs8,140
+apyefa/commands/parsers/rapid_json_parser.py,sha256=UMexRiMKkJLcK5EEj80B6RYkWBuR8ZWD3YpeGa0J3lQ,212
+apyefa/commands/parsers/xml_parser.py,sha256=ru52QtBP68KoTZ8OgjFWrLy-PD4_j1miY8Zv5umNSE8,151
+apyefa-0.0.6.dist-info/LICENSE,sha256=C2Gdvb1B39BeEP-RGqVd7w6j94GnJo4gnYyiC_l3SFQ,1066
+apyefa-0.0.6.dist-info/METADATA,sha256=K0jaxYWYGc9Y3QkAQsdojOyLHWGUM9gBusllwQjbm6Y,16701
+apyefa-0.0.6.dist-info/WHEEL,sha256=PZUExdf71Ui_so67QXpySuHtCi3-J3wvF4ORK6k_S8U,91
+apyefa-0.0.6.dist-info/top_level.txt,sha256=b9VSv2S7lxdaypCumxO92IEQFpJdFuB8vQs03j5gZxY,7
+apyefa-0.0.6.dist-info/RECORD,,

apyefa/commands/command_add_info.py

@@ -1,51 +0,0 @@
-import logging
-
-from voluptuous import Any, Optional, Required, Schema
-
-from apyefa.commands.command import Command
-
-_LOGGER = logging.getLogger(__name__)
-
-
-class CommandAdditionalInfo(Command):
-    def __init__(self) -> None:
-        super().__init__("XML_ADDINFO_REQUEST", "addinfo")
-
-    def parse(self, data: dict):
-        data = self._get_parser().parse(data)
-
-        result = []
-
-        return result
-
-    def _get_params_schema(self) -> Schema:
-        return Schema(
-            {
-                Required("outputFormat", default="rapidJSON"): Any("rapidJSON"),
-                Required("coordOutputFormat", default="WGS84"): Any("WGS84"),
-                Optional("filterDateValid"): str,
-                Optional("filterDateValidDay"): str,
-                Optional("filterDateValidMonth"): str,
-                Optional("filterDateValidYear"): str,
-                Optional("filterDateValidComponentsActive"): Any("0", "1", 0, 1),
-                Optional("filterPublicationStatus"): Any("current", "history"),
-                Optional("filterValidIntervalStart"): str,
-                Optional("filterValidIntervalEnd"): str,
-                Optional("filterOMC"): str,
-                Optional("filterOMC_PlaceID"): str,
-                Optional("filterLineNumberIntervalStart"): str,
-                Optional("filterLineNumberIntervalEnd"): str,
-                Optional("filterMOTType"): str,
-                Optional("filterPNLineDir"): str,
-                Optional("filterPNLineSub"): str,
-                Optional("itdLPxx_selLine"): str,
-                Optional("itdLPxx_selOperator"): str,
-                Optional("itdLPxx_selStop"): str,
-                Optional("line"): str,
-                Optional("filterInfoID"): str,
-                Optional("filterInfoType"): str,
-                Optional("filterPriority"): str,
-                Optional("filterProviderCode"): str,
-                Optional("filterSourceSystemName"): str,
-            }
-        )

apyefa-0.0.4.dist-info/RECORD

@@ -1,22 +0,0 @@
-apyefa/__init__.py,sha256=kohSwa1VlugPyxKa0QZqQFwRi4hIGrKFd74W7NDgunA,342
-apyefa/client.py,sha256=lwAATLU_-QlAkE_n1kqn2BymvWngH84RDb2D2Z1DYbo,6857
-apyefa/data_classes.py,sha256=KKNYuVHF2d_U-CGxmkyf2RoWCP0GPUvWrrzafytxS_0,11392
-apyefa/exceptions.py,sha256=Vhc8FEtI1xSxbVRLFXd3BlNTekY2w3byEvd3Jhhg8h4,240
-apyefa/helpers.py,sha256=EJyj-Pw3xDrn8WKGbpfqbnaUZjHtVrE2A2LYpTkACps,1695
-apyefa/commands/__init__.py,sha256=_E7sD_tVa7xI7vUN1EJUwHovSU1xg0RFtbnQb7be1sQ,506
-apyefa/commands/command.py,sha256=wq3rEaYd3NUpkNqo2sX3Yw9-lcRerp8scAy2SVpx1hs,3577
-apyefa/commands/command_add_info.py,sha256=7RLV81i6sCKM3fW1DDX3RJz6GvkICqjxDICF_464ppU,1983
-apyefa/commands/command_departures.py,sha256=kHOyxxSHn7F7ClAV1fQdl1O4cOVRs6a60pkqc8-r_9o,1736
-apyefa/commands/command_serving_lines.py,sha256=NAS_9cvTq7-Lc9lFEFgVsWavEA730FH1UYqohOCDnR0,2038
-apyefa/commands/command_stop_finder.py,sha256=SXi09wA5fmGxEcMEu3XYEK4mpth-bKUoRzDyspDATWo,1944
-apyefa/commands/command_system_info.py,sha256=0bQ0oYbp7FFqPA1b5RgaxANm9-BYlN5KiwRILCCuDVY,783
-apyefa/commands/command_trip.py,sha256=kOlchWyBRlvWBqwjqpx130VXEh5kly6KMSv_pgCBljs,1095
-apyefa/commands/parsers/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-apyefa/commands/parsers/parser.py,sha256=1PSlLpfYrNeKRTpvCcYsCzAKlNrs0oHvSN7zpF4Xcs8,140
-apyefa/commands/parsers/rapid_json_parser.py,sha256=UMexRiMKkJLcK5EEj80B6RYkWBuR8ZWD3YpeGa0J3lQ,212
-apyefa/commands/parsers/xml_parser.py,sha256=ru52QtBP68KoTZ8OgjFWrLy-PD4_j1miY8Zv5umNSE8,151
-apyefa-0.0.4.dist-info/LICENSE,sha256=C2Gdvb1B39BeEP-RGqVd7w6j94GnJo4gnYyiC_l3SFQ,1066
-apyefa-0.0.4.dist-info/METADATA,sha256=OV6RcIfCeFWX_ta-4_bXp0JC3gr_j-9w5LtTBW1uO6g,15615
-apyefa-0.0.4.dist-info/WHEEL,sha256=PZUExdf71Ui_so67QXpySuHtCi3-J3wvF4ORK6k_S8U,91
-apyefa-0.0.4.dist-info/top_level.txt,sha256=b9VSv2S7lxdaypCumxO92IEQFpJdFuB8vQs03j5gZxY,7
-apyefa-0.0.4.dist-info/RECORD,,