├── .coveragerc
├── .gitignore
├── .travis.yml
├── HISTORY.rst
├── LICENSE
├── MANIFEST.in
├── Makefile
├── NOTICE
├── README.rst
├── dev-requirements.txt
├── docs
    ├── Makefile
    ├── _themes
    │   ├── .gitignore
    │   ├── LICENSE
    │   ├── flask_theme_support.py
    │   ├── kr
    │   │   ├── layout.html
    │   │   ├── relations.html
    │   │   ├── static
    │   │   │   ├── flasky.css_t
    │   │   │   └── small_flask.css
    │   │   └── theme.conf
    │   └── kr_small
    │   │   ├── layout.html
    │   │   ├── static
    │   │       └── flasky.css_t
    │   │   └── theme.conf
    ├── api.rst
    ├── authors.rst
    ├── conf.py
    ├── contributing.rst
    ├── history.rst
    ├── index.rst
    ├── installation.rst
    ├── make.bat
    ├── modules.rst
    ├── readme.rst
    ├── robobrowser.forms.rst
    ├── robobrowser.rst
    └── usage.rst
├── robobrowser
    ├── __init__.py
    ├── browser.py
    ├── cache.py
    ├── compat.py
    ├── exceptions.py
    ├── forms
    │   ├── __init__.py
    │   ├── fields.py
    │   └── form.py
    ├── helpers.py
    ├── ordereddict.py
    └── responses.py
├── setup.cfg
├── setup.py
├── tests
    ├── __init__.py
    ├── fixtures.py
    ├── test_browser.py
    ├── test_cache.py
    ├── test_forms.py
    ├── test_helpers.py
    └── utils.py
└── tox.ini


/.coveragerc:
--------------------------------------------------------------------------------
1 | [report]
2 | omit =
3 |     robobrowser/ordereddict.py
4 |     robobrowser/responses.py
5 |     */python?.?/*
6 |     */lib-python/?.?/*.py
7 |     */pypy/*
8 | 


--------------------------------------------------------------------------------
/.gitignore:
--------------------------------------------------------------------------------
 1 | *.py[cod]
 2 | .idea/
 3 | 
 4 | # C extensions
 5 | *.so
 6 | 
 7 | # Packages
 8 | *.egg
 9 | *.egg-info
10 | dist
11 | build
12 | eggs
13 | parts
14 | bin
15 | var
16 | sdist
17 | develop-eggs
18 | .installed.cfg
19 | lib
20 | lib64
21 | 
22 | # Installer logs
23 | pip-log.txt
24 | 
25 | # Unit test / coverage reports
26 | .coverage
27 | .tox
28 | nosetests.xml
29 | 
30 | # Translations
31 | *.mo
32 | 
33 | # Mr Developer
34 | .mr.developer.cfg
35 | .project
36 | .pydevproject
37 | 
38 | # Complexity
39 | output/*.html
40 | output/*/index.html
41 | 
42 | # Sphinx
43 | docs/_build
44 | 


--------------------------------------------------------------------------------
/.travis.yml:
--------------------------------------------------------------------------------
 1 | language: python
 2 | sudo: false
 3 | 
 4 | python:
 5 |     - "3.4"
 6 |     - "3.3"
 7 |     - "2.7"
 8 |     - "2.6"
 9 |     - "pypy"
10 | 
11 | install:
12 |     - python setup.py install
13 |     - pip install -U -r dev-requirements.txt
14 |     - pip install coverage coveralls nose responses
15 | 
16 | before_script: flake8 robobrowser
17 | 
18 | script: nosetests --with-coverage --cover-package=robobrowser
19 | 
20 | after_success: coveralls
21 | 


--------------------------------------------------------------------------------
/HISTORY.rst:
--------------------------------------------------------------------------------
 1 | .. :changelog:
 2 | 
 3 | History
 4 | -------
 5 | 
 6 | 0.5.3
 7 | ++++++++++++++++++
 8 | * Improve documentation. Thanks tpugsley and rcutmore for improvements!
 9 | * Improve messages in error handling. Thanks again rcutmore!
10 | * Fix default values for <select> fields. Thanks pohmelie for reporting!
11 | * Simplify value property of field elements; delete `FieldMeta`.
12 | * Move retry logic to requests and urllib3.
13 | 
14 | 0.5.2
15 | ++++++++++++++++++
16 | * Remove requirements parsing from `setup.py`.
17 | * Don't pin to exact requirements versions. Thanks StuntsPT!
18 | * Don't install tests along with package. Thanks voyageur!
19 | * Handle empty select fields. Thanks pratyushmittal!
20 | * Parse partial document correctly when lxml is installed. Thanks again pratyushmittal!
21 | * Lint code with flake8.
22 | 
23 | 0.5.0
24 | ++++++++++++++++++
25 | * Add optional `session` argument to `RoboBrowser::__init__`
26 | * Add optional `timeout` and `allow_redirects` options to `RoboBrowser::__init__`
27 | * Allow `RoboBrowser::open`, `RoboBrowser::follow_link`, and `RoboBrowser::submit_form` to accept optional keyword arguments to requests (`timeout`, `verify`, etc.)
28 | * *Backwards-incompatible*: Remove `auth`, `headers`,  and `verify` arguments `from RoboBrowser::__init__`; session configuration should instead be passed in `session`
29 | * *Backwards-incompatible*: Restrict `RoboBrowser::follow_link` to `link` argument; text strings and BeautifulSoup arguments no longer accepted
30 | 
31 | 0.4.1
32 | ++++++++++++++++++
33 | * Handle multi-option fields without "value" attributes
34 | 
35 | 0.4.0
36 | ++++++++++++++++++
37 | * Fix modeling of form fields to handle non-unique field names.
38 | * Allow selection of submit button if multiple submits are present.
39 | 
40 | 0.1.0
41 | ++++++++++++++++++
42 | 
43 | * First release on PyPI.
44 | 


--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
 1 | Copyright (c) "", Joshua Carp
 2 | All rights reserved.
 3 | 
 4 | Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
 5 | 
 6 | * Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
 7 | 
 8 | * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
 9 | 
10 | * Neither the name of robobrowser nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
11 | 
12 | THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.


--------------------------------------------------------------------------------
/MANIFEST.in:
--------------------------------------------------------------------------------
1 | include AUTHORS.rst
2 | include CONTRIBUTING.rst
3 | include HISTORY.rst
4 | include LICENSE
5 | include README.rst
6 | include requirements.txt
7 | 


--------------------------------------------------------------------------------
/Makefile:
--------------------------------------------------------------------------------
 1 | .PHONY: clean-pyc clean-build docs
 2 | 
 3 | help:
 4 | 	@echo "clean-build - remove build artifacts"
 5 | 	@echo "clean-pyc - remove Python file artifacts"
 6 | 	@echo "lint - check style with flake8"
 7 | 	@echo "test - run tests quickly with the default Python"
 8 | 	@echo "testall - run tests on every Python version with tox"
 9 | 	@echo "coverage - check code coverage quickly with the default Python"
10 | 	@echo "docs - generate Sphinx HTML documentation, including API docs"
11 | 	@echo "release - package and upload a release"
12 | 	@echo "sdist - package"
13 | 
14 | clean: clean-build clean-pyc
15 | 
16 | clean-build:
17 | 	rm -fr build/
18 | 	rm -fr dist/
19 | 	rm -fr *.egg-info
20 | 
21 | clean-pyc:
22 | 	find . -name '*.pyc' -exec rm -f {} +
23 | 	find . -name '*.pyo' -exec rm -f {} +
24 | 	find . -name '*~' -exec rm -f {} +
25 | 
26 | lint:
27 | 	flake8 robobrowser tests
28 | 
29 | test:
30 | 	python setup.py test
31 | 
32 | test-all:
33 | 	tox
34 | 
35 | coverage:
36 | 	coverage run --source robobrowser setup.py test
37 | 	coverage report -m
38 | 	coverage html
39 | 	open htmlcov/index.html
40 | 
41 | docs:
42 | 	rm -f docs/robobrowser.rst
43 | 	rm -f docs/modules.rst
44 | 	sphinx-apidoc -o docs/ robobrowser
45 | 	$(MAKE) -C docs clean
46 | 	$(MAKE) -C docs html
47 | 	open docs/_build/html/index.html
48 | 
49 | release: clean
50 | 	python setup.py sdist upload
51 | 
52 | sdist: clean
53 | 	python setup.py sdist
54 | 	ls -l dist


--------------------------------------------------------------------------------
/NOTICE:
--------------------------------------------------------------------------------
 1 | RoboBrowser's caching module is heavily inspired by httpcache, so its license
 2 | is included here:
 3 | 
 4 | Copyright 2013 Cory Benfield
 5 | 
 6 | Licensed under the Apache License, Version 2.0 (the "License");
 7 | you may not use this work except in compliance with the License.
 8 | You may obtain a copy of the License at
 9 | 
10 |     http://www.apache.org/licenses/LICENSE-2.0
11 | 
12 | Unless required by applicable law or agreed to in writing, software
13 | distributed under the License is distributed on an "AS IS" BASIS,
14 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15 | See the License for the specific language governing permissions and
16 | limitations under the License.
17 | 


--------------------------------------------------------------------------------
/README.rst:
--------------------------------------------------------------------------------
  1 | RoboBrowser: Your friendly neighborhood web scraper
  2 | ===============================================
  3 | 
  4 | .. image:: https://badge.fury.io/py/robobrowser.png
  5 |     :target: http://badge.fury.io/py/robobrowser
  6 | 
  7 | .. image:: https://travis-ci.org/jmcarp/robobrowser.png?branch=master
  8 |         :target: https://travis-ci.org/jmcarp/robobrowser
  9 | 
 10 | .. image:: https://coveralls.io/repos/jmcarp/robobrowser/badge.png?branch=master
 11 |         :target: https://coveralls.io/r/jmcarp/robobrowser
 12 | 
 13 | Homepage: `http://robobrowser.readthedocs.org/ <http://robobrowser.readthedocs.org/>`_
 14 | 
 15 | RoboBrowser is a simple, Pythonic library for browsing the web without a standalone web browser. RoboBrowser
 16 | can fetch a page, click on links and buttons, and fill out and submit forms. If you need to interact with web services
 17 | that don't have APIs, RoboBrowser can help.
 18 | 
 19 | .. code-block:: python
 20 | 
 21 |     import re
 22 |     from robobrowser import RoboBrowser
 23 | 
 24 |     # Browse to Genius
 25 |     browser = RoboBrowser(history=True)
 26 |     browser.open('http://genius.com/')
 27 | 
 28 |     # Search for Porcupine Tree
 29 |     form = browser.get_form(action='/search')
 30 |     form                # <RoboForm q=>
 31 |     form['q'].value = 'porcupine tree'
 32 |     browser.submit_form(form)
 33 | 
 34 |     # Look up the first song
 35 |     songs = browser.select('.song_link')
 36 |     browser.follow_link(songs[0])
 37 |     lyrics = browser.select('.lyrics')
 38 |     lyrics[0].text      # \nHear the sound of music ...
 39 | 
 40 |     # Back to results page
 41 |     browser.back()
 42 | 
 43 |     # Look up my favorite song
 44 |     song_link = browser.get_link('trains')
 45 |     browser.follow_link(song_link)
 46 | 
 47 |     # Can also search HTML using regex patterns
 48 |     lyrics = browser.find(class_=re.compile(r'\blyrics\b'))
 49 |     lyrics.text         # \nTrain set and match spied under the blind...
 50 | 
 51 | RoboBrowser combines the best of two excellent Python libraries:
 52 | `Requests <http://docs.python-requests.org/en/latest/>`_ and
 53 | `BeautifulSoup <http://www.crummy.com/software/BeautifulSoup/>`_.
 54 | RoboBrowser represents browser sessions using Requests and HTML responses
 55 | using BeautifulSoup, transparently exposing methods of both libraries:
 56 | 
 57 | .. code-block:: python
 58 | 
 59 |     import re
 60 |     from robobrowser import RoboBrowser
 61 | 
 62 |     browser = RoboBrowser(user_agent='a python robot')
 63 |     browser.open('https://github.com/')
 64 | 
 65 |     # Inspect the browser session
 66 |     browser.session.cookies['_gh_sess']         # BAh7Bzo...
 67 |     browser.session.headers['User-Agent']       # a python robot
 68 | 
 69 |     # Search the parsed HTML
 70 |     browser.select('div.teaser-icon')       # [<div class="teaser-icon">
 71 |                                             # <span class="mega-octicon octicon-checklist"></span>
 72 |                                             # </div>,
 73 |                                             # ...
 74 |     browser.find(class_=re.compile(r'column', re.I))    # <div class="one-third column">
 75 |                                                         # <div class="teaser-icon">
 76 |                                                         # <span class="mega-octicon octicon-checklist"></span>
 77 |                                                         # ...
 78 | 
 79 | You can also pass a custom `Session` instance for lower-level configuration:
 80 | 
 81 | .. code-block:: python
 82 | 
 83 |     from requests import Session
 84 |     from robobrowser import RoboBrowser
 85 | 
 86 |     session = Session()
 87 |     session.verify = False  # Skip SSL verification
 88 |     session.proxies = {'http': 'http://custom.proxy.com/'}  # Set default proxies
 89 |     browser = RoboBrowser(session=session)
 90 | 
 91 | RoboBrowser also includes tools for working with forms, inspired by
 92 | `WebTest <https://github.com/Pylons/webtest>`_ and `Mechanize <http://wwwsearch.sourceforge.net/mechanize/>`_.
 93 | 
 94 | .. code-block:: python
 95 | 
 96 |     from robobrowser import RoboBrowser
 97 | 
 98 |     browser = RoboBrowser()
 99 |     browser.open('http://twitter.com')
100 | 
101 |     # Get the signup form
102 |     signup_form = browser.get_form(class_='signup')
103 |     signup_form         # <RoboForm user[name]=, user[email]=, ...
104 | 
105 |     # Inspect its values
106 |     signup_form['authenticity_token'].value     # 6d03597 ...
107 | 
108 |     # Fill it out
109 |     signup_form['user[name]'].value = 'python-robot'
110 |     signup_form['user[user_password]'].value = 'secret'
111 | 
112 |     # Submit the form
113 |     browser.submit_form(signup_form)
114 | 
115 | Checkboxes:
116 | 
117 | .. code-block:: python
118 | 
119 |     from robobrowser import RoboBrowser
120 | 
121 |     # Browse to a page with checkbox inputs
122 |     browser = RoboBrowser()
123 |     browser.open('http://www.w3schools.com/html/html_forms.asp')
124 | 
125 |     # Find the form
126 |     form = browser.get_forms()[3]
127 |     form                            # <RoboForm vehicle=[]>
128 |     form['vehicle']                 # <robobrowser.forms.fields.Checkbox...>
129 | 
130 |     # Checked values can be get and set like lists
131 |     form['vehicle'].options         # [u'Bike', u'Car']
132 |     form['vehicle'].value           # []
133 |     form['vehicle'].value = ['Bike']
134 |     form['vehicle'].value = ['Bike', 'Car']
135 | 
136 |     # Values can also be set using input labels
137 |     form['vehicle'].labels          # [u'I have a bike', u'I have a car \r\n']
138 |     form['vehicle'].value = ['I have a bike']
139 |     form['vehicle'].value           # [u'Bike']
140 | 
141 |     # Only values that correspond to checkbox values or labels can be set;
142 |     # this will raise a `ValueError`
143 |     form['vehicle'].value = ['Hot Dogs']
144 | 
145 | Uploading files:
146 | 
147 | .. code-block:: python
148 | 
149 |     from robobrowser import RoboBrowser
150 | 
151 |     # Browse to a page with an upload form
152 |     browser = RoboBrowser()
153 |     browser.open('http://cgi-lib.berkeley.edu/ex/fup.html')
154 | 
155 |     # Find the form
156 |     upload_form = browser.get_form()
157 |     upload_form                     # <RoboForm upfile=, note=>
158 | 
159 |     # Choose a file to upload
160 |     upload_form['upfile']           # <robobrowser.forms.fields.FileInput...>
161 |     upload_form['upfile'].value = open('path/to/file.txt', 'r')
162 | 
163 |     # Submit
164 |     browser.submit(upload_form)
165 | 
166 | By default, creating a browser instantiates a new requests `Session`. 
167 | 
168 | Requirements
169 | ------------
170 | 
171 | - Python >= 2.6 or >= 3.3
172 | 
173 | License
174 | -------
175 | 
176 | MIT licensed. See the bundled `LICENSE <https://github.com/jmcarp/robobrowser/blob/master/LICENSE>`_ file for more details.
177 | 
178 | 


--------------------------------------------------------------------------------
/dev-requirements.txt:
--------------------------------------------------------------------------------
1 | coverage
2 | coveralls
3 | docutils
4 | flake8
5 | mock
6 | nose
7 | sphinx
8 | tox
9 | 


--------------------------------------------------------------------------------
/docs/Makefile:
--------------------------------------------------------------------------------
  1 | # Makefile for Sphinx documentation
  2 | #
  3 | 
  4 | # You can set these variables from the command line.
  5 | SPHINXOPTS    =
  6 | SPHINXBUILD   = sphinx-build
  7 | PAPER         =
  8 | BUILDDIR      = _build
  9 | 
 10 | # User-friendly check for sphinx-build
 11 | ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1)
 12 | $(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/)
 13 | endif
 14 | 
 15 | # Internal variables.
 16 | PAPEROPT_a4     = -D latex_paper_size=a4
 17 | PAPEROPT_letter = -D latex_paper_size=letter
 18 | ALLSPHINXOPTS   = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
 19 | # the i18n builder cannot share the environment and doctrees with the others
 20 | I18NSPHINXOPTS  = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
 21 | 
 22 | .PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext
 23 | 
 24 | help:
 25 | 	@echo "Please use \`make <target>' where <target> is one of"
 26 | 	@echo "  html       to make standalone HTML files"
 27 | 	@echo "  dirhtml    to make HTML files named index.html in directories"
 28 | 	@echo "  singlehtml to make a single large HTML file"
 29 | 	@echo "  pickle     to make pickle files"
 30 | 	@echo "  json       to make JSON files"
 31 | 	@echo "  htmlhelp   to make HTML files and a HTML help project"
 32 | 	@echo "  qthelp     to make HTML files and a qthelp project"
 33 | 	@echo "  devhelp    to make HTML files and a Devhelp project"
 34 | 	@echo "  epub       to make an epub"
 35 | 	@echo "  latex      to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
 36 | 	@echo "  latexpdf   to make LaTeX files and run them through pdflatex"
 37 | 	@echo "  latexpdfja to make LaTeX files and run them through platex/dvipdfmx"
 38 | 	@echo "  text       to make text files"
 39 | 	@echo "  man        to make manual pages"
 40 | 	@echo "  texinfo    to make Texinfo files"
 41 | 	@echo "  info       to make Texinfo files and run them through makeinfo"
 42 | 	@echo "  gettext    to make PO message catalogs"
 43 | 	@echo "  changes    to make an overview of all changed/added/deprecated items"
 44 | 	@echo "  xml        to make Docutils-native XML files"
 45 | 	@echo "  pseudoxml  to make pseudoxml-XML files for display purposes"
 46 | 	@echo "  linkcheck  to check all external links for integrity"
 47 | 	@echo "  doctest    to run all doctests embedded in the documentation (if enabled)"
 48 | 
 49 | clean:
 50 | 	rm -rf $(BUILDDIR)/*
 51 | 
 52 | html:
 53 | 	$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
 54 | 	@echo
 55 | 	@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
 56 | 
 57 | dirhtml:
 58 | 	$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
 59 | 	@echo
 60 | 	@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
 61 | 
 62 | singlehtml:
 63 | 	$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
 64 | 	@echo
 65 | 	@echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
 66 | 
 67 | pickle:
 68 | 	$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
 69 | 	@echo
 70 | 	@echo "Build finished; now you can process the pickle files."
 71 | 
 72 | json:
 73 | 	$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
 74 | 	@echo
 75 | 	@echo "Build finished; now you can process the JSON files."
 76 | 
 77 | htmlhelp:
 78 | 	$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
 79 | 	@echo
 80 | 	@echo "Build finished; now you can run HTML Help Workshop with the" \
 81 | 	      ".hhp project file in $(BUILDDIR)/htmlhelp."
 82 | 
 83 | qthelp:
 84 | 	$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
 85 | 	@echo
 86 | 	@echo "Build finished; now you can run "qcollectiongenerator" with the" \
 87 | 	      ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
 88 | 	@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/complexity.qhcp"
 89 | 	@echo "To view the help file:"
 90 | 	@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/complexity.qhc"
 91 | 
 92 | devhelp:
 93 | 	$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
 94 | 	@echo
 95 | 	@echo "Build finished."
 96 | 	@echo "To view the help file:"
 97 | 	@echo "# mkdir -p $$HOME/.local/share/devhelp/complexity"
 98 | 	@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/complexity"
 99 | 	@echo "# devhelp"
100 | 
101 | epub:
102 | 	$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
103 | 	@echo
104 | 	@echo "Build finished. The epub file is in $(BUILDDIR)/epub."
105 | 
106 | latex:
107 | 	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
108 | 	@echo
109 | 	@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
110 | 	@echo "Run \`make' in that directory to run these through (pdf)latex" \
111 | 	      "(use \`make latexpdf' here to do that automatically)."
112 | 
113 | latexpdf:
114 | 	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
115 | 	@echo "Running LaTeX files through pdflatex..."
116 | 	$(MAKE) -C $(BUILDDIR)/latex all-pdf
117 | 	@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
118 | 
119 | latexpdfja:
120 | 	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
121 | 	@echo "Running LaTeX files through platex and dvipdfmx..."
122 | 	$(MAKE) -C $(BUILDDIR)/latex all-pdf-ja
123 | 	@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
124 | 
125 | text:
126 | 	$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
127 | 	@echo
128 | 	@echo "Build finished. The text files are in $(BUILDDIR)/text."
129 | 
130 | man:
131 | 	$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
132 | 	@echo
133 | 	@echo "Build finished. The manual pages are in $(BUILDDIR)/man."
134 | 
135 | texinfo:
136 | 	$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
137 | 	@echo
138 | 	@echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
139 | 	@echo "Run \`make' in that directory to run these through makeinfo" \
140 | 	      "(use \`make info' here to do that automatically)."
141 | 
142 | info:
143 | 	$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
144 | 	@echo "Running Texinfo files through makeinfo..."
145 | 	make -C $(BUILDDIR)/texinfo info
146 | 	@echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."
147 | 
148 | gettext:
149 | 	$(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
150 | 	@echo
151 | 	@echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
152 | 
153 | changes:
154 | 	$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
155 | 	@echo
156 | 	@echo "The overview file is in $(BUILDDIR)/changes."
157 | 
158 | linkcheck:
159 | 	$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
160 | 	@echo
161 | 	@echo "Link check complete; look for any errors in the above output " \
162 | 	      "or in $(BUILDDIR)/linkcheck/output.txt."
163 | 
164 | doctest:
165 | 	$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
166 | 	@echo "Testing of doctests in the sources finished, look at the " \
167 | 	      "results in $(BUILDDIR)/doctest/output.txt."
168 | 
169 | xml:
170 | 	$(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml
171 | 	@echo
172 | 	@echo "Build finished. The XML files are in $(BUILDDIR)/xml."
173 | 
174 | pseudoxml:
175 | 	$(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml
176 | 	@echo
177 | 	@echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml."


--------------------------------------------------------------------------------
/docs/_themes/.gitignore:
--------------------------------------------------------------------------------
1 | *.pyc
2 | *.pyo
3 | .DS_Store
4 | 


--------------------------------------------------------------------------------
/docs/_themes/LICENSE:
--------------------------------------------------------------------------------
 1 | Modifications: 
 2 | 
 3 | Copyright (c) 2010 Kenneth Reitz.
 4 | 
 5 | 
 6 | Original Project: 
 7 | 
 8 | Copyright (c) 2010 by Armin Ronacher.
 9 | 
10 | 
11 | Some rights reserved.
12 | 
13 | Redistribution and use in source and binary forms of the theme, with or
14 | without modification, are permitted provided that the following conditions
15 | are met:
16 | 
17 | * Redistributions of source code must retain the above copyright
18 |   notice, this list of conditions and the following disclaimer.
19 | 
20 | * Redistributions in binary form must reproduce the above
21 |   copyright notice, this list of conditions and the following
22 |   disclaimer in the documentation and/or other materials provided
23 |   with the distribution.
24 | 
25 | * The names of the contributors may not be used to endorse or
26 |   promote products derived from this software without specific
27 |   prior written permission.
28 | 
29 | We kindly ask you to only use these themes in an unmodified manner just
30 | for Flask and Flask-related products, not for unrelated projects.  If you
31 | like the visual style and want to use it for your own projects, please
32 | consider making some larger changes to the themes (such as changing
33 | font faces, sizes, colors or margins).
34 | 
35 | THIS THEME IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
36 | AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
37 | IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
38 | ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
39 | LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
40 | CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
41 | SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
42 | INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
43 | CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
44 | ARISING IN ANY WAY OUT OF THE USE OF THIS THEME, EVEN IF ADVISED OF THE
45 | POSSIBILITY OF SUCH DAMAGE.
46 | 


--------------------------------------------------------------------------------
/docs/_themes/flask_theme_support.py:
--------------------------------------------------------------------------------
 1 | # flasky extensions.  flasky pygments style based on tango style
 2 | from pygments.style import Style
 3 | from pygments.token import Keyword, Name, Comment, String, Error, \
 4 |      Number, Operator, Generic, Whitespace, Punctuation, Other, Literal
 5 | 
 6 | 
 7 | class FlaskyStyle(Style):
 8 |     background_color = "#f8f8f8"
 9 |     default_style = ""
10 | 
11 |     styles = {
12 |         # No corresponding class for the following:
13 |         #Text:                     "", # class:  ''
14 |         Whitespace:                "underline #f8f8f8",      # class: 'w'
15 |         Error:                     "#a40000 border:#ef2929", # class: 'err'
16 |         Other:                     "#000000",                # class 'x'
17 | 
18 |         Comment:                   "italic #8f5902", # class: 'c'
19 |         Comment.Preproc:           "noitalic",       # class: 'cp'
20 | 
21 |         Keyword:                   "bold #004461",   # class: 'k'
22 |         Keyword.Constant:          "bold #004461",   # class: 'kc'
23 |         Keyword.Declaration:       "bold #004461",   # class: 'kd'
24 |         Keyword.Namespace:         "bold #004461",   # class: 'kn'
25 |         Keyword.Pseudo:            "bold #004461",   # class: 'kp'
26 |         Keyword.Reserved:          "bold #004461",   # class: 'kr'
27 |         Keyword.Type:              "bold #004461",   # class: 'kt'
28 | 
29 |         Operator:                  "#582800",   # class: 'o'
30 |         Operator.Word:             "bold #004461",   # class: 'ow' - like keywords
31 | 
32 |         Punctuation:               "bold #000000",   # class: 'p'
33 | 
34 |         # because special names such as Name.Class, Name.Function, etc.
35 |         # are not recognized as such later in the parsing, we choose them
36 |         # to look the same as ordinary variables.
37 |         Name:                      "#000000",        # class: 'n'
38 |         Name.Attribute:            "#c4a000",        # class: 'na' - to be revised
39 |         Name.Builtin:              "#004461",        # class: 'nb'
40 |         Name.Builtin.Pseudo:       "#3465a4",        # class: 'bp'
41 |         Name.Class:                "#000000",        # class: 'nc' - to be revised
42 |         Name.Constant:             "#000000",        # class: 'no' - to be revised
43 |         Name.Decorator:            "#888",           # class: 'nd' - to be revised
44 |         Name.Entity:               "#ce5c00",        # class: 'ni'
45 |         Name.Exception:            "bold #cc0000",   # class: 'ne'
46 |         Name.Function:             "#000000",        # class: 'nf'
47 |         Name.Property:             "#000000",        # class: 'py'
48 |         Name.Label:                "#f57900",        # class: 'nl'
49 |         Name.Namespace:            "#000000",        # class: 'nn' - to be revised
50 |         Name.Other:                "#000000",        # class: 'nx'
51 |         Name.Tag:                  "bold #004461",   # class: 'nt' - like a keyword
52 |         Name.Variable:             "#000000",        # class: 'nv' - to be revised
53 |         Name.Variable.Class:       "#000000",        # class: 'vc' - to be revised
54 |         Name.Variable.Global:      "#000000",        # class: 'vg' - to be revised
55 |         Name.Variable.Instance:    "#000000",        # class: 'vi' - to be revised
56 | 
57 |         Number:                    "#990000",        # class: 'm'
58 | 
59 |         Literal:                   "#000000",        # class: 'l'
60 |         Literal.Date:              "#000000",        # class: 'ld'
61 | 
62 |         String:                    "#4e9a06",        # class: 's'
63 |         String.Backtick:           "#4e9a06",        # class: 'sb'
64 |         String.Char:               "#4e9a06",        # class: 'sc'
65 |         String.Doc:                "italic #8f5902", # class: 'sd' - like a comment
66 |         String.Double:             "#4e9a06",        # class: 's2'
67 |         String.Escape:             "#4e9a06",        # class: 'se'
68 |         String.Heredoc:            "#4e9a06",        # class: 'sh'
69 |         String.Interpol:           "#4e9a06",        # class: 'si'
70 |         String.Other:              "#4e9a06",        # class: 'sx'
71 |         String.Regex:              "#4e9a06",        # class: 'sr'
72 |         String.Single:             "#4e9a06",        # class: 's1'
73 |         String.Symbol:             "#4e9a06",        # class: 'ss'
74 | 
75 |         Generic:                   "#000000",        # class: 'g'
76 |         Generic.Deleted:           "#a40000",        # class: 'gd'
77 |         Generic.Emph:              "italic #000000", # class: 'ge'
78 |         Generic.Error:             "#ef2929",        # class: 'gr'
79 |         Generic.Heading:           "bold #000080",   # class: 'gh'
80 |         Generic.Inserted:          "#00A000",        # class: 'gi'
81 |         Generic.Output:            "#888",           # class: 'go'
82 |         Generic.Prompt:            "#745334",        # class: 'gp'
83 |         Generic.Strong:            "bold #000000",   # class: 'gs'
84 |         Generic.Subheading:        "bold #800080",   # class: 'gu'
85 |         Generic.Traceback:         "bold #a40000",   # class: 'gt'
86 |     }
87 | 


--------------------------------------------------------------------------------
/docs/_themes/kr/layout.html:
--------------------------------------------------------------------------------
 1 | {%- extends "basic/layout.html" %}
 2 | {%- block extrahead %}
 3 |   {{ super() }}
 4 |   {% if theme_touch_icon %}
 5 |     <link rel="apple-touch-icon" href="{{ pathto('_static/' ~ theme_touch_icon, 1) }}" />
 6 |   {% endif %}
 7 |   <meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9">
 8 | {% endblock %}
 9 | {%- block relbar2 %}{% endblock %}
10 | {%- block footer %}
11 |     <div class="footer">
12 |       &copy; Copyright {{ copyright }}.
13 |     </div>
14 |     <a href="https://github.com/jmcarp/robobrowser" class="github">
15 |         <img style="position: absolute; top: 0; right: 0; border: 0;" src="http://s3.amazonaws.com/github/ribbons/forkme_right_darkblue_121621.png" alt="Fork me on GitHub"  class="github"/>
16 |     </a>
17 | 
18 | {%- endblock %}
19 | 


--------------------------------------------------------------------------------
/docs/_themes/kr/relations.html:
--------------------------------------------------------------------------------
 1 | <h3>Related Topics</h3>
 2 | <ul>
 3 |   <li><a href="{{ pathto(master_doc) }}">Documentation overview</a><ul>
 4 |   {%- for parent in parents %}
 5 |   <li><a href="{{ parent.link|e }}">{{ parent.title }}</a><ul>
 6 |   {%- endfor %}
 7 |     {%- if prev %}
 8 |       <li>Previous: <a href="{{ prev.link|e }}" title="{{ _('previous chapter')
 9 |         }}">{{ prev.title }}</a></li>
10 |     {%- endif %}
11 |     {%- if next %}
12 |       <li>Next: <a href="{{ next.link|e }}" title="{{ _('next chapter')
13 |         }}">{{ next.title }}</a></li>
14 |     {%- endif %}
15 |   {%- for parent in parents %}
16 |   </ul></li>
17 |   {%- endfor %}
18 |   </ul></li>
19 | </ul>
20 | 


--------------------------------------------------------------------------------
/docs/_themes/kr/static/flasky.css_t:
--------------------------------------------------------------------------------
  1 | /*
  2 |  * flasky.css_t
  3 |  * ~~~~~~~~~~~~
  4 |  *
  5 |  * :copyright: Copyright 2010 by Armin Ronacher. Modifications by Kenneth Reitz.
  6 |  * :license: Flask Design License, see LICENSE for details.
  7 |  */
  8 | 
  9 | {% set page_width = '940px' %}
 10 | {% set sidebar_width = '220px' %}
 11 | 
 12 | @import url("basic.css");
 13 | 
 14 | /* -- page layout ----------------------------------------------------------- */
 15 | 
 16 | body {
 17 |     font-family: 'goudy old style', 'minion pro', 'bell mt', Georgia, 'Hiragino Mincho Pro';
 18 |     font-size: 17px;
 19 |     background-color: white;
 20 |     color: #000;
 21 |     margin: 0;
 22 |     padding: 0;
 23 | }
 24 | 
 25 | div.document {
 26 |     width: {{ page_width }};
 27 |     margin: 30px auto 0 auto;
 28 | }
 29 | 
 30 | div.documentwrapper {
 31 |     float: left;
 32 |     width: 100%;
 33 | }
 34 | 
 35 | div.bodywrapper {
 36 |     margin: 0 0 0 {{ sidebar_width }};
 37 | }
 38 | 
 39 | div.sphinxsidebar {
 40 |     width: {{ sidebar_width }};
 41 | }
 42 | 
 43 | hr {
 44 |     border: 1px solid #B1B4B6;
 45 | }
 46 | 
 47 | div.body {
 48 |     background-color: #ffffff;
 49 |     color: #3E4349;
 50 |     padding: 0 30px 0 30px;
 51 | }
 52 | 
 53 | img.floatingflask {
 54 |     padding: 0 0 10px 10px;
 55 |     float: right;
 56 | }
 57 | 
 58 | div.footer {
 59 |     width: {{ page_width }};
 60 |     margin: 20px auto 30px auto;
 61 |     font-size: 14px;
 62 |     color: #888;
 63 |     text-align: right;
 64 | }
 65 | 
 66 | div.footer a {
 67 |     color: #888;
 68 | }
 69 | 
 70 | div.related {
 71 |     display: none;
 72 | }
 73 | 
 74 | div.sphinxsidebar a {
 75 |     color: #444;
 76 |     text-decoration: none;
 77 |     border-bottom: 1px dotted #999;
 78 | }
 79 | 
 80 | div.sphinxsidebar a:hover {
 81 |     border-bottom: 1px solid #999;
 82 | }
 83 | 
 84 | div.sphinxsidebar {
 85 |     font-size: 14px;
 86 |     line-height: 1.5;
 87 | }
 88 | 
 89 | div.sphinxsidebarwrapper {
 90 |     padding: 18px 10px;
 91 | }
 92 | 
 93 | div.sphinxsidebarwrapper p.logo {
 94 |     padding: 0;
 95 |     margin: -10px 0 0 -20px;
 96 |     text-align: center;
 97 | }
 98 | 
 99 | div.sphinxsidebar h3,
100 | div.sphinxsidebar h4 {
101 |     font-family: 'Garamond', 'Georgia', serif;
102 |     color: #444;
103 |     font-size: 24px;
104 |     font-weight: normal;
105 |     margin: 0 0 5px 0;
106 |     padding: 0;
107 | }
108 | 
109 | div.sphinxsidebar h4 {
110 |     font-size: 20px;
111 | }
112 | 
113 | div.sphinxsidebar h3 a {
114 |     color: #444;
115 | }
116 | 
117 | div.sphinxsidebar p.logo a,
118 | div.sphinxsidebar h3 a,
119 | div.sphinxsidebar p.logo a:hover,
120 | div.sphinxsidebar h3 a:hover {
121 |     border: none;
122 | }
123 | 
124 | div.sphinxsidebar p {
125 |     color: #555;
126 |     margin: 10px 0;
127 | }
128 | 
129 | div.sphinxsidebar ul {
130 |     margin: 10px 0;
131 |     padding: 0;
132 |     color: #000;
133 | }
134 | 
135 | div.sphinxsidebar input {
136 |     border: 1px solid #ccc;
137 |     font-family: 'Georgia', serif;
138 |     font-size: 1em;
139 | }
140 | 
141 | /* -- body styles ----------------------------------------------------------- */
142 | 
143 | a {
144 |     color: #004B6B;
145 |     text-decoration: underline;
146 | }
147 | 
148 | a:hover {
149 |     color: #6D4100;
150 |     text-decoration: underline;
151 | }
152 | 
153 | div.body h1,
154 | div.body h2,
155 | div.body h3,
156 | div.body h4,
157 | div.body h5,
158 | div.body h6 {
159 |     font-family: 'Garamond', 'Georgia', serif;
160 |     font-weight: normal;
161 |     margin: 30px 0px 10px 0px;
162 |     padding: 0;
163 | }
164 | 
165 | div.body h1 { margin-top: 0; padding-top: 0; font-size: 240%; }
166 | div.body h2 { font-size: 180%; }
167 | div.body h3 { font-size: 150%; }
168 | div.body h4 { font-size: 130%; }
169 | div.body h5 { font-size: 100%; }
170 | div.body h6 { font-size: 100%; }
171 | 
172 | a.headerlink {
173 |     color: #ddd;
174 |     padding: 0 4px;
175 |     text-decoration: none;
176 | }
177 | 
178 | a.headerlink:hover {
179 |     color: #444;
180 |     background: #eaeaea;
181 | }
182 | 
183 | div.body p, div.body dd, div.body li {
184 |     line-height: 1.4em;
185 | }
186 | 
187 | div.admonition {
188 |     background: #fafafa;
189 |     margin: 20px -30px;
190 |     padding: 10px 30px;
191 |     border-top: 1px solid #ccc;
192 |     border-bottom: 1px solid #ccc;
193 | }
194 | 
195 | div.admonition tt.xref, div.admonition a tt {
196 |     border-bottom: 1px solid #fafafa;
197 | }
198 | 
199 | dd div.admonition {
200 |     margin-left: -60px;
201 |     padding-left: 60px;
202 | }
203 | 
204 | div.admonition p.admonition-title {
205 |     font-family: 'Garamond', 'Georgia', serif;
206 |     font-weight: normal;
207 |     font-size: 24px;
208 |     margin: 0 0 10px 0;
209 |     padding: 0;
210 |     line-height: 1;
211 | }
212 | 
213 | div.admonition p.last {
214 |     margin-bottom: 0;
215 | }
216 | 
217 | div.highlight {
218 |     background-color: white;
219 | }
220 | 
221 | dt:target, .highlight {
222 |     background: #FAF3E8;
223 | }
224 | 
225 | div.note {
226 |     background-color: #eee;
227 |     border: 1px solid #ccc;
228 | }
229 | 
230 | div.seealso {
231 |     background-color: #ffc;
232 |     border: 1px solid #ff6;
233 | }
234 | 
235 | div.topic {
236 |     background-color: #eee;
237 | }
238 | 
239 | p.admonition-title {
240 |     display: inline;
241 | }
242 | 
243 | p.admonition-title:after {
244 |     content: ":";
245 | }
246 | 
247 | pre, tt {
248 |     font-family: 'Consolas', 'Menlo', 'Deja Vu Sans Mono', 'Bitstream Vera Sans Mono', monospace;
249 |     font-size: 0.9em;
250 | }
251 | 
252 | img.screenshot {
253 | }
254 | 
255 | tt.descname, tt.descclassname {
256 |     font-size: 0.95em;
257 | }
258 | 
259 | tt.descname {
260 |     padding-right: 0.08em;
261 | }
262 | 
263 | img.screenshot {
264 |     -moz-box-shadow: 2px 2px 4px #eee;
265 |     -webkit-box-shadow: 2px 2px 4px #eee;
266 |     box-shadow: 2px 2px 4px #eee;
267 | }
268 | 
269 | table.docutils {
270 |     border: 1px solid #888;
271 |     -moz-box-shadow: 2px 2px 4px #eee;
272 |     -webkit-box-shadow: 2px 2px 4px #eee;
273 |     box-shadow: 2px 2px 4px #eee;
274 | }
275 | 
276 | table.docutils td, table.docutils th {
277 |     border: 1px solid #888;
278 |     padding: 0.25em 0.7em;
279 | }
280 | 
281 | table.field-list, table.footnote {
282 |     border: none;
283 |     -moz-box-shadow: none;
284 |     -webkit-box-shadow: none;
285 |     box-shadow: none;
286 | }
287 | 
288 | table.footnote {
289 |     margin: 15px 0;
290 |     width: 100%;
291 |     border: 1px solid #eee;
292 |     background: #fdfdfd;
293 |     font-size: 0.9em;
294 | }
295 | 
296 | table.footnote + table.footnote {
297 |     margin-top: -15px;
298 |     border-top: none;
299 | }
300 | 
301 | table.field-list th {
302 |     padding: 0 0.8em 0 0;
303 | }
304 | 
305 | table.field-list td {
306 |     padding: 0;
307 | }
308 | 
309 | table.footnote td.label {
310 |     width: 0px;
311 |     padding: 0.3em 0 0.3em 0.5em;
312 | }
313 | 
314 | table.footnote td {
315 |     padding: 0.3em 0.5em;
316 | }
317 | 
318 | dl {
319 |     margin: 0;
320 |     padding: 0;
321 | }
322 | 
323 | dl dd {
324 |     margin-left: 30px;
325 | }
326 | 
327 | blockquote {
328 |     margin: 0 0 0 30px;
329 |     padding: 0;
330 | }
331 | 
332 | ul, ol {
333 |     margin: 10px 0 10px 30px;
334 |     padding: 0;
335 | }
336 | 
337 | pre {
338 |     background: #eee;
339 |     padding: 7px 30px;
340 |     margin: 15px -30px;
341 |     line-height: 1.3em;
342 | }
343 | 
344 | dl pre, blockquote pre, li pre {
345 |     margin-left: -60px;
346 |     padding-left: 60px;
347 | }
348 | 
349 | dl dl pre {
350 |     margin-left: -90px;
351 |     padding-left: 90px;
352 | }
353 | 
354 | tt {
355 |     background-color: #ecf0f3;
356 |     color: #222;
357 |     /* padding: 1px 2px; */
358 | }
359 | 
360 | tt.xref, a tt {
361 |     background-color: #FBFBFB;
362 |     border-bottom: 1px solid white;
363 | }
364 | 
365 | a.reference {
366 |     text-decoration: none;
367 |     border-bottom: 1px dotted #004B6B;
368 | }
369 | 
370 | a.reference:hover {
371 |     border-bottom: 1px solid #6D4100;
372 | }
373 | 
374 | a.footnote-reference {
375 |     text-decoration: none;
376 |     font-size: 0.7em;
377 |     vertical-align: top;
378 |     border-bottom: 1px dotted #004B6B;
379 | }
380 | 
381 | a.footnote-reference:hover {
382 |     border-bottom: 1px solid #6D4100;
383 | }
384 | 
385 | a:hover tt {
386 |     background: #EEE;
387 | }
388 | 
389 | 
390 | @media screen and (max-width: 870px) {
391 | 
392 |     div.sphinxsidebar {
393 |         display: none;
394 |     }
395 | 
396 |     div.document {
397 |        width: 100%;
398 | 
399 |     }
400 | 
401 |     div.documentwrapper {
402 |         margin-left: 0;
403 |         margin-top: 0;
404 |         margin-right: 0;
405 |         margin-bottom: 0;
406 |     }
407 | 
408 |     div.bodywrapper {
409 |         margin-top: 0;
410 |         margin-right: 0;
411 |         margin-bottom: 0;
412 |         margin-left: 0;
413 |     }
414 | 
415 |     ul {
416 |         margin-left: 0;
417 |     }
418 | 
419 |     .document {
420 |         width: auto;
421 |     }
422 | 
423 |     .footer {
424 |         width: auto;
425 |     }
426 | 
427 |     .bodywrapper {
428 |         margin: 0;
429 |     }
430 | 
431 |     .footer {
432 |         width: auto;
433 |     }
434 | 
435 |     .github {
436 |         display: none;
437 |     }
438 | 
439 | 
440 | 
441 | }
442 | 
443 | 
444 | 
445 | @media screen and (max-width: 875px) {
446 | 
447 |     body {
448 |         margin: 0;
449 |         padding: 20px 30px;
450 |     }
451 | 
452 |     div.documentwrapper {
453 |         float: none;
454 |         background: white;
455 |     }
456 | 
457 |     div.sphinxsidebar {
458 |         display: block;
459 |         float: none;
460 |         width: 102.5%;
461 |         margin: 50px -30px -20px -30px;
462 |         padding: 10px 20px;
463 |         background: #333;
464 |         color: white;
465 |     }
466 | 
467 |     div.sphinxsidebar h3, div.sphinxsidebar h4, div.sphinxsidebar p,
468 |     div.sphinxsidebar h3 a {
469 |         color: white;
470 |     }
471 | 
472 |     div.sphinxsidebar a {
473 |         color: #aaa;
474 |     }
475 | 
476 |     div.sphinxsidebar p.logo {
477 |         display: none;
478 |     }
479 | 
480 |     div.document {
481 |         width: 100%;
482 |         margin: 0;
483 |     }
484 | 
485 |     div.related {
486 |         display: block;
487 |         margin: 0;
488 |         padding: 10px 0 20px 0;
489 |     }
490 | 
491 |     div.related ul,
492 |     div.related ul li {
493 |         margin: 0;
494 |         padding: 0;
495 |     }
496 | 
497 |     div.footer {
498 |         display: none;
499 |     }
500 | 
501 |     div.bodywrapper {
502 |         margin: 0;
503 |     }
504 | 
505 |     div.body {
506 |         min-height: 0;
507 |         padding: 0;
508 |     }
509 | 
510 |     .rtd_doc_footer {
511 |         display: none;
512 |     }
513 | 
514 |     .document {
515 |         width: auto;
516 |     }
517 | 
518 |     .footer {
519 |         width: auto;
520 |     }
521 | 
522 |     .footer {
523 |         width: auto;
524 |     }
525 | 
526 |     .github {
527 |         display: none;
528 |     }
529 | }
530 | 
531 | 
532 | /* misc. */
533 | 
534 | .revsys-inline {
535 |     display: none!important;
536 | }
537 | 
538 | div.sphinxsidebar a.flattr-button {
539 |     text-decoration: none;
540 |     border-bottom: none;
541 | }


--------------------------------------------------------------------------------
/docs/_themes/kr/static/small_flask.css:
--------------------------------------------------------------------------------
 1 | /*
 2 |  * small_flask.css_t
 3 |  * ~~~~~~~~~~~~~~~~~
 4 |  *
 5 |  * :copyright: Copyright 2010 by Armin Ronacher.
 6 |  * :license: Flask Design License, see LICENSE for details.
 7 |  */
 8 | 
 9 | body {
10 |     margin: 0;
11 |     padding: 20px 30px;
12 | }
13 | 
14 | div.documentwrapper {
15 |     float: none;
16 |     background: white;
17 | }
18 | 
19 | div.sphinxsidebar {
20 |     display: block;
21 |     float: none;
22 |     width: 102.5%;
23 |     margin: 50px -30px -20px -30px;
24 |     padding: 10px 20px;
25 |     background: #333;
26 |     color: white;
27 | }
28 | 
29 | div.sphinxsidebar h3, div.sphinxsidebar h4, div.sphinxsidebar p,
30 | div.sphinxsidebar h3 a {
31 |     color: white;
32 | }
33 | 
34 | div.sphinxsidebar a {
35 |     color: #aaa;
36 | }
37 | 
38 | div.sphinxsidebar p.logo {
39 |     display: none;
40 | }
41 | 
42 | div.document {
43 |     width: 100%;
44 |     margin: 0;
45 | }
46 | 
47 | div.related {
48 |     display: block;
49 |     margin: 0;
50 |     padding: 10px 0 20px 0;
51 | }
52 | 
53 | div.related ul,
54 | div.related ul li {
55 |     margin: 0;
56 |     padding: 0;
57 | }
58 | 
59 | div.footer {
60 |     display: none;
61 | }
62 | 
63 | div.bodywrapper {
64 |     margin: 0;
65 | }
66 | 
67 | div.body {
68 |     min-height: 0;
69 |     padding: 0;
70 | }
71 | 
72 | .rtd_doc_footer {
73 |     display: none;
74 | }
75 | 
76 | .document {
77 |     width: auto;
78 | }
79 | 
80 | .footer {
81 | 	width: auto;
82 | }
83 | 
84 | .footer {
85 | 	width: auto;
86 | }
87 | 
88 | .github {
89 |     display: none;
90 | }
91 | 
92 | img {
93 |     border: 0px 0px;
94 | }


--------------------------------------------------------------------------------
/docs/_themes/kr/theme.conf:
--------------------------------------------------------------------------------
1 | [theme]
2 | inherit = basic
3 | stylesheet = flasky.css
4 | pygments_style = flask_theme_support.FlaskyStyle
5 | 
6 | [options]
7 | touch_icon = 
8 | 


--------------------------------------------------------------------------------
/docs/_themes/kr_small/layout.html:
--------------------------------------------------------------------------------
 1 | {% extends "basic/layout.html" %}
 2 | {% block header %}
 3 |   {{ super() }}
 4 |   {% if pagename == 'index' %}
 5 |   <div class=indexwrapper>
 6 |   {% endif %}
 7 | {% endblock %}
 8 | {% block footer %}
 9 |   {% if pagename == 'index' %}
10 |   </div>
11 |   {% endif %}
12 | {% endblock %}
13 | {# do not display relbars #}
14 | {% block relbar1 %}{% endblock %}
15 | {% block relbar2 %}
16 |   {% if theme_github_fork %}
17 |     <a href="http://github.com/{{ theme_github_fork }}"><img style="position: fixed; top: 0; right: 0; border: 0;"
18 |     src="http://s3.amazonaws.com/github/ribbons/forkme_right_darkblue_121621.png" alt="Fork me on GitHub" /></a>
19 |   {% endif %}
20 | {% endblock %}
21 | {% block sidebar1 %}{% endblock %}
22 | {% block sidebar2 %}{% endblock %}
23 | 


--------------------------------------------------------------------------------
/docs/_themes/kr_small/static/flasky.css_t:
--------------------------------------------------------------------------------
  1 | /*
  2 |  * flasky.css_t
  3 |  * ~~~~~~~~~~~~
  4 |  *
  5 |  * Sphinx stylesheet -- flasky theme based on nature theme.
  6 |  *
  7 |  * :copyright: Copyright 2007-2010 by the Sphinx team, see AUTHORS.
  8 |  * :license: BSD, see LICENSE for details.
  9 |  *
 10 |  */
 11 |  
 12 | @import url("basic.css");
 13 |  
 14 | /* -- page layout ----------------------------------------------------------- */
 15 |  
 16 | body {
 17 |     font-family: 'Georgia', serif;
 18 |     font-size: 17px;
 19 |     color: #000;
 20 |     background: white;
 21 |     margin: 0;
 22 |     padding: 0;
 23 | }
 24 | 
 25 | div.documentwrapper {
 26 |     float: left;
 27 |     width: 100%;
 28 | }
 29 | 
 30 | div.bodywrapper {
 31 |     margin: 40px auto 0 auto;
 32 |     width: 700px;
 33 | }
 34 | 
 35 | hr {
 36 |     border: 1px solid #B1B4B6;
 37 | }
 38 |  
 39 | div.body {
 40 |     background-color: #ffffff;
 41 |     color: #3E4349;
 42 |     padding: 0 30px 30px 30px;
 43 | }
 44 | 
 45 | img.floatingflask {
 46 |     padding: 0 0 10px 10px;
 47 |     float: right;
 48 | }
 49 |  
 50 | div.footer {
 51 |     text-align: right;
 52 |     color: #888;
 53 |     padding: 10px;
 54 |     font-size: 14px;
 55 |     width: 650px;
 56 |     margin: 0 auto 40px auto;
 57 | }
 58 |  
 59 | div.footer a {
 60 |     color: #888;
 61 |     text-decoration: underline;
 62 | }
 63 |  
 64 | div.related {
 65 |     line-height: 32px;
 66 |     color: #888;
 67 | }
 68 | 
 69 | div.related ul {
 70 |     padding: 0 0 0 10px;
 71 | }
 72 |  
 73 | div.related a {
 74 |     color: #444;
 75 | }
 76 |  
 77 | /* -- body styles ----------------------------------------------------------- */
 78 |  
 79 | a {
 80 |     color: #004B6B;
 81 |     text-decoration: underline;
 82 | }
 83 |  
 84 | a:hover {
 85 |     color: #6D4100;
 86 |     text-decoration: underline;
 87 | }
 88 | 
 89 | div.body {
 90 |     padding-bottom: 40px; /* saved for footer */
 91 | }
 92 |  
 93 | div.body h1,
 94 | div.body h2,
 95 | div.body h3,
 96 | div.body h4,
 97 | div.body h5,
 98 | div.body h6 {
 99 |     font-family: 'Garamond', 'Georgia', serif;
100 |     font-weight: normal;
101 |     margin: 30px 0px 10px 0px;
102 |     padding: 0;
103 | }
104 | 
105 | {% if theme_index_logo %}
106 | div.indexwrapper h1 {
107 |     text-indent: -999999px;
108 |     background: url({{ theme_index_logo }}) no-repeat center center;
109 |     height: {{ theme_index_logo_height }};
110 | }
111 | {% endif %}
112 |  
113 | div.body h2 { font-size: 180%; }
114 | div.body h3 { font-size: 150%; }
115 | div.body h4 { font-size: 130%; }
116 | div.body h5 { font-size: 100%; }
117 | div.body h6 { font-size: 100%; }
118 |  
119 | a.headerlink {
120 |     color: white;
121 |     padding: 0 4px;
122 |     text-decoration: none;
123 | }
124 |  
125 | a.headerlink:hover {
126 |     color: #444;
127 |     background: #eaeaea;
128 | }
129 |  
130 | div.body p, div.body dd, div.body li {
131 |     line-height: 1.4em;
132 | }
133 | 
134 | div.admonition {
135 |     background: #fafafa;
136 |     margin: 20px -30px;
137 |     padding: 10px 30px;
138 |     border-top: 1px solid #ccc;
139 |     border-bottom: 1px solid #ccc;
140 | }
141 | 
142 | div.admonition p.admonition-title {
143 |     font-family: 'Garamond', 'Georgia', serif;
144 |     font-weight: normal;
145 |     font-size: 24px;
146 |     margin: 0 0 10px 0;
147 |     padding: 0;
148 |     line-height: 1;
149 | }
150 | 
151 | div.admonition p.last {
152 |     margin-bottom: 0;
153 | }
154 | 
155 | div.highlight{
156 |     background-color: white;
157 | }
158 | 
159 | dt:target, .highlight {
160 |     background: #FAF3E8;
161 | }
162 | 
163 | div.note {
164 |     background-color: #eee;
165 |     border: 1px solid #ccc;
166 | }
167 |  
168 | div.seealso {
169 |     background-color: #ffc;
170 |     border: 1px solid #ff6;
171 | }
172 |  
173 | div.topic {
174 |     background-color: #eee;
175 | }
176 |  
177 | div.warning {
178 |     background-color: #ffe4e4;
179 |     border: 1px solid #f66;
180 | }
181 |  
182 | p.admonition-title {
183 |     display: inline;
184 | }
185 |  
186 | p.admonition-title:after {
187 |     content: ":";
188 | }
189 | 
190 | pre, tt {
191 |     font-family: 'Consolas', 'Menlo', 'Deja Vu Sans Mono', 'Bitstream Vera Sans Mono', monospace;
192 |     font-size: 0.85em;
193 | }
194 | 
195 | img.screenshot {
196 | }
197 | 
198 | tt.descname, tt.descclassname {
199 |     font-size: 0.95em;
200 | }
201 | 
202 | tt.descname {
203 |     padding-right: 0.08em;
204 | }
205 | 
206 | img.screenshot {
207 |     -moz-box-shadow: 2px 2px 4px #eee;
208 |     -webkit-box-shadow: 2px 2px 4px #eee;
209 |     box-shadow: 2px 2px 4px #eee;
210 | }
211 | 
212 | table.docutils {
213 |     border: 1px solid #888;
214 |     -moz-box-shadow: 2px 2px 4px #eee;
215 |     -webkit-box-shadow: 2px 2px 4px #eee;
216 |     box-shadow: 2px 2px 4px #eee;
217 | }
218 | 
219 | table.docutils td, table.docutils th {
220 |     border: 1px solid #888;
221 |     padding: 0.25em 0.7em;
222 | }
223 | 
224 | table.field-list, table.footnote {
225 |     border: none;
226 |     -moz-box-shadow: none;
227 |     -webkit-box-shadow: none;
228 |     box-shadow: none;
229 | }
230 | 
231 | table.footnote {
232 |     margin: 15px 0;
233 |     width: 100%;
234 |     border: 1px solid #eee;
235 | }
236 | 
237 | table.field-list th {
238 |     padding: 0 0.8em 0 0;
239 | }
240 | 
241 | table.field-list td {
242 |     padding: 0;
243 | }
244 | 
245 | table.footnote td {
246 |     padding: 0.5em;
247 | }
248 | 
249 | dl {
250 |     margin: 0;
251 |     padding: 0;
252 | }
253 | 
254 | dl dd {
255 |     margin-left: 30px;
256 | }
257 |  
258 | pre {
259 |     padding: 0;
260 |     margin: 15px -30px;
261 |     padding: 8px;
262 |     line-height: 1.3em;
263 |     padding: 7px 30px;
264 |     background: #eee;
265 |     border-radius: 2px;
266 |     -moz-border-radius: 2px;
267 |     -webkit-border-radius: 2px;
268 | }
269 | 
270 | dl pre {
271 |     margin-left: -60px;
272 |     padding-left: 60px;
273 | }
274 | 
275 | tt {
276 |     background-color: #ecf0f3;
277 |     color: #222;
278 |     /* padding: 1px 2px; */
279 | }
280 | 
281 | tt.xref, a tt {
282 |     background-color: #FBFBFB;
283 | }
284 | 
285 | a:hover tt {
286 |     background: #EEE;
287 | }
288 | 


--------------------------------------------------------------------------------
/docs/_themes/kr_small/theme.conf:
--------------------------------------------------------------------------------
 1 | [theme]
 2 | inherit = basic
 3 | stylesheet = flasky.css
 4 | nosidebar = true
 5 | pygments_style = flask_theme_support.FlaskyStyle
 6 | 
 7 | [options]
 8 | index_logo = ''
 9 | index_logo_height = 120px
10 | github_fork = ''
11 | 


--------------------------------------------------------------------------------
/docs/api.rst:
--------------------------------------------------------------------------------
 1 | .. _api:
 2 | 
 3 | API Reference
 4 | =============
 5 | 
 6 | browser
 7 | ------------
 8 | 
 9 | .. automodule:: robobrowser.browser
10 |     :members:
11 | 
12 | form
13 | ------------
14 | 
15 | .. automodule:: robobrowser.forms.form
16 |     :members:
17 | 
18 | fields
19 | ------------
20 | 
21 | .. automodule:: robobrowser.forms.fields
22 |     :members:
23 |     :inherited-members:
24 | 


--------------------------------------------------------------------------------
/docs/authors.rst:
--------------------------------------------------------------------------------
1 | .. include:: ../AUTHORS.rst


--------------------------------------------------------------------------------
/docs/conf.py:
--------------------------------------------------------------------------------
  1 | #!/usr/bin/env python
  2 | # -*- coding: utf-8 -*-
  3 | #
  4 | # complexity documentation build configuration file, created by
  5 | # sphinx-quickstart on Tue Jul  9 22:26:36 2013.
  6 | #
  7 | # This file is execfile()d with the current directory set to its containing dir.
  8 | #
  9 | # Note that not all possible configuration values are present in this
 10 | # autogenerated file.
 11 | #
 12 | # All configuration values have a default; values that are commented out
 13 | # serve to show the default.
 14 | 
 15 | import sys, os
 16 | 
 17 | # If extensions (or modules to document with autodoc) are in another directory,
 18 | # add these directories to sys.path here. If the directory is relative to the
 19 | # documentation root, use os.path.abspath to make it absolute, like shown here.
 20 | #sys.path.insert(0, os.path.abspath('.'))
 21 | 
 22 | # Get the project root dir, which is the parent dir of this
 23 | cwd = os.getcwd()
 24 | project_root = os.path.dirname(cwd)
 25 | 
 26 | # Insert the project root dir as the first element in the PYTHONPATH.
 27 | # This lets us ensure that the source package is imported, and that its
 28 | # version is used.
 29 | sys.path.insert(0, project_root)
 30 | sys.path.append(os.path.abspath('_themes'))
 31 | 
 32 | import robobrowser
 33 | 
 34 | # -- General configuration -----------------------------------------------------
 35 | 
 36 | # If your documentation needs a minimal Sphinx version, state it here.
 37 | #needs_sphinx = '1.0'
 38 | 
 39 | # Add any Sphinx extension module names here, as strings. They can be extensions
 40 | # coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
 41 | extensions = ['sphinx.ext.autodoc', 'sphinx.ext.viewcode']
 42 | 
 43 | # Add any paths that contain templates here, relative to this directory.
 44 | templates_path = ['_templates']
 45 | 
 46 | # The suffix of source filenames.
 47 | source_suffix = '.rst'
 48 | 
 49 | # The encoding of source files.
 50 | #source_encoding = 'utf-8-sig'
 51 | 
 52 | # The master toctree document.
 53 | master_doc = 'index'
 54 | 
 55 | # General information about the project.
 56 | project = u'robobrowser'
 57 | copyright = u'"", Joshua Carp'
 58 | 
 59 | # The version info for the project you're documenting, acts as replacement for
 60 | # |version| and |release|, also used in various other places throughout the
 61 | # built documents.
 62 | #
 63 | # The short X.Y version.
 64 | version = robobrowser.__version__
 65 | # The full version, including alpha/beta/rc tags.
 66 | release = robobrowser.__version__
 67 | 
 68 | # The language for content autogenerated by Sphinx. Refer to documentation
 69 | # for a list of supported languages.
 70 | #language = None
 71 | 
 72 | # There are two options for replacing |today|: either, you set today to some
 73 | # non-false value, then it is used:
 74 | #today = ''
 75 | # Else, today_fmt is used as the format for a strftime call.
 76 | #today_fmt = '%B %d, %Y'
 77 | 
 78 | # List of patterns, relative to source directory, that match files and
 79 | # directories to ignore when looking for source files.
 80 | exclude_patterns = ['_build']
 81 | 
 82 | # The reST default role (used for this markup: `text`) to use for all documents.
 83 | #default_role = None
 84 | 
 85 | # If true, '()' will be appended to :func: etc. cross-reference text.
 86 | #add_function_parentheses = True
 87 | 
 88 | # If true, the current module name will be prepended to all description
 89 | # unit titles (such as .. function::).
 90 | #add_module_names = True
 91 | 
 92 | # If true, sectionauthor and moduleauthor directives will be shown in the
 93 | # output. They are ignored by default.
 94 | #show_authors = False
 95 | 
 96 | # The name of the Pygments (syntax highlighting) style to use.
 97 | pygments_style = 'sphinx'
 98 | 
 99 | # A list of ignored prefixes for module index sorting.
100 | #modindex_common_prefix = []
101 | 
102 | # If true, keep warnings as "system message" paragraphs in the built documents.
103 | #keep_warnings = False
104 | 
105 | 
106 | # -- Options for HTML output ---------------------------------------------------
107 | 
108 | # The theme to use for HTML and HTML Help pages.  See the documentation for
109 | # a list of builtin themes.
110 | html_theme = 'kr'
111 | 
112 | # Theme options are theme-specific and customize the look and feel of a theme
113 | # further.  For a list of options available for each theme, see the
114 | # documentation.
115 | #html_theme_options = {}
116 | 
117 | # Add any paths that contain custom themes here, relative to this directory.
118 | html_theme_path = ['_themes']
119 | 
120 | # The name for this set of Sphinx documents.  If None, it defaults to
121 | # "<project> v<release> documentation".
122 | #html_title = None
123 | 
124 | # A shorter title for the navigation bar.  Default is the same as html_title.
125 | #html_short_title = None
126 | 
127 | # The name of an image file (relative to this directory) to place at the top
128 | # of the sidebar.
129 | #html_logo = None
130 | 
131 | # The name of an image file (within the static path) to use as favicon of the
132 | # docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
133 | # pixels large.
134 | #html_favicon = None
135 | 
136 | # Add any paths that contain custom static files (such as style sheets) here,
137 | # relative to this directory. They are copied after the builtin static files,
138 | # so a file named "default.css" will overwrite the builtin "default.css".
139 | html_static_path = ['_static']
140 | 
141 | # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
142 | # using the given strftime format.
143 | #html_last_updated_fmt = '%b %d, %Y'
144 | 
145 | # If true, SmartyPants will be used to convert quotes and dashes to
146 | # typographically correct entities.
147 | #html_use_smartypants = True
148 | 
149 | # Custom sidebar templates, maps document names to template names.
150 | #html_sidebars = {}
151 | 
152 | # Additional templates that should be rendered to pages, maps page names to
153 | # template names.
154 | #html_additional_pages = {}
155 | 
156 | # If false, no module index is generated.
157 | #html_domain_indices = True
158 | 
159 | # If false, no index is generated.
160 | #html_use_index = True
161 | 
162 | # If true, the index is split into individual pages for each letter.
163 | #html_split_index = False
164 | 
165 | # If true, links to the reST sources are added to the pages.
166 | #html_show_sourcelink = True
167 | 
168 | # If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
169 | #html_show_sphinx = True
170 | 
171 | # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
172 | #html_show_copyright = True
173 | 
174 | # If true, an OpenSearch description file will be output, and all pages will
175 | # contain a <link> tag referring to it.  The value of this option must be the
176 | # base URL from which the finished HTML is served.
177 | #html_use_opensearch = ''
178 | 
179 | # This is the file name suffix for HTML files (e.g. ".xhtml").
180 | #html_file_suffix = None
181 | 
182 | # Output file base name for HTML help builder.
183 | htmlhelp_basename = 'robobrowserdoc'
184 | 
185 | 
186 | # -- Options for LaTeX output --------------------------------------------------
187 | 
188 | latex_elements = {
189 | # The paper size ('letterpaper' or 'a4paper').
190 | #'papersize': 'letterpaper',
191 | 
192 | # The font size ('10pt', '11pt' or '12pt').
193 | #'pointsize': '10pt',
194 | 
195 | # Additional stuff for the LaTeX preamble.
196 | #'preamble': '',
197 | }
198 | 
199 | # Grouping the document tree into LaTeX files. List of tuples
200 | # (source start file, target name, title, author, documentclass [howto/manual]).
201 | latex_documents = [
202 |   ('index', 'robobrowser.tex', u'robobrowser Documentation',
203 |    u'Joshua Carp', 'manual'),
204 | ]
205 | 
206 | # The name of an image file (relative to this directory) to place at the top of
207 | # the title page.
208 | #latex_logo = None
209 | 
210 | # For "manual" documents, if this is true, then toplevel headings are parts,
211 | # not chapters.
212 | #latex_use_parts = False
213 | 
214 | # If true, show page references after internal links.
215 | #latex_show_pagerefs = False
216 | 
217 | # If true, show URL addresses after external links.
218 | #latex_show_urls = False
219 | 
220 | # Documents to append as an appendix to all manuals.
221 | #latex_appendices = []
222 | 
223 | # If false, no module index is generated.
224 | #latex_domain_indices = True
225 | 
226 | 
227 | # -- Options for manual page output --------------------------------------------
228 | 
229 | # One entry per manual page. List of tuples
230 | # (source start file, name, description, authors, manual section).
231 | man_pages = [
232 |     ('index', 'robobrowser', u'robobrowser Documentation',
233 |      [u'Joshua Carp'], 1)
234 | ]
235 | 
236 | # If true, show URL addresses after external links.
237 | #man_show_urls = False
238 | 
239 | 
240 | # -- Options for Texinfo output ------------------------------------------------
241 | 
242 | # Grouping the document tree into Texinfo files. List of tuples
243 | # (source start file, target name, title, author,
244 | #  dir menu entry, description, category)
245 | texinfo_documents = [
246 |   ('index', 'robobrowser', u'robobrowser Documentation',
247 |    u'Joshua Carp', 'robobrowser', 'One line description of project.',
248 |    'Miscellaneous'),
249 | ]
250 | 
251 | # Documents to append as an appendix to all manuals.
252 | #texinfo_appendices = []
253 | 
254 | # If false, no module index is generated.
255 | #texinfo_domain_indices = True
256 | 
257 | # How to display URL addresses: 'footnote', 'no', or 'inline'.
258 | #texinfo_show_urls = 'footnote'
259 | 
260 | # If true, do not generate a @detailmenu in the "Top" node's menu.
261 | #texinfo_no_detailmenu = False
262 | 


--------------------------------------------------------------------------------
/docs/contributing.rst:
--------------------------------------------------------------------------------
1 | .. include:: ../CONTRIBUTING.rst


--------------------------------------------------------------------------------
/docs/history.rst:
--------------------------------------------------------------------------------
1 | .. include:: ../HISTORY.rst


--------------------------------------------------------------------------------
/docs/index.rst:
--------------------------------------------------------------------------------
 1 | .. complexity documentation master file, created by
 2 |    sphinx-quickstart on Tue Jul  9 22:26:36 2013.
 3 |    You can adapt this file completely to your liking, but it should at least
 4 |    contain the root `toctree` directive.
 5 | 
 6 | Welcome to robobrowser's documentation!
 7 | ======================================
 8 | 
 9 | Contents:
10 | 
11 | .. toctree::
12 |    :maxdepth: 2
13 | 
14 |    readme
15 |    installation
16 |    history
17 |    api
18 | 
19 | Indices and tables
20 | ==================
21 | 
22 | * :ref:`genindex`
23 | * :ref:`modindex`
24 | * :ref:`search`
25 | 


--------------------------------------------------------------------------------
/docs/installation.rst:
--------------------------------------------------------------------------------
 1 | ============
 2 | Installation
 3 | ============
 4 | 
 5 | At the command line::
 6 | 
 7 |     $ easy_install robobrowser
 8 | 
 9 | Or, if you have virtualenvwrapper installed::
10 | 
11 |     $ mkvirtualenv robobrowser
12 |     $ pip install robobrowser
13 | 


--------------------------------------------------------------------------------
/docs/make.bat:
--------------------------------------------------------------------------------
  1 | @ECHO OFF
  2 | 
  3 | REM Command file for Sphinx documentation
  4 | 
  5 | if "%SPHINXBUILD%" == "" (
  6 | 	set SPHINXBUILD=sphinx-build
  7 | )
  8 | set BUILDDIR=_build
  9 | set ALLSPHINXOPTS=-d %BUILDDIR%/doctrees %SPHINXOPTS% .
 10 | set I18NSPHINXOPTS=%SPHINXOPTS% .
 11 | if NOT "%PAPER%" == "" (
 12 | 	set ALLSPHINXOPTS=-D latex_paper_size=%PAPER% %ALLSPHINXOPTS%
 13 | 	set I18NSPHINXOPTS=-D latex_paper_size=%PAPER% %I18NSPHINXOPTS%
 14 | )
 15 | 
 16 | if "%1" == "" goto help
 17 | 
 18 | if "%1" == "help" (
 19 | 	:help
 20 | 	echo.Please use `make ^<target^>` where ^<target^> is one of
 21 | 	echo.  html       to make standalone HTML files
 22 | 	echo.  dirhtml    to make HTML files named index.html in directories
 23 | 	echo.  singlehtml to make a single large HTML file
 24 | 	echo.  pickle     to make pickle files
 25 | 	echo.  json       to make JSON files
 26 | 	echo.  htmlhelp   to make HTML files and a HTML help project
 27 | 	echo.  qthelp     to make HTML files and a qthelp project
 28 | 	echo.  devhelp    to make HTML files and a Devhelp project
 29 | 	echo.  epub       to make an epub
 30 | 	echo.  latex      to make LaTeX files, you can set PAPER=a4 or PAPER=letter
 31 | 	echo.  text       to make text files
 32 | 	echo.  man        to make manual pages
 33 | 	echo.  texinfo    to make Texinfo files
 34 | 	echo.  gettext    to make PO message catalogs
 35 | 	echo.  changes    to make an overview over all changed/added/deprecated items
 36 | 	echo.  xml        to make Docutils-native XML files
 37 | 	echo.  pseudoxml  to make pseudoxml-XML files for display purposes
 38 | 	echo.  linkcheck  to check all external links for integrity
 39 | 	echo.  doctest    to run all doctests embedded in the documentation if enabled
 40 | 	goto end
 41 | )
 42 | 
 43 | if "%1" == "clean" (
 44 | 	for /d %%i in (%BUILDDIR%\*) do rmdir /q /s %%i
 45 | 	del /q /s %BUILDDIR%\*
 46 | 	goto end
 47 | )
 48 | 
 49 | 
 50 | %SPHINXBUILD% 2> nul
 51 | if errorlevel 9009 (
 52 | 	echo.
 53 | 	echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
 54 | 	echo.installed, then set the SPHINXBUILD environment variable to point
 55 | 	echo.to the full path of the 'sphinx-build' executable. Alternatively you
 56 | 	echo.may add the Sphinx directory to PATH.
 57 | 	echo.
 58 | 	echo.If you don't have Sphinx installed, grab it from
 59 | 	echo.http://sphinx-doc.org/
 60 | 	exit /b 1
 61 | )
 62 | 
 63 | if "%1" == "html" (
 64 | 	%SPHINXBUILD% -b html %ALLSPHINXOPTS% %BUILDDIR%/html
 65 | 	if errorlevel 1 exit /b 1
 66 | 	echo.
 67 | 	echo.Build finished. The HTML pages are in %BUILDDIR%/html.
 68 | 	goto end
 69 | )
 70 | 
 71 | if "%1" == "dirhtml" (
 72 | 	%SPHINXBUILD% -b dirhtml %ALLSPHINXOPTS% %BUILDDIR%/dirhtml
 73 | 	if errorlevel 1 exit /b 1
 74 | 	echo.
 75 | 	echo.Build finished. The HTML pages are in %BUILDDIR%/dirhtml.
 76 | 	goto end
 77 | )
 78 | 
 79 | if "%1" == "singlehtml" (
 80 | 	%SPHINXBUILD% -b singlehtml %ALLSPHINXOPTS% %BUILDDIR%/singlehtml
 81 | 	if errorlevel 1 exit /b 1
 82 | 	echo.
 83 | 	echo.Build finished. The HTML pages are in %BUILDDIR%/singlehtml.
 84 | 	goto end
 85 | )
 86 | 
 87 | if "%1" == "pickle" (
 88 | 	%SPHINXBUILD% -b pickle %ALLSPHINXOPTS% %BUILDDIR%/pickle
 89 | 	if errorlevel 1 exit /b 1
 90 | 	echo.
 91 | 	echo.Build finished; now you can process the pickle files.
 92 | 	goto end
 93 | )
 94 | 
 95 | if "%1" == "json" (
 96 | 	%SPHINXBUILD% -b json %ALLSPHINXOPTS% %BUILDDIR%/json
 97 | 	if errorlevel 1 exit /b 1
 98 | 	echo.
 99 | 	echo.Build finished; now you can process the JSON files.
100 | 	goto end
101 | )
102 | 
103 | if "%1" == "htmlhelp" (
104 | 	%SPHINXBUILD% -b htmlhelp %ALLSPHINXOPTS% %BUILDDIR%/htmlhelp
105 | 	if errorlevel 1 exit /b 1
106 | 	echo.
107 | 	echo.Build finished; now you can run HTML Help Workshop with the ^
108 | .hhp project file in %BUILDDIR%/htmlhelp.
109 | 	goto end
110 | )
111 | 
112 | if "%1" == "qthelp" (
113 | 	%SPHINXBUILD% -b qthelp %ALLSPHINXOPTS% %BUILDDIR%/qthelp
114 | 	if errorlevel 1 exit /b 1
115 | 	echo.
116 | 	echo.Build finished; now you can run "qcollectiongenerator" with the ^
117 | .qhcp project file in %BUILDDIR%/qthelp, like this:
118 | 	echo.^> qcollectiongenerator %BUILDDIR%\qthelp\complexity.qhcp
119 | 	echo.To view the help file:
120 | 	echo.^> assistant -collectionFile %BUILDDIR%\qthelp\complexity.ghc
121 | 	goto end
122 | )
123 | 
124 | if "%1" == "devhelp" (
125 | 	%SPHINXBUILD% -b devhelp %ALLSPHINXOPTS% %BUILDDIR%/devhelp
126 | 	if errorlevel 1 exit /b 1
127 | 	echo.
128 | 	echo.Build finished.
129 | 	goto end
130 | )
131 | 
132 | if "%1" == "epub" (
133 | 	%SPHINXBUILD% -b epub %ALLSPHINXOPTS% %BUILDDIR%/epub
134 | 	if errorlevel 1 exit /b 1
135 | 	echo.
136 | 	echo.Build finished. The epub file is in %BUILDDIR%/epub.
137 | 	goto end
138 | )
139 | 
140 | if "%1" == "latex" (
141 | 	%SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex
142 | 	if errorlevel 1 exit /b 1
143 | 	echo.
144 | 	echo.Build finished; the LaTeX files are in %BUILDDIR%/latex.
145 | 	goto end
146 | )
147 | 
148 | if "%1" == "latexpdf" (
149 | 	%SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex
150 | 	cd %BUILDDIR%/latex
151 | 	make all-pdf
152 | 	cd %BUILDDIR%/..
153 | 	echo.
154 | 	echo.Build finished; the PDF files are in %BUILDDIR%/latex.
155 | 	goto end
156 | )
157 | 
158 | if "%1" == "latexpdfja" (
159 | 	%SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex
160 | 	cd %BUILDDIR%/latex
161 | 	make all-pdf-ja
162 | 	cd %BUILDDIR%/..
163 | 	echo.
164 | 	echo.Build finished; the PDF files are in %BUILDDIR%/latex.
165 | 	goto end
166 | )
167 | 
168 | if "%1" == "text" (
169 | 	%SPHINXBUILD% -b text %ALLSPHINXOPTS% %BUILDDIR%/text
170 | 	if errorlevel 1 exit /b 1
171 | 	echo.
172 | 	echo.Build finished. The text files are in %BUILDDIR%/text.
173 | 	goto end
174 | )
175 | 
176 | if "%1" == "man" (
177 | 	%SPHINXBUILD% -b man %ALLSPHINXOPTS% %BUILDDIR%/man
178 | 	if errorlevel 1 exit /b 1
179 | 	echo.
180 | 	echo.Build finished. The manual pages are in %BUILDDIR%/man.
181 | 	goto end
182 | )
183 | 
184 | if "%1" == "texinfo" (
185 | 	%SPHINXBUILD% -b texinfo %ALLSPHINXOPTS% %BUILDDIR%/texinfo
186 | 	if errorlevel 1 exit /b 1
187 | 	echo.
188 | 	echo.Build finished. The Texinfo files are in %BUILDDIR%/texinfo.
189 | 	goto end
190 | )
191 | 
192 | if "%1" == "gettext" (
193 | 	%SPHINXBUILD% -b gettext %I18NSPHINXOPTS% %BUILDDIR%/locale
194 | 	if errorlevel 1 exit /b 1
195 | 	echo.
196 | 	echo.Build finished. The message catalogs are in %BUILDDIR%/locale.
197 | 	goto end
198 | )
199 | 
200 | if "%1" == "changes" (
201 | 	%SPHINXBUILD% -b changes %ALLSPHINXOPTS% %BUILDDIR%/changes
202 | 	if errorlevel 1 exit /b 1
203 | 	echo.
204 | 	echo.The overview file is in %BUILDDIR%/changes.
205 | 	goto end
206 | )
207 | 
208 | if "%1" == "linkcheck" (
209 | 	%SPHINXBUILD% -b linkcheck %ALLSPHINXOPTS% %BUILDDIR%/linkcheck
210 | 	if errorlevel 1 exit /b 1
211 | 	echo.
212 | 	echo.Link check complete; look for any errors in the above output ^
213 | or in %BUILDDIR%/linkcheck/output.txt.
214 | 	goto end
215 | )
216 | 
217 | if "%1" == "doctest" (
218 | 	%SPHINXBUILD% -b doctest %ALLSPHINXOPTS% %BUILDDIR%/doctest
219 | 	if errorlevel 1 exit /b 1
220 | 	echo.
221 | 	echo.Testing of doctests in the sources finished, look at the ^
222 | results in %BUILDDIR%/doctest/output.txt.
223 | 	goto end
224 | )
225 | 
226 | if "%1" == "xml" (
227 | 	%SPHINXBUILD% -b xml %ALLSPHINXOPTS% %BUILDDIR%/xml
228 | 	if errorlevel 1 exit /b 1
229 | 	echo.
230 | 	echo.Build finished. The XML files are in %BUILDDIR%/xml.
231 | 	goto end
232 | )
233 | 
234 | if "%1" == "pseudoxml" (
235 | 	%SPHINXBUILD% -b pseudoxml %ALLSPHINXOPTS% %BUILDDIR%/pseudoxml
236 | 	if errorlevel 1 exit /b 1
237 | 	echo.
238 | 	echo.Build finished. The pseudo-XML files are in %BUILDDIR%/pseudoxml.
239 | 	goto end
240 | )
241 | 
242 | :end


--------------------------------------------------------------------------------
/docs/modules.rst:
--------------------------------------------------------------------------------
1 | robobrowser
2 | ===========
3 | 
4 | .. toctree::
5 |    :maxdepth: 4
6 | 
7 |    robobrowser
8 | 


--------------------------------------------------------------------------------
/docs/readme.rst:
--------------------------------------------------------------------------------
1 | .. include:: ../README.rst


--------------------------------------------------------------------------------
/docs/robobrowser.forms.rst:
--------------------------------------------------------------------------------
 1 | robobrowser.forms package
 2 | =========================
 3 | 
 4 | Submodules
 5 | ----------
 6 | 
 7 | robobrowser.forms.fields module
 8 | -------------------------------
 9 | 
10 | .. automodule:: robobrowser.forms.fields
11 |     :members:
12 |     :undoc-members:
13 |     :show-inheritance:
14 | 
15 | robobrowser.forms.form module
16 | -----------------------------
17 | 
18 | .. automodule:: robobrowser.forms.form
19 |     :members:
20 |     :undoc-members:
21 |     :show-inheritance:
22 | 
23 | 
24 | Module contents
25 | ---------------
26 | 
27 | .. automodule:: robobrowser.forms
28 |     :members:
29 |     :undoc-members:
30 |     :show-inheritance:
31 | 


--------------------------------------------------------------------------------
/docs/robobrowser.rst:
--------------------------------------------------------------------------------
 1 | robobrowser package
 2 | ===================
 3 | 
 4 | Subpackages
 5 | -----------
 6 | 
 7 | .. toctree::
 8 | 
 9 |     robobrowser.forms
10 | 
11 | Submodules
12 | ----------
13 | 
14 | robobrowser.browser module
15 | --------------------------
16 | 
17 | .. automodule:: robobrowser.browser
18 |     :members:
19 |     :undoc-members:
20 |     :show-inheritance:
21 | 
22 | robobrowser.cache module
23 | ------------------------
24 | 
25 | .. automodule:: robobrowser.cache
26 |     :members:
27 |     :undoc-members:
28 |     :show-inheritance:
29 | 
30 | robobrowser.compat module
31 | -------------------------
32 | 
33 | .. automodule:: robobrowser.compat
34 |     :members:
35 |     :undoc-members:
36 |     :show-inheritance:
37 | 
38 | robobrowser.exceptions module
39 | -----------------------------
40 | 
41 | .. automodule:: robobrowser.exceptions
42 |     :members:
43 |     :undoc-members:
44 |     :show-inheritance:
45 | 
46 | robobrowser.helpers module
47 | --------------------------
48 | 
49 | .. automodule:: robobrowser.helpers
50 |     :members:
51 |     :undoc-members:
52 |     :show-inheritance:
53 | 
54 | robobrowser.ordereddict module
55 | ------------------------------
56 | 
57 | .. automodule:: robobrowser.ordereddict
58 |     :members:
59 |     :undoc-members:
60 |     :show-inheritance:
61 | 
62 | robobrowser.responses module
63 | ----------------------------
64 | 
65 | .. automodule:: robobrowser.responses
66 |     :members:
67 |     :undoc-members:
68 |     :show-inheritance:
69 | 
70 | 
71 | Module contents
72 | ---------------
73 | 
74 | .. automodule:: robobrowser
75 |     :members:
76 |     :undoc-members:
77 |     :show-inheritance:
78 | 


--------------------------------------------------------------------------------
/docs/usage.rst:
--------------------------------------------------------------------------------
1 | ========
2 | Usage
3 | ========
4 | 
5 | To use robobrowser in a project::
6 | 
7 | 	import robobrowser


--------------------------------------------------------------------------------
/robobrowser/__init__.py:
--------------------------------------------------------------------------------
1 | __version__ = '0.5.3'
2 | 
3 | from .browser import RoboBrowser
4 | 
5 | __all__ = ['RoboBrowser']
6 | 


--------------------------------------------------------------------------------
/robobrowser/browser.py:
--------------------------------------------------------------------------------
  1 | """
  2 | Robotic browser.
  3 | """
  4 | 
  5 | import re
  6 | import requests
  7 | from bs4 import BeautifulSoup
  8 | from werkzeug import cached_property
  9 | from requests.packages.urllib3.util.retry import Retry
 10 | 
 11 | from robobrowser import helpers
 12 | from robobrowser import exceptions
 13 | from robobrowser.compat import urlparse
 14 | from robobrowser.forms.form import Form
 15 | from robobrowser.cache import RoboHTTPAdapter
 16 | 
 17 | 
 18 | _link_ptn = re.compile(r'^(a|button)$', re.I)
 19 | _form_ptn = re.compile(r'^form$', re.I)
 20 | 
 21 | 
 22 | class RoboState(object):
 23 |     """Representation of a browser state. Wraps the browser and response, and
 24 |     lazily parses the response content.
 25 | 
 26 |     """
 27 | 
 28 |     def __init__(self, browser, response):
 29 |         self.browser = browser
 30 |         self.response = response
 31 |         self.url = response.url
 32 | 
 33 |     @cached_property
 34 |     def parsed(self):
 35 |         """Lazily parse response content, using HTML parser specified by the
 36 |         browser.
 37 |         """
 38 |         return BeautifulSoup(
 39 |             self.response.content,
 40 |             features=self.browser.parser,
 41 |         )
 42 | 
 43 | 
 44 | class RoboBrowser(object):
 45 |     """Robotic web browser. Represents HTTP requests and responses using the
 46 |     requests library and parsed HTML using BeautifulSoup.
 47 | 
 48 |     :param str parser: HTML parser; used by BeautifulSoup
 49 |     :param str user_agent: Default user-agent
 50 |     :param history: History length; infinite if True, 1 if falsy, else
 51 |         takes integer value
 52 | 
 53 |     :param int timeout: Default timeout, in seconds
 54 |     :param bool allow_redirects: Allow redirects on POST/PUT/DELETE
 55 | 
 56 |     :param bool cache: Cache responses
 57 |     :param list cache_patterns: List of URL patterns for cache
 58 |     :param timedelta max_age: Max age for cache
 59 |     :param int max_count: Max count for cache
 60 | 
 61 |     :param int tries: Number of retries
 62 |     :param Exception errors: Exception or tuple of exceptions to catch
 63 |     :param int delay: Delay between retries
 64 |     :param int multiplier: Delay multiplier between retries
 65 | 
 66 |     """
 67 |     def __init__(self, session=None, parser=None, user_agent=None,
 68 |                  history=True, timeout=None, allow_redirects=True, cache=False,
 69 |                  cache_patterns=None, max_age=None, max_count=None, tries=None,
 70 |                  multiplier=None):
 71 | 
 72 |         self.session = session or requests.Session()
 73 | 
 74 |         # Add default user agent string
 75 |         if user_agent is not None:
 76 |             self.session.headers['User-Agent'] = user_agent
 77 | 
 78 |         self.parser = parser
 79 | 
 80 |         self.timeout = timeout
 81 |         self.allow_redirects = allow_redirects
 82 | 
 83 |         # Set up caching
 84 |         if cache:
 85 |             adapter = RoboHTTPAdapter(max_age=max_age, max_count=max_count)
 86 |             cache_patterns = cache_patterns or ['http://', 'https://']
 87 |             for pattern in cache_patterns:
 88 |                 self.session.mount(pattern, adapter)
 89 |         elif max_age:
 90 |             raise ValueError('Parameter `max_age` is provided, '
 91 |                              'but caching is turned off')
 92 |         elif max_count:
 93 |             raise ValueError('Parameter `max_count` is provided, '
 94 |                              'but caching is turned off')
 95 | 
 96 |         # Configure history
 97 |         self.history = history
 98 |         if history is True:
 99 |             self._maxlen = None
100 |         elif not history:
101 |             self._maxlen = 1
102 |         else:
103 |             self._maxlen = history
104 |         self._states = []
105 |         self._cursor = -1
106 | 
107 |         # Set up retries
108 |         if tries:
109 |             retry = Retry(tries, backoff_factor=multiplier)
110 |             for protocol in ['http://', 'https://']:
111 |                 self.session.adapters[protocol].max_retries = retry
112 | 
113 |     def __repr__(self):
114 |         try:
115 |             return '<RoboBrowser url={0}>'.format(self.url)
116 |         except exceptions.RoboError:
117 |             return '<RoboBrowser>'
118 | 
119 |     @property
120 |     def state(self):
121 |         if self._cursor == -1:
122 |             raise exceptions.RoboError('No state')
123 |         try:
124 |             return self._states[self._cursor]
125 |         except IndexError:
126 |             raise exceptions.RoboError('Index out of range')
127 | 
128 |     @property
129 |     def response(self):
130 |         return self.state.response
131 | 
132 |     @property
133 |     def url(self):
134 |         return self.state.url
135 | 
136 |     @property
137 |     def parsed(self):
138 |         return self.state.parsed
139 | 
140 |     @property
141 |     def find(self):
142 |         """See ``BeautifulSoup::find``."""
143 |         try:
144 |             return self.parsed.find
145 |         except AttributeError:
146 |             raise exceptions.RoboError
147 | 
148 |     @property
149 |     def find_all(self):
150 |         """See ``BeautifulSoup::find_all``."""
151 |         try:
152 |             return self.parsed.find_all
153 |         except AttributeError:
154 |             raise exceptions.RoboError
155 | 
156 |     @property
157 |     def select(self):
158 |         """See ``BeautifulSoup::select``."""
159 |         try:
160 |             return self.parsed.select
161 |         except AttributeError:
162 |             raise exceptions.RoboError
163 | 
164 |     def _build_url(self, url):
165 |         """Build absolute URL.
166 | 
167 |         :param url: Full or partial URL
168 |         :return: Full URL
169 | 
170 |         """
171 |         return urlparse.urljoin(
172 |             self.url,
173 |             url
174 |         )
175 | 
176 |     @property
177 |     def _default_send_args(self):
178 |         """
179 | 
180 |         """
181 |         return {
182 |             'timeout': self.timeout,
183 |             'allow_redirects': self.allow_redirects,
184 |         }
185 | 
186 |     def _build_send_args(self, **kwargs):
187 |         """Merge optional arguments with defaults.
188 | 
189 |         :param kwargs: Keyword arguments to `Session::send`
190 | 
191 |         """
192 |         out = {}
193 |         out.update(self._default_send_args)
194 |         out.update(kwargs)
195 |         return out
196 | 
197 |     def open(self, url, method='get', **kwargs):
198 |         """Open a URL.
199 | 
200 |         :param str url: URL to open
201 |         :param str method: Optional method; defaults to `'get'`
202 |         :param kwargs: Keyword arguments to `Session::request`
203 | 
204 |         """
205 |         response = self.session.request(method, url, **self._build_send_args(**kwargs))
206 |         self._update_state(response)
207 | 
208 |     def _update_state(self, response):
209 |         """Update the state of the browser. Create a new state object, and
210 |         append to or overwrite the browser's state history.
211 | 
212 |         :param requests.MockResponse: New response object
213 | 
214 |         """
215 |         # Clear trailing states
216 |         self._states = self._states[:self._cursor + 1]
217 | 
218 |         # Append new state
219 |         state = RoboState(self, response)
220 |         self._states.append(state)
221 |         self._cursor += 1
222 | 
223 |         # Clear leading states
224 |         if self._maxlen:
225 |             decrement = len(self._states) - self._maxlen
226 |             if decrement > 0:
227 |                 self._states = self._states[decrement:]
228 |                 self._cursor -= decrement
229 | 
230 |     def _traverse(self, n=1):
231 |         """Traverse state history. Used by `back` and `forward` methods.
232 | 
233 |         :param int n: Cursor increment. Positive values move forward in the
234 |             browser history; negative values move backward.
235 | 
236 |         """
237 |         if not self.history:
238 |             raise exceptions.RoboError('Not tracking history')
239 |         cursor = self._cursor + n
240 |         if cursor >= len(self._states) or cursor < 0:
241 |             raise exceptions.RoboError('Index out of range')
242 |         self._cursor = cursor
243 | 
244 |     def back(self, n=1):
245 |         """Go back in browser history.
246 | 
247 |         :param int n: Number of pages to go back
248 | 
249 |         """
250 |         self._traverse(-1 * n)
251 | 
252 |     def forward(self, n=1):
253 |         """Go forward in browser history.
254 | 
255 |         :param int n: Number of pages to go forward
256 | 
257 |         """
258 |         self._traverse(n)
259 | 
260 |     def get_link(self, text=None, *args, **kwargs):
261 |         """Find an anchor or button by containing text, as well as standard
262 |         BeautifulSoup arguments.
263 | 
264 |         :param text: String or regex to be matched in link text
265 |         :return: BeautifulSoup tag if found, else None
266 | 
267 |         """
268 |         return helpers.find(
269 |             self.parsed, _link_ptn, text=text, *args, **kwargs
270 |         )
271 | 
272 |     def get_links(self, text=None, *args, **kwargs):
273 |         """Find anchors or buttons by containing text, as well as standard
274 |         BeautifulSoup arguments.
275 | 
276 |         :param text: String or regex to be matched in link text
277 |         :return: List of BeautifulSoup tags
278 | 
279 |         """
280 |         return helpers.find_all(
281 |             self.parsed, _link_ptn, text=text, *args, **kwargs
282 |         )
283 | 
284 |     def get_form(self, id=None, *args, **kwargs):
285 |         """Find form by ID, as well as standard BeautifulSoup arguments.
286 | 
287 |         :param str id: Form ID
288 |         :return: BeautifulSoup tag if found, else None
289 | 
290 |         """
291 |         if id:
292 |             kwargs['id'] = id
293 |         form = self.find(_form_ptn, *args, **kwargs)
294 |         if form is not None:
295 |             return Form(form)
296 | 
297 |     def get_forms(self, *args, **kwargs):
298 |         """Find forms by standard BeautifulSoup arguments.
299 |         :args: Positional arguments to `BeautifulSoup::find_all`
300 |         :args: Keyword arguments to `BeautifulSoup::find_all`
301 | 
302 |         :return: List of BeautifulSoup tags
303 | 
304 |         """
305 |         forms = self.find_all(_form_ptn, *args, **kwargs)
306 |         return [
307 |             Form(form)
308 |             for form in forms
309 |         ]
310 | 
311 |     def follow_link(self, link, **kwargs):
312 |         """Click a link.
313 | 
314 |         :param Tag link: Link to click
315 |         :param kwargs: Keyword arguments to `Session::send`
316 | 
317 |         """
318 |         try:
319 |             href = link['href']
320 |         except KeyError:
321 |             raise exceptions.RoboError('Link element must have "href" '
322 |                                        'attribute')
323 |         self.open(self._build_url(href), **kwargs)
324 | 
325 |     def submit_form(self, form, submit=None, **kwargs):
326 |         """Submit a form.
327 | 
328 |         :param Form form: Filled-out form object
329 |         :param Submit submit: Optional `Submit` to click, if form includes
330 |             multiple submits
331 |         :param kwargs: Keyword arguments to `Session::send`
332 | 
333 |         """
334 |         # Get HTTP verb
335 |         method = form.method.upper()
336 | 
337 |         # Send request
338 |         url = self._build_url(form.action) or self.url
339 |         payload = form.serialize(submit=submit)
340 |         serialized = payload.to_requests(method)
341 |         send_args = self._build_send_args(**kwargs)
342 |         send_args.update(serialized)
343 |         response = self.session.request(method, url, **send_args)
344 | 
345 |         # Update history
346 |         self._update_state(response)
347 | 


--------------------------------------------------------------------------------
/robobrowser/cache.py:
--------------------------------------------------------------------------------
  1 | """
  2 | Caching utilities for robotic browsers. Credit to
  3 | https://github.com/Lukasa/httpcache
  4 | """
  5 | 
  6 | import logging
  7 | import datetime
  8 | from requests.adapters import HTTPAdapter
  9 | 
 10 | from robobrowser.compat import OrderedDict, iteritems
 11 | 
 12 | logger = logging.getLogger(__name__)
 13 | 
 14 | # Modified from https://github.com/Lukasa/httpcache/blob/master/httpcache/cache.py
 15 | # RoboBrowser should only cache GET requests; HEAD and OPTIONS not exposed
 16 | CACHE_VERBS = ['GET']
 17 | CACHE_CODES = [200, 203, 300, 301, 410]
 18 | 
 19 | class RoboCache(object):
 20 | 
 21 |     def __init__(self, max_age=None, max_count=None):
 22 |         self.data = OrderedDict()
 23 |         self.max_age = max_age
 24 |         self.max_count = max_count
 25 | 
 26 |     def _reduce_age(self, now):
 27 |         """Reduce size of cache by date.
 28 | 
 29 |         :param datetime.datetime now: Current time
 30 | 
 31 |         """
 32 |         if self.max_age:
 33 |             keys = [
 34 |                 key for key, value in iteritems(self.data)
 35 |                 if now - value['date'] > self.max_age
 36 |             ]
 37 |             for key in keys:
 38 |                 del self.data[key]
 39 | 
 40 |     def _reduce_count(self):
 41 |         """Reduce size of cache by count.
 42 | 
 43 |         """
 44 |         if self.max_count:
 45 |             while len(self.data) > self.max_count:
 46 |                 self.data.popitem(last=False)
 47 | 
 48 |     def store(self, response):
 49 |         """Store response in cache, skipping if code is forbidden.
 50 | 
 51 |         :param requests.Response response: HTTP response
 52 | 
 53 |         """
 54 |         if response.status_code not in CACHE_CODES:
 55 |             return
 56 |         now = datetime.datetime.now()
 57 |         self.data[response.url] = {
 58 |             'date': now,
 59 |             'response': response,
 60 |         }
 61 |         logger.info('Stored response in cache')
 62 |         self._reduce_age(now)
 63 |         self._reduce_count()
 64 | 
 65 |     def retrieve(self, request):
 66 |         """Look up request in cache, skipping if verb is forbidden.
 67 | 
 68 |         :param requests.Request request: HTTP request
 69 | 
 70 |         """
 71 |         if request.method not in CACHE_VERBS:
 72 |             return
 73 |         try:
 74 |             response = self.data[request.url]['response']
 75 |             logger.info('Retrieved response from cache')
 76 |             return response
 77 |         except KeyError:
 78 |             return None
 79 | 
 80 |     def clear(self):
 81 |         "Clear cache."
 82 |         self.data = OrderedDict()
 83 | 
 84 | class RoboHTTPAdapter(HTTPAdapter):
 85 | 
 86 |     def __init__(self, max_age=None, max_count=None, **kwargs):
 87 |         super(RoboHTTPAdapter, self).__init__(**kwargs)
 88 |         self.cache = RoboCache(max_age=max_age, max_count=max_count)
 89 | 
 90 |     def send(self, request, **kwargs):
 91 |         cached_resp = self.cache.retrieve(request)
 92 |         if cached_resp is not None:
 93 |             return cached_resp
 94 |         else:
 95 |             return super(RoboHTTPAdapter, self).send(request, **kwargs)
 96 | 
 97 |     def build_response(self, request, response):
 98 |         resp = super(RoboHTTPAdapter, self).build_response(request, response)
 99 |         self.cache.store(resp)
100 |         return resp
101 | 


--------------------------------------------------------------------------------
/robobrowser/compat.py:
--------------------------------------------------------------------------------
 1 | import sys
 2 | 
 3 | PY2 = int(sys.version[0]) == 2
 4 | PY26 = PY2 and int(sys.version_info[1]) < 7
 5 | 
 6 | if PY26:
 7 |     from .ordereddict import OrderedDict
 8 | else:
 9 |     from collections import OrderedDict
10 | OrderedDict = OrderedDict
11 | 
12 | 
13 | if PY2:
14 |     import urlparse
15 |     urlparse = urlparse
16 |     string_types = (str, unicode)
17 |     unicode = unicode
18 |     basestring = basestring
19 |     iterkeys = lambda d: d.iterkeys()
20 |     itervalues = lambda d: d.itervalues()
21 |     iteritems = lambda d: d.iteritems()
22 |     builtin_name = '__builtin__'
23 | else:
24 |     import urllib.parse
25 |     urlparse = urllib.parse
26 |     string_types = (str,)
27 |     unicode = str
28 |     basestring = (str, bytes)
29 |     iterkeys = lambda d: iter(d.keys())
30 |     itervalues = lambda d: iter(d.values())
31 |     iteritems = lambda d: iter(d.items())
32 |     builtin_name = 'builtins'
33 | 
34 | 
35 | def encode_if_py2(func):
36 |     """If Python 2.x, return decorated function encoding unicode return value
37 |     to UTF-8; else noop.
38 |     """
39 |     if not PY2:
40 |         return func
41 |     def wrapped(*args, **kwargs):
42 |         ret = func(*args, **kwargs)
43 |         if not isinstance(ret, unicode):
44 |             raise TypeError('Wrapped function must return `unicode`')
45 |         return ret.encode('utf-8', 'ignore')
46 |     return wrapped
47 | 


--------------------------------------------------------------------------------
/robobrowser/exceptions.py:
--------------------------------------------------------------------------------
 1 | # -*- coding: utf-8 -*-
 2 | 
 3 | 
 4 | class RoboError(Exception):
 5 |     pass
 6 | 
 7 | 
 8 | class InvalidNameError(RoboError):
 9 |     pass
10 | 
11 | 
12 | class InvalidSubmitError(RoboError):
13 |     pass
14 | 


--------------------------------------------------------------------------------
/robobrowser/forms/__init__.py:
--------------------------------------------------------------------------------
1 | from . import fields
2 | from .form import Form
3 | 
4 | __all__ = ['fields', 'Form']
5 | 


--------------------------------------------------------------------------------
/robobrowser/forms/fields.py:
--------------------------------------------------------------------------------
  1 | """
  2 | HTML form fields.
  3 | """
  4 | 
  5 | import abc
  6 | import six
  7 | 
  8 | from robobrowser.compat import string_types
  9 | from robobrowser import helpers
 10 | from robobrowser import exceptions
 11 | 
 12 | 
 13 | class BaseField(six.with_metaclass(abc.ABCMeta, object)):
 14 |     """Abstract base class for form fields.
 15 | 
 16 |     :param parsed: String or BeautifulSoup tag
 17 |     """
 18 |     def __init__(self, parsed):
 19 |         self._parsed = helpers.ensure_soup(parsed, parser='html.parser')
 20 |         self._value = None
 21 |         self.name = self._get_name(self._parsed)
 22 | 
 23 |     @property
 24 |     def disabled(self):
 25 |         return 'disabled' in self._parsed.attrs
 26 | 
 27 |     def _get_name(self, parsed):
 28 |         name = parsed.get('name')
 29 |         if name is not None:
 30 |             return name
 31 |         raise exceptions.InvalidNameError
 32 | 
 33 |     # Different form fields may serialize their values under different keys.
 34 |     # See `FormData` for details.
 35 |     payload_key = None
 36 | 
 37 |     def serialize(self):
 38 |         return {self.name: self.value}
 39 | 
 40 |     @property
 41 |     def value(self):
 42 |         return self._value if self._value else ''
 43 | 
 44 |     @value.setter
 45 |     def value(self, value):
 46 |         self._value = value
 47 | 
 48 | 
 49 | class Input(BaseField):
 50 | 
 51 |     def __init__(self, parsed):
 52 |         super(Input, self).__init__(parsed)
 53 |         self.value = self._parsed.get('value')
 54 | 
 55 | 
 56 | class Submit(Input):
 57 |     pass
 58 | 
 59 | 
 60 | class FileInput(BaseField):
 61 | 
 62 |     @BaseField.value.setter
 63 |     def value(self, value):
 64 |         if hasattr(value, 'read'):
 65 |             self._value = value
 66 |         elif isinstance(value, string_types):
 67 |             self._value = open(value)
 68 |         else:
 69 |             raise ValueError('Value must be a file object or file path')
 70 | 
 71 |     # Serialize value to 'files' key for compatibility with file attachments
 72 |     # in requests.
 73 |     payload_key = 'files'
 74 | 
 75 | 
 76 | class MultiOptionField(BaseField):
 77 | 
 78 |     def __init__(self, parsed):
 79 |         super(MultiOptionField, self).__init__(parsed)
 80 |         self.options, self.labels, initial = self._get_options(parsed)
 81 |         self._set_initial(initial)
 82 | 
 83 |     @abc.abstractmethod
 84 |     def _get_options(self, parsed):
 85 |         return [], [], []
 86 | 
 87 |     def _set_initial(self, initial):
 88 |         self._value = None
 89 |         try:
 90 |             self.value = initial[0]
 91 |         except IndexError:
 92 |             pass
 93 | 
 94 |     def _value_to_index(self, value):
 95 |         if value in self.options:
 96 |             return self.options.index(value)
 97 |         if value in self.labels:
 98 |             return self.labels.index(value)
 99 |         raise ValueError('Option {0} not found in field {1!r}'.format(value, self))
100 | 
101 |     @property
102 |     def value(self):
103 |         if self._value is None:
104 |             return ''
105 |         return self.options[self._value]
106 | 
107 |     @value.setter
108 |     def value(self, value):
109 |         self._value = self._value_to_index(value)
110 | 
111 | 
112 | class MultiValueField(MultiOptionField):
113 | 
114 |     def _set_initial(self, initial):
115 |         self.value = initial
116 | 
117 |     @property
118 |     def value(self):
119 |         return [
120 |             self.options[idx]
121 |             for idx in self._value
122 |         ]
123 | 
124 |     @value.setter
125 |     def value(self, value):
126 |         if not isinstance(value, list):
127 |             value = [value]
128 |         self._value = [
129 |             self._value_to_index(item)
130 |             for item in value
131 |         ]
132 | 
133 |     # List-like methods
134 |     def append(self, value):
135 |         index = self._value_to_index(value)
136 |         if index in self._value:
137 |             raise ValueError('Option {0} already in field {1!r}'.format(value, self))
138 |         self._value.append(index)
139 |         self._value.sort()
140 | 
141 |     def remove(self, value):
142 |         index = self._value_to_index(value)
143 |         self._value.remove(index)
144 | 
145 | 
146 | class FlatOptionField(MultiOptionField):
147 | 
148 |     @property
149 |     def disabled(self):
150 |         return all('disabled' in each.attrs for each in self._parsed)
151 | 
152 |     def _get_name(self, parsed):
153 |         return super(FlatOptionField, self)._get_name(parsed[0])
154 | 
155 |     def _get_options(self, parsed):
156 |         options, labels, initial = [], [], []
157 |         for option in parsed:
158 |             value = option.get('value', 'on')
159 |             checked = option.get('checked')
160 |             options.append(value)
161 |             labels.append(
162 |                 option.next.string
163 |                 if isinstance(option.next, string_types)
164 |                 else None
165 |             )
166 |             if checked is not None:
167 |                 initial.append(value)
168 |         return options, labels, initial
169 | 
170 | 
171 | class NestedOptionField(MultiOptionField):
172 | 
173 |     @property
174 |     def disabled(self):
175 |         return (
176 |             super(NestedOptionField, self).disabled or
177 |             all('disabled' in each.attrs for each in self._parsed.find_all('option'))
178 |         )
179 | 
180 |     def _get_options(self, parsed):
181 |         options, labels, initial = [], [], []
182 |         for option in parsed.find_all('option'):
183 |             value = option.get('value', option.text)
184 |             selected = option.get('selected')
185 |             options.append(value)
186 |             labels.append(option.text)
187 |             if selected is not None:
188 |                 initial.append(value)
189 |         return options, labels, initial
190 | 
191 | 
192 | class Textarea(Input):
193 | 
194 |     def __init__(self, parsed):
195 |         super(Textarea, self).__init__(parsed)
196 |         self.value = self._parsed.text.rstrip('\r').rstrip('\n')
197 | 
198 | 
199 | class Checkbox(FlatOptionField, MultiValueField):
200 |     pass
201 | 
202 | 
203 | class Radio(FlatOptionField, MultiOptionField):
204 |     pass
205 | 
206 | 
207 | class Select(NestedOptionField, MultiOptionField):
208 | 
209 |     def _set_initial(self, initial):
210 |         """If no option is selected initially, select the first option.
211 |         """
212 |         super(Select, self)._set_initial(initial)
213 |         if not self._value and self.options:
214 |             self.value = self.options[0]
215 | 
216 | 
217 | class MultiSelect(NestedOptionField, MultiValueField):
218 |     pass
219 | 


--------------------------------------------------------------------------------
/robobrowser/forms/form.py:
--------------------------------------------------------------------------------
  1 | """
  2 | HTML forms.
  3 | """
  4 | 
  5 | import re
  6 | import collections
  7 | from werkzeug.datastructures import OrderedMultiDict
  8 | 
  9 | from robobrowser.compat import iteritems, encode_if_py2
 10 | 
 11 | from . import fields
 12 | from .. import helpers
 13 | from .. import exceptions
 14 | 
 15 | 
 16 | _tags = ['input', 'textarea', 'select']
 17 | _tag_ptn = re.compile(
 18 |     '|'.join(_tags),
 19 |     re.I
 20 | )
 21 | 
 22 | 
 23 | def _group_flat_tags(tag, tags):
 24 |     """Extract tags sharing the same name as the provided tag. Used to collect
 25 |     options for radio and checkbox inputs.
 26 | 
 27 |     :param Tag tag: BeautifulSoup tag
 28 |     :param list tags: List of tags
 29 |     :return: List of matching tags
 30 | 
 31 |     """
 32 |     grouped = [tag]
 33 |     name = tag.get('name', '').lower()
 34 |     while tags and tags[0].get('name', '').lower() == name:
 35 |         grouped.append(tags.pop(0))
 36 |     return grouped
 37 | 
 38 | 
 39 | def _parse_field(tag, tags):
 40 | 
 41 |     tag_type = tag.name.lower()
 42 | 
 43 |     if tag_type == 'input':
 44 |         tag_type = tag.get('type', '').lower()
 45 |         if tag_type == 'submit':
 46 |             return fields.Submit(tag)
 47 |         if tag_type == 'file':
 48 |             return fields.FileInput(tag)
 49 |         if tag_type == 'radio':
 50 |             radios = _group_flat_tags(tag, tags)
 51 |             return fields.Radio(radios)
 52 |         if tag_type == 'checkbox':
 53 |             checkboxes = _group_flat_tags(tag, tags)
 54 |             return fields.Checkbox(checkboxes)
 55 |         return fields.Input(tag)
 56 |     if tag_type == 'textarea':
 57 |         return fields.Textarea(tag)
 58 |     if tag_type == 'select':
 59 |         if tag.get('multiple') is not None:
 60 |             return fields.MultiSelect(tag)
 61 |         return fields.Select(tag)
 62 | 
 63 | 
 64 | def _parse_fields(parsed):
 65 |     """Parse form fields from HTML.
 66 | 
 67 |     :param BeautifulSoup parsed: Parsed HTML
 68 |     :return OrderedDict: Collection of field objects
 69 | 
 70 |     """
 71 |     # Note: Call this `out` to avoid name conflict with `fields` module
 72 |     out = []
 73 | 
 74 |     # Prepare field tags
 75 |     tags = parsed.find_all(_tag_ptn)
 76 |     for tag in tags:
 77 |         helpers.lowercase_attr_names(tag)
 78 | 
 79 |     while tags:
 80 |         tag = tags.pop(0)
 81 |         try:
 82 |             field = _parse_field(tag, tags)
 83 |         except exceptions.InvalidNameError:
 84 |             continue
 85 |         if field is not None:
 86 |             out.append(field)
 87 | 
 88 |     return out
 89 | 
 90 | 
 91 | def _filter_fields(fields, predicate):
 92 |     return OrderedMultiDict([
 93 |         (key, value)
 94 |         for key, value in fields.items(multi=True)
 95 |         if predicate(value)
 96 |     ])
 97 | 
 98 | 
 99 | class Payload(object):
100 |     """Container for serialized form outputs that knows how to export to
101 |     the format expected by Requests. By default, form values are stored in
102 |     `data`.
103 | 
104 |     """
105 |     def __init__(self):
106 |         self.data = OrderedMultiDict()
107 |         self.options = collections.defaultdict(OrderedMultiDict)
108 | 
109 |     @classmethod
110 |     def from_fields(cls, fields):
111 |         """
112 | 
113 |         :param OrderedMultiDict fields:
114 | 
115 |         """
116 |         payload = cls()
117 |         for _, field in fields.items(multi=True):
118 |             if not field.disabled:
119 |                 payload.add(field.serialize(), field.payload_key)
120 |         return payload
121 | 
122 |     def add(self, data, key=None):
123 |         """Add field values to container.
124 | 
125 |         :param dict data: Serialized values for field
126 |         :param str key: Optional key; if not provided, values will be added
127 |             to `self.payload`.
128 | 
129 |         """
130 |         sink = self.options[key] if key is not None else self.data
131 |         for key, value in iteritems(data):
132 |             sink.add(key, value)
133 | 
134 |     def to_requests(self, method='get'):
135 |         """Export to Requests format.
136 | 
137 |         :param str method: Request method
138 |         :return: Dict of keyword arguments formatted for `requests.request`
139 | 
140 |         """
141 |         out = {}
142 |         data_key = 'params' if method.lower() == 'get' else 'data'
143 |         out[data_key] = self.data
144 |         out.update(self.options)
145 |         return dict([
146 |             (key, list(value.items(multi=True)))
147 |             for key, value in iteritems(out)
148 |         ])
149 | 
150 | 
151 | def prepare_fields(all_fields, submit_fields, submit):
152 |     if len(list(submit_fields.items(multi=True))) > 1:
153 |         if not submit:
154 |             raise exceptions.InvalidSubmitError()
155 |         if submit not in submit_fields.getlist(submit.name):
156 |             raise exceptions.InvalidSubmitError()
157 |         return _filter_fields(
158 |             all_fields,
159 |             lambda f: not isinstance(f, fields.Submit) or f == submit
160 |         )
161 |     return all_fields
162 | 
163 | 
164 | class Form(object):
165 |     """Representation of an HTML form."""
166 | 
167 |     def __init__(self, parsed):
168 |         parsed = helpers.ensure_soup(parsed)
169 |         if parsed.name != 'form':
170 |             parsed = parsed.find('form')
171 |         self.parsed = parsed
172 |         self.action = self.parsed.get('action')
173 |         self.method = self.parsed.get('method', 'get')
174 |         self.fields = OrderedMultiDict()
175 |         for field in _parse_fields(self.parsed):
176 |             self.add_field(field)
177 | 
178 |     def add_field(self, field):
179 |         """Add a field.
180 | 
181 |         :param field: Field to add
182 |         :raise: ValueError if `field` is not an instance of `BaseField`.
183 | 
184 |         """
185 |         if not isinstance(field, fields.BaseField):
186 |             raise ValueError('Argument "field" must be an instance of '
187 |                              'BaseField')
188 |         self.fields.add(field.name, field)
189 | 
190 |     @property
191 |     def submit_fields(self):
192 |         return _filter_fields(
193 |             self.fields,
194 |             lambda field: isinstance(field, fields.Submit)
195 |         )
196 | 
197 |     @encode_if_py2
198 |     def __repr__(self):
199 |         state = u', '.join(
200 |             [
201 |                 u'{0}={1}'.format(name, field.value)
202 |                 for name, field in self.fields.items(multi=True)
203 |             ]
204 |         )
205 |         if state:
206 |             return u'<RoboForm {0}>'.format(state)
207 |         return u'<RoboForm>'
208 | 
209 |     def keys(self):
210 |         return self.fields.keys()
211 | 
212 |     def __getitem__(self, item):
213 |         return self.fields[item]
214 | 
215 |     def __setitem__(self, key, value):
216 |         self.fields[key].value = value
217 | 
218 |     def serialize(self, submit=None):
219 |         """Serialize each form field to a Payload container.
220 | 
221 |         :param Submit submit: Optional `Submit` to click, if form includes
222 |             multiple submits
223 |         :return: Payload instance
224 | 
225 |         """
226 |         include_fields = prepare_fields(self.fields, self.submit_fields, submit)
227 |         return Payload.from_fields(include_fields)
228 | 


--------------------------------------------------------------------------------
/robobrowser/helpers.py:
--------------------------------------------------------------------------------
 1 | """
 2 | Miscellaneous helper functions
 3 | """
 4 | 
 5 | import re
 6 | 
 7 | from bs4 import BeautifulSoup
 8 | from bs4.element import Tag
 9 | 
10 | from robobrowser.compat import string_types, iteritems
11 | 
12 | 
13 | def match_text(text, tag):
14 |     if isinstance(text, string_types):
15 |         return text in tag.text
16 |     if isinstance(text, re._pattern_type):
17 |         return text.search(tag.text)
18 | 
19 | 
20 | def find_all(soup, name=None, attrs=None, recursive=True, text=None,
21 |               limit=None, **kwargs):
22 |     """The `find` and `find_all` methods of `BeautifulSoup` don't handle the
23 |     `text` parameter combined with other parameters. This is necessary for
24 |     e.g. finding links containing a string or pattern. This method first
25 |     searches by text content, and then by the standard BeautifulSoup arguments.
26 | 
27 |     """
28 |     if text is None:
29 |         return soup.find_all(
30 |             name, attrs or {}, recursive, text, limit, **kwargs
31 |         )
32 |     if isinstance(text, string_types):
33 |         text = re.compile(re.escape(text), re.I)
34 |     tags = soup.find_all(
35 |         name, attrs or {}, recursive, **kwargs
36 |     )
37 |     rv = []
38 |     for tag in tags:
39 |         if match_text(text, tag):
40 |             rv.append(tag)
41 |         if limit is not None and len(rv) >= limit:
42 |             break
43 |     return rv
44 | 
45 | 
46 | def find(soup, name=None, attrs=None, recursive=True, text=None, **kwargs):
47 |     """Modified find method; see `find_all`, above.
48 | 
49 |     """
50 |     tags = find_all(
51 |         soup, name, attrs or {}, recursive, text, 1, **kwargs
52 |     )
53 |     if tags:
54 |         return tags[0]
55 | 
56 | 
57 | def ensure_soup(value, parser=None):
58 |     """Coerce a value (or list of values) to Tag (or list of Tag).
59 | 
60 |     :param value: String, BeautifulSoup, Tag, or list of the above
61 |     :param str parser: Parser to use; defaults to BeautifulSoup default
62 |     :return: Tag or list of Tags
63 | 
64 |     """
65 |     if isinstance(value, BeautifulSoup):
66 |         return value.find()
67 |     if isinstance(value, Tag):
68 |         return value
69 |     if isinstance(value, list):
70 |         return [
71 |             ensure_soup(item, parser=parser)
72 |             for item in value
73 |         ]
74 |     parsed = BeautifulSoup(value, features=parser)
75 |     return parsed.find()
76 | 
77 | 
78 | def lowercase_attr_names(tag):
79 |     """Lower-case all attribute names of the provided BeautifulSoup tag.
80 |     Note: this mutates the tag's attribute names and does not return a new
81 |     tag.
82 | 
83 |     :param Tag: BeautifulSoup tag
84 | 
85 |     """
86 |     # Use list comprehension instead of dict comprehension for 2.6 support
87 |     tag.attrs = dict([
88 |         (key.lower(), value)
89 |         for key, value in iteritems(tag.attrs)
90 |     ])
91 | 


--------------------------------------------------------------------------------
/robobrowser/ordereddict.py:
--------------------------------------------------------------------------------
  1 | # -*- coding: utf-8 -*-
  2 | '''A Python 2.6-compatible ordered dictionary.'''
  3 | # OrderedDict
  4 | # Copyright (c) 2009 Raymond Hettinger
  5 | #
  6 | # Permission is hereby granted, free of charge, to any person
  7 | # obtaining a copy of this software and associated documentation files
  8 | # (the "Software"), to deal in the Software without restriction,
  9 | # including without limitation the rights to use, copy, modify, merge,
 10 | # publish, distribute, sublicense, and/or sell copies of the Software,
 11 | # and to permit persons to whom the Software is furnished to do so,
 12 | # subject to the following conditions:
 13 | #
 14 | #     The above copyright notice and this permission notice shall be
 15 | #     included in all copies or substantial portions of the Software.
 16 | #
 17 | #     THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
 18 | #     EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
 19 | #     OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
 20 | #     NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
 21 | #     HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
 22 | #     WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
 23 | #     FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
 24 | #     OTHER DEALINGS IN THE SOFTWARE.
 25 | 
 26 | from UserDict import DictMixin
 27 | 
 28 | class OrderedDict(dict, DictMixin):
 29 | 
 30 |     def __init__(self, *args, **kwds):
 31 |         if len(args) > 1:
 32 |             raise TypeError('expected at most 1 arguments, got %d' % len(args))
 33 |         try:
 34 |             self.__end
 35 |         except AttributeError:
 36 |             self.clear()
 37 |         self.update(*args, **kwds)
 38 | 
 39 |     def clear(self):
 40 |         self.__end = end = []
 41 |         end += [None, end, end]         # sentinel node for doubly linked list
 42 |         self.__map = {}                 # key --> [key, prev, next]
 43 |         dict.clear(self)
 44 | 
 45 |     def __setitem__(self, key, value):
 46 |         if key not in self:
 47 |             end = self.__end
 48 |             curr = end[1]
 49 |             curr[2] = end[1] = self.__map[key] = [key, curr, end]
 50 |         dict.__setitem__(self, key, value)
 51 | 
 52 |     def __delitem__(self, key):
 53 |         dict.__delitem__(self, key)
 54 |         key, prev, next = self.__map.pop(key)
 55 |         prev[2] = next
 56 |         next[1] = prev
 57 | 
 58 |     def __iter__(self):
 59 |         end = self.__end
 60 |         curr = end[2]
 61 |         while curr is not end:
 62 |             yield curr[0]
 63 |             curr = curr[2]
 64 | 
 65 |     def __reversed__(self):
 66 |         end = self.__end
 67 |         curr = end[1]
 68 |         while curr is not end:
 69 |             yield curr[0]
 70 |             curr = curr[1]
 71 | 
 72 |     def popitem(self, last=True):
 73 |         if not self:
 74 |             raise KeyError('dictionary is empty')
 75 |         if last:
 76 |             key = reversed(self).next()
 77 |         else:
 78 |             key = iter(self).next()
 79 |         value = self.pop(key)
 80 |         return key, value
 81 | 
 82 |     def __reduce__(self):
 83 |         items = [[k, self[k]] for k in self]
 84 |         tmp = self.__map, self.__end
 85 |         del self.__map, self.__end
 86 |         inst_dict = vars(self).copy()
 87 |         self.__map, self.__end = tmp
 88 |         if inst_dict:
 89 |             return (self.__class__, (items,), inst_dict)
 90 |         return self.__class__, (items,)
 91 | 
 92 |     def keys(self):
 93 |         return list(self)
 94 | 
 95 |     setdefault = DictMixin.setdefault
 96 |     update = DictMixin.update
 97 |     pop = DictMixin.pop
 98 |     values = DictMixin.values
 99 |     items = DictMixin.items
100 |     iterkeys = DictMixin.iterkeys
101 |     itervalues = DictMixin.itervalues
102 |     iteritems = DictMixin.iteritems
103 | 
104 |     def __repr__(self):
105 |         if not self:
106 |             return '%s()' % (self.__class__.__name__,)
107 |         return '%s(%r)' % (self.__class__.__name__, self.items())
108 | 
109 |     def copy(self):
110 |         return self.__class__(self)
111 | 
112 |     @classmethod
113 |     def fromkeys(cls, iterable, value=None):
114 |         d = cls()
115 |         for key in iterable:
116 |             d[key] = value
117 |         return d
118 | 
119 |     def __eq__(self, other):
120 |         if isinstance(other, OrderedDict):
121 |             if len(self) != len(other):
122 |                 return False
123 |             for p, q in  zip(self.items(), other.items()):
124 |                 if p != q:
125 |                     return False
126 |             return True
127 |         return dict.__eq__(self, other)
128 | 
129 |     def __ne__(self, other):
130 |         return not self == other
131 | 


--------------------------------------------------------------------------------
/robobrowser/responses.py:
--------------------------------------------------------------------------------
  1 | """
  2 | Copyright 2013 Dropbox, Inc.
  3 | 
  4 | Licensed under the Apache License, Version 2.0 (the "License");
  5 | you may not use this file except in compliance with the License.
  6 | You may obtain a copy of the License at
  7 | 
  8 |     http://www.apache.org/licenses/LICENSE-2.0
  9 | 
 10 | Unless required by applicable law or agreed to in writing, software
 11 | distributed under the License is distributed on an "AS IS" BASIS,
 12 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 13 | See the License for the specific language governing permissions and
 14 | limitations under the License.
 15 | """
 16 | 
 17 | from __future__ import (
 18 |     absolute_import, print_function, division, unicode_literals
 19 | )
 20 | 
 21 | import re
 22 | 
 23 | import six
 24 | if six.PY2:
 25 |     try:
 26 |         from six import cStringIO as BufferIO
 27 |     except ImportError:
 28 |         from six import StringIO as BufferIO
 29 | else:
 30 |     from io import BytesIO as BufferIO
 31 | 
 32 | from collections import namedtuple, Sequence, Sized
 33 | from functools import wraps
 34 | from requests.adapters import HTTPAdapter
 35 | from requests.exceptions import ConnectionError
 36 | from requests.packages.urllib3.response import HTTPResponse
 37 | 
 38 | Call = namedtuple('Call', ['request', 'response'])
 39 | 
 40 | 
 41 | class CallList(Sequence, Sized):
 42 |     def __init__(self):
 43 |         self._calls = []
 44 | 
 45 |     def __iter__(self):
 46 |         return iter(self._calls)
 47 | 
 48 |     def __len__(self):
 49 |         return len(self._calls)
 50 | 
 51 |     def __getitem__(self, idx):
 52 |         return self._calls[idx]
 53 | 
 54 |     def add(self, request, response):
 55 |         self._calls.append(Call(request, response))
 56 | 
 57 |     def reset(self):
 58 |         self._calls = []
 59 | 
 60 | 
 61 | class RequestsMock(object):
 62 |     DELETE = 'DELETE'
 63 |     GET = 'GET'
 64 |     HEAD = 'HEAD'
 65 |     OPTIONS = 'OPTIONS'
 66 |     PATCH = 'PATCH'
 67 |     POST = 'POST'
 68 |     PUT = 'PUT'
 69 | 
 70 |     def __init__(self):
 71 |         self._calls = CallList()
 72 |         self.reset()
 73 | 
 74 |     def reset(self):
 75 |         self._urls = []
 76 |         self._calls.reset()
 77 | 
 78 |     def add(self, method, url, body='', match_querystring=False,
 79 |             status=200, adding_headers=None, stream=False,
 80 |             content_type='text/plain'):
 81 |         # ensure the url has a default path set
 82 |         if url.count('/') == 2:
 83 |             url = url.replace('?', '/?', 1) if match_querystring \
 84 |                 else url + '/'
 85 | 
 86 |         # body must be bytes
 87 |         if isinstance(body, six.text_type):
 88 |             body = body.encode('utf-8')
 89 | 
 90 |         self._urls.append({
 91 |             'url': url,
 92 |             'method': method,
 93 |             'body': body,
 94 |             'content_type': content_type,
 95 |             'match_querystring': match_querystring,
 96 |             'status': status,
 97 |             'adding_headers': adding_headers,
 98 |             'stream': stream,
 99 |         })
100 | 
101 |     @property
102 |     def calls(self):
103 |         return self._calls
104 | 
105 |     def activate(self, func):
106 |         @wraps(func)
107 |         def wrapped(*args, **kwargs):
108 |             self._start()
109 |             try:
110 |                 return func(*args, **kwargs)
111 |             finally:
112 |                 self._stop()
113 |                 self.reset()
114 |         return wrapped
115 | 
116 |     def _find_match(self, request):
117 |         url = request.url
118 |         url_without_qs = url.split('?', 1)[0]
119 | 
120 |         for match in self._urls:
121 |             if request.method != match['method']:
122 |                 continue
123 | 
124 |             # TODO(dcramer): we could simplify this by compiling a single
125 |             # regexp on register
126 |             if match['match_querystring']:
127 |                 if not re.match(re.escape(match['url']), url):
128 |                     continue
129 |             else:
130 |                 if match['url'] != url_without_qs:
131 |                     continue
132 | 
133 |             return match
134 | 
135 |         return None
136 | 
137 |     def _on_request(self, request, **kwargs):
138 |         match = self._find_match(request)
139 | 
140 |         # TODO(dcramer): find the correct class for this
141 |         if match is None:
142 |             error_msg = 'Connection refused: {0}'.format(request.url)
143 |             response = ConnectionError(error_msg)
144 | 
145 |             self._calls.add(request, response)
146 |             raise response
147 | 
148 |         headers = {
149 |             'Content-Type': match['content_type'],
150 |         }
151 |         if match['adding_headers']:
152 |             headers.update(match['adding_headers'])
153 | 
154 |         response = HTTPResponse(
155 |             status=match['status'],
156 |             body=BufferIO(match['body']),
157 |             headers=headers,
158 |             preload_content=False,
159 |         )
160 | 
161 |         adapter = HTTPAdapter()
162 | 
163 |         response = adapter.build_response(request, response)
164 |         if not match['stream']:
165 |             response.content  # NOQA
166 | 
167 |         self._calls.add(request, response)
168 | 
169 |         return response
170 | 
171 |     def _start(self):
172 |         import mock
173 |         self._patcher = mock.patch('requests.Session.send', self._on_request)
174 |         self._patcher.start()
175 | 
176 |     def _stop(self):
177 |         self._patcher.stop()
178 | 
179 | 
180 | # expose default mock namespace
181 | _default_mock = RequestsMock()
182 | __all__ = []
183 | for __attr in (a for a in dir(_default_mock) if not a.startswith('_')):
184 |     __all__.append(__attr)
185 |     globals()[__attr] = getattr(_default_mock, __attr)
186 | 


--------------------------------------------------------------------------------
/setup.cfg:
--------------------------------------------------------------------------------
1 | [flake8]
2 | ignore = E127,E128,E265,E302,N803,N804,N806,E731,E402
3 | exclude = compat.py,ordereddict.py
4 | max-line-length = 90
5 | 


--------------------------------------------------------------------------------
/setup.py:
--------------------------------------------------------------------------------
 1 | # -*- coding: utf-8 -*-
 2 | 
 3 | import os
 4 | import re
 5 | import sys
 6 | 
 7 | from setuptools import setup
 8 | from setuptools import find_packages
 9 | 
10 | 
11 | REQUIREMENTS = [
12 |     'beautifulsoup4>=4.3.2',
13 |     'requests>=2.6.0',
14 |     'six>=1.9.0',
15 |     'Werkzeug>=0.10.4',
16 | ]
17 | TEST_REQUIREMENTS = [
18 |     'coverage',
19 |     'coveralls',
20 |     'docutils',
21 |     'mock',
22 |     'nose',
23 |     'sphinx',
24 |     'tox',
25 | ]
26 | 
27 | 
28 | if sys.argv[-1] == 'publish':
29 |     os.system('python setup.py sdist upload')
30 |     sys.exit()
31 | 
32 | 
33 | def find_version(fname):
34 |     """Attempts to find the version number in the file names fname.
35 |     Raises RuntimeError if not found.
36 |     """
37 |     version = ''
38 |     with open(fname, 'r') as fp:
39 |         reg = re.compile(r'__version__ = [\'"]([^\'"]*)[\'"]')
40 |         for line in fp:
41 |             m = reg.match(line)
42 |             if m:
43 |                 version = m.group(1)
44 |                 break
45 |     if not version:
46 |         raise RuntimeError('Cannot find version information')
47 |     return version
48 | 
49 | 
50 | setup(
51 |     name='robobrowser',
52 |     version=find_version('robobrowser/__init__.py'),
53 |     description='Your friendly neighborhood web scraper',
54 |     author='Joshua Carp',
55 |     author_email='jm.carp@gmail.com',
56 |     url='https://github.com/jmcarp/robobrowser',
57 |     packages=find_packages(exclude=('tests',)),
58 |     package_dir={'robobrowser': 'robobrowser'},
59 |     include_package_data=True,
60 |     install_requires=REQUIREMENTS,
61 |     tests_require=TEST_REQUIREMENTS,
62 |     license='MIT',
63 |     zip_safe=False,
64 |     keywords='robobrowser',
65 |     classifiers=[
66 |         'Development Status :: 2 - Pre-Alpha',
67 |         'Intended Audience :: Developers',
68 |         'License :: OSI Approved :: BSD License',
69 |         'Natural Language :: English',
70 |         'Programming Language :: Python :: 2',
71 |         'Programming Language :: Python :: 2.6',
72 |         'Programming Language :: Python :: 2.7',
73 |         'Programming Language :: Python :: 3',
74 |         'Programming Language :: Python :: 3.3',
75 |         'Programming Language :: Python :: 3.4',
76 |     ],
77 |     test_suite='tests',
78 | )
79 | 


--------------------------------------------------------------------------------
/tests/__init__.py:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/jmcarp/robobrowser/4284c11d00ae1397983e269aa180e5cf7ee5f4cf/tests/__init__.py


--------------------------------------------------------------------------------
/tests/fixtures.py:
--------------------------------------------------------------------------------
 1 | from robobrowser import responses
 2 | 
 3 | from tests import utils
 4 | 
 5 | mock_links = utils.mock_responses(
 6 |     [
 7 |         utils.ArgCatcher(
 8 |             responses.GET, 'http://robobrowser.com/links/',
 9 |             body=b'''
10 |                 <a href="/link1/">sheer heart attack</a>
11 |                 <a href="/link2/" class="song">night at the opera</a>
12 |                 <a class="nohref">no href</a>
13 |             '''
14 |         ),
15 |         utils.ArgCatcher(responses.GET, 'http://robobrowser.com/link1/'),
16 |         utils.ArgCatcher(responses.GET, 'http://robobrowser.com/link2/'),
17 |     ]
18 | )
19 | 
20 | mock_forms = utils.mock_responses(
21 |     [
22 |         utils.ArgCatcher(
23 |             responses.GET, 'http://robobrowser.com/get_form/',
24 |             body=b'''
25 |                 <form id="bass" method="get" action="/get_form/">'
26 |                     <input name="deacon" value="john" />
27 |                 </form>
28 |                 <form id="drums" method="post" action="/get_form/">'
29 |                     <input name="deacon" value="john" />
30 |                 </form>
31 |             '''
32 |         ),
33 |         utils.ArgCatcher(
34 |             responses.GET, 'http://robobrowser.com/multi_submit_form/',
35 |             body=b'''
36 |                 <form id="bass" method="get" action="/multi_submit_form/">'
37 |                     <input name="deacon" value="john" />
38 |                     <input type="submit" name="submit1" value="value1" />
39 |                     <input type="submit" name="submit2" value="value2" />
40 |                 </form>
41 |             '''
42 |         ),
43 |         utils.ArgCatcher(
44 |             responses.GET, 'http://robobrowser.com/post_form/',
45 |             body=b'''
46 |                 <form id="bass" method="post" action="/submit/">'
47 |                     <input name="deacon" value="john" />
48 |                 </form>
49 |                 <form id="drums" method="post" action="/submit/">'
50 |                     <input name="deacon" value="john" />
51 |                 </form>
52 |             '''
53 |         ),
54 |         utils.ArgCatcher(
55 |             responses.GET, 'http://robobrowser.com/noname/',
56 |             body=b'''
57 |                 <form name="input" action="action" method="get">
58 |                 <input type="checkbox" name="vehicle" value="Bike">
59 |                     I have a bike<br>
60 |                 <input type="checkbox" name="vehicle" value="Car">I have a car
61 |                 <br><br>
62 |                 <input type="submit" value="Submit">
63 |                 </form>
64 |             '''
65 |         ),
66 |         utils.ArgCatcher(
67 |             responses.POST, 'http://robobrowser.com/submit/',
68 |         ),
69 |     ]
70 | )
71 | 
72 | mock_urls = utils.mock_responses(
73 |     [
74 |         utils.ArgCatcher(responses.GET, 'http://robobrowser.com/page1/'),
75 |         utils.ArgCatcher(responses.GET, 'http://robobrowser.com/page2/'),
76 |         utils.ArgCatcher(responses.GET, 'http://robobrowser.com/page3/'),
77 |         utils.ArgCatcher(responses.GET, 'http://robobrowser.com/page4/'),
78 |     ]
79 | )
80 | 


--------------------------------------------------------------------------------
/tests/test_browser.py:
--------------------------------------------------------------------------------
  1 | import mock
  2 | import unittest
  3 | from nose.tools import *  # noqa
  4 | 
  5 | import re
  6 | import requests
  7 | from bs4 import BeautifulSoup
  8 | 
  9 | from robobrowser.browser import RoboBrowser
 10 | from robobrowser import exceptions
 11 | 
 12 | from tests.fixtures import mock_links, mock_urls, mock_forms
 13 | 
 14 | 
 15 | class TestHeaders(unittest.TestCase):
 16 | 
 17 |     @mock_links
 18 |     def test_user_agent(self):
 19 |         browser = RoboBrowser(user_agent='freddie')
 20 |         browser.open('http://robobrowser.com/links/')
 21 |         assert_true('User-Agent' in browser.session.headers)
 22 |         assert_equal(
 23 |             browser.session.headers['User-Agent'], 'freddie'
 24 |         )
 25 | 
 26 |     def test_default_headers(self):
 27 |         browser = RoboBrowser()
 28 |         assert_equal(browser.session.headers, requests.Session().headers)
 29 | 
 30 | 
 31 | class TestOpen(unittest.TestCase):
 32 | 
 33 |     def setUp(self):
 34 |         self.browser = RoboBrowser()
 35 | 
 36 |     @mock.patch('requests.Session.request')
 37 |     def test_open_default_method(self, mock_request):
 38 |         url = 'http://robobrowser.com'
 39 |         self.browser.open(url)
 40 |         assert_true(mock_request.called)
 41 |         args = mock_request.mock_calls[0][1]
 42 |         assert_equal(args, ('get', url))
 43 | 
 44 |     @mock.patch('requests.Session.request')
 45 |     def test_open_custom_method(self, mock_request):
 46 |         url = 'http://robobrowser.com'
 47 |         self.browser.open(url, method='post')
 48 |         assert_true(mock_request.called)
 49 |         args = mock_request.mock_calls[0][1]
 50 |         assert_equal(args, ('post', url))
 51 | 
 52 | 
 53 | class TestLinks(unittest.TestCase):
 54 | 
 55 |     @mock_links
 56 |     def setUp(self):
 57 |         self.browser = RoboBrowser()
 58 |         self.browser.open('http://robobrowser.com/links/')
 59 | 
 60 |     @mock_links
 61 |     def test_get_link(self):
 62 |         link = self.browser.get_link()
 63 |         assert_equal(link.get('href'), '/link1/')
 64 | 
 65 |     @mock_links
 66 |     def test_get_links(self):
 67 |         links = self.browser.get_links()
 68 |         assert_equal(len(links), 3)
 69 | 
 70 |     @mock_links
 71 |     def test_follow_link_tag(self):
 72 |         link = self.browser.get_link(text=re.compile('sheer'))
 73 |         self.browser.follow_link(link)
 74 |         assert_equal(self.browser.url, 'http://robobrowser.com/link1/')
 75 | 
 76 |     @mock_links
 77 |     def test_follow_link_no_href(self):
 78 |         link = BeautifulSoup('<a>nohref</a>').find('a')
 79 |         assert_raises(
 80 |             exceptions.RoboError,
 81 |             lambda: self.browser.follow_link(link)
 82 |         )
 83 | 
 84 | 
 85 | class TestForms(unittest.TestCase):
 86 | 
 87 |     def setUp(self):
 88 |         self.browser = RoboBrowser()
 89 | 
 90 |     @mock_forms
 91 |     def test_get_forms(self):
 92 |         self.browser.open('http://robobrowser.com/get_form/')
 93 |         forms = self.browser.get_forms()
 94 |         assert_equal(len(forms), 2)
 95 | 
 96 |     @mock_forms
 97 |     def test_get_form_by_id(self):
 98 |         self.browser.open('http://robobrowser.com/get_form/')
 99 |         form = self.browser.get_form('bass')
100 |         assert_equal(form.parsed.get('id'), 'bass')
101 | 
102 |     @mock_forms
103 |     def test_submit_form_get(self):
104 |         self.browser.open('http://robobrowser.com/get_form/')
105 |         form = self.browser.get_form()
106 |         self.browser.submit_form(form)
107 |         assert_equal(
108 |             self.browser.url,
109 |             'http://robobrowser.com/get_form/?deacon=john'
110 |         )
111 |         assert_true(self.browser.state.response.request.body is None)
112 | 
113 |     @mock_forms
114 |     def test_submit_form_multi_submit(self):
115 |         self.browser.open('http://robobrowser.com/multi_submit_form/')
116 |         form = self.browser.get_form()
117 |         submit = form.submit_fields['submit2']
118 |         self.browser.submit_form(form, submit=submit)
119 |         assert_equal(
120 |             self.browser.url,
121 |             'http://robobrowser.com/multi_submit_form/'
122 |             '?deacon=john&submit2=value2'
123 |         )
124 | 
125 |     @mock_forms
126 |     def test_submit_form_post(self):
127 |         self.browser.open('http://robobrowser.com/post_form/')
128 |         form = self.browser.get_form()
129 |         self.browser.submit_form(form)
130 |         assert_equal(
131 |             self.browser.url,
132 |             'http://robobrowser.com/submit/'
133 |         )
134 |         assert_equal(
135 |             self.browser.state.response.request.body,
136 |             'deacon=john'
137 |         )
138 | 
139 | 
140 | class TestFormsInputNoName(unittest.TestCase):
141 | 
142 |     @mock_forms
143 |     def setUp(self):
144 |         self.browser = RoboBrowser()
145 |         self.browser.open('http://robobrowser.com/noname/')
146 | 
147 |     @mock_forms
148 |     def test_get_forms(self):
149 |         forms = self.browser.get_forms()
150 |         assert_equal(len(forms), 1)
151 | 
152 | 
153 | class TestHistoryInternals(unittest.TestCase):
154 | 
155 |     def setUp(self):
156 |         self.browser = RoboBrowser(history=True)
157 | 
158 |     @mock_urls
159 |     def test_open_appends_to_history(self):
160 |         assert_equal(len(self.browser._states), 0)
161 |         assert_equal(self.browser._cursor, -1)
162 |         self.browser.open('http://robobrowser.com/page1/')
163 |         assert_equal(len(self.browser._states), 1)
164 |         assert_equal(self.browser._cursor, 0)
165 | 
166 |     @mock_forms
167 |     def test_submit_appends_to_history(self):
168 |         self.browser.open('http://robobrowser.com/get_form/')
169 |         form = self.browser.get_form()
170 |         self.browser.submit_form(form)
171 | 
172 |         assert_equal(len(self.browser._states), 2)
173 |         assert_equal(self.browser._cursor, 1)
174 | 
175 |     @mock_urls
176 |     def test_open_clears_history_after_back(self):
177 |         self.browser.open('http://robobrowser.com/page1/')
178 |         self.browser.open('http://robobrowser.com/page2/')
179 |         self.browser.back()
180 |         self.browser.open('http://robobrowser.com/page3/')
181 |         assert_equal(len(self.browser._states), 2)
182 |         assert_equal(self.browser._cursor, 1)
183 | 
184 |     @mock_urls
185 |     def test_state_deque_max_length(self):
186 |         browser = RoboBrowser(history=5)
187 |         for _ in range(5):
188 |             browser.open('http://robobrowser.com/page1/')
189 |         assert_equal(len(browser._states), 5)
190 |         browser.open('http://robobrowser.com/page2/')
191 |         assert_equal(len(browser._states), 5)
192 | 
193 |     @mock_urls
194 |     def test_state_deque_no_history(self):
195 |         browser = RoboBrowser(history=False)
196 |         for _ in range(5):
197 |             browser.open('http://robobrowser.com/page1/')
198 |             assert_equal(len(browser._states), 1)
199 |             assert_equal(browser._cursor, 0)
200 | 
201 | 
202 | class TestHistory(unittest.TestCase):
203 | 
204 |     @mock_urls
205 |     def setUp(self):
206 |         self.browser = RoboBrowser(history=True)
207 |         self.browser.open('http://robobrowser.com/page1/')
208 |         self.browser.open('http://robobrowser.com/page2/')
209 |         self.browser.open('http://robobrowser.com/page3/')
210 | 
211 |     def test_back(self):
212 |         self.browser.back()
213 |         assert_equal(
214 |             self.browser.url,
215 |             'http://robobrowser.com/page2/'
216 |         )
217 | 
218 |     def test_back_n(self):
219 |         self.browser.back(n=2)
220 |         assert_equal(
221 |             self.browser.url,
222 |             'http://robobrowser.com/page1/'
223 |         )
224 | 
225 |     def test_forward(self):
226 |         self.browser.back()
227 |         self.browser.forward()
228 |         assert_equal(
229 |             self.browser.url,
230 |             'http://robobrowser.com/page3/'
231 |         )
232 | 
233 |     def test_forward_n(self):
234 |         self.browser.back(n=2)
235 |         self.browser.forward(n=2)
236 |         assert_equal(
237 |             self.browser.url,
238 |             'http://robobrowser.com/page3/'
239 |         )
240 | 
241 |     @mock_urls
242 |     def test_open_clears_forward(self):
243 |         self.browser.back(n=2)
244 |         self.browser.open('http://robobrowser.com/page4/')
245 |         assert_equal(
246 |             self.browser._cursor,
247 |             len(self.browser._states) - 1
248 |         )
249 |         assert_raises(
250 |             exceptions.RoboError,
251 |             self.browser.forward
252 |         )
253 | 
254 |     def test_back_error(self):
255 |         assert_raises(
256 |             exceptions.RoboError,
257 |             self.browser.back,
258 |             5
259 |         )
260 | 
261 | 
262 | class TestCustomSession(unittest.TestCase):
263 | 
264 |     @mock_links
265 |     def test_custom_headers(self):
266 |         session = requests.Session()
267 |         session.headers.update({
268 |             'Content-Encoding': 'gzip',
269 |         })
270 |         browser = RoboBrowser(session=session)
271 |         browser.open('http://robobrowser.com/links/')
272 |         assert_equal(
273 |             browser.response.request.headers.get('Content-Encoding'),
274 |             'gzip'
275 |         )
276 | 
277 |     @mock_links
278 |     def test_custom_headers_override(self):
279 |         session = requests.Session()
280 |         session.headers.update({
281 |             'Content-Encoding': 'gzip',
282 |         })
283 |         browser = RoboBrowser(session=session)
284 |         browser.open(
285 |             'http://robobrowser.com/links/',
286 |             headers={'Content-Encoding': 'identity'}
287 |         )
288 |         assert_equal(
289 |             browser.response.request.headers.get('Content-Encoding'),
290 |             'identity'
291 |         )
292 | 
293 | 
294 | class TestTimeout(unittest.TestCase):
295 | 
296 |     @mock.patch('requests.Session.request')
297 |     def test_no_timeout(self, mock_request):
298 |         browser = RoboBrowser()
299 |         browser.open('http://robobrowser.com/')
300 |         assert_true(mock_request.called)
301 |         kwargs = mock_request.mock_calls[0][2]
302 |         assert_true(kwargs.get('timeout') is None)
303 | 
304 |     @mock.patch('requests.Session.request')
305 |     def test_instance_timeout(self, mock_request):
306 |         browser = RoboBrowser(timeout=5)
307 |         browser.open('http://robobrowser.com/')
308 |         assert_true(mock_request.called)
309 |         kwargs = mock_request.mock_calls[0][2]
310 |         assert_equal(kwargs.get('timeout'), 5)
311 | 
312 |     @mock.patch('requests.Session.request')
313 |     def test_call_timeout(self, mock_request):
314 |         browser = RoboBrowser(timeout=5)
315 |         browser.open('http://robobrowser.com/', timeout=10)
316 |         assert_true(mock_request.called)
317 |         kwargs = mock_request.mock_calls[0][2]
318 |         assert_equal(kwargs.get('timeout'), 10)
319 | 
320 | 
321 | class TestAllowRedirects(unittest.TestCase):
322 | 
323 |     @mock.patch('requests.Session.request')
324 |     def test_no_allow_redirects(self, mock_request):
325 |         browser = RoboBrowser()
326 |         browser.open('http://robobrowser.com/')
327 |         assert_true(mock_request.called)
328 |         kwargs = mock_request.mock_calls[0][2]
329 |         assert_true(kwargs.get('allow_redirects') is True)
330 | 
331 |     @mock.patch('requests.Session.request')
332 |     def test_instance_allow_redirects(self, mock_request):
333 |         browser = RoboBrowser(allow_redirects=False)
334 |         browser.open('http://robobrowser.com/')
335 |         assert_true(mock_request.called)
336 |         kwargs = mock_request.mock_calls[0][2]
337 |         assert_true(kwargs.get('allow_redirects') is False)
338 | 
339 |     @mock.patch('requests.Session.request')
340 |     def test_call_allow_redirects(self, mock_request):
341 |         browser = RoboBrowser(allow_redirects=True)
342 |         browser.open('http://robobrowser.com/', allow_redirects=False)
343 |         assert_true(mock_request.called)
344 |         kwargs = mock_request.mock_calls[0][2]
345 |         assert_true(kwargs.get('allow_redirects') is False)
346 | 


--------------------------------------------------------------------------------
/tests/test_cache.py:
--------------------------------------------------------------------------------
 1 | import unittest
 2 | from nose.tools import *
 3 | 
 4 | import datetime
 5 | 
 6 | from robobrowser.browser import RoboBrowser
 7 | from robobrowser.cache import RoboCache
 8 | from tests.utils import KwargSetter
 9 | 
10 | 
11 | class TestAdapter(unittest.TestCase):
12 | 
13 |     def test_cache_on(self):
14 |         self.browser = RoboBrowser(cache=True)
15 |         self.browser.open('http://httpbin.org/')
16 |         resp1 = self.browser.state.response
17 |         self.browser.open('http://httpbin.org/')
18 |         resp2 = self.browser.state.response
19 |         assert_true(resp1 is resp2)
20 | 
21 |     def test_cache_off(self):
22 |         self.browser = RoboBrowser(cache=False)
23 |         self.browser.open('http://httpbin.org/')
24 |         resp1 = self.browser.state.response
25 |         self.browser.open('http://httpbin.org/')
26 |         resp2 = self.browser.state.response
27 |         assert_true(resp1 is not resp2)
28 | 
29 | 
30 | class TestCache(unittest.TestCase):
31 | 
32 |     def setUp(self):
33 |         self.cache = RoboCache()
34 | 
35 |     def test_store(self):
36 |         url = 'http://robobrowser.com/'
37 |         response = KwargSetter(url=url, status_code=200)
38 |         now = datetime.datetime.now()
39 |         self.cache.store(response)
40 |         assert_true(url in self.cache.data)
41 |         assert_equal(self.cache.data[url]['response'], response)
42 |         date_diff = self.cache.data[url]['date'] - now
43 |         assert_true(date_diff < datetime.timedelta(seconds=0.1))
44 | 
45 |     def test_store_invalid_verb(self):
46 |         url = 'http://robobrowser.com/'
47 |         response = KwargSetter(url=url, status_code=400)
48 |         self.cache.store(response)
49 |         assert_false(url in self.cache.data)
50 | 
51 |     def test_retrieve_not_stored(self):
52 |         request = KwargSetter(url='http://robobrowser.com/', method='GET')
53 |         retrieved = self.cache.retrieve(request)
54 |         assert_equal(retrieved, None)
55 | 
56 |     def test_retrieve_stored(self):
57 |         request = KwargSetter(url='http://robobrowser.com/', method='GET')
58 |         response = KwargSetter(url='http://robobrowser.com/', status_code=200)
59 |         self.cache.store(response)
60 |         retrieved = self.cache.retrieve(request)
61 |         assert_equal(retrieved, response)
62 | 
63 |     def test_retrieve_invalid_code(self):
64 |         request = KwargSetter(url='http://robobrowser.com/', method='GET')
65 |         response = KwargSetter(url='http://robobrowser.com/', status_code=400)
66 |         self.cache.store(response)
67 |         retrieved = self.cache.retrieve(request)
68 |         assert_equal(retrieved, None)
69 | 
70 |     def test_reduce_age(self):
71 |         for idx in range(5):
72 |             response = KwargSetter(url=idx, status_code=200)
73 |             self.cache.store(response)
74 |             # time.sleep(0.1)
75 |         assert_equal(len(self.cache.data), 5)
76 |         now = datetime.datetime.now()
77 |         self.cache.max_age = now - self.cache.data[2]['date']
78 |         self.cache._reduce_age(now)
79 |         assert_equal(len(self.cache.data), 3)
80 |         # Cast keys to list for 3.3 compatibility
81 |         assert_equal(list(self.cache.data.keys()), [2, 3, 4])
82 | 
83 |     def test_reduce_count(self):
84 |         for idx in range(5):
85 |             response = KwargSetter(url=idx, status_code=200)
86 |             self.cache.store(response)
87 |         assert_equal(len(self.cache.data), 5)
88 |         self.cache.max_count = 3
89 |         self.cache._reduce_count()
90 |         assert_equal(len(self.cache.data), 3)
91 |         # Cast keys to list for 3.3 compatibility
92 |         assert_equal(list(self.cache.data.keys()), [2, 3, 4])
93 | 


--------------------------------------------------------------------------------
/tests/test_forms.py:
--------------------------------------------------------------------------------
  1 | # -*- coding: utf-8 -*-
  2 | 
  3 | import mock
  4 | import unittest
  5 | from nose.tools import *  # noqa
  6 | 
  7 | import tempfile
  8 | from bs4 import BeautifulSoup
  9 | 
 10 | from robobrowser.compat import builtin_name
 11 | from robobrowser.forms.form import Form, Payload, fields, _parse_fields
 12 | from robobrowser import exceptions
 13 | 
 14 | 
 15 | class TestPayload(unittest.TestCase):
 16 | 
 17 |     def setUp(self):
 18 |         self.payload = Payload()
 19 |         self.payload.add({'red': 'special'})
 20 | 
 21 |     def test_add_payload(self):
 22 |         self.payload.add({'lazing': 'sunday'})
 23 |         assert_true('lazing' in self.payload.data)
 24 |         assert_equal(self.payload.data['lazing'], 'sunday')
 25 | 
 26 |     def test_add_by_key(self):
 27 |         self.payload.add({'lazing': 'sunday'}, 'afternoon')
 28 |         assert_false('lazing' in self.payload.data)
 29 |         assert_true('afternoon' in self.payload.options)
 30 |         assert_true('lazing' in self.payload.options['afternoon'])
 31 |         assert_equal(
 32 |             self.payload.options['afternoon']['lazing'],
 33 |             'sunday'
 34 |         )
 35 | 
 36 |     def test_requests_get(self):
 37 |         out = self.payload.to_requests('get')
 38 |         assert_true('params' in out)
 39 |         assert_equal(list(out['params']), [('red', 'special')])
 40 | 
 41 |     def test_requests_post(self):
 42 |         out = self.payload.to_requests('post')
 43 |         assert_true('data' in out)
 44 |         assert_equal(list(out['data']), [('red', 'special')])
 45 | 
 46 | 
 47 | class TestForm(unittest.TestCase):
 48 | 
 49 |     def setUp(self):
 50 |         self.html = '''
 51 |             <form>
 52 |                 <input name="vocals" />
 53 |                 <input name="guitar" type="file" />
 54 |                 <select name="drums">
 55 |                     <option value="roger">Roger<br />
 56 |                     <option value="john">John<br />
 57 |                 </select>
 58 |                 <input type="radio" name="bass" value="Roger">Roger<br />
 59 |                 <input type="radio" name="bass" value="John">John<br />
 60 |                 <input name="multi" value="multi1" />
 61 |                 <input name="multi" value="multi2" />
 62 |                 <input type="submit" name="submit" value="submit" />
 63 |             </form>
 64 |         '''
 65 |         self.form = Form(self.html)
 66 | 
 67 |     def test_fields(self):
 68 |         keys = set(('vocals', 'guitar', 'drums', 'bass', 'multi', 'submit'))
 69 |         assert_equal(set(self.form.fields.keys()), keys)
 70 |         assert_equal(set(self.form.keys()), keys)
 71 | 
 72 |     def test_add_field(self):
 73 |         html = '<input name="instrument" />'
 74 |         field = fields.Input(html)
 75 |         self.form.add_field(field)
 76 |         assert_true('instrument' in self.form.fields)
 77 | 
 78 |     def test_add_field_wrong_type(self):
 79 |         assert_raises(ValueError, lambda: self.form.add_field('freddie'))
 80 | 
 81 |     def test_repr(self):
 82 |         assert_equal(
 83 |             repr(self.form),
 84 |             '<RoboForm vocals=, guitar=, drums=roger, bass=, '
 85 |             'multi=multi1, multi=multi2, submit=submit>'
 86 |         )
 87 | 
 88 |     def test_repr_empty(self):
 89 |         assert_equal(
 90 |             repr(Form('<form></form>')),
 91 |             '<RoboForm>'
 92 |         )
 93 | 
 94 |     def test_repr_unicode(self):
 95 |         form = Form(u'<form><input name="drüms" value="bäss" /></form>')
 96 |         assert_equal(
 97 |             repr(form),
 98 |             '<RoboForm drüms=bäss>'
 99 |         )
100 | 
101 |     def test_serialize(self):
102 |         serialized = self.form.serialize()
103 |         assert_equal(serialized.data.getlist('multi'), ['multi1', 'multi2'])
104 |         assert_equal(serialized.data['submit'], 'submit')
105 | 
106 |     def test_serialize_skips_disabled(self):
107 |         html = '''
108 |             <form>
109 |                 <input name="vocals" />
110 |                 <input name="guitar" disabled />
111 |                 <input type="submit" name="submit" value="submit" />
112 |             </form>
113 |         '''
114 |         form = Form(html)
115 |         serialized = form.serialize()
116 |         assert_false('guitar' in serialized.data)
117 | 
118 | 
119 | class TestFormMultiSubmit(unittest.TestCase):
120 | 
121 |     def setUp(self):
122 |         self.html = '''
123 |             <form>
124 |                 <input type="submit" name="submit1" value="value1" />
125 |                 <input type="submit" name="submit2" value="value2" />
126 |             </form>
127 |         '''
128 |         self.form = Form(self.html)
129 | 
130 |     def test_serialize_multi_no_submit_specified(self):
131 |         assert_raises(
132 |             exceptions.InvalidSubmitError,
133 |             lambda: self.form.serialize()
134 |         )
135 | 
136 |     def test_serialize_multi_wrong_submit_specified(self):
137 |         fake_submit = fields.Submit('<input type="submit" name="fake" />')
138 |         assert_raises(
139 |             exceptions.InvalidSubmitError,
140 |             lambda: self.form.serialize(submit=fake_submit)
141 |         )
142 | 
143 |     def test_serialize_multi(self):
144 |         submit = self.form.submit_fields['submit1']
145 |         serialized = self.form.serialize(submit)
146 |         assert_equal(serialized.data['submit1'], 'value1')
147 |         assert_false('submit2' in serialized.data)
148 | 
149 | 
150 | class TestParser(unittest.TestCase):
151 | 
152 |     def setUp(self):
153 |         self.form = Form('<form></form>')
154 | 
155 |     def test_method_default(self):
156 |         assert_equal(self.form.method, 'get')
157 | 
158 |     def test_method(self):
159 |         form = Form('<form method="put"></form>')
160 |         assert_equal(form.method, 'put')
161 | 
162 |     def test_action(self):
163 |         form = Form('<form action="/"></form>')
164 |         assert_equal(form.action, '/')
165 | 
166 |     def test_parse_input(self):
167 |         html = '<input name="band" value="queen" />'
168 |         _fields = _parse_fields(BeautifulSoup(html))
169 |         assert_equal(len(_fields), 1)
170 |         assert_true(isinstance(_fields[0], fields.Input))
171 | 
172 |     def test_parse_file_input(self):
173 |         html = '<input name="band" type="file" />'
174 |         _fields = _parse_fields(BeautifulSoup(html))
175 |         assert_equal(len(_fields), 1)
176 |         assert_true(isinstance(_fields[0], fields.FileInput))
177 | 
178 |     def test_parse_textarea(self):
179 |         html = '<textarea name="band">queen</textarea>'
180 |         _fields = _parse_fields(BeautifulSoup(html))
181 |         assert_equal(len(_fields), 1)
182 |         assert_true(isinstance(_fields[0], fields.Textarea))
183 | 
184 |     def test_parse_radio(self):
185 |         html = '''
186 |             <input type="radio" name="favorite_member" />freddie<br />
187 |             <input type="radio" name="favorite_member" />brian<br />
188 |             <input type="radio" name="favorite_member" />roger<br />
189 |             <input type="radio" name="favorite_member" />john<br />
190 |             <input type="radio" name="favorite_song" />rhapsody<br />
191 |             <input type="radio" name="favorite_song" />killer<br />
192 |         '''
193 |         _fields = _parse_fields(BeautifulSoup(html))
194 |         assert_equal(len(_fields), 2)
195 |         assert_true(isinstance(_fields[0], fields.Radio))
196 |         assert_true(isinstance(_fields[0], fields.Radio))
197 |         assert_equal(
198 |             len(_fields[0]._parsed), 4
199 |         )
200 |         assert_equal(
201 |             len(_fields[1]._parsed), 2
202 |         )
203 | 
204 |     def test_parse_checkbox(self):
205 |         html = '''
206 |             <input type="checkbox" name="favorite_member" />freddie<br />
207 |             <input type="checkbox" name="favorite_member" />brian<br />
208 |             <input type="checkbox" name="favorite_member" />roger<br />
209 |             <input type="checkbox" name="favorite_member" />john<br />
210 |             <input type="checkbox" name="favorite_song" />rhapsody<br />
211 |             <input type="checkbox" name="favorite_song" />killer<br />
212 |         '''
213 |         _fields = _parse_fields(BeautifulSoup(html))
214 |         assert_equal(len(_fields), 2)
215 |         assert_true(isinstance(_fields[0], fields.Checkbox))
216 |         assert_true(isinstance(_fields[1], fields.Checkbox))
217 |         assert_equal(len(_fields[0]._parsed), 4)
218 |         assert_equal(len(_fields[1]._parsed), 2)
219 | 
220 |     def test_parse_select(self):
221 |         html = '''
222 |             <select name="instrument">
223 |                 <option value="vocals">vocals</option>
224 |                 <option value="guitar">guitar</option>
225 |                 <option value="drums">drums</option>
226 |                 <option value="bass">bass</option>
227 |             </select>
228 |         '''
229 |         _fields = _parse_fields(BeautifulSoup(html))
230 |         assert_equal(len(_fields), 1)
231 |         assert_true(isinstance(_fields[0], fields.Select))
232 | 
233 |     def test_parse_empty_select(self):
234 |         html = '''
235 |             <select name="instrument"></select>
236 |         '''
237 |         _fields = _parse_fields(BeautifulSoup(html))
238 |         assert_equal(len(_fields), 1)
239 |         assert_true(isinstance(_fields[0], fields.Select))
240 |         assert_equal(_fields[0].value, '')
241 |         assert_equal(_fields[0].options, [])
242 | 
243 |     def test_parse_select_multi(self):
244 |         html = '''
245 |             <select name="instrument" multiple>
246 |                 <option value="vocals">vocals</option>
247 |                 <option value="guitar">guitar</option>
248 |                 <option value="drums">drums</option>
249 |                 <option value="bass">bass</option>
250 |             </select>
251 |         '''
252 |         _fields = _parse_fields(BeautifulSoup(html))
253 |         assert_equal(len(_fields), 1)
254 |         assert_true(isinstance(_fields[0], fields.MultiSelect))
255 | 
256 | 
257 | class TestInput(unittest.TestCase):
258 | 
259 |     def setUp(self):
260 |         self.html = '<input name="brian" value="may" />'
261 |         self.input = fields.Input(BeautifulSoup(self.html).find('input'))
262 | 
263 |     def test_name(self):
264 |         assert_equal(self.input.name, 'brian')
265 | 
266 |     def test_initial(self):
267 |         assert_equal(self.input._value, 'may')
268 |         assert_equal(self.input.value, 'may')
269 | 
270 |     def test_value(self):
271 |         self.input.value = 'red special'
272 |         assert_equal(self.input._value, 'red special')
273 |         assert_equal(self.input.value, 'red special')
274 | 
275 |     def test_serialize(self):
276 |         assert_equal(
277 |             self.input.serialize(),
278 |             {'brian': 'may'}
279 |         )
280 | 
281 |     def test_invalid_name(self):
282 |         html = '<input />'
283 |         assert_raises(exceptions.InvalidNameError, lambda: fields.Input(html))
284 | 
285 | 
286 | class TestInputBlank(unittest.TestCase):
287 | 
288 |     def setUp(self):
289 |         self.html = '<input name="blank" />'
290 |         self.input = fields.Input(BeautifulSoup(self.html).find('input'))
291 | 
292 |     def test_initial(self):
293 |         assert_equal(self.input._value, None)
294 |         assert_equal(self.input.value, '')
295 | 
296 |     def test_serialize(self):
297 |         assert_equal(
298 |             self.input.serialize(),
299 |             {'blank': ''}
300 |         )
301 | 
302 | 
303 | class TestTextarea(unittest.TestCase):
304 | 
305 |     def setUp(self):
306 |         self.html = '<textarea name="roger">taylor</textarea>'
307 |         self.input = fields.Textarea(BeautifulSoup(self.html).find('textarea'))
308 | 
309 |     def test_name(self):
310 |         assert_equal(self.input.name, 'roger')
311 | 
312 |     def test_initial(self):
313 |         assert_equal(self.input._value, 'taylor')
314 |         assert_equal(self.input.value, 'taylor')
315 | 
316 |     def test_value(self):
317 |         self.input.value = 'the drums'
318 |         assert_equal(self.input._value, 'the drums')
319 |         assert_equal(self.input.value, 'the drums')
320 | 
321 |     def test_serialize(self):
322 |         assert_equal(
323 |             self.input.serialize(),
324 |             {'roger': 'taylor'}
325 |         )
326 | 
327 | 
328 | class TestTextareaBlank(unittest.TestCase):
329 | 
330 |     def setUp(self):
331 |         self.html = '<textarea name="blank"></textarea>'
332 |         self.input = fields.Textarea(BeautifulSoup(self.html).find('textarea'))
333 | 
334 |     def test_initial(self):
335 |         assert_equal(self.input._value, '')
336 |         assert_equal(self.input.value, '')
337 | 
338 |     def test_serialize(self):
339 |         assert_equal(
340 |             self.input.serialize(),
341 |             {'blank': ''}
342 |         )
343 | 
344 | 
345 | class TestSelect(unittest.TestCase):
346 | 
347 |     def setUp(self):
348 |         self.html = '''
349 |             <select name="john">
350 |                 <option value="tie">your mother down</option>
351 |                 <option value="you're" selected>my best friend</option>
352 |                 <option value="the">millionaire waltz</option>
353 |             </select>
354 |         '''
355 |         self.input = fields.Select(BeautifulSoup(self.html).find('select'))
356 | 
357 |     def test_name(self):
358 |         assert_equal(self.input.name, 'john')
359 | 
360 |     def test_options(self):
361 |         assert_equal(
362 |             self.input.options,
363 |             ['tie', "you're", 'the']
364 |         )
365 | 
366 |     def test_initial(self):
367 |         assert_equal(self.input._value, 1)
368 |         assert_equal(self.input.value, "you're")
369 | 
370 |     def test_value(self):
371 |         self.input.value = 'the'
372 |         assert_equal(self.input._value, 2)
373 |         assert_equal(self.input.value, 'the')
374 | 
375 |     def test_value_label(self):
376 |         self.input.value = 'millionaire waltz'
377 |         assert_equal(self.input._value, 2)
378 |         assert_equal(self.input.value, 'the')
379 | 
380 |     def test_serialize(self):
381 |         assert_equal(
382 |             self.input.serialize(),
383 |             {'john': "you're"}
384 |         )
385 | 
386 | 
387 | class TestSelectBlank(unittest.TestCase):
388 | 
389 |     def setUp(self):
390 |         self.html = '''
391 |             <select name="john">
392 |                 <option value="tie">your mother down</option>
393 |                 <option value="you're">my best friend</option>
394 |                 <option value="the">millionaire waltz</option>
395 |             </select>
396 |         '''
397 |         self.input = fields.Select(BeautifulSoup(self.html).find('select'))
398 | 
399 |     def test_name(self):
400 |         assert_equal(self.input.name, 'john')
401 | 
402 |     def test_initial(self):
403 |         assert_equal(self.input._value, 0)
404 |         assert_equal(self.input.value, 'tie')
405 | 
406 |     def test_serialize(self):
407 |         assert_equal(
408 |             self.input.serialize(),
409 |             {'john': 'tie'}
410 |         )
411 | 
412 | 
413 | class TestMultiSelect(unittest.TestCase):
414 | 
415 |     def setUp(self):
416 |         self.html = '''
417 |             <select name="john" multiple>
418 |                 <option value="tie">your mother down</option>
419 |                 <option value="you're" selected>my best friend</option>
420 |                 <option value="the">millionaire waltz</option>
421 |             </select>
422 |         '''
423 |         self.input = fields.MultiSelect(BeautifulSoup(self.html).find('select'))
424 | 
425 | 
426 | class TestMixedCase(unittest.TestCase):
427 | 
428 |     def test_upper_type(self):
429 |         html = '''
430 |             <input type="RADIO" name="members" value="mercury" />vocals<br />
431 |         '''
432 |         input = fields.Radio(BeautifulSoup(html).find_all('input'))
433 |         assert_equal(input.name, 'members')
434 | 
435 |     def test_upper_name(self):
436 |         html = '''
437 |             <input type="radio" NAME="members" value="mercury" />vocals<br />
438 |         '''
439 |         input = fields.Radio(BeautifulSoup(html).find_all('input'))
440 |         assert_equal(input.name, 'members')
441 | 
442 |     def test_mixed_radio_names(self):
443 |         html = '''
444 |             <input type="radio" NAME="members" value="mercury" />vocals<br />
445 |             <input type="radio" NAME="MEMBERS" value="may" />guitar<br />
446 |         '''
447 |         input = fields.Radio(BeautifulSoup(html).find_all('input'))
448 |         assert_equal(input.name, 'members')
449 |         assert_equal(
450 |             input.options,
451 |             ['mercury', 'may']
452 |         )
453 | 
454 | 
455 | class TestRadio(unittest.TestCase):
456 | 
457 |     def setUp(self):
458 |         self.html = '''
459 |             <input type="radio" name="members" value="mercury" checked />vocals<br />
460 |             <input type="radio" name="members" value="may" />guitar<br />
461 |             <input type="radio" name="members" value="taylor" />drums<br />
462 |             <input type="radio" name="members" value="deacon" checked />bass<br />
463 |         '''
464 |         self.input = fields.Radio(BeautifulSoup(self.html).find_all('input'))
465 | 
466 |     def test_name(self):
467 |         assert_equal(self.input.name, 'members')
468 | 
469 |     def test_options(self):
470 |         assert_equal(
471 |             self.input.options,
472 |             ['mercury', 'may', 'taylor', 'deacon']
473 |         )
474 | 
475 |     def test_initial(self):
476 |         assert_equal(self.input.value, 'mercury')
477 | 
478 |     def test_value(self):
479 |         self.input.value = 'taylor'
480 |         assert_equal(self.input._value, 2)
481 |         assert_equal(self.input.value, 'taylor')
482 | 
483 |     def test_value_label(self):
484 |         self.input.value = 'drums'
485 |         assert_equal(self.input._value, 2)
486 |         assert_equal(self.input.value, 'taylor')
487 | 
488 |     def test_serialize(self):
489 |         assert_equal(
490 |             self.input.serialize(),
491 |             {'members': 'mercury'}
492 |         )
493 | 
494 | 
495 | class TestRadioBlank(unittest.TestCase):
496 | 
497 |     def setUp(self):
498 |         self.html = '''
499 |             <input type="radio" name="member" value="mercury" />vocals<br />
500 |             <input type="radio" name="member" value="may" />guitar<br />
501 |             <input type="radio" name="member" value="taylor" />drums<br />
502 |             <input type="radio" name="member" value="deacon" />bass<br />
503 |         '''
504 |         self.input = fields.Radio(BeautifulSoup(self.html).find_all('input'))
505 | 
506 |     def test_initial(self):
507 |         assert_equal(self.input.value, '')
508 | 
509 |     def test_serialize(self):
510 |         assert_equal(
511 |             self.input.serialize(),
512 |             {'member': ''}
513 |         )
514 | 
515 | 
516 | class TestCheckbox(unittest.TestCase):
517 | 
518 |     def setUp(self):
519 |         self.html = '''
520 |             <input type="checkbox" name="member" value="mercury" checked />vocals<br />
521 |             <input type="checkbox" name="member" value="may" />guitar<br />
522 |             <input type="checkbox" name="member" value="taylor" />drums<br />
523 |             <input type="checkbox" name="member" value="deacon" checked />bass<br />
524 |         '''
525 |         self.input = fields.Checkbox(BeautifulSoup(self.html).find_all('input'))
526 | 
527 |     def test_name(self):
528 |         assert_equal(self.input.name, 'member')
529 | 
530 |     def test_options(self):
531 |         assert_equal(
532 |             self.input.options,
533 |             ['mercury', 'may', 'taylor', 'deacon']
534 |         )
535 | 
536 |     def test_initial(self):
537 |         assert_equal(
538 |             self.input.value,
539 |             ['mercury', 'deacon']
540 |         )
541 | 
542 |     def test_value(self):
543 |         self.input.value = 'taylor'
544 |         assert_equal(self.input._value, [2])
545 |         assert_equal(self.input.value, ['taylor'])
546 | 
547 |     def test_values(self):
548 |         self.input.value = ['taylor', 'deacon']
549 |         assert_equal(self.input._value, [2, 3])
550 |         assert_equal(self.input.value, ['taylor', 'deacon'])
551 | 
552 |     def test_value_label(self):
553 |         self.input.value = 'drums'
554 |         assert_equal(self.input._value, [2])
555 |         assert_equal(self.input.value, ['taylor'])
556 | 
557 |     def test_serialize(self):
558 |         assert_equal(
559 |             self.input.serialize(),
560 |             {'member': ['mercury', 'deacon']}
561 |         )
562 | 
563 | 
564 | class TestCheckboxBlank(unittest.TestCase):
565 | 
566 |     def setUp(self):
567 |         self.html = '''
568 |             <input type="checkbox" name="member" value="mercury" />vocals<br />
569 |             <input type="checkbox" name="member" value="may" />guitar<br />
570 |             <input type="checkbox" name="member" value="taylor" />drums<br />
571 |             <input type="checkbox" name="member" value="deacon" />bass<br />
572 |         '''
573 |         self.input = fields.Checkbox(BeautifulSoup(self.html).find_all('input'))
574 | 
575 |     def test_initial(self):
576 |         assert_equal(
577 |             self.input.value, []
578 |         )
579 | 
580 |     def test_serialize(self):
581 |         assert_equal(
582 |             self.input.serialize(),
583 |             {'member': []}
584 |         )
585 | 
586 | 
587 | class TestFileInput(unittest.TestCase):
588 | 
589 |     def setUp(self):
590 |         self.html = '<input name="song" type="file" />'
591 |         self.input = fields.FileInput(BeautifulSoup(self.html).find('input'))
592 | 
593 |     def test_name(self):
594 |         assert_equal(self.input.name, 'song')
595 | 
596 |     def test_value_file(self):
597 |         file = tempfile.TemporaryFile('r')
598 |         self.input.value = file
599 |         assert_equal(self.input._value, file)
600 |         assert_equal(self.input.value, file)
601 | 
602 |     @mock.patch('{0}.open'.format(builtin_name))
603 |     def test_value_name(self, mock_open):
604 |         file = tempfile.TemporaryFile('r')
605 |         mock_open.return_value = file
606 |         self.input.value = 'temp'
607 |         assert_equal(self.input._value, file)
608 |         assert_equal(self.input.value, file)
609 | 
610 |     def test_serialize(self):
611 |         file = tempfile.TemporaryFile('r')
612 |         self.input.value = file
613 |         assert_equal(
614 |             self.input.serialize(),
615 |             {'song': file}
616 |         )
617 | 
618 | 
619 | class TestDisabledValues(unittest.TestCase):
620 | 
621 |     def test_input_enabled(self):
622 |         html = '<input name="brian" value="may" />'
623 |         input = fields.Input(BeautifulSoup(html).find('input'))
624 |         assert_false(input.disabled)
625 | 
626 |     def test_input_disabled(self):
627 |         html = '<input name="brian" value="may" disabled />'
628 |         input = fields.Input(BeautifulSoup(html).find('input'))
629 |         assert_true(input.disabled)
630 | 
631 |     def test_checkbox_enabled(self):
632 |         html = '''
633 |             <input type="checkbox" name="member" value="mercury" checked />vocals<br />
634 |             <input type="checkbox" name="member" value="may" />guitar<br />
635 |             <input type="checkbox" name="member" value="taylor" disabled />drums<br />
636 |             <input type="checkbox" name="member" value="deacon" checked />bass<br />
637 |         '''
638 |         input = fields.Checkbox(BeautifulSoup(html).find_all('input'))
639 |         assert_false(input.disabled)
640 | 
641 |     def test_checkbox_disabled(self):
642 |         html = '''
643 |             <input type="checkbox" name="member" value="mercury" checked disabled />vocals<br />
644 |             <input type="checkbox" name="member" value="may" disabled />guitar<br />
645 |             <input type="checkbox" name="member" value="taylor" disabled />drums<br />
646 |             <input type="checkbox" name="member" value="deacon" checked disabled />bass<br />
647 |         '''
648 |         input = fields.Checkbox(BeautifulSoup(html).find_all('input'))
649 |         assert_true(input.disabled)
650 | 
651 |     def test_select_enabled(self):
652 |         html = '''
653 |             <select name="john">
654 |                 <option value="tie">your mother down</option>
655 |                 <option value="you're" selected>my best friend</option>
656 |                 <option value="the">millionaire waltz</option>
657 |             </select>
658 |         '''
659 |         input = fields.Select(BeautifulSoup(html).find('select'))
660 |         assert_false(input.disabled)
661 | 
662 |     def test_select_disabled_root(self):
663 |         html = '''
664 |             <select name="john" disabled>
665 |                 <option value="tie">your mother down</option>
666 |                 <option value="you're" selected>my best friend</option>
667 |                 <option value="the">millionaire waltz</option>
668 |             </select>
669 |         '''
670 |         input = fields.Select(BeautifulSoup(html).find('select'))
671 |         assert_true(input.disabled)
672 | 
673 |     def test_select_disabled_options(self):
674 |         html = '''
675 |             <select name="john">
676 |                 <option value="tie" disabled>your mother down</option>
677 |                 <option value="you're" selected disabled>my best friend</option>
678 |                 <option value="the" disabled>millionaire waltz</option>
679 |             </select>
680 |         '''
681 |         input = fields.Select(BeautifulSoup(html).find('select'))
682 |         assert_true(input.disabled)
683 | 
684 | 
685 | class TestDefaultValues(unittest.TestCase):
686 | 
687 |     def test_checkbox_default(self):
688 |         inputs = BeautifulSoup('''
689 |             <input type="checkbox" name="checkbox" />
690 |         ''').find_all('input')
691 |         checkbox = fields.Checkbox(inputs)
692 |         assert_equal(checkbox.options, ['on'])
693 | 
694 |     def test_radio_default(self):
695 |         inputs = BeautifulSoup('''
696 |             <input type="radio" name="checkbox" />
697 |         ''').find_all('input')
698 |         radio = fields.Radio(inputs)
699 |         assert_equal(radio.options, ['on'])
700 | 
701 |     def test_select_default(self):
702 |         parsed = BeautifulSoup('''
703 |             <select name="select">
704 |                 <option>opt</option>
705 |             </select>
706 |         ''', 'html.parser')
707 |         select = fields.Select(parsed)
708 |         assert_equal(select.options, ['opt'])
709 | 
710 |     def test_multi_select_default(self):
711 |         parsed = BeautifulSoup('''
712 |             <select name="select" multiple>
713 |                 <option>opt</option>
714 |             </select>
715 |         ''', 'html.parser')
716 |         select = fields.Select(parsed)
717 |         assert_equal(select.options, ['opt'])
718 | 


--------------------------------------------------------------------------------
/tests/test_helpers.py:
--------------------------------------------------------------------------------
 1 | import unittest
 2 | from nose.tools import *
 3 | 
 4 | from bs4 import BeautifulSoup
 5 | 
 6 | from robobrowser import helpers
 7 | 
 8 | 
 9 | class TestEnsureSoup(unittest.TestCase):
10 |     
11 |     def setUp(self):
12 |         self.html = '<form></form>'
13 |         self.tag = BeautifulSoup(self.html).find()
14 |         self.htmls = [
15 |             '<form></form>',
16 |             '<input />',
17 |         ]
18 |         self.tags = [
19 |             BeautifulSoup(html).find()
20 |             for html in self.htmls
21 |         ]
22 | 
23 |     def test_handle_string(self):
24 |         ensured = helpers.ensure_soup(self.html)
25 |         assert_equal(ensured, self.tag)
26 |     
27 |     def test_handle_soup(self):
28 |         ensured = helpers.ensure_soup(BeautifulSoup(self.html))
29 |         assert_equal(ensured, self.tag)
30 | 
31 |     def test_handle_tag(self):
32 |         ensured = helpers.ensure_soup(BeautifulSoup(self.html).find())
33 |         assert_equal(ensured, self.tag)
34 | 
35 |     def test_handle_string_list(self):
36 |         ensured = helpers.ensure_soup(self.htmls)
37 |         assert_equal(ensured, self.tags)
38 | 
39 |     def test_handle_soup_list(self):
40 |         ensured = helpers.ensure_soup([
41 |             BeautifulSoup(html)
42 |             for html in self.htmls
43 |         ])
44 |         assert_equal(ensured, self.tags)
45 | 
46 |     def test_handle_tag_list(self):
47 |         ensured = helpers.ensure_soup([
48 |             BeautifulSoup(html).find()
49 |             for html in self.htmls
50 |         ])
51 |         assert_equal(ensured, self.tags)
52 | 
53 | 


--------------------------------------------------------------------------------
/tests/utils.py:
--------------------------------------------------------------------------------
 1 | import functools
 2 | 
 3 | from robobrowser import responses
 4 | from robobrowser.compat import iteritems
 5 | 
 6 | 
 7 | class ArgCatcher(object):
 8 |     """Simple class for memorizing positional and keyword arguments. Used to
 9 |     capture responses for mock_responses.
10 | 
11 |     """
12 |     def __init__(self, *args, **kwargs):
13 |         self.args = args
14 |         self.kwargs = kwargs
15 | 
16 | 
17 | class KwargSetter(object):
18 |     """Simple class for memorizing keyword arguments as instance attributes.
19 |     Used to mock requests and responses for testing.
20 | 
21 |     """
22 |     def __init__(self, **kwargs):
23 |         for key, value in iteritems(kwargs):
24 |             setattr(self, key, value)
25 | 
26 | 
27 | def mock_responses(resps):
28 |     """Decorator factory to make tests more DRY. Bundles responses.activate
29 |     with a collection of response rules.
30 | 
31 |     :param list resps: List of response-formatted ArgCatcher arguments.
32 | 
33 |     """
34 |     def wrapper(func):
35 |         @responses.activate
36 |         @functools.wraps(func)
37 |         def wrapped(*args, **kwargs):
38 |             for resp in resps:
39 |                 responses.add(*resp.args, **resp.kwargs)
40 |             return func(*args, **kwargs)
41 |         return wrapped
42 |     return wrapper
43 | 


--------------------------------------------------------------------------------
/tox.ini:
--------------------------------------------------------------------------------
 1 | [tox]
 2 | envlist = py26,py27,py33,py34,pypy
 3 | 
 4 | [testenv]
 5 | deps = 
 6 |     -rdev-requirements.txt
 7 | commands = 
 8 |     {envpython} setup.py test
 9 | 
10 | 


--------------------------------------------------------------------------------