This commit is contained in:
mdeboute
2022-04-26 22:25:40 +02:00
parent dd82e9afe9
commit 6a2c514265
12 changed files with 615 additions and 407 deletions

32
src/libs.py Normal file
View File

@@ -0,0 +1,32 @@
"""
Common libraries
"""
from json import loads as read_json
from urllib import request
from urllib.error import HTTPError
def get_data_from_json(url):
"""
Gets data from json at url
"""
opener = request.build_opener()
try:
return read_json(opener.open(url).read().decode("utf8"))
except HTTPError:
return None
def hms2seconds(hhmmss):
"""
Convert H:M:S string to time in seconds
"""
try:
cut_string = hhmmss.split(":")
cut_time = (int(cut_string[0]), int(cut_string[1]), int(cut_string[2]))
return 3600 * cut_time[0] + 60 * cut_time[1] + cut_time[2]
except (IndexError, ValueError, TypeError):
return None

245
src/stop.py Normal file
View File

@@ -0,0 +1,245 @@
"""
Provides stop information
"""
from src.libs import get_data_from_json, hms2seconds
from time import time
from urllib.parse import quote
from re import search
STOP_URL = "https://ws.infotbm.com/ws/1.0/get-schedule/%s"
INFO_URL = "https://ws.infotbm.com/ws/1.0/network/stoparea-informations/%s"
SCHEDULE_URL = "https://ws.infotbm.com/ws/1.0/get-realtime-pass/%d/%s"
line_types = (
"Tram",
"Corol",
"Lianes",
"Ligne",
"Bus Relais",
"Citéis",
)
line_translate = {
"Tram A": "A",
"Tram B": "B",
"Tram C": "C",
"Tram D": "D",
"TBNight": "58",
"BAT3": "69",
}
def search_stop_by_name(keyword):
"""
Finds the reference of a stop name
Format of data returned by the site
[
{
id: str, named ref thereafter
name: str
type: str, but we only manage "stop_area"
city: str
},
]
"""
d = get_data_from_json(STOP_URL % quote(keyword))
r = []
for i in d:
if i["type"] == "stop_area":
r.append(
{
"name": i["name"],
"city": i["city"],
"ref": i["id"],
}
)
return r
def show_stops_from_ref(ref):
"""
Displays the list of stops of a reference given by search_stop_name
Format of data returned by the site
{
id: str, content of given ref variable
name: str
latitude: str, convertible in float
longitude: str, convertible in float
city: str
hasWheelchairBoarding: bool, wheelchair accessibility
stopPoints: [
id: str
name: str, once again the name of the stop
routes: [
{
id: str
name: str, name of the terminus
line: {
name: str, human readable
}
}
]
]
}
"""
d = get_data_from_json(INFO_URL % quote(ref))
r = {
"ref": d["id"],
"name": d["name"],
"latitude": float(d["latitude"]),
"longitude": float(d["longitude"]),
"city": d["city"],
"stop_points": [],
}
for i in d["stopPoints"]:
s = {
"name": i["name"],
"routes": [],
}
s["id"] = int(search("[0-9]+$", i["id"]).group())
for j in i["routes"]:
rte = {
"terminus": j["name"],
"line_human": j["line"]["name"],
}
add = False
if rte["line_human"] in line_translate:
line_id = line_translate[rte["line_human"]]
add = True
else:
try:
line_id = search("[0-9]+$", rte["line_human"]).group()
except AttributeError:
continue
line_id = "%02d" % int(line_id)
for i in line_types:
if rte["line_human"][0 : len(i)] == i:
add = True
break
if add:
rte["line_id"] = line_id
s["routes"].append(rte)
if s["routes"] != []:
r["stop_points"].append(s)
return r
class StopRoute:
"""
Retrieves information about a stop
Format of data returned by the site
{
destinations: {
<destination_stop_id>: [
{
destination_name: str
realtime: 1 if followed, 0 otherwise
vehicle_id: str
vehicle_lattitude: float
vehicle_longitude: float
waittime: HH:MM:SS
waittime_text: str, human readable
},
]
}
}
"""
def __init__(
self,
number,
line,
autoupdate_at_creation=True,
autoupdate=False,
autoupdate_delay=-1,
):
self.number = number
self.line = line
self.last_update = 0
self.data = None
if autoupdate_at_creation:
self.update()
def update(self, auto=False):
"""
Update data
"""
d = get_data_from_json(SCHEDULE_URL % (self.number, self.line))
if "destinations" in d:
d = d["destinations"]
else:
return ()
self.last_update = time()
if type(d) == dict:
self.data = []
# let's simplify the data
for i in d:
for j in d[i]:
loc = None
try:
loc = (
float(j["vehicle_lattitude"]),
float(j["vehicle_longitude"]),
)
except TypeError:
pass
vehicle = {
"id": j["vehicle_id"],
"destination": j["destination_name"],
"realtime": j["realtime"] == "1",
"location": loc,
"wait_time": hms2seconds(j["waittime"]),
"wait_time_human": j["waittime_text"],
"arrival": int(self.last_update + hms2seconds(j["waittime"])),
}
self.data.append(vehicle)
self.data = sorted(self.data, key=lambda item: item["arrival"])
else:
self.last_update = 0
def data_age(self):
"""
Returns the age of the data
"""
return time() - self.last_update
def get_line(self):
class Line:
"""
Information on the line served at a stop
"""
def __init__(self, data):
self.ve = data
def vehicles(self):
if self.ve is not None:
return list(range(0, len(self.ve)))
return []
def get_vehicle(self, vehicle):
class Vehicle:
"""
Information on a vehicle passage
"""
def __init__(self, data):
self.id = data["id"]
self.location = data["location"]
self.destination = data["destination"]
self.is_realtime = data["realtime"]
self.wait_time = data["wait_time"]
self.wait_time_text = data["wait_time_human"]
self.arrival = data["arrival"]
return Vehicle(self.ve[vehicle])
return Line(self.data)

0
src/utils.py Normal file
View File

132
src/vcub.py Normal file
View File

@@ -0,0 +1,132 @@
"""
Provides all info about V³ stations
"""
from src.libs import get_data_from_json
from time import time
vcub_url = "https://ws.infotbm.com/ws/1.0/vcubs"
class Vcub:
"""
Retrieves information from V³ stations
Data format, as returned by the infotbm website:
{
lists: [
{
'id': station number,
'name': str,
'connexionState': 'CONNECTED' if in service 'DISCONNECTED' otherwise,
'typeVlsPlus': 'VLS_PLUS' if V³+ 'PAS_VLS_PLUS' otherwise,
'nbPlaceAvailable': 33,
'nbBikeAvailable': 0
'nbElectricBikeAvailable': 6
'latitude': float,
'longitude': float,
},
]
}
"""
def __init__(
self,
autoupdate_at_creation=None,
autoupdate=False,
autoupdate_delay=-1,
data=None,
):
self.last_update = 0
if type(data) == dict:
self.data = self.update(data=data)
else:
self.data = None
if autoupdate_at_creation or (
autoupdate_at_creation is None and self.data is None
):
self.update()
def update(self, auto=False, data=None):
"""
Updates data
auto optionnal param is to set if a update is a automatic one,
and must be performed as defined in autoupdate_delay variable
"""
if data is None or type(data) != dict:
d = get_data_from_json(vcub_url)
else:
d = data
# the original format is awfull, so I change it a little
if type(d) == dict:
self.data = {}
d = d["lists"]
for i in d:
e = {
"name": i["name"],
"online": i["connexionState"] == "CONNECTEE",
"plus": i["typeVlsPlus"] == "VLS_PLUS",
"empty": int(i["nbPlaceAvailable"]),
"bikes": int(i["nbBikeAvailable"]),
"ebikes": int(i["nbElectricBikeAvailable"]),
"location": (float(i["latitude"]), float(i["longitude"])),
}
self.data[int(i["id"])] = e
self.last_update = time()
def data_age(self):
"""
Computes the data's age
"""
return time() - self.last_update
def get_names(self):
"""
Returns all names in a dict with id as data
"""
r = {}
for i in self.data:
r[self.data[i]["name"]] = i
return r
def get_locations(self):
"""
Returns all locations in a dict with id as data
"""
r = {}
for i in self.data:
r[self.data[i]["location"]] = i
return r
def get_by_id(self, id):
"""
Returns a station by its id
"""
class Station:
"""
A V³ station
"""
def __init__(self, data, id):
self.data = data
self.id = id
self.name = self.data["name"]
self.location = self.data["location"]
self.online = self.data["online"]
self.isplus = self.data["plus"]
self.bikes = self.data["bikes"]
self.ebikes = self.data["ebikes"]
self.empty = self.data["empty"]
def __int__(self):
return self.id
return Station(self.data[id], id)
def get_all_ids(self):
return tuple(self.data.keys())