Packages

p

argparse

package argparse

Ordering
  1. Alphabetic
Visibility
  1. Public
  2. Protected

Package Members

  1. package core

Type Members

  1. final class Argument[A] extends () => A

    The future value of an argument.

    The future value of an argument.

    You can obtain an instance of this class through the various param() methods of ArgumentParser.

    Once arguments have been parsed by the ArgumentParser, the .value() method in this class will become available.

  2. sealed trait BashCompleter extends AnyRef
  3. case class arg(aliases: Seq[String] = Seq(), doc: String = "", env: String = null) extends Annotation with StaticAnnotation with Product with Serializable
  4. case class main() extends Annotation with StaticAnnotation with Product with Serializable

Deprecated Type Members

  1. case class dirs(name: String, system: Boolean = false) extends Product with Serializable

    Common directories for an application of a given name.

    Common directories for an application of a given name.

    The directories here are implemented as a mix of the XDG Base Directory Specification, macOS adaptations and a fallback to classic unix directories for system applications.

    Applications are encouraged to use these directories instead of creating their own hierarchies. They are particularly well-suited for use as parameter defaults, for example:

    val parser = argparse.ArgumentParser() val cache = parser.param[os.Path]( "--cache-dir", default = argparse.dirs("myapp").cache

    name

    the name of the application

    system

    use system-wide paths instead of user-specific ones

    Annotations
    @deprecated
    Deprecated

    (Since version 0.10.3) use userdirs for user-specific directories, and the FHS standard for system dirs

Value Members

  1. object BashCompleter
  2. object default extends Api

    The recommended API bundle.

    The recommended API bundle. Includes readers for most common types.

  3. object term

    Properties of the current terminal.

  4. object userdirs

    Common directories for *user* applications, as specified by the [XDG Base Directory Specification](https://specifications.freedesktop.org/basedir-spec/basedir-spec-latest.html), with some adaptations made for macOS.

    Common directories for *user* applications, as specified by the [XDG Base Directory Specification](https://specifications.freedesktop.org/basedir-spec/basedir-spec-latest.html), with some adaptations made for macOS.

    See also

    dirs for conventional directories for an application of a given name, including system services.

Deprecated Value Members

  1. object dirs extends Serializable
    Annotations
    @deprecated
    Deprecated

    (Since version 0.10.3) use userdirs for user-specific directories, and the FHS standard for system dirs

Ungrouped