geonature.core.gn_meta.models.commons

Module Contents

Classes

DateFilterSchema	Base schema class with which to define custom schemas.
MetadataFilterSchema	Base schema class with which to define custom schemas.
CorAcquisitionFrameworkActor	The base class of the SQLAlchemy.Model declarative model class.
CorDatasetActor	The base class of the SQLAlchemy.Model declarative model class.
CorDatasetProtocol	The base class of the SQLAlchemy.Model declarative model class.
TBibliographicReference	The base class of the SQLAlchemy.Model declarative model class.

Attributes

cor_acquisition_framework_objectif
cor_acquisition_framework_voletsinp
cor_acquisition_framework_territory
cor_dataset_territory

class geonature.core.gn_meta.models.commons.DateFilterSchema(*, only: marshmallow.types.StrSequenceOrSet | None = None, exclude: marshmallow.types.StrSequenceOrSet = (), many: bool = False, context: dict | None = None, load_only: marshmallow.types.StrSequenceOrSet = (), dump_only: marshmallow.types.StrSequenceOrSet = (), partial: bool | marshmallow.types.StrSequenceOrSet | None = None, unknown: str | None = None)

Bases: marshmallow.Schema

Base schema class with which to define custom schemas.

Example usage:

import datetime as dt
from dataclasses import dataclass

from marshmallow import Schema, fields


@dataclass
class Album:
    title: str
    release_date: dt.date


class AlbumSchema(Schema):
    title = fields.Str()
    release_date = fields.Date()


album = Album("Beggars Banquet", dt.date(1968, 12, 6))
schema = AlbumSchema()
data = schema.dump(album)
data  # {'release_date': '1968-12-06', 'title': 'Beggars Banquet'}

Paramètres:

• only – Whitelist of the declared fields to select when instantiating the Schema. If None, all fields are used. Nested fields can be represented with dot delimiters.

• exclude – Blacklist of the declared fields to exclude when instantiating the Schema. If a field appears in both only and exclude, it is not used. Nested fields can be represented with dot delimiters.

• many – Should be set to True if obj is a collection so that the object will be serialized to a list.

• context – Optional context passed to fields.Method and fields.Function fields.

• load_only – Fields to skip during serialization (write-only fields)

• dump_only – Fields to skip during deserialization (read-only fields)

• partial – Whether to ignore missing fields and not require any fields declared. Propagates down to Nested fields as well. If its value is an iterable, only missing fields listed in that iterable will be ignored. Use dot delimiters to specify nested fields.

• unknown – Whether to exclude, include, or raise an error for unknown fields in the data. Use EXCLUDE, INCLUDE or RAISE.

Modifié dans la version 3.0.0: prefix parameter removed.

Modifié dans la version 2.0.0: __validators__, __preprocessors__, and __data_handlers__ are removed in favor of marshmallow.decorators.validates_schema, marshmallow.decorators.pre_load and marshmallow.decorators.post_dump. __accessor__ and __error_handler__ are deprecated. Implement the handle_error and get_attribute methods instead.

year

month

day

class geonature.core.gn_meta.models.commons.MetadataFilterSchema(*, only: marshmallow.types.StrSequenceOrSet | None = None, exclude: marshmallow.types.StrSequenceOrSet = (), many: bool = False, context: dict | None = None, load_only: marshmallow.types.StrSequenceOrSet = (), dump_only: marshmallow.types.StrSequenceOrSet = (), partial: bool | marshmallow.types.StrSequenceOrSet | None = None, unknown: str | None = None)

Bases: marshmallow.Schema

Base schema class with which to define custom schemas.

Example usage:

import datetime as dt
from dataclasses import dataclass

from marshmallow import Schema, fields


@dataclass
class Album:
    title: str
    release_date: dt.date


class AlbumSchema(Schema):
    title = fields.Str()
    release_date = fields.Date()


album = Album("Beggars Banquet", dt.date(1968, 12, 6))
schema = AlbumSchema()
data = schema.dump(album)
data  # {'release_date': '1968-12-06', 'title': 'Beggars Banquet'}

Paramètres:

• only – Whitelist of the declared fields to select when instantiating the Schema. If None, all fields are used. Nested fields can be represented with dot delimiters.

• exclude – Blacklist of the declared fields to exclude when instantiating the Schema. If a field appears in both only and exclude, it is not used. Nested fields can be represented with dot delimiters.

• many – Should be set to True if obj is a collection so that the object will be serialized to a list.

• context – Optional context passed to fields.Method and fields.Function fields.

• load_only – Fields to skip during serialization (write-only fields)

• dump_only – Fields to skip during deserialization (read-only fields)

• partial – Whether to ignore missing fields and not require any fields declared. Propagates down to Nested fields as well. If its value is an iterable, only missing fields listed in that iterable will be ignored. Use dot delimiters to specify nested fields.

• unknown – Whether to exclude, include, or raise an error for unknown fields in the data. Use EXCLUDE, INCLUDE or RAISE.

Modifié dans la version 3.0.0: prefix parameter removed.

Modifié dans la version 2.0.0: __validators__, __preprocessors__, and __data_handlers__ are removed in favor of marshmallow.decorators.validates_schema, marshmallow.decorators.pre_load and marshmallow.decorators.post_dump. __accessor__ and __error_handler__ are deprecated. Implement the handle_error and get_attribute methods instead.

class Meta

unknown

uuid

name

date

person

organism

areas

search

convert_date(data, **kwargs)

geonature.core.gn_meta.models.commons.cor_acquisition_framework_objectif

geonature.core.gn_meta.models.commons.cor_acquisition_framework_voletsinp

geonature.core.gn_meta.models.commons.cor_acquisition_framework_territory

class geonature.core.gn_meta.models.commons.CorAcquisitionFrameworkActor

Bases: geonature.utils.env.DB.Model

The base class of the SQLAlchemy.Model declarative model class.

To define models, subclass db.Model, not this. To customize db.Model, subclass this and pass it as model_class to SQLAlchemy. To customize db.Model at the metaclass level, pass an already created declarative model class as model_class.

__tablename__ = 'cor_acquisition_framework_actor'

__table_args__

id_cafa

id_acquisition_framework

id_role

id_organism

id_nomenclature_actor_role

nomenclature_actor_role

role

organism

class geonature.core.gn_meta.models.commons.CorDatasetActor

Bases: geonature.utils.env.DB.Model

The base class of the SQLAlchemy.Model declarative model class.

To define models, subclass db.Model, not this. To customize db.Model, subclass this and pass it as model_class to SQLAlchemy. To customize db.Model at the metaclass level, pass an already created declarative model class as model_class.

__tablename__ = 'cor_dataset_actor'

__table_args__

id_cda

id_dataset

id_role

id_organism

id_nomenclature_actor_role

nomenclature_actor_role

role

organism

actor()

display()

class geonature.core.gn_meta.models.commons.CorDatasetProtocol

Bases: geonature.utils.env.DB.Model

The base class of the SQLAlchemy.Model declarative model class.

To define models, subclass db.Model, not this. To customize db.Model, subclass this and pass it as model_class to SQLAlchemy. To customize db.Model at the metaclass level, pass an already created declarative model class as model_class.

__tablename__ = 'cor_dataset_protocol'

__table_args__

id_cdp

id_dataset

id_protocol

geonature.core.gn_meta.models.commons.cor_dataset_territory

class geonature.core.gn_meta.models.commons.TBibliographicReference

Bases: geonature.utils.env.db.Model

The base class of the SQLAlchemy.Model declarative model class.

To define models, subclass db.Model, not this. To customize db.Model, subclass this and pass it as model_class to SQLAlchemy. To customize db.Model at the metaclass level, pass an already created declarative model class as model_class.

__tablename__ = 't_bibliographical_references'

__table_args__

id_bibliographic_reference

id_acquisition_framework

publication_url

publication_reference