MAINT: Make 'oyaml' private

Author: mferrera

src/fmu/config/_configparserfmu_ipl.py

@@ -238,7 +238,7 @@ def _guess_dtype(var: str, entry: dict[str, Any]) -> dict[str, Any]:
     keyword = var
     logger.info("Guess dtype and value(s) for %s %s", var, values)
 
-    usekey = OrderedDict()
+    usekey: OrderedDict = OrderedDict()
     usekey[keyword] = OrderedDict()
     usekey[keyword]["dtype"] = None
     usekey[keyword]["value"] = None  # Keep "value" if singel entry

src/fmu/config/oyaml.py src/fmu/config/_oyaml.pysrc/fmu/config/oyaml.py renamed to src/fmu/config/_oyaml.py

@@ -14,21 +14,19 @@
 import re
 import socket
 import sys
-
-# for ordered dicts!
 from collections import Counter, OrderedDict
 from copy import deepcopy
 from os.path import join as ojoin
 from typing import TYPE_CHECKING
 
+from fmu.config import _configparserfmu_ipl, _oyaml as yaml, etc
+from fmu.config._loader import ConstructorError, FmuLoader
+
 try:
     from fmu.config.version import __version__
 except ImportError:
     __version__ = "0.0.0"
 
-from fmu.config import _configparserfmu_ipl, etc, oyaml as yaml
-from fmu.config._loader import ConstructorError, FmuLoader
-
 if TYPE_CHECKING:
     from typing import Any, Literal
 

src/fmu/config/configparserfmu.py

@@ -2,9 +2,10 @@
 
 from __future__ import annotations
 
+from yaml.loader import Loader
+
 from fmu.config import _oyaml as yaml
 from fmu.config._loader import ConstructorError, FmuLoader
-from yaml.loader import Loader
 
 
 def yaml_load(

src/fmu/config/utilities.py

@@ -4,10 +4,10 @@
 import os.path
 from os.path import join
 
-import fmu.config as config
 import pytest
-from fmu.config import _oyaml as yaml
-from fmu.config import utilities as ut
+
+import fmu.config as config
+from fmu.config import _oyaml as yaml, utilities as ut
 
 # import fmu.config.fmuconfigrunner as fmurun
 

tests/test_config.py

@@ -5,8 +5,10 @@
 
 import pytest
 import yaml
+from pytest import MonkeyPatch
 from yaml.constructor import ConstructorError
 
+import fmu.config as config
 from fmu.config import etc, utilities as util
 from fmu.config.configparserfmu import ConfigParserFMU
 
@@ -144,3 +146,61 @@ def test_mapping_ordering_maintained(tmp_path: Path) -> None:
 
     assert bad_cfg != cfg._config
     assert good_cfg == cfg._config
+
+
+def test_mapping_ordering_maintained_during_include(
+    tmp_path: Path, monkeypatch: MonkeyPatch
+) -> None:
+    monkeypatch.chdir(tmp_path)
+    with open("global_config.yml", "w", encoding="utf-8") as f:
+        # Can't yaml dump this, puts the !include in quotes
+        f.write(
+            """
+revision: test
+global:
+  foo: !include _bar.yml
+    """.strip()
+        )
+
+    _bar_yml = {
+        "A_Upper": 11.2,
+        "A_Lower_2": 12.3,
+        "A_Lower_1": 12.3,
+        "C_Fm_3": 13.4,
+        "C_Fm_2": 13.4,
+        "C_Fm_1": 13.4,
+        "B_Upper_2": 14.5,
+        "B_Upper_1": 14.5,
+        "B_Lower_2": 14.3,
+        "B_Lower_1": 14.3,
+    }
+    with open("_bar.yml", "w", encoding="utf-8") as f:
+        f.write(yaml.dump(_bar_yml))
+
+    cfg = config.ConfigParserFMU()
+    cfg.parse("global_config.yml")
+    cfg.to_yaml(
+        rootname="out_config",
+        destination=tmp_path,
+        template=tmp_path,
+    )
+    with open("out_config.yml", encoding="utf-8") as f:
+        # Strip out added comments
+        result = "".join([line for line in f.readlines() if not line.startswith("#")])
+
+    expected = """
+revision: test
+global:
+  foo:
+    A_Upper: 11.2
+    A_Lower_2: 12.3
+    A_Lower_1: 12.3
+    C_Fm_3: 13.4
+    C_Fm_2: 13.4
+    C_Fm_1: 13.4
+    B_Upper_2: 14.5
+    B_Upper_1: 14.5
+    B_Lower_2: 14.3
+    B_Lower_1: 14.3
+""".strip()
+    assert result.strip() == expected.strip()