feat: add IsFalseLike #23

osintalex · 2022-03-08T13:43:29Z

I thought this library looked pretty cool so wanted to give this a go.

codecov · 2022-03-08T13:44:02Z

Codecov Report

Merging #23 (f287e1c) into main (6e42e04) will not change coverage.
The diff coverage is 100.00%.

@@            Coverage Diff            @@
##              main       #23   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files            9        10    +1     
  Lines          584       599   +15     
  Branches       153       155    +2     
=========================================
+ Hits           584       599   +15

Impacted Files	Coverage Δ
dirty_equals/_base.py	`100.00% <ø> (ø)`
dirty_equals/__init__.py	`100.00% <100.00%> (ø)`
dirty_equals/_boolean.py	`100.00% <100.00%> (ø)`

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 6e42e04...f287e1c. Read the comment docs.

osintalex · 2022-03-08T13:46:30Z

dirty_equals/_boolean.py

+    Check if the value is False like, and matches the given conditions.
+    """
+
+    allowed_types: Union[Type[B], Tuple[Union[_SpecialForm, type], ...]] = (


There might be a much simpler way to do this, I got quite confused working with _SpecialForm and mypy here. This also requires a type ignore here.

osintalex · 2022-03-24T20:39:24Z

Hey, just wondering if there's any interest on this? Happy to try and help with something else if that would be a better fit, I think it's a really cool project!

samuelcolvin · 2022-03-24T20:40:26Z

Sorry, somehow I missed this. I'll look soon.

samuelcolvin

This is looking great, just a few things to fix.

We'll need to add IsTrueLike in the same release, but I can do that.

samuelcolvin · 2022-03-25T09:11:32Z

dirty_equals/_boolean.py

+    Check if the value is False like, and matches the given conditions.
+    """
+
+    allowed_types: Union[Type[B], Tuple[Union[_SpecialForm, type], ...]] = (


I think we should allow all types to IsFalseLike, with that:

the logic will be simpler - effectively return not bool(thing) (except for the string logic)

it will be more pythonic

it will be easier for users to understand - they don't have to remember (or look up) what types allowed - they can just use their intuition about python

samuelcolvin · 2022-03-25T09:12:05Z

dirty_equals/_boolean.py

+
+    def __init__(
+        self,
+        numeric: Optional[bool] = None,


this is not required:

assert bool(1) is True assert bool(0) is False

Is already the case.

samuelcolvin · 2022-03-25T09:13:48Z

dirty_equals/_boolean.py

+    def __init__(
+        self,
+        numeric: Optional[bool] = None,
+        string: Optional[bool] = None,


I think this is good, but we should ignore case and give it a more descritive name.

assert 'false' == IsFalseLike(allow_strings=True)

also, I think you should make it a keyword only argument.

samuelcolvin · 2022-03-25T09:14:16Z

dirty_equals/_boolean.py

+        if self.numeric and not isinstance(self.numeric, bool):
+            raise ValueError('"numeric" requires a boolean argument')
+        if self.string and not isinstance(self.string, bool):
+            raise ValueError('"string" requires a boolean argument')


no need for explicit type checks like this, we don't do it elsewhere.

samuelcolvin · 2022-03-25T09:14:27Z

docs/types/boolean.md

@@ -0,0 +1,3 @@
+# Boolean Types


samuelcolvin · 2022-03-25T09:14:40Z

tests/test_boolean.py

+
+
+@pytest.mark.parametrize(
+    'other, expected',


osintalex · 2022-03-26T20:24:57Z

Thanks for the helpful feedback! All makes sense, about to push another commit now.

osintalex · 2022-03-26T20:43:21Z

I think those check fails are all about an error in the test_is_now_tz test intest_datetime.py tests. Plus this jinja update which breaks mkdocs. Looks like the latest version of mkdocs has fixed it though.

samuelcolvin

Otherwise looking good, main should now be fixed, so you can rebase to fix build

samuelcolvin · 2022-03-28T11:46:48Z

dirty_equals/_boolean.py

+        super().__init__(
+            allow_strings=allow_strings,
+        )


Suggested change

super().__init__(

allow_strings=allow_strings,

)

super().__init__(allow_strings=allow_strings)

samuelcolvin · 2022-03-28T11:47:46Z

dirty_equals/_boolean.py

+
+        assert False == IsFalseLike
+        assert 0 == IsFalseLike
+        assert '0' == IsFalseLike(allow_strings=True)


put the assert 'false' == IsFalseLike(allow_strings=True) case before these.

You should also add assert 'foobar' != IsFalseLike(allow_strings=True) to show that other values don't raise an error.

samuelcolvin · 2022-03-28T11:48:36Z

dirty_equals/_boolean.py

+        allow_strings: Optional[bool] = None,
+    ):
+        """
+        Example of basic usage:


you need to add Args and document what values are allowed when allow_strings=True.

samuelcolvin · 2022-03-28T11:49:38Z

dirty_equals/_boolean.py

+
+class IsFalseLike(DirtyEquals[B]):
+    """
+    Check if the value is False like, and matches the given conditions.


Suggested change

Check if the value is False like, and matches the given conditions.

Check if the value is False like, `IsFalseLike` allows comparison to anything and effectively uses

`return not bool(other)` (with string checks if `allow_strings=True` is set).

Or similar

samuelcolvin · 2022-03-28T11:51:52Z

dirty_equals/_boolean.py

+        if other.lower() in ('0', '0.0', 'false'):
+            return True
+        else:
+            return False


You can use just:

Suggested change

if other.lower() in ('0', '0.0', 'false'):

return True

else:

return False

return other.lower() in {'0', '0.0', 'false'}

in checks are almost always faster with sets than tuples or lists.

Cool! Did not know that re sets.

samuelcolvin · 2022-03-28T11:52:33Z

dirty_equals/_boolean.py

+        )
+
+    def equals(self, other: Any) -> bool:
+        if self.allow_strings:


Suggested change

if self.allow_strings:

if isinstance(other, str) and self.allow_strings:

Otherwise you'd get an error here!

samuelcolvin · 2022-03-28T11:53:10Z

tests/test_boolean.py

+    def test_dirty_not_equals(self, other, expected):
+        with pytest.raises(AssertionError):
+            assert other != expected


this isn't achieving anything, you can remove it and make this a simple function test.

samuelcolvin · 2022-03-29T10:28:53Z

thanks so much.

For future reference, you've done something weird here when updating from main, which means my changes are showing in your PR, but shouldn't be a problem on this occation.

osintalex · 2022-03-30T21:03:16Z

Pleasure - thanks for the feedback. My bad on that, think I should have forced push but instead hit git pull origin <branch> --rebase. Will beard in mind for the future 👍🏻

feat: add IsFalseLike

e14b834

osintalex commented Mar 8, 2022

View reviewed changes

osintalex marked this pull request as ready for review March 8, 2022 13:47

samuelcolvin reviewed Mar 25, 2022

View reviewed changes

fix: remove numeric and allow all types on IsFalseLike

cc76f75

samuelcolvin reviewed Mar 28, 2022

View reviewed changes

samuelcolvin and others added 4 commits March 28, 2022 22:30

fix build, uprev dependencies (samuelcolvin#24)

f8e2d7a

fix mkdocs material insiders install

c7132cd

fix IsOneOf example

0a1334b

fix: amend IsFalseLike docs, logic, test

f287e1c

samuelcolvin merged commit 7a02b01 into samuelcolvin:main Mar 29, 2022

samuelcolvin mentioned this pull request Mar 29, 2022

More types #3

Open

20 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: add IsFalseLike #23

feat: add IsFalseLike #23

osintalex commented Mar 8, 2022

codecov bot commented Mar 8, 2022 •

edited

Loading

osintalex Mar 8, 2022

osintalex commented Mar 24, 2022

samuelcolvin commented Mar 24, 2022

samuelcolvin left a comment

samuelcolvin Mar 25, 2022 •

edited

Loading

samuelcolvin Mar 25, 2022

samuelcolvin Mar 25, 2022

samuelcolvin Mar 25, 2022

samuelcolvin Mar 25, 2022

samuelcolvin Mar 25, 2022

osintalex commented Mar 26, 2022

osintalex commented Mar 26, 2022

samuelcolvin left a comment

samuelcolvin Mar 28, 2022

samuelcolvin Mar 28, 2022

samuelcolvin Mar 28, 2022

samuelcolvin Mar 28, 2022

samuelcolvin Mar 28, 2022

osintalex Mar 28, 2022

samuelcolvin Mar 28, 2022

samuelcolvin Mar 28, 2022

samuelcolvin commented Mar 29, 2022

osintalex commented Mar 30, 2022

-    Check if the value is False like, and matches the given conditions.
+    Check if the value is False like, `IsFalseLike` allows comparison to anything and effectively uses
+    `return not bool(other)` (with string checks if `allow_strings=True` is set).
+Or similar

	if self.allow_strings:
	if isinstance(other, str) and self.allow_strings:

feat: add IsFalseLike #23

feat: add IsFalseLike #23

Conversation

osintalex commented Mar 8, 2022

codecov bot commented Mar 8, 2022 • edited Loading

Codecov Report

Choose a reason for hiding this comment

osintalex commented Mar 24, 2022

samuelcolvin commented Mar 24, 2022

samuelcolvin left a comment

Choose a reason for hiding this comment

samuelcolvin Mar 25, 2022 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

osintalex commented Mar 26, 2022

osintalex commented Mar 26, 2022

samuelcolvin left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

samuelcolvin commented Mar 29, 2022

osintalex commented Mar 30, 2022

codecov bot commented Mar 8, 2022 •

edited

Loading

samuelcolvin Mar 25, 2022 •

edited

Loading