Categorizing Dynamic Commands

[KresoDenis]

How to categorize a dynamic command created via

setattr(CommandsInLoop, 'do_{}'.format(command), functools.partialmethod(CommandsInLoop.send_text, text=command))

in dynamic example

running categorize function from cmd2 dont work since i guess it was not mean to be used this way.

Any other alternative way. There seems to be nothing in documentation.

[KresoDenis]

P.S. I found solution in using functools.partial instead of functools.partialmethod
where i could do

sarma = functools.partial(CommandsInLoop.send_text, text=command)
setattr(sarma, 'help_category', 'somecategory')
setattr(CommandsInLoop, 'do_{}'.format(command), sarma)

But im guessing there should be something more official or streamlined than this.

And still not sure how to use it with partialmethod when partialmethod is actually needed. Since you cant setattr to it.

[tleonhardt]

@KresoDenis
I think you might jus need to pass your sarma variable to categorize()

Some of our developers do use dynamic commands but we didn't want to add a particular implementation to our code base for easily doing that since there are infinite ways to do that and we didn't want to impose a single way. We believe we provide all the functions necessary already.

It really comes down to your needs ...

1. Are you creating functions dynamically?
2. Do you have existing functions in other files that you add once?
3. Are your functions loaded and unloaded as part of a plugin at an unknown time by the user?
4. Are you adding the functions to the CLI class or an instance?

Once you answer those questions, the solution is generally a Pythonic one and not so much cmd2 specific.

@kmvanbrunt Do you have any further comments and/or suggestions?

[kmvanbrunt]

@tleonhardt I agree with your comment

[KresoDenis]

I just tried. Categorize does not work on partialmethod in cmd2 dynamic example. It does only work when using partial instead of partialmethod with settattr or categorize. Just wondered whats the proper way for partialmethod since that is default in examples.

This does not work

    sarma = functools.partialmethod(CommandsInLoop.send_text, text=command)
    cmd2.categorize(sarma, 'CustomCategory')
    setattr(CommandsInLoop, 'do_{}'.format(command), sarma)

This does

    sarma = functools.partial(CommandsInLoop.send_text, text=command)
    cmd2.categorize(sarma, 'CustomCategory')
    setattr(CommandsInLoop, 'do_{}'.format(command), sarma)

Just wanted to know how you solved it with partialmethods officialy. But i have no blockers in using partial instead of partialmethods. Some people following official examples will have issues. Especially if they need partialmethod.

[kmvanbrunt]

It looks like Python is not preserving the help category attribute when it binds the partial method object to the CommandsInLoop instance.

I've rewritten the example to add commands in the instance's __init__() method and this works with categories. See PR #840.

[kmvanbrunt]

@KresoDenis The example has been merged into master. Let us know if this is works out for you.

[KresoDenis]

Sure thing. Example PR moved from partialmethod to partial. Same as i did. I think that is the reason why it works. Even without moving it to init() partial should work.

It Works out for me. Adding categorization in example of dynamic ones will help others. If that means using just partial in example instead of partialmethod. Im ok with that. Thanks.