Overlay config setting dicts; add Python 3.13; linter fixes

Author: dakrauth

.github/workflows/test.yml

@@ -5,7 +5,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        python-version: ["3.10", "3.11", "3.12"]
+        python-version: ["3.10", "3.11", "3.12", "3.13"]
     steps:
     - uses: actions/checkout@v4
     - name: Set up Python ${{ matrix.python-version }}

Justfile

@@ -26,26 +26,23 @@ update:
     {{PIP}} install -U \
         build \
         pytest \
-        docutils \
         pytest-sugar \
         pytest-clarity \
         freezegun \
         responses \
         coverage \
         tox \
         ipython \
-        flake8 \
-        black \
         twine \
-        bump \
+        ruff \
         isort
 
 # Create a virtual environment if needed
 venv:
     #!/usr/bin/env bash
     if [ ! -d {{VENV}} ]; then
         echo Creating virtual env in dir {{VENV}} ...
-        python3 -m venv {{VENV}}
+        python3 -m venv --prompt when {{VENV}}
     fi 
 
 # Create virtual environment and install / update all dev dependencies
@@ -103,13 +100,22 @@ purge: clean clean-dev rmvenv clean-build
 build:
     {{BIN}}/python -m build --outdir ./.dev/dist
 
+# Run linter and code formatter checks
+check:
+    @echo Linting...
+    -{{BIN}}/ruff check --diff src/when tests
+
+    @echo Format checks...
+    -{{BIN}}/ruff format --diff --line-length 100 src/when tests
+
 # Run linter and code formatter tools
 lint:
     @echo Linting...
-    -{{BIN}}/flake8 src/when tests
+    -{{BIN}}/ruff check src/when tests
 
     @echo Format checks...
-    -{{BIN}}/black --check --diff -l 100 src/when tests
+    -{{BIN}}/ruff format --line-length 100 src/when tests
+
 
 # Launch sqlite data browser (macOS only)
 [macos]
@@ -133,6 +139,10 @@ strftime:
         "Notes:\n* - Locale-dependent\n+ - C99 extension\n! - when extension"
     )
 
+# Run a command from the venv bin directory
+run *args:
+    {{BIN}}/"$@"
+
 # Execute the when command with any arbitrary arguments
 when *args:
     @{{BIN}}/when "$@"

README.md

@@ -4,12 +4,34 @@
 [![PyPI](https://img.shields.io/pypi/v/when.svg)](https://pypi.python.org/pypi/when)
 
 **Scenario:** Your favorite sporting event, concert, performance, conference, or symposium is happening
-in Ulaanbaatar, Mongolia and all you know is the time of the event relative to the location.
+in Ulan Bator, Mongolia and all you have is the time of the event relative to the location -- Feb 8, 3pm.
+
+* What time is it currently in Ulan Bator?
+
+  ```console
+  $ when --source "Ulan Bator"
+  2025-02-07 03:08:58+0800 (+08, Asia/Ulaanbaatar) 038d05w (Ulan Bator, Ulaanbaatar, MN, Asia/Ulaanbaatar)[🌓 First Quarter]
+  ```
+* What time is the event in your local time (PST for me, currently)?
+
+  ```console
+  $ when --source "Ulan Bator" Feb 8 3pm
+  2025-02-07 23:00:00-0800 (PST, America/Los_Angeles) 038d05w [🌓 First Quarter]
+  ```
 
-* So what time is that for you in your local time?
 * What time did it or will it occur at some other time, past or present?
+
+  ```console
+  $ when --source "Ulan Bator" --offset +15d6h
+  2025-02-22 09:18:01+0800 (+08, Asia/Ulaanbaatar) 053d07w (Ulan Bator, Ulaanbaatar, MN, Asia/Ulaanbaatar)[🌗 Last Quarter]
+  ```
 * What about for your friends in other locations around the world?
 
+  ```console
+  $ when --exact --target London,GB  --source "Ulan Bator" Feb 8 3pm
+  2025-02-08 07:00:00+0000 (GMT, Europe/London) 039d05w (London, England, GB, Europe/London)[🌓 First Quarter]
+  ```
+
 ## Table of Contents
 
 - [Features](#features)
@@ -548,7 +570,7 @@ $ when --config
 
 You can refer to [Default TOML](#default-toml) below for all configuration values.
 
-To begin, lets create the file:
+To begin, create the file:
 
 ```console
 $ cat << EOF > .whenrc.toml
@@ -561,13 +583,13 @@ grouped = " ➡️ From "
 EOF
 ```
 
-Now, verify your configuration by doing:
+Now, verify the configuration by doing:
 
 ```console
 $ when --config
 ``` 
 
-At the top of the output, you should see a line similar to the following:
+At the top of the output there should be a line similar to the following:
 
 ```console
 # Read from /path/to/pwd/.whenrc.toml

pyproject.toml

@@ -22,9 +22,10 @@ classifiers = [
     "Operating System :: MacOS :: MacOS X",
     "Programming Language :: Python",
     "Programming Language :: Python :: 3",
-    "Programming Language :: Python :: 3.8",
-    "Programming Language :: Python :: 3.9",
     "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
     "Topic :: Software Development",
     "Topic :: Software Development :: Libraries",
     "Topic :: Software Development :: Libraries :: Python Modules",
@@ -51,8 +52,13 @@ packages = ["when", "when.db"]
 [tool.setuptools.dynamic]
 version = { attr = "when.__version__"}
 
-[tool.black]
+[tool.ruff]
+cache-dir = ".dev/ruff"
 line-length = 100
+indent-width = 4
+
+[tool.ruff.lint]
+ignore = ["E741"]
 
 [tool.pytest.ini_options]
 cache_dir = "./.dev/pytest_cache"

src/when/__init__.py

@@ -9,8 +9,7 @@
 def __getattr__(name):
     if name == "when":
         from .core import When
-        from .config import Settings
 
-        return When(Settings())
+        return When()
 
     raise AttributeError(f"What is {name}?")

src/when/cli.py

@@ -176,10 +176,7 @@ def get_parser(settings):
     )
 
     parser.add_argument(
-        "--alias",
-        type=int,
-        dest="db_alias",
-        help="Create a new alias from the city id"
+        "--alias", type=int, dest="db_alias", help="Create a new alias from the city id"
     )
 
     parser.add_argument(

src/when/config.py

@@ -222,31 +222,6 @@
 """
 
 
-def overlay(first, other):
-    if not isinstance(other, dict):
-        return first
-
-    keys = set([*first.keys(), *other.keys()])
-    result = {}
-    for key in keys:
-        if key not in other:
-            result[key] = first[key]
-            continue
-
-        if key not in first:
-            result[key] = other[key]
-            continue
-
-        if isinstance(first[key], dict):
-            result[key] = overlay(first[key], other[key])
-            continue
-
-        result[key] = other[key]
-
-    return result
-
-
-
 class Settings:
     NAME = ".whenrc.toml"
     DIRS = [Path.cwd(), Path.home()]
@@ -269,14 +244,14 @@ def read_path(self, path):
         except FileNotFoundError:
             pass
         else:
-            self.read_from.append(path)
             try:
-                result = overlay(self.data, data)
+                result = Settings.overlay(self.data, data)
             except Exception as why:
-                print(f"Unable to settings file {path}, skipping:", file=sys.stderr)
+                print(f"Unable to import settings file {path}, skipping:", file=sys.stderr)
                 print(f"{why}", file=sys.stderr)
             else:
                 self.data = result
+                self.read_from.append(path)
 
     @property
     def paths(self):
@@ -289,3 +264,27 @@ def write_text(self):
 
         out = toml.dumps(self.data)
         return f"{text}{out}"
+
+    @staticmethod
+    def overlay(first, other):
+        if not isinstance(other, dict):
+            return first
+
+        keys = set([*first.keys(), *other.keys()])
+        result = {}
+        for key in keys:
+            if key not in other:
+                result[key] = first[key]
+                continue
+
+            if key not in first:
+                result[key] = other[key]
+                continue
+
+            if isinstance(first[key], dict):
+                result[key] = Settings.overlay(first[key], other[key])
+                continue
+
+            result[key] = other[key]
+
+        return result

src/when/core.py

@@ -1,15 +1,13 @@
 import fnmatch
 import json
-import logging
 import re
 from datetime import date, datetime, timedelta
 from itertools import chain
 
 from dateutil import rrule
 from dateutil.easter import easter
 
-from . import exceptions, timezones, utils
-from .config import DEFAULT_FORMAT, FORMAT_SPECIFIERS
+from . import exceptions, timezones, utils, config
 from .db import client
 from .lunar import lunar_phase
 
@@ -72,9 +70,9 @@ def __init__(self, settings, format="default", delta=None):
         self.settings = settings
         self.format = self.settings["formats"]["named"].get(format, format)
 
-        self.c99_specs = [fs[0][1] for fs in FORMAT_SPECIFIERS if "+" in fs[-1]]
-        self.when_specs = [fs[0][2] for fs in FORMAT_SPECIFIERS if "!" == fs[-1]]
-        self.cond_specs = [fs[0][2] for fs in FORMAT_SPECIFIERS if "!!" == fs[-1]]
+        self.c99_specs = [fs[0][1] for fs in config.FORMAT_SPECIFIERS if "+" in fs[-1]]
+        self.when_specs = [fs[0][2] for fs in config.FORMAT_SPECIFIERS if "!" == fs[-1]]
+        self.cond_specs = [fs[0][2] for fs in config.FORMAT_SPECIFIERS if "!!" == fs[-1]]
         self.delta = delta
 
     def token_replacement(self, result, value, pattern, specs, prefix):
@@ -149,7 +147,7 @@ def c99_F(self, result):
 
     def c99_g(self, result):
         "Week-based year, last two digits (00-99): 01"
-        return f"{result.dt.year%100:02}"
+        return f"{result.dt.year % 100:02}"
 
     def c99_G(self, result):
         "Week-based year: 2001"
@@ -255,8 +253,8 @@ def __repr__(self):
 
 
 class When:
-    def __init__(self, settings, local_zone=None, db=None):
-        self.settings = settings
+    def __init__(self, settings=None, local_zone=None, db=None):
+        self.settings = settings or config.Settings()
         self.db = db or client.DB()
         self.tz_dict = {z: z for z in utils.all_zones()}
         for key in list(self.tz_dict):

src/when/db/__init__.py

@@ -1,7 +1,6 @@
 import sys
 
 from . import make, client
-from .. import utils
 
 CITY_FILE_SIZES = make.CITY_FILE_SIZES
 

src/when/db/client.py

@@ -1,10 +1,9 @@
 import os
 import re
-import contextlib
-import logging
 import sqlite3
-from collections import namedtuple
+import contextlib
 from pathlib import Path
+from collections import namedtuple
 
 from .. import utils
 from ..exceptions import DBError