hydra-qol 0.1.0__tar.gz

hydra_qol-0.1.0/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

hydra_qol-0.1.0/PKG-INFO

@@ -0,0 +1,132 @@
+Metadata-Version: 2.4
+Name: hydra-qol
+Version: 0.1.0
+Summary: Quality-of-life helpers for Hydra: register dataclass configs and check that all YAML config files are valid.
+Keywords: hydra,config,configuration,dataclass,omegaconf
+Author: Thomas M Kehrenberg
+Author-email: Thomas M Kehrenberg <tmke8@posteo.net>
+License-Expression: Apache-2.0
+License-File: LICENSE
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Science/Research
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: Software Development :: Libraries
+Classifier: Typing :: Typed
+Requires-Dist: hydra-core>=1.4.0rc1
+Requires-Dist: omegaconf>=2.4
+Requires-Python: >=3.11
+Project-URL: Repository, https://github.com/tmke8/hydra-qol
+Project-URL: Issues, https://github.com/tmke8/hydra-qol/issues
+Description-Content-Type: text/markdown
+
+# hydra-qol
+
+Quality-of-life helpers for [Hydra](https://hydra.cc): register dataclass-based configs
+in one call, prepare composed configs for logging, and check that *all* YAML config
+files in a project are valid without running any experiments.
+
+## Installation
+
+```bash
+uv add hydra-qol
+# or
+pip install hydra-qol
+```
+
+Requires Python 3.11+, `hydra-core` 1.4+ (a pre-release at the time of writing) and
+`omegaconf` 2.4+.
+
+## What's in the box
+
+| Function | Purpose |
+| --- | --- |
+| `register_hydra_config(Config, groups, schema_name=...)` | Stores the main config class and all config-group options in Hydra's `ConfigStore`, after checking the classes for common mistakes. |
+| `prepare_for_logging(hydra_config)` | Turns a composed config into a plain dict (enums → strings, interpolations resolved, subconfigs tagged with their type), ready for `wandb.init(config=...)`. |
+| `check_configs(Config, groups, config_name=..., config_dir=...)` | Composes every YAML file in `config_dir` and instantiates `Config` from it; prints a report and returns an exit code. |
+| `validate_configs(...)` | Same as `check_configs`, but returns a list of `CheckResult` objects instead of printing. Handy in a test suite. |
+
+## Quick start
+
+```python
+# main.py
+import hydra
+from omegaconf import DictConfig, OmegaConf
+from hydra_qol import prepare_for_logging, register_hydra_config
+
+from my_project.config import CONFIG_GROUPS, Config
+
+
+@hydra.main(config_path="configs", config_name="main_config")
+def main(hydra_config: DictConfig) -> None:
+    config = OmegaConf.to_object(hydra_config)
+    assert isinstance(config, Config)
+    config_for_logging = prepare_for_logging(hydra_config)
+    ...
+
+
+if __name__ == "__main__":
+    register_hydra_config(Config, CONFIG_GROUPS, schema_name="main_config")
+    main()
+```
+
+```python
+# check_configs.py
+import sys
+
+from hydra_qol import check_configs
+
+from my_project.config import CONFIG_GROUPS, Config
+
+if __name__ == "__main__":
+    sys.exit(
+        check_configs(
+            Config, CONFIG_GROUPS, config_name="main_config", config_dir="configs"
+        )
+    )
+```
+
+```
+$ python check_configs.py
+OK    dm/celeba_male_smiling.yaml (dm=celeba_male_smiling)
+OK    good_run.yaml (--config-name good_run)
+FAIL  model/single_linear_layer.yaml (model=single_linear_layer)
+Traceback (most recent call last):
+  ...
+hydra.errors.ConfigCompositionException: Could not override 'model.num_hiden'.
+
+1 config file(s) are invalid:
+  - model/single_linear_layer.yaml (model=single_linear_layer)
+```
+
+A complete, annotated example project that uses these functions can be found at
+[wearepal/hydra-example](https://github.com/wearepal/hydra-example).
+The full documentation lives in [`docs/`](docs/) and is built with Sphinx:
+
+```bash
+uv sync --group docs
+uv run sphinx-build -b html docs docs/_build/html
+```
+
+## Development
+
+```bash
+uv sync                # installs test, lint and docs dependencies
+uv run pytest
+uv run ruff check && uv run ruff format --check
+uv run ty check
+```
+
+## Acknowledgements
+
+`register_hydra_config` and `prepare_for_logging` originate from
+[ranzen](https://github.com/wearepal/ranzen) (Apache 2.0).
+
+## License
+
+Apache 2.0, see [LICENSE](LICENSE).

hydra_qol-0.1.0/README.md

@@ -0,0 +1,105 @@
+# hydra-qol
+
+Quality-of-life helpers for [Hydra](https://hydra.cc): register dataclass-based configs
+in one call, prepare composed configs for logging, and check that *all* YAML config
+files in a project are valid without running any experiments.
+
+## Installation
+
+```bash
+uv add hydra-qol
+# or
+pip install hydra-qol
+```
+
+Requires Python 3.11+, `hydra-core` 1.4+ (a pre-release at the time of writing) and
+`omegaconf` 2.4+.
+
+## What's in the box
+
+| Function | Purpose |
+| --- | --- |
+| `register_hydra_config(Config, groups, schema_name=...)` | Stores the main config class and all config-group options in Hydra's `ConfigStore`, after checking the classes for common mistakes. |
+| `prepare_for_logging(hydra_config)` | Turns a composed config into a plain dict (enums → strings, interpolations resolved, subconfigs tagged with their type), ready for `wandb.init(config=...)`. |
+| `check_configs(Config, groups, config_name=..., config_dir=...)` | Composes every YAML file in `config_dir` and instantiates `Config` from it; prints a report and returns an exit code. |
+| `validate_configs(...)` | Same as `check_configs`, but returns a list of `CheckResult` objects instead of printing. Handy in a test suite. |
+
+## Quick start
+
+```python
+# main.py
+import hydra
+from omegaconf import DictConfig, OmegaConf
+from hydra_qol import prepare_for_logging, register_hydra_config
+
+from my_project.config import CONFIG_GROUPS, Config
+
+
+@hydra.main(config_path="configs", config_name="main_config")
+def main(hydra_config: DictConfig) -> None:
+    config = OmegaConf.to_object(hydra_config)
+    assert isinstance(config, Config)
+    config_for_logging = prepare_for_logging(hydra_config)
+    ...
+
+
+if __name__ == "__main__":
+    register_hydra_config(Config, CONFIG_GROUPS, schema_name="main_config")
+    main()
+```
+
+```python
+# check_configs.py
+import sys
+
+from hydra_qol import check_configs
+
+from my_project.config import CONFIG_GROUPS, Config
+
+if __name__ == "__main__":
+    sys.exit(
+        check_configs(
+            Config, CONFIG_GROUPS, config_name="main_config", config_dir="configs"
+        )
+    )
+```
+
+```
+$ python check_configs.py
+OK    dm/celeba_male_smiling.yaml (dm=celeba_male_smiling)
+OK    good_run.yaml (--config-name good_run)
+FAIL  model/single_linear_layer.yaml (model=single_linear_layer)
+Traceback (most recent call last):
+  ...
+hydra.errors.ConfigCompositionException: Could not override 'model.num_hiden'.
+
+1 config file(s) are invalid:
+  - model/single_linear_layer.yaml (model=single_linear_layer)
+```
+
+A complete, annotated example project that uses these functions can be found at
+[wearepal/hydra-example](https://github.com/wearepal/hydra-example).
+The full documentation lives in [`docs/`](docs/) and is built with Sphinx:
+
+```bash
+uv sync --group docs
+uv run sphinx-build -b html docs docs/_build/html
+```
+
+## Development
+
+```bash
+uv sync                # installs test, lint and docs dependencies
+uv run pytest
+uv run ruff check && uv run ruff format --check
+uv run ty check
+```
+
+## Acknowledgements
+
+`register_hydra_config` and `prepare_for_logging` originate from
+[ranzen](https://github.com/wearepal/ranzen) (Apache 2.0).
+
+## License
+
+Apache 2.0, see [LICENSE](LICENSE).

hydra_qol-0.1.0/pyproject.toml

@@ -0,0 +1,143 @@
+[project]
+name = "hydra-qol"
+version = "0.1.0"
+description = "Quality-of-life helpers for Hydra: register dataclass configs and check that all YAML config files are valid."
+readme = "README.md"
+license = "Apache-2.0"
+license-files = ["LICENSE"]
+requires-python = ">=3.11"
+dependencies = [
+    "hydra-core>=1.4.0rc1",
+    "omegaconf>=2.4",
+]
+keywords = [
+    "hydra",
+    "config",
+    "configuration",
+    "dataclass",
+    "omegaconf",
+]
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Intended Audience :: Developers",
+    "Intended Audience :: Science/Research",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Programming Language :: Python :: 3.14",
+    "Topic :: Software Development :: Libraries",
+    "Typing :: Typed",
+]
+
+[[project.authors]]
+name = "Thomas M Kehrenberg"
+email = "tmke8@posteo.net"
+
+[project.urls]
+Repository = "https://github.com/tmke8/hydra-qol"
+Issues = "https://github.com/tmke8/hydra-qol/issues"
+
+[dependency-groups]
+test = ["pytest>=8"]
+lint = [
+    "ruff>=0.14",
+    "ty",
+]
+docs = [
+    "sphinx>=8",
+    "furo",
+]
+
+[[dependency-groups.dev]]
+include-group = "test"
+
+[[dependency-groups.dev]]
+include-group = "lint"
+
+[[dependency-groups.dev]]
+include-group = "docs"
+
+[build-system]
+requires = ["uv_build>=0.9,<0.14"]
+build-backend = "uv_build"
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+addopts = "-ra"
+
+[tool.ty.src]
+include = [
+    "src",
+    "tests",
+]
+
+[tool.ty.rules]
+disjoint-cast = "warn"
+possibly-missing-attribute = "warn"
+possibly-missing-import = "warn"
+possibly-unresolved-reference = "warn"
+truthiness-test-of-none-union = "warn"
+unsound-assignment = "warn"
+unsound-return-statement = "warn"
+
+[tool.ruff]
+line-length = 88
+target-version = "py311"
+
+[tool.ruff.format]
+quote-style = "preserve"
+
+[tool.ruff.lint]
+select = [
+    "ARG",
+    "B",
+    "C4",
+    "E",
+    "F",
+    "FBT",
+    "I",
+    "INP",
+    "N",
+    "PLC",
+    "PLE",
+    "PLR",
+    "PLW",
+    "PTH",
+    "SIM",
+    "UP",
+    "W",
+]
+ignore = [
+    "E501",
+    "N812",
+    "PLR0402",
+    "PLR2004",
+    "PLR0913",
+    "PLW2901",
+    "PLC0105",
+    "W191",
+]
+
+[tool.ruff.lint.per-file-ignores]
+"__init__.py" = [
+    "F403",
+    "PLC0414",
+]
+"docs/conf.py" = ["INP"]
+"tests/**" = ["INP"]
+
+[tool.ruff.lint.isort]
+known-third-party = ["hydra"]
+extra-standard-library = ["typing_extensions"]
+no-lines-before = [
+    "future",
+    "standard-library",
+]
+force-sort-within-sections = true
+split-on-trailing-comma = false
+
+[tool.ruff.lint.pylint]
+max-statements = 60
+max-branches = 13

hydra_qol-0.1.0/pyproject.toml.orig

@@ -0,0 +1,111 @@
+[project]
+name = "hydra-qol"
+version = "0.1.0"
+description = "Quality-of-life helpers for Hydra: register dataclass configs and check that all YAML config files are valid."
+readme = "README.md"
+license = "Apache-2.0"
+license-files = ["LICENSE"]
+authors = [{ name = "Thomas M Kehrenberg", email = "tmke8@posteo.net" }]
+requires-python = ">=3.11"
+dependencies = ["hydra-core>=1.4.0rc1", "omegaconf>=2.4"]
+keywords = ["hydra", "config", "configuration", "dataclass", "omegaconf"]
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Intended Audience :: Developers",
+    "Intended Audience :: Science/Research",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Programming Language :: Python :: 3.14",
+    "Topic :: Software Development :: Libraries",
+    "Typing :: Typed",
+]
+
+[project.urls]
+Repository = "https://github.com/tmke8/hydra-qol"
+Issues = "https://github.com/tmke8/hydra-qol/issues"
+
+[dependency-groups]
+dev = [{ include-group = "test" }, { include-group = "lint" }, { include-group = "docs" }]
+test = ["pytest>=8"]
+lint = ["ruff>=0.14", "ty"]
+docs = ["sphinx>=8", "furo"]
+
+[build-system]
+requires = ["uv_build>=0.9,<0.14"]
+build-backend = "uv_build"
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+addopts = "-ra"
+
+[tool.ty.src]
+include = ["src", "tests"]
+
+[tool.ty.rules]
+disjoint-cast = "warn"
+possibly-missing-attribute = "warn"
+possibly-missing-import = "warn"
+possibly-unresolved-reference = "warn"
+truthiness-test-of-none-union = "warn"
+unsound-assignment = "warn"
+unsound-return-statement = "warn"
+
+[tool.ruff]
+line-length = 88
+target-version = "py311"
+
+[tool.ruff.format]
+quote-style = "preserve"
+
+[tool.ruff.lint]
+select = [
+    "ARG", # flake8-unused-args
+    "B",   # bugbear
+    "C4",  # flake8-comprehensions
+    "E",   # pycodestyle
+    "F",   # pyflakes
+    "FBT", # boolean trap
+    "I",   # isort
+    "INP", # implicit namespace package
+    "N",   # pep8-naming
+    "PLC", # pylint convention
+    "PLE", # pylint error
+    "PLR", # pylint refactor
+    "PLW", # pylint warning
+    "PTH", # flake8-use-pathlib
+    "SIM", # flake8-simplify
+    "UP",  # pyupgrade
+    "W",
+]
+ignore = [
+    "E501",    # line too long (conflicts with formatter)
+    "N812",    # case of import alias
+    "PLR0402", # useless import alias
+    "PLR2004", # magic number comparison
+    "PLR0913", # too many arguments
+    "PLW2901", # overwriting loop variables
+    "PLC0105", # mark variance in typevar name
+    "W191",    # tab indentation (conflicts with formatter)
+]
+
+[tool.ruff.lint.per-file-ignores]
+"__init__.py" = [
+    "F403",
+    "PLC0414", # reexporting
+]
+"docs/conf.py" = ["INP"]
+"tests/**" = ["INP"]
+
+[tool.ruff.lint.isort]
+known-third-party = ["hydra"]
+extra-standard-library = ["typing_extensions"]
+no-lines-before = ["future", "standard-library"]
+force-sort-within-sections = true
+split-on-trailing-comma = false
+
+[tool.ruff.lint.pylint]
+max-statements = 60 # default: 50
+max-branches = 13   # default: 12

hydra_qol-0.1.0/src/hydra_qol/__init__.py

@@ -0,0 +1,30 @@
+"""Quality-of-life helpers for `Hydra <https://hydra.cc>`_.
+
+The package has two parts:
+
+* :func:`register_hydra_config` and :func:`prepare_for_logging` help with setting up
+  a dataclass-based configuration (registering the schema and the config groups in
+  Hydra's ``ConfigStore``, and turning a composed config into a plain dictionary for
+  logging).
+* :func:`check_configs` and :func:`validate_configs` compose every YAML file in a config
+  directory and instantiate the config object from it, so that broken config files are
+  caught without running any experiments.
+"""
+
+from .checking import CheckResult as CheckResult
+from .checking import check_configs as check_configs
+from .checking import construct_override as construct_override
+from .checking import to_object as to_object
+from .checking import validate_configs as validate_configs
+from .formatting import prepare_for_logging as prepare_for_logging
+from .registration import register_hydra_config as register_hydra_config
+
+__all__ = [
+    "CheckResult",
+    "check_configs",
+    "construct_override",
+    "prepare_for_logging",
+    "register_hydra_config",
+    "to_object",
+    "validate_configs",
+]

hydra_qol-0.1.0/src/hydra_qol/checking.py

@@ -0,0 +1,249 @@
+"""Checking that all YAML config files in a directory are valid.
+
+YAML config files are not checked by the type checker, so if, for example, a field in
+one of the config dataclasses is renamed, a YAML file that still uses the old name would
+only fail once someone tries to use it. The functions in this module catch that without
+running any experiments: they compose every config file with Hydra (which validates keys
+and value types against the registered dataclasses) and then instantiate the main config
+object from the result.
+"""
+
+from collections.abc import Sequence
+from dataclasses import dataclass
+from pathlib import Path
+import sys
+import traceback
+from typing import Any, TextIO
+
+from hydra import compose, initialize_config_dir
+from omegaconf import DictConfig, OmegaConf, open_dict
+
+from .registration import register_hydra_config
+
+__all__ = [
+    "CheckResult",
+    "check_configs",
+    "construct_override",
+    "to_object",
+    "validate_configs",
+]
+
+_MISSING = object()
+
+
+@dataclass(frozen=True, kw_only=True)
+class CheckResult:
+    """Outcome of checking a single YAML config file."""
+
+    path: Path
+    """Path of the config file, relative to the config directory."""
+    cmdline_arg: str
+    """The command-line argument that would select this config file.
+
+    This is ``--config-name <name>`` for primary configs and ``<group>=<option>`` or
+    ``+<group>=<option>`` for config-group options.
+    """
+    error: Exception | None = None
+    """The exception that was raised while composing or instantiating the config, if
+    any."""
+    traceback: str | None = None
+    """The formatted traceback of :attr:`error`, if any."""
+
+    @property
+    def ok(self) -> bool:
+        """Whether the config file is valid."""
+        return self.error is None
+
+    @property
+    def description(self) -> str:
+        """Short, human-readable description of the config file."""
+        return f"{self.path.as_posix()} ({self.cmdline_arg})"
+
+
+def validate_configs(
+    main_cls: type,
+    groups: dict[str, dict[str, type]],
+    *,
+    config_name: str,
+    config_dir: Path | str,
+) -> list[CheckResult]:
+    """Compose and instantiate every YAML config file in ``config_dir``.
+
+    First, ``main_cls`` and ``groups`` are registered with
+    :func:`~hydra_qol.register_hydra_config` (with ``replace=True``, so that it doesn't
+    matter whether the main script already registered them). Then, every ``.yaml``/``.yml`` file below
+    ``config_dir`` is composed with Hydra: files at the top level of ``config_dir`` are
+    treated as primary configs (``--config-name <name>``), all other files are treated
+    as options of a config group (``<group>=<option>``). Finally, the composed config is
+    converted to an instance of ``main_cls`` with :func:`to_object`. Any exception
+    raised along the way is recorded in the corresponding :class:`CheckResult`.
+
+    :param main_cls: The main config class; has to be a dataclass.
+    :param groups: The config groups, in the same format as expected by
+        :func:`~hydra_qol.register_hydra_config`.
+    :param config_name: Name of the main schema. This has to match both the
+        ``schema_name`` passed to :func:`~hydra_qol.register_hydra_config` and the
+        ``config_name`` passed to ``@hydra.main()`` in the main script.
+    :param config_dir: The directory containing the YAML config files; the same
+        directory as the ``config_path`` passed to ``@hydra.main()``.
+    :returns: One :class:`CheckResult` per config file, sorted by path.
+    :raises ValueError: If the config classes themselves are malformed (see
+        :func:`~hydra_qol.register_hydra_config`).
+    """
+    config_dir = Path(config_dir).resolve()
+    register_hydra_config(main_cls, groups, schema_name=config_name, replace=True)
+
+    results: list[CheckResult] = []
+    with initialize_config_dir(config_dir=str(config_dir)):
+        # Groups that are already in the defaults list are overridden with
+        # `group=option`, all others have to be appended with `+group=option`.
+        base_cfg = compose(config_name, return_hydra_config=True)
+        groups_in_defaults = set(base_cfg.hydra.runtime.choices)
+
+        for path in sorted(config_dir.rglob("*.y*ml")):
+            # For each YAML file, we construct an override like `group=sub/config`.
+            rel_path = path.relative_to(config_dir)
+            name_parts = rel_path.with_suffix("").parts
+
+            if len(name_parts) == 1:
+                # A config at the top level is a primary config.
+                primary_config = name_parts[0]
+                overrides: list[str] = []
+                cmdline_arg = f"--config-name {primary_config}"
+            else:
+                # Any other config is an option in a config group.
+                override = construct_override(name_parts, groups_in_defaults)
+                primary_config = config_name
+                overrides = [override]
+                cmdline_arg = override
+
+            try:
+                cfg = compose(
+                    primary_config, overrides=overrides, return_hydra_config=True
+                )
+                config_obj = to_object(cfg)
+                if not isinstance(config_obj, main_cls):
+                    raise TypeError(
+                        f"Config was not instantiated as `{main_cls.__name__}`, but as "
+                        f"`{type(config_obj).__name__}`. (Does the primary config "
+                        f"inherit from `{config_name}` in its defaults list?)"
+                    )
+            except Exception as exc:
+                results.append(
+                    CheckResult(
+                        path=rel_path,
+                        cmdline_arg=cmdline_arg,
+                        error=exc,
+                        traceback=traceback.format_exc(),
+                    )
+                )
+            else:
+                results.append(CheckResult(path=rel_path, cmdline_arg=cmdline_arg))
+    return results
+
+
+def check_configs(
+    main_cls: type,
+    groups: dict[str, dict[str, type]],
+    *,
+    config_name: str,
+    config_dir: Path | str,
+    file: TextIO | None = None,
+) -> int:
+    """Check all YAML config files in ``config_dir`` and print a report.
+
+    This is a thin wrapper around :func:`validate_configs` that prints one line per
+    config file (plus the traceback for every failure) and returns an exit code, so
+    that it can be used directly in a script::
+
+        if __name__ == "__main__":
+            sys.exit(
+                check_configs(
+                    Config, CONFIG_GROUPS, config_name="main_config", config_dir="configs"
+                )
+            )
+
+    :param main_cls: The main config class; has to be a dataclass.
+    :param groups: The config groups, in the same format as expected by
+        :func:`~hydra_qol.register_hydra_config`.
+    :param config_name: Name of the main schema; see :func:`validate_configs`.
+    :param config_dir: The directory containing the YAML config files.
+    :param file: Where to print the report to; defaults to ``sys.stdout``.
+    :returns: ``0`` if all config files are valid, ``1`` otherwise.
+    """
+    out = sys.stdout if file is None else file
+    results = validate_configs(
+        main_cls, groups, config_name=config_name, config_dir=config_dir
+    )
+
+    failures = [result for result in results if not result.ok]
+    for result in results:
+        if result.ok:
+            print(f"OK    {result.description}", file=out)
+        else:
+            print(f"FAIL  {result.description}", file=out)
+            print(result.traceback, file=out)
+
+    if failures:
+        print(f"\n{len(failures)} config file(s) are invalid:", file=out)
+        for failure in failures:
+            print(f"  - {failure.description}", file=out)
+        return 1
+    print("\nAll config files are valid.", file=out)
+    return 0
+
+
+def construct_override(name_parts: Sequence[str], groups_in_defaults: set[str]) -> str:
+    """Construct the command-line override that selects a config-group option.
+
+    Groups can be nested (e.g. ``hydra/launcher``) and options can contain slashes
+    (e.g. ``experiment=cmnist/cnn``), so we pick the longest known group that is a
+    prefix of the path and fall back to the top-level directory.
+
+    :param name_parts: The parts of the path of the config file, relative to the config
+        directory and without the file extension; e.g. ``("hydra", "launcher", "slurm")``
+        for ``configs/hydra/launcher/slurm.yaml``.
+    :param groups_in_defaults: The groups that are already in the defaults list. Options
+        of these groups can be selected with ``group=option``; all other groups have to
+        be added with ``+group=option``.
+    :returns: The override string, e.g. ``"hydra/launcher=slurm"`` or ``"+opt=adamw"``.
+    """
+    split = next(
+        (
+            i
+            for i in range(len(name_parts) - 1, 0, -1)
+            if "/".join(name_parts[:i]) in groups_in_defaults
+        ),
+        1,
+    )
+    group = "/".join(name_parts[:split])
+    option = "/".join(name_parts[split:])
+    prefix = "" if group in groups_in_defaults else "+"
+    return f"{prefix}{group}={option}"
+
+
+def to_object(cfg: DictConfig) -> Any:
+    """Instantiate the config object from a composed config.
+
+    This mimics what ``@hydra.main()`` does before calling the decorated function
+    (removing the ``hydra`` node) and then calls ``OmegaConf.to_object()``. In addition,
+    the keys listed under ``hydra.sweeper.params`` are checked for existence, because
+    they are just strings in the sweeper config and would otherwise only fail once a
+    sweep is started.
+
+    :param cfg: A config as returned by ``compose(..., return_hydra_config=True)``.
+    :returns: The instantiated config object (an instance of the registered schema
+        class, if the config was composed from it).
+    :raises KeyError: If a key in ``hydra.sweeper.params`` does not exist in the config.
+    """
+    # Keys that are swept over by the sweeper are just strings in the sweeper config,
+    # so we check here that they actually exist in the config.
+    if (params := OmegaConf.select(cfg, "hydra.sweeper.params")) is not None:
+        for key in params:
+            if OmegaConf.select(cfg, key, default=_MISSING) is _MISSING:
+                raise KeyError(f"Swept-over key '{key}' does not exist in the config.")
+
+    # Remove the hydra node (as `@hydra.main` does) and instantiate the dataclasses.
+    with open_dict(cfg):
+        del cfg["hydra"]
+    return OmegaConf.to_object(cfg)

hydra_qol-0.1.0/src/hydra_qol/formatting.py

@@ -0,0 +1,53 @@
+"""Turning a composed Hydra config into something that is nice to log."""
+
+from typing import Any, cast
+
+from omegaconf import DictConfig, OmegaConf
+
+__all__ = ["prepare_for_logging"]
+
+
+def prepare_for_logging(
+    hydra_config: DictConfig, *, enum_to_str: bool = True
+) -> dict[str, Any]:
+    """Take a Hydra config and make it prettier for logging.
+
+    Things this function does: turn enums into strings, resolve any interpolations, and
+    mark subconfigs with their type. The last point is the main reason to use this
+    function: if an entry of the config is a config group with several options (say, a
+    ``model`` entry that can be ``fcn`` or ``cnn``), the key of that entry in the
+    returned dictionary becomes ``"model/FcnFactory"`` or ``"model/SimpleCNNFactory"``,
+    so that the chosen option is visible in the logs.
+
+    :param hydra_config: The config object as received by the function decorated with
+        ``@hydra.main()`` (or as returned by :func:`hydra.compose`).
+    :param enum_to_str: Whether to convert enum values to strings (their ``name``).
+    :returns: A plain (nested) dictionary with resolved values.
+    :raises omegaconf.MissingMandatoryValue: If the config contains an entry that is
+        still ``MISSING`` (``???``).
+
+    :example:
+        .. code-block:: python
+
+            @hydra.main(config_path="configs", config_name="main_config")
+            def main(hydra_config: DictConfig) -> None:
+                config_for_logging = prepare_for_logging(hydra_config)
+                wandb.init(config=config_for_logging)
+    """
+    raw_config = OmegaConf.to_container(
+        hydra_config, throw_on_missing=True, enum_to_str=enum_to_str, resolve=True
+    )
+    assert isinstance(raw_config, dict)
+    raw_config = cast(dict[str, Any], raw_config)
+    return {
+        f"{key}/{_type_name(dict_)}"
+        if isinstance(dict_ := hydra_config[key], DictConfig)
+        else key: value
+        for key, value in raw_config.items()
+    }
+
+
+def _type_name(cfg: DictConfig) -> str:
+    """Name of the dataclass backing a config node (or of the node itself if untyped)."""
+    typ = OmegaConf.get_type(cfg)
+    return str(typ.__name__) if typ is not None else type(cfg).__name__

hydra_qol-0.1.0/src/hydra_qol/registration.py

@@ -0,0 +1,163 @@
+"""Registering dataclass-based configs with Hydra's ``ConfigStore``."""
+
+import dataclasses
+from dataclasses import MISSING, is_dataclass
+from typing import Any, Final, get_args, get_type_hints
+
+from hydra.core.config_store import ConfigStore
+
+__all__ = ["register_hydra_config"]
+
+_NEED: Final = "there should be"
+_IF: Final = "if an entry has"
+
+
+def register_hydra_config(
+    main_cls: type,
+    groups: dict[str, dict[str, type]],
+    schema_name: str = "config_schema",
+    *,
+    replace: bool = False,
+) -> None:
+    """Check the given config classes and store everything in Hydra's ``ConfigStore``.
+
+    This function performs two tasks: 1) make the necessary calls to ``ConfigStore``
+    and 2) run some checks over the given config classes and, if there are problems,
+    try to give a nice error message.
+
+    The checks are based on the following rules:
+
+    * An entry of type ``Any`` has to have registered variants (an entry in ``groups``)
+      and may not have a default value.
+    * An entry whose type is a dataclass and which has no default value has to have
+      registered variants, and all variants have to be subclasses of the entry's type.
+    * An entry whose type is a dataclass and which has a default value may not have
+      registered variants.
+    * An entry with registered variants has to have a dataclass type or ``Any``
+      (unions of dataclasses are not supported by Hydra).
+    * Variants may not have generic base classes.
+
+    :param main_cls: The main config class; has to be a dataclass.
+    :param groups: A dictionary that defines all the variants. The keys of the top level
+        of the dictionary should correspond to the group names (which are also the
+        names of the entries in ``main_cls``), and the keys in the nested dictionaries
+        should correspond to the names of the options.
+    :param schema_name: Name under which the main schema is stored. This name has to
+        be passed as ``config_name`` to ``@hydra.main()`` (or it has to appear in the
+        defaults list of a YAML file that is used as the primary config).
+    :param replace: What to do if a config with the same name is already registered in
+        the ``ConfigStore`` (this happens, for example, if this function is called
+        twice). ``False`` (the default) raises a :class:`ValueError`, ``True`` replaces
+        the existing config silently. For a normal Hydra app, the default is the right
+        choice, because a collision usually means that something is registered twice by
+        accident.
+    :raises ValueError: If the config is malformed in some way, or on a collision
+        with ``replace=False``.
+    :raises RuntimeError: If Hydra itself is throwing an error.
+
+    :example:
+        .. code-block:: python
+
+            @dataclass
+            class DataModule:
+                root: Path = Path()
+
+            @dataclass
+            class LinearModel:
+                dim: int = 256
+
+            @dataclass
+            class CNNModel:
+                kernel: int = 3
+
+            @dataclass
+            class Config:
+                dm: DataModule = field(default_factory=DataModule)
+                model: Any
+
+            groups = {"model": {"linear": LinearModel, "cnn": CNNModel}}
+            register_hydra_config(Config, groups, schema_name="main_config")
+    """
+    assert isinstance(main_cls, type), "`main_cls` has to be a type."
+    if not is_dataclass(main_cls):
+        raise ValueError(f"The config class {main_cls.__name__} should be a dataclass.")
+    entries = dataclasses.fields(main_cls)
+    try:
+        types = get_type_hints(main_cls)
+    except NameError as exc:
+        raise ValueError(
+            f"Can't resolve type hints from the config class: `{main_cls.__name__}`."
+        ) from exc
+
+    for entry in entries:
+        has_default = (
+            entry.default is not MISSING or entry.default_factory is not MISSING
+        )
+        _check_entry(
+            entry.name, types[entry.name], has_default=has_default, groups=groups
+        )
+
+    cs = ConfigStore.instance()
+    cs.store(node=main_cls, name=schema_name, replace=replace)
+    for group, variants in groups.items():
+        for var_name, var_type in variants.items():
+            bases = getattr(var_type, "__orig_bases__", None)
+            if bases is not None and len(bases) > 0 and len(get_args(bases[0])) > 0:
+                raise ValueError(
+                    f"Can't register a dataclass with generic base class: `{var_type.__name__}`"
+                    f" with base class `{bases[0].__name__}`."
+                )
+            try:
+                cs.store(node=var_type, name=var_name, group=group, replace=replace)
+            except ValueError:
+                # A collision with `replace=False`; the message is already descriptive.
+                raise
+            except Exception as exc:
+                raise RuntimeError(
+                    f"{main_cls=}, {var_type=}, {var_name=}, {group=}"
+                ) from exc
+
+
+def _check_entry(
+    name: str, typ: Any, *, has_default: bool, groups: dict[str, dict[str, type]]
+) -> None:
+    """Check a single field of the main config class against the registered variants."""
+    group = groups.get(name)
+    if typ == Any:
+        if group is None:
+            raise ValueError(f"{_IF} type `Any`, {_NEED} variants: `{name}`")
+        for var_name, var_class in group.items():
+            if not is_dataclass(var_class):
+                raise ValueError(
+                    f"All variants should be dataclasses: type `{var_class.__name__}` "
+                    f"of variant `{name}={var_name}` is not a dataclass."
+                )
+        if has_default:
+            raise ValueError(f"{_IF} type `Any`, {_NEED} no default value: `{name}`")
+    elif is_dataclass(typ):
+        if has_default:
+            if group is not None:
+                raise ValueError(
+                    f"Can't have both a default value and variants: `{name}`."
+                )
+        elif group is not None:
+            for var_name, var_class in group.items():
+                if not issubclass(var_class, typ):
+                    raise ValueError(
+                        f"All variants should be subclasses of their entry's type: type"
+                        f" `{var_class.__name__}` of variant `{name}={var_name}` "
+                        f"is not a subclass of `{typ.__name__}`."
+                    )
+        else:
+            raise ValueError(
+                f"{_IF} a dataclass type, "
+                f"{_NEED} a default value or registered variants: `{name}`. "
+                "You can specify a default value with `field(default_factory=...)`."
+            )
+    elif group is not None:
+        raise ValueError(
+            f"Entry `{name}` has registered variants, but its type annotation, "
+            f"`{getattr(typ, '__name__', str(typ))}`, is not a dataclass. "
+            "(Note that unions of dataclasses are not allowed either.) "
+            "You can always use `Any` for the type annotation."
+        )