Done with version 1.2.0, still need to setup readthedocs stuff

CHANGELOG.md

@@ -7,6 +7,12 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ---
 
+## [1.2.0] - 2024-06-20
+
+### Added
+
+- Altered sequence processing to make use of numpy vectorization.
+
 ## [1.1.1] - 2024-06-17
 
 ### Fixed

pyproject.toml

@@ -5,7 +5,7 @@ build-backend = "setuptools.build_meta"
 [project]
 name = "temporal_adjuster"
 dynamic = ["dependencies"]
-version = "1.1.0"
+version = "1.2.0"
 description = "Adjusters are a key tool for modifying temporal objects. They exist to externalize the process of adjustment, permitting different approaches, as per the strategy design pattern. Temporal Adjuster provides tools that help pinpoint very specific moments in time, without having to manually count days, weeks, or months."
 requires-python = ">= 3.3"
 authors = [

requirements_dev.txt

@@ -1,4 +1,5 @@
 coverage
+mypy
 pandas
 pre-commit
 psutil

temporal_adjuster/common/decorators/sequence_processor.pyi

@@ -0,0 +1,8 @@
+from typing import TypeVar
+
+T = TypeVar("T")
+
+def sequenceable(target: str):
+    """
+    This decorator is used to process if a sequence of values passed as an argument to a function. The function is called for each value in the sequence, and the result is stored in the same position in the sequence.
+    """

temporal_adjuster/common/enums/day_of_week.pyi

@@ -0,0 +1,33 @@
+from enum import IntEnum
+
+class Weekday(IntEnum):
+    """
+    A day-of-week, such as 'Tuesday'.
+    Weekday is an enum representing the 7 days of the week - Monday, Tuesday, Wednesday, Thursday, Friday, Saturday and Sunday.
+
+    In addition to the textual enum name, each day-of-week has an int value. The int value follows the Python datetime standard, from 0 (Monday) to 6 (Sunday).
+    """
+
+    MONDAY: int
+    TUESDAY: int
+    WEDNESDAY: int
+    THURSDAY: int
+    FRIDAY: int
+    SATURDAY: int
+    SUNDAY: int
+
+class ISOWeekday(IntEnum):
+    """
+    A day-of-week, such as 'Tuesday'.
+    Weekday is an enum representing the 7 days of the week - Monday, Tuesday, Wednesday, Thursday, Friday, Saturday and Sunday.
+
+    In addition to the textual enum name, each day-of-week has an int value. The int value follows the ISO-8601 standard, from 1 (Monday) to 7 (Sunday).
+    """
+
+    MONDAY: int
+    TUESDAY: int
+    WEDNESDAY: int
+    THURSDAY: int
+    FRIDAY: int
+    SATURDAY: int
+    SUNDAY: int

temporal_adjuster/common/exceptions/common.pyi

@@ -0,0 +1 @@
+class DateError(Exception): ...

temporal_adjuster/common/types/dates.pyi

@@ -0,0 +1,5 @@
+from datetime import date, datetime
+from typing import TypeVar
+
+AnyDate = datetime | date
+DateT = TypeVar("DateT", bound=AnyDate)

temporal_adjuster/modules/first_and_last_day_operations.py

@@ -9,9 +9,7 @@
 class _TemporalAdjusterForFirstAndLastDays:
     @staticmethod
     @sequenceable(target="date")
-    def first_day_of_week(
-        date: Union[DateT, Sequence[DateT]]
-    ) -> Union[DateT, Sequence[DateT]]:
+    def first_day_of_week(date: DateT) -> DateT:
         """
         Returns the first day of the week of the given date. The week starts on Monday.
 
@@ -25,9 +23,7 @@ def first_day_of_week(
 
     @staticmethod
     @sequenceable(target="date")
-    def first_day_of_next_week(
-        date: Union[DateT, Sequence[DateT]]
-    ) -> Union[DateT, Sequence[DateT]]:
+    def first_day_of_next_week(date: DateT) -> DateT:
         """
         Returns the first day of the next week of the given date. The week starts on Monday.
 
@@ -43,9 +39,7 @@ def first_day_of_next_week(
 
     @staticmethod
     @sequenceable(target="date")
-    def first_day_of_last_week(
-        date: Union[DateT, Sequence[DateT]]
-    ) -> Union[DateT, Sequence[DateT]]:
+    def first_day_of_last_week(date: DateT) -> DateT:
         """
         Returns the first day of the last week of the given date. The week starts on Monday.
 
@@ -61,9 +55,7 @@ def first_day_of_last_week(
 
     @staticmethod
     @sequenceable(target="date")
-    def first_day_of_month(
-        date: Union[DateT, Sequence[DateT]]
-    ) -> Union[DateT, Sequence[DateT]]:
+    def first_day_of_month(date: DateT) -> DateT:
         """
         Returns the first day of the month of the given date.
 
@@ -77,9 +69,7 @@ def first_day_of_month(
 
     @staticmethod
     @sequenceable(target="date")
-    def first_day_of_next_month(
-        date: Union[DateT, Sequence[DateT]]
-    ) -> Union[DateT, Sequence[DateT]]:
+    def first_day_of_next_month(date: DateT) -> DateT:
         """
         Returns the first day of the next month of the given date.
 
@@ -95,9 +85,7 @@ def first_day_of_next_month(
 
     @staticmethod
     @sequenceable(target="date")
-    def first_day_of_last_month(
-        date: Union[DateT, Sequence[DateT]]
-    ) -> Union[DateT, Sequence[DateT]]:
+    def first_day_of_last_month(date: DateT) -> DateT:
         """
         Returns the first day of the last month of the given date.
 
@@ -113,9 +101,7 @@ def first_day_of_last_month(
 
     @staticmethod
     @sequenceable(target="date")
-    def first_day_of_year(
-        date: Union[DateT, Sequence[DateT]]
-    ) -> Union[DateT, Sequence[DateT]]:
+    def first_day_of_year(date: DateT) -> DateT:
         """
         Returns the first day of the year of the given date.
 
@@ -129,9 +115,7 @@ def first_day_of_year(
 
     @staticmethod
     @sequenceable(target="date")
-    def first_day_of_next_year(
-        date: Union[DateT, Sequence[DateT]]
-    ) -> Union[DateT, Sequence[DateT]]:
+    def first_day_of_next_year(date: DateT) -> DateT:
         """
         Returns the first day of the next year of the given date.
 
@@ -147,9 +131,7 @@ def first_day_of_next_year(
 
     @staticmethod
     @sequenceable(target="date")
-    def first_day_of_last_year(
-        date: Union[DateT, Sequence[DateT]]
-    ) -> Union[DateT, Sequence[DateT]]:
+    def first_day_of_last_year(date: DateT) -> DateT:
         """
         Returns the first day of the last year of the given date.
 
@@ -165,9 +147,7 @@ def first_day_of_last_year(
 
     @staticmethod
     @sequenceable(target="date")
-    def last_day_of_week(
-        date: Union[DateT, Sequence[DateT]]
-    ) -> Union[DateT, Sequence[DateT]]:
+    def last_day_of_week(date: DateT) -> DateT:
         """
         Returns the last day of the week of the given date. The week ends on Sunday.
 
@@ -181,9 +161,7 @@ def last_day_of_week(
 
     @staticmethod
     @sequenceable(target="date")
-    def last_day_of_next_week(
-        date: Union[DateT, Sequence[DateT]]
-    ) -> Union[DateT, Sequence[DateT]]:
+    def last_day_of_next_week(date: DateT) -> DateT:
         """
         Returns the last day of the next week of the given date. The week ends on Sunday.
 
@@ -199,9 +177,7 @@ def last_day_of_next_week(
 
     @staticmethod
     @sequenceable(target="date")
-    def last_day_of_last_week(
-        date: Union[DateT, Sequence[DateT]]
-    ) -> Union[DateT, Sequence[DateT]]:
+    def last_day_of_last_week(date: DateT) -> DateT:
         """
         Returns the last day of the last week of the given date. The week ends on Sunday.
 
@@ -217,9 +193,7 @@ def last_day_of_last_week(
 
     @staticmethod
     @sequenceable(target="date")
-    def last_day_of_month(
-        date: Union[DateT, Sequence[DateT]]
-    ) -> Union[DateT, Sequence[DateT]]:
+    def last_day_of_month(date: DateT) -> DateT:
         """
         Returns the last day of the month of the given date.
 
@@ -233,9 +207,7 @@ def last_day_of_month(
 
     @staticmethod
     @sequenceable(target="date")
-    def last_day_of_next_month(
-        date: Union[DateT, Sequence[DateT]]
-    ) -> Union[DateT, Sequence[DateT]]:
+    def last_day_of_next_month(date: DateT) -> DateT:
         """
         Returns the last day of the next month of the given date.
 
@@ -251,9 +223,7 @@ def last_day_of_next_month(
 
     @staticmethod
     @sequenceable(target="date")
-    def last_day_of_last_month(
-        date: Union[DateT, Sequence[DateT]]
-    ) -> Union[DateT, Sequence[DateT]]:
+    def last_day_of_last_month(date: DateT) -> DateT:
         """
         Returns the last day of the last month of the given date.
 
@@ -269,9 +239,7 @@ def last_day_of_last_month(
 
     @staticmethod
     @sequenceable(target="date")
-    def last_day_of_year(
-        date: Union[DateT, Sequence[DateT]]
-    ) -> Union[DateT, Sequence[DateT]]:
+    def last_day_of_year(date: DateT) -> DateT:
         """
         Returns the last day of the year of the given date.
 
@@ -285,9 +253,7 @@ def last_day_of_year(
 
     @staticmethod
     @sequenceable(target="date")
-    def last_day_of_next_year(
-        date: Union[DateT, Sequence[DateT]]
-    ) -> Union[DateT, Sequence[DateT]]:
+    def last_day_of_next_year(date: DateT) -> DateT:
         """
         Returns the last day of the next year of the given date.
 
@@ -303,9 +269,7 @@ def last_day_of_next_year(
 
     @staticmethod
     @sequenceable(target="date")
-    def last_day_of_last_year(
-        date: Union[DateT, Sequence[DateT]]
-    ) -> Union[DateT, Sequence[DateT]]:
+    def last_day_of_last_year(date: DateT) -> DateT:
         """
         Returns the last day of the last year of the given date.