Documented get_type()

omry · Sep 1, 2020 · 81ccf2e · 81ccf2e
1 parent e819bf3
commit 81ccf2e
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 0 deletions.
diff --git a/docs/source/structured_config.rst b/docs/source/structured_config.rst
@@ -114,6 +114,19 @@ Python type annotation can be used by static type checkers like Mypy/Pyre or by
     >>> with raises(ValidationError):
     ...     conf.num = "foo"
 
+This is duck-typing, the actual object type of `conf` is `DictConfig`. You can access the underlying
+type using `OmegaConf.get_type()`:
+
+.. doctest::
+
+    >>> type(conf)
+    <class 'omegaconf.dictconfig.DictConfig'>
+
+    >>> OmegaConf.get_type(conf)
+    <class 'SimpleTypes'>
+
+
+
 Runtime type validation and conversion
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 OmegaConf supports merging configs together, as well as overriding from the command line.

diff --git a/news/343.docs b/news/343.docs
@@ -0,0 +1 @@
+Document OmegaConf.get_type()