argparse
API
Generated with
argparse/argparse.core/OutputApi

OutputApi

argparse.core.OutputApi
See theOutputApi companion object
trait OutputApi extends ParsersApi with TypesApi with Printers

Attributes

Companion:
object
Graph
Supertypes
trait Printers
trait TypesApi
class Object
trait Matchable
class Any
Known subtypes
trait MacroApi
trait Api
object default.type

Members list

Concise view

Type members

Classlikes

trait Printer[A]

Attributes

Graph
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object given_Printer_Unit.type

Inherited classlikes

class ArgumentParser(val description: String, val helpFlags: Seq[String], val bashCompletionFlags: Seq[String])

A simple command line argument parser.

A simple command line argument parser.

Usage:

  1. Define parameters with param, requiredParam and repeatedParam. Each of these methods gives back a handle to a future argument value.

  2. Call parseOrExit() with actual arguments.

  3. If parsing succeeds, the arguments will be available in the handles defined in step 1.

If parsing fails, error descriptions are printed and the program exits with 2.

Example:

val parser = argparse.default.ArgumentParser()

val p1 = parser.param[String]("--this-is-a-named-param", default = "default value")
val p2 = parser.param[Int]("positional-param", default = 2)

parser.parseOrExit(Seq("--this-is-a-named-param=other", 5))
println(p1.value)
println(p2.value)

Attributes

bashCompletionFlag

Use these flags to print a sourceable bash-completion script. Set to empty to disable.

description

A short description of this command. Used in help messages.

helpFlags

Use these flags to print the help message. Set to empty to disable.

Inherited from:
ParsersApi
Graph
Supertypes
class Object
trait Matchable
class Any
object ArgumentParser

Attributes

Inherited from:
ParsersApi
Graph
Supertypes
class Object
trait Matchable
class Any
object Reader

Attributes

Inherited from:
TypesApi
Graph
Supertypes
class Object
trait Matchable
class Any
trait Reader[A]

A typeclass that defines how to convert a string from a single command line argument to a given type.

A typeclass that defines how to convert a string from a single command line argument to a given type.

Attributes

Inherited from:
TypesApi
Graph
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object BooleanReader.type
object DoubleReader.type
object DurationReader.type
object FloatReader.type
trait FsPathReader[A]
object FilePathReader.type
object JavaFileReader.type
object JavaPathReader.type
object PathReader.type
object RelPathReader.type
object SubPathReader.type
object InputStreamReader.type
object InstantReader.type
object LocalDateReader.type
object LocalTime.type
object OutputStreamReader.type
object RangeReader.type
object ReadableReader.type
object given_Printer_Array extends Printer[Array[Byte]]

Attributes

Inherited from:
Printers
Graph
Supertypes
trait Printer[Array[Byte]]
class Object
trait Matchable
class Any
object given_Printer_Unit extends Printer[Unit]

Attributes

Inherited from:
Printers
Graph
Supertypes
trait Printer[Unit]
class Object
trait Matchable
class Any
object given_Printer_Writable extends Printer[Writable]

Attributes

Inherited from:
Printers
Graph
Supertypes
trait Printer[Writable]
class Object
trait Matchable
class Any

Value members

Concrete methods

def handleError(t: Throwable): Nothing

Top-level error handler for command line applications using the annotation API.

Top-level error handler for command line applications using the annotation API.

You can override this to change what should be done on errors.

The default implementation prints the exception's message unless the DEBUG environment variable is set, in which case the whole stack trace is printed. Then, it exits with error code 1.

Attributes

Inherited methods

def defaultBashCompletionFlags: Seq[String]

The name of the flag to use for generating standalone bash-completion.

The name of the flag to use for generating standalone bash-completion.

Set this to empty to disable bash-completion entirely.

Note that individual argument parsers may override this.

Attributes

Inherited from:
ParsersApi
def defaultHelpFlags: Seq[String]

The name of the flag to use for printing help messages.

The name of the flag to use for printing help messages.

Set this to empty to disable help entirely.

Note that individual argument parsers may override this.

Attributes

Inherited from:
ParsersApi
def defaultHelpMessage(parser: ArgumentParser): String

Generate a help message from parameters.

Generate a help message from parameters.

This message will be used by ArgumentParsers. Overriding this allows you to customize the help message of all ArgumentParsers.

Attributes

Inherited from:
ParsersApi
protected def exit(code: Int): Nothing

Called by parseOrExit in case of error.

Called by parseOrExit in case of error.

Overriding this can be useful in situations where you do not want to exit, for example in tests.

Attributes

Inherited from:
ParsersApi

Givens

Inherited givens

given anyPrinter[A]: anyPrinter[A]

Attributes

Inherited from:
LowPrioPrinters
given given_Printer_Array: given_Printer_Array.type

Attributes

Inherited from:
Printers
given given_Printer_Future[A](using p: Printer[A]): given_Printer_Future[A]

Attributes

Inherited from:
Printers
given given_Printer_Generator[A](using p: Printer[A]): given_Printer_Generator[A]

Attributes

Inherited from:
Printers
given given_Printer_Unit: given_Printer_Unit.type

Attributes

Inherited from:
Printers
given given_Printer_Writable: given_Printer_Writable.type

Attributes

Inherited from:
Printers
given nonProductListPrinter[A <: Iterable[B], B](using elemPrinter: Printer[B]): nonProductListPrinter[A, B]

Attributes

Inherited from:
Printers
inline given productListPrinter[A <: Iterable[B], B <: Product](using m: ProductLabels[B]): productListPrinter[A, B]

Attributes

Inherited from:
Printers

Implicits

Inherited implicits

implicit val StringReader: Reader[String]

Attributes

Inherited from:
TypesApi
Generated with