pyspc.webservice.report.report.OnlineReport

class pyspc.webservice.report.report.OnlineReport(reporttype=None, proxies=None, timeout=None)[source]

Bases : _Basic_webservice

Structure de données Online_Report

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

url

Adresse de la requête

Type:: None, str

filename

Fichier enregistré en local

Type:: None, str

reporttype

Type de rapport

Type:: str

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

Instanciation du wbeservice

Paramètres:

reporttype (str) – Type de rapport
proxies (None, dict) – Dictionnaire des proxys {“protocol”: “proxy”}
timeout (None, int) – Durée maximale de la requête

Methods

`__init__`([reporttype, proxies, timeout])	Instanciation du wbeservice
`get_reporttypes`()	Liste des types de rapport
`retrieve`([engine])	Récupérer un objet depuis une url
`retrieve_byrequests`()	Récupérer un objet depuis une url par 'urllib'
`retrieve_byurllib`()	Récupérer un objet depuis une url par 'urllib'
`set_filename`([code, varname, date, ...])	Définir le fichier des documents en ligne
`set_filename_bycode`([code, dirname])	Définir le fichier local
`set_filename_bycodedatetype`([code, date, ...])	Définir le fichier local
`set_filename_bycodevarname`([code, varname, ...])	Définir le fichier local
`set_filename_bydate`([date, dirname, dtfmt])	Définir le fichier local
`set_filename_mf_monthlyreport`([code, date, ...])	Définir le fichier des bulletins mensuels de Météo-France
`set_filename_noarg`([dirname])	Définir le fichier sans option
`set_url`([code, date, varname, codetype])	Définir l'url des documents en ligne
`set_url_bycode`([code])	Définir une url avec l'argument code
`set_url_mf_dailyreport`([date])	Définir l'url des bulletins journaliers de Météo-France
`set_url_mf_monthlyreport`([code, date])	Définir l'url des bulletins mensuels de Météo-France
`set_url_mf_warning`([date])	Définir l'url des vigilances de Météo-France
`set_url_noarg`()	Définir une url sans option
`set_url_vigicrues`([code, varname])	Définir l'url des données de Vigicrues
`set_url_vigicrues1`([code, codetype])	Définir l'url des données de Vigicrues - service version 1.1
`set_verify`()	Définir le chemin local du certificat SSL

classmethod get_reporttypes()[source]

Liste des types de rapport

Renvoie:: Types de rapport
Type renvoyé:: list

Voir aussi

pyspc.webservice.report.HOSTNAMES

retrieve(engine=None)

Récupérer un objet depuis une url

Paramètres:

engine (str) – Outil de récupération. Défaut: “urllib” - urllib : https://docs.python.org/fr/3/library/urllib.html - requests : https://requests.readthedocs.io/en/master/

Renvoie:

None – Si la requête est incorrecte
res (http.client.HTTPResponse) – Si engine == “urllib” La réponse de “urllib.request.urlopen” si self.filename is None
res (requests.Response) – La réponse de “requests.get” si self.filename is None Si engine == “requests”
filename (str) – Le fichier enregistré

retrieve_byrequests()

Récupérer un objet depuis une url par “urllib”

Paramètres:

verify (bool, str) – Paramètre de vérification SSL de requests.get

Renvoie:

None – Si la requête est incorrecte
res (requests.Response) – La réponse de “requests.get” si self.filename is None
filename (str) – Le fichier enregistré
.. seealso:: https (//requests.readthedocs.io/en/master/)

retrieve_byurllib()

Récupérer un objet depuis une url par “urllib”

Renvoie:

None – Si la requête est incorrecte
res (http.client.HTTPResponse) – La réponse de “urllib.request.urlopen” si self.filename is None
filename (str) – Le fichier enregistré
.. seealso:: https (//docs.python.org/fr/3/library/urllib.html)

set_filename(code=None, varname=None, date=None, codetype=None, dirname='.')[source]

Définir le fichier des documents en ligne

Paramètres:

code (str) – Identifiant (Hydro2, BNBV, station, région, département…)
varname (str) – Grandeur
date (datetime) – Date du bulletin
codetype (str) – Type d’entité Vigicrues (1.1)
dirname (str) – Répertoire local de stockage

set_filename_bycode(code=None, dirname='.')[source]

Définir le fichier local

Paramètres:

code (str) – Identifiant Hydro2
dirname (str) – Répertoire local de stockage

set_filename_bycodedatetype(code=None, date=None, codetype=None, dirname='.', dtfmt='%Y%m%d%H%M')[source]

Définir le fichier local

Paramètres:

code (str) – Identifiant
date (datetime) – Date du bulletin
codetype (str) – Type d’entité Vigicrues (1.1)
dirname (str) – Répertoire local de stockage
dtfmt (str) – Format de la date

set_filename_bycodevarname(code=None, varname=None, dirname='.')[source]

Définir le fichier local

Paramètres:

code (str) – Identifiant
varname (str) – Grandeur
dirname (str) – Répertoire local de stockage

set_filename_bydate(date=None, dirname='.', dtfmt='%Y%m%d%H%M')[source]

Définir le fichier local

Paramètres:

date (datetime) – Date du fichier
dirname (str) – Répertoire local de stockage
dtfmt (str) – Format de la date

set_filename_mf_monthlyreport(code=None, date=None, dirname='.')[source]

Définir le fichier des bulletins mensuels de Météo-France

Paramètres:

code (str) – Identifiant du département/région
date (datetime) – Date du bulletin
dirname (str) – Répertoire local de stockage

set_filename_noarg(dirname='.')[source]

Définir le fichier sans option

Paramètres:: dirname (str) – Répertoire local de stockage

set_url(code=None, date=None, varname=None, codetype=None)[source]

Définir l’url des documents en ligne

Paramètres:

code (str) – Identifiant (Hydro2, BNBV, station, région, département…)
date (datetime) – Date du bulletin
varname (str) – Grandeur (Vigicrues)
codetype (str) – Type d’entité Vigicrues (1.1)

Voir aussi

pyspc.convention.vigicrues.CODETYPES, pyspc.convention.vigicrues.VARNAMES

set_url_bycode(code=None)[source]

Définir une url avec l’argument code

Paramètres:: code (str) – Identifiant

set_url_mf_dailyreport(date=None)[source]

Définir l’url des bulletins journaliers de Météo-France

Paramètres:: date (datetime) – Date du bulletin

set_url_mf_monthlyreport(code=None, date=None)[source]

Définir l’url des bulletins mensuels de Météo-France

Paramètres:

code (str) – Identifiant du département/région
date (datetime) – Date du bulletin

set_url_mf_warning(date=None)[source]

Définir l’url des vigilances de Météo-France

Paramètres:: date (datetime) – Date de la vigilance

set_url_noarg()[source]: Définir une url sans option

set_url_vigicrues(code=None, varname=None)[source]

Définir l’url des données de Vigicrues

Paramètres:

code (str) – Identifiant Hydro3 de la station
varname (str) – Grandeur parmi (“H”, “Q”)

set_url_vigicrues1(code=None, codetype=None)[source]

Définir l’url des données de Vigicrues - service version 1.1

Paramètres:

code (str) – Identifiant Hydro3 de la station
codetype (str) – Type d’entité Vigicrues (1.1)

Voir aussi

pyspc.convention.vigicrues.CODETYPES

set_verify()[source]

Définir le chemin local du certificat SSL

Voir aussi

https: //www.ssllabs.com/ssltest/analyze.html?d=webgr.inrae.fr