Add a dummy vieweras a minimal implementation example #16
Conversation
This file contains hidden or 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
There was a problem hiding this comment.
Pull Request Overview
This PR introduces a dummy viewer implementation to serve as an example and exercise the API assumptions detailed in issue #12. Key changes include:
- Importing and using the dummy viewer in tests
- Adding a new test function to verify the dummy viewer instance
- Creating a test case class that inherits from the widget API test suite
| @@ -27,3 +28,12 @@ def test_api_test_class_completeness(): | |||
| "ImageWidgetAPITest does not access these attributes/methods:\n " | |||
| f"{"\n".join(attr for attr, present in zip(required_attributes, attr_present) if not present)}. " | |||
| ) | |||
|
|
|||
|
|
|||
| def test_instance(): | |||
There was a problem hiding this comment.
[nitpick] Consider adding a docstring to the test_instance function to clarify its purpose for future maintainers.
Suggested change
| def test_instance(): | |
| def test_instance(): | |
| """ | |
| Test that an instance of ImageViewer conforms to the ImageViewerInterface. | |
| """ |
Copilot uses AI. Check for mistakes.
| assert isinstance(image, ImageViewerInterface) | ||
|
|
||
|
|
||
| class TestDummyViewer(ImageWidgetAPITest): |
There was a problem hiding this comment.
[nitpick] Adding a brief docstring for TestDummyViewer could help clarify its role and intended usage, improving future maintainability.
Suggested change
| class TestDummyViewer(ImageWidgetAPITest): | |
| class TestDummyViewer(ImageWidgetAPITest): | |
| """ | |
| A test implementation of ImageWidgetAPITest that uses the ImageViewer | |
| class as the widget under test. | |
| """ |
Copilot uses AI. Check for mistakes.
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 main reason for adding this -- and I don't really care if it stays in this package long-term -- is that it helps expose some of the unstated assumptions in the API (like interactions between the states of different settings, see #12) and provides, in the test file, an example of how downstream classes would demonstrate API compatibility.