-
-
Notifications
You must be signed in to change notification settings - Fork 29.8k
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
gh-121798: Add class method Decimal.from_number() #121801
base: main
Are you sure you want to change the base?
gh-121798: Add class method Decimal.from_number() #121801
Conversation
It is an alternate constructor which only accepts a single numeric argument. Unlike to Decimal.from_float() it accepts also Decimal. Unlike to the standard constructor, it does not accept strings and tuples.
Co-authored-by: Nice Zombies <nineteendo19d0@gmail.com>
>>> Decimal.from_number(Decimal('3.14')) # another decimal instance | ||
Decimal('3.14') | ||
""" | ||
if isinstance(number, (int, Decimal, float)): |
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.
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.
Yes, these are the only numeric types accepted by the constructor. Exact conversion from Fraction to Decimal is not possible in general case (e.g. 1/3).
Doc/library/decimal.rst
Outdated
@@ -598,6 +598,23 @@ Decimal objects | |||
|
|||
.. versionadded:: 3.1 | |||
|
|||
.. classmethod:: from_number(number) | |||
|
|||
Alternative constructor that only accepts numbers (instances of |
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.
Instead of using number
, maybe you can directly say "only accepts instances of float, int or Decimal" since otherwise people might wonder why objects implementing the Number protocol are not allowed.
By the way, this function is essentially a shortcut to avoid an if isinstance(...)
right?
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.
Done.
Yes, you can look at it from such point. If your function needs a Decimal or a number that can be converted to Decimal, it can use Decimal.from_number()
without additional type check. It will reject strings and tuples that are accepted by the constructor.
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.
+1 for the general idea. I haven't reviewed line-by-line.
It is an alternate constructor which only accepts a single numeric argument. Unlike to Decimal.from_float() it accepts also Decimal. Unlike to the standard constructor, it does not accept strings and tuples.
📚 Documentation preview 📚: https://cpython-previews--121801.org.readthedocs.build/