pydantic_for_lingrel2025.py

#!/usr/bin/env -S uv run --script
# /// script
# dependencies = ["pydantic"]
# ///

# 2025.10.26 TV

from enum import Enum
from typing import Optional
from pydantic import BaseModel, Field


class LangCode(str, Enum):
    """A language code contains its ISO 639-3 code, followed by code(s) for its dialect or orthography, or both
    """

    # "fenno-ugric langages {{{
    izh = ("izh",)  # isuri (Ingeri)
    izh_alamaluuga = ("izh_alamaluuga",)
    izh_mehmet = ("izh_mehmet",)
    izh_soikkola = ("izh_soikkola",)
    kca = ("kca",)  # handi
    kca_kazym = ("kca_kazym",)
    kca_kazym_2013 = ("kca_kazym_2013",)  # new orthography
    kca_kazym_2000 = ("kca_kazym_2000",)  # old orthography
    kca_priur = ("kca_priur",)
    kca_shur = ("kca_shur",)
    kca_shur_2013 = ("kca_shur_2013",)
    kca_shur_2000 = ("kca_shur_2000",)
    kca_sred = ("kca_sred",)
    kca_surgut = ("kca_surgut",)
    kca_surgut_2013 = ("kca_surgut_2013",)  # new orthography
    kca_surgut_2000 = ("kca_surgut_2000",)  # old orthography
    kca_unk = ("kca_unk",)
    kca_vakh = ("kca_vakh",)
    kca_vakh2 = (
        "kca_vakh2",
    )  # for kca ouipiir _dictation 
    kca_vakh_2013 = ("kca_vakh_2013",)  # new orthography
    kca_vakh_2000 = ("kca_vakh_2000",)  # old orthography
    koi = ("koi",)  # permikomi
    kpv = ("kpv",)  # sürjakomi
    krl = ("krl",)  # karjala = krl_viena + krl_suvi + krl_tver
    krl_cyr = ("krl_cyr",)  # cyrillic orthography
    krl_viena = ("krl_viena",)  # North or Viena Karelian
    krl_suvi = ("krl_suvi",)  # South or Suvi Karelian
    krl_tver = ("krl_tver",)  # Tver Karelian
    # "dialec" vepkar korpusest {{
    krl_Dyorzha = ("krl_Dyorzha",)
    krl_Ilomantsi = ("krl_Ilomantsi",)
    krl_Keret = ("krl_Keret",)
    krl_Kestenga = ("krl_Kestenga",)
    krl_Kontokki = ("krl_Kontokki",)
    krl_Korbiselga = ("krl_Korbiselga",)
    krl_Maslozero = ("krl_Maslozero",)
    krl_Myandyselga = ("krl_Myandyselga",)
    krl_Newwritten = ("krl_Newwritten",)  # New written Karelian
    krl_NewwrittenTver = ("krl_NewwrittenTver",)
    krl_Oldwritten = ("krl_Oldwritten",)  # Old written Karelian
    krl_Oldwritten_cyr = ("krl_Oldwritten_cyr",)  # cyrillic orthography
    krl_OldwrittenTver = ("krl_OldwrittenTver",)
    krl_OldwrittenTver_cyr = ("krl_OldwrittenTver_cyr",)  # cyrillic orthography
    krl_Oulanga = ("krl_Oulanga",)
    krl_Padany = ("krl_Padany",)
    krl_Panozero = ("krl_Panozero",)
    krl_Poduzhemye = ("krl_Poduzhemye",)
    krl_Porosozero = ("krl_Porosozero",)
    krl_Reboly = ("krl_Reboly",)
    krl_Rugozero = ("krl_Rugozero",)
    krl_Suistamo = ("krl_Suistamo",)
    krl_Suoyarvi = ("krl_Suoyarvi",)
    krl_Tikhtozero = ("krl_Tikhtozero",)
    krl_Tikhvin = ("krl_Tikhvin",)
    krl_Tolmachi = ("krl_Tolmachi",)
    krl_Tunguda = ("krl_Tunguda",)
    krl_Uhta = ("krl_Uhta",)
    krl_Valdai = ("krl_Valdai",)
    krl_Vesyegonsk = ("krl_Vesyegonsk",)
    krl_Voknavolok = ("krl_Voknavolok",)
    krl_Vychetaibola = ("krl_Vychetaibola",)
    krl_Yushkozero = ("krl_Yushkozero",)
    lud_Mikhailovskoye = ("lud_Mikhailovskoye",)
    lud_Newwritten = ("lud_Newwritten",)  # New written Ludian
    lud_Northern = ("lud_Northern",)  # Northern Ludian (Kondopoga)
    lud_Central = ("lud_Central",)  # Central Ludian (Munozero)
    lud_Southern = ("lud_Southern",)  # Southern Ludian (Svjatozero)
    olo_Newwritten = ("olo_Newwritten",)  # New written Livvic
    olo_Oldwritten = ("olo_Oldwritten",)  # Old written Livvic
    olo_Oldwritten_cyr = ("olo_Oldwritten_cyr",)  # cyrillic orthography
    olo_Impilahti = ("olo_Impilahti",)
    olo_Kondushi = ("olo_Kondushi",)
    olo_Kotkozero = ("olo_Kotkozero",)
    olo_Nekkula = ("olo_Nekkula",)
    olo_Rypushkalitsa = ("olo_Rypushkalitsa",)
    olo_Salmi = ("olo_Salmi",)
    olo_Suoyarvi = ("olo_Suoyarvi",)
    olo_Syamozero = ("olo_Syamozero",)
    olo_Tulmozero = ("olo_Tulmozero",)
    olo_Vedlozero = ("olo_Vedlozero",)
    olo_Vidlitsa = ("olo_Vidlitsa",)
    vep_Newwritten = ("vep_Newwritten",)  # New written Veps
    vep_CentralEastern = ("vep_CentralEastern",)  # Central Eastern Veps
    vep_CentralWestern = ("vep_CentralWestern",)  # Central Western Veps
    vep_Northern = ("vep_Northern",)  # Northern Veps
    vep_Southern = ("vep_Southern",)  # Southern Veps
    # }} "dialect" vepkar korpusest
    liv = ("liv",)  # liivi
    liv_standard = ("liv_standard",)  # liivi keel (standard)
    liv_ft = ("liv_ft",)  # liivi phonetic transcription
    liv_av = ("liv_av",)  # liivi lemmas
    liv_idaliivi_ft = (
        "liv_idaliivi_ft",
    )  # liivi keel, idaliivi, phonetic transcription
    liv_lääneliivi_ft = (
        "liv_lääneliivi_ft",
    )  # liivi keel, lääneliivi, phonetic transcription
    liv_ira_ft = (
        "liv_ira_ft",
    )  # liivi keel, iraliivi, phonetic transcription
    lud = ("lud",)  # lüüdi (= karjala-lüüdi)
    lud_miikul = ("lud_miikul",)  #
    mdf = ("mdf",)  # mokša
    mhr = ("mhr",)  # ida- ja niidumari
    mns = ("mns",)  # mansi
    mns_unk = ("mns_unk",)  # mansi
    mns_sosv = ("mns_sosv",)  # mansi sosvinskiy/сосьвинский dialect
    mns_obs = ("mns_obs",)  # mansi obski/Обский dialect
    mns_verh = ("mns_verh",)  # mansi verhne-lozvinskiy/верхне-лозьвинский dialect
    mrj = ("mrj",)  # mäemari
    myv = ("myv",)  # ersa
    olo = ("olo",)  # livviko = Livvi-Karelian = Olonets
    sjd = (
        "sjd",
    )  # kildini saami 
    sjd_kuruch = ("sjd_kuruch",)  # kildini saami
    sjd_antonova = ("sjd_antonova",)  # kildini saami
    sje = ("sje",)  # pite saami
    sju = ("sju",)  # Ume saami
    sma = ("sma",)  # lõunasaami
    sme = ("sme",)  # põhjasaami
    smj = ("smj",)  # lule saami
    smn = ("smn",)  # inarisaami
    sms = ("sms",)  # koltasaami
    udm = ("udm",)  # udmurdi
    vep = ("vep",)  # vepsa
    vot = ("vot",)  # vadja
    vot_standard = ("vot_standard",)  # vadja standard
    vot_i = ("vot_i",)  # vadja dialekt
    vot_j = ("vot_j",)  # vadja dialekt
    vot_ja = ("vot_ja",)  # vadja dialekt
    vot_k = ("vot_k",)  # vadja dialekt
    vot_ke = ("vot_ke",)  # vadja dialekt
    vot_ko = ("vot_ko",)  # vadja dialekt
    vot_kõ = ("vot_kõ",)  # vadja dialekt
    vot_l = ("vot_l",)  # vadja dialekt
    vot_li = ("vot_li",)  # vadja dialekt
    vot_lu = ("vot_lu",)  # vadja dialekt
    vot_m = ("vot_m",)  # vadja dialekt
    vot_p = ("vot_p",)  # vadja dialekt
    vot_po = ("vot_po",)  # vadja dialekt
    vot_r = ("vot_r",)  # vadja dialekt
    vot_ra = ("vot_ra",)  # vadja dialekt
    vot_s = ("vot_s",)  # vadja dialekt
    vot_u = ("vot_u",)  # vadja dialekt
    vot_unk = ("vot_unk",)  # vadja dialekt
    vot_v = ("vot_v",)  # vadja dialekt
    vot_läänevadja_ft = (
        "vot_läänevadja_ft",
    )  # vadja keel, läänevadja, phonetic transcription
    vot_idavadja_ft = (
        "vot_idavadja_ft",
    )  # vadja keel, idavadja, phonetic transcription
    fkv = ("fkv",)  # kveeni (Kven Finnish)
    fit = ("fit",)  # Meä keel (Tornedalian Finnish)

    # Estonian dialects
    """An Estonian dialect code contains est, followed by dialect, posssibly followed by code(s) for county and source
    """
    est_vro_x = ("est_vro_x",)
    est_vro_seto = ("est_vro_seto",)
    est_vro_seto_setom = ("est_vro_seto_setom",)
    est_vro_stand_uma = ("est_vro_stand_uma",)
    est_vro_stand_sõnaq = ("est_vro_stand_sõnaq",)
    # }}}
    est_alutaguse_iis = ("est_alutaguse_iis",)  # iisaku
    est_alutaguse_jõh_ems = ("est_alutaguse_jõh_ems",)  # jõhvi, EKI murdesõnastikust
    est_alutaguse_lüg_ems = ("est_alutaguse_lüg_ems",)  # lüganuse, EKI murdesõnastikust
    est_alutaguse_vai = ("est_alutaguse_vai",)  # iisaku
    est_ranna_jõe_ems = ("est_ranna_jõe_ems",)  # jõelähtme  EKI murdesõnastikust
    est_ranna_kuu_ems = ("est_ranna_kuu_ems",)  # kuusalu  EKI murdesõnastikust
    est_ranna_kuu_ekidct = (
        "est_ranna_kuu_ekidct",
    )  # kuusalu, EKI xml sõnastik 
    est_ranna_hlj_ems = ("est_ranna_hljems",)  # haljala EKI murdesõnastikust
    est_ranna_vng_ems = ("est_ranna_vng_ems",)  # viru-nigula  EKI murdesõnastikust
    est_ranna_vai_ems = ("est_ranna_vai_ems",)  # vaivara  EKI murdesõnastikust
    est_ranna_iis_ems = ("est_ranna_iis_ems",)  # iisaku   EKI murdesõnastikust
    est_ida_kod_ems = ("est_ida_kod_ems",)  # kodavere, EKI murdesõnastikust
    est_ida_MMg = ("est_ida_MMg",)
    est_ida_trm_ems = ("est_ida_trm_ems",)  # torma, EKI murdesõnastikust
    est_ida_lai = ("est_ida_lai",)
    est_ida_iis_ems = ("est_ida_iis_ems",)  # iisaku, EKI murdesõnastikust
    est_ida_pal = ("est_ida_pal",)
    est_ida_avi = ("est_ida_avi",)
    est_saare_jäm_ems = ("est_saare_jäm_ems",)  # jämaja  EKI murdesõnastikust
    est_saare_ans = ("est_saare_ans",)
    est_kihnu_ekidct = (
        "est_kihnu_ekidct",
    )  # kihnu murre, EKI xml sõnastik 
    est_kihnu_ems = ("est_kihnu_ems",)  # kihnu murre EKI murdesõnastikust
    est_saare_khk_ems = ("est_saare_khk_ems",)  # kihelkonna  EKI murdesõnastikust
    est_saare_mus_ems = ("est_saare_mus_ems",)  # mustjala EKI murdesõnastikust
    est_saare_jaa = ("est_saare_jaa",)
    est_saare_pöi_ems = ("est_saare_pöi_ems",)  # pöide EKI murdesõnastikust
    est_saare_jäm = ("est_saare_jäm",)  # jämaja
    est_saare_krj = ("est_saare_krj",)
    est_saare_vll = ("est_saare_vll",)
    est_saare_pha_ems = ("est_saare_pha_ems",)  # püha  EKI murdesõnastikust
    est_saare_kaa_ems = ("est_saare_kaa_ems",)  # kaarma  EKI murdesõnastikust
    est_saare_kär_ems = ("est_saare_kär_ems",)  # kärla EKI murdesõnastikust
    est_muhu_ems = ("est_muhu_ems",)  # muhu murre EKI murdesõnastikust
    # est_hiiu = ("est_hiiu",)  # hiiumaa murre
    est_hiiu_ekidct = ("est_hiiu_ekidct",)  # hiiu murre, EKI xml sõnastik Tõnis Nurgalt
    est_hiiu_emm_ems = ("est_hiiu_emm_ems",)  # emmaste  EKI murdesõnastikust
    est_hiiu_rei_ems = ("est_hiiu_rei_ems",)  # reigi EKI murdesõnastikust
    est_hiiu_phl_ems = ("est_hiiu_phl_ems",)  # pühalepa  EKI murdesõnastikust
    est_hiiu_käi_ems = ("est_hiiu_käi_ems",)  # käina  EKI murdesõnastikust
    est_lääne_noa = ("est_lääne_noa",)
    est_lääne_lng_ems = ("est_lääne_lng_ems",)  # lääne-nigula  EKI murdesõnastikust
    est_lääne_rid_ems = ("est_lääne_rid_ems",)  # ridala  EKI murdesõnastikust
    est_lääne_mar_ems = ("est_lääne_mar_ems",)  # martna  EKI murdesõnastikust
    est_lääne_kul = ("est_lääne_kul",)
    est_lääne_mär_ems = ("est_lääne_mär_ems",)  # märjamaa  EKI murdesõnastikust
    est_lääne_han_ems = ("est_lääne_han_ems",)  # hanila  EKI murdesõnastikust
    est_lääne_kse_ems = ("est_lääne_kse_ems",)  # karuse  EKI murdesõnastikust
    est_lääne_lih = ("est_lääne_lih",)
    est_lääne_var_ems = ("est_lääne_var_ems",)  # varbla  EKI murdesõnastikust
    est_lääne_mih_ems = ("est_lääne_mih_ems",)  # mihkli  EKI murdesõnastikust
    est_lääne_tõs_ems = ("est_lääne_tõs_ems",)  # tõstamaa EKI murdesõnastikust
    est_lääne_aud_ems = ("est_lääne_aud_ems",)  # audru  EKI murdesõnastikust
    est_lääne_kir = ("est_lääne_kir",)
    est_lääne_vig_ems = ("est_lääne_vig_ems",)  # vigala EKI murdesõnastikust
    est_lääne_pjg_ems = ("est_lääne_pjg_ems",)  # pärnu-jaagupi EKI murdesõnastikust
    est_lääne_pär = ("est_lääne_pär",)
    est_lääne_vän_ems = ("est_lääne_vän_ems",)  # vändra  EKI murdesõnastikust
    est_lääne_tor = ("est_lääne_tor",)
    est_lääne_hää_ems = ("est_lääne_hää_ems",)  # häädemeeste EKI murdesõnastikust
    est_lääne_saa_ems = ("est_lääne_saa_ems",)  # saarde EKI murdesõnastikust
    est_kesk_ris = ("est_kesk_ris",)
    est_kesk_hmd_ems = ("est_kesk_hmd_ems",)  # harju-madise EKI murdesõnastikust
    est_kesk_nis = ("est_kesk_nis",)
    est_kesk_kei = ("est_kesk_kei",)
    est_kesk_hag_ems = ("est_kesk_hag_ems",)  # hageri  EKI murdesõnastikust
    est_kesk_rap_ems = ("est_kesk_rap_ems",)  # rapla  EKI murdesõnastikust
    est_kesk_juu_ems = ("est_kesk_juu_ems",)  # juuru  EKI murdesõnastikust
    est_kesk_pai = ("est_kesk_pai",)
    est_kesk_tür_ems = ("est_kesk_tür_ems",)  # türi EKI murdesõnastikust
    est_kesk_jõe = ("est_kesk_jõe",)
    est_kesk_kuu_ems = ("est_kesk_kuu_ems",)  # kuusalu  EKI murdesõnastikust
    est_kesk_kad_ems = ("est_kesk_kad-ems",)  # kadrina  EKI murdesõnastikust
    est_kesk_hlj = ("est_kesk_hlj",)
    est_kesk_rak = ("est_kesk_rak",)
    est_kesk_vjg_ems = ("est_kesk_vjg_ems",)  # viru-jaagupi EKI murdesõnastikust
    est_kesk_iis_ems = ("est_kesk_iis_ems",)  # iisaku  EKI murdesõnastikust
    est_kesk_ksi = ("est_kesk_ksi",)
    est_kesk_äks_ems = ("est_kesk_äks_ems",)  # äksi  EKI murdesõnastikust
    est_kesk_lai = ("est_kesk_lai",)
    est_kesk_pal = ("est_kesk_pal",)
    est_kesk_kõp = ("est_kesk_kõp",)
    est_kesk_vil = ("est_kesk_vil",)
    est_kesk_sjn = ("est_kesk_sjn",)
    est_kesk_pil = ("est_kesk_pil",)
    est_kesk_kjn_ems = ("est_kesk_kjn_ems",)  # kolga-jaani EKI murdesõnastikust
    est_kesk_plt_ems = ("est_kesk_plt_ems",)  # põltsamaa EKI murdesõnastikust
    est_kesk_vmr = ("est_kesk_vmr",)
    est_kesk_sim = ("est_kesk_sim",)
    est_kesk_amb_ems = ("est_kesk_amb_ems",)  # ambla  EKI murdesõnastikust
    est_kesk_jmd_ems = ("est_kesk_jmd_ems",)  # järva madise EKI murdesõnastikust
    est_kesk_jjn_ems = ("est_kesk_jjn_ems",)  # järva-jaani EKI murdesõnastikust
    est_kesk_ann_ems = ("est_kesk_ann_ems",)  # anna  EKI murdesõnastikust
    est_kesk_koe = ("est_kesk_koe",)
    est_kesk_pee = ("est_kesk_pee",)
    est_kesk_jür_ems = ("est_kesk_jür_ems",)  # jüri  EKI murdesõnastikust
    est_kesk_hjn_ems = ("est_kesk_hjn_ems",)  # harju-jaani EKI murdesõnastikust
    est_kesk_kos_ems = ("est_kesk_kos_ems",)  # kose  EKI murdesõnastikust
    est_mulgi = ("est_mulgi",)  # mulgi murre
    est_mulgi_ekidct = (
        "est_mulgi_ekidct",
    )  # mulgi murre, EKI xml sõnastik 
    est_mulgi_hls_ems = ("est_mulgi_hls_ems",)  # halliste EKI murdesõnastikust
    est_mulgi_krk_ems = ("est_mulgi_krk_ems",)  # karksi   EKI murdesõnastikust
    est_mulgi_pst = ("est_mulgi_pst",)
    est_mulgi_hel_ems = ("est_mulgi_hel_ems",)  # helme    EKI murdesõnastikust
    est_mulgi_trv_ems = ("est_mulgi_trv_ems",)  # tarvastu EKI murdesõnastikust
    est_tartu_kod = ("est_tartu_kod",)
    est_tartu_tmr = ("est_tartu_tmr",)
    est_tartu_ran_ems = ("est_tartu_ran_ems",)  # rannu, EKI murdesõnastikust
    est_tartu_puh_ems = ("est_tartu_puh_ems",)  # puhja, EKI murdesõnastikust
    est_tartu_nõo_ems = ("est_tartu_nõo_ems",)  # nõo,   EKI murdesõnastikust
    est_tartu_kam = ("est_tartu_kam",)
    est_tartu_võn = ("est_tartu_võn",)
    est_tartu_rõn = ("est_tartu_rõn",)
    est_tartu_ote_ems = ("est_tartu_ote_ems",)  # otepää, EKI murdesõnastikust
    est_tartu_san = ("est_tartu_san",)
    est_setu_ems = ("est_setu_ems",)  # setu, EKI murdesõnastikust
    est_setu_ekidct = ("est_setu_ekidct",)  # setu, EKI xml sõnastik Tõnis Nurgalt
    est_võru_har = ("est_võru_har",)  # hargla
    est_võru_krl = ("est_võru_krl",)  # karula
    est_võru_urv = ("est_võru_urv",)  # urvaste 
    est_võru_kan = ("est_võru_kan",)  # kanepi 
    est_võru_rõu = ("est_võru_rõu",)  # rõuge 
    est_võru_plv = ("est_võru_plv",)  # põlva 
    est_võru_räp = ("est_võru_räp",)  # räpina 
    est_võru_vas = ("est_võru_vas",)  # vastseliina 
    est_võru_lei_ems = ("est_võro_lei_ems",)  # leivu EKI murdesõnastikust
    est_võru_lut_ems = ("est_võro_lut_ems",)  # lutsi EKI murdesõnastikust
    est_võru_kra = ("est_võro_kra",)
    est_võru_vrox = (
        "est_võru_vrox",
    )  
    est_võru_vrosõnaq = (
        "est_võru_vrosõnaq",
    )  
    est_võru_vrosetom = (
        "est_võru_vrosetom",
    )  
    est_võru_vrouma = (
        "est_võru_vrouma",
    )  
    
    # translated into or from these languages {{{
    est = (
        "est",
    )  
    est_av = ("est_av",)  # eesti algvormid
    eng = ("eng",)  # inglise
    eng_av = ("eng_av",)  # inglise algvormid
    eng_piibel = ("eng_piibel",)  # inglise piiblikeel
    rus = ("rus",)  # vene
    fin = ("fin",)  # soome
    deu = ("deu",)  # saksa
    swe = ("swe",)  # rootsi
    lit = ("lit",)  # leedu
    lav = ("lav",)  # läti
    pol = ("pol",)  # poola
    ukr = ("ukr",)  # ukraina
    bel = ("bel",)  # valgevene
    ces = ("ces",)  # tšehhi
    slk = ("slk",)  # slovaki
    hun = ("hun",)  # ungari
    ron = ("ron",)  # rumeenia
    bil = ("bul",)  # bulgaaria
    hrv = ("hrv",)  # horvaatia
    slv = ("slv",)  # sloveeni
    ita = ("ita",)  # itaalia
    fra = ("fra",)  # prantsuse
    por = ("por",)  # portugali
    spa = ("spa",)  # hispaaniareg
    nld = ("nld",)  # hollandi
    dan = ("dan",)  # taani
    isl = ("isl",)  # islandi
    nor = ("nor",)  # norra
    nob = ("nob",)  # norra Bokmål, Norwegian Bokmål
    nno = ("nno",)  # norra Nynorsk
    # }}} 
    xxx = ("xxx",)  # other languages, unknown


class EMurderyhmad(str, Enum):
    """Estonian dialects (as defined for this corpus).
    """

    alutaguse = ("alutaguse",)
    ranna = ("ranna",)
    ida = ("ida",)
    saare = ("saare",)
    kihnu = ("kihnu",)
    muhu = ("muhu",)
    hiiu = ("hiiu",)
    lääne = ("lääne",)
    kesk = ("kesk",)
    mulgi = ("mulgi",)
    tartu = ("tartu",)
    võru = ("võru",)
    setu = ("setu",)
    lutsi = ("lutsi",)
    leivu = ("leivu",)


class EM_Ortograafia(str, Enum):
    """Estonian dialect orthographies.
    """

    mut = ("mut",)  
    ems = ("ems",)  
    ekidct = ("ekidct",)  
    vrox = (
        "vrox",
    )  
    vrosõnaq = (
        "vrosõnaq",
    )  
    vrosetom = (
        "vrosetom",
    )  
    vrouma = (
        "vrouma",
    )  


class Input_Method(str, Enum):

    OCR = ("OCR",)
    keyboard = ("keyboard",)
    speech_reqognition = ("speech_reqognition",)


class Text_Type(str, Enum):

    dictionary = ("dictionary",)
    dictionary_with_meta = ("dictionary_with_meta",)
    bible = ("bible",)
    wikipedia = ("wikipedia",)
    transcriptions_of_speech = ("transcriptions_of_speech",)
    legalese = ("legalese",)


class FEATURES(BaseModel):
    """Metainfo template

    Examples:
    >>> FEATURES(corpus="testkorpus", filename="test.txt", counter_tokens={LangCode.est: 100, LangCode.eng: 50})
    FEATURES(corpus='testkorpus', filename='test.txt', counter_tokens={<LangCode.est: 'est'>: 100, <LangCode.eng: 'eng'>: 50}, langprobs=None)

    >>> FEATURES(corpus="testkorpus", filename="test.txt", counter_tokens={LangCode.est: 100, LangCode.eng: 50}, author="Juhan Liiv", title="Vari")
    FEATURES(corpus='testkorpus', filename='test.txt', counter_tokens={<LangCode.est: 'est'>: 100, <LangCode.eng: 'eng'>: 50}, langprobs=None, author='Juhan Liiv', title='Vari')
    """

    model_config = {"extra": "allow"}  
    corpus: str  
    filename: str  
    counter_tokens: dict[LangCode, int] = {}  # lang code  # tokens
    langprobs: Optional[  # only if language identification has been performed with glotlid
        dict[
            LangCode,  # 
            dict[
                str,  
                float,  # probability
            ],
        ]
    ] = Field(None)

    input_method: Optional[
        dict[
            LangCode,  
            Input_Method,
        ]
    ] = Field(None)  # None == unknown

    text_type: Optional[list[Text_Type]] = Field(
        None,  #  None == unknown
        description="Valikuline list, mis sisaldab Text_Type enum'i väärtuseid.",
    )


class TEXTS(BaseModel):
    """coherent (parallel) text (without explicit split into sentences) + metainfo"""

    model_config = {"extra": "allow"}  
    features: FEATURES  
    texts: list[  # text or text parts (like chapters)
        dict[
            LangCode,  
            str,  # text itself
        ]
    ] = []  # empty by default


class SENTENCES(BaseModel):
    """unrelated (parallel) sentences + metainfo"""

    model_config = {"extra": "allow"}  
    features: FEATURES  
    sentences: list[  # sentences
        dict[
            LangCode,  
            str,  # text itself
        ]
    ] = []  # empty by default


class PHRASES(BaseModel):
    """unrelated (parallel) phrases/words + metainfo"""

    model_config = {"extra": "allow"}  
    features: FEATURES  
    phrases: list[  # usually from a dictionary
        dict[LangCode, list[str]]  
    ] = []  # empty by default


class PARASENTS(BaseModel):
    """coherent sequence of (parallel) paragraphs and possibly sentences + metainfo"""

    model_config = {"extra": "allow"}  
    features: FEATURES  
    parasents: list[  # texts
        dict[
            LangCode,  
            list[  # paragraphs
                list[str]  # sentences
            ],
        ]
    ] = [] # empty by default