Handling of --help is broken for click about mmpy_bot

[attzonko]

I am fine leaving it as is....its a side effect of 'click' :)

[unode]

Hi @sw-dbrown this was fixed in f6d8b98 which hasn't been released yet. Would you mind trying the latest version from the main branch and see if the problem persists?

[sw-dbrown]

Hey @unode, thanks for the very fast response. I just manually applied the patch in my venv and I can confirm that the issue is fixed in f6d8b98. Is it intended behavior that the output of the --help command is also sent to the log of the bot?

Hi @sw-dbrown this was fixed in f6d8b98 which hasn't been released yet. Would you mind trying the latest version from the main branch and see if the problem persists?

[unode]

Not intended but harder to control as it's pre-defined behavior in click.
There may be a workaround but the crash was the most important part.

Either way, I would discourage the use of --help as we can't easily control the content of the output.

[unode]

I had a second look at the code and we could use:

with contextlib.redirect_stdout(io.StringIO()):
    ctx = self.function.make_context(
        info_name=self.plugin.__class__.__name__, args=list(args)
    )

at

mmpy_bot/mmpy_bot/function.py

Line 160 in 641b918

ctx = self.function.make_context(

but I don't like this solution. It could accidentally discard other messages which would make it painful to debug.

I also don't think that filtering out --help from args is a good solution.

Any other from those in this thread? I'm tempted to close this issue as-is without additional patches.

[attzonko]

So the remaining issue is that with plugins which use 'click' functions, when the plugin gets the '--help' command, the output shows up in the channel and also in the log?

[unode]

Output is sent to stdout stream, not really the log.