Python documentation for Selenium2.0 Web Driver

[Anagha]

Hi Folks,
I am new to Selenium and after a little bit of reading/searching
decided to go with Web Driver and Selenium 2.0. I've got it installed
and running and am able to test a few things but I am not able to find
the complete documentation for using the python bindings. Is there
something like this excellent Java documentation below for python as
well ?

http://selenium.googlecode.com/svn/tags/selenium-2.0-rc-2/docs/api/java/index.html?org/openqa/selenium/WebDriver.html

Any help will be greatly appreciated.

[Anagha Mudigonda]

Anagha

[Luke Inman-Semerau]

There isn't any JavaDoc like documentation for python. But it's not hard to view the source either what you have in your site-packages or in the source:

http://code.google.com/p/selenium/source/browse/trunk/py/selenium/webdriver

there's also always the command line interpreter:

python

>> from selenium import webdriver

>> dir(webdriver)

....

>> ff = webdriver.Firefox()

>> dir(ff)

....

dir will return a list all the attributes (method or object) that are on the passed in object.

--
You received this message because you are subscribed to the Google Groups "Selenium Users" group.
To post to this group, send email to seleniu...@googlegroups.com.
To unsubscribe from this group, send email to selenium-user...@googlegroups.com.
For more options, visit this group at http://groups.google.com/group/selenium-users?hl=en.

[mrstevegross]

I ran into the same problem. Yes, I can read the source. But that's no
excuse for missing documentation. Clearly, the source has nice
documentation; someone at Selenium simply needs to periodically run
pydoc on it to create nice, browsable documentation. Can someone at
selenium take care of that?

In the meantime, you can always run:
pydoc -w selenium.py

To create web-browsable documentation.

Thanks,
--Steve

[Luke Inman-Semerau]

i've logged a new issue for this enhancement:

http://code.google.com/p/selenium/issues/detail?id=2360

Feel free to supply a patch to get this done. There is no one "at Selenium"... everyone volunteers on the side to contribute to this project.

[mrstevegross]

> Feel free to supply a patch to get this done. There is no one "at
> Selenium"... everyone volunteers on the side to contribute to this project.

Ok, I can do that. But this would be a post-submit hook into the
Selenium website. Is there a mechanism for doing stuff like that?

Thanks,
--Steve

[Luke Inman-Semerau]

All we are doing right now on the downloads page (http://code.google.com/p/selenium/source/browse/websites/www.seleniumhq.org/src/main/webapp/download/index.html) is linking to the checked in docs (http://code.google.com/p/selenium/source/browse/trunk/docs/) which is hosted via googlecode.

No real hooks necessary other than what I mentioned about the Rakefile (http://code.google.com/p/selenium/source/browse/trunk/Rakefile) building it automatically.

So, submitting a patch to the Rakefile and/or the rake-tasks/  that will do the py doc generation and put the output into trunk/docs/api/py  would be nice, then I'm sure whoever applying the patch will check in the generated content into the docs folder. (Then I can take care of adding the link to the downloads page).

Thanks,
--Steve

[Stéphane Klein]

Hi,

note there are another Selenium Python documentation here :

http://readthedocs.org/docs/selenium-python/en/latest/

The source code of this documentation is here :

https://github.com/baijum/selenium-python

Some points this document need to be improved.

Regards,
Stephane