PicoCLI: смешанные и независимые аргументы - PullRequest
Новая
       32

PicoCLI: смешанные и независимые аргументы

1 голос
/ 18 марта 2020

Я пытаюсь добиться чего-то подобного с помощью PicoCLI:

  • Опция 0 (справка, многословно)
  • Опция A
    • Зависимая опция A-1
    • Зависимая опция A-2
    • Зависимая опция A-3
  • Опция B
    • Требуется опция A
    • Но не допускает любой вариант A - *

Я не знаю, смогу ли я выполнить эту настройку с помощью инструментов PicoCLI или просто проверю после анализа с помощью пользовательского кода.

В этом состоянии вариант A находится в группе ArgGroup, где требуется вариант A, а Optioan A- * нет. Вариант B находится в другой ArgGroup. Я пытался сделать некоторые вещи эксклюзивными, но я не могу понять, как ArgGroup / Exclusive работает так, как задумано ...

Есть какие-нибудь подсказки?

1 Ответ

0 голосов
/ 18 марта 2020

Чтобы суммировать отношения, эти параметры должны иметь:

  1. -B, -A1, -A2 и -A3 все требуют параметр -A
  2. -B запрещает любой из параметров -A1, -A2 и -A3
  3. -A1, -A2 и -A3 позволяют друг другу
  4. опция -A позволяет (но не требует) -B, -A1, -A2 и -A3 options

Одних аннотаций picocli будет недостаточно для декларативного express всех этих отношений, потребуется некоторая пользовательская проверка.

Так что мы могли бы также упростить и создать группа с одним аргументом, так как мы не можем express требование 2 (-B является эксклюзивным с -A1, -A2, -A3) одновременно с требованием 1 и 3 (-B, -A1, -A2 и -A3 все требуют -A и -A1, -A2, -A3 разрешают друг другу).

Одна группа, такая как [-A [-B] [-A1] [-A2] [-A3]], позаботится о некоторых проверках: все, кроме требования 2 (-B является ex кластеризуется с -A1, -A2, -A3). Для требования 2 нам нужно кодировать некоторую пользовательскую проверку в приложении (пример ниже).

Для вашего случая использования может быть полезно иметь пользовательский краткий обзор, который точно отражает отношения между опциями. Примерно так: 

Usage: app [-hV] [-A [-B]]
       app [-hV] [-A [-A1] [-A2] [-A3]]

Пример кода для достижения этой цели: 

import picocli.CommandLine;
import picocli.CommandLine.*;
import picocli.CommandLine.Model.CommandSpec;

@Command(name = "app", mixinStandardHelpOptions = true,
        synopsisHeading = "",
        customSynopsis = {
            "Usage: app [-hV] [-A [-B]]",
            "       app [-hV] [-A [-A1] [-A2] [-A3]]",
        })
public class App implements Runnable {
    static class MyGroup {
        @Option(names = "-A", required = true) boolean a;
        @Option(names = "-B") boolean b;
        @Option(names = "-A1") boolean a1;
        @Option(names = "-A2") boolean a2;
        @Option(names = "-A3") boolean a3;

        boolean isInvalid() {
            return b && (a1 || a2 || a3);
        }
    }

    @ArgGroup(exclusive = false)
    MyGroup myGroup;

    @Spec CommandSpec spec;

    public void run() {
        if (myGroup != null && myGroup.isInvalid()) {
            String msg = "Option -B is mutually exclusive with -A1, -A2 and -A3";
            throw new ParameterException(spec.commandLine(), msg);
        }
        System.out.printf("OK: %s%n", spec.commandLine().getParseResult().originalArgs());
    }

    public static void main(String[] args) {
        //new CommandLine(new App()).usage(System.out);

        //test: these are all valid
        new CommandLine(new App()).execute();
        new CommandLine(new App()).execute("-A -B".split(" "));

        // requires validation in the application to disallow
        new CommandLine(new App()).execute("-A -B -A1".split(" "));

        // picocli validates this, gives: "Error: Missing required argument(s): -A"
        new CommandLine(new App()).execute("-B -A1".split(" "));
    }
}
...