Test fails with click 8.2.0 if both "type=bool" and "default=False" are specified

[s3v-]

Hi,
I open this discussion because I don't now if it is a regression or a new (undocumented?) feature in new click 8.2.0.

Recently, Debian uploaded click 8.2.0 in unstable and there is a bug report [1] to understand whether to reintroduce 8.1.8 version or patch out all reverse dependencies that spot failures in their tests.

After changing:

click/tests/test_basic.py

Lines 225 to 237 in 5dd6288

	@pytest.mark.parametrize("default", [True, False])
	@pytest.mark.parametrize(("args", "expect"), [(["--f"], True), ([], False)])
	def test_boolean_flag(runner, default, args, expect):
	@click.command()
	@click.option("--f", is_flag=True, default=default)
	def cli(f):
	return f
	if default:
	expect = not expect
	result = runner.invoke(cli, args, standalone_mode=False)
	assert result.return_value is expect

to:

@pytest.mark.parametrize("default", [True, False]) 
@pytest.mark.parametrize(("args", "expect"), [(["--f"], True), ([], False)])
 def test_boolean_flag(runner, default, args, expect): 
     @click.command() 
     @click.option("--f", type=bool, is_flag=True, default=default) 
     def cli(f): 
         return f 
  
     if default: 
         expect = not expect 
  
     result = runner.invoke(cli, args, standalone_mode=False) 

the test fails:

========================================================================= FAILURES ==========================================================================
____________________________________________________________ test_boolean_flag[args0-True-True] _____________________________________________________________

runner = <click.testing.CliRunner object at 0x7fb3d1d5cb40>, default = True, args = ['--f'], expect = False

    @pytest.mark.parametrize("default", [True, False])
    @pytest.mark.parametrize(("args", "expect"), [(["--f"], True), ([], False)])
    def test_boolean_flag(runner, default, args, expect):
        @click.command()
        @click.option("--f", type=bool, is_flag=True, default=default)
        def cli(f):
            return f
    
        if default:
            expect = not expect
    
        result = runner.invoke(cli, args, standalone_mode=False)
>       assert result.return_value is expect
E       assert True is False
E        +  where True = <Result okay>.return_value

../../../tests/test_basic.py:237: AssertionError
____________________________________________________________ test_boolean_flag[args0-True-False] ____________________________________________________________

runner = <click.testing.CliRunner object at 0x7fb3d1d5c3d0>, default = False, args = ['--f'], expect = True

    @pytest.mark.parametrize("default", [True, False])
    @pytest.mark.parametrize(("args", "expect"), [(["--f"], True), ([], False)])
    def test_boolean_flag(runner, default, args, expect):
        @click.command()
        @click.option("--f", type=bool, is_flag=True, default=default)
        def cli(f):
            return f
    
        if default:
            expect = not expect
    
        result = runner.invoke(cli, args, standalone_mode=False)
>       assert result.return_value is expect
E       assert False is True
E        +  where False = <Result okay>.return_value

../../../tests/test_basic.py:237: AssertionError
================================================================== short test summary info ==================================================================
FAILED ../../../tests/test_basic.py::test_boolean_flag[args0-True-True] - assert True is False
FAILED ../../../tests/test_basic.py::test_boolean_flag[args0-True-False] - assert False is True
============================================ 2 failed, 626 passed, 21 skipped, 1 deselected, 1 xfailed in 1.15s =============================================

but the same test pass against click 8.1.8

I noticed this behavior after seeing test failures in httpx [2] that declares:
https://github.com/encode/httpx/blob/ce7a6e91fbcaae8b8e5d8df5865a95a9b75acb64/httpx/_main.py#L436-L443

Please note that I'm not the maintainer for click in Debian, @ppentchev is (He's the appropriate person to evaluate the click status and tagged consequently).

Thanks for your work.

Kind Regards

[1] https://bugs.debian.org/cgi-bin/bugreport.cgi?bug=1098507
[2] https://ci.debian.net/packages/h/httpx/testing/amd64/58300723/

[kdeldycke]

I can confirm this issue with the upcoming 8.2.0 release: default value and for flags are messed up unless type=bool is explicitly passed as argument.

Can we transform this discussion into an issue?

[s3v-]

Can we transform this discussion into an issue?

Yes, of course.
Thanks for taking care of it.

P.S.
Upcoming Debian 13 "Trixie" will ship click 8.1.8 and httpx 0.28.1, so no problem so far.

[s3v-]

Hi,
problem reported in this discussion (bug) was resolved in #2930, so closing now.

Thank you everyone for taking care of click!