Improve overall commands handling of envconfig

[tomschr]

Some of our docbuild commands checks for an empty .envconfig like this:

if context.envconfig is None:
        raise ValueError("No envconfig found in context.")

This is futile now and a leftover as it's all covered by Pydantic.

This PR changes:

• Removed these futile if-clauses in src/docbuild/cli/cmd_c14n/* files.
• Introduced a cast (env = cast(EnvConfig, context.envconfig)) to make editor not complain. => Change DocBuildContext.envconfig to be a EnvConfig object and not a dict.
• Adjusted the test cases to make dummy EnvConfig objects and not dicts to simulate the behavior of the model.
• Realized that ManagedGitRepo should allow str and Repo in __init__ to pass any of the two objects without taking care. This make it easier when called. Raise a TypeError when there is a different type.
• Removed obsolete test_process_no_envconfig test function as there is no need to test this anymore when Pydantic already validates it. Failed configs are tested elsewhere.

[github-actions]

Coverage Report

For commit d3e2bca

Click to expand Coverage Report

  Name                                           Stmts   Miss Branch BrPart  Cover
  --------------------------------------------------------------------------------
+ src/docbuild/cli/cmd_check/process.py             58      0     22      1  98.8%
+ src/docbuild/utils/pidlock.py                     79      1     14      1  97.8%
+ src/docbuild/config/xml/stitch.py                 48      1     12      1  96.7%
+ src/docbuild/cli/cmd_validate/process.py         178      5     52      4  96.1%
+ src/docbuild/cli/callback.py                      35      0     10      2  95.6%
+ src/docbuild/cli/cmd_metadata/metaprocess.py     168     10     42      7  91.9%
- src/docbuild/cli/cmd_config/__init__.py            9      1      0      0  88.9%
- src/docbuild/cli/cmd_cli.py                       86     11      6      3  84.8%
- src/docbuild/cli/cmd_check/__init__.py            18      5      2      0  65.0%
- src/docbuild/cli/cmd_build/__init__.py            13      5      0      0  61.5%
- src/docbuild/cli/cmd_metadata/__init__.py         27     10      2      0  58.6%
- src/docbuild/cli/cmd_config/environment.py        11      6      2      0  38.5%
  --------------------------------------------------------------------------------
+ TOTAL                                           2734     55    624     19  97.6%
  
  47 files skipped due to complete coverage.

[sushant-suse]

Some of our docbuild commands checks for an empty .envconfig like this:

if context.envconfig is None:
        raise ValueError("No envconfig found in context.")

This is futile now and a leftover as it's all covered by Pydantic.

This PR changes:

• Removed these futile if-clauses in src/docbuild/cli/cmd_c14n/* files.
• Introduced a cast (env = cast(EnvConfig, context.envconfig)) to make editor not complain.
• Adjusted the test cases to make dummy EnvConfig objects and not dicts to simulate the behavior of the model.
• Realized that ManagedGitRepo should allow str and Repo in __init__ to pass any of the two objects without taking care. This make it easier when called. Raise a TypeError when there is a different type.
• Removed obsolete test_process_no_envconfig test function as there is no need to test this anymore when Pydantic already validates it. Failed configs are tested elsewhere.

Hi @tomschr, thanks a lot for the awesome work. Much appreciated!

This is a fantastic cleanup. By using our move to Pydantic, you've significantly reduced the 'noise' of defensive coding across the CLI commands.

The code is much leaner and follows better DevSecOps and Pythonic practices. LGTM, Approved.

One small request: could you please add a fragment file for example:

Streamlined CLI subcommands by removing redundant environment configuration checks and implementing strict typing with EnvConfig models. Updated ManagedGitRepo to support both string and Repo model initialization.

[tomschr]

One small request: could you please add a fragment file

This is added in commit c1366ea

[tomschr]

I also removed the cast(EnvConfig, ...) part as the envconfig attribute is now a EnvConfig object, not a dict anymore. This makes things better for our editors.

[sushant-suse]

I also removed the cast(EnvConfig, ...) part as the envconfig attribute is now a EnvConfig object, not a dict anymore. This makes things better for our editors.

Awesome. Please merge it.