refspy.config

 1"""Configure libraries and languages.
 2
 3Note: TODO: Don't initialise all libraries every time, only on demand.
 4"""
 5
 6from refspy.models.language import Language
 7from refspy.models.library import Library
 8from refspy.models.syntax import Syntax, syntax_label
 9
10from refspy.languages.english import ENGLISH
11from refspy.languages.french import FRENCH
12
13from refspy.libraries.en_US import (
14    DC as EN_DC,
15    DC_ORTHODOX as EN_DC_ORTHODOX,
16    NT as EN_NT,
17    OT as EN_OT,
18)
19from refspy.libraries.fr_FR import (
20    DC as FR_DC,
21    DC_ORTHODOX as FR_DC_ORTHODOX,
22    NT as FR_NT,
23    OT as FR_OT,
24)
25
26from refspy.syntax.european import EUROPEAN
27from refspy.syntax.international import INTERNATIONAL
28
29LIBRARIES: dict[str, dict[str, list[Library]]] = {
30    "protestant": {
31        "en_US": [EN_OT, EN_NT],
32        "fr_FR": [FR_OT, FR_NT],
33    },
34    "catholic": {
35        "en_US": [EN_OT, EN_DC, EN_NT],
36        "fr_FR": [FR_OT, FR_DC, FR_NT],
37    },
38    "orthodox": {
39        "en_US": [EN_OT, EN_DC, EN_DC_ORTHODOX, EN_NT],
40        "fr_FR": [FR_OT, FR_DC, FR_DC_ORTHODOX, FR_NT],
41    },
42}
43"""A dictionary of available locales for available libraries, used for
44shorthand library invocation.
45
46Example:
47    ```
48    from refspy.libraries.en_US import NT, OT
49
50    LIBRARIES = { "protestant": {"en_US": [OT, NT] } }
51    ```
52"""
53
54LANGUAGE_OPTIONS: list[tuple[str, str, str]] = [
55    ("en_US", "English", "intl"),
56    ("fr_FR", "French", "euro"),
57]
58"""
59Default language options; could be used in forms and interfaces.
60"""
61
62LANGUAGES: dict[str, Language] = {"en": ENGLISH, "fr": FRENCH}
63"""A dictionary of available languages in the present version of refspy.
64
65Language names use the first two chars of locale names, e.g. 'en_US' is 'en'.
66
67Example:
68    ```
69    from refspy.languages.english import ENGLISH
70
71    LANGUAGES = { "en": ENGLISH }
72    ```
73"""
74
75SYNTAX_OPTIONS: list[tuple[str, str]] = [
76    (INTERNATIONAL.abbrev, syntax_label(INTERNATIONAL)),
77    (EUROPEAN.abbrev, syntax_label(EUROPEAN)),
78]
79"""
80Default syntax options; could be used in forms and interfaces.
81"""
82
83SYNTAX: dict[str, Syntax] = {"euro": EUROPEAN, "intl": INTERNATIONAL}
84"""A dictionary of available syntaxes in the present version of refspy.
85"""