Use format=None to return raw Python data structure (#467)

Author: hugovk

src/pypistats/__init__.py

@@ -85,7 +85,7 @@ def _clear_cache() -> None:
 def pypi_stats_api(
     endpoint: str,
     params: str | None = None,
-    format: str = "pretty",
+    format: str | None = "pretty",
     start_date: str | None = None,
     end_date: str | None = None,
     sort: bool = True,
@@ -173,6 +173,9 @@ def pypi_stats_api(
     data = _percent(data)
     data = _grand_total(data)
 
+    if format is None:
+        return data
+
     if color != "no" and format in ("markdown", "pretty", "rst", "tsv"):
         data = _colourify(data)
 

tests/test_pypistats.py

@@ -748,6 +748,25 @@ def test_format_pandas(self) -> None:
         assert isinstance(output, pandas.DataFrame)
         assert str(output).strip() == expected_output.strip()
 
+    @respx.mock
+    def test_format_none(self) -> None:
+        # Arrange
+        package = "pip"
+        mocked_url = "https://pypistats.org/api/packages/pip/overall"
+        mocked_response = SAMPLE_RESPONSE_OVERALL
+        expected_output = {
+            "category": "with_mirrors",
+            "downloads": 3587357,
+            "percent": "100.00%",
+        }
+
+        # Act
+        respx.get(mocked_url).respond(content=mocked_response)
+        output = pypistats.overall(package, format=None)
+
+        # Assert
+        assert output[0] == expected_output
+
     @respx.mock
     def test_package_not_exist(self) -> None:
         # Arrange