Not provided optional arguments become `Sentinel.UNSET`

[JenySadadia]

I recently developed maestro pipeline cron service to run kci-dev maestro validate command.
(For reference: kernelci/kernelci-pipeline#1320)

I am receiving the below error even when I haven't provided nodeid argument while invoking maestro results command:

# kci-dev --settings kci-dev.toml maestro validate builds --all-checkouts
Fetching build information...
Traceback (most recent call last):
  File "/usr/local/bin/kci-dev", line 8, in <module>
    sys.exit(run())
  File "/usr/local/lib/python3.10/site-packages/kcidev/main.py", line 67, in run
    cli()
  File "/usr/local/lib/python3.10/site-packages/click/core.py", line 1462, in __call__
    return self.main(*args, **kwargs)
  File "/usr/local/lib/python3.10/site-packages/click/core.py", line 1383, in main
    rv = self.invoke(ctx)
  File "/usr/local/lib/python3.10/site-packages/click/core.py", line 1850, in invoke
    return _process_result(sub_ctx.command.invoke(sub_ctx))
  File "/usr/local/lib/python3.10/site-packages/click/core.py", line 1850, in invoke
    return _process_result(sub_ctx.command.invoke(sub_ctx))
  File "/usr/local/lib/python3.10/site-packages/click/core.py", line 1850, in invoke
    return _process_result(sub_ctx.command.invoke(sub_ctx))
  File "/usr/local/lib/python3.10/site-packages/click/core.py", line 1246, in invoke
    return ctx.invoke(self.callback, **ctx.params)
  File "/usr/local/lib/python3.10/site-packages/click/core.py", line 814, in invoke
    return callback(*args, **kwargs)
  File "/usr/local/lib/python3.10/site-packages/click/decorators.py", line 34, in new_func
    return f(get_current_context(), *args, **kwargs)
  File "/usr/local/lib/python3.10/site-packages/kcidev/subcommands/maestro/validate/builds.py", line 137, in builds
    stats = get_build_stats(
  File "/usr/local/lib/python3.10/site-packages/kcidev/subcommands/maestro/validate/helper.py", line 118, in get_build_stats
    maestro_builds, dashboard_builds = get_builds(ctx, giturl, branch, commit, arch)
  File "/usr/local/lib/python3.10/site-packages/kcidev/subcommands/maestro/validate/helper.py", line 27, in get_builds
    maestro_builds = ctx.invoke(
  File "/usr/local/lib/python3.10/site-packages/click/core.py", line 814, in invoke
    return callback(*args, **kwargs)
  File "/usr/local/lib/python3.10/site-packages/click/decorators.py", line 34, in new_func
    return f(get_current_context(), *args, **kwargs)
  File "/usr/local/lib/python3.10/site-packages/kcidev/subcommands/maestro/results.py", line 126, in results
    results = maestro_get_node(url, nodeid)
  File "/usr/local/lib/python3.10/site-packages/kcidev/libs/maestro_common.py", line 58, in maestro_get_node
    url = url + "latest/node/" + nodeid
TypeError: can only concatenate str (not "Sentinel") to str

[JenySadadia]

I investigated the issue and found out that some versions of click are passing Sentinel.UNSET when optional arguments are not provided. That's the root cause of this issue.
This issue is already fixed but that hasn't been released yet.
See pallets/click#3066 and pallets/click#3068

Shouldn't we pin a specific version of click in the dependencies to avoid such issues? @aliceinwire
Also, we should pin all the python packages we are using since version changes may break things.

[aliceinwire]

we are currently pinning to click = "^8.1.7"

kci-dev/pyproject.toml

Line 34 in 89a6222

click = "^8.1.7"

[aliceinwire]

we can temporary pin click to a specif version, for this problem
click = "<8.3.0" # issue #222

[aliceinwire]

Completely freezing package is not good for distro packaging as each distro have different package versions.
Still in the near future we will test each version with OBS (suse open build system) so we should catch sooner if a release break something.

[JenySadadia]

we can temporary pin click to a specif version, for this problem click = "<8.3.0" # issue #222

That won't work since this change was introduced in 8.x version. We can't use <8.x as other packages require click >=8.2.0.
Until the click fix is released, we can have a workaround by providing default=None to optional args.

[aliceinwire]

This issue follow the introduction in 8.3.0 of a Sentinel.UNSET object via the pallets/click#3030 PR. This PR is itself fixing loads of latent edge-cases around flag options, env vars and default values.

The fix is currently working on my enviroment, the problem was introduced in 8.3.0 version and we are forcing click to don't get version affected by the click issue.
Not only on my environment but I created packages for fedora and opensuse

I can add a minor limit to click >=8.2.0
by default click should be choosen by the last near version to 8.3.0 or the version available in the distribution

[aliceinwire]

also I'm currently on click 8.1.7 without any problem

Successfully installed click-8.1.7 kci-dev-0.1.8
linux-cip git:(linux-6.12.y-cip) kci-dev results hardware list --origin maestro --json
[{"name": "aaeon-UPN-EHLX4RE-A10-0864", "compatibles": "aaeon-UPN-EHLX4RE-A10-0864"}, {"name": "acer-cb317
-- snip --

so i doubt is just 8.2.0 that works

[aliceinwire]

with click 0.8.0

Successfully installed click-8.0.0 kci-dev-0.1.8

(.venv) ➜  linux-cip git:(linux-6.12.y-cip) kci-dev results boots
- test path: boot
  hardware: jh7110-starfive-visionfive-2-v1-3b
  compatibles: starfive,visionfive-2-v1.3b | starfive,jh7110
  config: defconfig arch: riscv compiler: gcc-12
  status:PASS
  log: https://files.kernelci.org/baseline-riscv-broonie-68d5174e5cfd4b8860946347/log.txt.gz
  start time: 2025-09-25T10:19:58.600000Z
  id: maestro:68d5174e5cfd4b8860946347
  dashboard: https://dashboard.kernelci.org/test/maestro:68d5174e5cfd4b8860946347

[aliceinwire]

the only problem I got is with click lower than 8.0.0
black depend on ">=8.0.0"
only few distro[1] have click lower than 8.0.0 and I'm adding the minor limit as a (temporary) contingent as they probably should update to a better version anyway

1. https://repology.org/project/python%3Aclick/versions

[JenySadadia]

Thanks for the fix.