Fix cfg.pretty() deprecation warning

omry · Sep 3, 2020 · 6e0c3d7 · 6e0c3d7
1 parent 3dd16f7
commit 6e0c3d7
Show file tree

Hide file tree

Showing 3 changed files with 12 additions and 8 deletions.
diff --git a/news/358.bugfix b/news/358.bugfix
@@ -0,0 +1 @@
+Fix cfg.pretty() deprecation warning
diff --git a/omegaconf/basecontainer.py b/omegaconf/basecontainer.py
@@ -3,6 +3,7 @@
 import warnings
 from abc import ABC, abstractmethod
 from enum import Enum
+from textwrap import dedent
 from typing import Any, Dict, List, Optional, Tuple, Union
 
 import yaml
@@ -222,11 +223,12 @@ def pretty(self, resolve: bool = False, sort_keys: bool = False) -> str:
         from omegaconf import OmegaConf
 
         warnings.warn(
+            dedent(
+                """\
+            cfg.pretty() is deprecated and will be removed in a future version.
+            Use OmegaConf.to_yaml(cfg)
             """
-            pretty() is deprecated and will be removed in a future version.
-            Use OmegaConf.to_yaml. Please note that the default value for
-            resolve has changed to True.
-            """,
+            ),
             category=UserWarning,
         )
 

diff --git a/tests/test_to_yaml.py b/tests/test_to_yaml.py
@@ -130,11 +130,12 @@ def test_pretty_deprecated() -> None:
     with pytest.warns(
         expected_warning=UserWarning,
         match=re.escape(
-            """
-            pretty() is deprecated and will be removed in a future version.
-            Use OmegaConf.to_yaml. Please note that the default value for
-            resolve has changed to True.
+            dedent(
+                """\
+            cfg.pretty() is deprecated and will be removed in a future version.
+            Use OmegaConf.to_yaml(cfg)
             """,
+            )
         ),
     ):
         assert c.pretty() == "foo: bar\n"