Skip to content
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.

Sign up for GitHub

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

Jump to bottom

#126: fix MakeNote.key_to_log not being updated. #129

Merged
merged 1 commit into from
Feb 20, 2024
+3 −0
Merged

#126: fix MakeNote.key_to_log not being updated. #129

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions screenpy/actions/make_note.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,7 @@ class MakeNote:
"""

key: str | None
key_to_log: str | None
question: T_Q

@classmethod
Expand All @@ -56,6 +57,7 @@ def of_the(cls, question: T_Q) -> Self:
def as_(self, key: str) -> Self:
"""Set the key to use to recall this noted value."""
self.key = key
self.key_to_log = represent_prop(key)
Copy link
Contributor

@bandophahita bandophahita Feb 20, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This make sense, but I'm starting to wonder if we should consider a wholesale update to any action similar to this; I think we ought to make key_to_log a property. (in a future PR)

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That's a good call, and yeah let's make that happen soon.

return self

def describe(self) -> str:
Expand Down
1 change: 1 addition & 0 deletions tests/test_actions.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -384,6 +384,7 @@ def test_key_value_set(self) -> None:

assert mn.question == test_question
assert mn.key == test_key
assert mn.key_to_log == f"'{test_key}'"
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this is the only test we need, as our typehints try to tell users to only pass strs to MakeNote.as_. If i add a test for passing a non-string to as_, MyPy complains about it. :P

This test shows that using .as_ updates key_to_log at least.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There isn't a test to prove MakeNote(question, key) displays the right thing, but I think if we're going to eventually make key_to_log into a property, we can address the problem there.


def test_answers_question(self, Tester: Actor) -> None:
mock_question = FakeQuestion()
Expand Down
Loading