ics-query 0.1.0a0__py3-none-any.whl → 0.1.dev1__py3-none-any.whl

ics_query/parse.py

@@ -1,13 +1,87 @@
+# ics-query
+# Copyright (C) 2024 Nicco Kunzmann
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <https://www.gnu.org/licenses/>.
 """Functions for parsing the content."""
 
 from __future__ import annotations
 
-DateArgument = tuple[int]
+import datetime
+import re
+from typing import Union
 
+Date = tuple[int]
+DateAndDelta = Union[Date, datetime.timedelta]
 
-def to_time(dt: str) -> DateArgument:
+
+class InvalidTimeFormat(ValueError):
+    """The value provided does not yield a precise time."""
+
+
+REGEX_TIME = re.compile(
+    r"^(?P<year>\d\d\d\d)"
+    r"(?P<month>-\d?\d|\d\d)?"
+    r"(?P<day>-\d?\d|\d\d)?"
+    r"(?P<hour>[ T]\d?\d|\d\d)?"
+    r"(?P<minute>:\d?\d|\d\d)?"
+    r"(?P<second>:\d?\d|\d\d)?"
+    r"$"
+)
+
+REGEX_TIMEDELTA = re.compile(
+    r"^\+?(?:(?P<days>\d+)d)?"
+    r"(?:(?P<hours>\d+)h)?"
+    r"(?:(?P<minutes>\d+)m)?"
+    r"(?:(?P<seconds>\d+)s)?"
+    r"$"
+)
+
+
+def to_time(dt: str) -> Date:
     """Parse the time and date."""
-    return tuple(map(int, dt.split("-")))
+    parsed_dt = REGEX_TIME.match(dt)
+    if parsed_dt is None:
+        raise InvalidTimeFormat(dt)
+
+    def group(group_name: str) -> Date:
+        """Return a group's value."""
+        result = parsed_dt.group(group_name)
+        while result and result[0] not in "0123456789":
+            result = result[1:]
+        if result is None:
+            return ()
+        return (int(result),)
+
+    return (
+        group("year")
+        + group("month")
+        + group("day")
+        + group("hour")
+        + group("minute")
+        + group("second")
+    )
+
+
+def to_time_and_delta(dt: str) -> DateAndDelta:
+    """Parse to a absolute time or timedelta."""
+    parsed_td = REGEX_TIMEDELTA.match(dt)
+    if parsed_td is None:
+        return to_time(dt)
+    kw = {k: int(v) for k, v in parsed_td.groupdict().items() if v is not None}
+    if not kw:
+        raise InvalidTimeFormat(dt)
+    return datetime.timedelta(**kw)
 
 
-__all__ = ["to_time", "DateArgument"]
+__all__ = ["to_time", "Date", "to_time_and_delta", "DateAndDelta"]

ics_query/query.py

@@ -0,0 +1,78 @@
+# ics-query
+# Copyright (C) 2024 Nicco Kunzmann
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <https://www.gnu.org/licenses/>.
+"""This is an adaptation of the CalendarQuery."""
+
+from __future__ import annotations
+
+import datetime
+import zoneinfo
+from typing import TYPE_CHECKING
+
+import x_wr_timezone
+from recurring_ical_events import CalendarQuery, Occurrence
+from tzlocal import get_localzone
+
+if TYPE_CHECKING:
+    from collections.abc import Sequence
+
+    from icalendar import Calendar
+
+
+class Query(CalendarQuery):
+    def __init__(self, calendar: Calendar, timezone: str, components: Sequence[str]):
+        """Create a new query."""
+        super().__init__(
+            x_wr_timezone.to_standard(calendar),
+            components=components,
+            skip_bad_series=True,
+        )
+        self.timezone = self.get_timezone(timezone)
+
+    def get_timezone(self, timezone: str) -> datetime.tzinfo | None:
+        """Return the local time tz."""
+        if timezone == "localtime":
+            return get_localzone()
+        return zoneinfo.ZoneInfo(timezone) if timezone else None
+
+    def with_timezone(self, dt: datetime.date | datetime.datetime):
+        """Add the timezone."""
+        if self.timezone is None:
+            return dt
+        if not isinstance(dt, datetime.datetime):
+            return datetime.datetime(
+                year=dt.year, month=dt.month, day=dt.day, tzinfo=self.timezone
+            )
+        if dt.tzinfo is None:
+            return dt.replace(tzinfo=self.timezone)
+        return dt.astimezone(self.timezone)
+
+    def _occurrences_between(
+        self,
+        start: datetime.date | datetime.datetime,
+        end: datetime.date | datetime.datetime,
+    ) -> list[Occurrence]:
+        """Override to adapt timezones."""
+        result = []
+        for occurrence in super()._occurrences_between(
+            self.with_timezone(start), self.with_timezone(end)
+        ):
+            occurrence.start = self.with_timezone(occurrence.start)
+            occurrence.end = self.with_timezone(occurrence.end)
+            result.append(occurrence)
+        return result
+
+
+__all__ = ["Query"]

ics_query/tests/conftest.py

@@ -1,16 +1,31 @@
+# ics-query
+# Copyright (C) 2024 Nicco Kunzmann
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <https://www.gnu.org/licenses/>.
 """Configure the tests."""
 
 from __future__ import annotations
 
 import subprocess
-from copy import deepcopy
 from pathlib import Path
-from typing import NamedTuple
+from typing import Callable, NamedTuple
 
 import pytest
 
 HERE = Path(__file__).parent
 IO_DIRECTORY = HERE / "runs"
+CALENDARS_DIRECTORY = IO_DIRECTORY / "calendars"
 
 
 class TestRun(NamedTuple):
@@ -34,45 +49,78 @@ class TestRun(NamedTuple):
         )
 
 
+def get_binary_path(request: pytest.FixtureRequest) -> str:
+    """Return the path to the ics-query command."""
+    command: str = request.config.getoption("--binary")
+    if command == "ics-query":
+        # The default command can be found on the command line
+        return command
+    # we must set the path to be absolute
+    return Path(command).absolute()
+
+
+def run_ics_query(*command, cwd=CALENDARS_DIRECTORY, binary: str) -> TestRun:
+    """Run ics-qeury with a command.
+
+    - cwd is the working directory
+    - binary is the path to the command
+    """
+    cmd = [binary, *command]
+    print(" ".join(map(str, cmd)))
+    completed_process = subprocess.run(  # noqa: S603, RUF100
+        cmd,  # noqa: S603, RUF100
+        capture_output=True,
+        timeout=10,
+        check=False,
+        cwd=cwd,
+    )
+    return TestRun.from_completed_process(completed_process)
+
+
 class IOTestCase(NamedTuple):
     """An example test case."""
 
     name: str
     command: list[str]
-    cwd: Path
+    location: Path
     expected_output: str
+    binary: str
 
     @classmethod
-    def from_path(cls, path: Path) -> IOTestCase:
+    def from_path(cls, path: Path, binary: str) -> IOTestCase:
         """Create a new testcase from the files."""
         expected_output = path.read_text(encoding="UTF-8").replace("\r\n", "\n")
-        return cls(path.name, path.stem.split(), path.parent, expected_output)
+        return cls(path.name, path.stem.split(), path.parent, expected_output, binary)
 
     def run(self) -> TestRun:
         """Run this test case and return the result."""
-        command = ["ics-query", *self.command]
-        print(" ".join(command))
-        completed_process = subprocess.run(  # noqa: S603, RUF100
-            command,  # noqa: S603, RUF100
-            capture_output=True,
-            timeout=3,
-            check=False,
-            cwd=self.cwd / "calendars",
-        )
-        return TestRun.from_completed_process(completed_process)
+        return run_ics_query(*self.command, binary=self.binary)
 
 
-io_test_cases = [
-    IOTestCase.from_path(test_case_path)
+io_test_case_paths = [
+    test_case_path
     for test_case_path in IO_DIRECTORY.iterdir()
     if test_case_path.is_file()
 ]
 
 
-@pytest.fixture(params=io_test_cases)
-def io_testcase(request) -> IOTestCase:
+@pytest.fixture(params=io_test_case_paths)
+def io_testcase(request: pytest.FixtureRequest) -> IOTestCase:
     """Go though all the IO test cases."""
-    return deepcopy(request.param)
+    path: Path = request.param
+    binary = get_binary_path(request)
+    return IOTestCase.from_path(path, binary)
+
+
+@pytest.fixture
+def run(request: pytest.FixtureRequest) -> Callable[..., TestRun]:
+    """Return a runner function."""
+
+    def run(*args, **kw):
+        kw["binary"] = get_binary_path(request)
+        return run_ics_query(*args, **kw)
+
+    return run
 
 
 __all__ = ["IOTestCase", "TestRun"]

ics_query/tests/runs/all --tz Singapore one-event.ics -.run

@@ -0,0 +1,9 @@
+BEGIN:VEVENT
+SUMMARY:test1
+DTSTART;TZID=Singapore:20190304T150000
+DTEND;TZID=Singapore:20190304T153000
+DTSTAMP:20190303T111937
+UID:UYDQSG9TH4DE0WM3QFL2J
+CREATED:20190303T111937
+LAST-MODIFIED:20190303T111937
+END:VEVENT

ics_query/tests/runs/all three-events.ics -.run

@@ -0,0 +1,33 @@
+BEGIN:VEVENT
+SUMMARY:test4
+DTSTART;TZID=Europe/Berlin:20190304T000000
+DTEND;TZID=Europe/Berlin:20190304T010000
+DTSTAMP:20190303T111937
+UID:UYDQSG9TH4DE0WM3QFL2J
+CLASS:PUBLIC
+CREATED:20190303T111937
+LAST-MODIFIED:20190303T111937
+STATUS:CONFIRMED
+END:VEVENT
+BEGIN:VEVENT
+SUMMARY:test4
+DTSTART;TZID=Europe/Berlin:20190307T000000
+DTEND;TZID=Europe/Berlin:20190307T010000
+DTSTAMP:20190303T111937
+UID:UYDQSG9TH4DE0WM3QFL2J
+CLASS:PUBLIC
+CREATED:20190303T111937
+LAST-MODIFIED:20190303T111937
+STATUS:CONFIRMED
+END:VEVENT
+BEGIN:VEVENT
+SUMMARY:test4
+DTSTART;TZID=Europe/Berlin:20190310T000000
+DTEND;TZID=Europe/Berlin:20190310T010000
+DTSTAMP:20190303T111937
+UID:UYDQSG9TH4DE0WM3QFL2J
+CLASS:PUBLIC
+CREATED:20190303T111937
+LAST-MODIFIED:20190303T111937
+STATUS:CONFIRMED
+END:VEVENT

ics_query/tests/runs/at 2019-03-04 multiple-calendars.ics -.run

@@ -0,0 +1,20 @@
+BEGIN:VEVENT
+SUMMARY:test4
+DTSTART;TZID=Europe/Berlin:20190304T000000
+DTEND;TZID=Europe/Berlin:20190304T010000
+DTSTAMP:20190303T111937
+UID:UYDQSG9TH4DE0WM3QFL2J
+CLASS:PUBLIC
+CREATED:20190303T111937
+LAST-MODIFIED:20190303T111937
+STATUS:CONFIRMED
+END:VEVENT
+BEGIN:VEVENT
+SUMMARY:test1
+DTSTART;TZID=Europe/Berlin:20190304T080000
+DTEND;TZID=Europe/Berlin:20190304T083000
+DTSTAMP:20190303T111937
+UID:UYDQSG9TH4DE0WM3QFL2J
+CREATED:20190303T111937
+LAST-MODIFIED:20190303T111937
+END:VEVENT

ics_query/tests/runs/at 2019-03-04 one-event-twice.ics -.run

@@ -0,0 +1,18 @@
+BEGIN:VEVENT
+SUMMARY:test1
+DTSTART;TZID=Europe/Berlin:20190304T080000
+DTEND;TZID=Europe/Berlin:20190304T083000
+DTSTAMP:20190303T111937
+UID:UYDQSG9TH4DE0WM3QFL2J
+CREATED:20190303T111937
+LAST-MODIFIED:20190303T111937
+END:VEVENT
+BEGIN:VEVENT
+SUMMARY:test1
+DTSTART;TZID=Europe/Berlin:20190304T080000
+DTEND;TZID=Europe/Berlin:20190304T083000
+DTSTAMP:20190303T111937
+UID:UYDQSG9TH4DE0WM3QFL2J
+CREATED:20190303T111937
+LAST-MODIFIED:20190303T111937
+END:VEVENT

ics_query/tests/runs/at 2019-03-07 multiple-calendars.ics -.run

@@ -0,0 +1,11 @@
+BEGIN:VEVENT
+SUMMARY:test4
+DTSTART;TZID=Europe/Berlin:20190307T000000
+DTEND;TZID=Europe/Berlin:20190307T010000
+DTSTAMP:20190303T111937
+UID:UYDQSG9TH4DE0WM3QFL2J
+CLASS:PUBLIC
+CREATED:20190303T111937
+LAST-MODIFIED:20190303T111937
+STATUS:CONFIRMED
+END:VEVENT

ics_query/tests/runs/at 2024-08-20 Berlin-Los-Angeles.ics -.run

@@ -0,0 +1,23 @@
+BEGIN:VEVENT
+SUMMARY:6:00-7:00 Europe/Berlin 20th August
+DTSTART;TZID=Europe/Berlin:20240820T060000
+DTEND;TZID=Europe/Berlin:20240820T070000
+DTSTAMP:20240823T130444Z
+UID:b27ea261-f23d-4e03-a7ac-f8cb0d00f07f
+CREATED:20240823T120639Z
+LAST-MODIFIED:20240823T130444Z
+TRANSP:OPAQUE
+X-MOZ-GENERATION:3
+END:VEVENT
+BEGIN:VEVENT
+SUMMARY:6:00-7:00 Amerika/Los Angeles 20th August
+DTSTART;TZID=America/Los_Angeles:20240820T060000
+DTEND;TZID=America/Los_Angeles:20240820T070000
+DTSTAMP:20240823T130711Z
+UID:6d7ff7f3-4bc4-4d89-afa0-771bd690518a
+SEQUENCE:1
+CREATED:20240823T120639Z
+LAST-MODIFIED:20240823T130711Z
+TRANSP:OPAQUE
+X-MOZ-GENERATION:4
+END:VEVENT

ics_query/tests/runs/between 20240823 4d recurring-work-events.ics -.run

@@ -0,0 +1,24 @@
+BEGIN:VEVENT
+SUMMARY:Work
+DTSTART;TZID=Europe/Berlin:20240823T090000
+DTEND;TZID=Europe/Berlin:20240823T170000
+DTSTAMP:20240823T082915Z
+UID:6b85b60c-eb1a-4338-9ece-33541b95bf17
+SEQUENCE:1
+CREATED:20240823T082829Z
+LAST-MODIFIED:20240823T082915Z
+TRANSP:OPAQUE
+X-MOZ-GENERATION:2
+END:VEVENT
+BEGIN:VEVENT
+SUMMARY:Work
+DTSTART;TZID=Europe/Berlin:20240826T090000
+DTEND;TZID=Europe/Berlin:20240826T170000
+DTSTAMP:20240823T082915Z
+UID:6b85b60c-eb1a-4338-9ece-33541b95bf17
+SEQUENCE:1
+CREATED:20240823T082829Z
+LAST-MODIFIED:20240823T082915Z
+TRANSP:OPAQUE
+X-MOZ-GENERATION:2
+END:VEVENT