Fix for Click 8.2 breaking change #4061
Open
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Somewhere around 8.2
click
introduced a breaking change around whether you could use thismix_stderr
when initialising the runner, and unfortunately we now use it following the bump of Modal tomodal>=1
integration dependency.In 8.2 the internal
HelpFormatter.write_dl
now enforces definition-list entries to be pairs. Our CLI’s grouped help still feeds triples (category, command, summary), which now throws aTypeError
, and Click exits withSystemExit(2)
while printing the error. In the tests that simply runCliRunner().invoke(cli)
(or run a command that shows help), that exception bubbles up as a failure.The exit-path change hits us anywhere a test relies on
CliRunner
invoking the root zenml command and expects the call to succeed cleanly.This PR updates the CLI formatting code to handle this case.