res2df 1.3.7__py3-none-any.whl → 1.3.8__py3-none-any.whl

res2df/vfp/_vfp.py

@@ -7,7 +7,7 @@ output both in csv format as a pandas DataFrame or in pyarrow and pyarrow.table
 import argparse
 import logging
 import sys
-from typing import Any, Dict, List, Optional, Union
+from typing import Any
 
 import numpy as np
 import pandas as pd
@@ -16,12 +16,11 @@ import pyarrow as pa
 try:
     # Needed for mypy
 
-    # pylint: disable=unused-import
     import opm.io
 
     # This import is seemingly not used, but necessary for some attributes
     # to be included in DeckItem objects.
-    from opm.io.deck import DeckKeyword  # noqa
+    from opm.io.deck import DeckKeyword  # noqa: F401
 except ImportError:
     pass
 
@@ -37,10 +36,10 @@ logger = logging.getLogger(__name__)
 
 
 def basic_data(
-    deck: Union[str, ResdataFiles, "opm.libopmcommon_python.Deck"],
+    deck: "str | ResdataFiles | opm.opmcommon_python.Deck",
     keyword: str = "VFPPROD",
-    vfpnumbers_str: Optional[str] = None,
-) -> List[Dict[str, Any]]:
+    vfpnumbers_str: str | None = None,
+) -> list[dict[str, Any]]:
     """Produce a dictionary with basic data for an Eclipe VFPPROD/VFPINJ.
     Dictionary returned contains items for liftcuve tables as simple datatypes
     Required keys in dictionary for VFPPROD and VFPINJ can be found in
@@ -75,13 +74,13 @@ def basic_data(
                     basic_data_vfps.append(basic_data_vfpprod)
             elif deck_keyword.name == "VFPINJ":
                 basic_data_vfpinj = vfpinj.basic_data(deck_keyword, vfpnumbers_str)
-                if basic_data_vfpinj is not None:
+                if len(basic_data_vfpinj) > 0:
                     basic_data_vfps.append(basic_data_vfpinj)
 
     return basic_data_vfps
 
 
-def basic_data2df(data: Dict[str, Any]) -> pd.DataFrame:
+def basic_data2df(data: dict[str, Any]) -> pd.DataFrame:
     """Convert basic_data representation of VFPPROD/VFPINF
     (see function basic_data for defintion of data) into
     pandas DataFrame representation
@@ -141,7 +140,7 @@ def basic_data2df(data: Dict[str, Any]) -> pd.DataFrame:
     raise ValueError("VFP_TYPE not found in basic data")
 
 
-def basic_data2pyarrow(data: Dict[str, Any], /) -> pa.Table:
+def basic_data2pyarrow(data: dict[str, Any], /) -> pa.Table:
     """Convert basic_data representation of VFPPROD/VFPINF
     (see function basic_data for defintion of data) into
     pyarrow.Table representation
@@ -201,7 +200,7 @@ def basic_data2pyarrow(data: Dict[str, Any], /) -> pa.Table:
     raise ValueError("VFP_TYPE not found in basic data")
 
 
-def df2basic_data(dframe: pd.DataFrame, /) -> Union[Dict[str, Any], None]:
+def df2basic_data(dframe: pd.DataFrame, /) -> dict[str, Any] | None:
     """Produce a dictionary with basic data types for a VFPPROD/VFPINJ
     liftcurve table represented as a Pandas DataFrame
 
@@ -222,7 +221,7 @@ def df2basic_data(dframe: pd.DataFrame, /) -> Union[Dict[str, Any], None]:
     return None
 
 
-def pyarrow2basic_data(pa_table: pa.Table) -> Union[Dict[str, Any], None]:
+def pyarrow2basic_data(pa_table: pa.Table) -> dict[str, Any] | None:
     """Produce a dictionary with basic data types for a VFPPROD/VFPINJ
     liftcurve table represented as a pyarrow Table
 
@@ -243,10 +242,10 @@ def pyarrow2basic_data(pa_table: pa.Table) -> Union[Dict[str, Any], None]:
 
 
 def dfs(
-    deck: Union[str, ResdataFiles, "opm.libopmcommon_python.Deck"],
+    deck: "str | ResdataFiles | opm.opmcommon_python.Deck",
     keyword: str = "VFPPROD",
-    vfpnumbers_str: Optional[str] = None,
-) -> List[pd.DataFrame]:
+    vfpnumbers_str: str | None = None,
+) -> list[pd.DataFrame]:
     """Produce a list of dataframes of vfp tables from a :term:`deck`
 
     Data for the keyword VFPPROD or VFPINJ will be returned as separate item in list
@@ -286,10 +285,10 @@ def dfs(
 
 
 def pyarrow_tables(
-    deck: Union[str, ResdataFiles, "opm.libopmcommon_python.Deck"],
+    deck: "str | ResdataFiles | opm.opmcommon_python.Deck",
     keyword: str = "VFPPROD",
-    vfpnumbers_str: Optional[str] = None,
-) -> List[pa.Table]:
+    vfpnumbers_str: str | None = None,
+) -> list[pa.Table]:
     """Produce a list of pyarrow.Table of vfp tables from a :term:`deck`
 
     Data for the keyword VFPPROD or VFPINJ will be returned as separate item in list
@@ -331,8 +330,8 @@ def pyarrow_tables(
 def df2ress(
     dframe: pd.DataFrame,
     keyword: str = "VFPPROD",
-    comments: Optional[Dict[str, str]] = None,
-) -> List[str]:
+    comments: dict[str, str] | None = None,
+) -> list[str]:
     """Produce a list of strings defining VFPPROD/VFPINJ Eclipse
     :term:`include file` contents from a dataframe
 
@@ -377,8 +376,8 @@ def df2ress(
 def df2res(
     dframe: pd.DataFrame,
     keyword: str = "VFPPROD",
-    comments: Optional[Dict[str, str]] = None,
-    filename: Optional[str] = None,
+    comments: dict[str, str] | None = None,
+    filename: str | None = None,
 ) -> str:
     """Create a string defining all VFPPROD/VFPINJ Eclipse
     :term:`include file` contents from a dataframe
@@ -412,9 +411,9 @@ def df2res(
 
 
 def df(
-    deck: Union[str, ResdataFiles, "opm.libopmcommon_python.Deck"],
+    deck: "str | ResdataFiles | opm.opmcommon_python.Deck",
     keyword: str = "VFPPROD",
-    vfpnumbers_str: Optional[str] = None,
+    vfpnumbers_str: str | None = None,
 ) -> pd.DataFrame:
     """Produce a dataframes of all vfp tables from a deck
 
@@ -487,9 +486,7 @@ def fill_reverse_parser(parser: argparse.ArgumentParser) -> argparse.ArgumentPar
 
 def vfp_main(args) -> None:
     """Entry-point for module, for command line utility."""
-    logger = getLogger_res2csv(  # pylint: disable=redefined-outer-name
-        __name__, vars(args)
-    )
+    logger = getLogger_res2csv(__name__, vars(args))
     if args.keyword and args.keyword not in SUPPORTED_KEYWORDS:
         raise ValueError(f"Keyword argument {args.keyword} not supported")
     if not args.output:
@@ -510,11 +507,11 @@ def vfp_main(args) -> None:
             table_number = int(
                 vfp_table.schema.metadata[b"TABLE_NUMBER"].decode("utf-8")
             )
-            vfp_filename = f"{outputfile}_{str(table_number)}.arrow"
+            vfp_filename = f"{outputfile}_{table_number!s}.arrow"
             write_dframe_stdout_file(
                 vfp_table, vfp_filename, index=False, caller_logger=logger
             )
-            logger.info(f"Parsed file {args.DATAFILE} for vfp.dfs_arrow")
+            logger.info("Parsed file %s for vfp.dfs_arrow", args.DATAFILE)
     else:
         dframe = df(
             resdatafiles.get_deck(), keyword=args.keyword, vfpnumbers_str=vfpnumbers
@@ -523,16 +520,14 @@ def vfp_main(args) -> None:
             write_dframe_stdout_file(
                 dframe, args.output, index=False, caller_logger=logger
             )
-            logger.info(f"Parsed file {args.DATAFILE} for vfp.df")
+            logger.info("Parsed file %s for vfp.df", args.DATAFILE)
 
 
 def vfp_reverse_main(args) -> None:
     """Entry-point for module, for command line utility for CSV to Eclipse"""
-    logger = getLogger_res2csv(  # pylint: disable=redefined-outer-name
-        __name__, vars(args)
-    )
+    logger = getLogger_res2csv(__name__, vars(args))
     vfp_df = pd.read_csv(args.csvfile)
-    logger.info("Parsed {args.csvfile}")
+    logger.info("Parsed %s", args.csvfile)
     inc_string = df2res(vfp_df, args.keyword)
     if args.output:
         write_inc_stdout_file(inc_string, args.output)

res2df/vfp/_vfpcommon.py

@@ -8,7 +8,7 @@ output both in csv format as a pandas DataFrame or in pyarrow and pyarrow.table
 
 import logging
 import numbers
-from typing import Any, List, Union
+from typing import Any
 
 import numpy as np
 import pandas as pd
@@ -16,12 +16,11 @@ import pandas as pd
 try:
     # Needed for mypy
 
-    # pylint: disable=unused-import
     import opm.io
 
     # This import is seemingly not used, but necessary for some attributes
     # to be included in DeckItem objects.
-    from opm.io.deck import DeckKeyword  # noqa
+    from opm.io.deck import DeckKeyword  # noqa: F401
 except ImportError:
     pass
 
@@ -30,7 +29,7 @@ from ..common import parse_opmio_deckrecord
 logger = logging.getLogger(__name__)
 
 
-def _string2intlist(list_def_str: str) -> List[int]:
+def _string2intlist(list_def_str: str) -> list[int]:
     """Produce a list of int from input string
 
     Args:
@@ -53,13 +52,13 @@ def _string2intlist(list_def_str: str) -> List[int]:
 
 
 def _deckrecord2list(
-    record: "opm.libopmcommon_python.DeckRecord",
+    record: "opm.opmcommon_python.DeckRecord",
     keyword: str,
     recordindex: int,
     recordname: str,
-) -> Union[Any, List[float]]:
+) -> Any | list[float]:
     """
-    Parse an opm.libopmcommon_python.DeckRecord belonging to a certain keyword
+    Parse an opm.opmcommon_python.DeckRecord belonging to a certain keyword
     and return as list of numbers
 
     Args:
@@ -71,7 +70,7 @@ def _deckrecord2list(
     """
     record = parse_opmio_deckrecord(record, keyword, "records", recordindex)
 
-    values: Union[Any, List[float]]
+    values: Any | list[float]
     # Extract interpolation ranges into lists
     if isinstance(record.get(recordname), list):
         values = record.get(recordname)
@@ -87,10 +86,10 @@ def _deckrecord2list(
 
 
 def _stack_vfptable2df(
-    index_names_list: List[str],
-    index_values_list: Union[np.ndarray, List[List[float]]],
-    flow_values_list: Union[np.ndarray, List[float]],
-    table_values_list: Union[np.ndarray, List[List[float]]],
+    index_names_list: list[str],
+    index_values_list: np.ndarray | list[list[float]],
+    flow_values_list: np.ndarray | list[float],
+    table_values_list: np.ndarray | list[list[float]],
 ) -> pd.DataFrame:
     """Return a dataframe from a list of interpolation ranges and tabulated values
 
@@ -137,16 +136,16 @@ def _stack_vfptable2df(
     df_vfptable.columns = pd.MultiIndex.from_tuples(indextuples)
 
     # Now stack
-    df_vfptable_stacked = df_vfptable.stack()
+    df_vfptable_stacked = df_vfptable.stack(future_stack=True).sort_index()
 
     # In order to propagate the gfr, thp, wct values after
     # stacking to the correct rows, we should either understand
     # how to do that properly using pandas, but for now, we try a
     # backwards fill, hopefully that is robust enough
-    df_vfptable_stacked.bfill(inplace=True)
     # Also reset the index:
-    df_vfptable_stacked.reset_index(inplace=True)
-    df_vfptable_stacked.drop("level_0", axis="columns", inplace=True)
+    df_vfptable_stacked = (
+        df_vfptable_stacked.bfill().reset_index().drop("level_0", axis="columns")
+    )
     # This column is not meaningful (it is the old index)
 
     # Delete rows that does not belong to any flow rate (this is
@@ -163,15 +162,15 @@ def _stack_vfptable2df(
     df_vfptable_stacked["RATE"] = df_vfptable_stacked["RATE"].astype(float)
 
     # Sort values in correct order
-    df_vfptable_stacked.sort_values(
-        by=index_names_list + ["RATE"], ascending=True, inplace=True, ignore_index=True
+    df_vfptable_stacked = df_vfptable_stacked.sort_values(
+        by=[*index_names_list, "RATE"], ascending=True, ignore_index=True
     )
 
     return df_vfptable_stacked
 
 
 def _write_vfp_range(
-    values: List[float],
+    values: list[float],
     var_type: str,
     unit_type: str,
     format: str = "%10.6g",

res2df/vfp/_vfpdefs.py

@@ -6,10 +6,9 @@ routines for VFPPROD and VFPINJ keywords in res2df.
 """
 
 from enum import Enum
-from typing import Dict, List, Union
 
 # Supported types of VFP keywords
-SUPPORTED_KEYWORDS: List[str] = [
+SUPPORTED_KEYWORDS: list[str] = [
     "VFPPROD",
     "VFPINJ",
 ]
@@ -18,7 +17,7 @@ SUPPORTED_KEYWORDS: List[str] = [
 # desired column names in produced dataframes. They also to a certain
 # extent determine the structure of the dataframe, in particular
 # for keywords with arbitrary data amount pr. record (GAS, THP, WGR, GOR f.ex)
-RENAMERS: Dict[str, Dict[str, Union[str, List[str]]]] = {}
+RENAMERS: dict[str, dict[str, str | list[str]]] = {}
 
 
 # Type of VFP curve

res2df/vfp/_vfpinj.py

@@ -11,7 +11,7 @@ pyarrow.Table to file as Eclipse .Ecl format
 
 import logging
 import numbers
-from typing import Any, Dict, List, Optional, Union
+from typing import Any
 
 import numpy as np
 import pandas as pd
@@ -20,12 +20,11 @@ import pyarrow as pa
 try:
     # Needed for mypy
 
-    # pylint: disable=unused-import
     import opm.io
 
     # This import is seemingly not used, but necessary for some attributes
     # to be included in DeckItem objects.
-    from opm.io.deck import DeckKeyword  # noqa
+    from opm.io.deck import DeckKeyword  # noqa: F401
 except ImportError:
     pass
 
@@ -65,9 +64,9 @@ logger = logging.getLogger(__name__)
 
 
 def basic_data(
-    keyword: "opm.libopmcommon_python.DeckKeyword",
-    vfpnumbers_str: Optional[str] = None,
-) -> Dict[str, Any]:
+    keyword: "opm.opmcommon_python.DeckKeyword",
+    vfpnumbers_str: str | None = None,
+) -> dict[str, Any]:
     """Read and return all data for Eclipse VFPINJ keyword as basic data types
 
     Empty string returned if vfp table number does not match any number in list
@@ -89,7 +88,7 @@ def basic_data(
     if vfpnumbers_str:
         vfpnumbers = _string2intlist(vfpnumbers_str)
         if tableno not in vfpnumbers:
-            return pd.DataFrame()
+            return {}
     datum = basic_record["DATUM_DEPTH"]
     rate_type = VFPINJ_FLO.GAS
     if basic_record["RATE_TYPE"]:
@@ -121,11 +120,11 @@ def basic_data(
         )
 
     # Extract interpolation values and tabulated values (BHP values)
-    bhp_table: List[List[float]] = []
-    thp_indices: List[float] = []
+    bhp_table: list[list[float]] = []
+    thp_indices: list[float] = []
     for n in range(3, num_rec):
         bhp_record = parse_opmio_deckrecord(keyword[n], "VFPINJ", "records", 3)
-        bhp_values: Union[Any, List[float]]
+        bhp_values: Any | list[float]
         if isinstance(bhp_record.get("VALUES"), list):
             bhp_values = bhp_record.get("VALUES")
         elif isinstance(bhp_record.get("VALUES"), numbers.Number):
@@ -224,7 +223,7 @@ def basic_data2df(
     ]
 
     # reset index (not used other than tests)
-    df_bhp_stacked.reset_index(inplace=True, drop=True)
+    df_bhp_stacked = df_bhp_stacked.reset_index(drop=True)
     return df_bhp_stacked
 
 
@@ -295,7 +294,7 @@ def basic_data2pyarrow(
     return pa_table
 
 
-def df2basic_data(dframe: pd.DataFrame) -> Dict[str, Any]:
+def df2basic_data(dframe: pd.DataFrame) -> dict[str, Any]:
     """Return basic data type for VFPINJ from a pandas dataframe.
 
     Return format is a dictionary all data in VFPINJ in basic data types
@@ -348,12 +347,12 @@ def df2basic_data(dframe: pd.DataFrame) -> Dict[str, Any]:
     if no_tab_values % no_flow_values != 0:
         raise ValueError(
             f"Number of unique rate values {no_flow_values} not consistent "
-            "with number of tabulated values {no_tab_values}"
+            f"with number of tabulated values {no_tab_values}"
         )
     if no_tab_values % no_thp_values != 0:
         raise ValueError(
             f"Number of unique thp values {no_thp_values} not consistent "
-            "with number of tabulated values {no_tab_values}"
+            f"with number of tabulated values {no_tab_values}"
         )
 
     # Replace interpolation values with index in dataframe
@@ -385,7 +384,7 @@ def df2basic_data(dframe: pd.DataFrame) -> Dict[str, Any]:
     return vfpinj_data
 
 
-def pyarrow2basic_data(pa_table: pa.Table) -> Dict[str, Any]:
+def pyarrow2basic_data(pa_table: pa.Table) -> dict[str, Any]:
     """Return basic data type for VFPINJ from a pyarrow.Table.
 
     Return format is a dictionary all data in VFPINJ in basic data types
@@ -422,7 +421,7 @@ def pyarrow2basic_data(pa_table: pa.Table) -> Dict[str, Any]:
     return vfpinj_data
 
 
-def _check_basic_data(vfp_data: Dict[str, Any]) -> bool:
+def _check_basic_data(vfp_data: dict[str, Any]) -> bool:
     """Perform a check of the VFPINJ data contained in the dictionary.
     Checks if all data is present and if the dimensions of the arrays
     are consisitent.
@@ -471,9 +470,9 @@ def _check_basic_data(vfp_data: Dict[str, Any]) -> bool:
 
 
 def df(
-    keyword: "opm.libopmcommon_python.DeckKeyword",
-    vfpnumbers_str: Optional[str] = None,
-) -> Union[pd.DataFrame, None]:
+    keyword: "opm.opmcommon_python.DeckKeyword",
+    vfpnumbers_str: str | None = None,
+) -> pd.DataFrame | None:
     """Return a dataframes of a single VFPINJ table from a :term:`.DATA file`
 
     Data from the VFPINJ keyword are stacked into a Pandas Dataframe
@@ -508,9 +507,9 @@ def df(
 
 
 def pyarrow(
-    keyword: "opm.libopmcommon_python.DeckKeyword",
-    vfpnumbers_str: Optional[str] = None,
-) -> Union[pa.Table, None]:
+    keyword: "opm.opmcommon_python.DeckKeyword",
+    vfpnumbers_str: str | None = None,
+) -> pa.Table | None:
     """Return a pyarrow Table of a single VFPINJ table from a :term:`.DATA file`
        If no VFPINJ table found, return None
 
@@ -577,43 +576,9 @@ def _write_basic_record(
     return deck_str
 
 
-def _write_table(
-    table: pd.DataFrame,
-    format: str = "%10.6g",
-    values_per_line: int = 5,
-) -> str:
-    """Creates a :term:`include file` content string representing
-    a resdata record for a VFPINJ table (BHP part)
-
-    Args:
-        table:           DataFrame with multiindex for table ranges and colums
-                         for tabulated values (BHP)
-        format:          Format string for values
-        values_per_line: Number of values per line in output
-    """
-
-    deck_str = ""
-    for idx, _row in table.iterrows():
-        deck_str += f"{idx:2d}"
-        no_flo = len(table.loc[idx].to_list())
-        for n, value in enumerate(table.loc[idx].to_list()):
-            deck_str += format % value
-            if (n + 1) % values_per_line == 0:
-                if n < no_flo - 1:
-                    deck_str += "\n"
-                    deck_str += " " * 2
-                else:
-                    deck_str += "\n"
-            elif n == no_flo - 1:
-                deck_str += "\n"
-        deck_str += "/\n"
-
-    return deck_str
-
-
 def _write_table_records(
     thp_indices: np.ndarray,
-    table: pd.DataFrame,
+    table: np.ndarray,
     format: str = "%10.6g",
     values_per_line: int = 5,
 ) -> str:
@@ -657,7 +622,7 @@ def _write_table_records(
     return deck_str
 
 
-def df2res(dframe: pd.DataFrame, comment: Optional[str] = None) -> str:
+def df2res(dframe: pd.DataFrame, comment: str | None = None) -> str:
     """Creates a :term:`include file` content string
     representing single VFPINJ Eclipse input from a dataframe