Exception cleanup #895
Merged
Exception cleanup #895
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Drop various uses of format that can be replaced with f-strings when building exception messages. Signed-off-by: James Knight <james.d.knight@live.com>
Moving the exception `ConfluenceConfigurationError` into its own exception file under `config`. This is to prepare for updates to configuration exceptions, where various exception cases will have their own class instead of custom messages defined in scenarios like the configuration check call. Signed-off-by: James Knight <james.d.knight@live.com>
Renaming the exception `ConfluenceConfigurationError` into a smaller `ConfluenceConfigError` name; still conveys the meaning at a much smaller text length. Also follows Sphinx's `ConfigError` name. Signed-off-by: James Knight <james.d.knight@live.com>
Updating the configuration checks logic to raise specific configuration exception cases instead of a generic configuration error. This is to help avoid rendering content of any string literals in the stack trace outside the message itself (EM101). In addition, the exception messages built have been updated to take advantage of f-strings (to avoid the need to format these messages), as well as performing proper exception chaining. Signed-off-by: James Knight <james.d.knight@live.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
update exceptions to use f-strings
Drop various uses of format that can be replaced with f-strings when building exception messages.
move confluence-specific config exception into a new file
Moving the exception
ConfluenceConfigurationErrorinto its own exception file underconfig. This is to prepare for updates to configuration exceptions, where various exception cases will have their own class instead of custom messages defined in scenarios like the configuration check call.rename confluence-specific config exception
Renaming the exception
ConfluenceConfigurationErrorinto a smallerConfluenceConfigErrorname; still conveys the meaning at a much smaller text length. Also follows Sphinx'sConfigErrorname.build configuration-specific exceptions
Updating the configuration checks logic to raise specific configuration exception cases instead of a generic configuration error. This is to help avoid rendering content of any string literals in the stack trace outside the message itself (EM101).
In addition, the exception messages built have been updated to take advantage of f-strings (to avoid the need to format these messages), as well as performing proper exception chaining.