Add attribute 'step' to FloatField.

[Jacob Rief]

If someone wants to use the step attribute as provided by the HTML field
<input type="number" ...> , she/he has to specify that using for instance
FloatField(widget=NumberInput(attrs={'step': 0.5})).

Since the HTML standard offers a step attribute on input fields of type="number",
this feature shall be reflected by Django's FloatField and optionally DecimalField,
rather than having to parametrize the widget.

Min- and max-values are already supported by the FloatField, so the step-value
would make sense here as well. It furthermore would require to revalidate the
step-value by Django's Form validation, rather than by HTML alone.

Patch: ​https://github.com/django/django/pull/14162

[Markus Holtermann]

Thank you. Sounds like a perfectly valid use case.

[Tim Graham]

​django-developers discussion

[Kapil Bansal]

​PR

[Adam Johnson]

On ​the forum, Kapil wrote:

Hi,
I was working on ticket 32559 to add step in FloatField but how to write validation check for this.
Due to python floating point issues, I am not able to validate whether field value is of given step_size or not

The loss of precision in floating points is a real issue. The normal way to validate would be to use the modulo operator to check there is no remainder after dividing by the step, but this isn't possible in floating points with common decimal steps like 0.1:

>>> step = 0.1
>>> 1 % step == 0
False
>>> 1 % step
0.09999999999999995

This problem cannot be solved for FloatField - I suggest we move the ticket to modify DecimalField, as Decimal objects do not have the same problem:

>>> from decimal import Decimal
>>> step = Decimal('0.1')
>>> Decimal(1) % step == 0
True
>>> Decimal(1) % step
Decimal('0.0')

We'd want to enforce that step is given as a Decimal.

The float problem can also occur when constructing a Decimal from a float:

>>> Decimal(0.1)
Decimal('0.1000000000000000055511151231257827021181583404541015625')

Perhaps we should have a check that the given step does not have more than 10 digits after the decimal point?

[Kapil Bansal]

Hi,
I got a reply on mailing list to use math.isclose function. Pull Request is already opened to be reviewed

[Jacob Rief]

I reviewed that pull request and after some testing I came to the conclusion, that math.isclose with a tolerance of 1e-9 is the best solution to fix the floating point rounding errors. All other approaches did not work properly or were far too complicated.

[Jacob Rief]

Reclaiming ticket because of missing progress.

A new pull request is here: ​https://github.com/django/django/pull/14532
This adds the missing documentation and release note for this feature.

[Carlton Gibson]

Current PR removes the default step="any" which is a problem.

Comment from PR:

This introduces a regression from 7ec2a21be15af5b2c7513482c3bcfdd1e12782ed.

We need a selenium test to cover it, but if I create an <input type="number" /> without the step specified at all, I can't enter a non-integer value, such as 0.5 without triggering the browser validation (Enter a valid value).

This ties in with ​MDN docs for step:

The default stepping value for number inputs is 1, allowing only integers to be entered…

[Jacob Rief]

I re-added the attribute step="any" to the FloatField . However, I don't know where to add a Selenium test for check this.

[Carlton Gibson]

Thanks Jacob! I'll take another look.

[Mariusz Felisiak <felisiak.mariusz@…>]

In 4b8e9492:

Refs #32559 -- Added selenium test for FloatField client-side validation.

step="any" is required for non-integer values. See:
​https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input/number#step

Covers behaviour added in 7ec2a21be15af5b2c7513482c3bcfdd1e12782ed.

[Jacob Rief]

step="any" is required for non-integer values.

shall I add this? According to the Mozilla developer docs, the step is not mandatory and default to 1 for number input fields, so I'm unsure what to change here.

[Carlton Gibson]

Hey Jacob. See ​my comment on the PR for outstanding issues. Specifically, the docs need versionchanged/versionadded annotations, and (more) the new validator needs tests, matching those for the other validator classes.

[Jacob Rief]

• Added versionadded annotations to the docs.
• Added tests for new validator StepValueValidator.
• Fixed all annotations from black and flake8.

[Carlton Gibson <carlton@…>]

In 3a82b5f6:

Fixed #32559 -- Added 'step_size’ to numeric form fields.

Co-authored-by: Jacob Rief <jacob.rief@…>