python docopt: "expected string or buffer"

Question

I am using docopt module to handle python script options :

from docopt import docopt
"""Usage:
  ./convert [ -h | -i | -t | -c ]

Options:
  -h          Show this help
  -i          Convert image to vertical scroll box
  -t          Convert text to vertical scroll box
  -c          Convert command list to html
"""

def main(docopt_args):
...
if __name__ == '__main__':
    args = docopt(__doc__, version='v0.1')
    main(args)

Traceback (most recent call last): File
"/home/ajn/Converter-yaml-to-html-blocks/convert.py", line 66, in
args = docopt(doc, version='v0.1') File "/usr/local/lib/python3.4/dist-packages/docopt.py", line 558, in docopt
DocoptExit.usage = printable_usage(doc) File "/usr/local/lib/python3.4/dist-packages/docopt.py", line 466, in printable_usage
usage_split = re.split(r'([Uu][Ss][Aa][Gg][Ee]:)', doc) File "/usr/lib/python3.4/re.py", line 196, in split
return _compile(pattern, flags).split(string, maxsplit) TypeError: expected string or buffer

Any hint?

I suspect that the __doc__ you're passing is None, which is neither a string nor a buffer. (Remember: "Explicit is better than implicit".) — 9000
– 9000, Commented Jul 2, 2017 at 4:19

EarthDragon · Accepted Answer · 2017-07-02 04:25:06Z

16

Move the doc string to the start of the file (before the import line)

answered Jul 2, 2017 at 4:25

EarthDragon

7554 silver badges14 bronze badges

Sign up to request clarification or add additional context in comments.

2 Comments

pylearner Over a year ago

I didnt understand this...can anyone reply to this ?

Pani Over a year ago

the docstring is the string literal after the import. I added a new answer explaining it a bit

Pani · Accepted Answer · 2020-06-03 10:55:04Z

1

To anyone confused, when using docopt you should write a docstring before the from docopt import docopt. The options for the arguments are generated by parsing that string automatically. In this question the docstring is:

"""Usage:
  ./convert [ -h | -i | -t | -c ]

Options:
  -h          Show this help
  -i          Convert image to vertical scroll box
  -t          Convert text to vertical scroll box
  -c          Convert command list to html
"""

and should have been placed before the import.

See more examples at the README of the project here

edited Jun 3, 2020 at 10:55

answered Jun 2, 2020 at 11:11

Pani

1,4071 gold badge17 silver badges23 bronze badges

Collectives™ on Stack Overflow

python docopt: "expected string or buffer"

2 Answers 2

2 Comments

Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

2 Answers 2

2 Comments

Comments

Your Answer

Sign up or log in

Post as a guest

Related