pyspc.webservice.hydro2.export.Export

class pyspc.webservice.hydro2.export.Export(stations=None, datatype=None, precision=None, first_dt=None, last_dt=None)

Bases : object

Structure de données Export HYDRO-2

stations

Liste des entités

Type:

list

datatype

Type d’export

Type:

str

precision

Précision (si export TOUSMOIS)

Type:

None, int

first_dt

Premier pas de temps

Type:

datetime

last_dt

Dernier pas de temps

Type:

datetime

period

Période extraite

Type:

timedelta

dtfmt

Format de date

Type:

str

exports

Liste des exports, définis par les méthodes set_export*

Type:

None, list

__init__(stations=None, datatype=None, precision=None, first_dt=None, last_dt=None)

Initialisation de l’instance de la classe Export d’Hydro-2

Paramètres:

• stations (list) – Liste des entités

• datatype (str) – Type d’export

• precision (None, int) – Précision (si export TOUSMOIS)

• first_dt (datetime) – Premier pas de temps

• last_dt (datetime) – Dernier pas de temps

Methods

__init__([stations, datatype, precision, ...])	Initialisation de l'instance de la classe Export d'Hydro-2
check_dtime()	Contrôler si les dates sont fournies sous forme de datetime
check_dtype()	Contrôler le type d'export
check_precision()	Contrôler la précision
check_stations()	Contrôler si les stations sont fournies sous forme de liste
get_datatypes()	Obtenir la liste des exports
get_dtfmt()	Contrôler et renvoyer le format des dates
get_maxperiod()	Contrôler et renvoyer la durée maximale d'un export
set_export([onefile])	Définir la liste des procédures d'export Hydro2
set_export_crucal([onefile])	Procédure Export CRUCAL
set_export_debcla([onefile])	Procédure Export DEBCLA
set_export_series()	Procédure Export de séries de données - H-TEMPS - QTVAR - QTFIX - QJM
set_export_synthese([onefile])	Procédure Export SYNTHESE
set_export_tousmois([onefile])	Procédure Export TOUSMOIS
set_index_export([station, indexes])	Définir l'indice unique servant au suffixe du fichier d'export
set_shortfilename([station, index])	Définir le nom du fichier d'export Hydro2
write([filename])	Ecrire le fichier contenant les procédures d'export Hydro2

check_dtime()

Contrôler si les dates sont fournies sous forme de datetime

check_dtype()

Contrôler le type d’export

check_precision()

Contrôler la précision

check_stations()

Contrôler si les stations sont fournies sous forme de liste

classmethod get_datatypes()

Obtenir la liste des exports

Renvoie:

Liste des types d’export

Type renvoyé:

list

get_dtfmt()

Contrôler et renvoyer le format des dates

get_maxperiod()

Contrôler et renvoyer la durée maximale d’un export

set_export(onefile=None)

Définir la liste des procédures d’export Hydro2

Paramètres:

onefile (str) – Nom du fichier, si l’utilisateur souhaite avoir toutes les stations dans un seul fichier

set_export_crucal(onefile=None)

Procédure Export CRUCAL

Paramètres:

onefile (str) – Nom du fichier, si l’utilisateur souhaite avoir toutes les stations dans un seul fichier

set_export_debcla(onefile=None)

Procédure Export DEBCLA

Paramètres:

onefile (str) – Nom du fichier, si l’utilisateur souhaite avoir toutes les stations dans un seul fichier

set_export_series()

Procédure Export de séries de données - H-TEMPS - QTVAR - QTFIX - QJM

set_export_synthese(onefile=None)

Procédure Export SYNTHESE

Paramètres:

onefile (str) – Nom du fichier, si l’utilisateur souhaite avoir toutes les stations dans un seul fichier

set_export_tousmois(onefile=None)

Procédure Export TOUSMOIS

Paramètres:

onefile (str) – Nom du fichier, si l’utilisateur souhaite avoir toutes les stations dans un seul fichier

static set_index_export(station=None, indexes=None)

Définir l’indice unique servant au suffixe du fichier d’export

Paramètres:

• station (str) – Code de la station

• indexes (dict) – Dictionnaire des indices déjà utilisés

Renvoie:

• index (int) – Premier indice valide pour la station courante

• indexes (dict) – Dictionnaire des indices déjà utilisés

set_shortfilename(station=None, index=0)

Définir le nom du fichier d’export Hydro2

Paramètres:

• station (str) – Code de la station

• index (int) – Suffixe du fichier

Renvoie:

shortfilename – Nom court sur 8 caractères + extension

Type renvoyé:

str

write(filename=None)

Ecrire le fichier contenant les procédures d’export Hydro2

Paramètres:

filename (str) – Fichier des commandes abrégées pour Hydro2, à placer dans cdesabr

Renvoie:

filename – Fichier des commandes abrégées pour Hydro2, à placer dans cdesabr

Type renvoyé:

str