Deprecate float sizes (min_size, max_size) #1635

math2001 · 2018-10-11T00:19:32Z

It shows a deprecation warning when min_size or max_size is a float, instead of being an integer.

The tests only target "whole" float number like 5.0, and not 5.1.

I tried to find somewhere in the documentation where to mention this deprecation, but I didn't find anything... I'm not really sure if it'd be that useful anyway...

It also changes the type hints for average_size to being None instead of int.

Lastly, this broke a test with NaN values: a test (in cover/test_direct_strategies.py, at test_validates_keyword_arguments) checks a bunch of invalid arguments and asserts that they raise InvalidArgument.

One of them tests min_size as float('nan'). And this breaks because it raises a warning that it doesn't expect (the warning that this PR adds). Here's the error message

Traceback (most recent call last):                                                                                                                                                                
  File "/home/math2001/code/python/hypothesis/hypothesis-python/tests/cover/test_direct_strategies.py", line 158, in test_validates_keyword_arguments                                             
    fn(**kwargs).example()                                                                                                                                                                        
  File "/home/math2001/code/python/hypothesis/hypothesis-python/src/hypothesis/searchstrategy/strategies.py", line 304, in example                                                                
    phases=tuple(set(Phase) - {Phase.shrink}),                                                                                                                                                    
  File "/home/math2001/code/python/hypothesis/hypothesis-python/src/hypothesis/core.py", line 985, in find                                                                                        
    specifier.validate()                                                                                                                                                                          
  File "/home/math2001/code/python/hypothesis/hypothesis-python/src/hypothesis/searchstrategy/strategies.py", line 379, in validate                                                               
    self.do_validate()                                                                                                                                                                            
  File "/home/math2001/code/python/hypothesis/hypothesis-python/src/hypothesis/searchstrategy/lazy.py", line 127, in do_validate                                                                  
    w = self.wrapped_strategy                                                                                                                                                                     
  File "/home/math2001/code/python/hypothesis/hypothesis-python/src/hypothesis/searchstrategy/lazy.py", line 113, in wrapped_strategy                                                             
    *self.__args, **self.__kwargs                                                                                                                                                                 
  File "/home/math2001/code/python/hypothesis/hypothesis-python/src/hypothesis/strategies.py", line 631, in lists                                                                                 
    check_valid_sizes(min_size, average_size, max_size)                                                                                                                                           
  File "/home/math2001/code/python/hypothesis/hypothesis-python/src/hypothesis/internal/validation.py", line 156, in check_valid_sizes                                                            
    check_valid_size(min_size, 'min_size')                                                                                                                                                        
  File "/home/math2001/code/python/hypothesis/hypothesis-python/src/hypothesis/internal/validation.py", line 119, in check_valid_size                                                             
    name, value                                                                                                                                                                                   
  File "/home/math2001/code/python/hypothesis/hypothesis-python/src/hypothesis/_settings.py", line 873, in note_deprecation                                                                       
    warnings.warn(warning, stacklevel=2)                                                                                                                                                          
hypothesis.errors.HypothesisDeprecationWarning: Float size are deprecated: min_size should be an integer, got nan

So, I tried to find a way for this test to ignore the warning, without breaking all the other tests in the table.

I've tried to use @pytest.mark.filterwarnings, without success, but weirdly, a with pytest.warns clause works. I'd expect it would make sure every call would raise a warning, but instead, it seems that it just filters them out.

If you want to try it locally:

git remote add mathieu https://github.com/math2001/hypothesis
git fetch mathieu deprecate-float-sizes
git checkout deprecate-float-sizes
pytest "hypothesis-python/tests/cover/test_direct_strategies.py::test_validates_keyword_arguments"

min_size and max_size should be integers. And we only test whole float numbers, like 5.0 for example.

It use to be type: int

float size warning were breaking a test that was making sure that invalid arguments raised an InvalidArgument error.

lint and check-format tasks on travis

Zac-HD

Solid start - see comments below.

Also make sure that you mention the change of the type hints in RELEASE.rst; something like

The type hint for average_size arguments has been changed from Optional[int] to None, because non-None values are always ignored and deprecated.

I've also just done a quick check for other uses of average_size (with git grep -n "average_size="), and you could delete the use of it in docs/examples.rst. There are plenty more, but all of those uses are OK for compatibility or internal use.

hypothesis-python/tests/cover/test_direct_strategies.py

hypothesis-python/src/hypothesis/internal/validation.py

Zac-HD · 2018-10-11T01:57:17Z

hypothesis-python/src/hypothesis/internal/validation.py

+            '{} should be an integer, got {}'.format(name, value)
+        )
+    else:
+        check_type(integer_types, value)
    if value < 0:
        raise InvalidArgument(u'Invalid size %s=%r < 0' % (name, value))
    if isinstance(value, float) and math.isnan(value):


We can move this to the isinstance(value, float) clause above.

Moving it before the deprecation will also fix the failing test!

Hum... I don't know how I didn't see this... 😢 I'll make sure to read the whole function next time 👀

@Zac-HD

Thanks to @Zac-HD

hypothesis-python/src/hypothesis/internal/validation.py

Conforms to the rest of the document's style

Zac-HD

LGTM (looks good to me) 🎉

Zac-HD · 2018-10-11T05:25:12Z

And if you're looking for another (!) issue, #1600 would be a good choice - a bit more complex now that you're comfortable with the process and tests, but still fairly well defined and the code should be quite self-contained. After that it's the deep end, at least for Hypothesis issues.

math2001 · 2018-10-11T05:54:37Z

Whooo! Thank you!

I'll have a look at #1600.

math2001 added 9 commits October 11, 2018 07:33

add deprecation notice for float sizes

c7982ce

test deprecation notice for float sizes

b943f6b

add test for floats sizes deprecations

61ad711

min_size and max_size should be integers. And we only test whole float numbers, like 5.0 for example.

change type hints of average_size to None

63abdbe

It use to be type: int

add myself to the contributors list

2ddb293

add relase.txt

4033c2b

filter out deprecation warning during test

70c208e

float size warning were breaking a test that was making sure that invalid arguments raised an InvalidArgument error.

fix formatting errors

dd255da

lint and check-format tasks on travis

fix pep8 linting error

b3e63d6

Zac-HD reviewed Oct 11, 2018

View reviewed changes

math2001 added 3 commits October 11, 2018 13:34

fix max/min size valitation and roll back tests

67ea919

updated release: add type hint infos

ea34ef0

Thanks to @Zac-HD

remove use of average_size in examples

ca46708

Zac-HD reviewed Oct 11, 2018

View reviewed changes

hypothesis-python/src/hypothesis/internal/validation.py Outdated Show resolved Hide resolved

Zac-HD added the legibility make errors helpful and Hypothesis grokable label Oct 11, 2018

math2001 added 2 commits October 11, 2018 15:51

improve check_valid_size perf

480c9c7

use % instead of .format in check_valid_size

956cbc3

Conforms to the rest of the document's style

Zac-HD approved these changes Oct 11, 2018

View reviewed changes

Zac-HD merged commit 928e575 into HypothesisWorks:master Oct 11, 2018

math2001 deleted the deprecate-float-sizes branch October 11, 2018 05:52

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Deprecate float sizes (min_size, max_size) #1635

Deprecate float sizes (min_size, max_size) #1635

math2001 commented Oct 11, 2018 •

edited

Zac-HD left a comment

Zac-HD Oct 11, 2018 •

edited

math2001 Oct 11, 2018

Zac-HD left a comment

Zac-HD commented Oct 11, 2018

math2001 commented Oct 11, 2018

Deprecate float sizes (min_size, max_size) #1635

Deprecate float sizes (min_size, max_size) #1635

Conversation

math2001 commented Oct 11, 2018 • edited

Zac-HD left a comment

Choose a reason for hiding this comment

Zac-HD Oct 11, 2018 • edited

Choose a reason for hiding this comment

math2001 Oct 11, 2018

Choose a reason for hiding this comment

Zac-HD left a comment

Choose a reason for hiding this comment

Zac-HD commented Oct 11, 2018

math2001 commented Oct 11, 2018

math2001 commented Oct 11, 2018 •

edited

Zac-HD Oct 11, 2018 •

edited