wwvb 5.0.1__tar.gz → 5.0.3__tar.gz

{wwvb-5.0.1 → wwvb-5.0.3}/.github/workflows/cron.yml

@@ -11,7 +11,7 @@ on:
 
 jobs:
   update-dut1:
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-24.04
     if: startswith(github.repository, 'jepler/')
     steps:
 

{wwvb-5.0.1 → wwvb-5.0.3}/.github/workflows/release.yml

@@ -11,7 +11,7 @@ on:
 jobs:
   release:
 
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-24.04
     steps:
     - name: Dump GitHub context
       env:

{wwvb-5.0.1 → wwvb-5.0.3}/.github/workflows/test.yml

@@ -31,6 +31,31 @@ jobs:
     - name: Build HTML docs
       run: make html
 
+  typing:
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version:
+        - '3.13'
+        os-version:
+        - 'ubuntu-latest'
+    runs-on: ${{ matrix.os-version }}
+    steps:
+    - uses: actions/checkout@v4
+      with:
+        persist-credentials: false
+
+    - name: Set up Python
+      uses: actions/setup-python@v5
+      with:
+        python-version: ${{ matrix.python-version }}
+
+    - name: Install deps
+      run: |
+        python -mpip install wheel
+        python -mpip install -r requirements-dev.txt
+
+
   test:
     strategy:
       fail-fast: false
@@ -40,7 +65,8 @@ jobs:
         - '3.10'
         - '3.11'
         - '3.12'
-        - '3.13.0-alpha.0 - 3.13'
+        - '3.13'
+        - '3.14.0-alpha.0 - 3.14'
         os-version:
         - 'ubuntu-latest'
         include:
@@ -67,10 +93,6 @@ jobs:
         python -mpip install wheel
         python -mpip install -r requirements-dev.txt
 
-    - name: Check stubs
-      if: (! startsWith(matrix.python-version, 'pypy-'))
-      run: make mypy PYTHON=python
-
     - name: Coverage
       run: make coverage PYTHON=python
 

{wwvb-5.0.1 → wwvb-5.0.3}/.pre-commit-config.yaml

@@ -21,7 +21,7 @@ repos:
   - id: reuse
 - repo: https://github.com/astral-sh/ruff-pre-commit
   # Ruff version.
-  rev: v0.8.4
+  rev: v0.11.7
   hooks:
     # Run the linter.
     - id: ruff

wwvb-5.0.3/.readthedocs.yaml

@@ -0,0 +1,17 @@
+# SPDX-FileCopyrightText: 2024 Jeff Epler
+#
+# SPDX-License-Identifier: GPL-3.0-only
+
+version: 2
+
+build:
+  os: ubuntu-lts-latest
+  tools:
+    python: "3"
+
+sphinx:
+  configuration: doc/conf.py
+
+python:
+  install:
+    - requirements: requirements-dev.txt

{wwvb-5.0.1/src/wwvb.egg-info → wwvb-5.0.3}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: wwvb
-Version: 5.0.1
+Version: 5.0.3
 Summary: Generate WWVB timecodes for any desired time
 Author-email: Jeff Epler <jepler@gmail.com>
 Project-URL: Source, https://github.com/jepler/wwvbpy
@@ -33,13 +33,11 @@ SPDX-License-Identifier: GPL-3.0-only
 [![codecov](https://codecov.io/gh/jepler/wwvbpy/branch/main/graph/badge.svg?token=Exx0c3Gp65)](https://codecov.io/gh/jepler/wwvbpy)
 [![Update DUT1 data](https://github.com/jepler/wwvbpy/actions/workflows/cron.yml/badge.svg)](https://github.com/jepler/wwvbpy/actions/workflows/cron.yml)
 [![PyPI](https://img.shields.io/pypi/v/wwvb)](https://pypi.org/project/wwvb)
-[![CodeQL](https://github.com/jepler/wwvbpy/actions/workflows/codeql.yml/badge.svg)](https://github.com/jepler/wwvbpy/actions/workflows/codeql.yml)
 [![pre-commit.ci status](https://results.pre-commit.ci/badge/github/jepler/wwvbpy/main.svg)](https://results.pre-commit.ci/latest/github/jepler/wwvbpy/main)
 
 # Purpose
 
-wwvbpy generates WWVB timecodes for any desired time.  These timecodes
-may be useful in testing WWVB decoder software.
+Python package and command line programs for interacting with WWVB timecodes.
 
 Where possible, wwvbpy uses existing facilities for calendar and time
 manipulation (datetime and dateutil).
@@ -65,7 +63,7 @@ The package includes:
 
 # Development status
 
-The author (@jepler) occasionally develops and maintains this project, but
+The author ([@jepler](https://github.com/jepler)) occasionally develops and maintains this project, but
 issues are not likely to be acted on.  They would be interested in adding
 co-maintainer(s).
 
@@ -93,7 +91,7 @@ channel.
 # Usage
 
 ~~~~
-Usage: python -m wwvb.gen [OPTIONS] [TIMESPEC]...
+Usage: wwvbgen [OPTIONS] [TIMESPEC]...
 
   Generate WWVB timecodes
 
@@ -123,7 +121,7 @@ Options:
 
 For example, to display the leap second that occurred at the end of 1998,
 ~~~~
-$ python wwvbgen.py -m 7 1998 365 23 56
+$ wwvbgen -m 7 1998 365 23 56
 WWVB timecode: year=98 days=365 hour=23 min=56 dst=0 ut1=-300 ly=0 ls=1
 '98+365 23:56  210100110200100001120011001102010100010200110100121000001002
 '98+365 23:57  210100111200100001120011001102010100010200110100121000001002
@@ -145,7 +143,7 @@ The letters `a` through `u` represent offsets of -1.0s through +1.0s
 in 0.1s increments; `k` represents 0s.  (In practice, only a smaller range
 of values, typically -0.7s to +0.8s, is seen)
 
-For 2001 through 2019, NIST has published the actual DUT1 values broadcast,
+For 2001 through 2024, NIST has published the actual DUT1 values broadcast,
 and the date of each change, though it in the format of an HTML
 table and not designed for machine readability:
 

{wwvb-5.0.1 → wwvb-5.0.3}/README.md

@@ -7,13 +7,11 @@ SPDX-License-Identifier: GPL-3.0-only
 [![codecov](https://codecov.io/gh/jepler/wwvbpy/branch/main/graph/badge.svg?token=Exx0c3Gp65)](https://codecov.io/gh/jepler/wwvbpy)
 [![Update DUT1 data](https://github.com/jepler/wwvbpy/actions/workflows/cron.yml/badge.svg)](https://github.com/jepler/wwvbpy/actions/workflows/cron.yml)
 [![PyPI](https://img.shields.io/pypi/v/wwvb)](https://pypi.org/project/wwvb)
-[![CodeQL](https://github.com/jepler/wwvbpy/actions/workflows/codeql.yml/badge.svg)](https://github.com/jepler/wwvbpy/actions/workflows/codeql.yml)
 [![pre-commit.ci status](https://results.pre-commit.ci/badge/github/jepler/wwvbpy/main.svg)](https://results.pre-commit.ci/latest/github/jepler/wwvbpy/main)
 
 # Purpose
 
-wwvbpy generates WWVB timecodes for any desired time.  These timecodes
-may be useful in testing WWVB decoder software.
+Python package and command line programs for interacting with WWVB timecodes.
 
 Where possible, wwvbpy uses existing facilities for calendar and time
 manipulation (datetime and dateutil).
@@ -39,7 +37,7 @@ The package includes:
 
 # Development status
 
-The author (@jepler) occasionally develops and maintains this project, but
+The author ([@jepler](https://github.com/jepler)) occasionally develops and maintains this project, but
 issues are not likely to be acted on.  They would be interested in adding
 co-maintainer(s).
 
@@ -67,7 +65,7 @@ channel.
 # Usage
 
 ~~~~
-Usage: python -m wwvb.gen [OPTIONS] [TIMESPEC]...
+Usage: wwvbgen [OPTIONS] [TIMESPEC]...
 
   Generate WWVB timecodes
 
@@ -97,7 +95,7 @@ Options:
 
 For example, to display the leap second that occurred at the end of 1998,
 ~~~~
-$ python wwvbgen.py -m 7 1998 365 23 56
+$ wwvbgen -m 7 1998 365 23 56
 WWVB timecode: year=98 days=365 hour=23 min=56 dst=0 ut1=-300 ly=0 ls=1
 '98+365 23:56  210100110200100001120011001102010100010200110100121000001002
 '98+365 23:57  210100111200100001120011001102010100010200110100121000001002
@@ -119,7 +117,7 @@ The letters `a` through `u` represent offsets of -1.0s through +1.0s
 in 0.1s increments; `k` represents 0s.  (In practice, only a smaller range
 of values, typically -0.7s to +0.8s, is seen)
 
-For 2001 through 2019, NIST has published the actual DUT1 values broadcast,
+For 2001 through 2024, NIST has published the actual DUT1 values broadcast,
 and the date of each change, though it in the format of an HTML
 table and not designed for machine readability:
 

{wwvb-5.0.1 → wwvb-5.0.3}/doc/conf.py

@@ -56,6 +56,7 @@ version = release = final_version
 # ones.
 extensions = [
     "sphinx.ext.autodoc",
+    "sphinx_mdinclude",
 ]
 
 # Add any paths that contain templates here, relative to this directory.
@@ -82,6 +83,10 @@ html_static_path = ["_static"]
 autodoc_typehints = "description"
 autodoc_class_signature = "separated"
 
+default_role = "any"
+
+intersphinx_mapping = {'py': ('https://docs.python.org/3', None)}
+
 # SPDX-FileCopyrightText: 2021-2024 Jeff Epler
 #
 # SPDX-License-Identifier: GPL-3.0-only

wwvb-5.0.3/doc/index.rst

@@ -0,0 +1,24 @@
+.. SPDX-FileCopyrightText: 2021-2024 Jeff Epler
+..
+.. SPDX-License-Identifier: GPL-3.0-only
+
+wwvbpy |version|
+================
+
+.. mdinclude:: ../README.md
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+wwvb module
+===========
+
+.. automodule:: wwvb
+   :members:
+
+uwwvb module
+============
+
+.. automodule:: uwwvb
+   :members:

{wwvb-5.0.1 → wwvb-5.0.3}/pyproject.toml

@@ -19,7 +19,7 @@ dependencies = {file = "requirements.txt"}
 write_to = "src/wwvb/__version__.py"
 [tool.ruff.lint]
 select = ["E", "F", "D", "I", "N", "UP", "YTT", "BLE", "B", "FBT", "A", "COM", "C4", "DTZ", "FA", "ISC", "ICN", "PIE", "PYI", "Q", "RET", "SIM", "TID", "TCH", "ARG", "PTH", "C", "R", "W", "FLY", "RUF", "PL"]
-ignore = ["D203", "D213", "D400", "D415", "ISC001", "E741", "C901", "PLR0911", "PLR2004", "PLR0913"]
+ignore = ["D203", "D213", "D400", "D415", "ISC001", "E741", "C901", "PLR0911", "PLR2004", "PLR0913", "COM812"]
 [tool.ruff]
 line-length = 120
 [project]

{wwvb-5.0.1 → wwvb-5.0.3}/requirements-dev.txt

@@ -14,9 +14,10 @@ pre-commit
 python-dateutil
 requests; implementation_name=="cpython"
 setuptools>=68; implementation_name=="cpython"
-sphinx>=7,<8
+sphinx
 sphinx-autodoc-typehints
 sphinx-rtd-theme
+sphinx-mdinclude
 twine; implementation_name=="cpython"
 types-beautifulsoup4; implementation_name=="cpython"
 types-python-dateutil; implementation_name=="cpython"

{wwvb-5.0.1 → wwvb-5.0.3}/src/uwwvb.py

@@ -4,7 +4,10 @@
 
 # ruff: noqa: C405 PYI024 PLR2004 FBT001 FBT002
 
-"""Implementation of a WWVB state machine & decoder for resource-constrained systems"""
+"""Implementation of a WWVB state machine & decoder for resource-constrained systems
+
+This version is intended for use with MicroPython & CircuitPython.
+"""
 
 from __future__ import annotations
 

{wwvb-5.0.1 → wwvb-5.0.3}/src/wwvb/__init__.py

@@ -1,5 +1,13 @@
 #!/usr/bin/python3
-"""A library for WWVB timecodes"""
+"""A package and CLI for WWVB timecodes
+
+This is the full featured library suitable for use on 'real computers'.
+For a reduced version suitable for use on MicroPython & CircuitPython,
+see `uwwvb`.
+
+This package also includes the commandline programs listed above,
+perhaps most importantly ``wwvbgen`` for generating WWVB timecodes.
+"""
 
 # SPDX-FileCopyrightText: 2011-2024 Jeff Epler
 #
@@ -24,12 +32,6 @@ SECOND = datetime.timedelta(seconds=1)
 T = TypeVar("T")
 
 
-def _require(x: T | None) -> T:
-    """Check an Optional item is not None."""
-    assert x is not None
-    return x
-
-
 def _removeprefix(s: str, p: str) -> str:
     if s.startswith(p):
         return s[len(p) :]
@@ -49,7 +51,6 @@ def _maybe_warn_update(dt: datetime.date, stacklevel: int = 1) -> None:
     # If the date is less than 300 days after today, there should be (possibly)
     # prospective available now.
     today = datetime.datetime.now(tz=datetime.timezone.utc).date()
-    print(f"_mwu {today=!r} {dt=!r} {iersdata.end=!r}")
     if _date(dt) < today + datetime.timedelta(days=330):
         warnings.warn(
             "Note: Running `updateiers` may provide better DUT1 and LS information",
@@ -324,11 +325,22 @@ _dst_ls_lut = [
 ]
 
 
-class _WWVBMinute(NamedTuple):
-    """Uniquely identifies a minute of time in the WWVB system.
+@enum.unique
+class DstStatus(enum.IntEnum):
+    """Constants that describe the DST status of a minute"""
 
-    To use ut1 and ls information from IERS, create a WWVBMinuteIERS value instead.
-    """
+    DST_NOT_IN_EFFECT = 0b00
+    """DST not in effect today"""
+    DST_STARTS_TODAY = 0b01
+    """DST starts today at 0200 local standard time"""
+    DST_ENDS_TODAY = 0b10
+    """DST ends today at 0200 local standard time"""
+    DST_IN_EFFECT = 0b11
+    """DST in effect all day today"""
+
+
+class _WWVBMinute(NamedTuple):
+    """(implementation detail)"""
 
     year: int
     """2-digit year within the WWVB epoch"""
@@ -342,7 +354,7 @@ class _WWVBMinute(NamedTuple):
     min: int
     """Minute of hour"""
 
-    dst: int
+    dst: DstStatus
     """2-bit DST code """
 
     ut1: int
@@ -358,7 +370,8 @@ class _WWVBMinute(NamedTuple):
 class WWVBMinute(_WWVBMinute):
     """Uniquely identifies a minute of time in the WWVB system.
 
-    To use ut1 and ls information from IERS, create a WWVBMinuteIERS value instead.
+    To use ``ut1`` and ``ls`` information from IERS, create a `WWVBMinuteIERS`
+    object instead.
     """
 
     epoch: int = 1970
@@ -369,16 +382,25 @@ class WWVBMinute(_WWVBMinute):
         days: int,
         hour: int,
         minute: int,
-        dst: int | None = None,
+        dst: DstStatus | int | None = None,
         ut1: int | None = None,
         ls: bool | None = None,
         ly: bool | None = None,
     ) -> WWVBMinute:
-        """Construct a WWVBMinute"""
-        if dst is None:
-            dst = cls.get_dst(year, days)
-        if dst not in (0, 1, 2, 3):
-            raise ValueError("dst value should be 0..3")
+        """Construct a WWVBMinute
+
+        :param year: The 2- or 4-digit year. This parameter is converted by the `full_year` method.
+        :param days: 1-based day of year
+
+        :param hour: UTC hour of day
+
+        :param minute: Minute of hour
+        :param dst: 2-bit DST code
+        :param ut1: UT1 offset in units of 100ms, range -900 to +900ms
+        :param ls: Leap second warning flag
+        :param ly: Leap year flag
+        """
+        dst = cls.get_dst(year, days) if dst is None else DstStatus(dst)
         if ut1 is None and ls is None:
             ut1, ls = cls._get_dut1_info(year, days)
         elif ut1 is None or ls is None:
@@ -408,13 +430,13 @@ class WWVBMinute(_WWVBMinute):
         return year
 
     @staticmethod
-    def get_dst(year: int, days: int) -> int:
+    def get_dst(year: int, days: int) -> DstStatus:
         """Get the 2-bit WWVB DST value for the given day"""
         d0 = datetime.datetime(year, 1, 1, tzinfo=datetime.timezone.utc) + datetime.timedelta(days - 1)
         d1 = d0 + datetime.timedelta(1)
         dst0 = isdst(d0)
         dst1 = isdst(d1)
-        return dst1 * 2 + dst0
+        return DstStatus(dst1 * 2 + dst0)
 
     def __str__(self) -> str:
         """Implement str()"""
@@ -425,7 +447,10 @@ class WWVBMinute(_WWVBMinute):
         )
 
     def as_datetime_utc(self) -> datetime.datetime:
-        """Convert to a UTC datetime"""
+        """Convert to a UTC datetime
+
+        The returned object has ``tzinfo=datetime.timezone.utc``.
+        """
         d = datetime.datetime(self.year, 1, 1, tzinfo=datetime.timezone.utc)
         d += datetime.timedelta(self.days - 1, self.hour * 3600 + self.min * 60)
         return d
@@ -438,7 +463,18 @@ class WWVBMinute(_WWVBMinute):
         *,
         dst_observed: bool = True,
     ) -> datetime.datetime:
-        """Convert to a local datetime according to the DST bits"""
+        """Convert to a local datetime according to the DST bits
+
+        The returned object has ``tz=datetime.timezone(computed_offset)``.
+
+        :param standard_time_offset: The UTC offset of local standard time, in seconds west of UTC.
+            The default value, ``7 * 3600``, is for Colorado, the source of the WWVB broadcast.
+
+        :param dst_observed: If ``True`` then the locale observes DST, and a
+            one hour offset is applied according to WWVB rules. If ``False``, then
+            the standard time offset is used at all times.
+
+        """
         u = self.as_datetime_utc()
         offset = datetime.timedelta(seconds=-standard_time_offset)
         d = u - datetime.timedelta(seconds=standard_time_offset)
@@ -683,7 +719,7 @@ class WWVBMinute(_WWVBMinute):
         return cls(u.tm_year, u.tm_yday, u.tm_hour, u.tm_min, ut1=newut1, ls=newls)
 
     @classmethod
-    def from_timecode_am(cls, t: WWVBTimecode) -> WWVBMinute | None:
+    def from_timecode_am(cls, t: WWVBTimecode) -> WWVBMinute | None:  # noqa: PLR0912
         """Construct a WWVBMinute from a WWVBTimecode"""
         for i in (0, 9, 19, 29, 39, 49, 59):
             if t.am[i] != AmplitudeModulation.MARK:
@@ -698,9 +734,13 @@ class WWVBMinute(_WWVBMinute):
         minute = t._get_am_bcd(1, 2, 3, 5, 6, 7, 8)
         if minute is None:
             return None
+        if minute >= 60:
+            return None
         hour = t._get_am_bcd(12, 13, 15, 16, 17, 18)
         if hour is None:
             return None
+        if hour >= 24:
+            return None
         days = t._get_am_bcd(22, 23, 25, 26, 27, 28, 30, 31, 32, 33)
         if days is None:
             return None
@@ -717,7 +757,9 @@ class WWVBMinute(_WWVBMinute):
         if days > 366 or (not ly and days > 365):
             return None
         ls = bool(t.am[56])
-        dst = _require(t._get_am_bcd(57, 58))
+        dst = t._get_am_bcd(57, 58)
+        if dst is None:
+            return None
         return cls(year, days, hour, minute, dst, ut1, ls, ly)
 
 
@@ -727,10 +769,10 @@ class WWVBMinuteIERS(WWVBMinute):
     @classmethod
     def _get_dut1_info(cls, year: int, days: int, old_time: WWVBMinute | None = None) -> tuple[int, bool]:  # noqa: ARG003
         d = datetime.datetime(year, 1, 1, tzinfo=datetime.timezone.utc) + datetime.timedelta(days - 1)
-        return int(round(get_dut1(d) * 10)) * 100, isls(d)
+        return round(get_dut1(d) * 10) * 100, isls(d)
 
 
-def _bcd_bits(n: int) -> Generator[bool, None, None]:
+def _bcd_bits(n: int) -> Generator[bool]:
     """Return the bcd representation of n, starting with the least significant bit"""
     while True:
         d = n % 10
@@ -744,9 +786,13 @@ class AmplitudeModulation(enum.IntEnum):
     """Constants that describe an Amplitude Modulation value"""
 
     ZERO = 0
+    """A zero bit (reduced carrier during the first 200ms of the second)"""
     ONE = 1
+    """A one bit (reduced carrier during the first 500ms of the second)"""
     MARK = 2
+    """A mark bit (reduced carrier during the first 800ms of the second)"""
     UNSET = -1
+    """An unset or unknown amplitude modulation value"""
 
 
 @enum.unique
@@ -754,8 +800,11 @@ class PhaseModulation(enum.IntEnum):
     """Constants that describe a Phase Modulation value"""
 
     ZERO = 0
+    """A one bit (180° phase shift during the second)"""
     ONE = 1
+    """A zero bit (No phase shift during the second)"""
     UNSET = -1
+    """An unset or unknown phase modulation value"""
 
 
 class WWVBTimecode:
@@ -778,7 +827,10 @@ class WWVBTimecode:
         The the bits ``self.am[poslist[i]]`` in MSB order are converted from
         BCD to integer
         """
-        pos = reversed(poslist)
+        pos = list(poslist)[::-1]
+        for p in pos:
+            if self.am[p] not in {AmplitudeModulation.ZERO, AmplitudeModulation.ONE}:
+                return None
         val = [bool(self.am[p]) for p in pos]
         result = 0
         base = 1

{wwvb-5.0.1 → wwvb-5.0.3}/src/wwvb/__version__.py

@@ -1,8 +1,13 @@
-# file generated by setuptools_scm
+# file generated by setuptools-scm
 # don't change, don't track in version control
+
+__all__ = ["__version__", "__version_tuple__", "version", "version_tuple"]
+
 TYPE_CHECKING = False
 if TYPE_CHECKING:
-    from typing import Tuple, Union
+    from typing import Tuple
+    from typing import Union
+
     VERSION_TUPLE = Tuple[Union[int, str], ...]
 else:
     VERSION_TUPLE = object
@@ -12,5 +17,5 @@ __version__: str
 __version_tuple__: VERSION_TUPLE
 version_tuple: VERSION_TUPLE
 
-__version__ = version = '5.0.1'
-__version_tuple__ = version_tuple = (5, 0, 1)
+__version__ = version = '5.0.3'
+__version_tuple__ = version_tuple = (5, 0, 3)

wwvb-5.0.3/src/wwvb/iersdata.json

@@ -0,0 +1 @@
+{"START": "1972-01-01", "OFFSETS_GZ": "H4sIAHTtFGgC/+2aa3LDMAiEL5uHLDuxnN5/pn/aTmfSSiAWhGR9J8gsywJylqVHPtqxZuH/7leeI0fKsGd5EngQ2WisJWKegrThDa6aJFnL0u4wYZkCE2UmSF0U+13vCveStC6JTfQyW3O86HLJf0SvDgy5u4FCI+WVKRuy0KMjJeXoULIvMDmEWgeRxAJtwXquPCIBqbLh/gbfv0mcxk3mHV9tYiATZP8W/zgw2wd5LpJnY+WErI8abJ3opaIW6592+YMbjSsNWQFlNVVtuhjhtQzSUh4MEpOdDrSW6qsUv+O+Dt+XkIONSrUwvWmTsmq5LO9xsZ+EgcDK+MIESDaYmxSxGlgbGOFjBXMjbV7lc6zlmQ0i48oH5P4+vK7i/AHc7tfTXDtffqFi3m6WhApPSTyDvArU5vUDhm7YaNQYGASVbbwLUBtI2PrhSiZNbvCRrtGUGu0GbjDhJ3aLCx5dQFjt0LFovmWB96e6tktqMenoULXajVS3asBibP3kYXrpmZxnsS2Yf2xRPrHbvQ2D9wjfL4C6b4PWV4otW0vWUYkeWE5M8M594oLbxP77xcl4NuBkG0dfM3xOUf/T0GF+ur+J5pljcODEUZkXg6vIdLYy7g3oZU3bPNDnc8qwGdJZMmAurUsRj6tOo95zP6fb9YPWp5OuZ5X7q2DrmsG/VCyTyaREnDRhnUxOzfzzhzuJhuMTQw5vlI1NAAA="}

{wwvb-5.0.1 → wwvb-5.0.3}/src/wwvb/updateiers.py

@@ -52,7 +52,7 @@ def update_iersdata(  # noqa: PLR0915
         offs_str = r["UT1-UTC"]
         if not offs_str:
             break
-        offs = int(round(float(offs_str) * 10))
+        offs = round(float(offs_str) * 10)
         if not offsets:
             table_start = datetime.date(1858, 11, 17) + datetime.timedelta(jd)
 
@@ -98,7 +98,7 @@ def update_iersdata(  # noqa: PLR0915
         cells = row.findAll("td")
         when = datetime.datetime.strptime(cells[0].text + "+0000", "%Y-%m-%d%z").date()
         dut1 = cells[2].text.replace("s", "").replace(" ", "")
-        dut1 = int(round(float(dut1) * 10))
+        dut1 = round(float(dut1) * 10)
         if wwvb_dut1 is not None:
             assert wwvb_start is not None
             patch(wwvb_start, when, wwvb_dut1)

{wwvb-5.0.1 → wwvb-5.0.3}/src/wwvb/wwvbtk.py

@@ -6,9 +6,8 @@
 # SPDX-License-Identifier: GPL-3.0-only
 from __future__ import annotations
 
+import datetime
 import functools
-import threading
-import time
 from tkinter import Canvas, TclError, Tk
 from typing import TYPE_CHECKING, Any
 
@@ -31,7 +30,7 @@ def validate_colors(ctx: Any, param: Any, value: str) -> list[str]:  # noqa: ARG
     app = _app()
     colors = value.split()
     if len(colors) not in (2, 3, 4, 6):
-        raise click.BadParameter(f"Give 2, 3, 4 or 6 colors (not {len(colors)}")
+        raise click.BadParameter(f"Give 2, 3, 4 or 6 colors (not {len(colors)})")
     for c in colors:
         try:
             app.winfo_rgb(c)
@@ -53,33 +52,36 @@ DEFAULT_COLORS = "#3c3c3c #3c3c3c #3c3c3c #cc3c3c #88883c #3ccc3c"
 
 
 @click.command
-@click.option("--colors", callback=validate_colors, default=DEFAULT_COLORS)
-@click.option("--size", default=48)
-@click.option("--min-size", default=None)
+@click.option(
+    "--colors",
+    callback=validate_colors,
+    default=DEFAULT_COLORS,
+    metavar="COLORS",
+    help="2, 3, 4, or 6 Tk color values",
+)
+@click.option("--size", default=48, help="initial size in pixels")
+@click.option("--min-size", default=None, type=int, help="minimum size in pixels (default: same as initial size)")
 def main(colors: list[str], size: int, min_size: int | None) -> None:  # noqa: PLR0915
     """Visualize the WWVB signal in realtime"""
     if min_size is None:
         min_size = size
 
-    def sleep_deadline(deadline: float) -> None:
-        """Sleep until a deadline"""
-        now = time.time()
-        if deadline > now:
-            time.sleep(deadline - now)
+    def deadline_ms(deadline: datetime.datetime) -> int:
+        """Compute the number of ms until a deadline"""
+        now = datetime.datetime.now(datetime.timezone.utc)
+        return int(max(0, (deadline - now).total_seconds()) * 1000)
 
-    def wwvbtick() -> Generator[tuple[float, wwvb.AmplitudeModulation], None, None]:
+    def wwvbtick() -> Generator[tuple[datetime.datetime, wwvb.AmplitudeModulation]]:
         """Yield consecutive values of the WWVB amplitude signal, going from minute to minute"""
-        timestamp = time.time() // 60 * 60
+        timestamp = datetime.datetime.now(datetime.timezone.utc).replace(second=0, microsecond=0)
 
         while True:
-            tt = time.gmtime(timestamp)
-            key = tt.tm_year, tt.tm_yday, tt.tm_hour, tt.tm_min
-            timecode = wwvb.WWVBMinuteIERS(*key).as_timecode()
+            timecode = wwvb.WWVBMinuteIERS.from_datetime(timestamp).as_timecode()
             for i, code in enumerate(timecode.am):
-                yield timestamp + i, code
-            timestamp = timestamp + 60
+                yield timestamp + datetime.timedelta(seconds=i), code
+            timestamp = timestamp + datetime.timedelta(seconds=60)
 
-    def wwvbsmarttick() -> Generator[tuple[float, wwvb.AmplitudeModulation], None, None]:
+    def wwvbsmarttick() -> Generator[tuple[datetime.datetime, wwvb.AmplitudeModulation]]:
         """Yield consecutive values of the WWVB amplitude signal
 
         .. but deal with time progressing unexpectedly, such as when the
@@ -90,10 +92,10 @@ def main(colors: list[str], size: int, min_size: int | None) -> None:  # noqa: P
         """
         while True:
             for stamp, code in wwvbtick():
-                now = time.time()
-                if stamp < now - 60:
+                now = datetime.datetime.now(datetime.timezone.utc)
+                if stamp < now - datetime.timedelta(seconds=60):
                     break
-                if stamp < now - 1:
+                if stamp < now - datetime.timedelta(seconds=1):
                     continue
                 yield stamp, code
 
@@ -127,18 +129,23 @@ def main(colors: list[str], size: int, min_size: int | None) -> None:  # noqa: P
         """Turn the canvas's virtual LED off"""
         canvas.itemconfigure(circle, fill=colors[i])
 
-    def thread_func() -> None:
-        """Update the canvas virtual LED"""
+    def controller_func() -> Generator[int]:
+        """Update the canvas virtual LED, yielding the number of ms until the next change"""
         for stamp, code in wwvbsmarttick():
-            sleep_deadline(stamp)
+            yield deadline_ms(stamp)
             led_on(code)
             app.update()
-            sleep_deadline(stamp + 0.2 + 0.3 * int(code))
+            yield deadline_ms(stamp + datetime.timedelta(seconds=0.2 + 0.3 * int(code)))
             led_off(code)
             app.update()
 
-    thread = threading.Thread(target=thread_func, daemon=True)
-    thread.start()
+    controller = controller_func().__next__
+
+    def after_func() -> None:
+        """Repeatedly run the controller after the desired interval"""
+        app.after(controller(), after_func)
+
+    app.after_idle(after_func)
     app.mainloop()
 
 

{wwvb-5.0.1 → wwvb-5.0.3/src/wwvb.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: wwvb
-Version: 5.0.1
+Version: 5.0.3
 Summary: Generate WWVB timecodes for any desired time
 Author-email: Jeff Epler <jepler@gmail.com>
 Project-URL: Source, https://github.com/jepler/wwvbpy
@@ -33,13 +33,11 @@ SPDX-License-Identifier: GPL-3.0-only
 [![codecov](https://codecov.io/gh/jepler/wwvbpy/branch/main/graph/badge.svg?token=Exx0c3Gp65)](https://codecov.io/gh/jepler/wwvbpy)
 [![Update DUT1 data](https://github.com/jepler/wwvbpy/actions/workflows/cron.yml/badge.svg)](https://github.com/jepler/wwvbpy/actions/workflows/cron.yml)
 [![PyPI](https://img.shields.io/pypi/v/wwvb)](https://pypi.org/project/wwvb)
-[![CodeQL](https://github.com/jepler/wwvbpy/actions/workflows/codeql.yml/badge.svg)](https://github.com/jepler/wwvbpy/actions/workflows/codeql.yml)
 [![pre-commit.ci status](https://results.pre-commit.ci/badge/github/jepler/wwvbpy/main.svg)](https://results.pre-commit.ci/latest/github/jepler/wwvbpy/main)
 
 # Purpose
 
-wwvbpy generates WWVB timecodes for any desired time.  These timecodes
-may be useful in testing WWVB decoder software.
+Python package and command line programs for interacting with WWVB timecodes.
 
 Where possible, wwvbpy uses existing facilities for calendar and time
 manipulation (datetime and dateutil).
@@ -65,7 +63,7 @@ The package includes:
 
 # Development status
 
-The author (@jepler) occasionally develops and maintains this project, but
+The author ([@jepler](https://github.com/jepler)) occasionally develops and maintains this project, but
 issues are not likely to be acted on.  They would be interested in adding
 co-maintainer(s).
 
@@ -93,7 +91,7 @@ channel.
 # Usage
 
 ~~~~
-Usage: python -m wwvb.gen [OPTIONS] [TIMESPEC]...
+Usage: wwvbgen [OPTIONS] [TIMESPEC]...
 
   Generate WWVB timecodes
 
@@ -123,7 +121,7 @@ Options:
 
 For example, to display the leap second that occurred at the end of 1998,
 ~~~~
-$ python wwvbgen.py -m 7 1998 365 23 56
+$ wwvbgen -m 7 1998 365 23 56
 WWVB timecode: year=98 days=365 hour=23 min=56 dst=0 ut1=-300 ly=0 ls=1
 '98+365 23:56  210100110200100001120011001102010100010200110100121000001002
 '98+365 23:57  210100111200100001120011001102010100010200110100121000001002
@@ -145,7 +143,7 @@ The letters `a` through `u` represent offsets of -1.0s through +1.0s
 in 0.1s increments; `k` represents 0s.  (In practice, only a smaller range
 of values, typically -0.7s to +0.8s, is seen)
 
-For 2001 through 2019, NIST has published the actual DUT1 values broadcast,
+For 2001 through 2024, NIST has published the actual DUT1 values broadcast,
 and the date of each change, though it in the format of an HTML
 table and not designed for machine readability:
 

{wwvb-5.0.1 → wwvb-5.0.3}/src/wwvb.egg-info/SOURCES.txt

@@ -1,6 +1,7 @@
 .coveragerc
 .gitignore
 .pre-commit-config.yaml
+.readthedocs.yaml
 Makefile
 README.md
 adafruit_datetime.pyi
@@ -8,7 +9,6 @@ codecov.yml
 pyproject.toml
 requirements-dev.txt
 requirements.txt
-.github/workflows/codeql.yml
 .github/workflows/cron.yml
 .github/workflows/release.yml
 .github/workflows/test.yml

{wwvb-5.0.1 → wwvb-5.0.3}/test/testwwvb.py

@@ -395,6 +395,38 @@ class WWVBRoundtrip(unittest.TestCase):
         self.assertEqual(WWVBMinute2k(2070, 1, 1, 0, 0).year, 2070)
         self.assertEqual(WWVBMinute2k(2099, 1, 1, 0, 0).year, 2099)
 
+    def test_invalid_minute(self) -> None:
+        """Check that minute 61 is not valid in an AM timecode"""
+        base_minute = wwvb.WWVBMinute(2021, 1, 1, 0, 0)
+        minute = base_minute.as_timecode()
+        minute._put_am_bcd(61, 1, 2, 3, 5, 6, 7, 8)  # valid BCD, invalid minute
+        decoded_minute = wwvb.WWVBMinute.from_timecode_am(minute)
+        assert decoded_minute is None
+
+    def test_invalid_hour(self) -> None:
+        """Check that hour 25 is not valid in an AM timecode"""
+        base_minute = wwvb.WWVBMinute(2021, 1, 1, 0, 0)
+        minute = base_minute.as_timecode()
+        minute._put_am_bcd(29, 12, 13, 15, 16, 17, 18)  # valid BCD, invalid hour
+        decoded_minute = wwvb.WWVBMinute.from_timecode_am(minute)
+        assert decoded_minute is None
+
+    def test_invalid_bcd_day(self) -> None:
+        """Check that invalid BCD is detected in AM timecode"""
+        base_minute = wwvb.WWVBMinute(2021, 1, 1, 0, 0)
+        minute = base_minute.as_timecode()
+        minute.am[30:34] = [wwvb.AmplitudeModulation.ONE] * 4  # invalid BCD 0xf
+        decoded_minute = wwvb.WWVBMinute.from_timecode_am(minute)
+        assert decoded_minute is None
+
+    def test_invalid_mark(self) -> None:
+        """Check that invalid presence of MARK in a data field is detected"""
+        base_minute = wwvb.WWVBMinute(2021, 1, 1, 0, 0)
+        minute = base_minute.as_timecode()
+        minute.am[57] = wwvb.AmplitudeModulation.MARK
+        decoded_minute = wwvb.WWVBMinute.from_timecode_am(minute)
+        assert decoded_minute is None
+
 
 if __name__ == "__main__":
     unittest.main()

wwvb-5.0.1/.github/workflows/codeql.yml

@@ -1,49 +0,0 @@
-# SPDX-FileCopyrightText: 2022-2024 Jeff Epler
-#
-# SPDX-License-Identifier: CC0-1.0
-
-name: "CodeQL"
-
-on:
-  push:
-    branches: [ "main" ]
-  pull_request:
-    branches: [ "main" ]
-  schedule:
-    - cron: "53 3 * * 5"
-
-jobs:
-  analyze:
-    name: Analyze
-    runs-on: ubuntu-latest
-    permissions:
-      actions: read
-      contents: read
-      security-events: write
-
-    strategy:
-      fail-fast: false
-      matrix:
-        language: [ python ]
-
-    steps:
-      - name: Checkout
-        uses: actions/checkout@v4
-        with:
-          persist-credentials: false
-      - name: Install Dependencies (python)
-        run: pip3 install -r requirements-dev.txt
-
-      - name: Initialize CodeQL
-        uses: github/codeql-action/init@v3
-        with:
-          languages: ${{ matrix.language }}
-          queries: +security-and-quality
-
-      - name: Autobuild
-        uses: github/codeql-action/autobuild@v3
-
-      - name: Perform CodeQL Analysis
-        uses: github/codeql-action/analyze@v3
-        with:
-          category: "/language:${{ matrix.language }}"

wwvb-5.0.1/doc/index.rst

@@ -1,31 +0,0 @@
-.. SPDX-FileCopyrightText: 2021-2024 Jeff Epler
-..
-.. SPDX-License-Identifier: GPL-3.0-only
-
-wwvbpy
-======
-
-.. image:: https://github.com/jepler/wwvbpy/actions/workflows/test.yml/badge.svg
-    :target: https://github.com/jepler/wwvbpy/actions/workflows/test.yml
-    :alt: Test wwvbpy
-
-.. image:: https://img.shields.io/pypi/v/wwvb
-    :target: https://pypi.org/project/wwvb
-    :alt: PyPI
-
-
-.. toctree::
-   :maxdepth: 2
-   :caption: Contents:
-
-wwvb module
-===========
-
-.. automodule:: wwvb
-   :members:
-
-uwwvb module
-============
-
-.. automodule:: uwwvb
-   :members:

wwvb-5.0.1/src/wwvb/iersdata.json

@@ -1 +0,0 @@
-{"START": "1972-01-01", "OFFSETS_GZ": "H4sIAMNkdmcC/+2aa3LDMAiEL5uHLTuxnN5/pn/aTmfSSiAWhGy+E2SWZQE58zwiH/1YivB/96vMXiIX2Io8CTyIrDSWGqlMRdrpDa6aJFnr0m4wYZkCE2UmSF0V+13vBveStK6JTfQyW3O86HLJf0RvDgy5u4FCI+WVKTsVoUdHzsrRoWRfYHIItZ5EEgu0Beu58EgEpMpO9zf4/s3iNO4y7/hqEwOZIPu3+PuO2T7Ic5E8GxsnZHvUYOtELxW1WP+0yx/caFxpyAooq6lq06UEr+UkLeXOIDPZ6EBrqb5K8Tvu6/B9CdnZqFQL05s2KauWy/IeF/tJGAisjK9MgGyDuUkRq4G1gRE+VjA30uZNPsdantkgMq58QO4fw+sqzj+A2/16mmvnyy9UzDvMktDgKYlnkFeB2rx+wNANG40aA4OgsY03AWoDCVs/XMmkyQ0+0jWaUqPdwA0m/MRuccGjCwirHToWzbcs8P7U1nZZLSYdHapWu5HqVg1YjK2fPEwvPZPzLPUF848tyid2u7dh8B7h+wVQ923Q+kqxZe3JclSSB+YTM3nnHrjgFth/vzgZzw6cbOMYa4bHFPU/DR3mp/ubKM4cgwMnHZW4GFxFprOVcevAKGva6oExn1MOmyGDJQPm0rpU8bjqdOo993O6Xz9ofToZela5vwrWoTn4l4o5CIIaKejCEgSnJv784V8zOZ+rHS1DD00AAA=="}