apyefa 0.0.5__tar.gz → 0.0.7__tar.gz

{apyefa-0.0.5 → apyefa-0.0.7}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: apyefa
-Version: 0.0.5
+Version: 0.0.7
 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

{apyefa-0.0.5 → apyefa-0.0.7}/README.md

@@ -140,16 +140,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

{apyefa-0.0.5 → apyefa-0.0.7}/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-0.0.5 → apyefa-0.0.7}/apyefa/client.py

@@ -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

{apyefa-0.0.5 → apyefa-0.0.7}/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-0.0.5 → apyefa-0.0.7}/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-0.0.5 → apyefa-0.0.7}/apyefa/commands/command_serving_lines.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 Line, LineRequestType
+from apyefa.data_classes import CoordFormat, Line, LineRequestType
 
 _LOGGER = logging.getLogger(__name__)
 
@@ -41,7 +41,9 @@ 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"),

{apyefa-0.0.5 → apyefa-0.0.7}/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,
@@ -41,6 +43,10 @@ class CommandStopFinder(Command):
                 Optional("anyResSort_sf"): str,
                 Optional("anyObjFilter_sf"): int,
                 Optional("doNotSearchForStops_sf"): Any("0", "1", 0, 1),
+                Optional("locationInfoActive_sf"): Any("0", "1", 0, 1),
+                Optional("useHouseNumberList_sf"): Any("0", "1", 0, 1),
+                Optional("useLocalityMainStop"): Any("0", "1", 0, 1),
+                Optional("prMinQu"): int,
                 Optional("anyObjFilter_origin"): Range(
                     min=0, max=sum([x.value for x in LocationFilter])
                 ),

{apyefa-0.0.5 → apyefa-0.0.7}/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-0.0.5 → apyefa-0.0.7}/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-0.0.5 → apyefa-0.0.7}/apyefa/data_classes.py

@@ -97,7 +97,7 @@ def IsLocationType(type: str):
 
 SCHEMA_PROPERTIES = vol.Schema(
     {
-        vol.Required("stopId"): str,
+        vol.Optional("stopId"): str,
         vol.Optional("downloads"): list,
         vol.Optional("area"): str,
         vol.Optional("platform"): str,

{apyefa-0.0.5 → apyefa-0.0.7}/apyefa.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: apyefa
-Version: 0.0.5
+Version: 0.0.7
 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

{apyefa-0.0.5 → apyefa-0.0.7}/pyproject.toml

@@ -7,7 +7,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "apyefa"
-version = "0.0.5"
+version = "0.0.7"
 requires-python = ">= 3.11"
 description = "Python API for EFA(Elektronische Fahrplanauskunft) async requests"
 authors = [

{apyefa-0.0.5 → apyefa-0.0.7}/tests/commands/test_cmd.py

@@ -48,7 +48,7 @@ def test_command_init(mock_command):
 def test_command_to_str_default_params(mock_command):
     assert (
         str(mock_command)
-        == "my_name?commonMacro=my_macro&outputFormat=rapidJSON&coordOutputFormat=WGS84"
+        == "my_name?commonMacro=my_macro&outputFormat=rapidJSON&coordOutputFormat=WGS84[dd.ddddd]"
     )
 
 

{apyefa-0.0.5 → apyefa-0.0.7}/tests/commands/test_cmd_departures.py

@@ -28,7 +28,7 @@ def test_init_name_and_macro(command):
 def test_init_params(command):
     expected_params = {
         "outputFormat": "rapidJSON",
-        "coordOutputFormat": "WGS84",
+        "coordOutputFormat": "WGS84[dd.ddddd]",
         "name_dm": "my_stop",
     }
 

{apyefa-0.0.5 → apyefa-0.0.7}/tests/commands/test_cmd_serving_lines.py

@@ -29,7 +29,7 @@ def test_init_params_mode_odv():
 
     expected_params = {
         "outputFormat": "rapidJSON",
-        "coordOutputFormat": "WGS84",
+        "coordOutputFormat": "WGS84[dd.ddddd]",
         "mode": "odv",
         "name_sl": "my_value",
         "type_sl": "stopID",
@@ -43,7 +43,7 @@ def test_init_params_mode_line():
 
     expected_params = {
         "outputFormat": "rapidJSON",
-        "coordOutputFormat": "WGS84",
+        "coordOutputFormat": "WGS84[dd.ddddd]",
         "mode": "line",
         "lineName": "my_value",
     }
@@ -89,6 +89,6 @@ def test_add_param_failed(command, param, value):
 
 # test 'to_str() and __str()__'
 def test_to_str(command):
-    expected_str = f"{NAME}?commonMacro={MACRO}&outputFormat=rapidJSON&coordOutputFormat=WGS84&type_sl=stopID&name_sl=my_name&mode=odv"
+    expected_str = f"{NAME}?commonMacro={MACRO}&outputFormat=rapidJSON&coordOutputFormat=WGS84[dd.ddddd]&type_sl=stopID&name_sl=my_name&mode=odv"
 
     assert command.to_str() == expected_str and str(command) == expected_str

{apyefa-0.0.5 → apyefa-0.0.7}/tests/commands/test_cmd_stop_finder.py

@@ -24,7 +24,7 @@ def test_init_name_and_macro(command):
 def test_init_params(command):
     expected_params = {
         "outputFormat": "rapidJSON",
-        "coordOutputFormat": "WGS84",
+        "coordOutputFormat": "WGS84[dd.ddddd]",
         "type_sf": "any",
         "name_sf": "my_name",
     }
@@ -49,7 +49,7 @@ def test_add_param_failed(command, param, value):
 
 # test 'to_str() and __str()__'
 def test_to_str(command):
-    expected_str = f"{NAME}?commonMacro={MACRO}&outputFormat=rapidJSON&coordOutputFormat=WGS84&type_sf=any&name_sf=my_name"
+    expected_str = f"{NAME}?commonMacro={MACRO}&outputFormat=rapidJSON&coordOutputFormat=WGS84[dd.ddddd]&type_sf=any&name_sf=my_name"
 
     assert command.to_str() == expected_str and str(command) == expected_str
 

{apyefa-0.0.5 → apyefa-0.0.7}/tests/commands/test_cmd_system_info.py

@@ -23,7 +23,10 @@ def test_init_name_and_macro(command):
 
 
 def test_init_parameters(command):
-    expected_params = {"outputFormat": "rapidJSON", "coordOutputFormat": "WGS84"}
+    expected_params = {
+        "outputFormat": "rapidJSON",
+        "coordOutputFormat": "WGS84[dd.ddddd]",
+    }
 
     assert command._parameters == expected_params
 
@@ -45,9 +48,7 @@ def test_add_param_failed(command, param, value):
 
 # test 'to_str() and __str()__'
 def test_to_str(command):
-    expected_str = (
-        f"{NAME}?commonMacro={MACRO}&outputFormat=rapidJSON&coordOutputFormat=WGS84"
-    )
+    expected_str = f"{NAME}?commonMacro={MACRO}&outputFormat=rapidJSON&coordOutputFormat=WGS84[dd.ddddd]"
 
     assert command.to_str() == expected_str and str(command) == expected_str
 

{apyefa-0.0.5 → apyefa-0.0.7}/tests/commands/test_commands.py

@@ -53,17 +53,20 @@ def test_init_macro_and_name(command, cmd_name, cmd_macro, request):
     [
         (
             "system_info_command",
-            {"outputFormat": "rapidJSON", "coordOutputFormat": "WGS84"},
+            {"outputFormat": "rapidJSON", "coordOutputFormat": "WGS84[dd.ddddd]"},
         ),
         (
             "departures_command",
             {
                 "outputFormat": "rapidJSON",
-                "coordOutputFormat": "WGS84",
+                "coordOutputFormat": "WGS84[dd.ddddd]",
                 "name_dm": "my_stop",
             },
         ),
-        ("trip_command", {"outputFormat": "rapidJSON", "coordOutputFormat": "WGS84"}),
+        (
+            "trip_command",
+            {"outputFormat": "rapidJSON", "coordOutputFormat": "WGS84[dd.ddddd]"},
+        ),
     ],
 )
 def test_init_parameters(command, expected, request):
@@ -79,7 +82,7 @@ def test_init_parameters_serving_lines():
     cmd = CommandServingLines("line", "my_value")
     assert cmd._parameters == {
         "outputFormat": "rapidJSON",
-        "coordOutputFormat": "WGS84",
+        "coordOutputFormat": "WGS84[dd.ddddd]",
         "lineName": "my_value",
         "mode": "line",
     }
@@ -87,7 +90,7 @@ def test_init_parameters_serving_lines():
     cmd = CommandServingLines("odv", "my_value")
     assert cmd._parameters == {
         "outputFormat": "rapidJSON",
-        "coordOutputFormat": "WGS84",
+        "coordOutputFormat": "WGS84[dd.ddddd]",
         "type_sl": "stopID",
         "name_sl": "my_value",
         "mode": "odv",