iwls_api_request package

iwls_api_request.api_config.get_api_config(config_file=PosixPath('/home/docs/checkouts/readthedocs.org/user_builds/chs-csb-processing/checkouts/stable/config/config_API.toml'))[source]

Retournes la configuration de l’API IWLS

Paramètres:: config_file (Path) – Le fichier de configuration.
Renvoie:: Un objet APIConfig.
Type renvoyé:: IWLSAPIConfig

iwls_api_request.api_config.get_environment_config(api_config_dict)[source]

Retournes les configurations des environnements de l’API IWLS

Paramètres:: api_config_dict (IWLSapiDict) – La configuration de l’API IWLS.
Renvoie:: Les configurations des environnements de l’API IWLS.
Type renvoyé:: dict[str, APIEnvironment]

iwls_api_request.api_config.load_config(config_file=PosixPath('/home/docs/checkouts/readthedocs.org/user_builds/chs-csb-processing/checkouts/stable/config/config_API.toml'))[source]

Retournes la configuration de l’API IWLS

Paramètres:: config_file (Path) – Le fichier de configuration.
Renvoie:: La configuration de l’API IWLS.
Type renvoyé:: IWLSapiDict

iwls_api_request.api_facade module

class iwls_api_request.api_facade.EnvironmentType(value)[source]

Bases : StrEnum

DEV = 'dev'

PROD = 'prod'

PUBLIC = 'public'

class iwls_api_request.api_facade.HandlerType(value)[source]

Bases : StrEnum

RATE_LIMITER = 'rate_limiter'

REQUESTS = 'request'

iwls_api_request.api_facade._configure_session_type(session_type_config)[source]

Fonction qui configure le type de session en fonction de la configuration.

Paramètres:: session_type_config (SessionType | CachedSessionConfig) – (SessionType | CachedSessionConfig) Le type de session ou la configuration pour la cache.
Type renvoyé:: tuple[SessionType, CachedSessionConfig | None]
Renvoie:: (tuple[SessionType, CachedSessionConfig | None]) Le type de session et la configuration pour la cache.

iwls_api_request.api_facade._get_handler(handler_type, calls, period, session_type_config)[source]

Fonction qui retourne un gestionnaire de requêtes en fonction du type de gestionnaire.

Paramètres:

handler_type (HandlerType) – (HandlerType) Le type de gestionnaire de requêtes.
calls (int) – (int) Le nombre de requêtes autorisées (nécessaire pour “HandlerType.RATE_LIMITER).
period (int) – (int) La période de temps pour les requêtes autorisées (nécessaire pour HandlerType.RATE_LIMITER).
session_type_config (SessionType | CachedSessionConfig) – (SessionType | CachedSessionConfig) Le type de session ou la configuration pour la cache.

Type renvoyé:

RequestsHandler

Renvoie:

(RequestsHandler) Le gestionnaire de requêtes.

iwls_api_request.api_facade._mount_retry_adapter(handler, retry_adapter_config)[source]

Fonction qui monte un adaptateur de réessai sur le gestionnaire de requêtes.

Paramètres:

handler (RequestsHandler) – (RequestsHandler) Le gestionnaire de requêtes.
retry_adapter_config (RetryAdapterConfig | bool) – (RetryAdapterConfig | bool) La configuration pour l’adaptateur de réessai ou un booléen. Si True, une configuration par défaut est utilisé, si False, aucun adaptateur est utilisé.

Renvoie:

(None)

iwls_api_request.api_facade.get_api_factory(endpoint)[source]

Retournes la classe de l’API IWLS en fonction du profil.

Paramètres:: endpoint (EndpointType) – (Endpoint) L’endpoint de l’API IWLS.
Renvoie:: (type[IWLSapi]) La classe de l’API IWLS.
Renvoie:: La classe de l’API IWLS.
Type renvoyé:: type[IWLSapiABC]

iwls_api_request.api_facade.get_iwls_api(endpoint, handler_type=HandlerType.RATE_LIMITER, calls=10, period=1, session_type_config=SessionType.REQUESTS, retry_adapter_config=True)[source]

Fonction qui retourne l’API IWLS.

Paramètres:

endpoint (Endpoint) – (Endpoint) L’endpoint de l’API IWLS.
handler_type (Optional[HandlerType]) – (HandlerType) Le type de gestionnaire de requêtes.
calls (Optional[int]) – (int) Le nombre de requêtes autorisées (nécessaire pour “HandlerType.RATE_LIMITER).
period (Optional[int]) – (int) La période de temps pour les requêtes autorisées (nécessaire pour HandlerType.RATE_LIMITER).
session_type_config (Union[SessionType, CachedSessionConfig, None]) – (SessionType) Le type de session ou la configuration pour la cache. Si une configuration est fourni, le session_type est alors automatiquement SessionType.CACHE.
retry_adapter_config (Union[RetryAdapterConfig, bool, None]) – (RetryAdapterConfig | bool) La configuration pour l’adaptateur de réessai ou un booléen. Si True, une configuration par défaut est utilisé, si False, aucun adaptateur est utilisé.

Type renvoyé:

IWLSapiABC | IWLSapiPrivate | IWLSapiPublic

Renvoie:

(IWLSapi) L’API IWLS.

Module contents

exception iwls_api_request.CoordinatesError[source]: Bases : Exception

exception iwls_api_request.StationsError[source]: Bases : Exception

class iwls_api_request.APIEnvironment(**data)[source]

Bases : BaseModel

class Config[source]

Bases : object

arbitrary_types_allowed = True

classmethod must_be_positive(value)[source]

calls: int

endpoint: Endpoint

name: str

period: int

class iwls_api_request.APIProfile(**data)[source]

Bases : BaseModel

active: EnvironmentType

class iwls_api_request.CachedSessionConfig(db=PosixPath('/home/docs/checkouts/readthedocs.org/user_builds/chs-csb-processing/checkouts/stable/src/iwls_api_request/handler/.cache/IWLS'), backend='sqlite', allowable_methods=('GET',), expire_after=600, timeout=5)[source]

Bases : object

allowable_methods: tuple[str] | None = ('GET',)

backend: str | None = 'sqlite'

db: Path | None = PosixPath('/home/docs/checkouts/readthedocs.org/user_builds/chs-csb-processing/checkouts/stable/src/iwls_api_request/handler/.cache/IWLS')

expire_after: int | None = 600

timeout: int | None = 5

class iwls_api_request.Endpoint(API, TYPE, BENCHMARK, BENCHMARKS, BENCHMARK_METADATA, ELEVVATIONS, HEIGHT_TYPE, HEIGHT_TYPES, PHENOMENA, PHENOMENON, STATION, STATIONS, STATION_DATA, STATION_METADATA, TIDE_TABLE, TIDE_TABLES, TIME_SERIES_DEFINITION, TIME_SERIE_DEFINITION, GNSS_STATION=None, GNSS_STATIONS=None, GNSS_SUM=None, REGIONS=None, STATION_DATA_LATEST=None, STATION_TIME_SERIES=None, STATION_STATS_DAILY=None, STATION_STATS_MONTHLY=None)[source]

Bases : ABC

Classe abstraite pour les points d’entrés de l’API.

Paramètres:

API (str) – URL de l’API.
TYPE (EndpointType) – Type de l’API.
BENCHMARK (str) – Point d’entrée pour un repère.
BENCHMARKS (str) – Point d’entrée pour les repères.
BENCHMARK_METADATA (str) – Point d’entrée pour les métadonnées d’un repère.
ELEVVATIONS (str) – Point d’entrée pour les élévations d’un repère.
HEIGHT_TYPE (str) – Point d’entrée pour un type de hauteur.
HEIGHT_TYPES (str) – Point d’entrée pour les types de hauteurs.
PHENOMENA (str) – Point d’entrée pour les phénomènes.
PHENOMENON (str) – Point d’entrée pour un phénomène.
STATION (str) – Point d’entrée pour une station.
STATIONS (str) – Point d’entrée pour les stations.
STATION_DATA (str) – Point d’entrée pour les données d’une station.
STATION_METADATA (str) – Point d’entrée pour les métadonnées d’une station.
TIDE_TABLE (str) – Point d’entrée pour une table des marées.
TIDE_TABLES (str) – Point d’entrée pour les tables des marées.
TIME_SERIES_DEFINITION (str) – Point d’entrée pour les définitions de séries temporelles.
TIME_SERIE_DEFINITION (str) – Point d’entrée pour une définition de série temporelle.
GNSS_STATION (Optional[str]) – Point d’entrée pour une station GNSS.
GNSS_STATIONS (Optional[str]) – Point d’entrée pour les stations GNSS.
GNSS_SUM (Optional[str]) – Point d’entrée pour le sommaire des données GNSS.
REGIONS (Optional[str]) – Point d’entrée pour les régions.
STATION_DATA_LATEST (Optional[str]) – Point d’entrée pour les dernières données d’une station.
STATION_TIME_SERIES (Optional[str]) – Point d’entrée pour les séries temporelles d’une station.
STATION_STATS_DAILY (Optional[str]) – Point d’entrée pour les statistiques journalières d’une station.
STATION_STATS_MONTHLY (Optional[str]) – Point d’entrée pour les statistiques mensuelles d’une station.

API: str

BENCHMARK: str

BENCHMARKS: str

BENCHMARK_METADATA: str

ELEVVATIONS: str

GNSS_STATION: str | None

GNSS_STATIONS: str | None

GNSS_SUM: str | None

HEIGHT_TYPE: str

HEIGHT_TYPES: str

PHENOMENA: str

PHENOMENON: str

REGIONS: str | None

STATION: str

STATIONS: str

STATION_DATA: str

STATION_DATA_LATEST: str | None

STATION_METADATA: str

STATION_STATS_DAILY: str | None

STATION_STATS_MONTHLY: str | None

STATION_TIME_SERIES: str | None

TIDE_TABLE: str

TIDE_TABLES: str

TIME_SERIES_DEFINITION: str

TIME_SERIE_DEFINITION: str

TYPE: EndpointType

class iwls_api_request.EndpointPrivateDev(API='', TYPE=EndpointType.PRIVATE_DEV, BENCHMARK='benchmarks/{benchmarkId}', BENCHMARKS='benchmarks/', BENCHMARK_METADATA='benchmarks/{benchmarkId}/metadata', ELEVVATIONS='benchmarks/{benchmarkId}/elevations', HEIGHT_TYPE='heights/{heightTypeId}', HEIGHT_TYPES='heights/', PHENOMENA='phenomena/', PHENOMENON='phenomena/{phenomenonId}', STATION='stations/{stationId}', STATIONS='stations/', STATION_DATA='stations/{stationId}/time-series/{tsId}/data', STATION_METADATA='stations/{stationId}/metadata', TIDE_TABLE='tideTables/{tideTableId}', TIDE_TABLES='tideTables/', TIME_SERIES_DEFINITION='time-series-definitions/', TIME_SERIE_DEFINITION='time-series-definitions/{id}', GNSS_STATION='stations/{stationId}/gnss/{gnssId}', GNSS_STATIONS='stations/{stationId}/gnss', GNSS_SUM='stations/{stationId}/gnss/{gnssId}/sum', REGIONS='chsRegions/', STATION_DATA_LATEST=None, STATION_TIME_SERIES='stations/{stationId}/time-series/', STATION_STATS_DAILY=None, STATION_STATS_MONTHLY=None)[source]

Bases : EndpointPrivate

Classe pour les points d’entrés de l’API privée de développement.

class iwls_api_request.EndpointPrivateProd(API='', TYPE=EndpointType.PRIVATE_PROD, BENCHMARK='benchmarks/{benchmarkId}', BENCHMARKS='benchmarks/', BENCHMARK_METADATA='benchmarks/{benchmarkId}/metadata', ELEVVATIONS='benchmarks/{benchmarkId}/elevations', HEIGHT_TYPE='heights/{heightTypeId}', HEIGHT_TYPES='heights/', PHENOMENA='phenomena/', PHENOMENON='phenomena/{phenomenonId}', STATION='stations/{stationId}', STATIONS='stations/', STATION_DATA='stations/{stationId}/time-series/{tsId}/data', STATION_METADATA='stations/{stationId}/metadata', TIDE_TABLE='tideTables/{tideTableId}', TIDE_TABLES='tideTables/', TIME_SERIES_DEFINITION='time-series-definitions/', TIME_SERIE_DEFINITION='time-series-definitions/{id}', GNSS_STATION='stations/{stationId}/gnss/{gnssId}', GNSS_STATIONS='stations/{stationId}/gnss', GNSS_SUM='stations/{stationId}/gnss/{gnssId}/sum', REGIONS='chsRegions/', STATION_DATA_LATEST=None, STATION_TIME_SERIES='stations/{stationId}/time-series/', STATION_STATS_DAILY=None, STATION_STATS_MONTHLY=None)[source]

Bases : EndpointPrivate

Classe pour les points d’entrés de l’API privée de production.

class iwls_api_request.EndpointPublic(API='https://api-iwls.dfo-mpo.gc.ca/api/v1/', TYPE=EndpointType.PUBLIC, BENCHMARK='benchmarks/{benchmarkId}', BENCHMARKS='benchmarks', BENCHMARK_METADATA='benchmarks/{benchmarkId}/metadata', ELEVVATIONS='benchmarks/{benchmarkId}/elevations', HEIGHT_TYPE='height-types/{heightTypeId}', HEIGHT_TYPES='height-types', PHENOMENA='phenomena', PHENOMENON='phenomena/{phenomenonId}', STATION='stations/{stationId}', STATIONS='stations', STATION_DATA='stations/{stationId}/data', STATION_METADATA='stations/{stationId}/metadata', TIDE_TABLE='tide-tables/{tideTableId}', TIDE_TABLES='tide-tables', TIME_SERIES_DEFINITION='time-series-definitions/', TIME_SERIE_DEFINITION='time-series-definitions/{timeSeriesDefinitionId}', GNSS_STATION=None, GNSS_STATIONS=None, GNSS_SUM=None, REGIONS=None, STATION_DATA_LATEST='stations/data/latest', STATION_TIME_SERIES=None, STATION_STATS_DAILY='stations/{stationId}/stats/calculate-daily-means', STATION_STATS_MONTHLY='stations/{stationId}/stats/calculate-monthly-mean')[source]

Bases : Endpoint

Classe pour les points d’entrés de l’API publique.

class iwls_api_request.EndpointType(value)[source]

Bases : StrEnum

classmethod from_str(value)[source]

PRIVATE_DEV = 'EndpointPrivateDev'

PRIVATE_PROD = 'EndpointPrivateProd'

PUBLIC = 'EndpointPublic'

class iwls_api_request.EnvironmentType(value)[source]

Bases : StrEnum

DEV = 'dev'

PROD = 'prod'

PUBLIC = 'public'

class iwls_api_request.HandlerType(value)[source]

Bases : StrEnum

RATE_LIMITER = 'rate_limiter'

REQUESTS = 'request'

class iwls_api_request.IWLSapiABC(query_handler, endpoint)[source]

Bases : ABC

static _aggregate_data(futures, time_serie_code, station)[source]

Méthode permettant d’agréger les données de plusieurs requêtes.

Paramètres:

futures (Collection) – (Collection) Une liste de futures contenant les données.
time_serie_code (str) – (str) Le code de la série temporelle.
station (str) – (str) L’identifiant de la station.

Type renvoyé:

tuple[list[dict], list[str]]

Renvoie:

(tuple) Une liste de données agrégées et une liste d’erreurs.

static _validate_coordinates(latitude, longitude)[source]

Méthode permettant de valider la latitude et la longitude.

Paramètres:

latitude (float | int) – (Union[float, int]) La latitude de la station.
longitude (float | int) – (Union[float, int]) La longitude de la station.

Type renvoyé:

tuple[float | int, float | int]

Renvoie:

(Tuple[Union[float, int], Union[float, int]]) La latitude et la longitude validées.

Raise:

TypeError si les coordonnées sont du mauvais type.

Raise:

CoordinatesError si les coordonnées sont invalides.

static _validate_iso_date(date)[source]

Méthode permettant de valider le format de la date.

Paramètres:: date (str) – (str) La date en format ISO 8601 UTC (ex: 2021-02-13T19:18:00Z).
Type renvoyé:: str
Renvoie:: (str) La date si est elle valide.
Raise:: ValueError si la date est invalide.

_construct_url(endpoint, **kwargs)[source]

Méthode permettant de construire l’url de la requête.

Paramètres:: endpoint (str) – (str) Un point d’entré pour la requête.
Type renvoyé:: str
Renvoie:: (str) L’url de la requête.

_fetch_and_aggregate_data(function, interval, time_serie_code, station, datetime_sorted=True)[source]

Méthode permettant de récupérer et d’agréger les données de plusieurs requêtes.

Paramètres:

function (Callable) – (Callable) La fonction à exécuter.
interval (Generator[tuple[str, str], None, None]) – (Generator) Un générateur contenant les intervalles de temps.
time_serie_code (str) – (str) Le code de la série temporelle.
station (str) – (str) L’identifiant de la station.
datetime_sorted (bool) – (bool) Si les données doivent être triées par date.

Type renvoyé:

Response

Renvoie:

(Response) Un objet Response contenant les données agrégées.

_validate_query_parameters(**kwargs)[source]

Méthode permettant de valider les paramètres de la requête.

Type renvoyé:: dict[str, str]
Renvoie:: (dict[str, str]) Un dictionnaire contenant les paramètres valides.

_validate_station_id(station_id)[source]

Méthode permettant de valider l’identifiant d’une station”.

Paramètres:: station_id (str) – (str) L’identifiant d’une station.
Type renvoyé:: str
Renvoie:: (str) L’identifiant si il est valide.
Raise:: ValueError si l’identifiant est invalide.

abstractmethod get_all_stations(code=None, chs_region_code=None, time_serie_code=None)[source]

Méthode permettant de récupérer une liste de stations ainsi que les informations les concernant.

Paramètres:

code (Optional[str]) – (str) Le code d’une station. Écrase les autres paramètres.
chs_region_code (Optional[Regions]) – (Regions) Le code d’une région (PAC, CNA, ATL, QUE).
time_serie_code (Optional[TimeSeries]) – (TimeSeries) Le code de la série temporelle désirée. wlo : Official quality controlled water level observation wlp: Water level prediction for the next years wlp-hilo: Tide tables prediction for the next years wlp-bores : Bores arrival and intensity wcp-slack : Reversing falls wlf : Water level forecast for the next 48 hours wlf-spine dvcf-spine : Dynamic vertical clearance forecast under infrastructure like bridges

Type renvoyé:

Response

Renvoie:

(Response) Un objet Response contenant les stations ainsi que les informations les concernant.

abstractmethod get_benchmark(benchmark_id)[source]

Méthode permettant de récupérer un repère.

Paramètres:: benchmark_id (str) – (str) L’identifiant du repère.
Type renvoyé:: Response
Renvoie:: (Response) Un objet Response contenant les informations sur le repère.

abstractmethod get_benchmark_metadata(benchmark_id)[source]

Méthode permettant de récupérer les métadonnées d’un repère.

Paramètres:: benchmark_id (str) – (str) L’identifiant du repère.
Type renvoyé:: Response
Renvoie:: (Response) Un objet Response contenant les métadonnées sur le repère.

abstractmethod get_benchmarks(station_ids=None, **kwargs)[source]

Méthode permettant de récupérer les repères des stations.

Paramètres:: station_ids (Collection[str]) – (Collection[str]) Une liste contenant les identifiants des stations.
Type renvoyé:: Response
Renvoie:: (Response) Un objet Response contenant les informations sur les repères.

get_closest_station(stations_list, latitude, longitude)[source]

Méthode permettant de récupérer la station la plus près des coordonnées géographiques.

Paramètres:

stations_list (Collection[dict]) – (Collection[dict]) Une liste des stations.
latitude (float | int) – (Union[float, int]) La latitude en format degré décimal.
longitude (float | int) – (Union[float, int]) La longitude en format degré décimal.

Type renvoyé:

dict[str, Any]

Renvoie:

(dict[str, Any]) Les informations de la station la plus près des coordonnées géographiques.

abstractmethod get_elevations(benchmark_id)[source]

Méthode permettant de récupérer les métadonnées d’un repère.

Paramètres:: benchmark_id (str) – (str) L’identifiant du repère.
Type renvoyé:: Response
Renvoie:: (Response) Un objet Response contenant les métadonnées sur le repère.

get_elevations_for_benchmarks(benchmarks_ids=None)[source]

Méthode permettant de récupérer les élévations concernant une liste de repères.

Paramètres:: benchmarks_ids (Sequence[str]) – (Sequence[str]) Une liste contenant les benchmarks.
Type renvoyé:: dict[str, Response]
Renvoie:: (dict[str, Response]) Un objet Response contenant les élévations des repères.

abstractmethod get_height(height)[source]

Méthode permettant de récupérer un type de hauteur.

Paramètres:: height (str) – (str) L’identifiant de la hauteur.
Type renvoyé:: Response
Renvoie:: (Response) Un objet Response contenant les informations concernant ce type de hauteur.

abstractmethod get_height_types()[source]

Méthode permettant de récupérer les types de hauteur.

Type renvoyé:: Response
Renvoie:: (Response) Un objet Response contenant les différents types de hauteur.

abstractmethod get_info_station(station)[source]

Méthode permettant de récupérer les informations concernant une station.

Paramètres:: station (str) – (str) L’identifiant de la station.
Type renvoyé:: Response
Renvoie:: (Response) Un objet Response contenant les informations de la station.

get_metadata_for_benchmarks(benchmarks_ids=None)[source]

Méthode permettant de récupérer les métadonnées concernant une liste de repères.

Paramètres:: benchmarks_ids (Sequence[str]) – (Sequence[str]) Une liste contenant les benchmarks.
Type renvoyé:: dict[str, Response]
Renvoie:: (dict[str, Response]) Un objet Response contenant les métadonnées des repères.

abstractmethod get_metadata_station(station)[source]

Méthode permettant de récupérer les métadonnées concernant une station.

Paramètres:: station (str) – (str) Le stationId de la station.
Type renvoyé:: Response
Renvoie:: (Response) Un objet Response contenant les métadonnées de la station.

get_metadata_stations(stations)[source]

Méthode permettant de récupérer les métadonnées concernant une liste de stations.

Paramètres:: stations (Sequence[str]) – (Sequence[str]) Une liste contenant le stationId des station.
Type renvoyé:: dict[str, Response]
Renvoie:: (dict[str, Response]) Un objet Response contenant les métadonnées des stations.

abstractmethod get_phenomena()[source]

Méthode permettant de récupérer les phénomènes.

Type renvoyé:: Response
Renvoie:: (Response) Un objet Response contenant les différents phénomènes.

abstractmethod get_phenomenon(phenomenon)[source]

Méthode permettant de récupérer les informations d’un phénomène.

Type renvoyé:: Response
Renvoie:: (Response) Un objet Response contenant les informations concernant un phénomène.

abstractmethod get_station_daily_mean(station, from_time, to_time, **kwargs)[source]

Méthode permettant d’obtenir les moyennes journalières pour une station.

Paramètres:

station (str) – (str) Le stationId de la station.
from_time (str) – (str) La date de début en format (ex: 2019-11-13).
to_time (str) – (str) La date de fin en format (ex: 2019-11-13).

Type renvoyé:

Response

Renvoie:

(Response) Un objet Response contenant les moyenne journalières de la station.

abstractmethod get_station_montly_mean(station, year, month, **kwargs)[source]

Méthode permettant d’obtenir la moyenne mensuelle pour une station.

Paramètres:

station (str) – (str) Le stationId de la station.
year (str) – (str) L’année désirée.
month (str) – (str) Le mois désiré.

Type renvoyé:

Response

Renvoie:

(Response) La moyenne mensuelle de la station.

abstractmethod get_tide_table(tide_table)[source]

Méthode permettant de recupérer une table de marées.

Paramètres:: tide_table (str) – (str) L’identifiant d’une table de marées.
Type renvoyé:: Response
Renvoie:: (Response) Un objet Response contenant les informations d’une table de marées.

abstractmethod get_tide_tables(type_table=None, parent_tide_table=None)[source]

Méthode permettant de recupérer la liste des tables de marées.

Paramètres:

type_table (TypeTideTable) – (TypeTideTable) Un type de table. {VOLUME, AREA, SUB_AREA}
parent_tide_table (str) – (str) L’identifiant d’une table.

Type renvoyé:

Response

Renvoie:

(Response) Un objet Response contenant l’ensemble des tables de marées correspondant aux critères de la recherche.

get_time_serie_block_data(station, from_time, to_time, time_serie_code=TimeSeries.WLO, time_delta=datetime.timedelta(days=7), datetime_sorted=True, **kwargs)[source]

Méthode permttant de récupérer des données à partir de l’API de iWLS.

/api/v1/stations/{stationId}/data

Paramètres:

station (str) – (str) Le stationId de la station.
time_serie_code (Optional[TimeSeries]) – (TimeSeries) Le code de la série temporelle désirée. wlo : Official quality controlled water level observation wlp: Water level prediction for the next years wlp-hilo: Tide tables prediction for the next years wlp-bores : Bores arrival and intensity wcp-slack : Reversing falls wlf : Water level forecast for the next 48 hours wlf-spine dvcf-spine : Dynamic vertical clearance forecast under infrastructure like bridges
from_time (str) – (str) La date de début en format ISO 8601 (ex: 2019-11-13T19:18:00Z).
to_time (str) – (str) La date de fin en format ISO 8601 (ex: 2019-11-13T19:18:00Z).
time_delta (timedelta) – (timedelta) L’intervalle de temps maximale pour chaque requête.
datetime_sorted (bool) – (bool) Si les données doivent être triées par date.

Type renvoyé:

Response

Renvoie:

(Response) Un objet Response contenant les données reçues de l’API de iWLS.

abstractmethod get_time_serie_data(station, from_time, to_time, time_serie_code=TimeSeries.WLO, **kwargs)[source]

Méthode permttant de récupérer des données à partir de l’API de iWLS.

Paramètres:

station (str) – (str) Le stationId de la station.
time_serie_code (Optional[TimeSeries]) – (TimeSerie) Le code de la série temporelle désirée. wlo : Official quality controlled water level observation wlp: Water level prediction for the next years wlp-hilo: Tide tables prediction for the next years wlp-bores : Bores arrival and intensity wcp-slack : Reversing falls wlf : Water level forecast for the next 48 hours wlf-spine dvcf-spine : Dynamic vertical clearance forecast under infrastructure like bridges …
from_time (str) – (str) La date de début en format ISO 8601 (ex: 2019-11-13T19:18:00Z).
to_time (str) – (str) La date de fin en format ISO 8601 (ex: 2019-11-13T19:18:00Z).

Type renvoyé:

Response

Renvoie:

(Response) Un objet Response contenant les données de la série temporelle.

abstractmethod get_time_serie_definition(time_serie_definition_id)[source]

Méthode permettant de récupérer la définition d’une série temporelle.

Paramètres:: time_serie_definition_id (str) – (str) L’identifiant de la série temporelle.
Type renvoyé:: Response
Renvoie:: (Response) Un objet Response contenant la définition de la série temporelle.

get_time_series_data(time_series, station, from_time, to_time, time_delta=datetime.timedelta(days=7), datetime_sorted=True)[source]

Méthode permettant de récupérer plusieurs série temporelle pour une station sur l’API de iWLS.

Paramètres:

time_series (Sequence[TimeSeries]) – (Sequence[TimeSeries]) La liste des codes des times série.
station (str) – (str) Le code de la station.
from_time (str) – (str) La date de début en format ISO 8601 UTC (ex: 2021-02-13T19:18:00Z).
to_time (str) – (str) La date de fin en format ISO 8601 UTC (ex: 2021-02-13T19:18:00Z).
time_delta (timedelta) – (timedelta) L’intervalle de temps maximale pour chaque requête.
datetime_sorted (bool) – (bool) Si les données doivent être triées par date.

Type renvoyé:

dict[TimeSeries, Response]

Renvoie:

dict[TimeSeries, Response] Les résultats de la requête.

abstractmethod get_time_series_definitions(time_serie=None)[source]

Méthode permettant de récupérer les définitions des séries temporelles.

Paramètres:: time_serie (Optional[TimeSeries]) – (TimeSeries) Le code de la série temporelle.
Type renvoyé:: Response
Renvoie:: (Response) Un objet Response contenant les définitions des séries temporelles.

_cache

_query_handler

property _stations: list

endpoint

property stations_dict: dict

property stations_list: list

class iwls_api_request.IWLSapiPrivate(query_handler, endpoint=<class 'iwls_api_request.api.endpoint.endpoint_private.EndpointPrivateProd'>)[source]

Bases : IWLSapiABC

static _filter_station_by_code(stations, code)[source]

Méthode permettant de filtrer les stations selon leur code.

Paramètres:

stations (Collection[dict]) – (Collection[dict]) Une liste de stations à filtrer.
code (str) – (str) Le code d’une station.

Type renvoyé:

list[dict]

Renvoie:

(list[dict]) Une liste contenant les stations filtrées.

static _filter_tables_by_parent(tables_list, parent_tide_table=None)[source]

Méthode permettant de filtrer les tables marée selon la table parent.

Paramètres:: tables_list (list[dict]) – (list[dict]) Une liste de tables.
Pram p_parent_tide_table:: (Optional[str]) L’identifiant de la table parent.
Type renvoyé:: list[dict]
Renvoie:: (list[dict]) Un liste contenant les tables filtrées selon la table parent.

static _filter_tables_by_type(tables_list, type_table=None)[source]

Méthode permettant de filtrer les tables marée selon leur type.

Paramètres:: tables_list (list[dict]) – (list[dict]) Une liste de tables.
Pram p_type_table:: (Optional[TypeTideTable]) Un type de table.
Type renvoyé:: list[dict]
Renvoie:: (list[dict]) Un liste contenant les tables filtrées selon le type.

_filter_stations_by_region(stations, chs_region_code=None)[source]

Méthode permettant de filtrer les stations selon le code d’une région.

Paramètres:

stations (list[dict]) – (list[dict]) Une liste de stations à filtrer.
chs_region_code (Regions) – (Regions) Le code d’une région (PAC, CNA, ATL, QUE).

Type renvoyé:

list[dict]

Renvoie:

(list[dict]) Une liste contenant les stations filtrées.

_filter_stations_by_ts(stations, time_serie_code=None)[source]

Méthode permettant de filtrer les stations selon le code d’une série temporelle.

Paramètres:

stations (list[dict]) – (list[dict]) Une liste de stations à filtrer.
time_serie_code (TimeSeries) – (TimeSeries) Le code d’une région (PAC, CNA, ATL, QUE).

Type renvoyé:

list[dict]

Renvoie:

(list[dict]) Une liste contenant les stations filtrées.

_get_benchmarks(benchmarks_ids=None, station_ids=None, page=0)[source]

Méthode permettant de récupérer les repères des stations.

/rest/benchmarks/

Paramètres:

benchmarks_ids (Collection[str]) – (Collection[str]) Une liste contenant les identifiants des repères.
station_ids (Collection[str]) – (Collection[str]) Une liste contenant les identifiants des stations.
page (int) – (int) Le numéro de la page de résultat.

Type renvoyé:

Response

Renvoie:

(Response) Un objet Response contenant les informations sur les repères.

get_all_gnss_from_station(station)[source]

Méthode permettant de récupérer la liste des GNSS pour une station.

/rest/stations/{stationId}/gnss

Paramètres:: station (str) – (str) Le stationId de la station.
Type renvoyé:: Response
Renvoie:: (Response) Un objet Response contenant la liste des GNSS pour une station.

get_all_stations(code=None, chs_region_code=None, time_serie_code=None)[source]

Méthode permettant de récupérer une liste de stations ainsi que les informations les concernant.

/rest/stations

Paramètres:

code (Optional[str]) – (str) Le code d’une station. Écrase les autres paramètres.
chs_region_code (Optional[Regions]) – (Regions) Le code d’une région (PAC, CNA, ATL, QUE).
time_serie_code (Optional[TimeSeries]) – (TimeSeries) Le code de la série temporelle désirée. wlo : Official quality controlled water level observation wlp: Water level prediction for the next years wlp-hilo: Tide tables prediction for the next years wlp-bores : Bores arrival and intensity wcp-slack : Reversing falls wlf : Water level forecast for the next 48 hours wlf-spine dvcf-spine : Dynamic vertical clearance forecast under infrastructure like bridges

Type renvoyé:

Response

Renvoie:

(Response) Un objet Response contenant les stations ainsi que les informations les concernant.

get_benchmark(benchmark_id)[source]

Méthode permettant de récupérer un repère.

/rest/benchmarks/{benchmarkId}

Paramètres:: benchmark_id (str) – (str) L’identifiant du repère.
Type renvoyé:: Response
Renvoie:: (Response) Un objet Response contenant les informations sur le repère.

get_benchmark_metadata(benchmark_id)[source]

Méthode permettant de récupérer les métadonnées d’un repère.

/rest/benchmarks/{benchmarkId}/metadata

Paramètres:: benchmark_id (str) – (str) L’identifiant du repère.
Type renvoyé:: Response
Renvoie:: (Response) Un objet Response contenant les métadonnées sur le repère.

get_benchmarks(benchmarks_ids=None, station_ids=None)[source]

Méthode permettant de récupérer les repères des stations pour toutes les pages.

/rest/benchmarks/

Paramètres:

benchmarks_ids (Collection[str]) – (Collection[str]) Une liste contenant les identifiants des repères.
station_ids (Collection[str]) – (Collection[str]) Une liste contenant les identifiants des stations.

Type renvoyé:

Response

Renvoie:

(Response) Un objet Response contenant les informations sur les repères.

get_chs_regions()[source]

Méthode permettant de récupérer les informations concernant les régions.

/rest/chsRegions

Type renvoyé:: Response
Renvoie:: (Response) Un objet Response des régions ainsi que les informations les concernant.

get_elevations(benchmark_id)[source]

Méthode permettant de récupérer les métadonnées d’un repère.

/rest/benchmarks/{benchmarkId}/metadata

Paramètres:: benchmark_id (str) – (str) L’identifiant du repère.
Type renvoyé:: Response
Renvoie:: (Response) Un objet Response contenant les métadonnées sur le repère.

get_gnss_station(station, gnss_id)[source]

Méthode permettant de récupérer les informations d’une station GNSS.

/rest/stations/{stationId}/gnss/{gnssId}

Paramètres:

station (str) – (str) Le stationId de la station.
gnss_id (str) – (str) L’identifiant d’une station GNSS.

Type renvoyé:

Response

Renvoie:

(Response) Un objet Response contenant les informations d’une station GNSS.

get_gnss_station_sum(station, gnss_id)[source]

Méthode permettant de récupérer un fichier .sum d’une station GNSS.

/rest/stations/{stationId}/gnss/{gnssId}/sum

Paramètres:

station (str) – (str) Le stationId de la station.
gnss_id (str) – (str) L’identifiant d’une station GNSS.

Type renvoyé:

Response

Renvoie:

(Response) Un objet Response contenant le sum d’une station.

get_height(height)[source]

Méthode permettant de récupérer un type de hauteur.

/rest/heights/{heightTypeId}

Paramètres:: height (str) – (str) L’identifiant de la hauteur.
Type renvoyé:: Response
Renvoie:: (Response) Un objet Response contenant les informations concernant ce type de hauteur.

get_height_types()[source]

Méthode permettant de récupérer les types de hauteur.

/rest/heights

Type renvoyé:: Response
Renvoie:: (Response) Un objet Response contenant les différents types de hauteur.

get_info_station(station)[source]

Méthode permettant de récupérer les informations concernant une station.

/rest/stations/{stationId}

Paramètres:: station (str) – (str) L’identifiant de la station.
Type renvoyé:: Response
Renvoie:: (Response) Un objet Response contenant les informations de la station.

get_metadata_station(station)[source]

Méthode permettant de récupérer les métadonnées concernant une station.

/rest/stations/{stationId}/metadata

Paramètres:: station (str) – (str) Le stationId de la station.
Type renvoyé:: Response
Renvoie:: (Response) Un objet Response contenant les métadonnées de la station.

get_phenomena()[source]

Méthode permettant de récupérer les phénomènes.

/rest/phenomena

Type renvoyé:: Response
Renvoie:: (Response) Un objet Response contenant les différents phénomènes.

get_phenomenon(phenomenon)[source]

Méthode permettant de récupérer les informations d’un phénomène.

/rest/phenomena/{phenomenonId}

Type renvoyé:: Response
Renvoie:: (Response) Un objet Response contenant les informations concernant un phénomène.

get_station_daily_mean(station, from_time, to_time, **kwargs)[source]

Méthode permettant d’obtenir les moyennes journalières pour une station.

Paramètres:

station (str) – (str) Le stationId de la station.
from_time (str) – (str) La date de début en format (ex: 2019-11-13).
to_time (str) – (str) La date de fin en format (ex: 2019-11-13).

Type renvoyé:

Response

Renvoie:

(Response) Un objet Response contenant les moyenne journalières de la station.

get_station_montly_mean(station, year, month, **kwargs)[source]

Méthode permettant d’obtenir la moyenne mensuelle pour une station.

Paramètres:

station (str) – (str) Le stationId de la station.
year (str) – (str) L’année désirée.
month (str) – (str) Le mois désiré.

Type renvoyé:

Response

Renvoie:

(Response) La moyenne mensuelle de la station.

get_tide_table(tide_table)[source]

Méthode permettant de recupérer une table de marées.

/rest/tideTables/{tideTableId}

Paramètres:: tide_table (str) – (str) L’identifiant d’une table de marées.
Type renvoyé:: Response
Renvoie:: (Response) Un objet Response contenant les informations d’une table de marées.

get_tide_tables(type_table=None, parent_tide_table=None)[source]

Méthode permettant de recupérer la liste des tables de marées.

/rest/tideTables/

Paramètres:

type_table (Optional[TypeTideTable]) – (TypeTideTable) Un type de table. {VOLUME, AREA, SUB_AREA}
parent_tide_table (Optional[str]) – (str) L’identifiant d’une table.

Type renvoyé:

Response

Renvoie:

(Response) Un objet Response contenant l’ensemble des tables de marées correspondant aux critères de la recherche.

get_time_serie_data(station, from_time, to_time, time_serie_code=TimeSeries.WLO, **kwargs)[source]

Méthode permttant de récupérer des données à partir de l’API de iWLS.

/rest/stations/{stationId}/time-series/{tsId}/data

Paramètres:

station (str) – (str) Le stationId de la station.
time_serie_code (Optional[TimeSeries]) – (TimeSerie) Le code de la série temporelle désirée. wlo : Official quality controlled water level observation wlp: Water level prediction for the next years wlp-hilo: Tide tables prediction for the next years wlp-bores : Bores arrival and intensity wcp-slack : Reversing falls wlf : Water level forecast for the next 48 hours wlf-spine dvcf-spine : Dynamic vertical clearance forecast under infrastructure like bridges …
from_time (str) – (str) La date de début en format ISO 8601 (ex: 2019-11-13T19:18:00Z).
to_time (str) – (str) La date de fin en format ISO 8601 (ex: 2019-11-13T19:18:00Z).

Type renvoyé:

Response

Renvoie:

(Response) Un objet Response contenant les données de la série temporelle.

get_time_serie_definition(time_serie_definition_id)[source]

Méthode permettant de récupérer les définitions d’une série temporelle.

/rest/time-series-definitions/{id}

Paramètres:: time_serie_definition_id (str) – (str) L’identifiant d’une série temporelle.
Type renvoyé:: Response
Renvoie:: (Response) Un objet Response contenant les définitions d’une série temporelle.

get_time_serie_id_from_code(station, time_serie_code=TimeSeries.WLO)[source]

Méthode permttant de récupérer la liste des times sereies disponibles pour une station.

Paramètres:

station (str) – (str) Le stationId de la station.
time_serie_code (Optional[TimeSeries]) – (TimeSeries) Le code de la série temporelle désirée.

Type renvoyé:

str

Renvoie:

(str) L’identifiant d’une time serie pour une station.

get_time_series_definitions(time_serie=None)[source]

Méthode permettant de récupérer les définitions des séries temporelles.

/rest/time-series-definitions/

Paramètres:: time_serie (Optional[TimeSeries]) – (TimeSeries) Le code de la série temporelle désirée.
Type renvoyé:: Response
Renvoie:: (Response) Un objet Response contenant les définitions des séries temporelles.

get_time_series_station(station)[source]

Méthode permttant de récupérer la liste des times series disponibles pour une station.

/rest/stations/{stationId}/time-series/

Paramètres:: station (str) – (str) Le stationId de la station.
Type renvoyé:: Response
Renvoie:: (Response) Un objet Response concernant les times series d’une station.

get_time_series_stations(stations=None)[source]

Méthode permettant de récupérer les séries temporelles concernant une liste de stations.

Paramètres:: stations (Sequence[str]) – (Sequence[str]) Une liste contenant les stations.
Type renvoyé:: dict[str, Response]
Renvoie:: (dict[str, Response]) Un objet Response contenant les séries temporelles des stations.

_cache

_query_handler

endpoint

class iwls_api_request.IWLSapiPublic(query_handler, endpoint=<class 'iwls_api_request.api.endpoint.endpoint_public.EndpointPublic'>)[source]

Bases : IWLSapiABC

static _aggregate_benchmarks(futures)[source]

Méthode permettant d’agréger les données des repères des stations.

Paramètres:: futures (Collection) – (Collection) Une collection de futures.
Type renvoyé:: tuple[list[dict], list[str]]
Renvoie:: (tuple) Une liste contenant les données agrégées et une liste contenant les erreurs.

_fetch_and_aggregate_benchmarks(function, station_ids)[source]

Méthode permettant de récupérer et d’agréger les données des repères des stations.

Paramètres:

function (Callable) – (Callable) Une fonction permettant de récupérer les données des repères.
station_ids (Collection[str]) – (Collection[str]) Une liste contenant les identifiants des stations.

Type renvoyé:

Response

Renvoie:

(Response) Un objet Response contenant les informations sur les repères.

_get_benchmarks(station_id=None)[source]

Méthode permettant de récupérer les repères d’une station.

/api/v1/benchmarks

Paramètres:: station_id (Optional[str]) – (str) L’identifiant d’une station.
Type renvoyé:: Response
Renvoie:: (Response) Un objet Response contenant les informations sur les repères.

get_all_stations(code=None, chs_region_code=None, time_serie_code=None)[source]

Méthode permettant de récupérer une liste de stations ainsi que les informations les concernant.

/api/v1/stations

Paramètres:

code (Optional[str]) – (str) Le code d’une station. Écrase les autres paramètres.
chs_region_code (Optional[Regions]) – (Regions) Le code d’une région (PAC, CNA, ATL, QUE).
time_serie_code (Optional[TimeSeries]) – (TimeSeries) Le code de la série temporelle désirée. wlo : Official quality controlled water level observation wlp: Water level prediction for the next years wlp-hilo: Tide tables prediction for the next years wlp-bores : Bores arrival and intensity wcp-slack : Reversing falls wlf : Water level forecast for the next 48 hours wlf-spine dvcf-spine : Dynamic vertical clearance forecast under infrastructure like bridges

Type renvoyé:

Response

Renvoie:

(Response) Un objet Response contenant les stations ainsi que les informations les concernant

get_benchmark(benchmark_id)[source]

Méthode permettant de récupérer les informations d’un repère.

/api/v1/benchmarks/{benchmarkId}

Paramètres:: benchmark_id (str) – (str) L’identifiant du repère.
Type renvoyé:: Response
Renvoie:: (Response) Un objet Response contenant les informations du repère.

get_benchmark_metadata(benchmark_id)[source]

Méthode permettant de récupérer les métadonnées d’un repère.

/api/v1/benchmarks/{benchmarkId}/metadata

Paramètres:: benchmark_id (str) – (str) L’identifiant du repère.
Type renvoyé:: Response
Renvoie:: (Response) Un objet Response contenant les métadonnées du repère.

get_benchmarks(station_ids=None, **kwargs)[source]

Méthode permettant de récupérer les repères des stations.

/api/v1/benchmarks

Paramètres:: station_ids (Collection[str]) – (Collection[str]) Une liste contenant les identifiants des stations.
Type renvoyé:: Response
Renvoie:: (Response) Un objet Response contenant les informations sur les repères.

get_elevations(benchmark_id)[source]

Méthode permettant de récupérer les métadonnées d’un repère.

/api/v1/benchmarks/{benchmarkId}/elevations

Paramètres:: benchmark_id (str) – (str) L’identifiant du repère.
Type renvoyé:: Response
Renvoie:: (Response) Un objet Response contenant les métadonnées sur le repère.

get_height(height)[source]

Méthode permettant de récupérer un type de hauteur.

/api/v1/height-types/{heightTypeId}

Paramètres:: height (str) – (str) L’identifiant de la hauteur.
Type renvoyé:: Response
Renvoie:: (Response) Un objet Response contenant les informations concernant ce type de hauteur.

get_height_types()[source]

Méthode permettant de récupérer les types de hauteur.

/api/v1/height-types

Type renvoyé:: Response
Renvoie:: (Response) Un objet Response contenant les différents types de hauteur.

get_info_station(station)[source]

Méthode permettant de récupérer les informations concernant une station.

/api/v1/stations/{stationId}

Paramètres:: station (str) – (str) L’identifiant de la station.
Type renvoyé:: Response
Renvoie:: (Response) Un objet Response contenant les informations de la station.

get_metadata_station(station)[source]

Méthode permettant de récupérer les métadonnées concernant une station.

/api/v1/stations/{stationId}/metadata

Paramètres:: station (str) – (str) Le stationId de la station.
Type renvoyé:: Response
Renvoie:: (Response) Un objet Response contenant les métadonnées de la station.

get_phenomena()[source]

Méthode permettant de récupérer les phénomènes.

/api/v1/phenomena

Type renvoyé:: Response
Renvoie:: (Response) Un objet Response contenant les différents phénomènes.

get_phenomenon(phenomenon)[source]

Méthode permettant de récupérer les informations d’un phénomène.

/api/v1/phenomena/{phenomenonId}

Type renvoyé:: Response
Renvoie:: (Response) Un objet Response contenant les informations concernant un phénomène.

get_station_daily_mean(station, from_time, to_time, time_zone=TimeZone.UTC)[source]

Méthode permettant d’obtenir les moyennes journalières pour une station.

/api/v1/stations/{stationId}/stats/calculate-daily-means

Paramètres:

station (str) – (str) Le stationId de la station.
from_time (str) – (str) La date de début en format (ex: 2019-11-13).
to_time (str) – (str) La date de fin en format (ex: 2019-11-13).
time_zone (Optional[TimeZone]) – (TimeZone) Le fuseau horaire désiré.

Type renvoyé:

Response

Renvoie:

(Response) Un objet Response contenant les moyenne journalières de la station.

get_station_montly_mean(station, year, month, time_zone=TimeZone.UTC)[source]

Méthode permettant d’obtenir la moyenne mensuelle pour une station.

/api/v1/stations/{stationId}/stats/calculate-monthly-mean

Paramètres:

station (str) – (str) Le stationId de la station.
year (str) – (str) L’année désirée.
month (str) – (str) Le mois désiré.
time_zone (Optional[TimeZone]) – (TimeZone) Le fuseau horaire désiré.

Type renvoyé:

Response

Renvoie:

(Response) Un objet Response contenant la moyenne mensuelle de la station.

get_tide_table(tide_table)[source]

Méthode permettant de recupérer une table de marées.

/api/v1/tide-tables/{tideTableId}

Paramètres:: tide_table (str) – (str) L’identifiant d’une table de marées.
Type renvoyé:: Response
Renvoie:: (Response) Un objet Response contenant les informations d’une table de marées.

get_tide_tables(type_table=None, parent_tide_table=None)[source]

Méthode permettant de recupérer la liste des tables de marées.

/api/v1/tide-tables

Paramètres:

type_table (Optional[TypeTideTable]) – (TypeTideTable) Un type de table. {VOLUME, AREA, SUB_AREA}
parent_tide_table (Optional[str]) – (str) L’identifiant d’une table.

Type renvoyé:

Response

Renvoie:

(Response) Un objet Response contenant l’ensemble des tables de marées correspondant aux critères de la recherche.

get_time_serie_data(station, from_time, to_time, time_serie_code=TimeSeries.WLO, time_resolution=TimeResolution.ONE_MINUTE)[source]

Méthode permttant de récupérer des données à partir de l’API de iWLS.

/api/v1/stations/{stationId}/data

Paramètres:

station (str) – (str) Le stationId de la station.
time_serie_code (Optional[TimeSeries]) – (TimeSeries) Le code de la série temporelle désirée. wlo : Official quality controlled water level observation wlp: Water level prediction for the next years wlp-hilo: Tide tables prediction for the next years wlp-bores : Bores arrival and intensity wcp-slack : Reversing falls wlf : Water level forecast for the next 48 hours wlf-spine dvcf-spine : Dynamic vertical clearance forecast under infrastructure like bridges
from_time (str) – (str) La date de début en format ISO 8601 (ex: 2019-11-13T19:18:00Z).
to_time (str) – (str) La date de fin en format ISO 8601 (ex: 2019-11-13T19:18:00Z). La durée maximale est de 7 jours pour la majorité des TimeSeries.
time_resolution (Optional[TimeResolution]) – (TimeResolution) La résolution temporelle désirée.

Type renvoyé:

Response

Renvoie:

(Response) Un objet Response contenant les données reçues de l’API de iWLS.

get_time_serie_definition(time_serie_definition_id)[source]

Méthode permettant de récupérer la définition d’une série temporelle.

/api/v1/time-series-definitions/{timeSeriesDefinitionId}

Paramètres:: time_serie_definition_id (str) – (str) L’identifiant de la série temporelle.
Type renvoyé:: Response
Renvoie:: (Response) Un objet Response contenant la définition de la série temporelle.

get_time_series_definitions(time_serie=None)[source]

Méthode permettant de récupérer les définitions des séries temporelles.

/api/v1/time-series-definitions

Paramètres:: time_serie (Optional[TimeSeries]) – (TimeSeries) Le code de la série temporelle désirée.
Type renvoyé:: Response
Renvoie:: (Response) Un objet Response contenant les définitions des séries temporelles.

get_wlo_latest_data()[source]

Méthode permettant de récupérer les 20 dernières minutes de données de la série temporelle WLO pour toutes les stations.

/api/v1/stations/data/latest

Type renvoyé:: Response
Renvoie:: (Response) Un objet Response contenant les 20 dernières minutes de données de la série temporelle WLO.

_cache

_query_handler

endpoint

class iwls_api_request.Regions(value)[source]

Bases : StrEnum

static get_values()[source]

Type renvoyé:: list[str]

ATL = 'ATL'

CNA = 'CNA'

PAC = 'PAC'

QUE = 'QUE'

class iwls_api_request.Response(status_code=200, data=None, message=None, error=None)[source]

Bases : object

data: dict | list | str = None

error: str | list = None

property is_ok: bool

message: str = None

status_code: int = 200

class iwls_api_request.RetryAdapterConfig(max_retry=5, backoff_factor=2, status_code=(429, 500, 502, 503, 504))[source]

Bases : object

backoff_factor: int | None = 2

max_retry: int | None = 5

status_code: Collection[int] | None = (429, 500, 502, 503, 504)

class iwls_api_request.SessionType(value)[source]

Bases : StrEnum

CACHE: str = 'cache'

REQUESTS: str = 'requests'

class iwls_api_request.TimeResolution(value)[source]

Bases : StrEnum

FIFTEEN_MINUTES = 'FIFTEEN_MINUTES'

FIVE_MINUTES = 'FIVE_MINUTES'

ONE_MINUTE = 'ONE_MINUTE'

SIXTY_MINUTES = 'SIXTY_MINUTES'

THREE_MINUTES = 'THREE_MINUTES'

class iwls_api_request.TimeSeries(value)[source]

Bases : StrEnum

classmethod from_str(value)[source]

static get_values()[source]

Type renvoyé:: list[str]

AP1 = 'ap1'

AP2 = 'ap2'

DVCF = 'dvcf'

DVCF_SPINE1 = 'dvcf-spine1'

V1 = 'v1'

V2 = 'v2'

WCDP = 'wcdp'

WCDP_EXTREMA = 'wcdp-extrema'

WCP_SLACK = 'wcp-slack'

WCSP = 'wcsp'

WCSP_EXTREMA = 'wcsp-extrema'

WL1 = 'wl1'

WL2 = 'wl2'

WL3 = 'wl3'

WLF = 'wlf'

WLF_SPINE = 'wlf-spine'

WLF_VTG = 'wlf-vtg'

WLO = 'wlo'

WLP = 'wlp'

WLP_BORES = 'wlp-bores'

WLP_HILO = 'wlp-hilo'

WS1 = 'ws1'

WS2 = 'ws2'

WT1 = 'wt1'

WT2 = 'wt2'

WT3 = 'wt3'

class iwls_api_request.TimeZone(value)[source]

Bases : StrEnum

LOCAL = 'LOCAL'

UTC = 'UTC'

class iwls_api_request.TypeTideTable(value)[source]

Bases : StrEnum

AREA = 'AREA'

SUB_AREA = 'SUB_AREA'

VOLUME = 'VOLUME'

iwls_api_request.get_environment_config(api_config_dict)[source]

Retournes les configurations des environnements de l’API IWLS

Paramètres:: api_config_dict (IWLSapiDict) – La configuration de l’API IWLS.
Renvoie:: Les configurations des environnements de l’API IWLS.
Type renvoyé:: dict[str, APIEnvironment]

iwls_api_request.get_iwls_api(endpoint, handler_type=HandlerType.RATE_LIMITER, calls=10, period=1, session_type_config=SessionType.REQUESTS, retry_adapter_config=True)[source]

Fonction qui retourne l’API IWLS.

Paramètres:

endpoint (Endpoint) – (Endpoint) L’endpoint de l’API IWLS.
handler_type (Optional[HandlerType]) – (HandlerType) Le type de gestionnaire de requêtes.
calls (Optional[int]) – (int) Le nombre de requêtes autorisées (nécessaire pour “HandlerType.RATE_LIMITER).
period (Optional[int]) – (int) La période de temps pour les requêtes autorisées (nécessaire pour HandlerType.RATE_LIMITER).
session_type_config (Union[SessionType, CachedSessionConfig, None]) – (SessionType) Le type de session ou la configuration pour la cache. Si une configuration est fourni, le session_type est alors automatiquement SessionType.CACHE.
retry_adapter_config (Union[RetryAdapterConfig, bool, None]) – (RetryAdapterConfig | bool) La configuration pour l’adaptateur de réessai ou un booléen. Si True, une configuration par défaut est utilisé, si False, aucun adaptateur est utilisé.

Type renvoyé:

IWLSapiABC | IWLSapiPrivate | IWLSapiPublic

Renvoie:

(IWLSapi) L’API IWLS.

iwls_api_request.load_config(config_file=PosixPath('/home/docs/checkouts/readthedocs.org/user_builds/chs-csb-processing/checkouts/stable/config/config_API.toml'))[source]

Retournes la configuration de l’API IWLS

Paramètres:: config_file (Path) – Le fichier de configuration.
Renvoie:: La configuration de l’API IWLS.
Type renvoyé:: IWLSapiDict