Skip to content

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.

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

Closed
wants to merge 2 commits into from
Closed

Modified octal_to_decimal #3243

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9b1dc8d
Added comments with some code midifications
cybov Oct 12, 2020
f01fc05
Renamed octal_to_decimal to include (.py)
cybov Oct 12, 2020
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
30 changes: 22 additions & 8 deletions conversions/octal_to_decimal → conversions/octal_to_decimal.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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):
Copy link
Member

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

Copy link
Contributor Author

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
>>> oct_to_decimal("")
Traceback (most recent call last):
...
ValueError: Empty string value was passed to the function
>>> oct_to_decimal("19")
Traceback (most recent call last):
...
ValueError: Non-octal value was passed to the function
"""
# Strip oct_string of whitespaces
Copy link
Member

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.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Ok

oct_string = str(oct_string).strip()
if not oct_string:
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
Copy link
Member

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
Copy link
Member

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.

oct_string = oct_string[1:]
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):
Copy link
Member

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.

Copy link
Contributor Author

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.

Copy link
Member

@cclauss cclauss Oct 13, 2020 •
edited
Loading

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'

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Ok

decimal_number = 0
for char in oct_string:
decimal_number = 8 * decimal_number + int(char)
if is_negative:
decimal_number = -decimal_number
return decimal_number
else:
# else raise exception
Copy link
Member

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.

raise ValueError("Non-octal value was passed to the function")
decimal_number = 0
for char in oct_string:
decimal_number = 8 * decimal_number + int(char)
if is_negative:
decimal_number = -decimal_number
return decimal_number


if __name__ == "__main__":
Expand Down