kerykeion.aspects.aspects_utils

 1# -*- coding: utf-8 -*-
 2"""
 3    This is part of Kerykeion (C) 2025 Giacomo Battaglia
 4"""
 5# TODO: Better documentation and unit tests
 6
 7from kerykeion import AstrologicalSubject
 8from kerykeion.settings import KerykeionSettingsModel
 9from swisseph import difdeg2n
10from typing import Union
11from kerykeion.kr_types.kr_models import AstrologicalSubjectModel
12from kerykeion.kr_types.kr_literals import Planet, AxialCusps
13from kerykeion.kr_types.settings_models import KerykeionSettingsCelestialPointModel, KerykeionSettingsAspectModel
14
15
16def get_aspect_from_two_points(
17    aspects_settings: Union[list[KerykeionSettingsAspectModel], list[dict]],
18    point_one: Union[float, int],
19    point_two: Union[float, int],
20):
21    """
22    Utility function to calculate the aspects between two points.
23
24    Args:
25        aspects_settings (dict): Dictionary containing aspect settings.
26        point_one (Union[float, int]): First point.
27        point_two (Union[float, int]): Second point.
28
29    Returns:
30        dict: Dictionary containing the aspect details.
31    """
32    distance = abs(difdeg2n(point_one, point_two))
33    diff = abs(point_one - point_two)
34
35    for aid, aspect in enumerate(aspects_settings):
36        # TODO: Remove the "degree" element EVERYWHERE!
37        aspect_degree = aspect["degree"] # type: ignore
38        aspect_orb = aspect["orb"] # type: ignore
39
40        if (aspect_degree - aspect_orb) <= int(distance) <= (aspect_degree + aspect_orb):
41            name = aspect["name"] # type: ignore
42            aspect_degrees = aspect_degree
43            verdict = True
44            break
45    else:
46        verdict = False
47        name = None
48        aspect_degrees = 0
49
50    return {
51        "verdict": verdict,
52        "name": name,
53        "orbit": distance - aspect_degrees,
54        "distance": distance - aspect_degrees,
55        "aspect_degrees": aspect_degrees,
56        "diff": diff,
57    }
58
59
60def planet_id_decoder(planets_settings: list[KerykeionSettingsCelestialPointModel], name: str) -> int:
61    """
62    Check if the name of the planet is the same in the settings and return
63    the correct id for the planet.
64    """
65    str_name = str(name)
66    for planet in planets_settings:
67        if planet["name"] == str_name:
68            result = planet["id"]
69            return result
70
71    raise ValueError(f"Planet {name} not found in the settings")
72
73
74def get_active_points_list(
75    subject: Union[AstrologicalSubject, AstrologicalSubjectModel], settings: Union[KerykeionSettingsModel, dict], active_points: list = []
76) -> list:
77    """
78    Given an astrological subject and the settings, return a list of the active points.
79    Args:
80        subject (AstrologicalSubject): The astrological subject to get the active points from.
81        settings (Union[KerykeionSettingsModel, dict]): Settings model o dictionary.
82
83    Returns:
84        list: List of the active points.
85    """
86    point_list = []
87    for planet in settings["celestial_points"]:
88        if planet["name"] in active_points:
89            point_list.append(subject[planet["name"].lower()])
90
91    return point_list