feat: add print_debug_info function

.github/ISSUE_TEMPLATE/bug_report.yml

@@ -6,36 +6,21 @@ body:
     attributes:
       value: |
         Please provide the following information.
-  - type: input
-    id: Zarr-version
-    attributes:
-      label: Zarr version
-      description: Value of ``zarr.__version__``
-      placeholder: v2.10.2, v2.11.3, v2.12.0, etc.
-    validations:
-      required: true
-  - type: input
-    id: Numcodecs-version
-    attributes:
-      label: Numcodecs version
-      description: Value of ``numcodecs.__version__``
-      placeholder: v0.8.1, v0.9.0, v0.10.0, etc.
-    validations:
-      required: true
-  - type: input
-    id: Python-version
-    attributes:
-      label: Python Version
-      description: Version of Python interpreter
-      placeholder: 3.10, 3.11, 3.12 etc.
-    validations:
-      required: true
-  - type: input
-    id: OS
-    attributes:
-      label: Operating System
-      description: Operating System
-      placeholder: (Linux/Windows/Mac)
+  - type: textarea
+    id: version-info
+    attributes:
+      label: Versions
+      description: Output of ``zarr.print_debug_info()``. This will automatically be rendered as code, no need for backticks.
+      render: shell
+      placeholder: |
+        platform: macOS-15.3-arm64-arm-64bit-Mach-O
+        python: 3.13.2
+
+        zarr: 3.0.5
+
+        numcodecs: 0.15.1
+        numpy: 2.2.3
+        fsspec: 2025.3.0
     validations:
       required: true
   - type: input

changes/2913.feature.rst

@@ -0,0 +1 @@
+Added a `print_debug_info` function for bug reports.

src/zarr/__init__.py

@@ -36,6 +36,25 @@
 # in case setuptools scm screw up and find version to be 0.0.0
 assert not __version__.startswith("0.0.0")
 
+
+def print_debug_info() -> None:
+    """
+    Print version info for use in bug reports.
+    """
+    import platform
+    from importlib import import_module
+
+    print(f"platform: {platform.platform()}")
+    print(f"python: {platform.python_version()}\n")
+
+    print(f"zarr: {__version__}\n")
+    for package in ["numcodecs", "numpy", "fsspec", "s3fs", "botocore", "gcsfs"]:
+        try:
+            print(f"{package}: {import_module(package).__version__}")
+        except ModuleNotFoundError:
+            continue
+
+
 __all__ = [
     "Array",
     "AsyncArray",
@@ -65,6 +84,7 @@
     "open_consolidated",
     "open_group",
     "open_like",
+    "print_debug_info",
     "save",
     "save_array",
     "save_group",

tests/test_zarr.py

@@ -9,3 +9,12 @@ def test_exports() -> None:
 
     for export in __all__:
         getattr(zarr, export)
+
+
+def test_print_debug_info() -> None:
+    """
+    Ensure that print_debug_info does not raise an error
+    """
+    from zarr import print_debug_info
+
+    print_debug_info()