vdk-control-cli: refactor output printing with printer class #1819
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
antoniivanov
force-pushed
the
person/aivanov/vdk-control-cli-refactor
branch
2 times, most recently
from
9d6b2c4
to
8229ee8
Compare
gageorgiev
approved these changes
Apr 3, 2023
antoniivanov
force-pushed
the
person/aivanov/vdk-control-cli-refactor
branch
2 times, most recently
from
88a56c1
to
9328713
Compare
Currently if a command needs to print similar types of data in multiple places or formats, the developer would have to duplicate the printing code for each location or format. This would lead to a lot of redundant code, which is difficult to maintain and prone to errors. This is making the code more "DRY". Also, users and devs are limited to a fixed set of output formats provided by the application. This could be restricting if the devs needs to print data in a format that is not supported by the application. E.g I wanted to add `rich` or `streamlit` type potentially. By introducing support for customizable output formats with the Printer class and related functions, users can define their own output formats and register them with the application using the printer decorator. This allows users to print data in any format they desire, providing greater flexibility and customization options. Testing Done: unit tests (incl new ones) Signed-off-by: Antoni Ivanov <aivanov@vmware.com>
antoniivanov
force-pushed
the
person/aivanov/vdk-control-cli-refactor
branch
from
9328713
to
ea36e8c
Compare
antoniivanov
added a commit
that referenced
this pull request
Apr 6, 2023
Adopting the new output_printer to print all outputs of all commands that were introduced in #1819 Some commands required small refactoring - to make some fields private. Testing Done: existing tests to verify no regressions Signed-off-by: Antoni Ivanov <aivanov@vmware.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.
Currently, if a command needs to print similar types of data in multiple places
or formats, the developer would have to duplicate the printing code for each location or format. This would lead to a lot of redundant code, which is difficult to maintain and prone to errors. This is making the code more "DRY".
Also, users and devs are limited to a fixed set of output formats provided by the application. This could be restricting if the devs needs to print data in a format that is not supported by the application. E.g I wanted to add
richorstreamlittype potentially.By introducing support for customizable output formats with the Printer class and related functions, users can define their own output formats and register them with the application using the printer decorator. This allows users to print data in any format they desire, providing greater flexibility and customization options.
This is of course an application of Factory and Strategy design patterns.
This is adopted in a single command here only. In a separate PR, I will adopt this printer in the other commands.
Testing Done: unit tests (incl new ones)