Ability to hide extra args from web ui

[fabito]

Resolves #1876

[cyberw]

After looking at your code more closely, I think it would be preferable to store the flag on the action itself (instead of in a separate list)

Is that possible?

[fabito]

We probably can.
Regardless where we decide to store it (indeed in the Action seems a better option), I think we will still need access to the parser instance I don't know how to propagate action metadata to the parsed_options.|

[cyberw]

One question: is it be possible to hide/unhide an argument after the fact?

And maybe we should invert the parameter? (change it to include_in_web_ui, default to True). What do you think?

[fabito]

Yeah, we can invert the flag, no problem.
What do you mean by "after the fact" ? Can you give me an example ?

[cyberw]

What do you mean by "after the fact" ? Can you give me an example ?

Lets say a library, like locust-plugins, or some shared file that you import in all your locust files adds a parameter that is hidden (or visible) in the web UI, and you want to show it (or hide it).

e.g (in your library)

parser.add_argument("--my-ui-invisible-argument", include_in_web_ui=False, default="I am invisible")

and then in your specific locustfile, it would be nice to be able to override that, by doing something like this:

parser.my_ui_invisible_argument.include_in_web_ui = True

[fabito]

I am not an ArgumentParser expert but AFAIK it does not expose an API for changing or removing arguments.
Since include_in_web_ui does not affect the parsing logic we could add a function that locates the action ( _actions attribute ) and change the flag's value.

Maybe something like this ??

def include_in_web_ui(self, arg):
    for action in self._actions:
        if (vars(action)['option_strings']
            and vars(action)['option_strings'][0] == arg) \
                or vars(action)['dest'] == arg:
            action.include_in_web_ui = True
            return

    for action in self._action_groups:
        vars_action = vars(action)
        var_group_actions = vars_action['_group_actions']
        for x in var_group_actions:
            if x.dest == arg:
                x.include_in_web_ui = True
                return

[cyberw]

That looks complicated, so lets not bother. it is an acceptable limitation not to be able to modify it. Thanks for the PR!