geonature.core.imports.models

Attributes

cor_role_import
cor_role_mapping

Classes

ImportModule	The base class of the SQLAlchemy.Model declarative model class.
ImportUserErrorType	The base class of the SQLAlchemy.Model declarative model class.
ImportUserError	The base class of the SQLAlchemy.Model declarative model class.
Destination	The base class of the SQLAlchemy.Model declarative model class.
BibThemes	The base class of the SQLAlchemy.Model declarative model class.
EntityField	The base class of the SQLAlchemy.Model declarative model class.
Entity	The base class of the SQLAlchemy.Model declarative model class.
InstancePermissionMixin
TImports	The base class of the SQLAlchemy.Model declarative model class.
CorImportDataset	The base class of the SQLAlchemy.Model declarative model class.
BibFields	The base class of the SQLAlchemy.Model declarative model class.
MappingTemplate	The base class of the SQLAlchemy.Model declarative model class.
FieldMapping	The base class of the SQLAlchemy.Model declarative model class.
ContentMapping	The base class of the SQLAlchemy.Model declarative model class.
ObserverMapping	The base class of the SQLAlchemy.Model declarative model class.

Functions

optional_conditions_to_jsonschema(→ dict)	Convert optional conditions into a JSON schema.
get_fields_of_an_entity(→ List[BibFields])	Get all BibFields associated with a given entity.

Module Contents

class geonature.core.imports.models.ImportModule

Bases: geonature.core.gn_commons.models.TModules

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.

__mapper_args__

generate_module_url_for_source(source)

class geonature.core.imports.models.ImportUserErrorType

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__ = 'bib_errors_types'

__table_args__

pk

category

name

description

level

__str__()

class geonature.core.imports.models.ImportUserError

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_user_errors'

__table_args__

pk

id_import

imprt

id_type

type

column

rows

comment

id_entity

entity

__str__()

class geonature.core.imports.models.Destination

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__ = 'bib_destinations'

__table_args__

id_destination

id_module

code

label

table_name

active

module

entities

get_transient_table()

property validity_columns

property statistics_labels

property actions

static allowed_destinations(user: pypnusershub.db.models.User | None = None, action_code: str = 'C') → List[Destination]

Return a list of allowed destinations for a given user and an action.

Parameters

userUser, optional

The user to filter destinations for. If not provided, the current_user is used.

actionstr

The action to filter destinations for. Possible values are “C”, “R”, “U”, “V”, “E”, “D”.

Returns

allowed_destinationList of Destination

List of allowed destinations for the given user.

classmethod filter_by_role(user: pypnusershub.db.models.User | None = None, action_code: str = 'C', **kwargs)

Filter Destination by role.

Parameters

userUser, optional

The user to filter destinations for. If not provided, the current_user is used.

Returns

sqlalchemy.sql.elements.BinaryExpression

A filter criterion for the id_destination column of the Destination table.

has_instance_permission(user: pypnusershub.db.models.User | None = None, action_code: str = 'C')

Check if a user has the permissions to do an action on this destination.

Parameters

userUser, optional

The user to check the permission for. If not provided, the current_user is used.

action_codestr

The action to check the permission for. Possible values are “C”, “R”, “U”, “V”, “E”, “D”.

Returns

bool

True if the user has the right to do the action on this destination, False otherwise.

__repr__()

class geonature.core.imports.models.BibThemes

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__ = 'bib_themes'

__table_args__

id_theme

name_theme

fr_label_theme

eng_label_theme

desc_theme

order_theme

class geonature.core.imports.models.EntityField

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_entity_field'

__table_args__

id_entity

entity

id_field

field

desc_field

id_theme

theme

order_field

comment

class geonature.core.imports.models.Entity

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__ = 'bib_entities'

__table_args__

id_entity

id_destination

destination

code

label

order

validity_column

destination_table_schema

destination_table_name

id_unique_column

id_uuid_column

id_parent

parent

childs

fields

unique_column

uuid_column

id_object

object

get_destination_table()

__repr__()

class geonature.core.imports.models.InstancePermissionMixin

get_instance_permissions(scopes, user=None)

geonature.core.imports.models.cor_role_import

class geonature.core.imports.models.TImports

Bases: InstancePermissionMixin, 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_imports'

__table_args__

AVAILABLE_ENCODINGS

AVAILABLE_FORMATS = ['csv', 'geojson']

AVAILABLE_SEPARATORS = [',', ';']

id_import

id_destination

destination

format_source_file

srid

separator

detected_separator

encoding

detected_encoding

full_file_name

date_create_import

date_update_import

date_end_import

source_count

erroneous_rows

statistics

date_min_data

date_max_data

uuid_autogenerated

altitude_autogenerated

authors

loaded

processed

source_file

columns

fieldmapping

contentmapping

observermapping

task_id

errors

datasets

property cruved

errors_count

property task_progress

property has_closed_af

Check if one AF of the import has been closed. Returns ——-

raise_on_closed_af()

has_instance_permission(scope, user=None, action_code='C')

static filter_by_scope(scope, user=None, **kwargs)

as_dict(import_as_dict)

class geonature.core.imports.models.CorImportDataset

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_import_datasets'

__table_args__

id_import

id_dataset

imprt

dataset

class geonature.core.imports.models.BibFields

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__ = 'bib_fields'

__table_args__

id_field

id_destination

destination

name_field

source_field

dest_field

fr_label

eng_label

type_field

type_field_params

mandatory

autogenerated

mnemonique

nomenclature_type

display

multi

optional_conditions

mandatory_conditions

entities

property source_column

property dest_column

__repr__()

geonature.core.imports.models.cor_role_mapping

class geonature.core.imports.models.MappingTemplate

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_mappings'

__table_args__

id

id_destination

destination

label

type

active

public

property cruved

__mapper_args__

owners

has_instance_permission(scope: int, user=None)

static filter_by_scope(scope, user=None)

geonature.core.imports.models.optional_conditions_to_jsonschema(name_field: str, optional_conditions: Iterable[str]) → dict

Convert optional conditions into a JSON schema.

Parameters

name_fieldstr

The name of the field.

optional_conditionsIterable[str]

The optional conditions.

Returns

dict

The JSON schema.

Notes

The JSON schema is created to ensure that if any of the optional conditions is not provided, the name_field is required.

geonature.core.imports.models.get_fields_of_an_entity(entity: Entity, columns: List[str] | None = None, optional_where_clause: Any | None = None) → List[BibFields]

Get all BibFields associated with a given entity.

Parameters

entityEntity

The entity to get the fields for.

columnsOptional[List[str]], optional

The columns to retrieve. If None, all columns are retrieved.

optional_where_clauseOptional[Any], optional

An optional where clause to apply to the query.

Returns

List[BibFields]

The BibFields associated with the given entity.

class geonature.core.imports.models.FieldMapping

Bases: MappingTemplate

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_fieldmappings'

__table_args__

id

values

__mapper_args__

static validate_values(field_mapping_json, destination=None)

Validate the field mapping values returned by the client form.

Parameters

field_mapping_jsondict

The field mapping values.

Raises

ValueError

If the field mapping values are invalid.

class geonature.core.imports.models.ContentMapping

Bases: MappingTemplate

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_contentmappings'

__table_args__

id

values

__mapper_args__

static validate_values(values, destination=None)

class geonature.core.imports.models.ObserverMapping

Bases: MappingTemplate

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_observermappings'

__table_args__

id

values

__mapper_args__

static validate_values(values, destination=None)