pyspc.webservice.hydroportail.hydroportail.Hydroportail

class pyspc.webservice.hydroportail.hydroportail.Hydroportail(hostname=None, proxies=None, timeout=None, verify=None)[source]

Bases : object

Structure du client accédant aux données de Hydroportail.

hostname

Hôte du webservice

Type:: str

proxies

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

Type:: None, dict

timeout

Durée maximale de la requête

Type:: None, int

session

Session de la requête

Type:: requests.Session

url

Adresse de la requête

Type:: None, str

filename

Fichier enregistré en local

Type:: None, str

verify

Vérification du certificat SSL. Voir requests.get

Type:: None, str, bool

__init__(hostname=None, proxies=None, timeout=None, verify=None)[source]

Instanciation du webservice.

Paramètres:

hostname (str) – Hôte du webservice. Par défaut: eaufrance
proxies (None, dict) – Dictionnaire des proxys {“protocol”: “proxy”}
timeout (None, int) – Durée maximale de la requête. Par défaut: 300 secondes.
verify (None, str, bool) – Vérification du certificat SSL. Voir requests.get

Methods

`__init__`([hostname, proxies, timeout, verify])	Instanciation du webservice.
`check_datatype`(dtype)	Contrôler s'il s'agit bien d'un export autorisé.
`get`([code, datatype])	Récupérer les données de Hydroportail.
`get_datatypes`()	Obtenir la liste des exports.
`login`()	Ouvrir une session requests.Session.
`logout`()	Fermer une session requests.Session.
`retrieve`([codes, datatype, dirname, ouahs])	Récupérer les données de Hydroportail en local.
`seasons2ouahs`(seasons[, asint])	Convertir le dataframe "data-seasons" au format OUAHS.

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

get(code=None, datatype=None)[source]

Récupérer les données de Hydroportail.

Paramètres:

code (str) – Identifiant du site hydro
datatype (str) – Type d’export Hydroportail

Renvoie:

res – Retour de requests.Session.get

Type renvoyé:

requests.models.Response

Voir aussi

pyspc.convention.hydroportail.DATATYPES, pyspc.webservice.hydroportail.Hydroportail.get_datatypes, pyspc.webservice.hydroportail.Hydroportail.retieve

classmethod get_datatypes()[source]

Obtenir la liste des exports.

Renvoie:: Liste des types d’export
Type renvoyé:: list

Voir aussi

pyspc.convention.hydroportail.DATATYPES

login()[source]: Ouvrir une session requests.Session.

logout()[source]: Fermer une session requests.Session.

retrieve(codes=None, datatype=None, dirname='.', ouahs=False)[source]

Récupérer les données de Hydroportail en local.

Paramètres:

codes (list) – Identifiants du site hydro
datatype (str) – Type d’export Hydroportail
dirname (str) – Répertoire local d’archivage des fichiers Hydroportail. Défaut: “.”
ouahs (bool) – Exporter l’échantillon au format OUAHS. Défaut: False

Renvoie:

filenames – Fichiers enregistrés {clé=(code, datatype), valeur = liste des fichiers associés}

Type renvoyé:

dict

Voir aussi

pyspc.convention.hydroportail.DATATYPES, pyspc.webservice.hydroportail.Hydroportail.get

static seasons2ouahs(seasons, asint=False)[source]

Convertir le dataframe « data-seasons » au format OUAHS.

Paramètres:

seasons (pandas.DataFrame) – Echantillon au format Hydroportail
asint (bool) – Forcer les valeurs en entier. Défaut: False

Renvoie:

ouahs – Echantillon au format OUAHS

Type renvoyé:

pandas.DataFrame

Voir aussi

pyspc.convention.hydroportail.OUAHS_COLS, pyspc.convention.hydroportail.OUAHS_NO_TRAILING_ZEROS, pyspc.convention.hydroportail.OUAHS_COLS_FROM_SEASONS