Missing function to print usage about docopt HOT 7 CLOSED

what about exit(__doc__)?

from docopt.

exit(__doc__.split("\n")[0]) — I want to print just usage line

from docopt.

your solution is not bad :-)

I'm now working in a pattern-matching branch, and there I extract the usage, and have it internally. I think it's a good idea to expose it. What API for that can you think of?

I have a weird idea of adding usage as a function attribute:

# 1
from docopt import docopt
exit(docopt.usage)  # or maybe __usage__

or maybe:

# 2
from docopt import docopt
docopt.print_usage()  # something similar to optparse? but weird since it's function attribute.

or:

# 3
from docopt import docopt, print_usage
print_usage()  # but this would require some global state

or make docopt a class:

# 4
from docopt import OptionParser
parser = OptionParser(__doc__)
options, arguments = parser.parse(sys.argv[1:])
parser.print_usage()  # very similar to optparse

from docopt.

I'm thinking of two possibilities:

# 1 (similar to your's # 4)
from docopt import OptionParser
parser = OptionParser(__doc__)
options, arguments = parser.parse(sys.argv[1:])
print >> sys.stderr, parser.usage # I think it's better to leave it to user how to print

or stick with function:

# 2
from docopt import docopt
options, args, meta = docopt(__doc__, need_meta=True) # or just return meta by default
print >> sys.stderr, meta.usage

from docopt.

I, as a user, would prefer:

from docopt import docopt
exit(docopt.usage)

Shortest variant, but weird.

I was thinking that maybe there will be no need to manually print usage after pattern-matching is implemented?
In that case whenever the invocation doesn't match the usage-pattern, docopt will exit showing usage. And since usage-patterns could be as complex as you need, there might be no need for printing usage manually?

from docopt.

I like the last paragraph — good point, looking forward for pattern-matching branch to be released.

from docopt.

@andreypopp
By the way, pattern-matching branch is somewhat usable now. If you want to try it out, you can take a look at this example: https://github.com/halst/docopt/blob/pattern-matching/test_example.py

from docopt.