Флаг функции для команд нажатия Python - PullRequest
Новая
       13

Флаг функции для команд нажатия Python

3 голосов
/ 27 марта 2019

В моем скрипте python-click-CLI я создаю некоторые команды для функций, которые не должны быть видимы для пользователей (чтобы не перепутать их), но видимы, например, для разработчиков.

Можно ли использовать флаги функций для команд щелчка Python?

Я бы хотел настроить (через файл конфигурации и т. Д.), Если команда доступна или нет.Если функция команды отключена, команда не должна вызываться и справка не должна отображать ее.

Примерно так: 

FLAG_ENABLED = False

# This command should not be shown and not be callable as long as the flag is disabled
@cli.command(name='specialfeature', active=FLAG_ENABLED)
def special_feature_command()
    ....

Очевидно, я мог бы изменить тело своей функции: 

@cli.command(name='specialfeature', active=FLAG_ENABLED)
def special_feature_command()
    if FLAG_ENABLED:
        ...
    else:
        ...

Но тогда моя команда все равно будет отображаться в справке, чего я бы хотел избежать.

1 Ответ

1 голос
/ 27 марта 2019

Вы можете добавить функциональный флаг функциональность с пользовательским классом как:

Пользовательский класс

Этот класс переходит к методу click.Group.command(), который используется для украшения командных функций. Добавлена ​​возможность передавать флаг active, который, когда False пропустит добавление команды в группу. 

import click

class FeatureFlagCommand(click.Group):

    def command(self, *args, active=True, **kwargs):
        """Behaves the same as `click.Group.command()` except added an
        `active` flag which can be used to disable to command.
        """
        if active:
            return super(FeatureFlagCommand, self).command(*args, **kwargs)
        else:
            return lambda f: f

Использование пользовательского класса

При передаче параметра cls в декоратор click.group() все команды, добавленные в группу через group.command(), будут стробированы с флагом active. 

@click.group(cls=FeatureFlagCommand)
def cli():
    ...

@cli.command(name='specialfeature', active=FLAG_ENABLED)
def special_feature_command()
    ...

Как это работает?

Это работает, потому что click - это хорошо спроектированная OO-инфраструктура. Легко унаследовать от click.Group и создать новый command() декоратор. В новом декораторе command(), если активным флагом является False, мы возвращаем недекорированную функцию вместо добавления функции в группу.

Тестовый код: 

@click.group(cls=FeatureFlagCommand)
def cli():
    """My Awesome Click Program"""

@cli.command(active=False)
def command1():
    click.echo('Command 1')

@cli.command(active=True)
def command2():
    click.echo('Command 2')

@cli.command()
def command3():
    click.echo('Command 3')


if __name__ == "__main__":
    commands = (
        'command1',
        'command2',
        'command3',
        '--help',
        '',
    )

    import sys, time

    time.sleep(1)
    print('Click Version: {}'.format(click.__version__))
    print('Python Version: {}'.format(sys.version))
    for cmd in commands:
        try:
            time.sleep(0.1)
            print('-----------')
            print('> ' + cmd)
            time.sleep(0.1)
            cli(cmd.split())

        except BaseException as exc:
            if str(exc) != '0' and \
                    not isinstance(exc, (click.ClickException, SystemExit)):
                raise

Результаты: 

Click Version: 6.7
Python Version: 3.6.3 (v3.6.3:2c5fed8, Oct  3 2017, 18:11:49) [MSC v.1900 64 bit (AMD64)]
-----------
> command1
Usage: test.py [OPTIONS] COMMAND [ARGS]...

Error: No such command "command1".
-----------
> command2
Command 2
-----------
> command3
Command 3
-----------
> --help
Usage: test.py [OPTIONS] COMMAND [ARGS]...

  My Awesome Click Program

Options:
  --help  Show this message and exit.

Commands:
  command2
  command3
-----------
> 
Usage: test.py [OPTIONS] COMMAND [ARGS]...

  My Awesome Click Program

Options:
  --help  Show this message and exit.

Commands:
  command2
  command3
...