mex.extractors.synopse.models package

Submodules

mex.extractors.synopse.models.project module

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

Bases: BaseRawData

Model for synopse projects with aliases to match CSV columns.

anschlussprojekt: str | None

auftraggeber: str | None

beitragende: str | None

beschreibung_studie: 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[__annotationlib_name_1__]

Return partners from extractor.

get_start_year() → TemporalEntity | None

Return start year from extractor.

get_units() → Sequence[__annotationlib_name_1__]

Return units from extractor.

model_config = {'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].

partner_extern: str | None

partner_intern: str | None

projekt_studientitel: str | None

projektbeginn: str | None

projektdokumentation: str | None

projektende: str | None

studie: str | None

studien_art_typ: str | None

studien_id: str

verantwortliche_oe: str | None

mex.extractors.synopse.models.study module

class mex.extractors.synopse.models.study.MetadatenZuDatensaetzen(*, StudienID: str, DStypID: int, Titel_Datenset: str, Beschreibung: str | None = None, SchlagworteThemen: str | None = None, Rechte: str | None = None, Zugangsbeschraenkung: str, TypischesAlterMax: int | None = None, TypischesAlterMin: int | None = None, RaeumlicherBezug: str | None = None, Feldstart: str | None = None, Feldende: str | None = None, ZweckDerDatenverarbeitung: str | None = None, DatumDerLetztenAenderung: str | None = None, Bevoelkerungsabdeckung: str | None = None, HerkunftDerDaten: str | None = None)

Bases: BaseModel

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

beschreibung: str | None

bevoelkerungsabdeckung: str | None

datum_der_letzten_aenderung: str | None

dstyp_id: int

feldende: str | None

feldstart: str | None

herkunft_der_daten: str | None

model_config = {'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].

raeumlicher_bezug: str | None

rechte: str | None

schlagworte_themen: str | None

studien_id: str

titel_datenset: str

typisches_alter_max: int | None

typisches_alter_min: int | None

zugangsbeschraenkung: str

zweck_der_datenverarbeitung: str | None

mex.extractors.synopse.models.study_overview module

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

Bases: BaseModel

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

dstyp_id: int | None

model_config = {'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.Variablenuebersicht(*, textbox5: str, valInstrument: str | None = None, textbox11: str | None = None, Originalfrage: str | None = None, SymopseID: str, textbox21: str | None = None, textbox24: str, textbox51: str | None = None, IntVar: bool, StudieID2: int)

Bases: BaseModel

Model class for Synopse variables.

int_var: bool

model_config = {'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_id2: int

symopse_id: str

textbox11: str | None

textbox21: str | None

textbox24: str

textbox5: str

textbox51: str | None

val_instrument: str | None

Module contents