ics-query 0.3.1b0__py3-none-any.whl → 0.3.2b0__py3-none-any.whl

ics_query/_version.py

@@ -12,5 +12,5 @@ __version__: str
 __version_tuple__: VERSION_TUPLE
 version_tuple: VERSION_TUPLE
 
-__version__ = version = '0.3.1b0'
-__version_tuple__ = version_tuple = (0, 3, 1)
+__version__ = version = '0.3.2b0'
+__version_tuple__ = version_tuple = (0, 3, 2)

ics_query/cli.py

@@ -25,6 +25,7 @@ import zoneinfo
 
 import click
 from icalendar.cal import Calendar, Component
+from tzlocal import get_localzone_name
 
 from . import parse
 from .query import Query
@@ -181,17 +182,18 @@ def opt_available_timezones(*param_decls: str, **kwargs: t.Any) -> t.Callable:
     """List available timezones.
 
     This is copied from the --help option.
+
+    Commonly used timezone names are added first.
     """
 
     def callback(ctx: click.Context, param: click.Parameter, value: bool) -> None:  # noqa: FBT001, ARG001
         if not value or ctx.resilient_parsing:
             return
 
-        first_zones = ["localtime", "UTC"]
+        click.echo("localtime")  # special local time handle
+        click.echo(get_localzone_name())
+        click.echo("UTC")
         all_zones = zoneinfo.available_timezones()
-        for zone in first_zones:
-            if zone in all_zones:
-                click.echo(zone)
         for zone in sorted(all_zones, key=str.lower):
             click.echo(zone)
         ctx.exit()

ics_query/query.py

@@ -23,6 +23,7 @@ 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
@@ -38,7 +39,13 @@ class Query(CalendarQuery):
             components=components,
             skip_bad_series=True,
         )
-        self.timezone = zoneinfo.ZoneInfo(timezone) if timezone else None
+        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."""

ics_query/tests/conftest.py

@@ -18,7 +18,6 @@
 from __future__ import annotations
 
 import subprocess
-from copy import deepcopy
 from pathlib import Path
 from typing import Callable, NamedTuple
 
@@ -50,14 +49,28 @@ class TestRun(NamedTuple):
         )
 
 
-def run_ics_query(*command, cwd=CALENDARS_DIRECTORY) -> TestRun:
-    """Run ics-qeury with a command."""
-    cmd = ["ics-query", *command]
-    print(" ".join(cmd))
+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=3,
+        timeout=10,
         check=False,
         cwd=cwd,
     )
@@ -71,35 +84,43 @@ class IOTestCase(NamedTuple):
     command: list[str]
     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."""
-        return run_ics_query(*self.command)
+        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() -> Callable[..., TestRun]:
+def run(request: pytest.FixtureRequest) -> Callable[..., TestRun]:
     """Return a runner function."""
-    return run_ics_query
+
+    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/calendars/one-event-without-timezone.ics

@@ -0,0 +1,14 @@
+BEGIN:VCALENDAR
+VERSION:2.0
+PRODID:-//SabreDAV//SabreDAV//EN
+CALSCALE:GREGORIAN
+BEGIN:VEVENT
+CREATED:20190303T111937
+DTSTAMP:20190303T111937
+LAST-MODIFIED:20190303T111937
+UID:UYDQSG9TH4DE0WM3QFL2J
+SUMMARY:test1
+DTSTART:20190304T080000
+DTEND:20190304T083000
+END:VEVENT
+END:VCALENDAR

ics_query/tests/test_command_line.py

@@ -15,6 +15,8 @@
 # along with this program.  If not, see <https://www.gnu.org/licenses/>.
 """Test the commmand line."""
 
+from tzlocal import get_localzone_name
+
 from ics_query.version import version
 
 from .conftest import IOTestCase
@@ -51,3 +53,20 @@ def test_timezones(run):
     assert tz.index("Zulu") > tz.index("Pacific/Nauru")
     assert tz.index("Pacific/Nauru") > tz.index("UTC")
     assert tz.index("UTC") > tz.index("localtime")
+
+
+def test_special_timezones(run):
+    """Make sure we show special timezones first."""
+    result = run("--available-timezones")
+    tz = result.output.split()
+    assert result.exit_code == 0
+    assert tz[0] == "localtime"
+    assert tz[1] == get_localzone_name()
+    assert tz[2] == "UTC"
+
+
+def test_localtime_is_not_in_the_result_string(run):
+    """We do not want 'localtime' to turn up as the result tz name."""
+    result = run("first", "--tz", "localtime", "one-event-without-timezone.ics")
+    assert f"DTSTART;TZID={get_localzone_name()}:201903" in result.output
+    assert f"DTEND;TZID={get_localzone_name()}:201903" in result.output

{ics_query-0.3.1b0.dist-info → ics_query-0.3.2b0.dist-info}/METADATA

@@ -1,10 +1,10 @@
 Metadata-Version: 2.3
 Name: ics-query
-Version: 0.3.1b0
+Version: 0.3.2b0
 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/985400ff5c4df0ea4ad62422ef5c5c5e98face07.zip
+Project-URL: source_archive, https://github.com/niccokunzmann/ics-query/archive/594ac9795b0598b83ad10972c984519dfb3c7b12.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
@@ -699,6 +699,7 @@ Requires-Python: >=3.9
 Requires-Dist: click
 Requires-Dist: icalendar
 Requires-Dist: recurring-ical-events<4,>=3.2.0
+Requires-Dist: tzlocal
 Requires-Dist: x-wr-timezone
 Provides-Extra: test
 Requires-Dist: pytest; extra == 'test'
@@ -723,6 +724,8 @@ You can install this package from the [PyPI].
 pip install ics-query
 ```
 
+For **Windows**, you can download `ics-query.exe` from our [Releases].
+
 ## Support
 
 - Support using [GitHub Sponsors]
@@ -922,7 +925,7 @@ You can specify which components you would like to get using the
 -c VEVENT   # only events
 -c VTODO    # only TODOs
 -c VJOURNAL # only journal entries
--c VEVENT -v VTODO # only events and journal entries
+-c VEVENT -c VTODO # only events and journal entries
 ```
 
 This example returns the first event of a calendar.
@@ -1071,6 +1074,12 @@ To release new versions,
 
 ## Changelog
 
+- v0.3.2b
+
+  - Fix that `--tz localtime` would use `localtime` as timezone name instead of the local timezone name.
+  - Fix tests on Windows
+  - Add Windows .exe build artifact
+
 - v0.3.1b
 
   - Add `--license` option
@@ -1148,3 +1157,4 @@ Examples:
 [Polar]: https://polar.sh/niccokunzmann/ics-query
 [GitHub Sponsors]: https://github.com/sponsors/niccokunzmann
 [thanks.dev]: https://thanks.dev
+[Releases]: https://github.com/niccokunzmann/ics-query/releases

{ics_query-0.3.1b0.dist-info → ics_query-0.3.2b0.dist-info}/RECORD

@@ -1,13 +1,13 @@
 ics_query/__init__.py,sha256=BBd-FYDFf3jY_ApkMRkivqGti2uMeP4OT6KtgZDixic,917
 ics_query/__main__.py,sha256=1rFDbZZcd6llmQ-X_611jWdrua4HMOnpOclKRvf03Us,737
-ics_query/_version.py,sha256=c2CEW8svaXrg7VxTbX_h3WVVYqpNARBenswZBolcByk,413
-ics_query/cli.py,sha256=_Em8oiTtaTtK9H5ZvqB0-F2v3OibBBaDM6lmBPgaeq4,19918
+ics_query/_version.py,sha256=hP_Hdbj34-4rXjvG9r1qSsOVZyNFfJ3DfZgn3Z3x0_g,413
+ics_query/cli.py,sha256=VPXcSCjtaWZJtSzMsHqLfcTgStnJsoyY9K8Q0VZUs3o,19993
 ics_query/parse.py,sha256=AO2TBoe98exzfzTKsoF5ZAvJOg3hN2qRpP15DAQKZaM,2415
-ics_query/query.py,sha256=bmC0fcK-qHVj0tB4TPpwf4g6-qFmUyZxs_IjMovwBX8,2434
+ics_query/query.py,sha256=9HSSWJ1y7avU6mRDXBQKKTkk9oeG9qEwhr3k0piHbaU,2692
 ics_query/version.py,sha256=Tx41PPl2wc6dQI6r93EzTANoUXjkFzUvwMYj5ARauNQ,1347
 ics_query/tests/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-ics_query/tests/conftest.py,sha256=E4rN037kKJzrGUj4QggIv2LyaAGXnxNknnkcbheJplQ,2943
-ics_query/tests/test_command_line.py,sha256=iXLhdOOXb1I4MBsP82CSfTGu9kZM0s8PxNYLKO04PLw,1838
+ics_query/tests/conftest.py,sha256=MmxzXtpXHN3pf8jDmVGXvxcNXfepRwrJ03EF68zRSrY,3668
+ics_query/tests/test_command_line.py,sha256=mB_v-WqjpYRcxtROdi7GfvUGTEHYZ-3Z-sWevp7lFYc,2524
 ics_query/tests/test_parse_date.py,sha256=EGD06AtO_kNDcYEY7vhI9rN45HiZPbRm2LkGZoVW6iw,2785
 ics_query/tests/test_parse_timedelta.py,sha256=EpM013rw-G61wI0hyWjtFOtE7xXo2DNsU3vSIULGZ1k,1469
 ics_query/tests/runs/all --tz Singapore one-event.ics -.run,sha256=sWF9T4kKzhnZYrgidUX5sgdJ5q95q1gp9vd8X65bIdk,218
@@ -31,13 +31,14 @@ ics_query/tests/runs/calendars/empty-calendar.ics,sha256=78162P3KYUj6Qhbdnjsm3E8
 ics_query/tests/runs/calendars/empty-file.ics,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 ics_query/tests/runs/calendars/multiple-calendars.ics,sha256=lS1Q9eSPpzLs2TRDKUiwF9HmpnJMw8xqjLudA0-KtY4,1516
 ics_query/tests/runs/calendars/one-event-twice.ics,sha256=GZ5wE-U4kjO91N2nIaLsYZpSOLvQTjkoLPI6saMocOM,1450
+ics_query/tests/runs/calendars/one-event-without-timezone.ics,sha256=0ZQBHz2RDxUIrub4ZWwcQPpUS_bvdl0GT-kaLDppMlc,282
 ics_query/tests/runs/calendars/one-event.ics,sha256=-uwohttEzg-jsTETNb6tQ5dO9PE3DXzlicwRiXJs1KQ,725
 ics_query/tests/runs/calendars/recurring-work-events.ics,sha256=4ASS_-xZl2pVv1kZ7nDOU9jpkmbo4zJC2KEAgHtpsNU,5115
 ics_query/tests/runs/calendars/simple-journal.ics,sha256=U6_YMQM6EHwPDaszWgJDo-pR4WIqbJx8CRlHg4iu9zA,457
 ics_query/tests/runs/calendars/simple-todo.ics,sha256=l9uHQD4eyiCE8STvd2tj5lAVaBrqUtpF_M8Pv6yf1es,327
 ics_query/tests/runs/calendars/three-events.ics,sha256=YvPfthOzMCR0DQhGR6uj_1Bltgax3uA1ETlkI4JUI08,828
-ics_query-0.3.1b0.dist-info/METADATA,sha256=pPdD_fvpGxjiWnkUYCpPCghCSnwMym-IwM8WViw5a00,53198
-ics_query-0.3.1b0.dist-info/WHEEL,sha256=1yFddiXMmvYK7QYTqtRNtX66WJ0Mz8PYEiEUoOUUxRY,87
-ics_query-0.3.1b0.dist-info/entry_points.txt,sha256=Jq_39vCKVOkNZjL7Wngf_04V_n_QRszLgLT2CbJKiH4,49
-ics_query-0.3.1b0.dist-info/licenses/LICENSE,sha256=OXLcl0T2SZ8Pmy2_dmlvKuetivmyPd5m1q-Gyd-zaYY,35149
-ics_query-0.3.1b0.dist-info/RECORD,,
+ics_query-0.3.2b0.dist-info/METADATA,sha256=9MOLxp1rDhfK4VonU6T1I1OpmwAmafQiNNVy3ovmUnc,53535
+ics_query-0.3.2b0.dist-info/WHEEL,sha256=1yFddiXMmvYK7QYTqtRNtX66WJ0Mz8PYEiEUoOUUxRY,87
+ics_query-0.3.2b0.dist-info/entry_points.txt,sha256=Jq_39vCKVOkNZjL7Wngf_04V_n_QRszLgLT2CbJKiH4,49
+ics_query-0.3.2b0.dist-info/licenses/LICENSE,sha256=OXLcl0T2SZ8Pmy2_dmlvKuetivmyPd5m1q-Gyd-zaYY,35149
+ics_query-0.3.2b0.dist-info/RECORD,,