Repository navigation
Add actionable assertion messages to enums checks #158
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
joyboy-29
wants to merge
1
commit into
abhiksark:main
Choose a base branch
from
joyboy-29:main
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,4 +1,4 @@ | ||
| assert Color.RED.value == "red" | ||
| assert Color.BLUE.value == "blue" | ||
| assert favorite is Color.RED | ||
| assert Color.RED.value == "red","RED value should be 'red'" | ||
| assert Color.BLUE.value == "blue","BLUE value should be 'blue'" | ||
| assert favorite is Color.RED, "favorite should be color.RED" | ||
| print("enums1 ok") | ||
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,3 +1,3 @@ | ||
| assert [member.name for member in Status] == ["TODO", "DOING", "DONE"] | ||
| assert [member.value for member in Status] == [1, 2, 3] | ||
| assert [member.name for member in Status] == ["TODO", "DOING", "DONE"], "status member names should be TODO, DOING, DONE in order" | ||
| assert [member.value for member in Status] == [1, 2, 3], "status member values should be 1,2,3 in order" | ||
| print("enums2 ok") |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,3 +1,3 @@ | ||
| assert selected_name == "HIGH" | ||
| assert selected_value == 5 | ||
| assert selected_name == "HIGH", "selected_name should be 'HIGH" | ||
| assert selected_value == 5, "selected_value should be 5" | ||
| print("enums3 ok") |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,2 +1,2 @@ | ||
| assert size_codes == ["S", "M", "L"] | ||
| assert size_codes == ["S", "M", "L"], "size_codes should be ['S', 'M', 'L']" | ||
| print("enums4 ok") |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,4 +1,4 @@ | ||
| assert is_terminal(TicketState.OPEN) is False | ||
| assert is_terminal(TicketState.CLOSED) is True | ||
| assert is_terminal(TicketState.CANCELLED) is True | ||
| assert is_terminal(TicketState.OPEN) is False, "OPEN should not be terminal" | ||
| assert is_terminal(TicketState.CLOSED) is True, "CLOSED should be terminal" | ||
| assert is_terminal(TicketState.CANCELLED) is True, "CANCELLED should be terminal" | ||
| print("enums5 ok") |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,3 +1,3 @@ | ||
| assert Direction.NORTH.delta() == (0, -1) | ||
| assert Direction.EAST.delta() == (1, 0) | ||
| assert Direction.NORTH.delta() == (0, -1), "NORTH delta should be (0, -1)" | ||
| assert Direction.EAST.delta() == (1, 0), "EAST delta should be(1, 0)" | ||
| print("enums6 ok") |
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🎯 Functional Correctness | 🟡 Minor | ⚡ Quick win
Use the enum’s correct name in the failure message.
The assertion uses
Color.RED, but the message sayscolor.RED. A learner may search for the wrong, case-sensitive identifier. Change the message toColor.RED.As per coding guidelines, “Checks must use bare assertions with actionable, beginner-facing messages.”
🧰 Tools
🪛 Ruff (0.16.8)
[error] 3-3: Undefined name
favorite(F821)
[error] 3-3: Undefined name
Color(F821)
🤖 Prompt for AI Agents
Source: Coding guidelines