solar

Solar event. A solar event can be used as the run_every value of a periodic task entry to schedule based on certain solar events.

Constructor

def solar(
    event: str,
    lat: int | float,
    lon: int | float,
    **kwargs: Any
) - > None

Name	Type	Description
event	`str`	The solar event that triggers the task (e.g., 'sunrise', 'sunset').
lat	`int	float`
lon	`int	float`
**kwargs	`Any`	Additional keyword arguments passed to the BaseSchedule parent class.

def solar(
    event: str,
    lat: float,
    lon: float
) - > null

Name	Type	Description
event	`str`	The specific solar event (e.g., 'sunrise', 'sunset') that triggers the task.
lat	`float`	The latitude of the observer, constrained between -90 and 90.
lon	`float`	The longitude of the observer, constrained between -180 and 180.

@classmethod
def remaining_estimate(
    last_run_at: datetime
) - > timedelta

Return estimate of next time to run.

Name	Type	Description
last_run_at	`datetime`	The timestamp of the last successful execution used to calculate the next occurrence.

Type	Description
`timedelta`	When the periodic task should run next, or if it shouldn't run today (e.g., the sun does not rise today), returns the time when the next check should take place.

@classmethod
def is_due(
    last_run_at: datetime
) - > tuple

Return tuple of (is_due, next_time_to_run).

Name	Type	Description
last_run_at	`datetime`	The timestamp of the last execution used to determine if the solar event has passed.

Type	Description
`tuple`	A tuple where the first element is a boolean indicating if the task is due, and the second is the delay until the next run in seconds.