Module access from inside itself

[Steven]

I'm writing a Python script which can be called from the command-line, and
I want to use my module doc string as the CL help text, but I don't know
how to access my module object from inside the module.

I've tried searching for an answer, but haven't found anything. Please
excuse me if I'm missing something simple, I'm a newbie to Python.

I'm doing something like this:

#!/usr/bin/python
"""Module doc string goes here.
"""

import getopt, sys

def MyFunction(args):
* * pass

if __name__ == "__main__":
* * opts, args = getop.getopt(sys.argv[1:], [], ["help"])
* * for opt in opts:
* * * * if opt == "--help":
* * * * * * print MY_MODULE.__doc__ * *# How do I get this?
* * * * else:
* * * * * * MyFunction(args)

How do I get a reference to the module from inside the module? Is this
the Pythonic way of generating help strings for CL scripts?
Thanks,
--
Steven D'Aprano

[Oren Tirosh]

On Fri, Aug 15, 2003 at 04:20:43PM +0000, Steven wrote:

I'm writing a Python script which can be called from the command-line, and
I want to use my module doc string as the CL help text, but I don't know
how to access my module object from inside the module.

You don't need the module object for this. MY_MODULE.__doc__ is the
same as accessing __doc__ directly.

If you really need the current module object use sys.modules[__name__]

Oren

[Scott David Daniels]

Steven wrote:

I'm writing a Python script which can be called from the command-line, and
I want to use my module doc string as the CL help text, but I don't know
how to access my module object from inside the module.

How about this:

# demo of accessing the docstring:

"""
This is a test.

Had this been a real document, it would have said something.
"""
if __name__ == '__main__':
import __main__
print __main__.__doc__

[Bengt Richter]

On Fri, 15 Aug 2003 16:20:43 GMT, Steven <di***@mikka.net.au> wrote:

I'm writing a Python script which can be called from the command-line, and
I want to use my module doc string as the CL help text, but I don't know
how to access my module object from inside the module.

I've tried searching for an answer, but haven't found anything. Please
excuse me if I'm missing something simple, I'm a newbie to Python.

I'm doing something like this:

#!/usr/bin/python
"""Module doc string goes here.
"""

import getopt, sys

def MyFunction(args):
* * pass

if __name__ == "__main__":
* * opts, args = getop.getopt(sys.argv[1:], [], ["help"])
* * for opt in opts:
* * * * if opt == "--help":
* * * * * * print MY_MODULE.__doc__ * *# How do I get this? * * * * * * print __doc__ * *# should get it
* * * * else:
* * * * * * MyFunction(args)

How do I get a reference to the module from inside the module? Is this
the Pythonic way of generating help strings for CL scripts?

You are already inside the module, so an unqualified name will refer
to module globals unless it's being used in some local scope that has
a binding shadowing the global name.

Regards,
Bengt Richter

[Aahz]

In article <pa**********************************@mikka.net.au >,
Steven <di***@mikka.net.au> wrote:

if __name__ == "__main__":
* * opts, args = getop.getopt(sys.argv[1:], [], ["help"])
* * for opt in opts:
* * * * if opt == "--help":
* * * * * * print MY_MODULE.__doc__ * *# How do I get this?
* * * * else:
* * * * * * MyFunction(args)

import __main__
print __main__.__doc__
--
Aahz (aa**@pythoncraft.com) <*> http://www.pythoncraft.com/

This is Python. We don't care much about theory, except where it intersects
with useful practice. --Aahz