watson 2.1.0 has issues with Python 3.13(.7)

[mharig]

The command "report" (and others) of watson 2.1.0 does not work with Python 3.13(.7).

Error:

File "/home/blubb/.local/lib/python3.13/site-packages/watson/cli.py", line 668, in report
if 'json' in output_format and not aggregated:
^^^^^^^^^^^^^^^^^^^^^^^
TypeError: argument of type 'NoneType' is not iterable

[baffalop]

Can confirm, I just installed Watson on a fresh install of macOS Sequoia:

$ python3 --version
Python 3.14.0

$ watson --version
Watson, version 2.1.0

The full stack trace for the report error:

$ watson report
Traceback (most recent call last):
  File "/opt/homebrew/bin/watson", line 3, in <module>
    from watson.__main__ import cli
  File "/opt/homebrew/Cellar/watson/2.1.0_8/libexec/lib/python3.14/site-packages/watson/__main__.py", line 3, in <module>
    cli.cli()
    ~~~~~~~^^
  File "/opt/homebrew/Cellar/watson/2.1.0_8/libexec/lib/python3.14/site-packages/click/core.py", line 1462, in __call__
    return self.main(*args, **kwargs)
           ~~~~~~~~~^^^^^^^^^^^^^^^^^
  File "/opt/homebrew/Cellar/watson/2.1.0_8/libexec/lib/python3.14/site-packages/click/core.py", line 1383, in main
    rv = self.invoke(ctx)
  File "/opt/homebrew/Cellar/watson/2.1.0_8/libexec/lib/python3.14/site-packages/click/core.py", line 1850, in invoke
    return _process_result(sub_ctx.command.invoke(sub_ctx))
                           ~~~~~~~~~~~~~~~~~~~~~~^^^^^^^^^
  File "/opt/homebrew/Cellar/watson/2.1.0_8/libexec/lib/python3.14/site-packages/click/core.py", line 1246, in invoke
    return ctx.invoke(self.callback, **ctx.params)
           ~~~~~~~~~~^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/opt/homebrew/Cellar/watson/2.1.0_8/libexec/lib/python3.14/site-packages/click/core.py", line 814, in invoke
    return callback(*args, **kwargs)
  File "/opt/homebrew/Cellar/watson/2.1.0_8/libexec/lib/python3.14/site-packages/click/decorators.py", line 46, in new_func
    return f(get_current_context().obj, *args, **kwargs)
  File "/opt/homebrew/Cellar/watson/2.1.0_8/libexec/lib/python3.14/site-packages/watson/cli.py", line 136, in wrapper
    return func(*args, **kwargs)
  File "/opt/homebrew/Cellar/watson/2.1.0_8/libexec/lib/python3.14/site-packages/watson/cli.py", line 668, in report
    if 'json' in output_format and not aggregated:
       ^^^^^^^^^^^^^^^^^^^^^^^
TypeError: argument of type 'NoneType' is not a container or iterable

[philpagel]

Same problem here. Python 3.13.5, Debian LINUX, Watson 2.1.0 installed via pipx.

[baffalop]

Then again, I tried using pyenv to downgrade to 3.12 (and also 3.11) but I have the same error 😕

$ pyenv global 3.11
$ python3 --version
Python 3.11.14

[philpagel]

Maybe a problem after an update of some library.

[baffalop]

Oh hang on, just realised that my stack trace still shows the same path with libexec/lib/python3.14/site-packages/click/... So, @philpagel you might be right that the issue is with a newer version of the click library. I'm also not sure at what step in the packaging/build/installation process this dependency is resolved. My installation is via Homebrew. I tried uninstalling, setting pyenv global 3.11 and reinstalling, but I still have a lib/python3.14 and still the same issue.

[baffalop]

Ok so I hacked in a fix locally just by adding a condition on top of the block of conditionals from the stack trace (cli.py:668): if output_format is not None. I doubt this is the ideal fix. I suspect that Click is supposed to default output_format to an empty list but the Python 3.14 version doesn't... or something like that.

[AshPhillips2786]

I took a different route and specified at the top of the report function, ~654:

if output_format is None:
    output_format = "plain"

this seems to be working so far.

[alsmola]

This is AI generated, so buyer-beware, but I put up: #513

[mharig]

Just saw that the command aggregate has another issue:

File "/home/blubb/.local/lib/python3.13/site-packages/watson/watson.py", line 475, in report
if from_ > to:
^^^^^^^^^^
TypeError: '>' not supported between instances of 'Sentinel' and 'Arrow'

[jcubic]

it seems that there are no default output_format anymore, so to fix this, you only need to add one of those options:

@click.option('-j', '--json', 'output_format', cls=MutuallyExclusiveOption,
              flag_value='json', mutually_exclusive=['csv'],
              help="Format output in JSON instead of plain text")
@click.option('-s', '--csv', 'output_format', cls=MutuallyExclusiveOption,
              flag_value='csv', mutually_exclusive=['json'],
              help="Format output in CSV instead of plain text")
@click.option('--plain', 'output_format', cls=MutuallyExclusiveOption,
              flag_value='plain', mutually_exclusive=['json', 'csv'],
              default=True, hidden=True,
              help="Format output in plain text (default)")

Probably --plain should be default.

[philpagel]

Looking at cli.py, it seems that --plain is already supposed to be the default option. I believe that the problem is in class MutuallyExclusiveOption (line 43) or in the respective @click.option definitions (line 533 and following). Possibly caused by changes in click. So we should try and fix the problem at its root and not add additional if statements later in the code as proposed in PR #513.

I don't have time right now but hope to have a closer look over the holidays.