BUG: Add more tests, make console JSON == JSON file output

Author: alexprincel

doc/source/whatsnew/v1.3.0.rst

@@ -457,6 +457,7 @@ Other
 - Bug in :class:`Styler` where ``subset`` arg in methods raised an error for some valid multiindex slices (:issue:`33562`)
 - :class:`Styler` rendered HTML output minor alterations to support w3 good code standard (:issue:`39626`)
 - Bug in :meth:`DataFrame.equals`, :meth:`Series.equals`, :meth:`Index.equals` with object-dtype containing ``np.datetime64("NaT")`` or ``np.timedelta64("NaT")`` (:issue:`39650`)
+- Bug in :func: `pandas.util.show_versions` where console JSON output was not proper JSON (:issue:`39701`)
 
 
 .. ---------------------------------------------------------------------------

pandas/tests/util/test_show_versions.py

@@ -5,11 +5,7 @@
 import pytest
 
 import pandas as pd
-
-
-@pytest.fixture
-def as_json(request):
-    return request.param
+from pandas.util._print_versions import _get_sys_info, _get_dependency_info
 
 
 @pytest.mark.filterwarnings(
@@ -33,7 +29,7 @@ def as_json(request):
     "ignore:Distutils:UserWarning"
 )
 @pytest.mark.filterwarnings("ignore:Setuptools is replacing distutils:UserWarning")
-@pytest.mark.parametrize("as_json", [True, False, "test_output.json"], indirect=True)
+@pytest.mark.parametrize("as_json", [True, False, "test_output.json"])
 def test_show_versions(capsys, as_json, tmpdir):
     # gh-32041
     if isinstance(as_json, str):
@@ -42,6 +38,7 @@ def test_show_versions(capsys, as_json, tmpdir):
     pd.show_versions(as_json=as_json)
     captured = capsys.readouterr()
     result = captured.out
+    string_check = result
 
     # check valid json is printed to the console if as_json is True
     if as_json is True:
@@ -74,3 +71,22 @@ def test_show_versions(capsys, as_json, tmpdir):
 
             # check if file output is valid JSON
             json.loads(str_contents)
+
+            # prepare string for checking for specific keys
+            string_check = str_contents
+
+    # Basic check that each version element is found in output
+    version_elements = {**_get_sys_info, **_get_dependency_info}
+    assert all([v in string_check and k in string_check for k, v in version_elements])
+
+
+def test_json_output_match(capsys, tmpdir):
+    pd.show_versions(as_json=True)
+    result_console = capsys.readouterr().out
+
+    out_path = os.path.join(tmpdir, "test_json.json")
+    pd.show_versions(as_json=out_path)
+    with open(out_path) as out_fd:
+        result_file = "".join(out_fd.readlines())
+
+    assert result_console == result_file

pandas/util/_print_versions.py

@@ -107,7 +107,7 @@ def show_versions(as_json: Union[str, bool] = False) -> None:
         j = {"system": sys_info, "dependencies": deps}
 
         if as_json is True:
-            print(json.dumps(j))
+            sys.stdout.writelines(json.dumps(j, indent=2))
         else:
             assert isinstance(as_json, str)  # needed for mypy
             with codecs.open(as_json, "wb", encoding="utf8") as f: