{"author":"","author_email":"Nick Crews ","bugtrack_url":null,"classifiers":["Development Status :: 4 - Beta","Intended Audience :: Developers","License :: OSI Approved :: MIT License","Operating System :: OS Independent","Programming Language :: Python","Programming Language :: Python :: 3","Programming Language :: Python :: 3 :: Only","Programming Language :: Python :: 3.10","Programming Language :: Python :: 3.7","Programming Language :: Python :: 3.8","Programming Language :: Python :: 3.9","Programming Language :: Python :: Implementation :: CPython","Programming Language :: Python :: Implementation :: PyPy"],"description":"# **docopt-ng** creates *beautiful* command-line interfaces\n\n[![Test](https://github.com/jazzband/docopt-ng/actions/workflows/test.yml/badge.svg?event=push)](https://github.com/jazzband/docopt-ng/actions/workflows/test.yml)\n[![codecov](https://codecov.io/gh/jazzband/docopt-ng/branch/master/graph/badge.svg)](https://codecov.io/gh/jazzband/docopt-ng)\n[![image](https://img.shields.io/pypi/v/docopt-ng.svg)](https://pypi.python.org/pypi/docopt-ng)\n[![Jazzband](https://jazzband.co/static/img/badge.svg)](https://jazzband.co/)\n[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)\n\n**docopt-ng** is a fork of the [original docopt](https://github.com/docopt/docopt), now maintained by the\n[jazzband](https://jazzband.co/) project. Now with maintenance, typehints, and complete test coverage!\n\n**docopt-ng** helps you create beautiful command-line interfaces:\n\n```python\n\"\"\"Naval Fate.\n\nUsage:\n naval_fate.py ship new ...\n naval_fate.py ship move [--speed=]\n naval_fate.py ship shoot \n naval_fate.py mine (set|remove) [--moored | --drifting]\n naval_fate.py (-h | --help)\n naval_fate.py --version\n\nOptions:\n -h --help Show this screen.\n --version Show version.\n --speed= Speed in knots [default: 10].\n --moored Moored (anchored) mine.\n --drifting Drifting mine.\n\n\"\"\"\nfrom docopt import docopt\n\nif __name__ == \"__main__\":\n argv = [\"ship\", \"Guardian\", \"move\", \"100\", \"150\", \"--speed=15\"]\n arguments = docopt(__doc__, argv)\n print(arguments)\n```\n\nresults in:\n\n```python\n{'--drifting': False,\n '--help': False,\n '--moored': False,\n '--speed': '15',\n '--version': False,\n '': ['Guardian'],\n '': '100',\n '': '150',\n 'mine': False,\n 'move': True,\n 'new': False,\n 'remove': False,\n 'set': False,\n 'ship': True,\n 'shoot': False}\n```\n\nBeat that! The option parser is generated based on the docstring above\nthat is passed to `docopt` function. `docopt` parses the usage pattern\n(`\"Usage: ...\"`) and option descriptions (lines starting with dash\n\"`-`\") and ensures that the program invocation matches the usage\npattern; it parses options, arguments and commands based on that. The\nbasic idea is that *a good help message has all necessary information in\nit to make a parser*.\n\nAlso, [PEP 257](http://www.python.org/dev/peps/pep-0257/) recommends\nputting help message in the module docstrings.\n\n# Installation\n\nUse [pip](http://pip-installer.org):\n\n python -m pip install docopt-ng\n\n**docopt-ng** is tested with Python 3.7+.\n\n# API\n\n```python\ndef docopt(\n docstring: str,\n argv: list[str] | str | None = None,\n default_help: bool = True,\n version: Any = None,\n options_first: bool = False,\n) -> ParsedOptions:\n```\n\n`docopt` takes a docstring, and 4 optional arguments:\n\n- `docstring` is a string that contains a **help message** that will be\n used to create the option parser.\n The simple rules of how to write such a help message\n are given in next sections. Typically you would just use `__doc__`.\n\n- `argv` is an optional argument vector; by default `docopt` uses the\n argument vector passed to your program (`sys.argv[1:]`).\n Alternatively you can supply a list of strings like\n `[\"--verbose\", \"-o\", \"hai.txt\"]`, or a single string that will be split\n on spaces like `\"--verbose -o hai.txt\"`.\n\n- `default_help`, by default `True`, specifies whether the parser should\n automatically print the help message (supplied as `doc`) and\n terminate, in case `-h` or `--help` option is encountered (options\n should exist in usage pattern, more on that below). If you want to\n handle `-h` or `--help` options manually (as other options), set\n `help=False`.\n\n- `version`, by default `None`, is an optional argument that specifies\n the version of your program. If supplied, then, (assuming\n `--version` option is mentioned in usage pattern) when parser\n encounters the `--version` option, it will print the supplied\n version and terminate. `version` could be any printable object, but\n most likely a string, e.g. `\"2.1.0rc1\"`.\n\n > Note, when `docopt` is set to automatically handle `-h`, `--help`\n > and `--version` options, you still need to mention them in usage\n > pattern for this to work. Also, for your users to know about them.\n\n- `options_first`, by default `False`. If set to `True` will disallow\n mixing options and positional argument. I.e. after first positional\n argument, all arguments will be interpreted as positional even if\n the look like options. This can be used for strict compatibility\n with POSIX, or if you want to dispatch your arguments to other\n programs.\n\nThe **return** value is a simple dictionary with options, arguments and\ncommands as keys, spelled exactly like in your help message. Long\nversions of options are given priority. Furthermore, dot notation is\nsupported, with preceeding dashes (`-`) and surrounding brackets (`<>`)\nignored, for example `arguments.drifting` or `arguments.x`.\n\n# Help message format\n\nHelp message consists of 2 parts:\n\n- Usage pattern, e.g.:\n\n Usage: my_program.py [-hso FILE] [--quiet | --verbose] [INPUT ...]\n\n- Option descriptions, e.g.:\n\n -h --help show this\n -s --sorted sorted output\n -o FILE specify output file [default: ./test.txt]\n --quiet print less text\n --verbose print more text\n\nTheir format is described below; other text is ignored.\n\n## Usage pattern format\n\n**Usage pattern** is a substring of `doc` that starts with `usage:`\n(case *insensitive*) and ends with a *visibly* empty line. Minimum\nexample:\n\n```python\n\"\"\"Usage: my_program.py\n\n\"\"\"\n```\n\nThe first word after `usage:` is interpreted as your program's name. You\ncan specify your program's name several times to signify several\nexclusive patterns:\n\n```python\n\"\"\"Usage: my_program.py FILE\n my_program.py COUNT FILE\n\n\"\"\"\n```\n\nEach pattern can consist of the following elements:\n\n- **<arguments>**, **ARGUMENTS**. Arguments are specified as\n either upper-case words, e.g. `my_program.py CONTENT-PATH` or words\n surrounded by angular brackets: `my_program.py `.\n- **--options**. Options are words started with dash (`-`), e.g.\n `--output`, `-o`. You can \"stack\" several of one-letter options,\n e.g. `-oiv` which will be the same as `-o -i -v`. The options can\n have arguments, e.g. `--input=FILE` or `-i FILE` or even `-iFILE`.\n However it is important that you specify option descriptions if you\n want your option to have an argument, a default value, or specify\n synonymous short/long versions of the option (see next section on\n option descriptions).\n- **commands** are words that do *not* follow the described above\n conventions of `--options` or `` or `ARGUMENTS`, plus two\n special commands: dash \"`-`\" and double dash \"`--`\" (see below).\n\nUse the following constructs to specify patterns:\n\n- **\\[ \\]** (brackets) **optional** elements. e.g.:\n `my_program.py [-hvqo FILE]`\n- **( )** (parens) **required** elements. All elements that are *not*\n put in **\\[ \\]** are also required, e.g.:\n `my_program.py --path= ...` is the same as\n `my_program.py (--path= ...)`. (Note, \"required options\"\n might be not a good idea for your users).\n- **|** (pipe) **mutually exclusive** elements. Group them using **(\n )** if one of the mutually exclusive elements is required:\n `my_program.py (--clockwise | --counter-clockwise) TIME`. Group them\n using **\\[ \\]** if none of the mutually-exclusive elements are\n required: `my_program.py [--left | --right]`.\n- **...** (ellipsis) **one or more** elements. To specify that\n arbitrary number of repeating elements could be accepted, use\n ellipsis (`...`), e.g. `my_program.py FILE ...` means one or more\n `FILE`-s are accepted. If you want to accept zero or more elements,\n use brackets, e.g.: `my_program.py [FILE ...]`. Ellipsis works as a\n unary operator on the expression to the left.\n- **\\[options\\]** (case sensitive) shortcut for any options. You can\n use it if you want to specify that the usage pattern could be\n provided with any options defined below in the option-descriptions\n and do not want to enumerate them all in usage-pattern.\n- \"`[--]`\". Double dash \"`--`\" is used by convention to separate\n positional arguments that can be mistaken for options. In order to\n support this convention add \"`[--]`\" to your usage patterns.\n- \"`[-]`\". Single dash \"`-`\" is used by convention to signify that\n `stdin` is used instead of a file. To support this add \"`[-]`\" to\n your usage patterns. \"`-`\" acts as a normal command.\n\nIf your pattern allows to match argument-less option (a flag) several\ntimes:\n\n Usage: my_program.py [-v | -vv | -vvv]\n\nthen number of occurrences of the option will be counted. I.e.\n`args[\"-v\"]` will be `2` if program was invoked as `my_program -vv`.\nSame works for commands.\n\nIf your usage patterns allows to match same-named option with argument\nor positional argument several times, the matched arguments will be\ncollected into a list:\n\n Usage: my_program.py --path=...\n\nI.e. invoked with\n`my_program.py file1 file2 --path=./here --path=./there` the returned\ndict will contain `args[\"\"] == [\"file1\", \"file2\"]` and\n`args[\"--path\"] == [\"./here\", \"./there\"]`.\n\n## Option descriptions format\n\n**Option descriptions** consist of a list of options that you put below\nyour usage patterns.\n\nIt is necessary to list option descriptions in order to specify:\n\n- synonymous short and long options,\n- if an option has an argument,\n- if option's argument has a default value.\n\nThe rules are as follows:\n\n- Every line in `doc` that starts with `-` or `--` (not counting\n spaces) is treated as an option description, e.g.:\n\n Options:\n --verbose # GOOD\n -o FILE # GOOD\n Other: --bad # BAD, line does not start with dash \"-\"\n\n- To specify that option has an argument, put a word describing that\n argument after space (or equals \"`=`\" sign) as shown below. Follow\n either <angular-brackets> or UPPER-CASE convention for\n options' arguments. You can use comma if you want to separate\n options. In the example below, both lines are valid, however you are\n recommended to stick to a single style.:\n\n -o FILE --output=FILE # without comma, with \"=\" sign\n -i , --input # with comma, without \"=\" sign\n\n- Use two spaces to separate options with their informal description:\n\n --verbose More text. # BAD, will be treated as if verbose option had\n # an argument \"More\", so use 2 spaces instead\n -q Quit. # GOOD\n -o FILE Output file. # GOOD\n --stdout Use stdout. # GOOD, 2 spaces\n\n- If you want to set a default value for an option with an argument,\n put it into the option-description, in form\n `[default: ]`:\n\n --coefficient=K The K coefficient [default: 2.95]\n --output=FILE Output file [default: test.txt]\n --directory=DIR Some directory [default: ./]\n\n- If the option is not repeatable, the value inside `[default: ...]`\n will be interpreted as string. If it *is* repeatable, it will be\n splited into a list on whitespace:\n\n Usage: my_program.py [--repeatable= --repeatable=]\n [--another-repeatable=]...\n [--not-repeatable=]\n\n # will be [\"./here\", \"./there\"]\n --repeatable= [default: ./here ./there]\n\n # will be [\"./here\"]\n --another-repeatable= [default: ./here]\n\n # will be \"./here ./there\", because it is not repeatable\n --not-repeatable= [default: ./here ./there]\n\n# Examples\n\nWe have an extensive list of\n[examples](https://github.com/jazzband/docopt-ng/tree/master/examples)\nwhich cover every aspect of functionality of **docopt-ng**. Try them\nout, read the source if in doubt.\n\n# Development\n\nWe would *love* to hear what you think about **docopt-ng** on our\n[issues page](https://github.com/jazzband/docopt-ng/issues). Make pull requests, report bugs, and suggest ideas.\n\nTo setup your dev environment, fork this repo and clone it locally.\nWe use [pdm](https://pdm.fming.dev/latest/#installation) to\nmanage the project, so install that first.\n\nThen install dev requirements and the package itself as editable, then\ninstall the pre-commit hooks:\n\n pdm sync -d -G dev\n pdm run pre-commit install\n\nUseful testing, linting, and formatting commands:\n\n pdm run pytest\n pdm run black .\n pdm run ruff .\n","description_content_type":"text/markdown","docs_url":null,"download_url":"","downloads":{"last_day":-1,"last_month":-1,"last_week":-1},"dynamic":null,"home_page":"","keywords":"","license":"MIT","license_expression":null,"license_files":null,"maintainer":"","maintainer_email":"","name":"docopt-ng","package_url":"https://pypi.org/project/docopt-ng/","platform":null,"project_url":"https://pypi.org/project/docopt-ng/","project_urls":{"Homepage":"https://github.com/jazzband/docopt-ng","Repository":"https://github.com/jazzband/docopt-ng"},"provides_extra":null,"release_url":"https://pypi.org/project/docopt-ng/0.9.0/","requires_dist":null,"requires_python":">=3.7","summary":"Jazzband-maintained fork of docopt, the humane command line arguments parser.","version":"0.9.0","yanked":false,"yanked_reason":null}

Package search

docopt-ng

project_urls

Dependencies

All package metadata

Releases