fix ty check for conditional importlib_metadata import

Author: woutervh

pyproject.toml

@@ -214,6 +214,12 @@ ignore = [
 [tool.ruff.lint.isort]
 force-single-line = false
 
+[tool.ty.lint]
+# Needed because importlib_metadata is only installed on Python < 3.10,
+# but we need ty:ignore for when ty runs on Python >= 3.10
+ignore = ["unused-ignore-comment"]
+
+
 [tool.uv]
 package = true
 default-groups = "all"

scripts/example_requests.py

@@ -0,0 +1,40 @@
+#!/usr/bin/env -S uv run --script
+# /// script
+# dependencies = [
+#   "httpclient-logging",
+#   "requests",
+#   "rich",
+# ]
+# ///
+
+"""Demo requests usage."""
+
+import logging
+
+import requests
+import rich
+import rich.logging
+
+# configure colorized logging to console
+# enables output from all loggers including http.client
+logging.basicConfig(
+    level=logging.DEBUG,
+    format="%(name)s - %(message)s",
+    handlers=[rich.logging.RichHandler(rich_tracebacks=False)],
+)
+
+# experiment with different levels
+# logging.getLogger("example").setLevel(logging.INFO)
+# logging.getLogger("http.client").setLevel(logging.INFO)
+# logging.getLogger("urllib3").setLevel(logging.INFO)
+
+log = logging.getLogger("example")
+
+url = "https://peps.python.org/api/peps.json"
+
+log.info(f"Fetching data from {url}")
+resp = requests.get(url, timeout=5)
+log.info("Requests response status code: %s", resp.status_code)
+data = resp.json()
+
+rich.print([(k, v["title"]) for k, v in data.items()][:10])

scripts/example_urllib.py

@@ -0,0 +1,44 @@
+#!/usr/bin/env -S uv run --script
+# /// script
+# dependencies = [
+#   "httpclient-logging",
+#   "libranet-logging",
+#   "requests",
+#   "rich",
+# ]
+# ///
+
+"""Demo requests usage."""
+
+import json
+import logging
+import urllib.request
+
+# configure colorized logging to console
+# enables output from all loggers including http.client
+# logging.basicConfig(
+#     level=logging.DEBUG,
+#     format="%(name)s - %(message)s",
+#     handlers=[rich.logging.RichHandler(rich_tracebacks=False)],
+# )
+import libranet_logging
+import rich
+import rich.logging
+
+libranet_logging.initialize()
+
+# experiment with different levels
+# logging.getLogger("example").setLevel(logging.INFO)
+# logging.getLogger("http.client").setLevel(logging.INFO)
+# logging.getLogger("urllib3").setLevel(logging.INFO)
+
+log = logging.getLogger("example")
+
+url = "https://peps.python.org/api/peps.json"
+
+log.info(f"Fetching data from {url}")
+resp = urllib.request.urlopen(url, timeout=5)
+log.info("Requests response status code: %s", resp.code)
+data = json.load(resp)
+
+rich.print([(k, v["title"]) for k, v in data.items()][:10])

src/httpclient_logging/about.py

@@ -12,7 +12,7 @@
 if sys.version_info >= (3, 10):
     import importlib.metadata as importlib_metadata
 else:
-    import importlib_metadata
+    import importlib_metadata  # ty:ignore[unresolved-import]
 
 PACKAGE: str = __package__ or ""