Add support for pathlib.Path to OmegaConf.load() and OmegaConf.save()

omegaconf/omegaconf.py

@@ -2,6 +2,7 @@
 import copy
 import io
 import os
+import pathlib
 import re
 import sys
 from contextlib import contextmanager
@@ -183,7 +184,7 @@ def create(  # noqa F811
     def load(file_: Union[str, IO[bytes]]) -> Union[DictConfig, ListConfig]:
         from ._utils import get_yaml_loader
 
-        if isinstance(file_, str):
+        if isinstance(file_, (str, pathlib.Path)):
             with io.open(os.path.abspath(file_), "r", encoding="utf-8") as f:
                 obj = yaml.load(f, Loader=get_yaml_loader())
                 assert isinstance(obj, (list, dict, str))
@@ -204,7 +205,7 @@ def save(config: Container, f: Union[str, IO[str]], resolve: bool = False) -> No
         :param resolve: True to save a resolved config (defaults to False)
         """
         data = config.pretty(resolve=resolve)
-        if isinstance(f, str):
+        if isinstance(f, (str, pathlib.Path)):
             with io.open(os.path.abspath(f), "w", encoding="utf-8") as file:
                 file.write(data)
         elif hasattr(f, "write"):

tests/test_serialization.py

@@ -1,6 +1,7 @@
 # -*- coding: utf-8 -*-
 import io
 import os
+import pathlib
 import tempfile
 from typing import Any, Dict
 
@@ -37,6 +38,20 @@ def save_load_from_filename(conf: Container, resolve: bool, expected: Any) -> No
         os.unlink(fp.name)
 
 
+def save_load_from_pathlib_path(conf: Container, resolve: bool, expected: Any) -> None:
+    if expected is None:
+        expected = conf
+    # note that delete=False here is a work around windows incompetence.
+    try:
+        with tempfile.NamedTemporaryFile(delete=False) as fp:
+            filepath = pathlib.Path(fp.name)
+            OmegaConf.save(conf, filepath, resolve=resolve)
+            c2 = OmegaConf.load(filepath)
+            assert c2 == expected
+    finally:
+        os.unlink(fp.name)
+
+
 def test_load_from_invalid() -> None:
     with pytest.raises(TypeError):
         OmegaConf.load(3.1415)  # type: ignore
@@ -64,6 +79,12 @@ def test_save_load__from_filename(
         cfg = OmegaConf.create(input_)
         save_load_from_filename(cfg, resolve, expected)
 
+    def test_save_load__from_pathlib_path(
+        self, input_: Dict[str, Any], resolve: bool, expected: Any
+    ) -> None:
+        cfg = OmegaConf.create(input_)
+        save_load_from_pathlib_path(cfg, resolve, expected)
+
 
 def test_save_illegal_type() -> None:
     with pytest.raises(TypeError):