iii-sdk 0.11.6.dev2__tar.gz → 0.11.6.dev4__tar.gz

{iii_sdk-0.11.6.dev2 → iii_sdk-0.11.6.dev4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: iii-sdk
-Version: 0.11.6.dev2
+Version: 0.11.6.dev4
 Summary: III SDK for Python
 Project-URL: Homepage, https://github.com/iii-hq/iii
 Project-URL: Repository, https://github.com/iii-hq/iii

{iii_sdk-0.11.6.dev2 → iii_sdk-0.11.6.dev4}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "iii-sdk"
-version = "0.11.6.dev2"
+version = "0.11.6.dev4"
 description = "III SDK for Python"
 authors = [{ name = "III" }]
 license = { text = "Apache-2.0" }

{iii_sdk-0.11.6.dev2 → iii_sdk-0.11.6.dev4}/src/iii/iii.py

@@ -77,6 +77,42 @@ def _resolve_format(fmt: Any) -> Any | None:
     return fmt
 
 
+def _detect_project_name(cwd: str | None = None) -> str | None:
+    """Return a project identifier for telemetry, derived from the current working directory.
+
+    Reads ``[project] name`` from ``pyproject.toml`` if present at ``cwd``;
+    otherwise falls back to the basename of ``cwd``. Returns ``None`` only
+    when both signals are unavailable (e.g. cwd is the filesystem root, or
+    the Python runtime has no TOML parser and no readable cwd basename).
+
+    No directory walking — only inspects ``cwd`` itself, so the SDK never
+    reads files outside the user's explicit working directory.
+    """
+    try:
+        cwd = cwd or os.getcwd()
+        manifest = os.path.join(cwd, "pyproject.toml")
+        if os.path.isfile(manifest):
+            import importlib
+
+            try:
+                tomllib = importlib.import_module("tomllib")  # Python 3.11+
+            except ImportError:
+                tomllib = None
+            if tomllib is not None:
+                with open(manifest, "rb") as fh:
+                    data = tomllib.load(fh)
+                name = data.get("project", {}).get("name")
+                if isinstance(name, str) and name.strip():
+                    return name.strip()
+    except Exception:
+        pass
+
+    if not cwd:
+        return None
+    base = os.path.basename(cwd).strip()
+    return base or None
+
+
 class _TraceContextError(Exception):
     """Wraps a handler exception with the response traceparent from the active span."""
 
@@ -1163,7 +1199,10 @@ class III:
 
         telemetry: dict[str, Any] = {
             "language": language,
-            "project_name": telemetry_opts.project_name if telemetry_opts else None,
+            "project_name": (
+                (telemetry_opts.project_name if telemetry_opts else None)
+                or _detect_project_name()
+            ),
             "framework": (telemetry_opts.framework if telemetry_opts else None) or "iii-py",
             "amplitude_api_key": (
                 telemetry_opts.amplitude_api_key if telemetry_opts else None

iii_sdk-0.11.6.dev4/tests/test_worker_metadata.py

@@ -0,0 +1,113 @@
+from __future__ import annotations
+
+import json
+import os
+import sys
+from pathlib import Path
+
+import pytest
+
+from iii import InitOptions
+from iii.iii import III, _detect_project_name
+from iii.iii_constants import TelemetryOptions
+
+# pyproject.toml parsing relies on stdlib tomllib (Python 3.11+).
+# On 3.10 the SDK intentionally falls back to the cwd basename, so
+# tests that assert the parsed name are skipped on that runtime.
+requires_tomllib = pytest.mark.skipif(
+    sys.version_info < (3, 11),
+    reason="pyproject.toml parsing requires stdlib tomllib (Python 3.11+)",
+)
+
+
+def _call_metadata_method(options: InitOptions | None = None) -> dict[str, object]:
+    stub = III.__new__(III)
+    stub._options = options or InitOptions()
+    return stub._get_worker_metadata()
+
+
+def test_get_worker_metadata_isolation_is_none_when_env_unset(
+    monkeypatch: pytest.MonkeyPatch,
+) -> None:
+    monkeypatch.delenv("III_ISOLATION", raising=False)
+
+    metadata = _call_metadata_method()
+
+    assert "isolation" in metadata
+    assert metadata["isolation"] is None
+
+
+def test_get_worker_metadata_forwards_iii_isolation_env_var(
+    monkeypatch: pytest.MonkeyPatch,
+) -> None:
+    monkeypatch.setenv("III_ISOLATION", "docker")
+
+    metadata = _call_metadata_method()
+
+    assert metadata["isolation"] == "docker"
+
+
+@requires_tomllib
+def test_detect_project_name_reads_pyproject_name(tmp_path: Path) -> None:
+    (tmp_path / "pyproject.toml").write_text('[project]\nname = "my-pkg"\n')
+
+    assert _detect_project_name(str(tmp_path)) == "my-pkg"
+
+
+def test_detect_project_name_falls_back_to_cwd_basename_when_no_manifest(
+    tmp_path: Path,
+) -> None:
+    assert _detect_project_name(str(tmp_path)) == tmp_path.name
+
+
+def test_detect_project_name_falls_back_to_cwd_basename_when_name_missing(
+    tmp_path: Path,
+) -> None:
+    (tmp_path / "pyproject.toml").write_text('[project]\nversion = "1.0.0"\n')
+
+    assert _detect_project_name(str(tmp_path)) == tmp_path.name
+
+
+def test_detect_project_name_falls_back_to_cwd_basename_when_pyproject_malformed(
+    tmp_path: Path,
+) -> None:
+    (tmp_path / "pyproject.toml").write_text("not valid toml [[[")
+
+    assert _detect_project_name(str(tmp_path)) == tmp_path.name
+
+
+@requires_tomllib
+def test_get_worker_metadata_auto_detects_project_name_from_pyproject(
+    tmp_path: Path,
+    monkeypatch: pytest.MonkeyPatch,
+) -> None:
+    (tmp_path / "pyproject.toml").write_text('[project]\nname = "auto-detected-pkg"\n')
+    monkeypatch.chdir(tmp_path)
+
+    metadata = _call_metadata_method()
+
+    assert metadata["telemetry"]["project_name"] == "auto-detected-pkg"  # type: ignore[index]
+
+
+def test_get_worker_metadata_user_provided_project_name_wins(
+    tmp_path: Path,
+    monkeypatch: pytest.MonkeyPatch,
+) -> None:
+    (tmp_path / "pyproject.toml").write_text('[project]\nname = "auto-detected-pkg"\n')
+    monkeypatch.chdir(tmp_path)
+    options = InitOptions(telemetry=TelemetryOptions(project_name="explicit-override"))
+
+    metadata = _call_metadata_method(options)
+
+    assert metadata["telemetry"]["project_name"] == "explicit-override"  # type: ignore[index]
+
+
+def test_get_worker_metadata_falls_back_to_cwd_basename_without_pyproject(
+    tmp_path: Path,
+    monkeypatch: pytest.MonkeyPatch,
+) -> None:
+    monkeypatch.chdir(tmp_path)
+
+    metadata = _call_metadata_method()
+
+    assert metadata["telemetry"]["project_name"] == tmp_path.name  # type: ignore[index]

iii_sdk-0.11.6.dev2/tests/test_worker_metadata.py

@@ -1,33 +0,0 @@
-from __future__ import annotations
-
-import pytest
-
-from iii import InitOptions
-from iii.iii import III
-
-
-def _call_metadata_method() -> dict[str, object]:
-    stub = III.__new__(III)
-    stub._options = InitOptions()
-    return stub._get_worker_metadata()
-
-
-def test_get_worker_metadata_isolation_is_none_when_env_unset(
-    monkeypatch: pytest.MonkeyPatch,
-) -> None:
-    monkeypatch.delenv("III_ISOLATION", raising=False)
-
-    metadata = _call_metadata_method()
-
-    assert "isolation" in metadata
-    assert metadata["isolation"] is None
-
-
-def test_get_worker_metadata_forwards_iii_isolation_env_var(
-    monkeypatch: pytest.MonkeyPatch,
-) -> None:
-    monkeypatch.setenv("III_ISOLATION", "docker")
-
-    metadata = _call_metadata_method()
-
-    assert metadata["isolation"] == "docker"