From 9935c1643093f0b37f2c61f32ad1949098682de5 Mon Sep 17 00:00:00 2001 From: mferrera Date: Fri, 22 Mar 2024 07:43:42 +0100 Subject: [PATCH] CLN: Move providers to providers subpackage --- src/fmu/dataio/_metadata.py | 33 +++++++++---------- src/fmu/dataio/dataio.py | 2 +- .../_filedata.py} | 4 +-- .../{_fmu_provider.py => providers/_fmu.py} | 7 ++-- tests/conftest.py | 2 +- tests/test_units/test_dataio.py | 2 +- .../test_units/test_filedataprovider_class.py | 2 +- tests/test_units/test_fmuprovider_class.py | 2 +- 8 files changed, 25 insertions(+), 29 deletions(-) rename src/fmu/dataio/{_filedata_provider.py => providers/_filedata.py} (98%) rename src/fmu/dataio/{_fmu_provider.py => providers/_fmu.py} (99%) diff --git a/src/fmu/dataio/_metadata.py b/src/fmu/dataio/_metadata.py index d3112d225..039fd5e3c 100644 --- a/src/fmu/dataio/_metadata.py +++ b/src/fmu/dataio/_metadata.py @@ -18,27 +18,26 @@ from pydantic import AnyHttpUrl, TypeAdapter -from fmu import dataio -from fmu.dataio._definitions import SCHEMA, SOURCE, VERSION -from fmu.dataio._filedata_provider import FileDataProvider -from fmu.dataio._fmu_provider import FmuProvider -from fmu.dataio._utils import ( +from . import types +from ._definitions import SCHEMA, SOURCE, VERSION, FmuContext +from ._logging import null_logger +from ._utils import ( drop_nones, export_file_compute_checksum_md5, glue_metadata_preprocessed, read_metadata_from_file, ) -from fmu.dataio.datastructure._internal import internal -from fmu.dataio.datastructure.configuration import global_configuration -from fmu.dataio.datastructure.meta import meta -from fmu.dataio.providers._objectdata import objectdata_provider_factory - -from . import types -from ._definitions import FmuContext -from ._logging import null_logger +from .datastructure._internal import internal +from .datastructure.configuration import global_configuration +from .datastructure.meta import meta +from .providers._filedata import FileDataProvider +from .providers._fmu import FmuProvider +from .providers._objectdata import objectdata_provider_factory +from .version import __version__ if TYPE_CHECKING: - from fmu.dataio.providers._objectdata_base import ObjectDataProvider + from .dataio import ExportData + from .providers._objectdata_base import ObjectDataProvider logger: Final = null_logger(__name__) @@ -65,9 +64,7 @@ def generate_meta_tracklog() -> list[meta.TracklogEvent]: event="created", user=meta.User.model_construct(id=getpass.getuser()), sysinfo=meta.SystemInformation.model_construct( - fmu_dataio=meta.VersionInformation.model_construct( - version=dataio.__version__, - ), + fmu_dataio=meta.VersionInformation.model_construct(version=__version__), komodo=meta.VersionInformation.model_construct(version=kr) if (kr := os.environ.get("KOMODO_RELEASE")) else None, @@ -113,7 +110,7 @@ class MetaData: # input variables obj: types.Inferrable - dataio: dataio.ExportData + dataio: ExportData compute_md5: bool = True # storage state variables diff --git a/src/fmu/dataio/dataio.py b/src/fmu/dataio/dataio.py index a16513adb..da30d5139 100644 --- a/src/fmu/dataio/dataio.py +++ b/src/fmu/dataio/dataio.py @@ -21,7 +21,6 @@ FmuContext, ValidationError, ) -from ._fmu_provider import FmuEnv from ._logging import null_logger from ._utils import ( create_symlink, @@ -38,6 +37,7 @@ AllowedContent, ) from .datastructure.configuration import global_configuration +from .providers._fmu import FmuEnv # DATAIO_EXAMPLES: Final = dataio_examples() INSIDE_RMS: Final = detect_inside_rms() diff --git a/src/fmu/dataio/_filedata_provider.py b/src/fmu/dataio/providers/_filedata.py similarity index 98% rename from src/fmu/dataio/_filedata_provider.py rename to src/fmu/dataio/providers/_filedata.py index 8251513cd..463cbafe5 100644 --- a/src/fmu/dataio/_filedata_provider.py +++ b/src/fmu/dataio/providers/_filedata.py @@ -12,8 +12,8 @@ from typing import TYPE_CHECKING, Final, Optional from warnings import warn -from ._definitions import FmuContext -from ._logging import null_logger +from fmu.dataio._definitions import FmuContext +from fmu.dataio._logging import null_logger logger: Final = null_logger(__name__) diff --git a/src/fmu/dataio/_fmu_provider.py b/src/fmu/dataio/providers/_fmu.py similarity index 99% rename from src/fmu/dataio/_fmu_provider.py rename to src/fmu/dataio/providers/_fmu.py index 73dd93621..929e53dce 100644 --- a/src/fmu/dataio/_fmu_provider.py +++ b/src/fmu/dataio/providers/_fmu.py @@ -39,10 +39,9 @@ from warnings import warn from fmu.config import utilities as ut - -from . import _utils -from ._definitions import FmuContext -from ._logging import null_logger +from fmu.dataio import _utils +from fmu.dataio._definitions import FmuContext +from fmu.dataio._logging import null_logger # case metadata relative to casepath ERT_RELATIVE_CASE_METADATA_FILE: Final = "share/metadata/fmu_case.yml" diff --git a/tests/conftest.py b/tests/conftest.py index a0741a348..b469ee2e0 100644 --- a/tests/conftest.py +++ b/tests/conftest.py @@ -13,9 +13,9 @@ import xtgeo import yaml from fmu.config import utilities as ut -from fmu.dataio._fmu_provider import FmuEnv from fmu.dataio.dataio import ExportData, read_metadata from fmu.dataio.datastructure.configuration import global_configuration +from fmu.dataio.providers._fmu import FmuEnv from .utils import _metadata_examples diff --git a/tests/test_units/test_dataio.py b/tests/test_units/test_dataio.py index 4c04d644d..6d199b882 100644 --- a/tests/test_units/test_dataio.py +++ b/tests/test_units/test_dataio.py @@ -9,9 +9,9 @@ import pytest import yaml from fmu.dataio._definitions import FmuContext -from fmu.dataio._fmu_provider import FmuEnv from fmu.dataio._utils import prettyprint_dict from fmu.dataio.dataio import ExportData, ValidationError, read_metadata +from fmu.dataio.providers._fmu import FmuEnv # pylint: disable=no-member diff --git a/tests/test_units/test_filedataprovider_class.py b/tests/test_units/test_filedataprovider_class.py index 6ade63d08..746d63628 100644 --- a/tests/test_units/test_filedataprovider_class.py +++ b/tests/test_units/test_filedataprovider_class.py @@ -5,7 +5,7 @@ import pytest from fmu.dataio import ExportData -from fmu.dataio._filedata_provider import FileDataProvider +from fmu.dataio.providers._filedata import FileDataProvider from fmu.dataio.providers._objectdata import objectdata_provider_factory from fmu.dataio.providers._objectdata_base import derive_name from xtgeo.cube import Cube diff --git a/tests/test_units/test_fmuprovider_class.py b/tests/test_units/test_fmuprovider_class.py index 91c2bacc9..8d91c43bb 100644 --- a/tests/test_units/test_fmuprovider_class.py +++ b/tests/test_units/test_fmuprovider_class.py @@ -9,7 +9,7 @@ # from conftest import pretend_ert_env_run1 from fmu.dataio._definitions import FmuContext -from fmu.dataio._fmu_provider import RESTART_PATH_ENVNAME, FmuEnv, FmuProvider +from fmu.dataio.providers._fmu import RESTART_PATH_ENVNAME, FmuEnv, FmuProvider logger = logging.getLogger(__name__)