Refactor to split reporter backends and outputs. #3
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
jezdez
commented
Jun 6, 2024
Comment on lines
-216
to
235
| class ReporterHandlerBase(ABC): | ||
| class ReporterRendererBase(ABC): | ||
| """ | ||
| Base class for all reporter handlers. | ||
| Base class for all reporter renderers. | ||
| """ | ||
|
|
||
| def render(self, data: Any, **kwargs) -> str: | ||
| def default(self, data: Any, **kwargs) -> str: | ||
| """ | ||
| How to render the data by default | ||
| """ | ||
| return str(data) | ||
|
|
||
| @abstractmethod | ||
| def detail_view(self, data: dict[str, str | int | bool], **kwargs) -> str: | ||
| def table(self, data: Any, **kwargs) -> str: | ||
| """ | ||
| Render the output in a "tabular" format. | ||
| Renders the data in a tabular format. | ||
| """ | ||
|
|
||
| @abstractmethod | ||
| def envs_list(self, data, **kwargs) -> str: | ||
| def list(self, data: Any, **kwargs) -> str: | ||
| """ | ||
| Render a list of environments | ||
| Renders the data in a plain list | ||
| """ |
There was a problem hiding this comment.
This is a key change in how it handles render styles, should give us some flexibility for future expansion.
jezdez
commented
Jun 6, 2024
| """ | ||
|
|
||
| name: str | ||
| description: str | ||
| handler: ReporterHandlerBase | ||
| renderer: ReporterRendererBase |
jezdez
commented
Jun 6, 2024
| """ | ||
|
|
||
| name: str | ||
| description: str | ||
| get_output_io: Callable[[], ContextManager] | ||
| stream: Callable[[], ContextManager] |
There was a problem hiding this comment.
the output has a stream to write to
|
will take a look at the test failures tomorrow |
3 tasks
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.
This is my suggestion to tweak the naming and implementation complexity of this new exciting feature Xrefs conda#13868