Refactor the config_parser into multiple composable components #24
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
The config_parser.py was a file that contained all the classes and methods needed to parse the yaml config used to configure the webhook. Its purpose was to read the yaml file and generate objects that the core of the app can manage and understand. The problem with the old approach is that it was difficult to support multiple formats of the yaml config file. Ideally, if we decide to modify the format of the yaml config file, the app should be able to handle both old and new version (backward compatibility is always welcome for end users). This commit relocates the classes defined in config_parser.py into different files within the config_parser directory. Apart from that, now each subpiece of the yaml file is parsed by an interface. This interface can have different implementations in case we modify the format of the underlying yaml. Then, the GenericWebhookConfigManifest class has a method to instantiate the different subparsers according to the schema version of the yaml file.
jordipiqueselles
force-pushed
the
jordi/refactor-config-parser
branch
from
7064c3d
to
e2d1908
Compare
jordipiqueselles
added
enhancement
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.
The config_parser.py was a file that contained all the classes and methods needed to parse the yaml config used to configure the webhook. Its purpose was to read the yaml file and generate objects that the core of the app can manage and understand.
The problem with the old approach is that it was difficult to support multiple formats of the yaml config file. Ideally, if we decide to modify the format of the yaml config file, the app should be able to handle both old and new version (backward compatibility is always welcome for end users).
This commit relocates the classes defined in config_parser.py into different files within the config_parser directory. Apart from that, now each subpiece of the yaml file is parsed by an interface. This interface can have different implementations in case we modify the format of the underlying yaml. Then, the GenericWebhookConfigManifest class has a method to instantiate the different subparsers according to the schema version of the yaml file.