С помощью Python щелкните, как я могу избежать дублирования кода аргумента, используемого несколькими подкомандами
У меня есть группа подкоманд, которые работают со списком URL-адресов, которые могут быть переданы в качестве аргумента. Как можно вместо этого назначить этот аргумент группе, чтобы избежать дублирования определения аргумента в каждой подкоманде?
Текущий код:
from config import site_list
@click.group()
def cli():
pass
@cli.command()
@cli.argument('sites', nargs=-1)
def subcommand_one():
if sites:
site_list = sites
etc...
@cli.command()
@cli.argument('sites', nargs=-1)
def subcommand_two():
if sites:
site_list = sites
etc...
Пример вызова:
$ python sites.py subcommand_one www.example.com www.example2.com
Я попытался переместить декоратор аргумента в группу следующим образом:
@click.group()
@click.argument('sites', nargs=-1)
def cli(sites):
if sites:
site_list = sites
Но тогда я получу эту ошибку:
$ python sites.py subcommand_one
Usage: sites.py [OPTIONS] [SITES] COMMAND [ARGS]...
Try "sites.py --help" for help.
Error: Missing command.
2 ответа
Если есть конкретный nargs = -1 аргумент, что вы хотели бы оформить только на группу, но при необходимости быть применимы ко всем командам, вы можете сделать это с некоторыми дополнительными сантехническими, как:
Этот ответ вдохновлен этим ответом.
Пользовательский класс
class GroupNArgsForCommands(click.Group):
"""Add special arguments on group"""
def __init__(self, *args, **kwargs):
super(GroupNArgsForCommands, self).__init__(*args, **kwargs)
cls = GroupNArgsForCommands.CommandArgument
# gather the special arguments for later
self._cmd_args = {
a.name: a for a in self.params if isinstance(a, cls)}
# strip out the special arguments from self
self.params = [a for a in self.params if not isinstance(a, cls)]
class CommandArgument(click.Argument):
"""class to allow us to find our special arguments"""
@staticmethod
def command_argument(*param_decls, **attrs):
"""turn argument type into type we can find later"""
assert 'cls' not in attrs, "Not designed for custom arguments"
attrs['cls'] = GroupNArgsForCommands.CommandArgument
def decorator(f):
click.argument(*param_decls, **attrs)(f)
return f
return decorator
def group(self, *args, **kwargs):
# any derived groups need to be the same type
kwargs['cls'] = GroupNArgsForCommands
def decorator(f):
grp = super(GroupNArgsForCommands, self).group(
*args, **kwargs)(f)
self.add_command(grp)
# any sub commands need to hook the same special args
grp._cmd_args = self._cmd_args
return grp
return decorator
def add_command(self, cmd, name=None):
# call original add_command
super(GroupNArgsForCommands, self).add_command(cmd, name)
# if this command's callback has desired parameters add them
import inspect
args = inspect.signature(cmd.callback)
if len(args.parameters):
for arg_name in reversed(list(args.parameters)):
if arg_name in self._cmd_args:
cmd.params[:] = [self._cmd_args[arg_name]] + cmd.params
Использование пользовательского класса:
Чтобы использовать пользовательский класс, передайте cls параметр к click.group() декоратор, используйте@GroupNArgsForCommands.command_argument декоратор для специального аргумента, а затем добавьте параметр с тем же именем, что и специальный аргумент, к любым командам по мере необходимости.
@click.group(cls=GroupNArgsForCommands)
@GroupNArgsForCommands.command_argument('special', nargs=-1)
def a_group():
"""My project description"""
@a_group.command()
def a_command(special):
"""a command under the group"""
Как это работает?
Это работает, потому что click является хорошо разработанной структурой OO. @click.group() декоратор обычно создает экземпляр click.Group объект, но позволяет этому поведению быть перегруженным cls параметр.
Так что это относительно легко унаследовать от click.Group в нашем собственном классе и за рулем желаемых методов.
В этом случае мы переедем click.Group.add_command() так что при добавлении команды мы можем проверить параметры обратного вызова команды, чтобы увидеть, имеют ли они то же имя, что и любой из наших специальных аргументов. Если они совпадают, аргумент добавляется к аргументам команды так же, как если бы он был оформлен напрямую.
К тому же GroupNArgsForCommands реализует command_argument() метод. Этот метод используется в качестве декоратора при добавлении специального аргумента вместо использования click.argument()
Тестовый класс
import click
@click.group(cls=GroupNArgsForCommands)
@GroupNArgsForCommands.command_argument('sites', nargs=-1)
def cli():
click.echo("cli group")
@cli.command()
def command_one(sites):
click.echo("command_one: {}".format(sites))
@cli.group()
def subcommand():
click.echo("subcommand group")
@subcommand.command()
def one():
click.echo("subcommand_one")
@subcommand.command()
def two(sites):
click.echo("subcommand_two: {}".format(sites))
if __name__ == "__main__":
commands = (
'command_one site1 site2',
'command_one site1',
'command_one',
'subcommand',
'subcommand one site1 site2',
'subcommand one site1',
'subcommand one',
'subcommand two site1 site2',
'subcommand two site1',
'subcommand two',
'--help',
'command_one --help',
'subcommand --help',
'subcommand one --help',
'subcommand two --help',
'',
)
import sys, time
time.sleep(1)
print('Click Version: {}'.format(click.__version__))
print('Python Version: {}'.format(sys.version))
for command in commands:
try:
time.sleep(0.1)
print('-----------')
print('> ' + command)
time.sleep(0.1)
cli(command.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)]
-----------
> command_one site1 site2
cli group
command_one: ('site1', 'site2')
-----------
> command_one site1
cli group
command_one: ('site1',)
-----------
> command_one
cli group
command_one: ()
-----------
> subcommand
cli group
Usage: test.py subcommand [OPTIONS] COMMAND [ARGS]...
Options:
--help Show this message and exit.
Commands:
one
two
-----------
> subcommand one site1 site2
Usage: test.py subcommand one [OPTIONS]
Error: Got unexpected extra arguments (site1 site2)
cli group
subcommand group
-----------
> subcommand one site1
cli group
subcommand group
Usage: test.py subcommand one [OPTIONS]
Error: Got unexpected extra argument (site1)
-----------
> subcommand one
cli group
subcommand group
subcommand_one
-----------
> subcommand two site1 site2
cli group
subcommand group
subcommand_two: ('site1', 'site2')
-----------
> subcommand two site1
cli group
subcommand group
subcommand_two: ('site1',)
-----------
> subcommand two
cli group
subcommand group
subcommand_two: ()
-----------
> --help
Usage: test.py [OPTIONS] COMMAND [ARGS]...
Options:
--help Show this message and exit.
Commands:
command_one
subcommand
-----------
> command_one --help
cli group
Usage: test.py command_one [OPTIONS] [SITES]...
Options:
--help Show this message and exit.
-----------
> subcommand --help
cli group
Usage: test.py subcommand [OPTIONS] COMMAND [ARGS]...
Options:
--help Show this message and exit.
Commands:
one
two
-----------
> subcommand one --help
cli group
subcommand group
Usage: test.py subcommand one [OPTIONS]
Options:
--help Show this message and exit.
-----------
> subcommand two --help
cli group
subcommand group
Usage: test.py subcommand two [OPTIONS] [SITES]...
Options:
--help Show this message and exit.
-----------
>
Usage: test.py [OPTIONS] COMMAND [ARGS]...
Options:
--help Show this message and exit.
Commands:
command_one
subcommand
click.argument просто возвращает декоратор, как и любой другой, так что вы можете присвоить его некоторой переменной:
import click
@click.group()
def cli():
pass
sites_argument = click.argument('sites', nargs=-1)
@cli.command()
@sites_argument
def subcommand_one(sites):
...
@cli.command()
@sites_argument
def subcommand_two(sites):
...
Я думаю, что есть реальное решение, поддерживаемое Click, используя @click.pass_context.
Если вы хотите определить группу команд, которые все имеют, например, общий аргумент и общий параметр, вы можете определить их на уровне группы и добавить их в объект контекста, как описано в документации Click.
@click.group(chain=True)
@click.argument("dataset_directory", type=click.Path(exists=True))
@click.option("-s", "--split-names", help="The splits to preprocess.", required=True,
default=["trainset", "devset", "testset"], show_default=True)
@click.pass_context
def cli(ctx, dataset_directory, split_names):
"""
Prepare the dataset for training
DATASET_DIRECTORY The absolute path to the data directory.
"""
ctx.ensure_object(dict)
ctx.obj["DIRECTORY"] = dataset_directory
ctx.obj["SPLITS"] = split_names
Затем отдельные команды этой группы могут получить контекст и использовать значения из объекта контекста вместо определения своих собственных аргументов и параметров.
@cli.command("create")
@click.pass_context
def create(ctx):
create_semantics_json_from_csv(ctx.obj["DIRECTORY"], ctx.obj["SPLITS"])
@cli.command("tokenize")
@click.pass_context
def tokenize(ctx):
preprocess_tokenize_semantics_json(ctx.obj["DIRECTORY"], ctx.obj["SPLITS"])
В таком случае вызов команд возможен, например:
my-cli-app /path/to/data create tokenize