pyspc.webservice.lamedo.bdapbp.BdApbp

class pyspc.webservice.lamedo.bdapbp.BdApbp(hostname=None, proxies=None, timeout=None)[source]

Bases : _Basic_webservice

Structure de données BdApbp

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

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

Instanciation du wbeservice

Paramètres:

  • hostname (str) – Hôte du webservice

  • proxies (None, dict) – Dictionnaire des proxys {“protocol”: “proxy”}

  • timeout (None, int) – Durée maximale de la requête

Methods

__init__([hostname, proxies, timeout])

Instanciation du wbeservice

get_types()

Liste des formats des données ApBp au format JSON

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([zones, date, dtype, dirname])

Définir le fichier du bulletin APBP à télécharger

set_url([zones, date, dtype])

Définir l'url du bulletin APBP à télécharger
classmethod get_types()[source]

Liste des formats des données ApBp au format JSON

  • short : retour concis

  • long : retour complet

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(zones=None, date=None, dtype=None, dirname='.')[source]

Définir le fichier du bulletin APBP à télécharger

Paramètres:

  • zones (str, list) – Identifiants de zone AP

  • date (datetime) – Date du bulletin APBP

  • dtype (str) – Format du retour JSON - short : retour concis - long : retour complet (défaut)

  • dirname (str) – Répertoire local de stockage

  • seealso:: (..) – pyspc.webservice.lamedo.convention.BDAPBP_DATATYPES

set_url(zones=None, date=None, dtype=None)[source]

Définir l’url du bulletin APBP à télécharger

Paramètres:

  • zones (str, list) – Identifiants de zone AP

  • date (datetime) – Date du bulletin APBP

  • dtype (str) – Format du retour JSON - short : retour concis - long : retour complet (défaut)

  • seealso:: (..) – pyspc.webservice.lamedo.convention.BDAPBP_DATATYPES