mex.extractors.synopse.models package

Submodules

mex.extractors.synopse.models.project module

class mex.extractors.synopse.models.project.SynopseProject(*, Studie: str | None = None, ProjektStudientitel: str | None, BeschreibungStudie: str | None = None, StudienArtTyp: str | None = None, Projektbeginn: Annotated[str | None, Ge(ge=1891)] = None, Projektende: Annotated[str | None, Ge(ge=1891)] = None, 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: BaseRawData

Model for synopse projects with aliases to match CSV columns.

akronym_des_studientitels: str | None

anschlussprojekt: str | None

beitragende: str | None

beschreibung_der_studie: str | None

externe_partner: str | None

foerderinstitution_oder_auftraggeber: str | None

get_end_year() → TemporalEntity | None

Return end year from extractor.

get_identifier_in_primary_source() → str | None

Return identifier in primary source from extractor.

get_partners() → Sequence[str | None]

Return partners from extractor.

get_start_year() → TemporalEntity | None

Return start year from extractor.

get_units() → Sequence[str | None]

Return units from extractor.

interne_partner: str | None

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_by_alias': True, 'validate_by_name': True, 'validate_default': True}

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

project_studientitel: str | None

projektbeginn: str | None

projektdokumentation: str | None

projektende: str | None

studien_id: str

studienart_studientyp: str | None

verantwortliche_oe: str | None

mex.extractors.synopse.models.study module

class mex.extractors.synopse.models.study.SynopseStudy(*, Beschreibung: str | None = None, Bevoelkerungsabdeckung: str | None = None, Dateiformat: str | None = None, Dokumentation: str | None = None, DStypID: int, ErstellungsDatum: str | None = None, Feldende: str | None = None, feld_start: str | None = None, HerkunftDerDaten: str | None = None, Lizenz: str | None = None, DatumDerLetztenAenderung: str | None = None, Plattform: str | None = None, PlattformAdresse: str | None = None, Rechte: str | None = None, RaeumlicherBezug: str | None = None, SchlagworteThemen: str | None = None, Studie: str | None = None, StudienID: str, Titel_Datenset: str, TypischesAlterMax: str | None = None, TypischesAlterMin: str | None = None, Version: str | None = None, Zugangsbeschraenkung: str, ZweckDerDatenverarbeitung: str | None = None)

Bases: BaseModel

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

beschreibung: str | None

bevoelkerungsabdeckung: str | None

dateiformat: str | None

datum_der_letzten_aenderung: str | None

dokumentation: str | None

ds_typ_id: int

erstellungs_datum: str | None

feld_ende: str | None

feld_start: str | None

herkunft_der_daten: str | None

lizenz: str | None

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_by_alias': True, 'validate_by_name': True, 'validate_default': True}

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

plattform: str | None

plattform_adresse: str | None

raeumlicher_bezug: str | None

rechte: str | None

schlagworte_themen: str | None

studie: str | None

studien_id: str

titel_datenset: str

typisches_alter_max: str | None

typisches_alter_min: str | None

version: str | None

zugangsbeschraenkung: str

zweck: str | None

mex.extractors.synopse.models.study_overview module

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

Bases: BaseModel

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

ds_typ_id: int | None

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_by_alias': True, 'validate_by_name': True, 'validate_default': True}

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

studien_id: str

synopse_id: str

titel_datenset: str

mex.extractors.synopse.models.variable module

class mex.extractors.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, IntVar: bool, KeepVarname: bool)

Bases: BaseModel

Model class for Synopse variables.

auspraegungen: str | None

datentyp: str | None

int_var: bool

keep_varname: bool

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_by_alias': True, 'validate_by_name': True, 'validate_default': True}

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

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