MNT: add astropy.system_info report helper function

.github/ISSUE_TEMPLATE/bug_report.yaml

@@ -40,25 +40,29 @@ body:
   - type: textarea
     attributes:
       label: Versions
-      description: Version of relevant packages.
+      description: Please run the following script and paste the output
       value: |
         ```python
-        import platform; print(platform.platform())
-        import sys; print("Python", sys.version)
-        import astropy; print("astropy", astropy.__version__)
-        import numpy; print("Numpy", numpy.__version__)
-        import erfa; print("pyerfa", erfa.__version__)
+        import astropy
         try:
-            import scipy
-            print("Scipy", scipy.__version__)
-        except ImportError:
-            print("Scipy not installed")
-        try:
-            import matplotlib
-            print("Matplotlib", matplotlib.__version__)
-        except ImportError:
-            print("Matplotlib not installed")
+            astropy.system_info()
+        except AttributeError:
+            import platform; print(platform.platform())
+            import sys; print("Python", sys.version)
+            import astropy; print("astropy", astropy.__version__)
+            import numpy; print("Numpy", numpy.__version__)
+            import erfa; print("pyerfa", erfa.__version__)
+            try:
+                import scipy
+                print("Scipy", scipy.__version__)
+            except ImportError:
+                print("Scipy not installed")
+            try:
+                import matplotlib
+                print("Matplotlib", matplotlib.__version__)
+            except ImportError:
+                print("Matplotlib not installed")
         ```
         ```
-        # Copy the result here
+        # Paste the result here
         ```

astropy/__init__.py

@@ -9,6 +9,8 @@
 import sys
 from pathlib import Path
 
+from astropy.utils.system_info import system_info
+
 from .version import version as __version__
 
 # The location of the online documentation for astropy
@@ -208,6 +210,7 @@ def online_help(query):
     "conf",
     "physical_constants",
     "astronomical_constants",
+    "system_info",
 ]
 
 

astropy/utils/system_info.py

@@ -0,0 +1,86 @@
+r"""
+A helper script to automate system info in bug reports.
+
+This can be run as::
+
+    python -c "import astropy; astropy.system_info()"
+
+(note that the interpreter might be called python3 instead of python, depending
+on your system's details)
+
+This script should not require anything else than the standard library and is
+subject to change without notice.
+"""
+
+__all__ = ["system_info"]
+
+import platform
+from importlib.metadata import version
+from importlib.util import find_spec
+
+
+def _header(name: str) -> list[str]:
+    return [name, "-" * len(name)]
+
+
+def _report_platform() -> list[str]:
+    return [
+        f"{platform.platform() = }",
+        f"{platform.version() = }",
+        f"{platform.python_version() = }",
+    ]
+
+
+def _report_packages() -> list[str]:
+    pkgs = [
+        "astropy",
+        "numpy",
+        "scipy",
+        "matplotlib",
+        "pandas",
+    ]
+    lines = [f"{p:<20} {'--' if find_spec(p) is None else version(p)}" for p in pkgs]
+
+    # pyerfa may not export its package metadata (as of 2.0.1.4)
+    try:
+        import erfa
+    except ImportError:
+        v = "--"
+    else:
+        v = erfa.__version__
+    p = "pyerfa"
+    lines.append(f"{p:<20} {v}")
+    return lines
+
+
+def system_info() -> None:
+    """Print relevant system information for astropy bug reports.
+
+    Examples
+    --------
+    >>> import astropy
+    >>> astropy.system_info()  # doctest: +ELLIPSIS
+    platform
+    --------
+    platform.platform() = ...
+    platform.version() = ...
+    platform.python_version() = ...
+    <BLANKLINE>
+    packages
+    --------
+    astropy              ...
+    numpy                ...
+    scipy                ...
+    matplotlib           ...
+    pandas               ...
+    pyerfa               ...
+
+    """
+    report_lines = (
+        *_header("platform"),
+        *_report_platform(),
+        "",
+        *_header("packages"),
+        *_report_packages(),
+    )
+    print("\n".join(report_lines))

docs/changes/utils/16335.feature.rst

@@ -0,0 +1,2 @@
+Added the ``astropy.system_info`` function to help document runtime systems in
+bug reports.

docs/utils/ref_api.rst

@@ -48,6 +48,8 @@ Utility Functions/Classes
 .. automodapi:: astropy.utils.shapes
     :no-inheritance-diagram:
 
+.. automodapi:: astropy.utils.system_info
+    :no-inheritance-diagram:
 
 File Downloads
 ==============