geonature.core.gn_synthese.schemas
==================================

.. py:module:: geonature.core.gn_synthese.schemas


Classes
-------

.. autoapisummary::

   geonature.core.gn_synthese.schemas.ReportTypeSchema
   geonature.core.gn_synthese.schemas.ReportSchema
   geonature.core.gn_synthese.schemas.SourceSchema
   geonature.core.gn_synthese.schemas.SyntheseConverter
   geonature.core.gn_synthese.schemas.SyntheseSchema


Module Contents
---------------

.. py:class:: ReportTypeSchema(*args, **kwargs)

   Bases: :py:obj:`geonature.utils.env.ma.SQLAlchemyAutoSchema`


   SQLAlchemyAutoSchema that automatically generates marshmallow fields
   from a SQLAlchemy model's or table's column.
   Uses the scoped session from Flask-SQLAlchemy by default.

   See `marshmallow_sqlalchemy.SQLAlchemyAutoSchema` for more details
   on the `SQLAlchemyAutoSchema` API.


   .. py:class:: Meta

      Options object for a Schema.

      Example usage: ::

          from marshmallow import Schema


          class MySchema(Schema):
              class Meta:
                  fields = ("id", "email", "date_created")
                  exclude = ("password", "secret_attribute")

      .. admonition:: A note on type checking

          Type checkers will only check the attributes of the `Meta <marshmallow.Schema.Meta>`
          class if you explicitly subclass `marshmallow.Schema.Meta`.

          .. code-block:: python

              from marshmallow import Schema


              class MySchema(Schema):
                  # Not checked by type checkers
                  class Meta:
                      additional = True


              class MySchema2(Schema):
                  # Type checkers will check attributes
                  class Meta(Schema.Meta):
                      additional = True  # Incompatible types in assignment

      .. versionremoved:: 3.0.0b7 Remove ``strict``.
      .. versionadded:: 3.0.0b12 Add `unknown`.
      .. versionchanged:: 3.0.0b17 Rename ``dateformat`` to `datetimeformat`.
      .. versionadded:: 3.9.0 Add `timeformat`.
      .. versionchanged:: 3.26.0 Deprecate ``ordered``. Field order is preserved by default.
      .. versionremoved:: 4.0.0 Remove ``ordered``.


      .. py:attribute:: model



.. py:class:: ReportSchema(*args, **kwargs)

   Bases: :py:obj:`utils_flask_sqla.schema.SmartRelationshipsMixin`, :py:obj:`geonature.utils.env.ma.SQLAlchemyAutoSchema`


   This mixin automatically exclude from serialization:

   * Nested, RelatedList and Related fields
   * all fields with exclude=True in their metadata (e.g. ``fields.String(metadata={'exclude': True})``)
   * For SQLAlchemyAutoSchema, all deffered columns

   Default marshmallow behaviour is to serialize only fields specified in ``only``. This mixin add these:

   * If they are only Nested fields in ``only``, they are added to serialized fields *along with* default serialized fields.
   * To serialize Nested fields only and not default serialized fields, add ``"-"`` special value to ``only``.
   * To add excluded fields (through metadata or deffered fields) to the serialization *in addition* to default serialized fields,
     use '+field_name' syntax.

   Examples :

   .. code-block:: python

      class FooSchema(SmartRelationshipsMixin):
          id = fields.Int()
          name = field.Str()
          default_excluded_field = fields.Str(metadata={"exclude": True})
          relationship = fields.Nested(OtherSchema) # or field.RelatedList() / field.Related()

      FooSchema().dump() -> {"id": 1, "name": "toto" }
      FooSchema(only=["id"]).dump() -> {"id": 1}
      FooSchema(only=["default_excluded_field"]).dump() -> {"default_excluded_field": "test"}
      FooSchema(only=["+default_excluded_field"]).dump() -> {"id": 1, "name": "toto", "default_excluded_field": "test"}
      FooSchema(only=["relationship"]).dump() -> {"id": 1, "name": "toto",  "relationship": {OtherSchema...} }
      FooSchema(only=["id", "relationship"]).dump() -> {"id": 1, "relationship": {OtherSchema...}}
      FooSchema(only=["-", "relationship"]).dump() -> {"relationship": {OtherSchema...}}


   .. py:class:: Meta

      Options object for a Schema.

      Example usage: ::

          from marshmallow import Schema


          class MySchema(Schema):
              class Meta:
                  fields = ("id", "email", "date_created")
                  exclude = ("password", "secret_attribute")

      .. admonition:: A note on type checking

          Type checkers will only check the attributes of the `Meta <marshmallow.Schema.Meta>`
          class if you explicitly subclass `marshmallow.Schema.Meta`.

          .. code-block:: python

              from marshmallow import Schema


              class MySchema(Schema):
                  # Not checked by type checkers
                  class Meta:
                      additional = True


              class MySchema2(Schema):
                  # Type checkers will check attributes
                  class Meta(Schema.Meta):
                      additional = True  # Incompatible types in assignment

      .. versionremoved:: 3.0.0b7 Remove ``strict``.
      .. versionadded:: 3.0.0b12 Add `unknown`.
      .. versionchanged:: 3.0.0b17 Rename ``dateformat`` to `datetimeformat`.
      .. versionadded:: 3.9.0 Add `timeformat`.
      .. versionchanged:: 3.26.0 Deprecate ``ordered``. Field order is preserved by default.
      .. versionremoved:: 4.0.0 Remove ``ordered``.


      .. py:attribute:: model



   .. py:attribute:: report_type


   .. py:attribute:: user


.. py:class:: SourceSchema(*args, **kwargs)

   Bases: :py:obj:`geonature.utils.env.ma.SQLAlchemyAutoSchema`


   SQLAlchemyAutoSchema that automatically generates marshmallow fields
   from a SQLAlchemy model's or table's column.
   Uses the scoped session from Flask-SQLAlchemy by default.

   See `marshmallow_sqlalchemy.SQLAlchemyAutoSchema` for more details
   on the `SQLAlchemyAutoSchema` API.


   .. py:class:: Meta

      Options object for a Schema.

      Example usage: ::

          from marshmallow import Schema


          class MySchema(Schema):
              class Meta:
                  fields = ("id", "email", "date_created")
                  exclude = ("password", "secret_attribute")

      .. admonition:: A note on type checking

          Type checkers will only check the attributes of the `Meta <marshmallow.Schema.Meta>`
          class if you explicitly subclass `marshmallow.Schema.Meta`.

          .. code-block:: python

              from marshmallow import Schema


              class MySchema(Schema):
                  # Not checked by type checkers
                  class Meta:
                      additional = True


              class MySchema2(Schema):
                  # Type checkers will check attributes
                  class Meta(Schema.Meta):
                      additional = True  # Incompatible types in assignment

      .. versionremoved:: 3.0.0b7 Remove ``strict``.
      .. versionadded:: 3.0.0b12 Add `unknown`.
      .. versionchanged:: 3.0.0b17 Rename ``dateformat`` to `datetimeformat`.
      .. versionadded:: 3.9.0 Add `timeformat`.
      .. versionchanged:: 3.26.0 Deprecate ``ordered``. Field order is preserved by default.
      .. versionremoved:: 4.0.0 Remove ``ordered``.


      .. py:attribute:: model


      .. py:attribute:: load_instance
         :value: True




   .. py:attribute:: module_url


.. py:class:: SyntheseConverter(schema_cls: type[marshmallow.Schema] | None = None)

   Bases: :py:obj:`pypnnomenclature.utils.NomenclaturesConverter`, :py:obj:`utils_flask_sqla_geo.schema.GeoModelConverter`


   Converts a SQLAlchemy model into a dictionary of corresponding
   marshmallow `Fields <marshmallow.fields.Field>`.


.. py:class:: SyntheseSchema(*args, **kwargs)

   Bases: :py:obj:`utils_flask_sqla.schema.SmartRelationshipsMixin`, :py:obj:`utils_flask_sqla_geo.schema.GeoAlchemyAutoSchema`


   This mixin automatically exclude from serialization:

   * Nested, RelatedList and Related fields
   * all fields with exclude=True in their metadata (e.g. ``fields.String(metadata={'exclude': True})``)
   * For SQLAlchemyAutoSchema, all deffered columns

   Default marshmallow behaviour is to serialize only fields specified in ``only``. This mixin add these:

   * If they are only Nested fields in ``only``, they are added to serialized fields *along with* default serialized fields.
   * To serialize Nested fields only and not default serialized fields, add ``"-"`` special value to ``only``.
   * To add excluded fields (through metadata or deffered fields) to the serialization *in addition* to default serialized fields,
     use '+field_name' syntax.

   Examples :

   .. code-block:: python

      class FooSchema(SmartRelationshipsMixin):
          id = fields.Int()
          name = field.Str()
          default_excluded_field = fields.Str(metadata={"exclude": True})
          relationship = fields.Nested(OtherSchema) # or field.RelatedList() / field.Related()

      FooSchema().dump() -> {"id": 1, "name": "toto" }
      FooSchema(only=["id"]).dump() -> {"id": 1}
      FooSchema(only=["default_excluded_field"]).dump() -> {"default_excluded_field": "test"}
      FooSchema(only=["+default_excluded_field"]).dump() -> {"id": 1, "name": "toto", "default_excluded_field": "test"}
      FooSchema(only=["relationship"]).dump() -> {"id": 1, "name": "toto",  "relationship": {OtherSchema...} }
      FooSchema(only=["id", "relationship"]).dump() -> {"id": 1, "relationship": {OtherSchema...}}
      FooSchema(only=["-", "relationship"]).dump() -> {"relationship": {OtherSchema...}}


   .. py:class:: Meta

      Options object for a Schema.

      Example usage: ::

          from marshmallow import Schema


          class MySchema(Schema):
              class Meta:
                  fields = ("id", "email", "date_created")
                  exclude = ("password", "secret_attribute")

      .. admonition:: A note on type checking

          Type checkers will only check the attributes of the `Meta <marshmallow.Schema.Meta>`
          class if you explicitly subclass `marshmallow.Schema.Meta`.

          .. code-block:: python

              from marshmallow import Schema


              class MySchema(Schema):
                  # Not checked by type checkers
                  class Meta:
                      additional = True


              class MySchema2(Schema):
                  # Type checkers will check attributes
                  class Meta(Schema.Meta):
                      additional = True  # Incompatible types in assignment

      .. versionremoved:: 3.0.0b7 Remove ``strict``.
      .. versionadded:: 3.0.0b12 Add `unknown`.
      .. versionchanged:: 3.0.0b17 Rename ``dateformat`` to `datetimeformat`.
      .. versionadded:: 3.9.0 Add `timeformat`.
      .. versionchanged:: 3.26.0 Deprecate ``ordered``. Field order is preserved by default.
      .. versionremoved:: 4.0.0 Remove ``ordered``.


      .. py:attribute:: model


      .. py:attribute:: exclude
         :value: ('the_geom_4326_geojson',)



      .. py:attribute:: include_fk
         :value: True



      .. py:attribute:: load_instance
         :value: True



      .. py:attribute:: sqla_session


      .. py:attribute:: feature_id
         :value: 'id_synthese'



      .. py:attribute:: feature_geometry
         :value: 'the_geom_4326'



      .. py:attribute:: model_converter



   .. py:attribute:: the_geom_4326


   .. py:attribute:: the_geom_authorized


   .. py:attribute:: source


   .. py:attribute:: module


   .. py:attribute:: dataset


   .. py:attribute:: habitat


   .. py:attribute:: digitiser


   .. py:attribute:: cor_observers


   .. py:attribute:: medias


   .. py:attribute:: areas


   .. py:attribute:: area_attachment


   .. py:attribute:: validations


   .. py:attribute:: last_validation


   .. py:attribute:: reports