pyspc.metadata.refspc.refspc.RefSPC

class pyspc.metadata.refspc.refspc.RefSPC(filename=None)[source]

Bases : Sdb

Classe destinée à extraire des informations du référentiel du SPC LACI.

filename

Nom du fichier de la base de données

Type:

str

_dbase_connect

Object de connexion sqlite3

Type:

sqlite3

_dbase_cursor

Curseur de sqlite3

Type:

sqlite3

sql

Dernière requête SQL

Type:

str

__init__(filename=None)[source]

Initialisation de l’instance RefSPC.

Paramètres:

filename (str) – Nom du fichier de la base de données

Methods

__init__([filename])

Initialisation de l'instance RefSPC.

check_sql_return([content, warning])

Contrôler le retour de la requête SQL.

close()

Fermer la connexion à la base de données et le curseur <dbase>.

commit()

Commiter/accepter les enregistrements ajoutés.

connect()

Créer la connexion à la base de données Créer le curseur sqlite3

execute([warning])

Exécution de la requête SQL

get([codes, datatype, how, hydro3])

Extraire les informations du référentiel du SPC LACI.

get_datatypes()

Type de données du référentiel.

get_loc_hydro([codes, how, hydro3])

Extraire les informations 'LOC_HYDRO' du référentiel du SPC LACI.

get_loc_meteo([codes, how])

Extraire les informations 'LOC_METEO' du référentiel du SPC LACI.

get_reach([codes, how, hydro3])

Extraire les informations 'TRONCON' du référentiel du SPC LACI.

get_stat_hydro([codes])

Extraire les informations 'STAT_HYDRO' du référentiel du SPC LACI.

get_stat_meteo([codes])

Extraire les informations 'STAT_METEO' du référentiel du SPC LACI.

lastrowid()

Récupérer l'identifiant du dernier enregistrement

rollback()

Annuler les enregistrements ajoutés.
check_sql_return(content=None, warning=False)

Contrôler le retour de la requête SQL.

close()

Fermer la connexion à la base de données et le curseur <dbase>.

commit()

Commiter/accepter les enregistrements ajoutés.

connect()

Créer la connexion à la base de données Créer le curseur sqlite3

Avertissement

Cette méthode nécessite l’import de la bibliothèque tierce sqlite3

execute(warning=True)

Exécution de la requête SQL

Paramètres:

warning (bool) – Afficher les avertissements. Par défaut: True

Renvoie:

  • list or None – Eléments retenus par la requête SQL

  • .. warning:: Cette méthode nécessite l’import de la – bibliothèque tierce sqlite3

get(codes=None, datatype=None, how='by_code', hydro3=True)[source]

Extraire les informations du référentiel du SPC LACI.

Paramètres:

  • codes (list) –

    Liste des identifiants - si entité hydrologique et hydro3

    • site : identifiant de 8 caractères

    • station : identifiant de 10 caractères

    • capteuridentifiant de 12 caractères

      • si entité hydrologique et hydro-2 : 8 caractères

      • si entité météo : 8 caractères

  • datatype (str) – Type d’entités du référentiel Voir la méthode get_datatypes

  • how (str) – Source des identifiants - by_code : code de stations (par défaut) - by_reach : code de tronçons associés aux stations - by_loc : code de stations associées aux tronçons

  • hydro3 (bool) – Codes des lieux selon convention Hydro3 défaut: True

Renvoie:

  • atts (list) – Liste des attributs des entités extraites

  • info (dict) – Dictionnaire des informations extraites

classmethod get_datatypes()[source]

Type de données du référentiel.

get_loc_hydro(codes=None, how='by_code', hydro3=True)[source]

Extraire les informations “LOC_HYDRO” du référentiel du SPC LACI.

Paramètres:

  • codes (list) – Liste des identifiants: - site : identifiant de 8 caractères - station : identifiant de 10 caractères - capteur : identifiant de 12 caractères

  • how (str) – Source des identifiants - by_code : code de stations (par défaut) - by_reach : code de tronçons associés aux stations

  • hydro3 (bool) – Codes des lieux selon convention Hydro3 défaut: True

Renvoie:

  • atts (list) – Liste des attributs des entités extraites

  • info (dict) – Dictionnaire des informations extraites

get_loc_meteo(codes=None, how='by_code')[source]

Extraire les informations “LOC_METEO” du référentiel du SPC LACI.

Paramètres:

  • codes (list) – Liste des identifiants

  • how (str) – Source des identifiants - by_code : code de stations (par défaut) - by_dept : code de départements

Renvoie:

  • atts (list) – Liste des attributs des entités extraites

  • info (dict) – Dictionnaire des informations extraites

get_reach(codes=None, how='by_code', hydro3=True)[source]

Extraire les informations “TRONCON” du référentiel du SPC LACI.

Paramètres:

  • codes (list) – Liste des identifiants

  • how (str) – Source des identifiants - by_code : code de tronçons (par défaut) - by_loc : code de stations associées aux tronçons

  • hydro3 (bool) – Codes des lieux selon convention Hydro3 défaut: True

Renvoie:

  • atts (list) – Liste des attributs des entités extraites

  • info (dict) – Dictionnaire des informations extraites

get_stat_hydro(codes=None)[source]

Extraire les informations “STAT_HYDRO” du référentiel du SPC LACI.

Paramètres:

codes (list) – Liste des identifiants de site : 8 caractères

Renvoie:

  • atts (list) – Liste des attributs des entités extraites

  • info (dict) – Dictionnaire des informations extraites

get_stat_meteo(codes=None)[source]

Extraire les informations “STAT_METEO” du référentiel du SPC LACI.

Paramètres:

codes (list) – Liste des identifiants de site : 8 caractères

Renvoie:

  • atts (list) – Liste des attributs des entités extraites

  • info (dict) – Dictionnaire des informations extraites

lastrowid()

Récupérer l’identifiant du dernier enregistrement

Renvoie:

Identifiant du dernier enregistrement

Type renvoyé:

int ou None

rollback()

Annuler les enregistrements ajoutés.