profitroll/PythonRMV
1
1
Fork 0
Code Issues 1 Pull Requests Actions Packages Releases 4 Wiki Activity

Typing improved

Browse Source
This commit is contained in:
Profitroll
2022-10-12 17:08:49 +02:00
parent e09e8f29fb
commit 3599a034dc
9 changed files with 255 additions and 255 deletions
Download Patch File Download Diff File Expand all files Collapse all files

202
pyrmv/classes/Client.py
View File

@@ -70,15 +70,15 @@ class Client():
self.access_id = access_id
def board_arrival(self,
id: str = None, # type: ignore
id_ext: str = None, # type: ignore
direction: Union[str, Stop, StopTrip] = None, # type: ignore
date: Union[str, datetime] = None, # type: ignore
time: Union[str, datetime] = None, # type: ignore
id: Union[str, None] = None,
id_ext: Union[str, None] = None,
direction: Union[str, Stop, StopTrip, None] = None,
date: Union[str, datetime, None] = None,
time: Union[str, datetime, None] = None,
duration: Union[int, timedelta] = 60,
journeys_max: int = -1,
operators: Union[str, list] = None, # type: ignore
lines: Union[str, list] = None, # type: ignore
operators: Union[str, list, None] = None,
lines: Union[str, list, None] = None,
passlist: bool = False,
board_type: Literal[BoardArrivalType.ARR, BoardArrivalType.ARR_EQUIVS, BoardArrivalType.ARR_MAST, BoardArrivalType.ARR_STATION] = BoardArrivalType.ARR,
) -> BoardArrival:
@@ -113,7 +113,7 @@ class Client():
direction=direction, # type: ignore
date=date,
time=time,
duration=duration, # type: ignore
duration=duration,
maxJourneys=journeys_max,
operators=operators,
lines=lines,
@@ -126,15 +126,15 @@ class Client():
return BoardArrival(board_raw, self)
def board_departure(self,
id: str = None, # type: ignore
id_ext: str = None, # type: ignore
direction: Union[str, Stop, StopTrip] = None, # type: ignore
date: Union[str, datetime] = None, # type: ignore
time: Union[str, datetime] = None, # type: ignore
id: Union[str, None] = None,
id_ext: Union[str, None] = None,
direction: Union[str, Stop, StopTrip, None] = None,
date: Union[str, datetime, None] = None,
time: Union[str, datetime, None] = None,
duration: Union[int, timedelta] = 60,
journeys_max: int = -1,
operators: Union[str, list] = None, # type: ignore
lines: Union[str, list] = None, # type: ignore
operators: Union[str, list, None] = None,
lines: Union[str, list, None] = None,
passlist: bool = False,
board_type: Literal[BoardDepartureType.DEP, BoardDepartureType.DEP_EQUIVS, BoardDepartureType.DEP_MAST, BoardDepartureType.DEP_STATION] = BoardDepartureType.DEP,
) -> BoardDeparture:
@@ -169,7 +169,7 @@ class Client():
direction=direction, # type: ignore
date=date,
time=time,
duration=duration, # type: ignore
duration=duration,
maxJourneys=journeys_max,
operators=operators,
lines=lines,
@@ -182,28 +182,28 @@ class Client():
return BoardDeparture(board_raw, self)
def him_search(self,
date_begin: Union[str, datetime] = None, # type: ignore
date_end: Union[str, datetime] = None, # type: ignore
time_begin: Union[str, datetime] = None, # type: ignore
time_end: Union[str, datetime] = None, # type: ignore
weekdays: Union[str, OrderedDict[str, bool]] = None, # type: ignore
ids: list = None, # type: ignore
operators: list = None, # type: ignore
categories: list = None, # type: ignore
channels: list = None, # type: ignore
companies: list = None, # type: ignore
lines: list = None, # type: ignore
line_ids: list = None, # type: ignore
stations: Union[list, List[Stop]] = None, # type: ignore
station_from: Union[str, Stop] = None, # type: ignore
station_to: Union[str, Stop] = None, # type: ignore
both_ways: bool = None, # type: ignore
train_names: list = None, # type: ignore
search_mode: Literal[SearchMode.MATCH, SearchMode.NOMATCH, SearchMode.TFMATCH] = None, # type: ignore
affected_journey_mode: Literal[AffectedJourneyMode.ALL, AffectedJourneyMode.OFF] = None, # type: ignore
affected_journey_stop_mode: Literal[AffectedJourneyStopMode.ALL, AffectedJourneyStopMode.IMP, AffectedJourneyStopMode.OFF] = None, # type: ignore
priority_min: int = None, # type: ignore
priority_max: int = None # type: ignore
date_begin: Union[str, datetime, None] = None,
date_end: Union[str, datetime, None] = None,
time_begin: Union[str, datetime, None] = None,
time_end: Union[str, datetime, None] = None,
weekdays: Union[str, OrderedDict[str, bool], None] = None,
ids: Union[list, None] = None,
operators: Union[list, None] = None,
categories: Union[list, None] = None,
channels: Union[list, None] = None,
companies: Union[list, None] = None,
lines: Union[list, None] = None,
line_ids: Union[list, None] = None,
stations: Union[list, List[Stop], None] = None,
station_from: Union[str, Stop, None] = None,
station_to: Union[str, Stop, None] = None,
both_ways: Union[bool, None] = None,
train_names: Union[list, None] = None,
search_mode: Union[Literal[SearchMode.MATCH, SearchMode.NOMATCH, SearchMode.TFMATCH], None] = None,
affected_journey_mode: Union[Literal[AffectedJourneyMode.ALL, AffectedJourneyMode.OFF], None] = None,
affected_journey_stop_mode: Union[Literal[AffectedJourneyStopMode.ALL, AffectedJourneyStopMode.IMP, AffectedJourneyStopMode.OFF], None] = None,
priority_min: Union[int, None] = None,
priority_max: Union[int, None] = None
) -> List[Message]:
"""The him_search method will deliver a list of HIM messages if matched by the given criteria as
well as affected products if any.
@@ -239,10 +239,10 @@ class Client():
"""
if isinstance(station_from, Stop):
station_from = station_from.ext_id # type: ignore
station_from = station_from.ext_id
if isinstance(station_to, Stop):
station_to = station_to.ext_id # type: ignore
station_to = station_to.ext_id
if stations != None:
new_stations = []
@@ -254,17 +254,17 @@ class Client():
stations = new_stations
if search_mode == None:
search_mode = None # type: ignore
search_mode = None
else:
search_mode = search_mode.code
if affected_journey_mode == None:
affected_journey_mode = None # type: ignore
affected_journey_mode = None
else:
affected_journey_mode = affected_journey_mode.code
if affected_journey_stop_mode == None:
affected_journey_stop_mode = None # type: ignore
affected_journey_stop_mode = None
else:
affected_journey_stop_mode = affected_journey_stop_mode.code
@@ -304,12 +304,12 @@ class Client():
def journey_detail(self,
id: str,
date: Union[str, datetime] = None, # type: ignore
real_time_mode: Literal[RealTimeMode.FULL, RealTimeMode.INFOS, RealTimeMode.OFF, RealTimeMode.REALTIME, RealTimeMode.SERVER_DEFAULT] = None, # type: ignore
from_id: str = None, # type: ignore
from_index: int = None, # type: ignore
to_id: str = None, # type: ignore
to_index: int = None # type: ignore
date: Union[str, datetime, None] = None,
real_time_mode: Union[Literal[RealTimeMode.FULL, RealTimeMode.INFOS, RealTimeMode.OFF, RealTimeMode.REALTIME, RealTimeMode.SERVER_DEFAULT], None] = None,
from_id: Union[str, None] = None,
from_index: Union[int, None] = None,
to_id: Union[str, None] = None,
to_index: Union[int, None] = None
) -> Journey:
"""The journey_detail method will deliver information about the complete route of a vehicle. The journey
identifier is part of a trip or `board_departure()` response. It contains a list of all stops/stations of this journey
@@ -332,7 +332,7 @@ class Client():
"""
if real_time_mode == None:
real_time_mode = None # type: ignore
real_time_mode = None
else:
real_time_mode = real_time_mode.code
@@ -342,9 +342,9 @@ class Client():
date=date,
rtMode=real_time_mode, # type: ignore
fromId=from_id,
fromIdx=from_index, # type: ignore
fromIdx=from_index,
toId=to_id,
toIdx=to_index # type: ignore
toIdx=to_index
)
find_exception(journey_raw)
@@ -359,7 +359,7 @@ class Client():
radius: Union[int, float] = 1000,
max_number: int = 10,
stop_type: Literal[LocationType.S, LocationType.P, LocationType.SP, LocationType.SE, LocationType.SPE] = LocationType.S,
selection_mode: Literal[SelectionMode.SLCT_A, SelectionMode.SLCT_N] = None, # type: ignore
selection_mode: Union[Literal[SelectionMode.SLCT_A, SelectionMode.SLCT_N], None] = None,
) -> List[Stop]:
"""Method returns a list of stops around a given center coordinate.
The returned results are ordered by their distance to the center coordinate.
@@ -380,7 +380,7 @@ class Client():
"""
if selection_mode == None:
selection_mode = None # type: ignore
selection_mode = None
else:
selection_mode = selection_mode.code
@@ -446,12 +446,12 @@ class Client():
lang: Literal[Language.DE, Language.DA, Language.EN, Language.ES, Language.FR, Language.HU, Language.IT, Language.NL, Language.NO, Language.PL, Language.SV, Language.TR] = Language.EN,
max_number: int = 10,
stop_type: Literal[LocationType.A, LocationType.ALL, LocationType.AP, LocationType.P, LocationType.S, LocationType.SA, LocationType.SP] = LocationType.ALL,
selection_mode: Literal[SelectionMode.SLCT_A, SelectionMode.SLCT_N] = None, # type: ignore
coord_lat: Union[str, float] = None, # type: ignore
coord_lon: Union[str, float] = None, # type: ignore
selection_mode: Union[Literal[SelectionMode.SLCT_A, SelectionMode.SLCT_N], None] = None,
coord_lat: Union[str, float, None] = None,
coord_lon: Union[str, float, None] = None,
radius: Union[int, float] = 1000,
refine_id: str = None, # type: ignore
stations: Union[str, list] = None, # type: ignore
refine_id: Union[str, None] = None,
stations: Union[str, list, None] = None,
filter_mode: Literal[FilterMode.DIST_PERI, FilterMode.EXCL_PERI, FilterMode.SLCT_PERI] = FilterMode.DIST_PERI
) -> List[Stop]:
"""Method can be used to perform a pattern matching of a user input and to retrieve a list
@@ -478,7 +478,7 @@ class Client():
"""
if selection_mode == None:
selection_mode = None # type: ignore
selection_mode = None
else:
selection_mode = selection_mode.code
@@ -511,47 +511,47 @@ class Client():
def trip_find(self,
lang: Literal[Language.DE, Language.DA, Language.EN, Language.ES, Language.FR, Language.HU, Language.IT, Language.NL, Language.NO, Language.PL, Language.SV, Language.TR] = Language.EN,
origin_id: str = None, # type: ignore
origin_id_ext: str = None, # type: ignore
origin_coord_lat: Union[str, float] = None, # type: ignore
origin_coord_lon: Union[str, float] = None, # type: ignore
origin_coord_name: str = None, # type: ignore
origin_id: Union[str, None] = None,
origin_id_ext: Union[str, None] = None,
origin_coord_lat: Union[str, float, None] = None,
origin_coord_lon: Union[str, float, None] = None,
origin_coord_name: Union[str, None] = None,
destination_id: str = None, # type: ignore
destination_id_ext: str = None, # type: ignore
destination_coord_lat: Union[str, float] = None, # type: ignore
destination_coord_lon: Union[str, float] = None, # type: ignore
destination_coord_name: str = None, # type: ignore
destination_id: Union[str, None] = None,
destination_id_ext: Union[str, None] = None,
destination_coord_lat: Union[str, float, None] = None,
destination_coord_lon: Union[str, float, None] = None,
destination_coord_name: Union[str, None] = None,
via: str = None, # type: ignore
via_id: str = None, # type: ignore
via_gis: str = None, # type: ignore
via: Union[str, None] = None,
via_id: Union[str, None] = None,
via_gis: Union[str, None] = None,
via_wait_time: int = 0,
avoid: str = None, # type: ignore
avoid_id: str = None, # type: ignore
avoid: Union[str, None] = None,
avoid_id: Union[str, None] = None,
change_time_percent: int = 100,
change_time_min: int = None, # type: ignore
change_time_max: int = None, # type: ignore
change_time_add: int = None, # type: ignore
change_max: int = None, # type: ignore
change_time_min: Union[int, None] = None,
change_time_max: Union[int, None] = None,
change_time_add: Union[int, None] = None,
change_max: Union[int, None] = None,
date: Union[str, datetime] = None, # type: ignore
time: Union[str, datetime] = None, # type: ignore
date: Union[str, datetime, None] = None,
time: Union[str, datetime, None] = None,
search_arrival: bool = False,
trips_after_time: int = None, # type: ignore
trips_before_time: int = None, # type: ignore
trips_after_time: Union[int, None] = None,
trips_before_time: Union[int, None] = None,
context: str = None, # type: ignore
context: Union[str, None] = None,
passlist: bool = False,
operators: Union[str, list] = None, # type: ignore
operators: Union[str, list, None] = None,
lines: Union[str, list] = None, # type: ignore
lineids: Union[str, list] = None, # type: ignore
lines: Union[str, list, None] = None,
lineids: Union[str, list, None] = None,
iv_include: bool = False,
iv_only: bool = False,
@@ -560,11 +560,11 @@ class Client():
passing_points: bool = False,
real_time_mode: Literal[RealTimeMode.FULL, RealTimeMode.INFOS, RealTimeMode.OFF, RealTimeMode.REALTIME, RealTimeMode.SERVER_DEFAULT] = None, # type: ignore
real_time_mode: Union[Literal[RealTimeMode.FULL, RealTimeMode.INFOS, RealTimeMode.OFF, RealTimeMode.REALTIME, RealTimeMode.SERVER_DEFAULT], None] = None,
include_earlier: bool = False,
ict_alternatives: bool = False,
tariff: bool = None, # type: ignore
tariff: Union[bool, None] = None,
messages: bool = False,
frequency: bool = True
) -> List[Trip]:
@@ -623,7 +623,7 @@ class Client():
"""
if real_time_mode == None:
real_time_mode = None # type: ignore
real_time_mode = None
else:
real_time_mode = real_time_mode.code
@@ -700,17 +700,17 @@ class Client():
def trip_recon(self,
context: Union[str, Trip],
date: Union[str, datetime] = None, # type: ignore
match_real_time: bool = None, # type: ignore
enable_replacements: bool = None, # type: ignore
arrival_dev_lower: int = None, # type: ignore
arrival_dev_upper: int = None, # type: ignore
departure_dev_lower: int = None, # type: ignore
departure_dev_upper: int = None, # type: ignore
passlist: bool = None, # type: ignore
date: Union[str, datetime, None] = None,
match_real_time: Union[bool, None] = None,
enable_replacements: Union[bool, None] = None,
arrival_dev_lower: Union[int, None] = None,
arrival_dev_upper: Union[int, None] = None,
departure_dev_lower: Union[int, None] = None,
departure_dev_upper: Union[int, None] = None,
passlist: bool = False,
passing_points: bool = False,
real_time_mode: Literal[RealTimeMode.FULL, RealTimeMode.INFOS, RealTimeMode.OFF, RealTimeMode.REALTIME, RealTimeMode.SERVER_DEFAULT] = None, # type: ignore
tariff: bool = None, # type: ignore
real_time_mode: Union[Literal[RealTimeMode.FULL, RealTimeMode.INFOS, RealTimeMode.OFF, RealTimeMode.REALTIME, RealTimeMode.SERVER_DEFAULT], None] = None,
tariff: Union[bool, None] = None,
messages: bool = False
) -> List[Trip]:
"""Reconstructing a trip can be achieved using the reconstruction context provided by any trip result in the
@@ -739,7 +739,7 @@ class Client():
"""
if real_time_mode == None:
real_time_mode = None # type: ignore
real_time_mode = None
else:
real_time_mode = real_time_mode.code