Skip to content

Config

natal.config

Chart

Bases: ModelDict

Chart configuration settings.

Source code in natal/config.py 
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
class Chart(ModelDict):
    """
    Chart configuration settings.
    """

    stroke_width: int = 1
    stroke_opacity: float = 1
    font: str = "sans-serif"
    font_size_fraction: float = 0.55
    inner_min_degree: float = 9
    outer_min_degree: float = 8
    margin_factor: float = 0.04
    ring_thickness_fraction: float = 0.15
    # hard-coded 2.2 and 600 due to the original symbol svg size = 20x20
    scale_adj_factor: float = 600
    pos_adj_factor: float = 2.2

Config

Bases: ModelDict

Package configuration model.

Source code in natal/config.py 
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
class Config(ModelDict):
    """
    Package configuration model.
    """

    theme_type: ThemeType = "dark"
    house_sys: HouseSys = HouseSys.Placidus
    orb: Orb = Orb()
    light_theme: LightTheme = LightTheme()
    dark_theme: DarkTheme = DarkTheme()
    display: Display = Display()
    chart: Chart = Chart()

    @property
    def theme(self) -> Theme:
        """
        Return theme colors based on the theme type.

        Returns:
            Theme: The theme colors.
        """
        match self.theme_type:
            case "light":
                return self.light_theme
            case "dark":
                return self.dark_theme
            case "mono":
                kwargs = {key: "#888888" for key in self.light_theme.model_dump()}
                kwargs["background"] = "#FFFFFF"
                kwargs["transparency"] = 0
                return Theme(**kwargs)

theme: Theme property

Return theme colors based on the theme type.

Returns:

Name Type Description
Theme Theme

The theme colors.

DarkTheme

Bases: Theme

Default dark colors.

Source code in natal/config.py 
110
111
112
113
114
115
116
117
class DarkTheme(Theme):
    """
    Default dark colors.
    """

    foreground: str = "#F7F3F0"
    background: str = "#343a40"
    dim: str = "#515860"

Dictable

Bases: Mapping

Protocols for subclasses to behave like a dict.

Source code in natal/config.py 
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
class Dictable(Mapping):
    """
    Protocols for subclasses to behave like a dict.
    """

    def __getitem__(self, key: str):
        return getattr(self, key)

    def __setitem__(self, key: str, value: Any) -> None:
        setattr(self, key, value)

    def __iter__(self) -> Iterator[str]:
        return iter(self.__dict__)

    def __len__(self) -> int:
        return len(self.__dict__)

    def update(self, other: Mapping[str, Any] | None = None, **kwargs) -> None:
        """
        Update the attributes with elements from another mapping or from key/value pairs.

        Args:
            other (Mapping[str, Any] | None): A mapping object to update from.
            **kwargs: Additional key/value pairs to update with.
        """
        if other is not None:
            for key, value in other.items():
                setattr(self, key, value)
        for key, value in kwargs.items():
            setattr(self, key, value)

update(other: Mapping[str, Any] | None = None, **kwargs) -> None

Update the attributes with elements from another mapping or from key/value pairs.

Parameters:

Name Type Description Default
other Mapping[str, Any] | None

A mapping object to update from.

 None
**kwargs

Additional key/value pairs to update with.

 {}
Source code in natal/config.py 
26
27
28
29
30
31
32
33
34
35
36
37
38
def update(self, other: Mapping[str, Any] | None = None, **kwargs) -> None:
    """
    Update the attributes with elements from another mapping or from key/value pairs.

    Args:
        other (Mapping[str, Any] | None): A mapping object to update from.
        **kwargs: Additional key/value pairs to update with.
    """
    if other is not None:
        for key, value in other.items():
            setattr(self, key, value)
    for key, value in kwargs.items():
        setattr(self, key, value)

Display

Bases: ModelDict

Display settings for celestial bodies.

Source code in natal/config.py 
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
class Display(ModelDict):
    """
    Display settings for celestial bodies.
    """

    sun: bool = True
    moon: bool = True
    mercury: bool = True
    venus: bool = True
    mars: bool = True
    jupiter: bool = True
    saturn: bool = True
    uranus: bool = True
    neptune: bool = True
    pluto: bool = True
    asc_node: bool = True
    chiron: bool = False
    ceres: bool = False
    pallas: bool = False
    juno: bool = False
    vesta: bool = False
    asc: bool = True
    ic: bool = False
    dsc: bool = False
    mc: bool = True

DotDict

Bases: SimpleNamespace, Dictable

Extends SimpleNamespace to allow for unpacking and subscript notation access.

Source code in natal/config.py 
41
42
43
44
45
46
class DotDict(SimpleNamespace, Dictable):
    """
    Extends SimpleNamespace to allow for unpacking and subscript notation access.
    """

    pass

LightTheme

Bases: Theme

Default light colors.

Source code in natal/config.py 
100
101
102
103
104
105
106
107
class LightTheme(Theme):
    """
    Default light colors.
    """

    foreground: str = "#758492"
    background: str = "#FFFDF1"
    dim: str = "#A4BACD"

ModelDict

Bases: BaseModel, Dictable

Extends BaseModel to allow for unpacking and subscript notation access.

Source code in natal/config.py 
49
50
51
52
53
54
55
56
class ModelDict(BaseModel, Dictable):
    """
    Extends BaseModel to allow for unpacking and subscript notation access.
    """

    # override to return keys, otherwise BaseModel.__iter__ returns key value pairs
    def __iter__(self) -> Iterator[str]:
        return iter(self.__dict__)

Orb

Bases: ModelDict

default orb for natal chart

Source code in natal/config.py 
69
70
71
72
73
74
75
76
77
class Orb(ModelDict):
    """default orb for natal chart"""

    conjunction: int = 7
    opposition: int = 6
    trine: int = 6
    square: int = 6
    sextile: int = 5
    quincunx: int = 0

Theme

Bases: ModelDict

Default colors for the chart.

Source code in natal/config.py 
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
class Theme(ModelDict):
    """
    Default colors for the chart.
    """

    fire: str = "#ef476f"  # fire, square, Asc
    earth: str = "#ffd166"  # earth, MC
    air: str = "#06d6a0"  # air, trine
    water: str = "#81bce7"  # water, opposition
    points: str = "#118ab2"  # lunar nodes, sextile
    asteroids: str = "#AA96DA"  # asteroids, quincunx
    positive: str = "#FFC0CB"  # positive
    negative: str = "#AD8B73"  # negative
    others: str = "#FFA500"  # conjunction
    transparency: float = 0.1
    foreground: str
    background: str
    dim: str