Add lsdb.show_versions() (#1229)

* Add lsdb.show_versions()

* Ignore line un-reachable under testing conditions.

* Coverage pragma

Author: delucchi-cmu

.github/ISSUE_TEMPLATE/1-bug_report.md

@@ -11,6 +11,12 @@ assignees: ''
 
 **Environment Information**
 
+<details>
+<summary>INSTALLED VERSIONS</summary>
+
+Paste the output from `lsdb.show_versions()`
+
+</details>
 
 <details>
 <summary>Traceback</summary>
@@ -23,6 +29,6 @@ FILL IN YOUR STACK TRACE HERE
 Please check the following:
 
 - [ ] I have described the situation in which the bug arose, including what code was executed, and any applicable data others will need to reproduce the problem.
-- [ ] I have included information about my environment, including the version of this package (e.g. `lsdb.__version__`)
+- [ ] I have included information about my environment, including the version of this package (e.g. `lsdb.show_versions()`)
 - [ ] I have included available evidence of the unexpected behavior (including error messages, screenshots, and/or plots) as well as a description of what I expected instead.
 - [ ] If I have a solution in mind, I have provided an explanation and/or pseudocode and/or task list.

src/lsdb/__init__.py

@@ -4,6 +4,7 @@
 from .catalog import Catalog, MarginCatalog
 from .core.crossmatch.crossmatch import crossmatch
 from .core.search.region_search import BoxSearch, ConeSearch, PixelSearch, PolygonSearch
+from .io.show_versions import show_versions
 from .loaders.dataframe.from_astropy import from_astropy
 from .loaders.dataframe.from_dataframe import from_dataframe
 from .loaders.hats.read_hats import open_catalog, read_hats

src/lsdb/io/show_versions.py

@@ -0,0 +1,56 @@
+import importlib
+import os
+import platform
+import struct
+import sys
+
+
+def _get_sys_info() -> dict[str, str]:
+    uname_result = platform.uname()
+    return {
+        "python": platform.python_version(),
+        "python-bits": str(struct.calcsize("P") * 8),
+        "OS": uname_result.system,
+        "OS-release": uname_result.release,
+        "Version": uname_result.version,
+        "machine": uname_result.machine,
+        "processor": uname_result.processor,
+        "byteorder": sys.byteorder,
+        "LC_ALL": os.environ.get("LC_ALL") or "",
+        "LANG": os.environ.get("LANG") or "",
+    }
+
+
+def _get_dependency_info() -> dict[str, str]:
+    deps = [
+        "lsdb",
+        "hats",
+        "nested-pandas",
+        "pandas",
+        "numpy",
+        "dask",
+        "pyarrow",
+        "fsspec",
+    ]
+
+    result: dict[str, str] = {}
+    for modname in deps:
+        try:
+            result[modname] = importlib.metadata.version(modname)
+        except Exception:  # pylint: disable=broad-exception-caught # pragma: no cover
+            result[modname] = "N/A"
+    return result
+
+
+def show_versions():
+    """Print runtime versions and system info, useful for bug reports."""
+    sys_info = _get_sys_info()
+    deps = _get_dependency_info()
+
+    maxlen = max(len(x) for x in deps) + 1
+    print("\n--------      SYSTEM INFO      --------")
+    for k, v in sys_info.items():
+        print(f"{k:<{maxlen}}: {v}")
+    print("--------   INSTALLED VERSIONS   --------")
+    for k, v in deps.items():
+        print(f"{k:<{maxlen}}: {v}")

tests/lsdb/io/test_show_versions.py

@@ -0,0 +1,12 @@
+import lsdb
+
+
+def test_show_versions(capsys):
+    lsdb.show_versions()
+    captured = capsys.readouterr().out
+    assert captured.startswith("\n--------      SYSTEM INFO      --------")
+    assert "lsdb" in captured
+    assert "hats" in captured
+    assert "nested-pandas" in captured
+    assert "pyarrow" in captured
+    assert "fsspec" in captured