Add out columns name to other part of the API

Author: znicholls

src/pandas_openscm/db/loading.py

@@ -34,9 +34,9 @@ def load_data(  # noqa: PLR0913
     db_index: pd.DataFrame,
     db_file_map: pd.Series[Path],  # type: ignore # pandas type hints confused about what they support
     db_dir: Path,
-    out_columns_name: str | None,
     selector: pd.Index[Any] | pd.MultiIndex | pix.selectors.Selector | None = None,
     out_columns_type: type | None = None,
+    out_columns_name: str | None = None,
     parallel_op_config: ParallelOpConfig | None = None,
     progress: bool = False,
     max_workers: int | None = None,
@@ -69,6 +69,8 @@ def load_data(  # noqa: PLR0913
     out_columns_name
         The name for the columns in the output.
 
+        If not supplied, we don't set the output columns' name.
+
         This can also be set with
         [pd.DataFrame.rename_axis][pandas.DataFrame.rename_axis]
         but we provide it here for convenience

src/pandas_openscm/db/openscm_db.py

@@ -409,6 +409,8 @@ def load(  # noqa: PLR0913
         out_columns_name
             The name for the columns in the output.
 
+            If not supplied, we don't set the output columns' name.
+
             This can also be set with
             [pd.DataFrame.rename_axis][pandas.DataFrame.rename_axis]
             but we provide it here for convenience

src/pandas_openscm/db/reader.py

@@ -117,6 +117,8 @@ def load(  # noqa: PLR0913
         out_columns_name
             The name for the columns in the output.
 
+            If not supplied, we don't set the output columns' name.
+
             This can also be set with
             [pd.DataFrame.rename_axis][pandas.DataFrame.rename_axis]
             but we provide it here for convenience

src/pandas_openscm/io.py

@@ -14,6 +14,7 @@ def load_timeseries_csv(
     lower_column_names: bool = True,
     index_columns: list[str] | None = None,
     out_column_type: type | None = None,
+    out_columns_name: str | None = None,
 ) -> pd.DataFrame:
     """
     Load a CSV holding timeseries
@@ -47,6 +48,16 @@ def load_timeseries_csv(
 
         If not supplied, the raw type returned by pandas is returned.
 
+    out_columns_name
+        The name for the columns in the output.
+
+        If not supplied, the raw name returned by pandas is returned.
+
+        This can also be set with
+        [pd.DataFrame.rename_axis][pandas.DataFrame.rename_axis]
+        but we provide it here for convenience
+        (and in case you couldn't find this trick for ages, like us).
+
     Returns
     -------
     :
@@ -65,4 +76,7 @@ def load_timeseries_csv(
     if out_column_type is not None:
         out.columns = out.columns.astype(out_column_type)
 
+    if out_columns_name is not None:
+        out = out.rename_axis(out_columns_name, axis="columns")
+
     return out