laylight 0.2.2__tar.gz → 0.3.0__tar.gz

{laylight-0.2.2 → laylight-0.3.0}/.gitignore

@@ -31,3 +31,6 @@ packages/laylight-docs/out/
 packages/laylight-docs/lib/lyl-samples.generated.ts
 packages/laylight-docs/lib/benchmarks.generated.ts
 packages/laylight-docs/lib/photonics-examples.generated.ts
+
+# Local Wrangler / Miniflare state (packages/telemetry)
+.wrangler/

{laylight-0.2.2 → laylight-0.3.0}/PKG-INFO

@@ -1,10 +1,10 @@
 Metadata-Version: 2.5
 Name: laylight
-Version: 0.2.2
+Version: 0.3.0
 Summary: Photonic layout in Python, compiled to GDSII by the Laylight compiler
 Keywords: gds,layout,photonics
 Requires-Python: >=3.10
-Requires-Dist: laylight-cli==0.2.2
+Requires-Dist: laylight-cli==0.3.0
 Provides-Extra: klayout
 Requires-Dist: klayout>=0.30.8; extra == 'klayout'
 Description-Content-Type: text/markdown
@@ -35,7 +35,7 @@ Photonic layout work often mixes device geometry, parameter sweeps, custom scrip
 pip install laylight
 ```
 
-This installs the `laylight` command line too (the `laylight-cli` package). PNG previews and KLayout PCells need KLayout:
+This installs the `laylight` command line too (the `laylight-cli` package), which sends anonymous [usage statistics](https://laylight.photonstack.io/telemetry/) unless `LAYLIGHT_TELEMETRY=0` is set. PNG previews and KLayout PCells need KLayout:
 
 ```bash
 pip install "laylight[klayout]"

{laylight-0.2.2 → laylight-0.3.0}/README.md

@@ -24,7 +24,7 @@ Photonic layout work often mixes device geometry, parameter sweeps, custom scrip
 pip install laylight
 ```
 
-This installs the `laylight` command line too (the `laylight-cli` package). PNG previews and KLayout PCells need KLayout:
+This installs the `laylight` command line too (the `laylight-cli` package), which sends anonymous [usage statistics](https://laylight.photonstack.io/telemetry/) unless `LAYLIGHT_TELEMETRY=0` is set. PNG previews and KLayout PCells need KLayout:
 
 ```bash
 pip install "laylight[klayout]"

{laylight-0.2.2 → laylight-0.3.0}/laylight/backend.py

@@ -4,6 +4,11 @@ package) turns Laylight IR into GDSII, and reads GDSII back as IR.
 The command is found through the `LAYLIGHT_CLI` environment variable, then
 where the installed `laylight-cli` package put it, then next to the running
 Python, then on `PATH`.
+
+The command line sends anonymous usage statistics
+(https://laylight.photonstack.io/telemetry/); runs from this library are
+marked `LAYLIGHT_CALLER=python/<version>`, and its one-time notice about them
+is passed on to stderr. `LAYLIGHT_TELEMETRY=0` turns them off.
 """
 
 from __future__ import annotations
@@ -96,9 +101,15 @@ def run(args: Sequence[str], *, cli: str | None = None) -> subprocess.CompletedP
         raise CompilerError(
             f"laylight {found} at `{command}` cannot compile IR; laylight-cli {needed} or later is needed"
         )
-    result = subprocess.run([command, *args], capture_output=True, text=True)
+    result = subprocess.run([command, *args], capture_output=True, text=True, env=_environment())
+    # The notice about usage statistics is meant for the user, who does not
+    # see the command's stderr otherwise.
+    notice = [line for line in result.stderr.splitlines() if line.startswith("notice: ")]
+    if notice:
+        print("\n".join(notice), file=sys.stderr)
     if result.returncode != 0:
-        message = result.stderr.strip() or result.stdout.strip()
+        errors = "\n".join(line for line in result.stderr.splitlines() if not line.startswith("notice: "))
+        message = errors.strip() or result.stdout.strip()
         raise CompilerError(f"laylight {' '.join(args[:1])} failed:\n{message}")
     for line in result.stderr.splitlines():
         if line.startswith("warning: "):
@@ -106,6 +117,22 @@ def run(args: Sequence[str], *, cli: str | None = None) -> subprocess.CompletedP
     return result
 
 
+def _environment() -> dict[str, str]:
+    """The environment of a run: this one, with the caller named for the
+    command line's usage statistics unless a tool around us already did."""
+    env = dict(os.environ)
+    env.setdefault("LAYLIGHT_CALLER", f"python/{_library_version()}")
+    return env
+
+
+@functools.lru_cache(maxsize=None)
+def _library_version() -> str:
+    try:
+        return metadata.version("laylight")
+    except metadata.PackageNotFoundError:
+        return "0.0.0"
+
+
 def build(
     ir_text: str,
     output: "str | os.PathLike[str]",

{laylight-0.2.2 → laylight-0.3.0}/pyproject.toml

@@ -2,14 +2,14 @@
 name = "laylight"
 # Released together with the `laylight` command line, at its version
 # (crates/laylight-cli/Cargo.toml); scripts/check_version.py checks both.
-version = "0.2.2"
+version = "0.3.0"
 description = "Photonic layout in Python, compiled to GDSII by the Laylight compiler"
 readme = "README.md"
 requires-python = ">=3.10"
 dependencies = [
     # The `laylight` command line (Rust), which compiles the IR this library
     # builds: the release of the same version.
-    "laylight-cli==0.2.2",
+    "laylight-cli==0.3.0",
 ]
 keywords = ["layout", "gds", "photonics"]