Doc-SIG

Download

doc-sig@python.org

July 2009

4 participants
2 discussions

Out-of-service message for Python 3.0 docs?
by Georg Brandl July 26, 2009

July 26, 2009

Hi, I wondered if it might sense to put some text into the 3.0 docs that said that it's not supported anymore and users should go to 3.1. Mockup: http://pocoo.org/~g/note.png The link will go to the equivalent page in the 3.1 docs. What do you think? Georg -- Thus spake the Lord: Thou shalt indent with four spaces. No more, no less. Four shall be the number of spaces thou shalt indent, and the number of thy indenting shall be four. Eight shalt thou not indent, nor either indent thou two, excepting that thou then proceed to four. Tabs are right out.

2 1

PEP 257 question
by Fred Mailhot July 23, 2009

July 23, 2009

Hi, It is stated in PEP 257 that: "The docstring of a script (a stand-alone program) should be usable as its "usage" message, printed when the script is invoked with incorrect or missing arguments (or perhaps with a "-h" option, for "help").[...]" This is exactly what I'm trying to do, but I haven't been able to figure out how to access a script's docstring from within it. That is, I'm assuming (perhaps erroneously) that I can define some kind of usage function in my script that will spit out the docstring, as in the following example #!/usr/bin/python """ myscript.py Usage: python myscript.py <params> Some more specific info here. """ [python code here] def main(): [do stuff here] ### THIS IS WHAT I'D LIKE TO DO... ### def usage(): sys.stderr.write(this.__doc__) sys.exit() ### EXCEPT OF COURSE "this" ISN'T DEFINED if __name__ == "__main__": if [some condition is not satisfied]: usage() else: main() ################################ What should I be doing instead? I've Googled a bunch and turned up nothing, so I may just not be looking for the right terms (Googling "python print script docstring" gets me nothing). Thanks! Fred.

3 3