Best Practice apache common cli - optionen für hilfe ausblenden

[zer0zer0]

hallo,

da es beim apache common cli project ( 1.2 ) leider kein forum gibt, nur ne mailing-list für die entwickler da, versuche ich mal hier meine frage zu stellen.

ich suche einen weg, wie ich bestimmte optionen ( die nur für debugging / teste zwecke dienen ) für die hilfe auszublenden, damit einfache benutzer des console-programms nicht optionen angezeigt bekommen, die für sie nicht relevant sind.

leider habe ich keine gute möglich gefunden, wie ich das machen könnte. hatte vlt. gehofft das es irgendwie unterstützt wird, scheint aber nicht der fall zu ( oder doch irgendwie? ).

hat jemand eine idee, bzw. sowas ähnliches auch schonmal gebraucht?

gruß,
robin

 

[turtle]

Zum Ersten gibt es NATÜRLICH eine user mailing list.

Zum Punkt#2: Useage-Ausgabe mit Debugging-Optionen
In der Tat habe ich das noch nicht gemacht. Die Useage Zeilen werden mit der Klasse org.apache.commons.cli.HelpFormatter zusammen gebaut. Diese Klasse müsstest du erweitern/anpassen. Hab aber den Eindruck, das es mit dem Handling out-of-the-box gehen sollte,wenn du "nur" die richtigen Optionen angibst:

formatter.printHelp("myapp", header, options, footer, true);

Ich rate dir, und das ist ein grosser Vorteil von Open-Source-Software, in den Quellcode zu schauen und wenns nicht passt, zu ändern.

 

[zer0zer0]

ja ich hatte nur nicht den eindruck das es in den mailing-lists darum geht, so allgemeine und praktische fragen zum umgang mit dem tool zu stellen, sondern eher so framework-entwickler-unter-sich ;-)

das es mit dem Handling out-of-the-box gehen sollte,wenn du "nur" die richtigen Optionen angibst

problem dabei ist das ich alle optionen schon initial setze. sowas wie removeOption gibt es nicht.

deswegen werde das erstellen der optionen jetzt in zwei methoden splitten, damit ich explizit für die hilfe dann nur die optionen ausgeben, die nicht für entwickler gedacht sind. und für das parsen der optionen nehm ich die zusammengeführte menge aus beiden methoden. denke das müsste klappen, das ist recht simpel, bin nur erst nicht darauf gekommen, naja wie das nun manchmal so ist ;-) die "richtigen Optionen" ist da ein guter denkanstoß gewesen, danke dir.

 

[turtle]

Ich sage NICHT, das es das Eleganteste ist, aber du musst doch "nur" zwei verschiedene Optionssätze bauen
Im Beispiel fehlt bei Debug-Optionen das Argument -g2

	public static void main(String[] args) {
		// normale Optionen
		Options lvOptions = new Options();
		lvOptions.addOption("h", "hilfe", false, "zeigt diese Hilfe an.");
		OptionGroup lvGruppe = new OptionGroup();
		lvGruppe.addOption(OptionBuilder.withLongOpt("gruppe1").withDescription("gruppe 1").create("g1"));
		lvGruppe.addOption(OptionBuilder.withLongOpt("gruppe2").withDescription("gruppe 2").create("g2"));
		lvGruppe.addOption(OptionBuilder.withLongOpt("gruppe3").withDescription("gruppe 3").create("g3"));
		lvOptions.addOptionGroup(lvGruppe);

		// debug-Optionen
		Options debugOptions = new Options();
		debugOptions.addOption("h", "hilfe", false, "zeigt diese Hilfe an.");
		OptionGroup debugOptionsGruppe = new OptionGroup();
		debugOptionsGruppe.addOption(OptionBuilder.withLongOpt("gruppe1").withDescription("gruppe 1").create("g1"));
		debugOptionsGruppe.addOption(OptionBuilder.withLongOpt("gruppe3").withDescription("gruppe 3").create("g3"));
		debugOptions.addOptionGroup(debugOptionsGruppe);
		
		HelpFormatter formatter = new HelpFormatter();
		formatter.printHelp("turtle", lvOptions);
		formatter.printHelp("turtleDebug", debugOptions);
		// usage: turtle
		// -g1,--gruppe1 gruppe 1
		// -g2,--gruppe2 gruppe 2
		// -g3,--gruppe3 gruppe 3
		// -h,--hilfe zeigt diese Hilfe an.
		// usage: turtleDebug
		// -g1,--gruppe1 gruppe 1
		// -g3,--gruppe3 gruppe 3
		// -h,--hilfe zeigt diese Hilfe an.
	}

 

[zer0zer0]

ja, würde es im prinzip auch lieber mit OptionGroups machen, sofern man auch in einer OptionGroup auch mehrere argumente einer gruppe "geparst" bekommt:

Options userOptions = new Options();
userOptions.addOption( "h", "hilfe", false, "zeigt diese Hilfe an." );
OptionGroup userGroup = new OptionGroup();

userGroup.addOption( OptionBuilder.withLongOpt( "gruppe1" ).withDescription( "gruppe 1" ).hasArg().create( "g1" ) );
userGroup.addOption( OptionBuilder.withLongOpt( "gruppe2" ).withDescription( "gruppe 2" ).hasArg().create( "g2" ) );
userGroup.addOption( OptionBuilder.withLongOpt( "gruppe3" ).withDescription( "gruppe 3" ).hasArg().create( "g3" ) );
userOptions.addOptionGroup( userGroup );

Options debugOptions = new Options();
debugOptions.addOption( "h", "hilfe", false, "zeigt diese Hilfe an." );
OptionGroup debugGroup = new OptionGroup();
debugGroup.addOption( OptionBuilder.withLongOpt( "gruppe1" ).withDescription( "gruppe 1" ).hasArg().create( "g1" ) );
debugGroup.addOption( OptionBuilder.withLongOpt( "gruppe3" ).withDescription( "gruppe 3" ).hasArg().create( "g3" ) );
debugOptions.addOptionGroup( debugGroup );

HelpFormatter formatter = new HelpFormatter();
formatter.printHelp( "turtle", userOptions );
formatter.printHelp( "turtleDebug", debugOptions );


userOptions.addOptionGroup( debugGroup );

formatter.printHelp( "both", userOptions );

CommandLineParser parser = new PosixParser();
String[] arguments = new String[]{
    "--g1", "bla",
    "--g3", "blubb"
};
CommandLine line = parser.parse( userOptions, arguments );

aber da kommt dann beim parsen:

[WR]org.apache.commons.cli.AlreadySelectedException: The option 'g3' was specified but an option from this group has already been selected: 'g1'[/WR]

ich habs jetzt mit der variante gemacht wie ich es beschrieben hatte, sieht in etwa so aus ( da kann der dann auch mehrere argumente dieser gruppierungen parsen ):

private Options createMergedOptions() {
    return this.createOptions( ( Option[] ) ArrayUtils.addAll( getDebugOptions(), getOptions() ) );
}

private Options createUserOptions() {
    return this.createOptions( getOptions() );
}

private Options createDebugOptions() {
    return this.createOptions( getDebugOptions() );
}

private Options createOptions( Option[] opts ) {
    Options options = new Options();
    for( Option opt : opts ) {
        options.addOption( opt );
    }
    return options;
}

private Option[] getDebugOptions() {
    return new Option[]{
        new Option( null, "app-dir", true, "application directory." ),
        new Option( null, "dir-has", true, "check whether a directory is set." )
    };
}
private Option[] getOptions() {
    return new Option[]{
        new Option( "s", "scan", false, "scan / rescan your directories." ),
        new Option( "v", "verbose", false, "log common events to console." ),
        new Option( null, "source-location", true, "current path location. REQUIRED!" ),
        new Option( null, "source-drive", true, "current drive identification label." )
    };
}

 

[turtle]

[JAPI]OptionGroup
A group of mutually exclusive options.[/JAPI]