Module documentation

2006-03-26 Thread Tony Burrows
Just getting to grips with Python, a great language BUT
With something like Java I can find the syntax of a method call with no
problems, how do I do the same with Python?

For example, using MySQLdb or SGMLParser I can see what the available
methods are with dir, but how do I find out what parameters are needed and
what they represent?

Tony
-- 
http://mail.python.org/mailman/listinfo/python-list


Re: Module documentation

2006-03-26 Thread Tony Burrows
On Sun, 26 Mar 2006 17:19:35 +0200, Rene Pijlman wrote:

> Tony Burrows:
>>With something like Java I can find the syntax of a method call with no
>>problems, how do I do the same with Python?
> 
> The basic syntax is just the name, with parameters in brakcets:
> 
>object.method(par1, par2, ...)
> 
> This is explained in the documentation, of course.
> 
>>how do I find out what parameters are needed and what they represent?
> 
> This is documented in the library reference:
> http://docs.python.org/modindex.html
> 
> You can also query the module for its docstrings:
> 
>>>>import os
>>>>help(os)
> ...
>>>>help(os.utime)
> Help on built-in function utime in module nt:
> ...
Wow!  Thanks for that, I didn't know about the help command.  The problem
was that things like MySQLdb wasn't in the link you give (or at least, I
couldn't find it - though poking around did take me to the database
section and there it was).

Tony
-- 
http://mail.python.org/mailman/listinfo/python-list