EAScheduler 0.2.1__tar.gz → 0.2.2__tar.gz

{eascheduler-0.2.1/src/EAScheduler.egg-info → eascheduler-0.2.2}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.2
 Name: EAScheduler
-Version: 0.2.1
+Version: 0.2.2
 Summary: Easy async scheduling with a nice interface
 Home-page: https://github.com/spacemanspiff2007/eascheduler
 Author: spaceman_spiff
@@ -19,10 +19,20 @@ Classifier: Programming Language :: Python :: 3 :: Only
 Requires-Python: >=3.10
 Description-Content-Type: text/markdown
 License-File: LICENSE
-Requires-Dist: whenever==0.6.13
+Requires-Dist: whenever==0.6.16
 Requires-Dist: astral==3.2
-Requires-Dist: holidays==0.61
+Requires-Dist: holidays==0.64
 Requires-Dist: typing_extensions==4.12.2
+Dynamic: author
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: keywords
+Dynamic: project-url
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
 
 # EAScheduler
 [![Tests Status](https://github.com/spacemanspiff2007/eascheduler/workflows/Tests/badge.svg)](https://github.com/spacemanspiff2007/eascheduler/actions)
@@ -126,6 +136,10 @@ scheduler.at(
 ````
 
 ## Changelog
+#### 0.2.2 (2025-01-07)
+- Ensured that all trigger builders are imputable and can be composed without side effects
+- Updated dependencies
+
 #### 0.2.1 (2024-11-20)
 - Updated dependencies and some type hints
 

{eascheduler-0.2.1 → eascheduler-0.2.2}/requirements_setup.txt

@@ -1,6 +1,6 @@
 # Requirements to install and use this library
-whenever == 0.6.13
+whenever == 0.6.16
 astral   == 3.2
-holidays == 0.61
+holidays == 0.64
 
 typing_extensions == 4.12.2

{eascheduler-0.2.1 → eascheduler-0.2.2/src/EAScheduler.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.2
 Name: EAScheduler
-Version: 0.2.1
+Version: 0.2.2
 Summary: Easy async scheduling with a nice interface
 Home-page: https://github.com/spacemanspiff2007/eascheduler
 Author: spaceman_spiff
@@ -19,10 +19,20 @@ Classifier: Programming Language :: Python :: 3 :: Only
 Requires-Python: >=3.10
 Description-Content-Type: text/markdown
 License-File: LICENSE
-Requires-Dist: whenever==0.6.13
+Requires-Dist: whenever==0.6.16
 Requires-Dist: astral==3.2
-Requires-Dist: holidays==0.61
+Requires-Dist: holidays==0.64
 Requires-Dist: typing_extensions==4.12.2
+Dynamic: author
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: keywords
+Dynamic: project-url
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
 
 # EAScheduler
 [![Tests Status](https://github.com/spacemanspiff2007/eascheduler/workflows/Tests/badge.svg)](https://github.com/spacemanspiff2007/eascheduler/actions)
@@ -126,6 +136,10 @@ scheduler.at(
 ````
 
 ## Changelog
+#### 0.2.2 (2025-01-07)
+- Ensured that all trigger builders are imputable and can be composed without side effects
+- Updated dependencies
+
 #### 0.2.1 (2024-11-20)
 - Updated dependencies and some type hints
 

{eascheduler-0.2.1 → eascheduler-0.2.2}/src/EAScheduler.egg-info/requires.txt

@@ -1,4 +1,4 @@
-whenever==0.6.13
+whenever==0.6.16
 astral==3.2
-holidays==0.61
+holidays==0.64
 typing_extensions==4.12.2

eascheduler-0.2.2/src/eascheduler/__version__.py

@@ -0,0 +1 @@
+__version__ = '0.2.2'

{eascheduler-0.2.1 → eascheduler-0.2.2}/src/eascheduler/builder/filters.py

@@ -35,7 +35,7 @@ class FilterObject:
         self._filter: Final = filter
 
 
-_get_producer_filter = BuilderTypeValidator(FilterObject, ProducerFilterBase, '_filter')
+_get_producer_filter: Final = BuilderTypeValidator(FilterObject, ProducerFilterBase, '_filter')
 
 
 # noinspection PyProtectedMember,PyShadowingBuiltins

{eascheduler-0.2.1 → eascheduler-0.2.2}/src/eascheduler/builder/helper.py

@@ -103,7 +103,7 @@ def get_instant(value: HINT_INSTANT) -> Instant:
     # timedelta
     try:
         timedelta = get_timedelta(value)
-    except ValueError:
+    except (ValueError, TypeError):
         pass
     else:
         return Instant.now() + timedelta
@@ -112,7 +112,7 @@ def get_instant(value: HINT_INSTANT) -> Instant:
     # time
     try:
         time = get_time(value)
-    except ValueError:
+    except (ValueError, TypeError):
         pass
     else:
         now = SystemDateTime.now()
@@ -228,7 +228,8 @@ class BuilderTypeValidator(Generic[TYPE_OUT]):
             msg = f'Expected an instance of {self.type_out.__name__}, got {obj} ({type(obj).__name__})'
             raise TypeError(msg)
 
-        return obj
+        # We return a copy so we are sure that there are no side effects
+        return obj.copy()
 
     def __repr__(self) -> str:
         return f'{self.__class__.__name__}({self.type_in.__name__}, {self.type_out.__name__}, {self.var_name})'

{eascheduler-0.2.1 → eascheduler-0.2.2}/src/eascheduler/builder/triggers.py

@@ -4,6 +4,7 @@ from typing import TYPE_CHECKING, Final, Literal
 
 from typing_extensions import Self
 
+from eascheduler.builder.filters import _get_producer_filter
 from eascheduler.builder.helper import (
     HINT_CLOCK_BACKWARD,
     HINT_CLOCK_FORWARD,
@@ -27,8 +28,8 @@ from eascheduler.producers import (
     LatestProducerOperation,
     NoonProducer,
     OffsetProducerOperation,
-    SunAzimuthProducer,
-    SunElevationProducer,
+    SunAzimuthProducerCompare,
+    SunElevationProducerCompare,
     SunriseProducer,
     SunsetProducer,
     TimeProducer,
@@ -51,7 +52,7 @@ class TriggerObject:
         :param offset: The offset (positive or negative)
         """
         return self.__class__(
-            OffsetProducerOperation(self._producer, get_timedelta(offset).in_seconds())
+            OffsetProducerOperation(_get_producer(self), get_timedelta(offset).in_seconds())
         )
 
     def earliest(self, earliest: HINT_TIME, *,
@@ -65,7 +66,7 @@ class TriggerObject:
         """
         return self.__class__(
             EarliestProducerOperation(
-                self._producer,
+                _get_producer(self),
                 get_time_replacer(earliest, clock_forward=clock_forward, clock_backward=clock_backward)
             )
         )
@@ -81,7 +82,7 @@ class TriggerObject:
         """
         return self.__class__(
             LatestProducerOperation(
-                self._producer,
+                _get_producer(self),
                 get_time_replacer(latest, clock_forward=clock_forward, clock_backward=clock_backward)
             )
         )
@@ -94,7 +95,7 @@ class TriggerObject:
         """
         return self.__class__(
             JitterProducerOperation(
-                self._producer,
+                _get_producer(self),
                 get_timedelta(low).in_seconds(), get_timedelta(high).in_seconds() if high is not None else None
             )
         )
@@ -106,7 +107,7 @@ class TriggerObject:
         """
         if self._producer._filter is not None:
             raise ValueError()
-        self._producer._filter = filter._filter
+        self._producer._filter = _get_producer_filter(filter)
         return self
 
     only_at = only_on
@@ -146,7 +147,7 @@ class TriggerBuilder:
         :param elevation: Sun elevation in degrees
         :param direction: rising or falling
         """
-        return TriggerObject(SunElevationProducer(elevation, direction))
+        return TriggerObject(SunElevationProducerCompare(elevation, direction))
 
     @staticmethod
     def sun_azimuth(azimuth: float) -> TriggerObject:
@@ -154,7 +155,7 @@ class TriggerBuilder:
 
         :param azimuth: Sun azimuth in degrees
         """
-        return TriggerObject(SunAzimuthProducer(azimuth))
+        return TriggerObject(SunAzimuthProducerCompare(azimuth))
 
     @staticmethod
     def group(*builders: TriggerObject) -> TriggerObject:
@@ -200,4 +201,4 @@ class TriggerBuilder:
         )
 
 
-_get_producer = BuilderTypeValidator(TriggerObject, DateTimeProducerBase, '_producer')
+_get_producer: Final = BuilderTypeValidator(TriggerObject, DateTimeProducerBase, '_producer')

{eascheduler-0.2.1 → eascheduler-0.2.2}/src/eascheduler/helpers/time_replace.py

@@ -3,6 +3,7 @@ from __future__ import annotations
 from enum import Enum
 from typing import TYPE_CHECKING, Final, Literal, TypeAlias
 
+from typing_extensions import Self
 from whenever import Date, LocalDateTime, RepeatedTime, SkippedTime, SystemDateTime, Time
 
 from eascheduler.helpers.helpers import to_enum
@@ -60,7 +61,7 @@ class TimeTwiceError(Exception):
 
 
 class TimeReplacer:
-    __slots__ = ('_time', '_skipped', '_repeated')
+    __slots__ = ('_repeated', '_skipped', '_time')
 
     def __init__(self, time: Time, if_skipped: HINT_SKIPPED, if_repeated: HINT_REPEATED) -> None:
         super().__init__()
@@ -68,10 +69,18 @@ class TimeReplacer:
         self._skipped: Final[SkippedTimeBehavior] = to_enum(SkippedTimeBehavior, if_skipped)
         self._repeated: Final[RepeatedTimeBehavior] = to_enum(RepeatedTimeBehavior, if_repeated)
 
+    def __eq__(self, other: object) -> bool:
+        if not isinstance(other, TimeReplacer):
+            return NotImplemented
+        return self._time == other._time and self._skipped == other._skipped and self._repeated == other._repeated
+
     def __repr__(self) -> str:
         return (f'<{self.__class__.__name__} {self._time!s}'
                 f' if_skipped={self._skipped.value:s} if_repeated={self._repeated.value:s}>')
 
+    def copy(self) -> Self:
+        return self.__class__(self._time, self._skipped, self._repeated)
+
     def replace(self, dt: SystemDateTime | Date) -> SystemDateTime:  # noqa: C901
 
         kwargs = {

{eascheduler-0.2.1 → eascheduler-0.2.2}/src/eascheduler/producers/__init__.py

@@ -21,8 +21,8 @@ from .prod_sun import (
     DawnProducer,
     DuskProducer,
     NoonProducer,
-    SunAzimuthProducer,
-    SunElevationProducer,
+    SunAzimuthProducerCompare,
+    SunElevationProducerCompare,
     SunriseProducer,
     SunsetProducer,
 )

{eascheduler-0.2.1 → eascheduler-0.2.2}/src/eascheduler/producers/base.py

@@ -1,8 +1,8 @@
 from __future__ import annotations
 
-from typing import TYPE_CHECKING, NoReturn
+from typing import TYPE_CHECKING, NoReturn, TypeVar
 
-from typing_extensions import override
+from typing_extensions import Self, override
 
 from eascheduler.errors import InfiniteLoopDetectedError
 
@@ -13,14 +13,30 @@ if TYPE_CHECKING:
     from whenever import Instant, SystemDateTime
 
 
-class ProducerFilterBase:
+class CompareEqualityBySlotValues:
+    __slots__ = ()
+
+    # Since all classes use slots we can compare them by comparing their slot values
+    def __eq__(self, other: object) -> bool:
+        if not isinstance(other, self.__class__):
+            raise TypeError()
+        return all(getattr(self, s) == getattr(other, s) for s in self.__slots__)
+
+
+class ProducerFilterBase(CompareEqualityBySlotValues):
     __slots__ = ()
 
     def allow(self, dt: SystemDateTime) -> bool:
         raise NotImplementedError()
 
+    def copy(self) -> Self:
+        raise NotImplementedError()
+
 
-class DateTimeProducerBase:
+DTPB_TYPE = TypeVar('DTPB_TYPE', bound='DateTimeProducerBase')
+
+
+class DateTimeProducerBase(CompareEqualityBySlotValues):
     __slots__ = ('_filter', )
 
     def __init__(self) -> None:
@@ -31,6 +47,13 @@ class DateTimeProducerBase:
         Has to guarantee that the returned date time is after the given date time."""
         raise NotImplementedError()
 
+    def _copy_filter(self, obj: DTPB_TYPE) -> DTPB_TYPE:
+        obj._filter = self._filter.copy() if self._filter is not None else None
+        return obj
+
+    def copy(self) -> Self:
+        raise NotImplementedError()
+
 
 class DateTimeProducerOperationBase(DateTimeProducerBase):
     __slots__ = ('_producer', )

{eascheduler-0.2.1 → eascheduler-0.2.2}/src/eascheduler/producers/prod_filter.py

@@ -24,6 +24,9 @@ class ProducerFilterGroupBase(ProducerFilterBase):
         self._filters = (*self._filters, filter)
         return self
 
+    def copy(self) -> Self:
+        return self.__class__(f.copy() for f in self._filters)
+
 
 class AnyGroupProducerFilter(ProducerFilterGroupBase):
     @override
@@ -44,6 +47,10 @@ class InvertingProducerFilter(ProducerFilterBase):
     def __init__(self, filter: ProducerFilterBase) -> None:  # noqa: A002
         self._filter: ProducerFilterBase = filter
 
+    @override
+    def copy(self) -> Self:
+        return self.__class__(self._filter.copy())
+
     @override
     def allow(self, dt: SystemDateTime) -> bool:
         return not self._filter.allow(dt)
@@ -57,6 +64,10 @@ class TimeProducerFilter(ProducerFilterBase):
         self._lower: Final = lower
         self._upper: Final = upper
 
+    @override
+    def copy(self) -> Self:
+        return self.__class__(self._lower, self._upper)
+
     @override
     def allow(self, dt: SystemDateTime) -> bool:
 
@@ -77,6 +88,10 @@ class DayOfWeekProducerFilter(ProducerFilterBase):
         super().__init__()
         self._weekdays: Final = frozenset(weekdays)
 
+    @override
+    def copy(self) -> Self:
+        return self.__class__(self._weekdays)
+
     @override
     def allow(self, dt: SystemDateTime) -> bool:
         return dt.py_datetime().isoweekday() in self._weekdays
@@ -89,6 +104,10 @@ class DayOfMonthProducerFilter(ProducerFilterBase):
         super().__init__()
         self._days: Final = frozenset(days)
 
+    @override
+    def copy(self) -> DayOfMonthProducerFilter:
+        return self.__class__(self._days)
+
     @override
     def allow(self, dt: SystemDateTime) -> bool:
         return dt.day in self._days
@@ -101,6 +120,9 @@ class MonthOfYearProducerFilter(ProducerFilterBase):
         super().__init__()
         self._months: Final = frozenset(months)
 
+    def copy(self) -> Self:
+        return self.__class__(self._months)
+
     @override
     def allow(self, dt: SystemDateTime) -> bool:
         return dt.month in self._months

{eascheduler-0.2.1 → eascheduler-0.2.2}/src/eascheduler/producers/prod_filter_holiday.py

@@ -4,7 +4,7 @@ from typing import TYPE_CHECKING, Any, Final
 
 from holidays import HolidayBase as _HolidayBase
 from holidays import country_holidays
-from typing_extensions import override
+from typing_extensions import Self, override
 
 from eascheduler.errors.errors import HolidaysNotSetUpError
 from eascheduler.producers.base import ProducerFilterBase
@@ -24,6 +24,10 @@ class HolidayProducerFilterBase(ProducerFilterBase):
         super().__init__()
         self._holidays: Final = _get_holiday_obj(holidays)
 
+    @override
+    def copy(self) -> Self:
+        return self.__class__(self._holidays)
+
 
 class HolidayProducerFilter(HolidayProducerFilterBase):
     @override

{eascheduler-0.2.1 → eascheduler-0.2.2}/src/eascheduler/producers/prod_group.py

@@ -2,6 +2,8 @@ from __future__ import annotations
 
 from typing import TYPE_CHECKING, Final
 
+from typing_extensions import Self, override
+
 from .base import DateTimeProducerBase, not_infinite_loop
 
 
@@ -18,6 +20,11 @@ class GroupProducer(DateTimeProducerBase):
         super().__init__()
         self._producers: Final = tuple(producers)
 
+    @override
+    def copy(self) -> Self:
+        cls = self.__class__(p.copy() for p in self._producers)
+        return self._copy_filter(cls)
+
     def get_next(self, dt: Instant) -> Instant:   # type: ignore[return]
 
         next_dt = dt

{eascheduler-0.2.1 → eascheduler-0.2.2}/src/eascheduler/producers/prod_interval.py

@@ -2,7 +2,7 @@ from __future__ import annotations
 
 from typing import TYPE_CHECKING, Final
 
-from typing_extensions import override
+from typing_extensions import Self, override
 
 from .base import DateTimeProducerBase
 
@@ -20,6 +20,11 @@ class IntervalProducer(DateTimeProducerBase):
         self._next: Instant | None = start
         self._interval: Final = interval
 
+    @override
+    def copy(self) -> Self:
+        cls = self.__class__(start=self._next, interval=self._interval)
+        return self._copy_filter(cls)
+
     @override
     def get_next(self, dt: Instant) -> Instant:
         interval = self._interval

{eascheduler-0.2.1 → eascheduler-0.2.2}/src/eascheduler/producers/prod_operation.py

@@ -3,7 +3,7 @@ from __future__ import annotations
 from random import uniform
 from typing import TYPE_CHECKING, Final
 
-from typing_extensions import override
+from typing_extensions import Self, override
 from whenever import LocalDateTime, SkippedTime, SystemDateTime, Time, TimeDelta
 
 from eascheduler.helpers import TimeReplacer, TimeSkippedError, TimeTwiceError
@@ -34,6 +34,11 @@ class OffsetProducerOperation(DateTimeProducerOperationBase):
         super().__init__(producer)
         self.offset: Final = offset
 
+    @override
+    def copy(self) -> Self:
+        cls = self.__class__(self._producer.copy(), self.offset)
+        return self._copy_filter(cls)
+
     @override
     def apply_operation(self, next_dt: Instant, dt: Instant) -> Instant:
         return next_dt.add(seconds=self.offset)
@@ -46,6 +51,11 @@ class EarliestProducerOperation(DateTimeProducerOperationBase):
         super().__init__(producer)
         self.earliest: Final = earliest
 
+    @override
+    def copy(self) -> Self:
+        cls = self.__class__(self._producer.copy(), self.earliest.copy())
+        return self._copy_filter(cls)
+
     @override
     def apply_operation(self, next_dt: Instant, dt: Instant) -> Instant:
         try:
@@ -69,6 +79,11 @@ class LatestProducerOperation(DateTimeProducerOperationBase):
         super().__init__(producer)
         self.latest: Final = earliest
 
+    @override
+    def copy(self) -> Self:
+        cls = self.__class__(self._producer.copy(), self.latest.copy())
+        return self._copy_filter(cls)
+
     @override
     def apply_operation(self, next_dt: Instant, dt: Instant) -> Instant:
         try:
@@ -86,7 +101,7 @@ class LatestProducerOperation(DateTimeProducerOperationBase):
 
 
 class JitterProducerOperation(DateTimeProducerOperationBase):
-    __slots__ = ('low', 'high')
+    __slots__ = ('high', 'low')
 
     def __init__(self, producer: DateTimeProducerBase, low: float, high: float | None = None) -> None:
         super().__init__(producer)
@@ -100,6 +115,11 @@ class JitterProducerOperation(DateTimeProducerOperationBase):
         self.low: Final = low
         self.high: Final = high
 
+    @override
+    def copy(self) -> Self:
+        cls = self.__class__(self._producer.copy(), self.low, self.high)
+        return self._copy_filter(cls)
+
     @override
     def apply_operation(self, next_dt: Instant, dt: Instant) -> Instant:
         if (low := self.low) >= 0:

{eascheduler-0.2.1 → eascheduler-0.2.2}/src/eascheduler/producers/prod_sun.py

@@ -7,7 +7,7 @@ from datetime import timezone as dt_timezone
 from typing import TYPE_CHECKING, Final, Literal
 
 from astral import Observer, SunDirection, sun
-from typing_extensions import override
+from typing_extensions import Self, override
 from whenever import Instant
 
 from eascheduler.errors.errors import LocationNotSetError
@@ -66,6 +66,11 @@ class SunProducer(DateTimeProducerBase):
 
         self.func: Final = func
 
+    @override
+    def copy(self) -> Self:
+        cls = self.__class__()
+        return self._copy_filter(cls)
+
     def _cache_key(self) -> tuple[Hashable, ...]:
         return (self.__class__, )
 
@@ -150,16 +155,33 @@ class DuskProducer(SunProducer):
         super().__init__(sun.dusk)
 
 
-class SunElevationProducer(SunProducer):
+class SunFuncIgnoringCompare:
+    __slots__ = ()
+
+    def __eq__(self, other: object) -> bool:
+        if not isinstance(other, self.__class__):
+            raise TypeError()
+        return all(getattr(self, s) == getattr(other, s) for s in self.__slots__ if s != 'func')
+
+
+class SunElevationProducerCompare(SunProducer, SunFuncIgnoringCompare):
+    __slots__ = ('direction', 'elevation')
+
     def __init__(self, elevation: float, direction: Literal['rising', 'setting']) -> None:
         if elevation < -90 or elevation > 90:
             msg = 'Elevation must be between -90 and 90'
             raise ValueError(msg)
 
         self.elevation: Final = elevation
-        self.direction: Final = {'rising': SunDirection.RISING, 'setting': SunDirection.SETTING}[direction]
+        self.direction: Final = {'rising': SunDirection.RISING, 'setting': SunDirection.SETTING}[direction] \
+            if direction is not SunDirection.RISING and direction is not SunDirection.SETTING else direction
         super().__init__(self._sun_func)
 
+    @override
+    def copy(self) -> Self:
+        cls = self.__class__(self.elevation, self.direction)
+        return self._copy_filter(cls)
+
     def _sun_func(self, observer: Observer, date: dt_date) -> datetime:
         return sun.time_at_elevation(observer, self.elevation, date, self.direction)
 
@@ -168,7 +190,9 @@ class SunElevationProducer(SunProducer):
         return self.__class__, self.elevation, self.direction
 
 
-class SunAzimuthProducer(SunProducer):
+class SunAzimuthProducerCompare(SunProducer, SunFuncIgnoringCompare):
+    __slots__ = ('azimuth', )
+
     def __init__(self, azimuth: float) -> None:
         if not 0 <= azimuth <= 360:
             msg = 'Azimuth must be between 0° and 360°'
@@ -177,6 +201,11 @@ class SunAzimuthProducer(SunProducer):
         self.azimuth: Final = azimuth
         super().__init__(self._sun_func)
 
+    @override
+    def copy(self) -> Self:
+        cls = self.__class__(self.azimuth)
+        return self._copy_filter(cls)
+
     @override
     def _cache_key(self) -> tuple[Hashable, ...]:
         return self.__class__, self.azimuth

{eascheduler-0.2.1 → eascheduler-0.2.2}/src/eascheduler/producers/prod_time.py

@@ -2,7 +2,7 @@ from __future__ import annotations
 
 from typing import TYPE_CHECKING, Final
 
-from typing_extensions import override
+from typing_extensions import Self, override
 
 from eascheduler.helpers import TimeReplacer, TimeSkippedError, TimeTwiceError
 from eascheduler.producers.base import DateTimeProducerBase, not_infinite_loop
@@ -19,6 +19,11 @@ class TimeProducer(DateTimeProducerBase):
         super().__init__()
         self._time: Final = time
 
+    @override
+    def copy(self) -> Self:
+        cls = self.__class__(time=self._time.copy())
+        return self._copy_filter(cls)
+
     @override
     def get_next(self, dt: Instant) -> Instant:     # type: ignore[return]
 

eascheduler-0.2.1/src/eascheduler/__version__.py

@@ -1 +0,0 @@
-__version__ = '0.2.1'