Be nicer about possible misconfigurations #1004
Conversation
There was a problem hiding this comment.
i like the idea behind how the details change, but i aslo beleive a larger change is necessary to do the path/version scheme handling in a better way
due to personal time constraints it may take a be a while to propperly reiterate this
thank you for getting the ball rolling and preparing this as a initial vesion
| warnings.warn( | ||
| "Expected tag_regex to contain a single match group or a group named" | ||
| " 'version' to identify the version part of any tag." | ||
| raise ValueError( |
There was a problem hiding this comment.
this one is possibly a breaking change im not sure we can integrate it off hand
| @@ -105,6 +105,9 @@ class Configuration: | |||
|
|
|||
| parent: _t.PathT | None = None | |||
|
|
|||
| def __post_init__(self) -> None: | |||
| self.tag_regex = _check_tag_regex(self.tag_regex) | |||
There was a problem hiding this comment.
taking this here without leaving it in place creates potental trouble for valies valid in config but not in the config objects
| @@ -139,13 +142,11 @@ def from_data( | |||
| given configuration data | |||
| create a config instance after validating tag regex/version class | |||
| """ | |||
| tag_regex = _check_tag_regex(data.pop("tag_regex", None)) | |||
There was a problem hiding this comment.
this check needs to say even if the validation gets more struct
|
i intend to merge this after hte next minor release as its a "breaking change" that should go in nonetheless |
Fixes #1003 by turning situations where the user might get an
AssertionErrorand turn them into descriptiveValueErrors.Additionally, tests have been added to test the behavior.
The situations fixed are (with the real-world facepalm situations I ended up in):
version_schemeandlocal_schemedon't existversion_schemeandlocal_schemedon't return anythingreturnto my custom schemetag_regexis bad, and was loaded from the configtag_regexmatched, but the version was blank