hydra-core 1.4.0.dev5__tar.gz → 1.4.0.dev6__tar.gz

{hydra_core-1.4.0.dev5/hydra_core.egg-info → hydra_core-1.4.0.dev6}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: hydra-core
-Version: 1.4.0.dev5
+Version: 1.4.0.dev6
 Summary: A framework for elegantly configuring complex applications
 Home-page: https://github.com/facebookresearch/hydra
 Author: Omry Yadan
@@ -19,8 +19,7 @@ Classifier: Operating System :: Microsoft :: Windows
 Requires-Python: >=3.10
 Description-Content-Type: text/markdown
 License-File: LICENSE
-Requires-Dist: omegaconf>=2.4.0.dev12
-Requires-Dist: packaging
+Requires-Dist: omegaconf>=2.4.0.dev13
 Dynamic: author
 Dynamic: author-email
 Dynamic: classifier
@@ -46,7 +45,7 @@ Dynamic: summary
 <p align="center">
   <a href="https://github.com/facebookresearch/hydra/blob/main/LICENSE"><img src="https://img.shields.io/pypi/l/hydra-core" alt="PyPI - License" /></a>
   <a href="https://hydra-framework.zulipchat.com/"><img src="https://img.shields.io/badge/zulip-join_chat-brightgreen.svg" alt="Zulip chat" /></a>
-  <a href="https://github.com/psf/black"><img src="https://img.shields.io/badge/code%20style-black-000000.svg" alt="Code style: black" /></a>
+  <a href="https://github.com/astral-sh/ruff"><img src="https://img.shields.io/badge/code%20style-ruff-261230.svg" alt="Code style: Ruff" /></a>
 </p>
 
 <p align="center">

{hydra_core-1.4.0.dev5 → hydra_core-1.4.0.dev6}/README.md

@@ -10,7 +10,7 @@
 <p align="center">
   <a href="https://github.com/facebookresearch/hydra/blob/main/LICENSE"><img src="https://img.shields.io/pypi/l/hydra-core" alt="PyPI - License" /></a>
   <a href="https://hydra-framework.zulipchat.com/"><img src="https://img.shields.io/badge/zulip-join_chat-brightgreen.svg" alt="Zulip chat" /></a>
-  <a href="https://github.com/psf/black"><img src="https://img.shields.io/badge/code%20style-black-000000.svg" alt="Code style: black" /></a>
+  <a href="https://github.com/astral-sh/ruff"><img src="https://img.shields.io/badge/code%20style-ruff-261230.svg" alt="Code style: Ruff" /></a>
 </p>
 
 <p align="center">

{hydra_core-1.4.0.dev5 → hydra_core-1.4.0.dev6}/hydra/__init__.py

@@ -1,7 +1,7 @@
 # Copyright (c) Facebook, Inc. and its affiliates. All Rights Reserved
 
 # Source of truth for Hydra's version
-__version__ = "1.4.0.dev5"
+__version__ = "1.4.0.dev6"
 from hydra import utils
 from hydra.errors import MissingConfigException
 from hydra.main import main

{hydra_core-1.4.0.dev5 → hydra_core-1.4.0.dev6}/hydra/_internal/config_loader_impl.py

@@ -53,6 +53,7 @@ class ConfigLoaderImpl(ConfigLoader):
     ) -> None:
         self.config_search_path = config_search_path
         self.repository = ConfigRepository(config_search_path=config_search_path)
+        self._active_repository: Optional[IConfigRepository] = None
 
     @staticmethod
     def validate_sweep_overrides_legal(
@@ -142,6 +143,41 @@ class ConfigLoaderImpl(ConfigLoader):
         run_mode: RunMode,
         from_shell: bool = True,
         validate_sweep_overrides: bool = True,
+    ) -> DictConfig:
+        return self._load_configuration(
+            config_name=config_name,
+            overrides=overrides,
+            run_mode=run_mode,
+            from_shell=from_shell,
+            validate_sweep_overrides=validate_sweep_overrides,
+            activate_config_repository=False,
+        )
+
+    def _load_configuration_with_active_repository(
+        self,
+        config_name: Optional[str],
+        overrides: List[str],
+        run_mode: RunMode,
+        from_shell: bool = True,
+        validate_sweep_overrides: bool = True,
+    ) -> DictConfig:
+        return self._load_configuration(
+            config_name=config_name,
+            overrides=overrides,
+            run_mode=run_mode,
+            from_shell=from_shell,
+            validate_sweep_overrides=validate_sweep_overrides,
+            activate_config_repository=True,
+        )
+
+    def _load_configuration(
+        self,
+        config_name: Optional[str],
+        overrides: List[str],
+        run_mode: RunMode,
+        from_shell: bool,
+        validate_sweep_overrides: bool,
+        activate_config_repository: bool,
     ) -> DictConfig:
         try:
             return self._load_configuration_impl(
@@ -150,6 +186,7 @@ class ConfigLoaderImpl(ConfigLoader):
                 run_mode=run_mode,
                 from_shell=from_shell,
                 validate_sweep_overrides=validate_sweep_overrides,
+                activate_config_repository=activate_config_repository,
             )
         except OmegaConfBaseException as e:
             raise ConfigCompositionException().with_traceback(sys.exc_info()[2]) from e
@@ -242,6 +279,7 @@ class ConfigLoaderImpl(ConfigLoader):
         run_mode: RunMode,
         from_shell: bool = True,
         validate_sweep_overrides: bool = True,
+        activate_config_repository: bool = False,
     ) -> DictConfig:
         from hydra import __version__, version
 
@@ -304,6 +342,9 @@ class ConfigLoaderImpl(ConfigLoader):
 
         cfg.hydra.job.config_name = config_name
 
+        if activate_config_repository:
+            self._active_repository = caching_repo
+
         return cfg
 
     def load_sweep_config(
@@ -441,11 +482,13 @@ class ConfigLoaderImpl(ConfigLoader):
                         OmegaConf.update(cfg, key, value, merge=True, force_add=True)
                     else:
                         assert override.input_line is not None
-                        raise ConfigCompositionException(dedent(f"""\
+                        raise ConfigCompositionException(
+                            dedent(f"""\
                         Could not append to config. An item is already at '{override.key_or_group}'.
                         Either remove + prefix: '{override.input_line[1:]}'
                         Or add a second + to add or override '{override.key_or_group}': '+{override.input_line}'
-                        """))
+                        """)
+                        )
                 elif override.is_force_add():
                     OmegaConf.update(cfg, key, value, merge=True, force_add=True)
                 elif override.is_list_extend():
@@ -499,12 +542,14 @@ class ConfigLoaderImpl(ConfigLoader):
                 try:
                     url = "https://hydra.cc/docs/1.2/upgrades/1.0_to_1.1/automatic_schema_matching"
                     if "defaults" in schema.config:
-                        raise ConfigCompositionException(dedent(f"""\
+                        raise ConfigCompositionException(
+                            dedent(f"""\
                             '{config_path}' is validated against ConfigStore schema with the same name.
                             This behavior is deprecated in Hydra 1.1 and will be removed in Hydra 1.2.
                             In addition, the automatically matched schema contains a defaults list.
                             This combination is no longer supported.
-                            See {url} for migration instructions."""))
+                            See {url} for migration instructions.""")
+                        )
                     else:
                         deprecation_warning(
                             dedent(f"""\
@@ -588,6 +633,12 @@ class ConfigLoaderImpl(ConfigLoader):
         config_name: Optional[str] = None,
         overrides: Optional[List[str]] = None,
     ) -> List[str]:
+        if (
+            config_name is None
+            and overrides is None
+            and self._active_repository is not None
+        ):
+            return self._active_repository.get_group_options(group_name, results_filter)
         if overrides is None:
             overrides = []
         _, caching_repo = self._parse_overrides_and_create_caching_repo(
@@ -630,6 +681,8 @@ class ConfigLoaderImpl(ConfigLoader):
         return cfg
 
     def get_sources(self) -> List[ConfigSource]:
+        if self._active_repository is not None:
+            return self._active_repository.get_sources()
         return self.repository.get_sources()
 
     def compute_defaults_list(

{hydra_core-1.4.0.dev5 → hydra_core-1.4.0.dev6}/hydra/_internal/config_repository.py

@@ -51,6 +51,8 @@ class IConfigRepository(ABC):
 
 
 class ConfigRepository(IConfigRepository):
+    _KNOWN_DEFAULTS_LIST_KEYWORDS = ("optional", "override")
+
     config_search_path: ConfigSearchPath
     sources: List[ConfigSource]
 
@@ -199,7 +201,9 @@ class ConfigRepository(IConfigRepository):
                 assert isinstance(key, str)
                 config_group, package, _package2 = self._split_group(key)
                 keywords = ConfigRepository.Keywords()
-                self._extract_keywords_from_config_group(config_group, keywords)
+                self._extract_keywords_from_config_group(
+                    config_path, config_group, keywords
+                )
 
                 if not version.base_at_least("1.2"):
                     if not keywords.optional and old_optional is not None:
@@ -301,18 +305,22 @@ class ConfigRepository(IConfigRepository):
 
     @staticmethod
     def _extract_keywords_from_config_group(
-        group: str, keywords: "ConfigRepository.Keywords"
+        config_path: str, group: str, keywords: "ConfigRepository.Keywords"
     ) -> None:
-        elements = group.split(" ")
+        elements = group.split()
+        if not elements:
+            raise ValueError(f"In {config_path}: Missing group name in defaults list")
         group = elements[-1]
         elements = elements[0:-1]
-        for idx, e in enumerate(elements):
-            if e == "optional":
+        for keyword in elements:
+            if keyword not in ConfigRepository._KNOWN_DEFAULTS_LIST_KEYWORDS:
+                raise ValueError(
+                    f"In {config_path}: Unsupported keyword '{keyword}' in defaults list"
+                )
+            if keyword == "optional":
                 keywords.optional = True
-            elif e == "override":
+            elif keyword == "override":
                 keywords.override = True
-            else:
-                break
         keywords.group = group
 
 

{hydra_core-1.4.0.dev5 → hydra_core-1.4.0.dev6}/hydra/_internal/core_plugins/bash_completion.py

@@ -22,11 +22,16 @@ class BashCompletion(CompletionPlugin):
         if (( ${#words[@]} < 2 )); then
             return
         fi
+        if [[ "${words[1]}" == -* ]]; then
+            return
+        fi
         file_path=$(pwd)/${words[1]}
         if [ ! -f "$file_path" ]; then
             return
         fi
-        grep "@hydra.main" $file_path -q
+        if ! grep -Fq -- "@hydra.main" "$file_path"; then
+            return
+        fi
         helper="${words[0]} ${words[1]}"
     else
         helper="${words[0]}"

{hydra_core-1.4.0.dev5 → hydra_core-1.4.0.dev6}/hydra/_internal/core_plugins/structured_config_source.py

@@ -9,7 +9,6 @@ from hydra.plugins.config_source import ConfigResult, ConfigSource
 
 
 class StructuredConfigSource(ConfigSource):
-
     def __init__(self, provider: str, path: str) -> None:
         super().__init__(provider=provider, path=path)
         # Import the module, the __init__ there is expected to register the configs.

{hydra_core-1.4.0.dev5 → hydra_core-1.4.0.dev6}/hydra/_internal/defaults_list.py

@@ -337,7 +337,7 @@ def _check_not_missing(
     return False
 
 
-def _create_interpolation_map(
+def _create_legacy_interpolation_map(
     overrides: Overrides,
     defaults_list: List[InputDefault],
     self_added: bool,
@@ -402,9 +402,11 @@ def _update_overrides(
             pcp = parent.get_config_path()
             okey = last_override_seen.get_override_key()
             oval = last_override_seen.get_name()
-            raise ConfigCompositionException(dedent(f"""\
+            raise ConfigCompositionException(
+                dedent(f"""\
                     In {pcp}: Override '{okey} : {oval}' is defined before '{d.get_override_key()}: {d.get_name()}'.
-                    Overrides must be at the end of the defaults list"""))
+                    Overrides must be at the end of the defaults list""")
+            )
 
         if isinstance(d, GroupDefault):
             if legacy_hydra_override:
@@ -424,10 +426,12 @@ def _update_overrides(
                 if interpolated_subtree:
                     # Since interpolations are deferred for until all the config groups are already set,
                     # Their subtree may not contain config group overrides
-                    raise ConfigCompositionException(dedent(f"""\
+                    raise ConfigCompositionException(
+                        dedent(f"""\
                             {parent.get_config_path()}: Default List Overrides are not allowed in the subtree
                             of an in interpolated config group (override {d.get_override_key()}={d.get_name()}).
-                            """))
+                            """)
+                    )
                 overrides.add_override(parent.get_config_path(), d)
 
 
@@ -581,7 +585,13 @@ def _create_defaults_tree_impl(
                 add_child(children, new_root)
 
     # processed deferred interpolations
-    known_choices = _create_interpolation_map(overrides, defaults_list, self_added)
+    known_choices = OmegaConf.create(overrides.known_choices)
+    # TODO: Remove Hydra 1.1 compatibility in
+    # https://github.com/facebookresearch/hydra/issues/3221.
+    if not version.base_at_least("1.2"):
+        known_choices = _create_legacy_interpolation_map(
+            overrides, defaults_list, self_added
+        )
 
     for idx, dd in enumerate(children):
         if isinstance(dd, InputDefault) and dd.is_interpolation():

{hydra_core-1.4.0.dev5 → hydra_core-1.4.0.dev6}/hydra/_internal/grammar/grammar_functions.py

@@ -204,7 +204,7 @@ def cast_bool(*args: CastType, value: Optional[CastType] = None) -> Any:
 
 
 def choice(
-    *args: Union[str, int, float, bool, Dict[Any, Any], List[Any], ChoiceSweep]
+    *args: Union[str, int, float, bool, Dict[Any, Any], List[Any], ChoiceSweep],
 ) -> ChoiceSweep:
     """
     A choice sweep over the specified values

{hydra_core-1.4.0.dev5 → hydra_core-1.4.0.dev6}/hydra/_internal/hydra.py

@@ -25,6 +25,7 @@ from hydra.core.plugins import Plugins
 from hydra.core.utils import (
     JobReturn,
     JobRuntime,
+    JobStatus,
     configure_log,
     run_job,
     setup_globals,
@@ -149,6 +150,7 @@ class Hydra:
             overrides=overrides,
             with_log_configuration=with_log_configuration,
             run_mode=RunMode.RUN,
+            activate_config_repository=True,
         )
         if cfg.hydra.mode is None:
             cfg.hydra.mode = RunMode.RUN
@@ -158,16 +160,30 @@ class Hydra:
         callbacks = Callbacks(cfg)
         callbacks.on_run_start(config=cfg, config_name=config_name)
 
-        ret = run_job(
-            hydra_context=HydraContext(
-                config_loader=self.config_loader, callbacks=callbacks
-            ),
-            task_function=task_function,
-            config=cfg,
-            job_dir_key="hydra.run.dir",
-            job_subdir_key=None,
-            configure_logging=with_log_configuration,
-        )
+        try:
+            ret = run_job(
+                hydra_context=HydraContext(
+                    config_loader=self.config_loader, callbacks=callbacks
+                ),
+                task_function=task_function,
+                config=cfg,
+                job_dir_key="hydra.run.dir",
+                job_subdir_key=None,
+                configure_logging=with_log_configuration,
+            )
+        except KeyboardInterrupt as e:
+            # run_job attaches its populated JobReturn to the interrupt before
+            # re-raising; fall back to a minimal one if the interrupt happened
+            # before the job ran (e.g. during on_job_start)
+            job_return = getattr(e, "job_return", None)
+            if not isinstance(job_return, JobReturn):
+                job_return = JobReturn()
+                job_return.status = JobStatus.FAILED
+                job_return.return_value = e
+            callbacks.on_run_end(
+                config=cfg, config_name=config_name, job_return=job_return
+            )
+            raise
         callbacks.on_run_end(config=cfg, config_name=config_name, job_return=ret)
 
         # access the result to trigger an exception in case the job failed.
@@ -187,6 +203,7 @@ class Hydra:
             overrides=overrides,
             with_log_configuration=with_log_configuration,
             run_mode=RunMode.MULTIRUN,
+            activate_config_repository=True,
         )
 
         callbacks = Callbacks(cfg)
@@ -629,6 +646,7 @@ class Hydra:
         from_shell: bool = True,
         validate_sweep_overrides: bool = True,
         run_callback: bool = True,
+        activate_config_repository: bool = False,
     ) -> DictConfig:
         """
         :param config_name:
@@ -639,16 +657,28 @@ class Hydra:
         :param validate_sweep_overrides: True if sweep overrides should be validated
         :param run_callback: True if the on_compose_config callback should be called, generally should always
                              be True except for internal use cases
+        :param activate_config_repository: True to retain the effective repository on the invocation loader
         :return:
         """
 
-        cfg = self.config_loader.load_configuration(
-            config_name=config_name,
-            overrides=overrides,
-            run_mode=run_mode,
-            from_shell=from_shell,
-            validate_sweep_overrides=validate_sweep_overrides,
-        )
+        if activate_config_repository and isinstance(
+            self.config_loader, ConfigLoaderImpl
+        ):
+            cfg = self.config_loader._load_configuration_with_active_repository(
+                config_name=config_name,
+                overrides=overrides,
+                run_mode=run_mode,
+                from_shell=from_shell,
+                validate_sweep_overrides=validate_sweep_overrides,
+            )
+        else:
+            cfg = self.config_loader.load_configuration(
+                config_name=config_name,
+                overrides=overrides,
+                run_mode=run_mode,
+                from_shell=from_shell,
+                validate_sweep_overrides=validate_sweep_overrides,
+            )
         if with_log_configuration:
             configure_log(cfg.hydra.hydra_logging, cfg.hydra.verbose)
             global log