improve code readability #72
Merged
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
yedpodtrzitko
commented
Apr 27, 2024
| clear() | ||
| return -1 | ||
| # Selection ==================================================== | ||
| elif int(com[0]) > 0 and int(com[0]) <= len(choices): | ||
| elif com_name.isdigit() and 0 < int(com_name) <= len(choices): |
There was a problem hiding this comment.
here I added condition .isdigit(), otherwise it could end up with ValueError when calling int() on non-numeric string.
yedpodtrzitko
commented
Apr 27, 2024
| @@ -2625,14 +2627,14 @@ def scr_edit_entry_text(self, entry_index, field_index, allow_newlines=True, cle | |||
| self.lib.update_entry_field( | |||
| entry_index, field_index, new_content.rstrip('\n').rstrip('\r'), 'replace') | |||
|
|
|||
| def scr_list_tags(self, query: str = '', tag_ids: list[int] = [], clear_scr=True) -> None: | |||
| def scr_list_tags(self, query: str = '', tag_ids: list[int] = None, clear_scr=True) -> None: | |||
There was a problem hiding this comment.
if the empty list as a default parameter isnt intentional, then it might be causing some issues, see https://docs.python-guide.org/writing/gotchas/#mutable-default-arguments
yedpodtrzitko
commented
Apr 27, 2024
| @@ -4601,7 +4601,7 @@ def expand_collation(self, collation_entries: list[tuple[int, int]]): | |||
| for x in collation_entries]) | |||
| # self.update_thumbs() | |||
|
|
|||
| def get_frame_contents(self, index=0, query=str): | |||
| def get_frame_contents(self, index=0, query: str = None): | |||
There was a problem hiding this comment.
I assume query=str was supposed to be query:str, right? And since it's after a parameter with a default value, it needs some default value as well.
There was a problem hiding this comment.
Yes, that looks to be like the original intention. Surprised my linter didn't pick that up...
yedpodtrzitko
force-pushed
the
yed/readability
branch
from
2eb7507
to
f0f8e0e
Compare
CyanVoxel
approved these changes
Apr 27, 2024
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.
Hi,
this PR aims to simplify some pieces of code to improve readability. Beside that there's a few tiny fixes for potential bugs (see my comments on given lines)