-
-
Notifications
You must be signed in to change notification settings - Fork 46.6k
Modified octal_to_decimal #3243
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
Conversation
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.
I am not seeing an improvement in these changes.
@@ -9,26 +9,40 @@ def oct_to_decimal(oct_string: str) -> int: | |||
>>> oct_to_decimal("-45") | |||
-37 | |||
>>> oct_to_decimal("2-0Fm") | |||
Traceback (most recent call last): |
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.
These are optional and do not add much value
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.
I added them because the doctest failed without them.
ValueError: Non-octal value was passed to the function | ||
""" | ||
# Strip oct_string of whitespaces |
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.
This comment repeats what the code says. Comments should not be about what the code is doing, but should be about why we are doing something. Why are we removing whitespace? Why are we removing the minus sign.
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.
Ok
raise ValueError("Empty string was passed to the function") | ||
raise ValueError("Empty string value was passed to the function") | ||
|
||
# Check if oct_string is a negative value |
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.
This comment repeats what the code says.
is_negative = oct_string[0] == "-" | ||
if is_negative: | ||
# Remove (-) from oct_string |
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.
This comment repeats what the code says.
if not all(0 <= int(char) <= 7 for char in oct_string): | ||
|
||
# check if oct_string is an octal value and convert | ||
if oct_string.isdecimal() and all(0 <= int(char) <= 7 for char in oct_string): |
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.
These are redundant tests. The first one cannon pass if the second one does not pass. The original formulation is more consise.
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.
Thanks for reviewing. In the original, int(char) in the iterable passed to the all() function returns error that is not handled by the ValueError raised when char is not an integer value. It's why I modified it so.
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.
A ValueError is still raised. This is why I encourage doctests. It is not necessary that we raise all exceptions ourselves. It is only important that an appropriate exception is raised when garbage data is received.
>>> int('a')
Traceback (most recent call last):
File "<string>", line 1, in <module>
ValueError: invalid literal for int() with base 10: 'a'
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.
Ok
decimal_number = -decimal_number | ||
return decimal_number | ||
else: | ||
# else raise exception |
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.
This comment repeats what the code says.
Describe your change:
Add an algorithm?
Fix a bug or typo in an existing algorithm? octal_to_decimal converter #2399
Documentation change?
Checklist:
Fixes: #{$ISSUE_NO}
.