mex.synopse.models package

Submodules

mex.synopse.models.project module

class mex.synopse.models.project.SynopseProject(*, Studie: str, ProjektStudientitel: str | None = None, BeschreibungStudie: str | None = None, StudienArtTyp: str, Projektbeginn: Annotated[int | None, Ge(ge=1891)] = None, Projektende: Annotated[int | None, Ge(ge=1891)] = None, Kontakt: list[str] = [], Beitragende: str | None = None, Partner_intern: str | None = None, VerantwortlicheOE: str | None = None, Partner_extern: str | None = None, Auftraggeber: str | None = None, Anschlussprojekt: str | None = None, Projektdokumentation: str | None = None, StudienID: str)

Bases: BaseModel

Model for synopse projects with aliases to match CSV columns.

akronym_des_studientitels: str

anschlussprojekt: str | None

beitragende: str | None

beschreibung_der_studie: str | None

externe_partner: str | None

foerderinstitution_oder_auftraggeber: str | None

get_contacts() → list[str]

Split the values for the kontakt field by comma into a list.

interne_partner: str | None

kontakt: list[str]

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'extra': 'ignore', 'populate_by_name': True, 'str_max_length': 100000, 'str_min_length': 1, 'str_strip_whitespace': True, 'use_enum_values': True, 'validate_assignment': True, 'validate_default': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'akronym_des_studientitels': FieldInfo(annotation=str, required=True, alias='Studie', alias_priority=2), 'anschlussprojekt': FieldInfo(annotation=Union[str, NoneType], required=False, default=None, alias='Anschlussprojekt', alias_priority=2), 'beitragende': FieldInfo(annotation=Union[str, NoneType], required=False, default=None, alias='Beitragende', alias_priority=2), 'beschreibung_der_studie': FieldInfo(annotation=Union[str, NoneType], required=False, default=None, alias='BeschreibungStudie', alias_priority=2), 'externe_partner': FieldInfo(annotation=Union[str, NoneType], required=False, default=None, alias='Partner_extern', alias_priority=2), 'foerderinstitution_oder_auftraggeber': FieldInfo(annotation=Union[str, NoneType], required=False, default=None, alias='Auftraggeber', alias_priority=2), 'interne_partner': FieldInfo(annotation=Union[str, NoneType], required=False, default=None, alias='Partner_intern', alias_priority=2), 'kontakt': FieldInfo(annotation=list[str], required=False, default=[], alias='Kontakt', alias_priority=2), 'project_studientitel': FieldInfo(annotation=Union[str, NoneType], required=False, default=None, alias='ProjektStudientitel', alias_priority=2), 'projektbeginn': FieldInfo(annotation=Union[int, NoneType], required=False, default=None, alias='Projektbeginn', alias_priority=2, metadata=[Ge(ge=1891)]), 'projektdokumentation': FieldInfo(annotation=Union[str, NoneType], required=False, default=None, alias='Projektdokumentation', alias_priority=2), 'projektende': FieldInfo(annotation=Union[int, NoneType], required=False, default=None, alias='Projektende', alias_priority=2, metadata=[Ge(ge=1891)]), 'studien_id': FieldInfo(annotation=str, required=True, alias='StudienID', alias_priority=2), 'studienart_studientyp': FieldInfo(annotation=str, required=True, alias='StudienArtTyp', alias_priority=2), 'verantwortliche_oe': FieldInfo(annotation=Union[str, NoneType], required=False, default=None, alias='VerantwortlicheOE', alias_priority=2)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

project_studientitel: str | None

projektbeginn: int | None

projektdokumentation: str | None

projektende: int | None

studien_id: str

studienart_studientyp: str

verantwortliche_oe: str | None

mex.synopse.models.study module

class mex.synopse.models.study.SynopseStudy(*, Titel_Datenset: str, Beschreibung: str | None = None, SchlagworteThemen: str | None = None, Dateiformat: str | None = None, Dokumentation: str | None = None, ErstellungsDatum: str | None = None, Version: str | None = None, Rechte: str | None = None, Lizenz: str | None = None, Plattform: str | None = None, PlattformAdresse: str | None = None, Zugangsbeschraenkung: str | None = None, StudienID: str, DStypID: int, Studie: str | None = None)

Bases: BaseModel

Model for synopse study data with aliases to match CSV columns.

beschreibung: str | None

dateiformat: str | None

dokumentation: str | None

ds_typ_id: int

erstellungs_datum: str | None

lizenz: str | None

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'extra': 'ignore', 'populate_by_name': True, 'str_max_length': 100000, 'str_min_length': 1, 'str_strip_whitespace': True, 'use_enum_values': True, 'validate_assignment': True, 'validate_default': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'beschreibung': FieldInfo(annotation=Union[str, NoneType], required=False, default=None, alias='Beschreibung', alias_priority=2), 'dateiformat': FieldInfo(annotation=Union[str, NoneType], required=False, default=None, alias='Dateiformat', alias_priority=2), 'dokumentation': FieldInfo(annotation=Union[str, NoneType], required=False, default=None, alias='Dokumentation', alias_priority=2), 'ds_typ_id': FieldInfo(annotation=int, required=True, alias='DStypID', alias_priority=2), 'erstellungs_datum': FieldInfo(annotation=Union[str, NoneType], required=False, default=None, alias='ErstellungsDatum', alias_priority=2), 'lizenz': FieldInfo(annotation=Union[str, NoneType], required=False, default=None, alias='Lizenz', alias_priority=2), 'plattform': FieldInfo(annotation=Union[str, NoneType], required=False, default=None, alias='Plattform', alias_priority=2), 'plattform_adresse': FieldInfo(annotation=Union[str, NoneType], required=False, default=None, alias='PlattformAdresse', alias_priority=2), 'rechte': FieldInfo(annotation=Union[str, NoneType], required=False, default=None, alias='Rechte', alias_priority=2), 'schlagworte_themen': FieldInfo(annotation=Union[str, NoneType], required=False, default=None, alias='SchlagworteThemen', alias_priority=2), 'studie': FieldInfo(annotation=Union[str, NoneType], required=False, default=None, alias='Studie', alias_priority=2), 'studien_id': FieldInfo(annotation=str, required=True, alias='StudienID', alias_priority=2), 'titel_datenset': FieldInfo(annotation=str, required=True, alias='Titel_Datenset', alias_priority=2), 'version': FieldInfo(annotation=Union[str, NoneType], required=False, default=None, alias='Version', alias_priority=2), 'zugangsbeschraenkung': FieldInfo(annotation=Union[str, NoneType], required=False, default=None, alias='Zugangsbeschraenkung', alias_priority=2)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

plattform: str | None

plattform_adresse: str | None

rechte: str | None

schlagworte_themen: str | None

studie: str | None

studien_id: str

titel_datenset: str

version: str | None

zugangsbeschraenkung: str | None

mex.synopse.models.study_overview module

class mex.synopse.models.study_overview.SynopseStudyOverview(*, StudienID: str, DStypID: int, Titel_Datenset: str, SynopseID: str)

Bases: BaseModel

Model for synopse study overview with aliases to match CSV columns.

ds_typ_id: int

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'extra': 'ignore', 'populate_by_name': True, 'str_max_length': 100000, 'str_min_length': 1, 'str_strip_whitespace': True, 'use_enum_values': True, 'validate_assignment': True, 'validate_default': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'ds_typ_id': FieldInfo(annotation=int, required=True, alias='DStypID', alias_priority=2), 'studien_id': FieldInfo(annotation=str, required=True, alias='StudienID', alias_priority=2), 'synopse_id': FieldInfo(annotation=str, required=True, alias='SynopseID', alias_priority=2), 'titel_datenset': FieldInfo(annotation=str, required=True, alias='Titel_Datenset', alias_priority=2)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

studien_id: str

synopse_id: str

titel_datenset: str

mex.synopse.models.variable module

class mex.synopse.models.variable.SynopseVariable(*, textbox49: str | None = None, textbox11: str | None = None, Originalfrage: str | None = None, StudieID2: int, StudieID1: str, SymopseID: str, textbox51: str | None = None, textbox5: str, textbox2: str, valInstrument: str | None = None, textbox21: str | None = None, textbox24: str)

Bases: BaseModel

Model class for Synopse variables.

auspraegungen: str | None

datentyp: str | None

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'coerce_numbers_to_str': True, 'extra': 'ignore', 'populate_by_name': True, 'str_max_length': 100000, 'str_min_length': 1, 'str_strip_whitespace': True, 'use_enum_values': True, 'validate_assignment': True, 'validate_default': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'auspraegungen': FieldInfo(annotation=Union[str, NoneType], required=False, default=None, alias='textbox49', alias_priority=2), 'datentyp': FieldInfo(annotation=Union[str, NoneType], required=False, default=None, alias='textbox11', alias_priority=2), 'originalfrage': FieldInfo(annotation=Union[str, NoneType], required=False, default=None, alias='Originalfrage', alias_priority=2), 'studie': FieldInfo(annotation=str, required=True, alias='StudieID1', alias_priority=2), 'studie_id': FieldInfo(annotation=int, required=True, alias='StudieID2', alias_priority=2), 'synopse_id': FieldInfo(annotation=str, required=True, alias='SymopseID', alias_priority=2), 'text_dt': FieldInfo(annotation=Union[str, NoneType], required=False, default=None, alias='textbox51', alias_priority=2), 'thema_und_fragebogenausschnitt': FieldInfo(annotation=str, required=True, alias='textbox5', alias_priority=2), 'unterthema': FieldInfo(annotation=str, required=True, alias='textbox2', alias_priority=2), 'val_instrument': FieldInfo(annotation=Union[str, NoneType], required=False, default=None, alias='valInstrument', alias_priority=2), 'varlabel': FieldInfo(annotation=Union[str, NoneType], required=False, default=None, alias='textbox21', alias_priority=2), 'varname': FieldInfo(annotation=str, required=True, alias='textbox24', alias_priority=2)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

originalfrage: str | None

studie: str

studie_id: int

synopse_id: str

text_dt: str | None

thema_und_fragebogenausschnitt: str

unterthema: str

val_instrument: str | None

varlabel: str | None

varname: str

Module contents