Helpstring in argparse, each string from new line
up vote
0
down vote
favorite
I am doing a CLI utility. When adding a docstring to call help for the module with the function -- help in console, I was faced with the fact that all the added text is displayed as a continuous, unbreakable message. How to separate strings from each other? I tried to add n at the end of the line, but this does not work.
def createParser():
parser = argparse.ArgumentParser(
prog='samplefind',
description="""
Script to search for matches by word or lines in a text file and save the found information in a new outfile.txt file.
From command line run python sfind.py .
To view all available options: python sfind.py -h .
"""
python docstring
asked Nov 11 at 11:42
lepiloff
10919
add a comment |
up vote
0
down vote
favorite
I am doing a CLI utility. When adding a docstring to call help for the module with the function -- help in console, I was faced with the fact that all the added text is displayed as a continuous, unbreakable message. How to separate strings from each other? I tried to add n at the end of the line, but this does not work.
def createParser():
parser = argparse.ArgumentParser(
prog='samplefind',
description="""
Script to search for matches by word or lines in a text file and save the found information in a new outfile.txt file.
From command line run python sfind.py .
To view all available options: python sfind.py -h .
"""
python docstring
asked Nov 11 at 11:42
lepiloff
10919
1
That is not adocstringin the usual sense. Please change your title tohelpstring inargparse.
– kabanus
Nov 11 at 12:09
add a comment |
up vote
0
down vote
favorite
up vote
0
down vote
favorite
I am doing a CLI utility. When adding a docstring to call help for the module with the function -- help in console, I was faced with the fact that all the added text is displayed as a continuous, unbreakable message. How to separate strings from each other? I tried to add n at the end of the line, but this does not work.
def createParser():
parser = argparse.ArgumentParser(
prog='samplefind',
description="""
Script to search for matches by word or lines in a text file and save the found information in a new outfile.txt file.
From command line run python sfind.py .
To view all available options: python sfind.py -h .
"""
python docstring
asked Nov 11 at 11:42
lepiloff
10919
I am doing a CLI utility. When adding a docstring to call help for the module with the function -- help in console, I was faced with the fact that all the added text is displayed as a continuous, unbreakable message. How to separate strings from each other? I tried to add n at the end of the line, but this does not work.
def createParser():
parser = argparse.ArgumentParser(
prog='samplefind',
description="""
Script to search for matches by word or lines in a text file and save the found information in a new outfile.txt file.
From command line run python sfind.py .
To view all available options: python sfind.py -h .
"""
python docstring
python docstring
asked Nov 11 at 11:42
lepiloff
10919
asked Nov 11 at 11:42
lepiloff
10919
edited Nov 11 at 12:13
asked Nov 11 at 11:42
lepiloff
10919
asked Nov 11 at 11:42
lepiloff
10919
asked Nov 11 at 11:42
lepiloff
10919
10919
1
That is not adocstringin the usual sense. Please change your title tohelpstring inargparse.
– kabanus
Nov 11 at 12:09
add a comment |
1
That is not adocstringin the usual sense. Please change your title tohelpstring inargparse.
– kabanus
Nov 11 at 12:09
1
1
That is not a
docstring in the usual sense. Please change your title to help string in argparse.– kabanus
Nov 11 at 12:09
That is not a
docstring in the usual sense. Please change your title to help string in argparse.– kabanus
Nov 11 at 12:09
add a comment |
1 Answer
1
active
oldest
votes
up vote
2
down vote
accepted
Use formatter_class=argparse.RawTextHelpFormatter to retain all spaces in your help string. This is the argparse application help string, not a docstring. Could look a bit ugly though:
parser = argparse.ArgumentParser(
prog='samplefind',
formatter_class=argparse.RawTextHelpFormatter,
description="""
Script to search for matches by word or lines in a text file and save the found information in a new outfile.txt file.
From command line run python sfind.py .
To view all available options: python sfind.py -h .
""")
From terminal:
py bla.py -h usage: samplefind [-h]
Script to search for matches by word or lines in a text file and save the found information in a new outfile.txt file.
From command line run python sfind.py .
To view all available options: python sfind.py -h .
Do note that this include spaces from the beginning of line, new lines, everything.
answered Nov 11 at 11:45
kabanus
10.9k21237
I do not know why but it does not work for me.
– lepiloff
Nov 11 at 11:51
@lepiloff In what way does it not work? Are you using an IDE? Did you try toprint(thefunc.__doc__)and it did not produce newlines? Or use it inhelp(thefunc)?
– kabanus
Nov 11 at 11:54
print(thefunc.__doc__)return None
– lepiloff
Nov 11 at 11:59
1
@lepiloff you completely changed the question. That is not adocstring. I will edit.
– kabanus
Nov 11 at 12:00
add a comment |
1 Answer
1
active
oldest
votes
1 Answer
1
active
oldest
votes
active
oldest
votes
active
oldest
votes
up vote
2
down vote
accepted
Use formatter_class=argparse.RawTextHelpFormatter to retain all spaces in your help string. This is the argparse application help string, not a docstring. Could look a bit ugly though:
parser = argparse.ArgumentParser(
prog='samplefind',
formatter_class=argparse.RawTextHelpFormatter,
description="""
Script to search for matches by word or lines in a text file and save the found information in a new outfile.txt file.
From command line run python sfind.py .
To view all available options: python sfind.py -h .
""")
From terminal:
py bla.py -h usage: samplefind [-h]
Script to search for matches by word or lines in a text file and save the found information in a new outfile.txt file.
From command line run python sfind.py .
To view all available options: python sfind.py -h .
Do note that this include spaces from the beginning of line, new lines, everything.
answered Nov 11 at 11:45
kabanus
10.9k21237
I do not know why but it does not work for me.
– lepiloff
Nov 11 at 11:51
@lepiloff In what way does it not work? Are you using an IDE? Did you try toprint(thefunc.__doc__)and it did not produce newlines? Or use it inhelp(thefunc)?
– kabanus
Nov 11 at 11:54
print(thefunc.__doc__)return None
– lepiloff
Nov 11 at 11:59
1
@lepiloff you completely changed the question. That is not adocstring. I will edit.
– kabanus
Nov 11 at 12:00
add a comment |
up vote
2
down vote
accepted
Use formatter_class=argparse.RawTextHelpFormatter to retain all spaces in your help string. This is the argparse application help string, not a docstring. Could look a bit ugly though:
parser = argparse.ArgumentParser(
prog='samplefind',
formatter_class=argparse.RawTextHelpFormatter,
description="""
Script to search for matches by word or lines in a text file and save the found information in a new outfile.txt file.
From command line run python sfind.py .
To view all available options: python sfind.py -h .
""")
From terminal:
py bla.py -h usage: samplefind [-h]
Script to search for matches by word or lines in a text file and save the found information in a new outfile.txt file.
From command line run python sfind.py .
To view all available options: python sfind.py -h .
Do note that this include spaces from the beginning of line, new lines, everything.
answered Nov 11 at 11:45
kabanus
10.9k21237
I do not know why but it does not work for me.
– lepiloff
Nov 11 at 11:51
@lepiloff In what way does it not work? Are you using an IDE? Did you try toprint(thefunc.__doc__)and it did not produce newlines? Or use it inhelp(thefunc)?
– kabanus
Nov 11 at 11:54
print(thefunc.__doc__)return None
– lepiloff
Nov 11 at 11:59
1
@lepiloff you completely changed the question. That is not adocstring. I will edit.
– kabanus
Nov 11 at 12:00
add a comment |
up vote
2
down vote
accepted
up vote
2
down vote
accepted
Use formatter_class=argparse.RawTextHelpFormatter to retain all spaces in your help string. This is the argparse application help string, not a docstring. Could look a bit ugly though:
parser = argparse.ArgumentParser(
prog='samplefind',
formatter_class=argparse.RawTextHelpFormatter,
description="""
Script to search for matches by word or lines in a text file and save the found information in a new outfile.txt file.
From command line run python sfind.py .
To view all available options: python sfind.py -h .
""")
From terminal:
py bla.py -h usage: samplefind [-h]
Script to search for matches by word or lines in a text file and save the found information in a new outfile.txt file.
From command line run python sfind.py .
To view all available options: python sfind.py -h .
Do note that this include spaces from the beginning of line, new lines, everything.
answered Nov 11 at 11:45
kabanus
10.9k21237
Use formatter_class=argparse.RawTextHelpFormatter to retain all spaces in your help string. This is the argparse application help string, not a docstring. Could look a bit ugly though:
parser = argparse.ArgumentParser(
prog='samplefind',
formatter_class=argparse.RawTextHelpFormatter,
description="""
Script to search for matches by word or lines in a text file and save the found information in a new outfile.txt file.
From command line run python sfind.py .
To view all available options: python sfind.py -h .
""")
From terminal:
py bla.py -h usage: samplefind [-h]
Script to search for matches by word or lines in a text file and save the found information in a new outfile.txt file.
From command line run python sfind.py .
To view all available options: python sfind.py -h .
Do note that this include spaces from the beginning of line, new lines, everything.
answered Nov 11 at 11:45
kabanus
10.9k21237
edited Nov 11 at 12:07
answered Nov 11 at 11:45
kabanus
10.9k21237
answered Nov 11 at 11:45
kabanus
10.9k21237
answered Nov 11 at 11:45
kabanus
10.9k21237
10.9k21237
I do not know why but it does not work for me.
– lepiloff
Nov 11 at 11:51
@lepiloff In what way does it not work? Are you using an IDE? Did you try toprint(thefunc.__doc__)and it did not produce newlines? Or use it inhelp(thefunc)?
– kabanus
Nov 11 at 11:54
print(thefunc.__doc__)return None
– lepiloff
Nov 11 at 11:59
1
@lepiloff you completely changed the question. That is not adocstring. I will edit.
– kabanus
Nov 11 at 12:00
add a comment |
I do not know why but it does not work for me.
– lepiloff
Nov 11 at 11:51
@lepiloff In what way does it not work? Are you using an IDE? Did you try toprint(thefunc.__doc__)and it did not produce newlines? Or use it inhelp(thefunc)?
– kabanus
Nov 11 at 11:54
print(thefunc.__doc__)return None
– lepiloff
Nov 11 at 11:59
1
@lepiloff you completely changed the question. That is not adocstring. I will edit.
– kabanus
Nov 11 at 12:00
I do not know why but it does not work for me.
– lepiloff
Nov 11 at 11:51
I do not know why but it does not work for me.
– lepiloff
Nov 11 at 11:51
@lepiloff In what way does it not work? Are you using an IDE? Did you try to
print(thefunc.__doc__) and it did not produce newlines? Or use it in help(thefunc)?– kabanus
Nov 11 at 11:54
@lepiloff In what way does it not work? Are you using an IDE? Did you try to
print(thefunc.__doc__) and it did not produce newlines? Or use it in help(thefunc)?– kabanus
Nov 11 at 11:54
print(thefunc.__doc__) return None– lepiloff
Nov 11 at 11:59
print(thefunc.__doc__) return None– lepiloff
Nov 11 at 11:59
1
1
@lepiloff you completely changed the question. That is not a
docstring. I will edit.– kabanus
Nov 11 at 12:00
@lepiloff you completely changed the question. That is not a
docstring. I will edit.– kabanus
Nov 11 at 12:00
add a comment |
Thanks for contributing an answer to Stack Overflow!
- Please be sure to answer the question. Provide details and share your research!
But avoid …
- Asking for help, clarification, or responding to other answers.
- Making statements based on opinion; back them up with references or personal experience.
To learn more, see our tips on writing great answers.
Some of your past answers have not been well-received, and you're in danger of being blocked from answering.
Please pay close attention to the following guidance:
- Please be sure to answer the question. Provide details and share your research!
But avoid …
- Asking for help, clarification, or responding to other answers.
- Making statements based on opinion; back them up with references or personal experience.
To learn more, see our tips on writing great answers.
Sign up or log in
StackExchange.ready(function () {
StackExchange.helpers.onClickDraftSave('#login-link');
});
Sign up using Google
Sign up using Facebook
Sign up using Email and Password
Post as a guest
Required, but never shown
StackExchange.ready(
function () {
StackExchange.openid.initPostLogin('.new-post-login', 'https%3a%2f%2fstackoverflow.com%2fquestions%2f53248388%2fhelpstring-in-argparse-each-string-from-new-line%23new-answer', 'question_page');
}
);
Post as a guest
Required, but never shown
Sign up or log in
StackExchange.ready(function () {
StackExchange.helpers.onClickDraftSave('#login-link');
});
Sign up using Google
Sign up using Facebook
Sign up using Email and Password
Post as a guest
Required, but never shown
Sign up or log in
StackExchange.ready(function () {
StackExchange.helpers.onClickDraftSave('#login-link');
});
Sign up using Google
Sign up using Facebook
Sign up using Email and Password
Post as a guest
Required, but never shown
Sign up or log in
StackExchange.ready(function () {
StackExchange.helpers.onClickDraftSave('#login-link');
});
Sign up using Google
Sign up using Facebook
Sign up using Email and Password
Sign up using Google
Sign up using Facebook
Sign up using Email and Password
Post as a guest
Required, but never shown
Required, but never shown
Required, but never shown
Required, but never shown
Required, but never shown
Required, but never shown
Required, but never shown
Required, but never shown
Required, but never shown
1
That is not a
docstringin the usual sense. Please change your title tohelpstring inargparse.– kabanus
Nov 11 at 12:09