pyspc.webservice.phyc.phyc.PHyC

class pyspc.webservice.phyc.phyc.PHyC(hostname=None, username='', password='', proxies=None, warning=False)[source]

Bases : Check, Get, Request, Session

Structure du client SOAP accédant aux données de la PHyC

hostname

Hôte du webservice

Type:: str

proxies

Dictionnaire des proxys {“protocol”: “proxy”}

Type:: None, dict

username

Identifiant du contact

Type:: str

password

Mot de passe du contact

Type:: str

client

Client de connexion à la PHyC

Type:: suds.client.Client

session

Identifiant de la session PHyC

Type:: None, str

__init__(hostname=None, username='', password='', proxies=None, warning=False)[source]

Initialisation de l’instance du webservice PHyC.

Initialisation du client SOAP

Paramètres:

hostname (str) – Hôte du webservice
proxies (None, dict) – Dictionnaire des proxys {“protocol”: “proxy”}
username (str) – Identifiant du contact
password (str) – Mot de passe du contact
warning (bool) – Afficher les avertissements (proxy)

Methods

`__init__`([hostname, username, password, ...])	Initialisation de l'instance du webservice PHyC.
`check_client`()	Contrôler si le client SUDS existe.
`check_dtype`(dtype)	Contrôler s'il s'agit bien d'un export autorisé.
`check_session`()	Contrôler si la session SOAP existe.
`check_tstep`(tstep)	Contrôler s'il s'agit bien d'un pas de temps en minutes entières.
`check_varname`(varname)	Contrôler la grandeur.
`get`([datatype, codes, varname, timestep, ...])	Récupération de données/informations contenues dans la PHyC.
`get_data_fcst_hydro`([codes, varname, ...])	Récupération des prévisions PHyC.
`get_data_obs_hydro`([codes, varname, ...])	Récupération des observations hydrométriques en PHyC.
`get_data_obs_meteo`([codes, varname, ...])	Récupération des observations météorologiques en PHyC.
`get_datatypes`()	Renvoyer la liste des types de données PHyC.
`get_flowmes`([codes, first_dtime, last_dtime])	Récupérer les jaugeages de la PHyC.
`get_levelcor`([codes, first_dtime, last_dtime])	Récupérer les courbes de correction de la PHyC.
`get_loc_hydro`([codes, child])	Récupérer les sites/stations hydro connus dans la PHyC.
`get_loc_meteo`([codes])	Récupérer les sites météo connus dans la PHyC.
`get_ratingcurve`([codes, first_dtime, last_dtime])	Récupérer les courbes de tarage de la PHyC.
`get_user`([codes])	Récupérer les informations des contacts (user).
`get_varnames`()	Renvoyer la liste des grandeurs de données PHyC.
`login`()	Authentification PHyC.
`logout`()	Déconnexion PHyC.
`request_capteur_hydro`([codes])	Service PHyC <publierCapteurHydroListe>.
`request_capteur_hydro_by_station`([codes])	Service PHyC <publierCapteurHydroStationHydro>.
`request_data_fcst_hydro`([codes, models, ...])	Service PHyC <publierPrevisionsMajBase>.
`request_data_obs_hydro`([codes, varname, ...])	Service PHyC <publierObservationsHydroPasDeTemps>.
`request_data_obs_meteo`([codes, varname, ...])	Service PHyC <publierObservationsMeteo>.
`request_flowmes`([codes, first_dtime, last_dtime])	Service PHyC <publierJaugeageHydro>.
`request_levelcor`([codes, first_dtime, ...])	Service PHyC <publierCourbeCorrection>.
`request_loc_meteo`([codes])	Service PHyC <publierSiteMeteoListe>.
`request_ratingcurve`([codes, first_dtime, ...])	Service PHyC <publierCourbeTarage>.
`request_site_hydro`([codes])	Service PHyC <publierSiteHydroListe>.
`request_site_hydro_by_zone`([codes])	Service PHyC <publierSiteHydroZoneHydro>.
`request_station_hydro`([codes])	Service PHyC <publierStationHydroListe>.
`request_station_hydro_by_site`([codes])	Service PHyC <publierStationHydroSiteHydro>.
`request_user`([codes])	Service PHyC <publierContactListe>.
`request_user_loc_meteo`([codes])	Service PHyC <publierSiteMeteoContact>.
`request_user_site_hydro`([codes])	Service PHyC <publierSiteHydroContact>.
`request_user_station_hydro`([codes])	Service PHyC <publierStationHydroContact>.
`retrieve`([dirname, datatype, codes, ...])	Enregistrement de données/informations contenues dans la PHyC.

check_client(): Contrôler si le client SUDS existe.

static check_dtype(dtype): Contrôler s’il s’agit bien d’un export autorisé.

check_session(): Contrôler si la session SOAP existe.

static check_tstep(tstep): Contrôler s’il s’agit bien d’un pas de temps en minutes entières.

static check_varname(varname): Contrôler la grandeur.

get(datatype=None, codes=None, varname=None, timestep=datetime.timedelta(seconds=3600), models=None, first_dtime=datetime.datetime(2025, 10, 13, 11, 23, 40, 232536), last_dtime=datetime.datetime(2025, 10, 13, 11, 23, 40, 232541), elab=None, plusvalide=None)

Récupération de données/informations contenues dans la PHyC.

Paramètres:

datatype (str) – Type de données - ratingcurve : courbes de tarage - levelcor : courbes de correction - flowmes : jaugeages - loc_hydro : siteshydro, stationshydro - loc_meteo : sitesmeteo - data_obs_hydro : données observées hydro - data_obs_meteo : données observées meteo - data_fcst_hydro : données prévues hydro - user : informations utilisateur
codes (list) – Liste des identifiants des stations
first_dtime (datetime) – Premier instant à considérer (défaut: dt.utcnow())
last_dtime (datetime) – Dernier instant à considérer (défaut: dt.utcnow())
varname (str) – Nom de la variable selon convention PHyC (défaut: Q , RR)
timestep (timedelta) – Pas de temps (défaut: timedelta(hours=1))
models (list) – Liste des codes des modèles au sens POM (défaut: [], c’es-à-dire aucun filtre sur les modèles)
elab (bool) – Données élaborées (seulement si varname = Q)
plusvalide (bool) – Données les plus valides. Par défaut : True. Uniquement si datatype est data_obs_hydro ou data_obs_meteo.

Renvoie:

data – Dictionnaire des contenus XML clé: (code, datatype, varname, first_dtime, last_dtime)

Type renvoyé:

dict

get_data_fcst_hydro(codes=None, varname='Q', models=None, first_dtime=datetime.datetime(2025, 10, 13, 11, 23, 40, 232548), last_dtime=datetime.datetime(2025, 10, 13, 11, 23, 40, 232550))

Récupération des prévisions PHyC.

Paramètres:

codes (list) – Liste des identifiants des stations
first_dtime (datetime) – Premier instant à considérer (défaut: dt.utcnow())
last_dtime (datetime) – Dernier instant à considérer (défaut: dt.utcnow())
varname (str) – Nom de la variable selon convention PHyC (défaut: Q)
models (list) – Liste des codes des modèles au sens POM (défaut: [], c’es-à-dire aucun filtre sur les modèles)

Renvoie:

data – Dictionnaire des contenus XML clé: (code, “data_fcst_hydro”, varname, first_dtime, last_dtime)

Type renvoyé:

dict

get_data_obs_hydro(codes=None, varname='Q', timestep=datetime.timedelta(seconds=3600), first_dtime=datetime.datetime(2025, 10, 13, 11, 23, 40, 232554), last_dtime=datetime.datetime(2025, 10, 13, 11, 23, 40, 232557), elab=None, plusvalide=None)

Récupération des observations hydrométriques en PHyC.

Paramètres:

codes (list) – Liste des identifiants des stations
first_dtime (datetime) – Premier instant à considérer (défaut: dt.utcnow())
last_dtime (datetime) – Dernier instant à considérer (défaut: dt.utcnow())
varname (str) – Nom de la variable selon convention PHyC (défaut: Q)
timestep (timedelta) – Pas de temps (défaut: timedelta(hours=1))
elab (bool) – Données élaborées (seulement si varname = Q)
plusvalide (bool) – Données les plus valides. Par défaut : True.

Renvoie:

data – Dictionnaire des contenus XML clé: (code, “data_obs_hydro”, varname, first_dtime, last_dtime)

Type renvoyé:

dict

get_data_obs_meteo(codes=None, varname='RR', timestep=datetime.timedelta(seconds=3600), first_dtime=datetime.datetime(2025, 10, 13, 11, 23, 40, 232561), last_dtime=datetime.datetime(2025, 10, 13, 11, 23, 40, 232563), plusvalide=None)

Récupération des observations météorologiques en PHyC.

Paramètres:

codes (list) – Liste des identifiants des stations
first_dtime (datetime) – Premier instant à considérer (défaut: dt.utcnow())
last_dtime (datetime) – Dernier instant à considérer (défaut: dt.utcnow())
varname (str) – Nom de la variable selon convention PHyC (défaut: RR)
timestep (timedelta) – Pas de temps (défaut: timedelta(hours=1))
plusvalide (bool) – Données les plus valides. Par défaut : True.

Renvoie:

data – Dictionnaire des contenus XML clé: (code, “data_obs_meteo”, varname, first_dtime, last_dtime)

Type renvoyé:

dict

classmethod get_datatypes()

Renvoyer la liste des types de données PHyC.

Renvoie:: Types de données
Type renvoyé:: list

Voir aussi

pyspc.convention.sandre.DATATYPES

get_flowmes(codes=None, first_dtime=datetime.datetime(2025, 10, 13, 11, 23, 40, 232565), last_dtime=datetime.datetime(2025, 10, 13, 11, 23, 40, 232568))

Récupérer les jaugeages de la PHyC.

Paramètres:

codes (list) – Liste des identifiants des stations
first_dtime (datetime) – Premier instant à considérer (défaut: dt.utcnow())
last_dtime (datetime) – Dernier instant à considérer (défaut: dt.utcnow())

Renvoie:

data – Dictionnaire des contenus XML clé: (code, “flowmes”, first_dtime, last_dtime)

Type renvoyé:

dict

get_levelcor(codes=None, first_dtime=datetime.datetime(2025, 10, 13, 11, 23, 40, 232570), last_dtime=datetime.datetime(2025, 10, 13, 11, 23, 40, 232572))

Récupérer les courbes de correction de la PHyC.

Paramètres:

codes (list) – Liste des identifiants des stations
first_dtime (datetime) – Premier instant à considérer (défaut: dt.utcnow())
last_dtime (datetime) – Dernier instant à considérer (défaut: dt.utcnow())

Renvoie:

data – Dictionnaire des contenus XML clé: (code, “levelcor”, first_dtime, last_dtime)

Type renvoyé:

dict

get_loc_hydro(codes=None, child=False)

Récupérer les sites/stations hydro connus dans la PHyC.

Paramètres:

codes (list) – Liste des identifiants des sites/stations
child (bool) – Entités “filles” associée aux entités demandées. Par défaut: False

Renvoie:

data – Dictionnaire des contenus XML clé: (code, “loc_hydro”)

Type renvoyé:

dict

get_loc_meteo(codes=None)

Récupérer les sites météo connus dans la PHyC.

Paramètres:: codes (list) – Liste des identifiants des stations
Renvoie:: data – Dictionnaire des contenus XML clé: (code, “loc_meteo”)
Type renvoyé:: dict

get_ratingcurve(codes=None, first_dtime=datetime.datetime(2025, 10, 13, 11, 23, 40, 232575), last_dtime=datetime.datetime(2025, 10, 13, 11, 23, 40, 232578))

Récupérer les courbes de tarage de la PHyC.

Paramètres:

codes (list) – Liste des identifiants des stations
first_dtime (datetime) – Premier instant à considérer (défaut: dt.utcnow())
last_dtime (datetime) – Dernier instant à considérer (défaut: dt.utcnow())

Renvoie:

data – Dictionnaire des contenus XML clé: (code, “ratingcurve”, first_dtime, last_dtime)

Type renvoyé:

dict

get_user(codes=None)

Récupérer les informations des contacts (user).

Paramètres:: codes (list) – Liste des identifiants des contacts
Renvoie:: data – Dictionnaire des contenus XML clés: (code, “admin”) : informations administratives (code, “site_hydro”) : informations Site Hydro (code, “station_hydro”) : informations Station Hydro (code, “site_meteo”) : informations Site Meteo
Type renvoyé:: dict

classmethod get_varnames()

Renvoyer la liste des grandeurs de données PHyC.

Renvoie:: Grandeurs
Type renvoyé:: list

Voir aussi

pyspc.convention.sandre.VARNAMES

login(): Authentification PHyC.

logout(): Déconnexion PHyC.

request_capteur_hydro(codes=None)

Service PHyC <publierCapteurHydroListe>.

-> Liste des capteurs hydro connus dans la PHyC

Paramètres:: codes (list) – Liste des identifiants des capteurs
Renvoie:: result – Résultat de la requête PHyC
Type renvoyé:: suds.sudsobject

request_capteur_hydro_by_station(codes=None)

Service PHyC <publierCapteurHydroStationHydro>.

-> Liste des capteurs hydro associés à une station hydro

Paramètres:: codes (list) – Liste des identifiants des stations hydro
Renvoie:: result – Résultat de la requête PHyC
Type renvoyé:: suds.sudsobject

request_data_fcst_hydro(codes=None, models=None, varname='Q', first_dtime=datetime.datetime(2025, 10, 13, 11, 23, 40, 232862), last_dtime=datetime.datetime(2025, 10, 13, 11, 23, 40, 232865))

Service PHyC <publierPrevisionsMajBase>.

-> Prévisions selon date d’insertion dans la PHyC

Paramètres:

codes (list) – Liste des identifiants des stations
first_dtime (datetime) – Premier instant à considérer (défaut: dt.utcnow())
last_dtime (datetime) – Dernier instant à considérer (défaut: dt.utcnow())
varname (str) – Nom de la variable selon convention PHyC (défaut: Q)
models (list) – Liste des codes des modèles au sens POM (défaut: [], c’es-à-dire aucun filtre sur les modèles)

Renvoie:

result – Résultat de la requête PHyC

Type renvoyé:

suds.sudsobject

request_data_obs_hydro(codes=None, varname='Q', timestep=datetime.timedelta(seconds=3600), first_dtime=datetime.datetime(2025, 10, 13, 11, 23, 40, 232871), last_dtime=datetime.datetime(2025, 10, 13, 11, 23, 40, 232873), elab=None, plusvalide=None)

Service PHyC <publierObservationsHydroPasDeTemps>.

-> Hauteur horaire ou Débit horaire

ou

Service PHyC <publierObservationsHydro> -> Hauteur instantanée ou Débit instantané

Paramètres:

codes (list) – Liste des identifiants des stations
first_dtime (datetime) – Premier instant à considérer (défaut: dt.utcnow())
last_dtime (datetime) – Dernier instant à considérer (défaut: dt.utcnow())
varname (str) – Nom de la variable selon convention PHyC (défaut: Q)
timestep (timedelta) – Pas de temps fixe (défaut: 1h)
elab (bool) – Données élaborées (seulement si varname = Q)
plusvalide (bool) – Données les plus valides. Par défaut : True. Appliqué seulement si elab=False et timestep=None)

Renvoie:

result – Résultat de la requête PHyC

Type renvoyé:

suds.sudsobject

request_data_obs_meteo(codes=None, varname='RR', accum=False, timestep=datetime.timedelta(seconds=3600), first_dtime=datetime.datetime(2025, 10, 13, 11, 23, 40, 232877), last_dtime=datetime.datetime(2025, 10, 13, 11, 23, 40, 232879), plusvalide=None)

Service PHyC <publierObservationsMeteo>.

-> Précipitation ou température au pas de temps de collecte

ou

Service PHyC <publierPluvioCumulGlissant> -> Précipitation cumulée sur une période glissante

Le choix du service est fait en fonction de l’argument <accum>

Paramètres:

accum (bool) – Cumul à pas de temps fixe (False) ou sur une période glissante (True)
codes (list) – Liste des identifiants des stations
first_dtime (datetime) – Premier instant à considérer (défaut: dt.utcnow())
last_dtime (datetime) – Dernier instant à considérer (défaut: dt.utcnow())
varname (str) – Nom de la variable selon convention PHyC (défaut: RR)
timestep (timedelta) – Pas de temps fixe (défaut: 1h)
plusvalide (bool) – Données les plus valides. Par défaut : True. Appliqué seulement si timestep=None

Renvoie:

result – Résultat de la requête PHyC

Type renvoyé:

suds.sudsobject

request_flowmes(codes=None, first_dtime=datetime.datetime(2025, 10, 13, 11, 23, 40, 232882), last_dtime=datetime.datetime(2025, 10, 13, 11, 23, 40, 232884))

Service PHyC <publierJaugeageHydro>.

-> Jaugeages connus dans la PHyC

Paramètres:

codes (list) – Liste des identifiants des stations
first_dtime (datetime) – Premier instant à considérer (défaut: dt.utcnow())
last_dtime (datetime) – Dernier instant à considérer (défaut: dt.utcnow())

Renvoie:

result – Résultat de la requête PHyC

Type renvoyé:

suds.sudsobject

request_levelcor(codes=None, first_dtime=datetime.datetime(2025, 10, 13, 11, 23, 40, 232886), last_dtime=datetime.datetime(2025, 10, 13, 11, 23, 40, 232888))

Service PHyC <publierCourbeCorrection>.

-> Courbes de Correction connues dans la PHyC

Paramètres:

codes (list) – Liste des identifiants des stations
first_dtime (datetime) – Premier instant à considérer (défaut: dt.utcnow())
last_dtime (datetime) – Dernier instant à considérer (défaut: dt.utcnow())

Renvoie:

result – Résultat de la requête PHyC

Type renvoyé:

suds.sudsobject

request_loc_meteo(codes=None)

Service PHyC <publierSiteMeteoListe>.

-> Liste des sites météo connus dans la PHyC

Paramètres:: codes (list) – Liste des identifiants des stations
Renvoie:: result – Résultat de la requête PHyC
Type renvoyé:: suds.sudsobject

request_ratingcurve(codes=None, first_dtime=datetime.datetime(2025, 10, 13, 11, 23, 40, 232893), last_dtime=datetime.datetime(2025, 10, 13, 11, 23, 40, 232896))

Service PHyC <publierCourbeTarage>.

-> Courbes de Tarage connues dans la PHyC

Paramètres:

codes (list) – Liste des identifiants des stations
first_dtime (datetime) – Premier instant à considérer (défaut: dt.utcnow())
last_dtime (datetime) – Dernier instant à considérer (défaut: dt.utcnow())

Renvoie:

result – Résultat de la requête PHyC

Type renvoyé:

suds.sudsobject

request_site_hydro(codes=None)

Service PHyC <publierSiteHydroListe>.

-> Liste des sites hydro connus dans la PHyC

Paramètres:: codes (list) – Liste des identifiants des stations
Renvoie:: result – Résultat de la requête PHyC
Type renvoyé:: suds.sudsobject

request_site_hydro_by_zone(codes=None)

Service PHyC <publierSiteHydroZoneHydro>.

-> Liste des sites hydro associés à une zone hydro

Paramètres:: codes (list) – Liste des identifiants des zones hydro
Renvoie:: result – Résultat de la requête PHyC
Type renvoyé:: suds.sudsobject

request_station_hydro(codes=None)

Service PHyC <publierStationHydroListe>.

-> Liste des stations hydro connus dans la PHyC

Paramètres:: codes (list) – Liste des identifiants des stations
Renvoie:: result – Résultat de la requête PHyC
Type renvoyé:: suds.sudsobject

request_station_hydro_by_site(codes=None)

Service PHyC <publierStationHydroSiteHydro>.

-> Liste des stations hydro associés à un site hydro

Paramètres:: codes (list) – Liste des identifiants des sites hydro
Renvoie:: result – Résultat de la requête PHyC
Type renvoyé:: suds.sudsobject

request_user(codes=None)

Service PHyC <publierContactListe>.

-> Liste des contacts connus dans la PHyC

Paramètres:: codes (list) – Liste des identifiants des stations
Renvoie:: result – Résultat de la requête PHyC
Type renvoyé:: suds.sudsobject

request_user_loc_meteo(codes=None)

Service PHyC <publierSiteMeteoContact>.

-> Liste des sites meteo connus dans la PHyC et affiliés aux contacts

Paramètres:: codes (list) – Liste des identifiants des stations
Renvoie:: result – Résultat de la requête PHyC
Type renvoyé:: suds.sudsobject

request_user_site_hydro(codes=None)

Service PHyC <publierSiteHydroContact>.

-> Liste des sites hydro connus dans la PHyC et affiliés aux contacts

Paramètres:: codes (list) – Liste des identifiants des contacts
Renvoie:: result – Résultat de la requête PHyC
Type renvoyé:: suds.sudsobject

request_user_station_hydro(codes=None)

Service PHyC <publierStationHydroContact>.

-> Liste des stations hydro connus dans la PHyC et affiliés aux contacts

Paramètres:: codes (list) – Liste des identifiants des contacts
Renvoie:: result – Résultat de la requête PHyC
Type renvoyé:: suds.sudsobject

retrieve(dirname='.', datatype=None, codes=None, varname=None, timestep=datetime.timedelta(seconds=3600), models=None, first_dtime=datetime.datetime(2025, 10, 13, 11, 23, 40, 232586), last_dtime=datetime.datetime(2025, 10, 13, 11, 23, 40, 232588), elab=None, plusvalide=None)

Enregistrement de données/informations contenues dans la PHyC.

Paramètres:

dirname (str) – Dossier de sortie
datatype (str) –
Type de données
- data_fcst_hydro : données prévues hydro
- data_obs_hydro : données observées hydro
- data_obs_meteo : données observées meteo
- flowmes : jaugeages
- levelcor : courbes de correction
- ratingcurve : courbes de tarage
- loc_hydro : siteshydro, stationshydro
- loc_meteo : sitesmeteo
- user : informations utilisateur
codes (list) – Liste des identifiants des stations
first_dtime (datetime) – Premier instant à considérer (défaut: dt.utcnow())
last_dtime (datetime) – Dernier instant à considérer (défaut: dt.utcnow())
varname (str) – Nom de la variable selon convention PHyC (défaut: Q)
timestep (timedelta) – Pas de temps (défaut: timedelta(hours=1))
models (list) – Liste des codes des modèles au sens POM (défaut: [], c’es-à-dire aucun filtre sur les modèles)
elab (bool) – Données élaborées (seulement si varname = Q)
plusvalide (bool) – Données les plus valides. Par défaut : True. Uniquement si datatype est data_obs_hydro ou data_obs_meteo.

Renvoie:

Fichiers XML contenant les données de la PHyC

Type renvoyé:

list