[PyMeeus] Add stubs (#14649)

Author: donbarbos

stubs/PyMeeus/METADATA.toml

@@ -0,0 +1,2 @@
+version = "0.5.*"
+upstream_repository = "https://github.com/architest/pymeeus"

stubs/PyMeeus/pymeeus/Angle.pyi

@@ -0,0 +1,95 @@
+from typing import overload
+from typing_extensions import Self
+
+class Angle:
+    @overload
+    def __init__(self, *, ra: bool = False) -> None: ...
+    @overload
+    def __init__(self, a: Angle, /, *, ra: bool = False) -> None: ...
+    @overload
+    def __init__(self, a: float, /, *, ra: bool = False, radians: bool = False) -> None: ...
+    @overload
+    def __init__(self, a: list[float] | tuple[float, ...], /, *, ra: bool = False, radians: bool = False) -> None: ...
+    @overload
+    def __init__(self, a1: float, a2: float, /, *, ra: bool = False) -> None: ...
+    @overload
+    def __init__(self, a1: float, a2: float, a3: float, /, *, ra: bool = False) -> None: ...
+    @overload
+    def __init__(self, a1: float, a2: float, a3: float, a4: float, /, *, ra: bool = False) -> None: ...
+    @staticmethod
+    def reduce_deg(deg: float | Angle) -> float: ...
+    @staticmethod
+    def reduce_dms(degrees: float, minutes: float, seconds: float = 0.0) -> tuple[int, int, float, float]: ...
+    @staticmethod
+    def deg2dms(deg: float | Angle) -> tuple[int, int, float, float]: ...
+    @staticmethod
+    def dms2deg(degrees: float, minutes: float, seconds: float = 0.0) -> float: ...
+    def get_tolerance(self) -> float: ...
+    def set_tolerance(self, tol: float) -> None: ...
+    def __call__(self) -> float: ...
+    @overload
+    def set(self, *, ra: bool = False) -> None: ...
+    @overload
+    def set(self, a: Angle, /, *, ra: bool = False) -> None: ...
+    @overload
+    def set(self, a: float, /, *, ra: bool = False, radians: bool = False) -> None: ...
+    @overload
+    def set(self, a: list[float] | tuple[float, ...], /, *, ra: bool = False, radians: bool = False) -> None: ...
+    @overload
+    def set(self, a1: float, a2: float, /, *, ra: bool = False) -> None: ...
+    @overload
+    def set(self, a1: float, a2: float, a3: float, /, *, ra: bool = False) -> None: ...
+    @overload
+    def set(self, a1: float, a2: float, a3: float, a4: float, /, *, ra: bool = False) -> None: ...
+    def set_radians(self, rads: float) -> None: ...
+    @overload
+    def set_ra(self) -> None: ...
+    @overload
+    def set_ra(self, a: float | Angle | list[float] | tuple[float, ...], /) -> None: ...
+    @overload
+    def set_ra(self, a1: float, a2: float, /) -> None: ...
+    @overload
+    def set_ra(self, a1: float, a2: float, a3: float, /) -> None: ...
+    @overload
+    def set_ra(self, a1: float, a2: float, a3: float, a4: float, /) -> None: ...
+    def dms_str(self, fancy: bool | None = True, n_dec: int = -1) -> str: ...
+    def get_ra(self) -> float: ...
+    def ra_str(self, fancy: bool | None = True, n_dec: int = -1) -> str: ...
+    def rad(self) -> float: ...
+    def dms_tuple(self) -> tuple[int, int, float, float]: ...
+    def ra_tuple(self) -> tuple[int, int, float, float]: ...
+    def to_positive(self) -> Self: ...
+    def __eq__(self, b: float | Angle) -> bool: ...  # type: ignore[override]
+    def __ne__(self, b: float | Angle) -> bool: ...  # type: ignore[override]
+    def __lt__(self, b: float | Angle) -> bool: ...
+    def __ge__(self, b: float | Angle) -> bool: ...
+    def __gt__(self, b: float | Angle) -> bool: ...
+    def __le__(self, b: float | Angle) -> bool: ...
+    def __neg__(self) -> Angle: ...
+    def __abs__(self) -> Angle: ...
+    def __mod__(self, b: float | Angle) -> Angle: ...
+    def __add__(self, b: float | Angle) -> Angle: ...
+    def __sub__(self, b: float | Angle) -> Angle: ...
+    def __mul__(self, b: float | Angle) -> Angle: ...
+    def __div__(self, b: float | Angle) -> Angle: ...
+    def __truediv__(self, b: float | Angle) -> Angle: ...
+    def __pow__(self, b: float | Angle) -> Angle: ...
+    def __imod__(self, b: float | Angle) -> Self: ...
+    def __iadd__(self, b: float | Angle) -> Self: ...
+    def __isub__(self, b: float | Angle) -> Self: ...
+    def __imul__(self, b: float | Angle) -> Self: ...
+    def __idiv__(self, b: float | Angle) -> Angle: ...
+    def __itruediv__(self, b: float | Angle) -> Self: ...
+    def __ipow__(self, b: float | Angle) -> Self: ...
+    def __rmod__(self, b: float | Angle) -> Angle: ...
+    def __radd__(self, b: float | Angle) -> Angle: ...
+    def __rsub__(self, b: float | Angle) -> Angle: ...
+    def __rmul__(self, b: float | Angle) -> Angle: ...
+    def __rdiv__(self, b: float | Angle) -> Angle: ...
+    def __rtruediv__(self, b: float | Angle) -> Angle: ...
+    def __rpow__(self, b: float | Angle) -> Angle: ...
+    def __float__(self) -> float: ...
+    def __int__(self) -> int: ...
+    def __round__(self, n: float = 0) -> Angle: ...
+
+def main() -> None: ...

stubs/PyMeeus/pymeeus/Coordinates.pyi

@@ -0,0 +1,192 @@
+import datetime
+from typing import Final, overload
+
+from pymeeus.Angle import Angle
+from pymeeus.Epoch import Epoch
+
+NUTATION_ARG_TABLE: Final[list[list[int]]]
+NUTATION_SINE_COEF_TABLE: Final[list[list[float]]]
+NUTATION_COSINE_COEF_TABLE: Final[list[list[float]]]
+
+@overload
+def mean_obliquity(
+    a: Epoch | list[float] | tuple[float, ...] | datetime.date,
+    /,
+    *,
+    leap_seconds: float = 0,
+    local: bool = False,
+    utc: bool = False,
+) -> Angle: ...
+@overload
+def mean_obliquity(
+    year: int, month: int, day: int, /, *, leap_seconds: float = 0, local: bool = False, utc: bool = False
+) -> Angle: ...
+@overload
+def true_obliquity(
+    a: Epoch | list[float] | tuple[float, ...] | datetime.date,
+    /,
+    *,
+    leap_seconds: float = 0,
+    local: bool = False,
+    utc: bool = False,
+) -> Angle: ...
+@overload
+def true_obliquity(
+    year: int, month: int, day: int, /, *, leap_seconds: float = 0, local: bool = False, utc: bool = False
+) -> Angle: ...
+@overload
+def nutation_longitude(
+    a: Epoch | list[float] | tuple[float, ...] | datetime.date,
+    /,
+    *,
+    leap_seconds: float = 0,
+    local: bool = False,
+    utc: bool = False,
+) -> Angle: ...
+@overload
+def nutation_longitude(
+    year: int, month: int, day: int, /, *, leap_seconds: float = 0, local: bool = False, utc: bool = False
+) -> Angle: ...
+@overload
+def nutation_obliquity(
+    a: Epoch | list[float] | tuple[float, ...] | datetime.date,
+    /,
+    *,
+    leap_seconds: float = 0,
+    local: bool = False,
+    utc: bool = False,
+) -> Angle: ...
+@overload
+def nutation_obliquity(
+    year: int, month: int, day: int, /, *, leap_seconds: float = 0, local: bool = False, utc: bool = False
+) -> Angle: ...
+def precession_equatorial(
+    start_epoch: Epoch,
+    final_epoch: Epoch,
+    start_ra: Angle,
+    start_dec: Angle,
+    p_motion_ra: float | Angle = 0.0,
+    p_motion_dec: float | Angle = 0.0,
+) -> tuple[Angle, Angle]: ...
+def precession_ecliptical(
+    start_epoch: Epoch,
+    final_epoch: Epoch,
+    start_lon: Angle,
+    start_lat: Angle,
+    p_motion_lon: float | Angle = 0.0,
+    p_motion_lat: float | Angle = 0.0,
+) -> tuple[Angle, Angle]: ...
+def p_motion_equa2eclip(
+    p_motion_ra: Angle, p_motion_dec: Angle, ra: Angle, dec: Angle, lat: Angle, epsilon: Angle
+) -> tuple[float, float]: ...
+def precession_newcomb(
+    start_epoch: Epoch,
+    final_epoch: Epoch,
+    start_ra: Angle,
+    start_dec: Angle,
+    p_motion_ra: float | Angle = 0.0,
+    p_motion_dec: float | Angle = 0.0,
+) -> tuple[Angle, Angle]: ...
+def motion_in_space(
+    start_ra: Angle,
+    start_dec: Angle,
+    distance: float,
+    velocity: float,
+    p_motion_ra: float | Angle,
+    p_motion_dec: float | Angle,
+    time: float,
+) -> tuple[Angle, Angle]: ...
+def equatorial2ecliptical(right_ascension: Angle, declination: Angle, obliquity: Angle) -> tuple[Angle, Angle]: ...
+def ecliptical2equatorial(longitude: Angle, latitude: Angle, obliquity: Angle) -> tuple[Angle, Angle]: ...
+def equatorial2horizontal(hour_angle: Angle, declination: Angle, geo_latitude: Angle) -> tuple[Angle, Angle]: ...
+def horizontal2equatorial(azimuth: Angle, elevation: Angle, geo_latitude: Angle) -> tuple[Angle, Angle]: ...
+def equatorial2galactic(right_ascension: Angle, declination: Angle) -> tuple[Angle, Angle]: ...
+def galactic2equatorial(longitude: Angle, latitude: Angle) -> tuple[Angle, Angle]: ...
+def parallactic_angle(hour_angle: Angle, declination: Angle, geo_latitude: Angle) -> Angle | None: ...
+def ecliptic_horizon(local_sidereal_time: Angle, geo_latitude: Angle, obliquity: Angle) -> tuple[Angle, Angle, Angle]: ...
+def ecliptic_equator(longitude: Angle, latitude: Angle, obliquity: Angle) -> Angle: ...
+def diurnal_path_horizon(declination: Angle, geo_latitude: Angle) -> Angle: ...
+def times_rise_transit_set(
+    longitude: Angle,
+    latitude: Angle,
+    alpha1: Angle,
+    delta1: Angle,
+    alpha2: Angle,
+    delta2: Angle,
+    alpha3: Angle,
+    delta3: Angle,
+    h0: Angle,
+    delta_t: float,
+    theta0: Angle,
+) -> tuple[float, float, float] | tuple[None, None, None]: ...
+def refraction_apparent2true(apparent_elevation: Angle, pressure: float = 1010.0, temperature: float = 10.0) -> Angle: ...
+def refraction_true2apparent(true_elevation: Angle, pressure: float = 1010.0, temperature: float = 10.0) -> Angle: ...
+def angular_separation(alpha1: Angle, delta1: Angle, alpha2: Angle, delta2: Angle) -> Angle: ...
+def minimum_angular_separation(
+    alpha1_1: Angle,
+    delta1_1: Angle,
+    alpha1_2: Angle,
+    delta1_2: Angle,
+    alpha1_3: Angle,
+    delta1_3: Angle,
+    alpha2_1: Angle,
+    delta2_1: Angle,
+    alpha2_2: Angle,
+    delta2_2: Angle,
+    alpha2_3: Angle,
+    delta2_3: Angle,
+) -> tuple[float, Angle]: ...
+def relative_position_angle(alpha1: Angle, delta1: Angle, alpha2: Angle, delta2: Angle) -> Angle: ...
+def planetary_conjunction(
+    alpha1_list: list[Angle] | tuple[Angle, ...],
+    delta1_list: list[Angle] | tuple[Angle, ...],
+    alpha2_list: list[Angle] | tuple[Angle, ...],
+    delta2_list: list[Angle] | tuple[Angle, ...],
+) -> tuple[float, Angle]: ...
+def planet_star_conjunction(
+    alpha_list: list[Angle] | tuple[Angle, ...], delta_list: list[Angle] | tuple[Angle, ...], alpha_star: Angle, delta_star: Angle
+) -> tuple[float, Angle]: ...
+def planet_stars_in_line(
+    alpha_list: list[Angle] | tuple[Angle, ...],
+    delta_list: list[Angle] | tuple[Angle, ...],
+    alpha_star1: Angle,
+    delta_star1: Angle,
+    alpha_star2: Angle,
+    delta_star2: Angle,
+) -> float: ...
+def straight_line(
+    alpha1: Angle, delta1: Angle, alpha2: Angle, delta2: Angle, alpha3: Angle, delta3: Angle
+) -> tuple[Angle, Angle]: ...
+def circle_diameter(alpha1: Angle, delta1: Angle, alpha2: Angle, delta2: Angle, alpha3: Angle, delta3: Angle) -> Angle: ...
+def vsop_pos(
+    epoch: Epoch, vsop_l: list[list[list[float]]], vsop_b: list[list[list[float]]], vsop_r: list[list[list[float]]]
+) -> tuple[Angle, Angle, float]: ...
+def geometric_vsop_pos(
+    epoch: Epoch,
+    vsop_l: list[list[list[float]]],
+    vsop_b: list[list[list[float]]],
+    vsop_r: list[list[list[float]]],
+    tofk5: bool | None = True,
+) -> tuple[Angle, Angle, float]: ...
+def apparent_vsop_pos(
+    epoch: Epoch,
+    vsop_l: list[list[list[float]]],
+    vsop_b: list[list[list[float]]],
+    vsop_r: list[list[list[float]]],
+    nutation: bool | None = True,
+) -> tuple[Angle, Angle, float]: ...
+def apparent_position(epoch: Epoch, alpha: Angle, delta: Angle, sun_lon: Angle) -> tuple[Angle, Angle]: ...
+def orbital_equinox2equinox(epoch0: Epoch, epoch: Epoch, i0: Angle, arg0: Angle, lon0: Angle) -> tuple[Angle, Angle, Angle]: ...
+def kepler_equation(eccentricity: float, mean_anomaly: Angle) -> tuple[Angle, Angle]: ...
+def orbital_elements(
+    epoch: Epoch, parameters1: list[list[float]], parameters2: list[list[float]]
+) -> tuple[Angle, float, float, Angle, Angle, Angle]: ...
+def velocity(r: float, a: float) -> float: ...
+def velocity_perihelion(e: float, a: float) -> float: ...
+def velocity_aphelion(e: float, a: float) -> float: ...
+def length_orbit(e: float, a: float) -> float: ...
+def passage_nodes_elliptic(omega: Angle, e: float, a: float, t: Epoch, ascending: bool | None = True) -> tuple[Epoch, float]: ...
+def passage_nodes_parabolic(omega: Angle, q: float, t: Epoch, ascending: bool | None = True) -> tuple[Epoch, float]: ...
+def phase_angle(sun_dist: float, earth_dist: float, sun_earth_dist: float) -> Angle: ...
+def illuminated_fraction(sun_dist: float, earth_dist: float, sun_earth_dist: float) -> float: ...
+def main() -> None: ...

stubs/PyMeeus/pymeeus/CurveFitting.pyi

@@ -0,0 +1,43 @@
+from collections.abc import Callable
+from typing import overload
+
+from pymeeus.Angle import Angle
+
+class CurveFitting:
+    @overload
+    def __init__(self) -> None: ...
+    @overload
+    def __init__(self, a: CurveFitting, /) -> None: ...
+    @overload
+    def __init__(self, a: list[float | Angle] | tuple[float | Angle, ...], /) -> None: ...
+    @overload
+    def __init__(
+        self, a1: list[float | Angle] | tuple[float | Angle, ...], a2: list[float | Angle] | tuple[float | Angle, ...], /
+    ) -> None: ...
+    @overload
+    def __init__(
+        self, a1: float | Angle, a2: float | Angle, a3: float | Angle, a4: float | Angle, /, *rest: float | Angle
+    ) -> None: ...
+    @overload
+    def set(self) -> None: ...
+    @overload
+    def set(self, a: CurveFitting, /) -> None: ...
+    @overload
+    def set(self, a: list[float | Angle] | tuple[float | Angle, ...], /) -> None: ...
+    @overload
+    def set(
+        self, a1: list[float | Angle] | tuple[float | Angle, ...], a2: list[float | Angle] | tuple[float | Angle, ...], /
+    ) -> None: ...
+    @overload
+    def set(
+        self, a1: float | Angle, a2: float | Angle, a3: float | Angle, a4: float | Angle, /, *rest: float | Angle
+    ) -> None: ...
+    def __len__(self) -> int: ...
+    def correlation_coeff(self) -> float: ...
+    def linear_fitting(self) -> tuple[float, float]: ...
+    def quadratic_fitting(self) -> tuple[float, float, float]: ...
+    def general_fitting(
+        self, f0: Callable[..., float], f1: Callable[..., float] = ..., f2: Callable[..., float] = ...
+    ) -> tuple[float, float, float]: ...
+
+def main() -> None: ...