spotforecast2 0.2.1__py3-none-any.whl → 0.2.2__py3-none-any.whl

spotforecast2/data/fetch_data.py

@@ -44,7 +44,8 @@ def get_data_home(data_home: Optional[Union[str, Path]] = None) -> Path:
 
 
 def fetch_data(
-    filename: Union[str, pd.DataFrame] = "data_in.csv",
+    filename: Optional[str] = None,
+    dataframe: Optional[pd.DataFrame] = None,
     columns: Optional[list] = None,
     index_col: int = 0,
     parse_dates: bool = True,
@@ -54,13 +55,15 @@ def fetch_data(
     """Fetches the integrated raw dataset from a CSV file or processes a DataFrame.
 
     Args:
-        filename (str or pd.DataFrame):
-            Filename of the CSV file containing the dataset (located in data home directory)
-            or a pandas DataFrame. If DataFrame is provided, it will be processed with
-            proper timezone handling. Default: "data_in.csv".
+        filename (str, optional):
+            Filename of the CSV file containing the dataset. Must be located in the 
+            data home directory. If both filename and dataframe are None, defaults to "data_in.csv".
+        dataframe (pd.DataFrame, optional):
+            A pandas DataFrame to process. If provided, it will be processed with
+            proper timezone handling. Mutually exclusive with filename.
         columns (list, optional):
             List of columns to be included in the dataset. If None, all columns are included.
-            If an empty list is provided, a ValueError is blocked.
+            If an empty list is provided, a ValueError is raised.
         index_col (int):
             Column index to be used as the index (only used when loading from CSV).
         parse_dates (bool):
@@ -75,37 +78,44 @@ def fetch_data(
         pd.DataFrame: The integrated raw dataset with UTC timezone.
 
     Raises:
-        ValueError: If columns is an empty list.
+        ValueError: If columns is an empty list or if both filename and dataframe are provided.
         FileNotFoundError: If CSV file does not exist.
 
     Examples:
-        Load from CSV:
+        Load from CSV (default):
         >>> from spotforecast2.data.fetch_data import fetch_data
         >>> data = fetch_data(columns=["col1", "col2"])
         >>> data.head()
                         Header1  Header2  Header3
         
+        Load from specific CSV:
+        >>> data = fetch_data(filename="custom_data.csv")
+        
         Process a DataFrame:
         >>> import pandas as pd
         >>> df = pd.DataFrame({"value": [1, 2, 3]}, 
         ...                   index=pd.date_range("2024-01-01", periods=3, freq="h"))
-        >>> data = fetch_data(filename=df, timezone="Europe/Berlin")
+        >>> data = fetch_data(dataframe=df, timezone="Europe/Berlin")
         >>> data.index.tz
         <UTC>
     """
     if columns is not None and len(columns) == 0:
         raise ValueError("columns must be specified and cannot be empty.")
+    
+    if filename is not None and dataframe is not None:
+        raise ValueError("Cannot specify both filename and dataframe. Please provide only one.")
 
-    # Check if filename is actually a DataFrame
-    if isinstance(filename, pd.DataFrame):
-        # Use Data.from_dataframe for proper timezone handling
+    # Process DataFrame if provided
+    if dataframe is not None:
         dataset = Data.from_dataframe(
-            df=filename,
+            df=dataframe,
             timezone=timezone,
             columns=columns,
         )
     else:
         # Load from CSV file
+        if filename is None:
+            filename = "data_in.csv"
         csv_path = get_data_home() / filename
         if not Path(csv_path).is_file():
             raise FileNotFoundError(f"The file {csv_path} does not exist.")

spotforecast2/processing/n2n_predict.py

@@ -319,7 +319,7 @@ def n2n_predict(
     if data is not None:
         if verbose:
             print("Using provided dataframe...")
-        data = fetch_data(filename=data, columns=TARGET)
+        data = fetch_data(dataframe=data, columns=TARGET)
     else:
         if verbose:
             print("Fetching data from CSV...")

spotforecast2/processing/n2n_predict_with_covariates.py

@@ -876,7 +876,7 @@ def n2n_predict_with_covariates(
     else:
         if verbose:
             print("  Using provided dataframe...")
-        data = fetch_data(filename=data, timezone=timezone)
+        data = fetch_data(dataframe=data, timezone=timezone)
     
     target_columns = data.columns.tolist()
 

{spotforecast2-0.2.1.dist-info → spotforecast2-0.2.2.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: spotforecast2
-Version: 0.2.1
+Version: 0.2.2
 Summary: Forecasting with spot
 Author: bartzbeielstein
 Author-email: bartzbeielstein <32470350+bartzbeielstein@users.noreply.github.com>

{spotforecast2-0.2.1.dist-info → spotforecast2-0.2.2.dist-info}/RECORD

@@ -1,7 +1,7 @@
 spotforecast2/__init__.py,sha256=X9sBx15iz8yqr9iDJcrGJM5nhvnpaczXto4XV_GtfhE,59
 spotforecast2/data/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 spotforecast2/data/data.py,sha256=HEgr-FULaqHvuMeKTviOgYyo3GbxpGRTo3ZnmIU9w2Y,4422
-spotforecast2/data/fetch_data.py,sha256=whefI8g3y7rQzzhOp3uB6L3VQdvu4p2qc6aWvkKSgD0,8010
+spotforecast2/data/fetch_data.py,sha256=N99W-NNTC2hbXmx1FofITsvXJfHj9py4r5Kllf5950Y,8464
 spotforecast2/exceptions.py,sha256=6gOji-3cP-YAisPoxXCcrEEbjTnfPN1YqEhGYhmyZ8Y,20499
 spotforecast2/forecaster/__init__.py,sha256=BbCOS2ouKcPC9VzcdprllVyqlZIyAWXCOvUAiInxDi4,140
 spotforecast2/forecaster/base.py,sha256=rXhcjY4AMpyQhkpbtLIA8OOrGEb8fU57SQiyeR9c9DQ,16748
@@ -31,8 +31,8 @@ spotforecast2/preprocessing/imputation.py,sha256=lmH-HumI_QLLm9aMESe_oZq84Axn60w
 spotforecast2/preprocessing/outlier.py,sha256=jZxAR870QtYner7b4gXk6LLGJw0juLq1VU4CGklYd3c,4208
 spotforecast2/preprocessing/split.py,sha256=mzzt5ltUZdVzfWtBBTQjp8E2MyqVdWUFtz7nN11urbU,5011
 spotforecast2/processing/agg_predict.py,sha256=VKlruB0x-eJKokkHyJxR87rZ4m53si3ODbrd0ibPlow,2378
-spotforecast2/processing/n2n_predict.py,sha256=eClK0uccg_pKCnDfzWckFV6TWprTxskaY3whH_vJGs0,14911
-spotforecast2/processing/n2n_predict_with_covariates.py,sha256=xP7V_JB0xF7I5KlAqeR-U0ENwxZNSvSQvsPOLHjZWV8,40913
+spotforecast2/processing/n2n_predict.py,sha256=Sr2AFaCZxP-tbsxlEjiSdjBU-mtBiDa_f6rJLEJov64,14912
+spotforecast2/processing/n2n_predict_with_covariates.py,sha256=PyB3X1rNb18JBC72YiN12hUg5eSjUAsW4M-atczmCSQ,40914
 spotforecast2/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 spotforecast2/utils/__init__.py,sha256=NrMt_xJLe4rbTFbsbgSQYeREohEOiYG5S-97e6Jj07I,1018
 spotforecast2/utils/convert_to_utc.py,sha256=hz8mJUHK9jDLUiN5LdNX5l3KZuOKlklyycB4zFdB9Ng,1405
@@ -42,6 +42,6 @@ spotforecast2/utils/generate_holiday.py,sha256=SHaPvPMt-abis95cChHf5ObyPwCTrzJ87
 spotforecast2/utils/validation.py,sha256=x9ypQzcneDhWJA_piiY4Q3_ogoGd1LTsZ7__MFeG9Fc,21618
 spotforecast2/weather/__init__.py,sha256=1Jco88pl0deNESgNATin83Nf5i9c58pxN7G-vNiOiu0,120
 spotforecast2/weather/weather_client.py,sha256=Ec_ywug6uoa71MfXM8RNbXEvtBtBzr-SUS5xq_HKtZE,9837
-spotforecast2-0.2.1.dist-info/WHEEL,sha256=5DEXXimM34_d4Gx1AuF9ysMr1_maoEtGKjaILM3s4w4,80
-spotforecast2-0.2.1.dist-info/METADATA,sha256=CZtz7eiMtA8zOF85_sLrApPp085fYOYPsI7btv7UdtY,3481
-spotforecast2-0.2.1.dist-info/RECORD,,
+spotforecast2-0.2.2.dist-info/WHEEL,sha256=5DEXXimM34_d4Gx1AuF9ysMr1_maoEtGKjaILM3s4w4,80
+spotforecast2-0.2.2.dist-info/METADATA,sha256=f5BfMpKyfzwbTOTguKeNPgjbuEu2N0zwMrfcjG82XYo,3481
+spotforecast2-0.2.2.dist-info/RECORD,,