ics-query 0.4.32__tar.gz → 0.4.34__tar.gz

{ics_query-0.4.32 → ics_query-0.4.34}/PKG-INFO

@@ -1,10 +1,10 @@
 Metadata-Version: 2.4
 Name: ics-query
-Version: 0.4.32
+Version: 0.4.34
 Summary: Find out what happens in ICS calendar files - query and filter RFC 5545 compatible .ics files for events, journals, TODOs and more.
 Project-URL: Homepage, https://github.com/niccokunzmann/ics-query/
 Project-URL: Repository, https://github.com/niccokunzmann/ics-query/
-Project-URL: source_archive, https://github.com/niccokunzmann/ics-query/archive/a11ed5390eb3571ecd3e0af2a1b990812f3de41d.zip
+Project-URL: source_archive, https://github.com/niccokunzmann/ics-query/archive/c25d3a90e2b57c9bd22aa18e57104f174691dba3.zip
 Project-URL: Issues, https://github.com/niccokunzmann/ics-query/issues
 Project-URL: Documentation, https://github.com/niccokunzmann/ics-query/
 Project-URL: Changelog, https://github.com/niccokunzmann/ics-query/#changelog
@@ -697,7 +697,7 @@ Classifier: Programming Language :: Python :: 3.12
 Classifier: Topic :: Office/Business :: Scheduling
 Requires-Python: >=3.9
 Requires-Dist: click==8.1.8
-Requires-Dist: icalendar==6.1.3
+Requires-Dist: icalendar==6.2.0
 Requires-Dist: python-dateutil==2.9.0.post0
 Requires-Dist: recurring-ical-events==3.7.0
 Requires-Dist: six==1.17.0
@@ -802,6 +802,8 @@ LAST-MODIFIED:20190303T111937
 END:VEVENT
 ```
 
+#### Concatenating Calendars
+
 We can concatenate calendars and pipe them into `ics-query`.
 In the example below, we get all events that happen right now in two calendars.
 
@@ -819,6 +821,30 @@ You can pipe one or more calendars into the input.
 cat calendar.ics | ics-query first -
 ```
 
+#### Valid ICS files
+
+The resulting events are missing the timezone and the calendar information by default.
+This information can be added using the `--as-calendar` parameter.
+The result is a valid `.ics` file that can be processed further by other commands and programs.
+
+In the example below, we use the calendar command to inspect the event for human readability.
+
+```shell
+$ ics-query at --as-calendar 2014-05-03 x-wr-timezone-rdate-hackerpublicradio.ics event.ics
+$ icalendar event.ics
+    Organizer: 
+    Attendees:
+
+    Summary    : HPR Community News
+    Starts     : Sat May  3 20:00:00 2014
+    End        : Sat May  3 22:00:00 2014
+    Duration   : 2:00:00
+    Location   : mumble.openspeak.cc port: 64747
+    Comment    : 
+    Description:
+     This is from http://www.hackerpublicradio.org/eps/hpr1286/iCalendar_Hacking_shownotes.html
+```
+
 ### Events at Certain Times
 
 You can query which events happen at certain times:
@@ -1110,6 +1136,16 @@ We automatically release the versions that only update dependencies.
 If the version you installed does not show up here, only the dependencies
 have been updated.
 
+- v0.4.33
+
+  - Add `--as-calendar` parameter.
+
+- v0.4.32
+
+  - Update dependencies.
+  - Include recurrence ID in events to identify the occurrence in a series.
+  - Update help message in command line.
+
 - v0.4.1
 
   - Automatic release with patch level version number increased

{ics_query-0.4.32 → ics_query-0.4.34}/README.md

@@ -92,6 +92,8 @@ LAST-MODIFIED:20190303T111937
 END:VEVENT
 ```
 
+#### Concatenating Calendars
+
 We can concatenate calendars and pipe them into `ics-query`.
 In the example below, we get all events that happen right now in two calendars.
 
@@ -109,6 +111,30 @@ You can pipe one or more calendars into the input.
 cat calendar.ics | ics-query first -
 ```
 
+#### Valid ICS files
+
+The resulting events are missing the timezone and the calendar information by default.
+This information can be added using the `--as-calendar` parameter.
+The result is a valid `.ics` file that can be processed further by other commands and programs.
+
+In the example below, we use the calendar command to inspect the event for human readability.
+
+```shell
+$ ics-query at --as-calendar 2014-05-03 x-wr-timezone-rdate-hackerpublicradio.ics event.ics
+$ icalendar event.ics
+    Organizer: 
+    Attendees:
+
+    Summary    : HPR Community News
+    Starts     : Sat May  3 20:00:00 2014
+    End        : Sat May  3 22:00:00 2014
+    Duration   : 2:00:00
+    Location   : mumble.openspeak.cc port: 64747
+    Comment    : 
+    Description:
+     This is from http://www.hackerpublicradio.org/eps/hpr1286/iCalendar_Hacking_shownotes.html
+```
+
 ### Events at Certain Times
 
 You can query which events happen at certain times:
@@ -400,6 +426,16 @@ We automatically release the versions that only update dependencies.
 If the version you installed does not show up here, only the dependencies
 have been updated.
 
+- v0.4.33
+
+  - Add `--as-calendar` parameter.
+
+- v0.4.32
+
+  - Update dependencies.
+  - Include recurrence ID in events to identify the occurrence in a series.
+  - Update help message in command line.
+
 - v0.4.1
 
   - Automatic release with patch level version number increased

{ics_query-0.4.32 → ics_query-0.4.34}/ics_query/_version.py

@@ -17,5 +17,5 @@ __version__: str
 __version_tuple__: VERSION_TUPLE
 version_tuple: VERSION_TUPLE
 
-__version__ = version = '0.4.32'
-__version_tuple__ = version_tuple = (0, 4, 32)
+__version__ = version = '0.4.34'
+__version_tuple__ = version_tuple = (0, 4, 34)

{ics_query-0.4.32 → ics_query-0.4.34}/ics_query/cli.py

@@ -24,18 +24,18 @@ import typing as t
 import zoneinfo
 
 import click
-from icalendar.cal import Calendar, Component
+from icalendar import Calendar, Component, Timezone
 from tzlocal import get_localzone_name
 
 from . import parse
 from .query import Query
-from .version import cli_version
+from .version import __version__, cli_version
 
 if t.TYPE_CHECKING:
     from io import FileIO
 
     import recurring_ical_events
-    from icalendar.cal import Component
+    from icalendar import Component
 
     from .parse import Date
 
@@ -67,17 +67,58 @@ class ComponentsResult:
     def __init__(self, output: FileIO):
         """Create a new result."""
         self._file = output
+        self._entered = False
 
-    def add_component(self, component: Component):
+    def write(self, data: bytes | str):
+        """Write data to the output."""
+        if isinstance(data, str):
+            data = data.encode()
+        self._file.write(data)
+
+    def __enter__(self):
+        """Start adding components."""
+        self._entered = True
+
+    def __exit__(self, exc_type, exc_value, traceback):
+        """Stop adding components."""
+        self._entered = False
+
+    def add_component(self, component: Component) -> None:
         """Return a component."""
-        self._file.write(component.to_ical())
+        assert self._entered
+        self.write(component.to_ical())
 
-    def add_components(self, components: t.Iterable[Component]):
+    def add_components(self, components: t.Iterable[Component]) -> None:
         """Add all components."""
         for component in components:
             self.add_component(component)
 
 
+class CalendarResult(ComponentsResult):
+    """Wrap the resulting components in a calendar."""
+
+    CALENDAR_START = (
+        f"BEGIN:VCALENDAR\r\nVERSION:2.0\r\nPRODID:ics-query {__version__}\r\n"
+    )
+    CALENDAR_END = "END:VCALENDAR\r\n"
+
+    def __init__(self, output: FileIO, timezones: list[Timezone]):
+        super().__init__(output)
+        self.timezones = timezones
+
+    def __enter__(self):
+        """Start the calendar."""
+        super().__enter__()
+        self.write(self.CALENDAR_START)
+        for timezone in self.timezones:
+            self.write(timezone.to_ical())
+
+    def __exit__(self, exc_type, exc_value, traceback):
+        """Stop the calendar."""
+        self.write(self.CALENDAR_END)
+        super().__exit__(exc_type, exc_value, traceback)
+
+
 class ComponentsResultArgument(click.File):
     """Argument for the result."""
 
@@ -89,6 +130,11 @@ class ComponentsResultArgument(click.File):
     ) -> ComponentsResult:
         """Return a ComponentsResult."""
         file = super().convert(value, param, ctx)
+        # we claim the as_calendar argument
+        wrap_calendar = ctx.params.pop("as_calendar", False)
+        if wrap_calendar:
+            joined: JoinedCalendars = ctx.params["calendar"]
+            return CalendarResult(file, joined.timezones)
         return ComponentsResult(file)
 
 
@@ -97,6 +143,7 @@ class JoinedCalendars:
         self, calendars: list[Calendar], timezone: str, components: t.Sequence[str]
     ):
         """Join multiple calendars."""
+        self.calendars = calendars
         self.queries = [
             Query(calendar, timezone, components=components) for calendar in calendars
         ]
@@ -124,6 +171,27 @@ class JoinedCalendars:
         for query in self.queries:
             yield from query.between(start, end)
 
+    @property
+    def timezones(self) -> list[Timezone]:
+        """Return all the timezones in use."""
+        result = []
+        tzids = set()
+        # add existing timezone components first
+        for calendar in self.calendars:
+            for timezone in calendar.timezones:
+                if timezone.tz_name not in tzids:
+                    tzids.add(timezone.tz_name)
+                    result.append(timezone)
+        # add X-WR-TIMEZONE later to prevent generating if existing
+        for calendar in self.calendars:
+            tzid = calendar.get("X-WR-TIMEZONE", None)
+            if tzid is not None and tzid not in tzids:
+                timezone = Timezone.from_tzid(tzid)
+                tzids.add(timezone.tz_name)
+                tzids.add(tzid)
+                result.append(timezone)
+        return result
+
 
 class CalendarQueryInputArgument(click.File):
     """Argument for the result."""
@@ -160,6 +228,15 @@ opt_timezone = click.option(
     help=("Set the timezone. See also --available-timezones"),
 )
 
+opt_calendar = click.option(
+    "--as-calendar",
+    envvar=ENV_PREFIX + "_AS_CALENDAR",
+    is_flag=True,
+    default=False,
+    is_eager=True,
+    help="Return a valid calendar, not just the components.",
+)
+
 
 def arg_calendar(func):
     """Decorator for a calendar argument with all used options."""
@@ -173,9 +250,12 @@ def arg_calendar(func):
     return opt_timezone(opt_components(arg(wrapper)))
 
 
-arg_output = click.argument("output", type=ComponentsResultArgument("wb"), default="-")
-# Option with many values and list as result
-# see https://click.palletsprojects.com/en/latest/options/#multiple-options
+def arg_output(func):
+    """Add the output argument and its parameters."""
+    # Option with many values and list as result
+    # see https://click.palletsprojects.com/en/latest/options/#multiple-options
+    arg = click.argument("output", type=ComponentsResultArgument("wb"), default="-")
+    return opt_calendar(arg(func))
 
 
 def opt_available_timezones(*param_decls: str, **kwargs: t.Any) -> t.Callable:
@@ -458,7 +538,8 @@ def at(calendar: JoinedCalendars, output: ComponentsResult, date: Date):
             ics-query at 19900101235959       # 1st January 1990, 23:59:59
             ics-query at `date +%Y%m%d%H%M%S` # now
     """  # noqa: D301
-    output.add_components(calendar.at(date))
+    with output:
+        output.add_components(calendar.at(date))
 
 
 @cli.command()
@@ -475,7 +556,8 @@ def first(calendar: JoinedCalendars, output: ComponentsResult):
         ics-query first --component VEVENT calendar.ics -
 
     """  # noqa: D301
-    output.add_components(calendar.first())
+    with output:
+        output.add_components(calendar.first())
 
 
 @cli.command()
@@ -499,7 +581,8 @@ def all(calendar: JoinedCalendars, output: ComponentsResult):  # noqa: A001
     potentially enourmous. You can mitigate this by closing the OUTPUT
     when you have enough e.g. with a head command.
     """  # noqa: D301
-    output.add_components(calendar.all())
+    with output:
+        output.add_components(calendar.all())
 
 
 @cli.command()
@@ -683,7 +766,8 @@ def between(
     Add 3 hours and 15 minutes to START: +3h15m
 
     """  # noqa: D301
-    output.add_components(calendar.between(start, end))
+    with output:
+        output.add_components(calendar.between(start, end))
 
 
 def main():

{ics_query-0.4.32 → ics_query-0.4.34}/ics_query/tests/conftest.py

@@ -22,13 +22,14 @@ from pathlib import Path
 from typing import Callable, NamedTuple
 
 import pytest
+from icalendar import Calendar
 
 HERE = Path(__file__).parent
 IO_DIRECTORY = HERE / "runs"
 CALENDARS_DIRECTORY = IO_DIRECTORY / "calendars"
 
 
-class TestRun(NamedTuple):
+class ExampleRun(NamedTuple):
     """The result from a test run."""
 
     exit_code: int
@@ -38,7 +39,7 @@ class TestRun(NamedTuple):
     @classmethod
     def from_completed_process(
         cls, completed_process: subprocess.CompletedProcess
-    ) -> TestRun:
+    ) -> ExampleRun:
         """Create a new run result."""
         stdout = completed_process.stdout.decode("UTF-8").replace("\r\n", "\n")
         print(stdout)
@@ -48,6 +49,11 @@ class TestRun(NamedTuple):
             completed_process.stderr.decode("UTF-8"),
         )
 
+    @property
+    def calendar(self) -> Calendar:
+        """Return the output as a calendar."""
+        return Calendar.from_ical(self.output)
+
 
 def get_binary_path(request: pytest.FixtureRequest) -> str:
     """Return the path to the ics-query command."""
@@ -59,7 +65,7 @@ def get_binary_path(request: pytest.FixtureRequest) -> str:
     return Path(command).absolute()
 
 
-def run_ics_query(*command, cwd=CALENDARS_DIRECTORY, binary: str) -> TestRun:
+def run_ics_query(*command, cwd=CALENDARS_DIRECTORY, binary: str) -> ExampleRun:
     """Run ics-qeury with a command.
 
     - cwd is the working directory
@@ -74,7 +80,9 @@ def run_ics_query(*command, cwd=CALENDARS_DIRECTORY, binary: str) -> TestRun:
         check=False,
         cwd=cwd,
     )
-    return TestRun.from_completed_process(completed_process)
+    if completed_process.stderr:
+        print(completed_process.stderr.decode())
+    return ExampleRun.from_completed_process(completed_process)
 
 
 class IOTestCase(NamedTuple):
@@ -92,7 +100,7 @@ class IOTestCase(NamedTuple):
         expected_output = path.read_text(encoding="UTF-8").replace("\r\n", "\n")
         return cls(path.name, path.stem.split(), path.parent, expected_output, binary)
 
-    def run(self) -> TestRun:
+    def run(self) -> ExampleRun:
         """Run this test case and return the result."""
         return run_ics_query(*self.command, binary=self.binary)
 
@@ -100,7 +108,7 @@ class IOTestCase(NamedTuple):
 io_test_case_paths = [
     test_case_path
     for test_case_path in IO_DIRECTORY.iterdir()
-    if test_case_path.is_file()
+    if test_case_path.is_file() and test_case_path.suffix == ".run"
 ]
 
 
@@ -112,8 +120,8 @@ def io_testcase(request: pytest.FixtureRequest) -> IOTestCase:
     return IOTestCase.from_path(path, binary)
 
 
-@pytest.fixture
-def run(request: pytest.FixtureRequest) -> Callable[..., TestRun]:
+@pytest.fixture()
+def run(request: pytest.FixtureRequest) -> Callable[..., ExampleRun]:
     """Return a runner function."""
 
     def run(*args, **kw):
@@ -123,4 +131,4 @@ def run(request: pytest.FixtureRequest) -> Callable[..., TestRun]:
     return run
 
 
-__all__ = ["IOTestCase", "TestRun"]
+__all__ = ["IOTestCase", "ExampleRun"]

ics_query-0.4.34/ics_query/tests/runs/at 2014-05-03 x-wr-timezone-rdate-hackerpublicradio.ics -.run

@@ -0,0 +1,9 @@
+BEGIN:VEVENT
+SUMMARY:HPR Community News
+DTSTART;TZID=Europe/London:20140503T200000
+DTEND;TZID=Europe/London:20140503T220000
+RECURRENCE-ID;TZID=Europe/London:20140503T200000
+DESCRIPTION:This is from http://www.hackerpublicradio.org/eps/hpr1286/iCal
+ endar_Hacking_shownotes.html
+LOCATION:mumble.openspeak.cc port: 64747
+END:VEVENT

ics_query-0.4.34/ics_query/tests/runs/calendars/x-wr-timezone-rdate-hackerpublicradio.ics

@@ -0,0 +1,26 @@
+BEGIN:VCALENDAR
+VERSION:2.0
+PRODID:Data::ICal 0.20
+X-WR-CALNAME:Hacker Public Radio
+X-WR-TIMEZONE:Europe/London
+BEGIN:VEVENT
+DESCRIPTION:This is from http://www.hackerpublicradio.org/eps/hpr1286/iCalendar_
+ Hacking_shownotes.html
+DTEND:20130803T210000Z
+DTSTART:20130803T190000Z
+LOCATION:mumble.openspeak.cc port: 64747
+RDATE;VALUE=DATE-TIME:20130803T190000Z
+RDATE;VALUE=DATE-TIME:20130831T190000Z
+RDATE;VALUE=DATE-TIME:20131005T190000Z
+RDATE;VALUE=DATE-TIME:20131102T190000Z
+RDATE;VALUE=DATE-TIME:20131130T190000Z
+RDATE;VALUE=DATE-TIME:20140104T190000Z
+RDATE;VALUE=DATE-TIME:20140201T190000Z
+RDATE;VALUE=DATE-TIME:20140301T190000Z
+RDATE;VALUE=DATE-TIME:20140405T190000Z
+RDATE;VALUE=DATE-TIME:20140503T190000Z
+RDATE;VALUE=DATE-TIME:20140531T190000Z
+RDATE;VALUE=DATE-TIME:20140705T190000Z
+SUMMARY:HPR Community News
+END:VEVENT
+END:VCALENDAR

ics_query-0.4.34/ics_query/tests/test_issue_40_valid_calendar.py

@@ -0,0 +1,68 @@
+"""We make sure that the result can be processed by another icalendar application.
+
+See https://github.com/niccokunzmann/ics-query/issues/40
+"""
+
+from __future__ import annotations
+
+from typing import TYPE_CHECKING
+
+import pytest
+
+from ics_query import __version__
+
+if TYPE_CHECKING:
+    from icalendar import Calendar, Timezone
+
+    from ics_query.tests.conftest import ExampleRun
+
+
+@pytest.fixture()
+def calendar(run) -> ExampleRun:
+    """Return a calendar that is wrapped around the event."""
+    return run("first", "--as-calendar", "one-event-without-timezone.ics").calendar
+
+
+def test_result_is_wrapped_in_a_calendar(calendar: Calendar):
+    """Add the calendar component around the event."""
+    assert calendar.name == "VCALENDAR"
+
+
+def test_the_product_id_is_that_of_ics_query(calendar):
+    """The product id is set with version."""
+    assert calendar["PRODID"] == f"ics-query {__version__}"
+
+
+def test_the_version_is_set(calendar):
+    """Version is required."""
+    assert calendar["VERSION"] == "2.0"
+
+
+def test_no_timezone_is_included(calendar):
+    """We do not have timezones in this file, so there should be none."""
+    assert calendar.timezones == []
+
+
+@pytest.mark.parametrize(
+    "file",
+    [
+        "one-event.ics",  # one timezone
+        "multiple-calendars.ics",  # same timezone twice
+    ],
+)
+def test_calendar_adds_timezones_automatically(run, file):
+    """Return a calendar that is wrapped around the event."""
+    calendar = run("first", "--as-calendar", file).calendar
+    assert len(calendar.timezones) == 1
+    tz: Timezone = calendar.timezones[0]
+    assert tz.tz_name == "Europe/Berlin"
+
+
+def test_x_wr_timezone_is_added(run):
+    """X-WR-TIMEZONE requires adding the timezone component manually."""
+    calendar = run(
+        "first", "--as-calendar", "x-wr-timezone-rdate-hackerpublicradio.ics"
+    ).calendar
+    assert len(calendar.timezones) == 1
+    tz: Timezone = calendar.timezones[0]
+    assert tz.tz_name == "Europe/London"

{ics_query-0.4.32 → ics_query-0.4.34}/pyproject.toml

@@ -45,7 +45,7 @@ classifiers = [
 ]
 
 dependencies = [
-    "icalendar==6.1.3",
+    "icalendar==6.2.0",
     "recurring-ical-events==3.7.0",
     "click==8.1.8",
     "x-wr-timezone==2.0.1",