Added command line option to lint the configuration setup

[yngve-sk]

Issue
Resolves #5248

Approach
Added command line option ert lint which just produces errors and warnings from the configuration file:

Pre review checklist

• Added appropriate release note label
• PR title captures the intent of the changes, and is fitting for release notes.
• Commit history is consistent and clean, in line with the contribution guidelines.
• Updated documentation
• Ensured new behaviour is tested

Adding labels helps the maintainers when writing release notes. This is the list of release note labels.

[codecov-commenter]

Codecov Report

Merging #5249 (fe69957) into main (abd5035) will increase coverage by 0.03%.
The diff coverage is 82.01%.

@@            Coverage Diff             @@
##             main    #5249      +/-   ##
==========================================
+ Coverage   73.20%   73.23%   +0.03%     
==========================================
  Files         391      395       +4     
  Lines       26946    27100     +154     
  Branches     1965     1965              
==========================================
+ Hits        19725    19846     +121     
- Misses       6657     6690      +33     
  Partials      564      564              

Impacted Files	Coverage Δ
src/ert/parsing/config_linting.py	0.00% <0.00%> (ø)
src/ert/__main__.py	78.73% <50.00%> (-0.20%)	⬇️
src/ert/parsing/error_info.py	71.42% <71.42%> (ø)
src/ert/parsing/context_values.py	80.39% <80.39%> (ø)
src/ert/parsing/config_errors.py	88.88% <89.47%> (-11.12%)	⬇️
src/ert/_c_wrappers/config/config_parser.py	94.59% <100.00%> (+0.07%)	⬆️
src/ert/_c_wrappers/enkf/enkf_obs.py	87.50% <100.00%> (+0.12%)	⬆️
src/ert/_c_wrappers/enkf/ensemble_config.py	96.23% <100.00%> (+0.27%)	⬆️
src/ert/parsing/config_keywords.py	99.33% <100.00%> (+0.04%)	⬆️
src/ert/parsing/file_context_token.py	100.00% <100.00%> (ø)
... and 2 more

... and 18 files with indirect coverage changes

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

[eivindjahren]

This is a good direction. I commented on some smaller issues. Generally I would like to see more tests as there is a lot of new functionality here. As for the general approach to the parser module, a second opinion by @mortalisk would be good.

[eivindjahren]

Need to annotate this as errors: List[Union[ErrorInfo, ConfigValidationError]] = []

[eivindjahren]

This could return args[0] with an error in the errors list coming from token_to_value_with_context.

[yngve-sk]

I think in case here it makes sense to check for errors before doing the return statement

[mortalisk]

by setting "ert" as the value to NUM_REALIZATIONS I got this. a repetition of the same error.

  * 'NUM_REALIZATIONS' must have an integer value as argument 1 at line 11, column 18-21
  * NUM_REALIZATIONS must have at least 1 arguments at line 11, column 1-17;Parsing config file `poly.ert` resulted in the errors: 
  * NUM_REALIZATIONS must be set. at line None, column None-None
  * NUM_REALIZATIONS must be set. at line None, column None-None

[yngve-sk]

by setting "ert" as the value to NUM_REALIZATIONS I got this. a repetition of the same error.

  * 'NUM_REALIZATIONS' must have an integer value as argument 1 at line 11, column 18-21
  * NUM_REALIZATIONS must have at least 1 arguments at line 11, column 1-17;Parsing config file `poly.ert` resulted in the errors: 
  * NUM_REALIZATIONS must be set. at line None, column None-None
  * NUM_REALIZATIONS must be set. at line None, column None-None

Fixed w/ test & some change to control flow, it happened due to 2 issues:

(1) if a kw like NUM_REALIZATIONS is specified to "ert", it is now not added to the config_dict as it is invalid, then check_required does not find it in the config_dict and also flags it as undeclared which is not the case. Fix: have check_required take in a Set[str] of declared values, because it checks if something is declared, not if it is valid & parsed.

(2) the alias NUM_REALISATIONS / NUM_REALIZATIONS caused a duplicate check in check_required, due to this:

    ...
    for constraints in schema.values():
    ....

schema.values() returns the NUM_REALIZATIONS entry twice.
Fix: Visit each kw only once:

    visited: Set[str] = set()

    for constraints in schema.values():
        if constraints.kw in visited:
            continue

[yngve-sk]

As for use of __new__ instead of __init__ when overriding int, str, float, which are immutable classes, there was a reason:

new() is intended mainly to allow subclasses of immutable types (like int, str, or tuple) to customize instance creation. It is also commonly overridden in custom metaclasses in order to customize class creation.

So a subclass overriding the init of its immutable superclass will give an error when initialized with more arguments than that of its superclass.

For ContextBool it works because it is a hacky way of emulating bool behavior with __bool__, as it is not possible to inherit from the bool class.

[eivindjahren]

Mypy complains about a mismatch of types in self.token = token

[yngve-sk]

Oops, should be FileContextToken, fixed

[mortalisk]

Remember to squash, and tick all the boxes

[eivindjahren]

Remember to squash and merge