ics-query 0.0.1a0__py3-none-any.whl

ics_query/__init__.py

@@ -0,0 +1,11 @@
+from .cli import main
+from .version import __version__, __version_tuple__, version, version_tuple
+
+__all__ = [
+    "main",
+    "app",
+    "__version__",
+    "version",
+    "__version_tuple__",
+    "version_tuple",
+]

ics_query/__main__.py

@@ -0,0 +1,5 @@
+import sys
+
+from .cli import main
+
+sys.exit(main())

ics_query/_version.py

@@ -0,0 +1,16 @@
+# file generated by setuptools_scm
+# don't change, don't track in version control
+TYPE_CHECKING = False
+if TYPE_CHECKING:
+    from typing import Tuple, Union
+    VERSION_TUPLE = Tuple[Union[int, str], ...]
+else:
+    VERSION_TUPLE = object
+
+version: str
+__version__: str
+__version_tuple__: VERSION_TUPLE
+version_tuple: VERSION_TUPLE
+
+__version__ = version = '0.0.1a0'
+__version_tuple__ = version_tuple = (0, 0, 1)

ics_query/cli.py

@@ -0,0 +1,92 @@
+"""The command line interface."""
+
+from __future__ import annotations
+
+import functools
+import os  # noqa: TCH003
+import sys
+import typing as t
+
+import click
+import recurring_ical_events
+from icalendar import Calendar
+from recurring_ical_events import CalendarQuery
+
+from . import parse
+
+if t.TYPE_CHECKING:
+    from io import FileIO
+
+    from icalendar.cal import Component
+
+    from .parse import DateArgument
+
+print = functools.partial(print, file=sys.stderr)  # noqa: A001
+
+
+class ComponentsResult:
+    """Output interface for components."""
+
+    def __init__(self, output: FileIO):
+        """Create a new result."""
+        self._file = output
+
+    def add_component(self, component: Component):
+        """Return a component."""
+        self._file.write(component.to_ical())
+
+
+class ComponentsResultArgument(click.File):
+    """Argument for the result."""
+
+    def convert(
+        self,
+        value: str | os.PathLike[str] | t.IO[t.Any],
+        param: click.Parameter | None,
+        ctx: click.Context | None,
+    ) -> ComponentsResult:
+        """Return a ComponentsResult."""
+        file = super().convert(value, param, ctx)
+        return ComponentsResult(file)
+
+
+class CalendarQueryInputArgument(click.File):
+    """Argument for the result."""
+
+    def convert(
+        self,
+        value: str | os.PathLike[str] | t.IO[t.Any],
+        param: click.Parameter | None,
+        ctx: click.Context | None,
+    ) -> recurring_ical_events.CalendarQuery:
+        """Return a CalendarQuery."""
+        file = super().convert(value, param, ctx)
+        calendar = Calendar.from_ical(file.read())
+        return recurring_ical_events.of(calendar)
+
+
+arg_calendar = click.argument("calendar", type=CalendarQueryInputArgument("rb"))
+arg_output = click.argument("output", type=ComponentsResultArgument("wb"))
+
+
+@click.group()
+def main():
+    """Simple program that greets NAME for a total of COUNT times."""
+    # sys.stdout = sys.stderr  # remove accidential print impact
+
+
+pass_datetime = click.make_pass_decorator(parse.to_time)
+
+
+@main.command()
+@click.argument("date", type=parse.to_time)
+@arg_calendar
+@arg_output
+def at(calendar: CalendarQuery, output: ComponentsResult, date: DateArgument):
+    """Get the components at a certain time."""
+    for event in calendar.at(date):
+        print("debug")
+        output.add_component(event)
+
+
+__all__ = ["main"]

ics_query/parse.py

@@ -0,0 +1,13 @@
+"""Functions for parsing the content."""
+
+from __future__ import annotations
+
+DateArgument = tuple[int]
+
+
+def to_time(dt: str) -> DateArgument:
+    """Parse the time and date."""
+    return tuple(map(int, dt.split("-")))
+
+
+__all__ = ["to_time", "DateArgument"]

ics_query/tests/conftest.py

@@ -0,0 +1,78 @@
+"""Configure the tests."""
+
+from __future__ import annotations
+
+import subprocess
+from copy import deepcopy
+from pathlib import Path
+from typing import NamedTuple
+
+import pytest
+
+HERE = Path(__file__).parent
+IO_DIRECTORY = HERE / "runs"
+
+
+class TestRun(NamedTuple):
+    """The result from a test run."""
+
+    exit_code: int
+    output: str
+    error: str
+
+    @classmethod
+    def from_completed_process(
+        cls, completed_process: subprocess.CompletedProcess
+    ) -> TestRun:
+        """Create a new run result."""
+        stdout = completed_process.stdout.decode("UTF-8").replace("\r\n", "\n")
+        print(stdout)
+        return cls(
+            completed_process.returncode,
+            stdout,
+            completed_process.stderr.decode("UTF-8"),
+        )
+
+
+class IOTestCase(NamedTuple):
+    """An example test case."""
+
+    name: str
+    command: list[str]
+    cwd: Path
+    expected_output: str
+
+    @classmethod
+    def from_path(cls, path: Path) -> 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)
+
+    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)
+
+
+io_test_cases = [
+    IOTestCase.from_path(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:
+    """Go though all the IO test cases."""
+    return deepcopy(request.param)
+
+
+__all__ = ["IOTestCase", "TestRun"]

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

@@ -0,0 +1,9 @@
+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/calendars/one-event.ics

@@ -0,0 +1,34 @@
+BEGIN:VCALENDAR
+VERSION:2.0
+PRODID:-//SabreDAV//SabreDAV//EN
+CALSCALE:GREGORIAN
+X-WR-CALNAME:test
+X-APPLE-CALENDAR-COLOR:#e78074
+BEGIN:VTIMEZONE
+TZID:Europe/Berlin
+X-LIC-LOCATION:Europe/Berlin
+BEGIN:DAYLIGHT
+TZOFFSETFROM:+0100
+TZOFFSETTO:+0200
+TZNAME:CEST
+DTSTART:19700329T020000
+RRULE:FREQ=YEARLY;BYMONTH=3;BYDAY=-1SU
+END:DAYLIGHT
+BEGIN:STANDARD
+TZOFFSETFROM:+0200
+TZOFFSETTO:+0100
+TZNAME:CET
+DTSTART:19701025T030000
+RRULE:FREQ=YEARLY;BYMONTH=10;BYDAY=-1SU
+END:STANDARD
+END:VTIMEZONE
+BEGIN:VEVENT
+CREATED:20190303T111937
+DTSTAMP:20190303T111937
+LAST-MODIFIED:20190303T111937
+UID:UYDQSG9TH4DE0WM3QFL2J
+SUMMARY:test1
+DTSTART;TZID=Europe/Berlin:20190304T080000
+DTEND;TZID=Europe/Berlin:20190304T083000
+END:VEVENT
+END:VCALENDAR

ics_query/tests/test_command_line.py

@@ -0,0 +1,10 @@
+"""Test the commmand line."""
+
+from .conftest import IOTestCase
+
+
+def test_check_program_output(io_testcase: IOTestCase):
+    """Run the test case and check the output."""
+    result = io_testcase.run()
+    print(result.error)
+    assert result.output == io_testcase.expected_output

ics_query/version.py

@@ -0,0 +1,16 @@
+# SPDX-FileCopyrightText: 2024 Nicco Kunzmann and Open Web Calendar Contributors <https://open-web-calendar.quelltext.eu/>
+#
+# SPDX-License-Identifier: GPL-2.0-only
+
+try:
+    from ._version import __version__, __version_tuple__, version, version_tuple
+except ModuleNotFoundError:
+    __version__ = version = "0.0dev0"
+    __version_tuple__ = version_tuple = (0, 0, "dev0")
+
+__all__ = [
+    "__version__",
+    "version",
+    "__version_tuple__",
+    "version_tuple",
+]