Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

MAINT: Refactor to remove the _usefmtflag #802

Merged
merged 1 commit into from
Sep 25, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 10 additions & 8 deletions src/fmu/dataio/_utils.py
Original file line number Diff line number Diff line change
Expand Up @@ -86,9 +86,12 @@ def export_metadata_file(
def export_file(
obj: types.Inferrable,
filename: Path,
flag: str | None = None,
fmt: str = "",
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Renamed to fmt to make it more clear what it is

) -> str:
"""Export a valid object to file"""
"""
Export a valid object to file. If xtgeo is in the fmt string, xtgeo
xyz-column names will be preserved for xtgeo.Points and xtgeo.Polygons
"""

# create output folder if not existing
filename.parent.mkdir(parents=True, exist_ok=True)
Expand All @@ -97,8 +100,7 @@ def export_file(
obj.to_file(filename, fformat="irap_binary")
elif filename.suffix == ".csv" and isinstance(obj, (xtgeo.Polygons, xtgeo.Points)):
out = obj.copy() # to not modify incoming instance!
assert flag is not None
if "xtgeo" not in flag:
if "xtgeo" not in fmt:
out.xname = "X"
out.yname = "Y"
out.zname = "Z"
Expand Down Expand Up @@ -154,15 +156,15 @@ def md5sum(fname: Path) -> str:
def export_file_compute_checksum_md5(
obj: types.Inferrable,
filename: Path,
flag: str | None = None,
fmt: str = "",
) -> str:
"""Export and compute checksum"""
export_file(obj, filename, flag=flag)
export_file(obj, filename, fmt=fmt)
return md5sum(filename)


def compute_md5_using_temp_file(
obj: types.Inferrable, extension: str, flag: str = ""
obj: types.Inferrable, extension: str, fmt: str = ""
) -> str:
"""Compute an MD5 sum using a temporary file."""
if not extension.startswith("."):
Expand All @@ -171,7 +173,7 @@ def compute_md5_using_temp_file(
with NamedTemporaryFile(buffering=0, suffix=extension) as tf:
logger.info("Compute MD5 sum for tmp file...: %s", tf.name)
return export_file_compute_checksum_md5(
obj=obj, filename=Path(tf.name), flag=flag
obj=obj, filename=Path(tf.name), fmt=fmt
)


Expand Down
19 changes: 4 additions & 15 deletions src/fmu/dataio/dataio.py
Original file line number Diff line number Diff line change
Expand Up @@ -407,9 +407,6 @@ class ExportData:
workflow: Optional[Union[str, Dict[str, str]]] = None # dict input is deprecated
table_index: Optional[list] = None

# some keys that are modified version of input, prepended with _use
_usefmtflag: str = field(default="", init=False)

# storing resulting state variables for instance, non-public:
_pwd: Path = field(default_factory=Path, init=False)
_fmurun: bool = field(default=False, init=False)
Expand Down Expand Up @@ -722,12 +719,6 @@ def _validate_and_establish_fmucontext(self) -> None:
UserWarning,
)

def _update_fmt_flag(self) -> None:
# treat special handling of "xtgeo" in format name:
if self.points_fformat == "csv|xtgeo" or self.polygons_fformat == "csv|xtgeo":
self._usefmtflag = "xtgeo"
logger.info("Using flag format: <%s>", self._usefmtflag)

def _update_check_settings(self, newsettings: dict) -> None:
"""Update instance settings (properties) from other routines."""
# if no newsettings (kwargs) this rutine is not needed
Expand Down Expand Up @@ -819,18 +810,17 @@ def _export_without_metadata(self, obj: types.Inferrable) -> str:
is found using the FileDataProvider directly.
A string with full path to the exported item is returned.
"""
self._update_fmt_flag()

fmudata = self._get_fmu_provider() if self._fmurun else None
objdata = objectdata_provider_factory(obj, self)

filemeta = FileDataProvider(
dataio=self,
objdata=objectdata_provider_factory(obj, self),
objdata=objdata,
runpath=fmudata.get_runpath() if fmudata else None,
).get_metadata()

assert filemeta.absolute_path is not None # for mypy
return export_file(obj, filename=filemeta.absolute_path, flag=self._usefmtflag)
return export_file(obj, filename=filemeta.absolute_path, fmt=objdata.fmt)

# ==================================================================================
# Public methods:
Expand Down Expand Up @@ -886,7 +876,6 @@ def generate_metadata(
is_observation=self.is_observation,
).generate_metadata(obj)

self._update_fmt_flag()
fmudata = self._get_fmu_provider() if self._fmurun else None

return generate_export_metadata(
Expand Down Expand Up @@ -942,7 +931,7 @@ def export(
outfile = Path(metadata["file"]["absolute_path"])
metafile = outfile.parent / f".{outfile.name}.yml"

export_file(obj, outfile, flag=self._usefmtflag)
export_file(obj, outfile, fmt=metadata["data"].get("format", ""))
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

data.format in the metadata is populated by the objdata.fmt

logger.info("Actual file is: %s", outfile)

export_metadata_file(metafile, metadata, savefmt=self.meta_format)
Expand Down
2 changes: 1 addition & 1 deletion src/fmu/dataio/providers/_filedata.py
Original file line number Diff line number Diff line change
Expand Up @@ -112,7 +112,7 @@ def _compute_md5(self) -> str:
if self.obj is None:
raise ValueError("Can't compute MD5 sum without an object.")
return compute_md5_using_temp_file(
self.obj, self.objdata.extension, self.dataio._usefmtflag
self.obj, self.objdata.extension, fmt=self.objdata.fmt
)

def _add_filename_to_path(self, path: Path) -> Path:
Expand Down