updated strict mode page

examples/tutorials/basic/your_first_hydra_app/3_using_the_config_object/my_app.py

@@ -1,8 +1,8 @@
 # Copyright (c) Facebook, Inc. and its affiliates. All Rights Reserved
-from omegaconf import DictConfig, open_dict, MissingMandatoryValue
+import pytest
+from omegaconf import DictConfig, MissingMandatoryValue, open_dict
 
 import hydra
-import pytest
 
 
 @hydra.main(config_name="config")

hydra/_internal/core_plugins/bash_completion.py

@@ -8,10 +8,6 @@
 
 log = logging.getLogger(__name__)
 
-# TODO:
-# Test with /miniconda3/envs/hydra36/bin/python , seems to be running python for some reason.
-# Test handling of errors loading config from command line during completion
-
 
 class BashCompletion(CompletionPlugin):
     def install(self) -> None:

hydra/plugins/completion_plugin.py

@@ -1,4 +1,10 @@
 # Copyright (c) Facebook, Inc. and its affiliates. All Rights Reserved
+
+# TODO: Test with /miniconda3/envs/hydra36/bin/python , seems to be running python for some reason.
+# TODO: Add tests for completion with +prefix (should suggest config groups that are not listed)
+# TODO: Test completion when defaults has a missing mandatory item
+
+
 import os
 import re
 import sys

tests/test_config_loader.py

@@ -1,8 +1,4 @@
 # Copyright (c) Facebook, Inc. and its affiliates. All Rights Reserved
-# TODO: Document command line: +/~, package, defaults manipulation, the works.
-# TODO: Proof read upgrades/0.11_to_1.0/strict_mode_flag_deprecated.md
-# TODO: Tab completion: Add tests for completion with +prefix (should suggest config groups that are not listed)
-# TODO: Tab completion: Test completion when defaults has a missing mandatory item
 import re
 from dataclasses import dataclass
 from typing import Any, List

tests/test_examples/test_tutorials_basic.py

@@ -15,7 +15,6 @@
     does_not_raise,
     verify_dir_outputs,
 )
-from tests.test_examples import run_with_error
 
 chdir_hydra_root()
 
@@ -402,10 +401,4 @@ def test_examples_using_the_config_object(tmpdir: Path) -> None:
         "hydra.run.dir=" + str(tmpdir),
     ]
 
-    expected = """Missing mandatory value: node.waldo
-\tfull_key: node.waldo
-\treference_type=Optional[Dict[Any, Any]]
-\tobject_type=dict"""
-
-    result = run_with_error(cmd)
-    assert re.search(re.escape(expected), result)
+    subprocess.check_output(cmd)

website/docs/tutorials/basic/running_your_app/config_strict_mode.md

@@ -3,18 +3,20 @@ id: strict_mode
 title: Strict config errors
 ---
 
+
 ### Overview
-`Strict mode` is enabled by default if you specify a config name in `hydra.main`.
-It catches references to fields not specified in the config. This helps with two types of mistakes:
+Hydra sets the `struct` flag on the config object. This catches references to fields not specified in the config. 
+
+This results in two useful behaviors:
 
-Accessing a field that not in the config file throws an exception:
+- Accessing a field that not in the config file raises exception:
 ```python {3}
 @hydra.main(config_name='config')
 def my_app(cfg : DictConfig) -> None:
     print(cfg.db.drover)  # typo: cfg.db.driver, raises an exception
 ```
 
-Overriding a field that is not in the config file via the command line prints an error:
+- Overriding a field that is not in the config file via the command line prints an error:
 ```text {1}
 $ python my_app.py db.drover=mariadb
 Error merging overrides
@@ -24,20 +26,8 @@ Key 'drover' in not in struct
         object_type=dict
 ```
 
-### Disabling strict mode
-You can disable `Strict mode` by passing `strict=False` to `hydra.main()` 
-```python
-@hydra.main(config_name='config', strict=False)
-def my_app(cfg : DictConfig) -> None:
-    cfg.db.port = 3306 # Okay
-```
-
-This is not recommended. Without strict mode:
- - Attempting to read a field not in the config object returns None.
-- Attempting to override a field not in the config inserts the new field into the config.
-
-If you have a good reason to add a new field to the config object at runtime, 
-use <a class="external" href="https://omegaconf.readthedocs.io/en/latest/usage.html#struct-flag" target="_blank">OmegaConf's open_dict</a>
-to disable this protection within a context.
-Note that `strict mode` is referred to as `struct mode` in OmegaConf.
+### Adding fields at runtime
+- You can disable the struct flag a specific context using `open_dict`.
+- You can disable the struct flag permanently for your config using `OmegaConf.set_struct(cfg, False)`.
 
+Learn more about OmegaConf struct flag <a class="external" href="https://omegaconf.readthedocs.io/en/latest/usage.html#struct-flag" target="_blank">here</a>.