Skip to content

Constants

natal.const

Constants and utility functions for the natal package.

AspectMember

Bases: Body

Represents an aspect in raw data. (conjunction, opposition, trine, square, sextile)

Source code in natal/const.py 
28
29
30
31
32
33
34
class AspectMember(Body):
    """
    Represents an aspect in raw data.
    (conjunction, opposition, trine, square, sextile)
    """

    ...

Body

Bases: DotDict

Represents a celestial body in raw data. Base class for all members.

Source code in natal/const.py 
 8
 9
10
11
12
13
14
15
16
17
class Body(DotDict):
    """
    Represents a celestial body in raw data.
    Base class for all members.
    """

    name: str
    symbol: str
    value: int
    color: str

ElementMember

Bases: Body

Represents an element in raw data. (fire, earth, air, water)

Source code in natal/const.py 
37
38
39
40
41
42
43
class ElementMember(Body):
    """
    Represents an element in raw data.
    (fire, earth, air, water)
    """

    ...

ExtraMember

Bases: Body

Represents an extra celestial body in raw data. (e.g. asteroids, nodes)

Source code in natal/const.py 
72
73
74
75
76
77
78
class ExtraMember(Body):
    """
    Represents an extra celestial body in raw data.
    (e.g. asteroids, nodes)
    """

    ...

HouseMember

Bases: Body

Represents a house in raw data.

Source code in natal/const.py 
64
65
66
67
68
69
class HouseMember(Body):
    """
    Represents a house in raw data.
    """

    ...

ModalityMember

Bases: Body

Represents a modality in raw data. (cardinal, fixed, mutable)

Source code in natal/const.py 
46
47
48
49
50
51
52
class ModalityMember(Body):
    """
    Represents a modality in raw data.
    (cardinal, fixed, mutable)
    """

    ...

PlanetMember

Bases: Body

Represents a planet in raw data.

Source code in natal/const.py 
20
21
22
23
24
25
class PlanetMember(Body):
    """
    Represents a planet in raw data.
    """

    ...

PolarityMember

Bases: Body

Represents a polarity in raw data. (positive, negative)

Source code in natal/const.py 
55
56
57
58
59
60
61
class PolarityMember(Body):
    """
    Represents a polarity in raw data.
    (positive, negative)
    """

    ...

SignMember

Bases: Body

Represents a zodiac sign in raw data.

Source code in natal/const.py 
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
class SignMember(Body):
    """
    Represents a zodiac sign in raw data.
    """

    ruler: str
    detriment: str
    exaltation: str
    fall: str
    classic_ruler: str
    classic_detriment: str
    modality: str
    element: str
    polarity: str

VertexMember

Bases: Body

Represents a vertex in raw data (asc, ic, dsc, mc).

Source code in natal/const.py 
81
82
83
84
85
86
class VertexMember(Body):
    """
    Represents a vertex in raw data (asc, ic, dsc, mc).
    """

    ...

get_member(raw_data: dict, name: str) -> DotDict

Get a member from raw data by name.

Parameters:

Name Type Description Default
raw_data dict

The raw data dictionary.

 required
name str

The name of the member.

 required

Returns:

Name Type Description
DotDict DotDict

The member as a DotDict.
Source code in natal/const.py 
108
109
110
111
112
113
114
115
116
117
118
119
120
121
def get_member(raw_data: dict, name: str) -> DotDict:
    """
    Get a member from raw data by name.

    Args:
        raw_data (dict): The raw data dictionary.
        name (str): The name of the member.

    Returns:
        DotDict: The member as a DotDict.
    """
    idx = raw_data["name"].index(name)
    member = {key: raw_data[key][idx] for key in raw_data.keys()}
    return DotDict(**member)

get_members(raw_data: dict) -> list[DotDict]

Get all members from raw data.

Parameters:

Name Type Description Default
raw_data dict

The raw data dictionary.

 required

Returns:

Type Description
list[DotDict]

list[DotDict]: A list of members as DotDicts.
Source code in natal/const.py 
124
125
126
127
128
129
130
131
132
133
134
def get_members(raw_data: dict) -> list[DotDict]:
    """
    Get all members from raw data.

    Args:
        raw_data (dict): The raw data dictionary.

    Returns:
        list[DotDict]: A list of members as DotDicts.
    """
    return [get_member(raw_data, name) for name in raw_data["name"]]