Méthodes des MTObject

Tous les objets du modèle (sauf les propriétés) héritent de la classe MTObject, et les objets quantifiables héritent de MTQuantifiables. Les fonctions ci-dessous sont donc accessibles pour tous les objets.

mtobjects.mtobject.MTObject

Classe mère des objets du modèle de Sinamet : Territory, Actor, Product, Gateflow, Pathflow, Stock

Parameters:

• properties –

  Liste des propriétés de l'objet

• type –

  type d'objet (parmis territory, actor, product, gateflow, pathflow, stock)

get_code

get_code(
    codes: Iterable[str] | str = [],
    /,
    *,
    date_point: str | date | None = None,
    return_type: Literal["value"] = "value",
    if_none: Literal["raise"],
    use_default: bool = False,
    force_cache: bool = False,
    if_many: Literal[
        "raise", "warn_first", "first"
    ] = "first",
    verbose: bool = False,
) -> str | int | float | MTObject | Geometry

get_code(
    codes: Iterable[str] | str = [],
    /,
    *,
    date_point: str | date | None = None,
    return_type: Literal["value"] = "value",
    if_none: Literal["raise"],
    use_default: bool = False,
    force_cache: bool = False,
    if_many: Literal["warn_list", "list"],
    verbose: bool = False,
) -> (
    str
    | int
    | float
    | MTObject
    | Geometry
    | list[str | int | float | MTObject | Geometry]
)

get_code(
    codes: Iterable[str] | str = [],
    /,
    *,
    date_point: str | date | None = None,
    return_type: Literal["value"] = "value",
    if_none: Literal["warn", None] = None,
    use_default: bool = False,
    force_cache: bool = False,
    if_many: Literal[
        "raise", "warn_first", "first"
    ] = "first",
    verbose: bool = False,
) -> str | int | float | MTObject | Geometry | None

get_code(
    codes: Iterable[str] | str = [],
    /,
    *,
    date_point: str | date | None = None,
    return_type: Literal["value"] = "value",
    if_none: Literal["warn", None] = None,
    use_default: bool = False,
    force_cache: bool = False,
    if_many: Literal["warn_list", "list"],
    verbose: bool = False,
) -> (
    str
    | int
    | float
    | MTObject
    | Geometry
    | None
    | list[str | int | float | MTObject | Geometry]
)

get_code(
    codes: Iterable[str] | str = [],
    /,
    *,
    date_point: str | date | None = None,
    return_type: Literal["property"],
    if_none: Literal["raise"],
    use_default: bool = False,
    force_cache: bool = False,
    if_many: Literal[
        "raise", "warn_first", "first"
    ] = "first",
    verbose: bool = False,
) -> Property

get_code(
    codes: Iterable[str] | str = [],
    /,
    *,
    date_point: str | date | None = None,
    return_type: Literal["property"],
    if_none: Literal["raise"],
    use_default: bool = False,
    force_cache: bool = False,
    if_many: Literal["warn_list", "list"],
    verbose: bool = False,
) -> Property | list[Property]

get_code(
    codes: Iterable[str] | str = [],
    /,
    *,
    date_point: str | date | None = None,
    return_type: Literal["property"],
    if_none: Literal["warn", None] = None,
    use_default: bool = False,
    force_cache: bool = False,
    if_many: Literal[
        "raise", "warn_first", "first"
    ] = "first",
    verbose: bool = False,
) -> Property | None

get_code(
    codes: Iterable[str] | str = [],
    /,
    *,
    date_point: str | date | None = None,
    return_type: Literal["property"],
    if_none: Literal["warn", None] = None,
    use_default: bool = False,
    force_cache: bool = False,
    if_many: Literal["warn_list", "list"],
    verbose: bool = False,
) -> Property | list[Property] | None

get_code(
    codes: Iterable[str] | str = [],
    /,
    *,
    date_point: str | date | None = None,
    return_type: Literal["tuple"],
    if_none: Literal["raise"],
    use_default: bool = False,
    force_cache: bool = False,
    if_many: Literal[
        "raise", "warn_first", "first"
    ] = "first",
    verbose: bool = False,
) -> tuple[str | int | float | MTObject | Geometry, str]

get_code(
    codes: Iterable[str] | str = [],
    /,
    *,
    date_point: str | date | None = None,
    return_type: Literal["tuple"],
    if_none: Literal["raise"],
    use_default: bool = False,
    force_cache: bool = False,
    if_many: Literal["warn_list", "list"],
    verbose: bool = False,
) -> (
    tuple[str | int | float | MTObject | Geometry, str]
    | list[
        tuple[str | int | float | MTObject | Geometry, str]
    ]
)

get_code(
    codes: Iterable[str] | str = [],
    /,
    *,
    date_point: str | date | None = None,
    return_type: Literal["tuple"],
    if_none: Literal["warn", None] = None,
    use_default: bool = False,
    force_cache: bool = False,
    if_many: Literal[
        "raise", "warn_first", "first"
    ] = "first",
    verbose: bool = False,
) -> (
    tuple[str | int | float | MTObject | Geometry, str]
    | None
)

get_code(
    codes: Iterable[str] | str = [],
    /,
    *,
    date_point: str | date | None = None,
    return_type: Literal["tuple"],
    if_none: Literal["warn", None] = None,
    use_default: bool = False,
    force_cache: bool = False,
    if_many: Literal["warn_list", "list"],
    verbose: bool = False,
) -> (
    tuple[str | int | float | MTObject | Geometry, str]
    | None
    | list[
        tuple[str | int | float | MTObject | Geometry, str]
    ]
)

get_code(
    codes=[],
    /,
    *,
    date_point=None,
    return_type="value",
    if_none=None,
    use_default=False,
    force_cache=False,
    if_many="first",
    verbose=False,
)

Renvoie le code recherché.

Fonction wrapper de get_property_gen, avec prop_name='Code'

get_name

get_name(
    names: Iterable[str] | str = [],
    /,
    *,
    date_point: str | date | None = None,
    return_type: Literal["value"] = "value",
    if_none: Literal["raise"],
    use_default: bool = False,
    force_cache: bool = False,
    if_many: Literal[
        "raise", "warn_first", "first"
    ] = "first",
    verbose: bool = False,
) -> str | int | float | MTObject | Geometry

get_name(
    names: Iterable[str] | str = [],
    /,
    *,
    date_point: str | date | None = None,
    return_type: Literal["value"] = "value",
    if_none: Literal["raise"],
    use_default: bool = False,
    force_cache: bool = False,
    if_many: Literal["warn_list", "list"],
    verbose: bool = False,
) -> (
    str
    | int
    | float
    | MTObject
    | Geometry
    | list[str | int | float | MTObject | Geometry]
)

get_name(
    names: Iterable[str] | str = [],
    /,
    *,
    date_point: str | date | None = None,
    return_type: Literal["value"] = "value",
    if_none: Literal["warn", None] = None,
    use_default: bool = False,
    force_cache: bool = False,
    if_many: Literal[
        "raise", "warn_first", "first"
    ] = "first",
    verbose: bool = False,
) -> str | int | float | MTObject | Geometry | None

get_name(
    names: Iterable[str] | str = [],
    /,
    *,
    date_point: str | date | None = None,
    return_type: Literal["value"] = "value",
    if_none: Literal["warn", None] = None,
    use_default: bool = False,
    force_cache: bool = False,
    if_many: Literal["warn_list", "list"],
    verbose: bool = False,
) -> (
    str
    | int
    | float
    | MTObject
    | Geometry
    | None
    | list[str | int | float | MTObject | Geometry]
)

get_name(
    names: Iterable[str] | str = [],
    /,
    *,
    date_point: str | date | None = None,
    return_type: Literal["property"],
    if_none: Literal["raise"],
    use_default: bool = False,
    force_cache: bool = False,
    if_many: Literal[
        "raise", "warn_first", "first"
    ] = "first",
    verbose: bool = False,
) -> Property

get_name(
    names: Iterable[str] | str = [],
    /,
    *,
    date_point: str | date | None = None,
    return_type: Literal["property"],
    if_none: Literal["raise"],
    use_default: bool = False,
    force_cache: bool = False,
    if_many: Literal["warn_list", "list"],
    verbose: bool = False,
) -> Property | list[Property]

get_name(
    names: Iterable[str] | str = [],
    /,
    *,
    date_point: str | date | None = None,
    return_type: Literal["property"],
    if_none: Literal["warn", None] = None,
    use_default: bool = False,
    force_cache: bool = False,
    if_many: Literal[
        "raise", "warn_first", "first"
    ] = "first",
    verbose: bool = False,
) -> Property | None

get_name(
    names: Iterable[str] | str = [],
    /,
    *,
    date_point: str | date | None = None,
    return_type: Literal["property"],
    if_none: Literal["warn", None] = None,
    use_default: bool = False,
    force_cache: bool = False,
    if_many: Literal["warn_list", "list"],
    verbose: bool = False,
) -> Property | list[Property] | None

get_name(
    names: Iterable[str] | str = [],
    /,
    *,
    date_point: str | date | None = None,
    return_type: Literal["tuple"],
    if_none: Literal["raise"],
    use_default: bool = False,
    force_cache: bool = False,
    if_many: Literal[
        "raise", "warn_first", "first"
    ] = "first",
    verbose: bool = False,
) -> tuple[str | int | float | MTObject | Geometry, str]

get_name(
    names: Iterable[str] | str = [],
    /,
    *,
    date_point: str | date | None = None,
    return_type: Literal["tuple"],
    if_none: Literal["raise"],
    use_default: bool = False,
    force_cache: bool = False,
    if_many: Literal["warn_list", "list"],
    verbose: bool = False,
) -> (
    tuple[str | int | float | MTObject | Geometry, str]
    | list[
        tuple[str | int | float | MTObject | Geometry, str]
    ]
)

get_name(
    names: Iterable[str] | str = [],
    /,
    *,
    date_point: str | date | None = None,
    return_type: Literal["tuple"],
    if_none: Literal["warn", None] = None,
    use_default: bool = False,
    force_cache: bool = False,
    if_many: Literal[
        "raise", "warn_first", "first"
    ] = "first",
    verbose: bool = False,
) -> (
    tuple[str | int | float | MTObject | Geometry, str]
    | None
)

get_name(
    names: Iterable[str] | str = [],
    /,
    *,
    date_point: str | date | None = None,
    return_type: Literal["tuple"],
    if_none: Literal["warn", None] = None,
    use_default: bool = False,
    force_cache: bool = False,
    if_many: Literal["warn_list", "list"],
    verbose: bool = False,
) -> (
    tuple[str | int | float | MTObject | Geometry, str]
    | None
    | list[
        tuple[str | int | float | MTObject | Geometry, str]
    ]
)

get_name(
    names=[],
    /,
    *,
    date_point=None,
    return_type="value",
    if_none=None,
    use_default=False,
    force_cache=False,
    if_many="first",
    verbose=False,
)

Renvoie le nom recherché.

Fonction wrapper de get_property_gen, avec prop_name='Name'

get_property

get_property(
    full_name: str,
    /,
    *,
    date_point: str | date | None = None,
    return_type: Literal["value"] = "value",
    if_none: Literal["raise"],
    use_default: bool = False,
    force_cache: bool = False,
    if_many: Literal[
        "raise", "warn_first", "first"
    ] = "first",
    verbose: bool = False,
) -> str | int | float | MTObject | Geometry

get_property(
    full_name: str,
    /,
    *,
    date_point: str | date | None = None,
    return_type: Literal["value"] = "value",
    if_none: Literal["raise"],
    use_default: bool = False,
    force_cache: bool = False,
    if_many: Literal["warn_list", "list"],
    verbose: bool = False,
) -> (
    str
    | int
    | float
    | MTObject
    | Geometry
    | list[str | int | float | MTObject | Geometry]
)

get_property(
    full_name: str,
    /,
    *,
    date_point: str | date | None = None,
    return_type: Literal["value"] = "value",
    if_none: Literal["warn", None] = None,
    use_default: bool = False,
    force_cache: bool = False,
    if_many: Literal[
        "raise", "warn_first", "first"
    ] = "first",
    verbose: bool = False,
) -> str | int | float | MTObject | Geometry | None

get_property(
    full_name: str,
    /,
    *,
    date_point: str | date | None = None,
    return_type: Literal["value"] = "value",
    if_none: Literal["warn", None] = None,
    use_default: bool = False,
    force_cache: bool = False,
    if_many: Literal["warn_list", "list"],
    verbose: bool = False,
) -> (
    str
    | int
    | float
    | MTObject
    | Geometry
    | None
    | list[str | int | float | MTObject | Geometry]
)

get_property(
    full_name: str,
    /,
    *,
    date_point: str | date | None = None,
    return_type: Literal["property"],
    if_none: Literal["raise"],
    use_default: bool = False,
    force_cache: bool = False,
    if_many: Literal[
        "raise", "warn_first", "first"
    ] = "first",
    verbose: bool = False,
) -> Property

get_property(
    full_name: str,
    /,
    *,
    date_point: str | date | None = None,
    return_type: Literal["property"],
    if_none: Literal["raise"],
    use_default: bool = False,
    force_cache: bool = False,
    if_many: Literal["warn_list", "list"],
    verbose: bool = False,
) -> Property | list[Property]

get_property(
    full_name: str,
    /,
    *,
    date_point: str | date | None = None,
    return_type: Literal["property"],
    if_none: Literal["warn", None] = None,
    use_default: bool = False,
    force_cache: bool = False,
    if_many: Literal[
        "raise", "warn_first", "first"
    ] = "first",
    verbose: bool = False,
) -> Property | None

get_property(
    full_name: str,
    /,
    *,
    date_point: str | date | None = None,
    return_type: Literal["property"],
    if_none: Literal["warn", None] = None,
    use_default: bool = False,
    force_cache: bool = False,
    if_many: Literal["warn_list", "list"],
    verbose: bool = False,
) -> Property | list[Property] | None

get_property(
    full_name: str,
    /,
    *,
    date_point: str | date | None = None,
    return_type: Literal["tuple"],
    if_none: Literal["raise"],
    use_default: bool = False,
    force_cache: bool = False,
    if_many: Literal[
        "raise", "warn_first", "first"
    ] = "first",
    verbose: bool = False,
) -> tuple[str | int | float | MTObject | Geometry, str]

get_property(
    full_name: str,
    /,
    *,
    date_point: str | date | None = None,
    return_type: Literal["tuple"],
    if_none: Literal["raise"],
    use_default: bool = False,
    force_cache: bool = False,
    if_many: Literal["warn_list", "list"],
    verbose: bool = False,
) -> (
    tuple[str | int | float | MTObject | Geometry, str]
    | list[
        tuple[str | int | float | MTObject | Geometry, str]
    ]
)

get_property(
    full_name: str,
    /,
    *,
    date_point: str | date | None = None,
    return_type: Literal["tuple"],
    if_none: Literal["warn", None] = None,
    use_default: bool = False,
    force_cache: bool = False,
    if_many: Literal[
        "raise", "warn_first", "first"
    ] = "first",
    verbose: bool = False,
) -> (
    tuple[str | int | float | MTObject | Geometry, str]
    | None
)

get_property(
    full_name: str,
    /,
    *,
    date_point: str | date | None = None,
    return_type: Literal["tuple"],
    if_none: Literal["warn", None] = None,
    use_default: bool = False,
    force_cache: bool = False,
    if_many: Literal["warn_list", "list"],
    verbose: bool = False,
) -> (
    tuple[str | int | float | MTObject | Geometry, str]
    | None
    | list[
        tuple[str | int | float | MTObject | Geometry, str]
    ]
)

get_property(
    full_name,
    /,
    *,
    date_point=None,
    return_type="value",
    if_none=None,
    use_default=False,
    force_cache=False,
    if_many="warn_first",
    verbose=False,
)

Renvoie la propriété recherchée.

Fonction wrapper de get_property_gen, prenant le nom complet de la propriété recherchée.

get_property_gen

get_property_gen(
    prop_name,
    prop_type=[],
    /,
    *,
    date_point=None,
    return_type="value",
    if_none=None,
    use_default=False,
    force_cache=False,
    if_many="warn_first",
    verbose=False,
)

Fonction qui renvoie la ou les propriétés correspondantes aux arguments.

Examples:

>>> charente = get_territory("Name", "Charente")
>>> charente.get_property_gen("Population", date_point="01/01/2023")
351036.0
>>> charente.get_property_gen("Name", ["fr", "en"]) or "-"  # `or` pour gérer une valeur par défaut

Parameters:

• prop_name (str) –

  Nom de la propriété.

• prop_type (Iterable[str] | str, default: [] ) –

  Si précisé recherche une propriété avec la précision donnée. Sinon, recherche une propriété sans précision.

• date_point (str | date | None, default: None ) –

  Dâte de la propriété recherchée.

• return_type (str, default: 'value' ) –

  Type de retour de la fonction. Valeurs possibles:

  • value: La valeur uniquement (ex. "FR").
  • property: L'object propriété (ex. ).
  • tuple: Un tuple avec comme premier élément la valeur, et en deuxième le type de la propriété (ex. ("FR", "isoa2")).
• if_none (Literal['raise', 'warn', None], default: None ) –

  Comportement en cas de propriété non trouvée: lève un erreur (raise), affiche un avertissement (warn) ou renvoie None (défaut).

• use_default (bool, default: False ) –

  Si prop_type pas trouvé, renvoie la première propriété correspondant à prop_name.

• force_cache (bool, default: False ) –

  Ne refait pas d'appel à la base de donnée et utilise les propriétés déjà mise en cache.

• if_many (str, default: 'warn_first' ) –

  Comportement en cas de plusieurs propriétés correspondantes au même nom ou code. Valeurs possibles:

  • raise: Lève une erreur.
  • warn_first: Avertit puis renvoie la première valeur.
  • warn_list: Avertit puis renvoie la liste.
  • first: Renvoie la première valeur.
  • list: Renvoie la liste.
• verbose (bool, default: False ) –

  Si True, décrit le déroulement de la fonction dans le shell.

Returns:

• str | int | float | MTObject | Geometry –

  La valeur de la propriété.

• Property –

  L'object Property lui-même.

• tuple[str | int | float | MTObject | Geometry, str] –

  Le tuple contenant la valeur de la propriété et la précision de la propriété.

• None –

  Aucune propriété n'a été trouvée.

Raises:

• ValueError –

  Si la valeur de return_type ou if_many est incorrecte.

• SidbNotFoundError –

  Si aucune propriété n'a été trouvée et que if_none == 'raise'.

• SidbMultiFoundError –

  Si plusieurs propriétés correspondent et que if_many == 'raise'.

Warns:

• UserWarning –

  Plusieurs propriétés correspondantes et if_many est warn_first ou warn_list.

get_codes

get_codes(
    codes: Iterable[str] = [],
    /,
    *,
    date_point: str | date | None = None,
    date_start: str | date | None = None,
    date_end: str | date | None = None,
    return_type: Literal["value"] = "value",
    if_none: Literal["raise", "warn", None] = None,
    use_default: bool = False,
    force_cache: bool = False,
    verbose: bool = False,
) -> list[str | int | float | MTObject | Geometry]

get_codes(
    codes: Iterable[str] = [],
    /,
    *,
    date_point: str | date | None = None,
    date_start: str | date | None = None,
    date_end: str | date | None = None,
    return_type: Literal["property"],
    if_none: Literal["raise", "warn", None] = None,
    use_default: bool = False,
    force_cache: bool = False,
    verbose: bool = False,
) -> list[Property]

get_codes(
    codes: Iterable[str] = [],
    /,
    *,
    date_point: str | date | None = None,
    date_start: str | date | None = None,
    date_end: str | date | None = None,
    return_type: Literal["tuple"],
    if_none: Literal["raise", "warn", None] = None,
    use_default: bool = False,
    force_cache: bool = False,
    verbose: bool = False,
) -> list[
    tuple[str | int | float | MTObject | Geometry, str]
]

get_codes(
    codes: Iterable[str] = [],
    /,
    *,
    date_point: str | date | None = None,
    date_start: str | date | None = None,
    date_end: str | date | None = None,
    return_type: Literal["dict"],
    if_none: Literal["raise", "warn", None] = None,
    use_default: bool = False,
    force_cache: bool = False,
    verbose: bool = False,
) -> dict[str, str | int | float | MTObject | Geometry]

get_codes(
    codes: Iterable[str] = [],
    /,
    *,
    date_point: str | date | None = None,
    date_start: str | date | None = None,
    date_end: str | date | None = None,
    return_type: Literal["profile"],
    if_none: Literal["raise", "warn", None] = None,
    use_default: bool = False,
    force_cache: bool = False,
    verbose: bool = False,
) -> Profile

get_codes(
    codes=[],
    /,
    *,
    date_point=None,
    date_start=None,
    date_end=None,
    return_type="value",
    if_none=None,
    use_default=False,
    force_cache=False,
    verbose=False,
)

Renvoie les codes recherchés.

Fonction wrapper de get_properties_gen, avec prop_name='Code'

get_names

get_names(
    names: Iterable[str] = [],
    /,
    *,
    date_point: str | date | None = None,
    date_start: str | date | None = None,
    date_end: str | date | None = None,
    return_type: Literal["value"] = "value",
    if_none: Literal["raise", "warn", None] = None,
    use_default: bool = False,
    force_cache: bool = False,
    verbose: bool = False,
) -> list[str | int | float | MTObject | Geometry]

get_names(
    names: Iterable[str] = [],
    /,
    *,
    date_point: str | date | None = None,
    date_start: str | date | None = None,
    date_end: str | date | None = None,
    return_type: Literal["property"],
    if_none: Literal["raise", "warn", None] = None,
    use_default: bool = False,
    force_cache: bool = False,
    verbose: bool = False,
) -> list[Property]

get_names(
    names: Iterable[str] = [],
    /,
    *,
    date_point: str | date | None = None,
    date_start: str | date | None = None,
    date_end: str | date | None = None,
    return_type: Literal["tuple"],
    if_none: Literal["raise", "warn", None] = None,
    use_default: bool = False,
    force_cache: bool = False,
    verbose: bool = False,
) -> list[
    tuple[str | int | float | MTObject | Geometry, str]
]

get_names(
    names: Iterable[str] = [],
    /,
    *,
    date_point: str | date | None = None,
    date_start: str | date | None = None,
    date_end: str | date | None = None,
    return_type: Literal["dict"],
    if_none: Literal["raise", "warn", None] = None,
    use_default: bool = False,
    force_cache: bool = False,
    verbose: bool = False,
) -> dict[str, str | int | float | MTObject | Geometry]

get_names(
    names: Iterable[str] = [],
    /,
    *,
    date_point: str | date | None = None,
    date_start: str | date | None = None,
    date_end: str | date | None = None,
    return_type: Literal["profile"],
    if_none: Literal["raise", "warn", None] = None,
    use_default: bool = False,
    force_cache: bool = False,
    verbose: bool = False,
) -> Profile

get_names(
    names=[],
    /,
    *,
    date_point=None,
    date_start=None,
    date_end=None,
    return_type="value",
    if_none=None,
    use_default=False,
    force_cache=False,
    verbose=False,
)

Renvoie les noms recherchés.

Fonction wrapper de [get_properties_gen] [mtobjects.mtobject.MTObject.get_properties_gen], avec prop_name='Code'

get_properties

get_properties(
    full_name: str,
    /,
    *,
    date_point: str | date | None = None,
    date_start: str | date | None = None,
    date_end: str | date | None = None,
    return_type: Literal["value"] = "value",
    if_none: Literal["raise", "warn", None] = None,
    use_default: bool = False,
    force_cache: bool = False,
    verbose: bool = False,
) -> list[str | int | float | MTObject | Geometry]

get_properties(
    full_name: str,
    /,
    *,
    date_point: str | date | None = None,
    date_start: str | date | None = None,
    date_end: str | date | None = None,
    return_type: Literal["property"],
    if_none: Literal["raise", "warn", None] = None,
    use_default: bool = False,
    force_cache: bool = False,
    verbose: bool = False,
) -> list[Property]

get_properties(
    full_name: str,
    /,
    *,
    date_point: str | date | None = None,
    date_start: str | date | None = None,
    date_end: str | date | None = None,
    return_type: Literal["tuple"],
    if_none: Literal["raise", "warn", None] = None,
    use_default: bool = False,
    force_cache: bool = False,
    verbose: bool = False,
) -> list[
    tuple[str | int | float | MTObject | Geometry, str]
]

get_properties(
    full_name: str,
    /,
    *,
    date_point: str | date | None = None,
    date_start: str | date | None = None,
    date_end: str | date | None = None,
    return_type: Literal["dict"],
    if_none: Literal["raise", "warn", None] = None,
    use_default: bool = False,
    force_cache: bool = False,
    verbose: bool = False,
) -> dict[str, str | int | float | MTObject | Geometry]

get_properties(
    full_name: str,
    /,
    *,
    date_point: str | date | None = None,
    date_start: str | date | None = None,
    date_end: str | date | None = None,
    return_type: Literal["profile"],
    if_none: Literal["raise", "warn", None] = None,
    use_default: bool = False,
    force_cache: bool = False,
    verbose: bool = False,
) -> Profile

get_properties(
    full_name,
    /,
    *,
    date_point=None,
    date_start=None,
    date_end=None,
    return_type="value",
    if_none=None,
    use_default=False,
    force_cache=False,
    verbose=False,
)

Renvoie les propriétés recherchées.

Fonction wrapper de get_properties_gen, prenant le nom complet des propriétés recherchées.

get_properties_gen

get_properties_gen(
    prop_name,
    prop_types=[],
    date_point=None,
    date_start=None,
    date_end=None,
    return_type="value",
    if_none=None,
    use_default=False,
    force_cache=False,
    verbose=False,
)

Fonction qui renvoie les propriétés correspondantes aux arguments.

Examples:

>>> france = get_territory("Name", "France")
>>> france.get_properties_gen("Code", ["isoa2", "isoa3"])
["FR", "FRA"]

Parameters:

• prop_name (str) –

  Nom de la propriété.

• prop_types (Iterable[str], default: [] ) –

  Si précisé recherche les propriétés avec les précision données. Sinon, recherche toutes les propriétés.

• return_type (str, default: 'value' ) –

  Type de retour de la fonction. Valeurs possibles:

  • value: Les valeurs uniquement (ex. ["FR", "FRA"]).
  • property: Les objects Property (ex. [, ]).
  • tuple: Une liste de tuples avec comme premier élément la valeur, et en deuxième le type de la propriété (ex. [("FR", "isoa2"), ("FRA", "isoa3")]).
  • dict: Un dictionnaire (ex. {"isoa2": "FR", "isoa3": "FRA"}). Attention si une précision comporte plusieurs propriétés.
  • profile: L'object Profile contenant les propriétés recherchées.
• if_none (Literal['raise', 'warn', None], default: None ) –

  Comportement en cas de propriété non trouvée: lève un erreur (raise), affiche un avertissement (warn) ou renvoie une liste vide (défaut).

• use_default (bool, default: False ) –

  Renvoie toutes les propriétés en commençant par celles indiquées dans prop_type.

• force_cache (bool, default: False ) –

  Ne refait pas d'appel à la base de donnée et utilise les propriétés déjà mise en cache.

• verbose (bool, default: False ) –

  Si True, décrit le déroulement de la fonction dans le shell.

Returns:

• list[str | int | float | MTObject | Geometry] –

  La liste des valeurs des propriétés recherchées.

• list[Property] –

  La liste des objects Property recherchés.

• list[tuple[str | int | float | MTObject | Geometry], str] –

  La liste des tuples contenants les valeurs des propriétés et leurs précisions.

• dict[str, str | int | float | MTObject, Geometry] –

  Un dictionnaire avec comme clés les précisions des propriétés, et comme valeurs leurs valeurs.

• Profile –

  L'object Profile contenant les propriétés recherchées.

Raises:

• ValueError –

  Si la valeur de return_type est incorrecte.

• SidbNotFoundError –

  Si aucune propriété n'a été trouvée et que if_none == 'raise'.

get_source_ref

get_source_ref(*, force_cache=False)

Renvoie les sources des propriétés de l'object.

Parameters:

• force_cache (bool, default: False ) –

  Si True, n'utilise que les propriétés déjà présentes en cache.

Returns:

• str –

  La liste des sources des propriétés de l'object, en chaîne de caractères, séparées par des virgules.

get_children

get_children(depth=1)

Renvoie les enfants de l'object.

Parameters:

• depth (int, default: 1 ) –

  Profondeur maximale de recherche.

Returns:

• list[MTObject] –

  La liste des enfants de l'object.

is_in

is_in(mtobject, force_cache=False, include_self=True)

Détermine si un autre objet est contenu dans cet objet.

Parameters:

• mtobject (MTObject) –

  L'objet dont on veut vérifier s'il se trouve dans cet objet.

• force_cache (bool, default: False ) –

  Si True, utilise uniquement les propriétés mises en cache, et ne fait pas de requète sur la base de données.

Returns:

• bool –

  True si l'objet mtobject est contenu dans cet objet, False sinon.

mtobjects.quantifiable.MTQuantifiable

Classe mère des objets quantifiables du modèle de Sinamet : Gateflow, Pathflow, Stock

Parameters:

• properties –

  Liste des propriétés de l'objet

• type –

  type d'objet (parmis gateflow, pathflow, stock)

• product –

  Produit associé à l'élément quantifiable

• quantity –

  Dictionnaire de la quantité dans différentes unités

• date_start –

  Repère temporel (Début) de l'élément quantifiable

• date_end –

  Repère temporel (Fin) de l'élément quantifiable

• date_point –

  Repère temporel (Date ponctuelle) de l'élément quantifiable

get_quantity

get_quantity(unit, error='raise')

Retourne une quantité.

Parameters:

• unit (str) –

  Unité de la quantité (euro, kg, ...).

• error (Literal['raise', 'none', 'print'], default: 'raise' ) –

  Comportement à adopter en cas d'erreur.

FutureDev

Remasteriser cette fonction.