pyspc.core.ratingcurve.RatingCurves

class pyspc.core.ratingcurve.RatingCurves(name='rtc')

Bases : OrderedDict

Structure de données pour manipuler une collection de courbes de tarage

codes

Codes “station” des courbes de tarage

Type:

list

nums

Identifiants des courbes de tarage

Type:

list

providers

Identifiants des fournisseurs des courbes de tarage

Type:

list

timeintervals

Périodes de validité des courbes de tarage (valeur) par station (clé)

Type:

dict

name

Nom de la collection

Type:

str

Voir aussi

pyspc.core.ratingcurve.RatingCurve

__init__(name='rtc')

Initialiser l’instance de RatingCurves

datatype

Type de la collection

Type:

str

name

Nom de la collection. Par défaut: “series”

Type:

str

Methods

__init__([name])	Initialiser l'instance de RatingCurves
add([curve, overwrite, refresh])	Ajouter une courbe de tarage dans la collection
check_overlapping(code)	Contrôler si au moins deux intervalles temporels se recouvrent en partie.
clear()
copy()
extend([curves, overwrite])	Alimenter la collection à partir d'une autre collection
fromkeys(iterable[, value])	Create a new ordered dictionary with keys from iterable and values set to value.
get(key[, default])	Return the value for key if key is in the dictionary, else default.
items()	Return a set-like object providing a view on the dict's items.
keys()	Return a set-like object providing a view on the dict's keys.
move_to_end(key[, last])	Move an existing element to the end (or beginning if last is false).
pop(key[,default])	If the key is not found, return the default if given; otherwise, raise a KeyError.
popitem([last])	Remove and return a (key, value) pair from the dictionary.
refresh()	Rafraîchir les informations de la collection
refresh_codes()	Rafraîchir la liste des codes
refresh_nums()	Rafraîchir la liste des identifiants
refresh_providers()	Rafraîchir la liste des sources
refresh_timeintervals()	Rafraîchir le dictionnaire des périodes de validité
select([codes, nums, providers, start, end])	Sélectionner des éléments pour construire une nouvelle collection.
setdefault(key[, default])	Insert key with a value of default if key is not in the dictionary.
update([E, ]**F)	If E is present and has a .keys() method, then does: for k in E.keys(): D[k] = E[k] If E is present and lacks a .keys() method, then does: for k, v in E: D[k] = v In either case, this is followed by: for k in F: D[k] = F[k]
values()	Return an object providing a view on the dict's values.

Attributes

codes	Codes 'station' des courbes de tarage
name	Nom de la collection de courbes de tarage
nums	Identifiants des courbes de tarage
providers	Identifiants des fournisseurs des courbes de tarage
timeintervals	Périodes de validité des courbes de tarage par station

add(curve=None, overwrite=False, refresh=True)

Ajouter une courbe de tarage dans la collection

Paramètres:

• curve (RatingCurve) – Courbe de tarage

• overwrite (bool) – Écraser la donnée existante ? défaut: False

• refresh (bool) – Rafraîchir les informations de la collection. Par défaut: True

check_overlapping(code)

Contrôler si au moins deux intervalles temporels se recouvrent en partie.

Paramètres:

code (str) – Code “station” des courbes de tarage

Lève:

ValueError – Si au moins deux intervalles temporels se recouvrent en partie

clear() → None.  Remove all items from od.

property codes

Codes “station” des courbes de tarage

copy() → a shallow copy of od

extend(curves=None, overwrite=False)

Alimenter la collection à partir d’une autre collection

Paramètres:

• curves (RatingCurves) – Collection d’origine

• overwrite (bool) – Écraser la donnée existante ? défaut: False

classmethod fromkeys(iterable, value=None)

Create a new ordered dictionary with keys from iterable and values set to value.

get(key, default=None, /)

Return the value for key if key is in the dictionary, else default.

items()

Return a set-like object providing a view on the dict’s items.

keys()

Return a set-like object providing a view on the dict’s keys.

move_to_end(key, last=True)

Move an existing element to the end (or beginning if last is false).

Raise KeyError if the element does not exist.

property name

Nom de la collection de courbes de tarage

property nums

Identifiants des courbes de tarage

pop(key[, default]) → v, remove specified key and return the corresponding value.

If the key is not found, return the default if given; otherwise, raise a KeyError.

popitem(last=True)

Remove and return a (key, value) pair from the dictionary.

Pairs are returned in LIFO order if last is true or FIFO order if false.

property providers

Identifiants des fournisseurs des courbes de tarage

refresh()

Rafraîchir les informations de la collection

refresh_codes()

Rafraîchir la liste des codes

refresh_nums()

Rafraîchir la liste des identifiants

refresh_providers()

Rafraîchir la liste des sources

refresh_timeintervals()

Rafraîchir le dictionnaire des périodes de validité

select(codes=None, nums=None, providers=None, start=None, end=None)

Sélectionner des éléments pour construire une nouvelle collection.

Paramètres:

• codes (list) – Codes “station” des courbes de tarage

• nums (list) – Identifiants des courbes de tarage

• providers (list) – Identifiants des fournisseurs des courbes de tarage

• start (datetime) – Date de début de la période considérée

• end (datetime) – Date de fin de la période considérée

Renvoie:

Nouvelle collection

Type renvoyé:

pyspc.core.ratingcurve.RatingCurves

Notes

La sélection temporelle repose sur le principe suivant:

• si start est défini, la fin de validité des courbes doit être postérieure à cette date

• si end est défini, le début de validité des courbes doit être antérieur à cette date

setdefault(key, default=None)

Insert key with a value of default if key is not in the dictionary.

Return the value for key if key is in the dictionary, else default.

property timeintervals

Périodes de validité des courbes de tarage par station

update([E, ]**F) → None.  Update D from mapping/iterable E and F.

If E is present and has a .keys() method, then does: for k in E.keys(): D[k] = E[k] If E is present and lacks a .keys() method, then does: for k, v in E: D[k] = v In either case, this is followed by: for k in F: D[k] = F[k]

values()

Return an object providing a view on the dict’s values.