kerykeion.kr_types.kr_models

  1# -*- coding: utf-8 -*-
  2"""
  3    This is part of Kerykeion (C) 2024 Giacomo Battaglia
  4"""
  5
  6
  7from typing import Union, Optional
  8from pydantic import BaseModel
  9
 10from kerykeion.kr_types import LunarPhaseEmoji, LunarPhaseName, Planet, Houses, Quality, Element, Sign, ZodiacType, SignNumbers, HouseNumbers, PointType, SiderealMode, HousesSystemIdentifier
 11
 12class SubscriptableBaseModel(BaseModel):
 13    """
 14    Pydantic BaseModel with subscriptable support, so you can access the fields as if they were a dictionary.
 15    """
 16    def __getitem__(self, key):
 17        return getattr(self, key)
 18
 19    def __setitem__(self, key, value):
 20        setattr(self, key, value)
 21
 22    def __delitem__(self, key):
 23        delattr(self, key)
 24
 25    def get(self, key, default):
 26        return getattr(self, key, default)
 27
 28class LunarPhaseModel(SubscriptableBaseModel):
 29    degrees_between_s_m: Union[float, int]
 30    moon_phase: int
 31    sun_phase: int
 32    moon_emoji: LunarPhaseEmoji
 33    moon_phase_name: LunarPhaseName
 34
 35
 36class KerykeionPointModel(SubscriptableBaseModel):
 37    """
 38    Kerykeion Point Model
 39    """
 40
 41    name: Union[Planet, Houses]
 42    quality: Quality
 43    element: Element
 44    sign: Sign
 45    sign_num: SignNumbers
 46    position: float
 47    abs_pos: float
 48    emoji: str
 49    point_type: PointType
 50    house: Optional[HouseNumbers] = None
 51    retrograde: Optional[bool] = None
 52
 53
 54class AstrologicalSubjectModel(SubscriptableBaseModel):
 55    # Data
 56    name: str
 57    year: int
 58    month: int
 59    day: int
 60    hour: int
 61    minute: int
 62    city: str
 63    nation: str
 64    lng: float
 65    lat: float
 66    tz_str: str
 67    zodiac_type: ZodiacType
 68    sidereal_mode: Union[SiderealMode, None]
 69    houses_system_identifier: HousesSystemIdentifier
 70    houses_system_name: str
 71    perspective_type: str
 72    iso_formatted_local_datetime: str
 73    iso_formatted_utc_datetime: str
 74    julian_day: float
 75
 76    # Planets
 77    sun: KerykeionPointModel
 78    moon: KerykeionPointModel
 79    mercury: KerykeionPointModel
 80    venus: KerykeionPointModel
 81    mars: KerykeionPointModel
 82    jupiter: KerykeionPointModel
 83    saturn: KerykeionPointModel
 84    uranus: KerykeionPointModel
 85    neptune: KerykeionPointModel
 86    pluto: KerykeionPointModel
 87
 88    # Optional Planets:
 89    chiron: Union[KerykeionPointModel, None]
 90
 91    # Houses
 92    first_house: KerykeionPointModel
 93    second_house: KerykeionPointModel
 94    third_house: KerykeionPointModel
 95    fourth_house: KerykeionPointModel
 96    fifth_house: KerykeionPointModel
 97    sixth_house: KerykeionPointModel
 98    seventh_house: KerykeionPointModel
 99    eighth_house: KerykeionPointModel
100    ninth_house: KerykeionPointModel
101    tenth_house: KerykeionPointModel
102    eleventh_house: KerykeionPointModel
103    twelfth_house: KerykeionPointModel
104
105    # Nodes
106    mean_node: KerykeionPointModel
107    true_node: KerykeionPointModel
108
109    # Lunar Phase
110    lunar_phase: LunarPhaseModel
111
112    # Lists
113    # houses_list: list[KerykeionPointModel]
114    # planets_list: list[KerykeionPointModel]
115    # planets_degrees_ut: list[float]
116    # houses_degree_ut: list[float]
117
118if __name__ == "__main__":
119    from kerykeion.utilities import setup_logging
120
121    setup_logging(level="debug")
122
123    sun = KerykeionPointModel(
124        name="Sun",
125        element="Air",
126        quality="Fixed",
127        sign="Aqu",
128        sign_num=1,
129        position=0,
130        abs_pos=12.123123,
131        emoji="♈",
132        point_type="Planet",
133    )
134
135    print(sun.model_dump_json())
136    print(sun)