59 | Please activate JavaScript to enable the search 60 | functionality. 61 |
62 |64 | From here you can search these documents. Enter your search 65 | words into the box below and click "search". Note that the search 66 | function will automatically search for all of the words. Pages 67 | containing fewer words won't appear in the result list. 68 |
69 | 74 | 75 || 64 | b | ||
| 67 | | 68 | browsermobproxy | 69 | |
50 | __version__ = '0.5.0'
51 |
52 | from server import Server
53 | from client import Client
54 |
55 | __all__ = ['Server', 'Client', 'browsermobproxy']
56 | Initialises a Server object
61 || Args: | 66 | |
|---|---|
| Parameters: |
|
72 |
Gets a client class that allow to set all the proxy details that you 79 | may need to.
80 |This will start the browsermob proxy and then wait until it can 86 | interact with it
87 |This will stop the process running the proxy
93 |Gets the url that the proxy is running on. This is not the URL clients 99 | should connect to.
100 |' + _('Hide Search Matches') + '
') 181 | .appendTo($('#searchbox')); 182 | } 183 | }, 184 | 185 | /** 186 | * init the domain index toggle buttons 187 | */ 188 | initIndexTable : function() { 189 | var togglers = $('img.toggler').click(function() { 190 | var src = $(this).attr('src'); 191 | var idnum = $(this).attr('id').substr(7); 192 | $('tr.cg-' + idnum).toggle(); 193 | if (src.substr(-9) == 'minus.png') 194 | $(this).attr('src', src.substr(0, src.length-9) + 'plus.png'); 195 | else 196 | $(this).attr('src', src.substr(0, src.length-8) + 'minus.png'); 197 | }).css('display', ''); 198 | if (DOCUMENTATION_OPTIONS.COLLAPSE_INDEX) { 199 | togglers.click(); 200 | } 201 | }, 202 | 203 | /** 204 | * helper function to hide the search marks again 205 | */ 206 | hideSearchWords : function() { 207 | $('#searchbox .highlight-link').fadeOut(300); 208 | $('span.highlighted').removeClass('highlighted'); 209 | }, 210 | 211 | /** 212 | * make the url absolute 213 | */ 214 | makeURL : function(relativeURL) { 215 | return DOCUMENTATION_OPTIONS.URL_ROOT + '/' + relativeURL; 216 | }, 217 | 218 | /** 219 | * get the current relative url 220 | */ 221 | getCurrentURL : function() { 222 | var path = document.location.pathname; 223 | var parts = path.split(/\//); 224 | $.each(DOCUMENTATION_OPTIONS.URL_ROOT.split(/\//), function() { 225 | if (this == '..') 226 | parts.pop(); 227 | }); 228 | var url = parts.join('/'); 229 | return path.substring(url.lastIndexOf('/') + 1, path.length - 1); 230 | } 231 | }; 232 | 233 | // quick alias for translations 234 | _ = Documentation.gettext; 235 | 236 | $(document).ready(function() { 237 | Documentation.init(); 238 | }); 239 | -------------------------------------------------------------------------------- /docs/conf.py: -------------------------------------------------------------------------------- 1 | # -*- coding: utf-8 -*- 2 | # 3 | # BrowserMob Proxy documentation build configuration file, created by 4 | # sphinx-quickstart on Fri May 24 12:37:12 2013. 5 | # 6 | # This file is execfile()d with the current directory set to its containing dir. 7 | # 8 | # Note that not all possible configuration values are present in this 9 | # autogenerated file. 10 | # 11 | # All configuration values have a default; values that are commented out 12 | # serve to show the default. 13 | 14 | import sys, os 15 | 16 | # If extensions (or modules to document with autodoc) are in another directory, 17 | # add these directories to sys.path here. If the directory is relative to the 18 | # documentation root, use os.path.abspath to make it absolute, like shown here. 19 | sys.path.insert(0, os.path.abspath('../')) 20 | 21 | # -- General configuration ----------------------------------------------------- 22 | 23 | # If your documentation needs a minimal Sphinx version, state it here. 24 | #needs_sphinx = '1.0' 25 | 26 | # Add any Sphinx extension module names here, as strings. They can be extensions 27 | # coming with Sphinx (named 'sphinx.ext.*') or your custom ones. 28 | extensions = ['sphinx.ext.coverage', 'sphinx.ext.viewcode', 'sphinx.ext.autodoc'] 29 | autoclass_content = 'both' 30 | 31 | # Add any paths that contain templates here, relative to this directory. 32 | templates_path = ['_templates'] 33 | 34 | # The suffix of source filenames. 35 | source_suffix = '.rst' 36 | 37 | # The encoding of source files. 38 | #source_encoding = 'utf-8-sig' 39 | 40 | # The master toctree document. 41 | master_doc = 'index' 42 | 43 | # General information about the project. 44 | project = u'BrowserMob Proxy' 45 | copyright = u'2014, David Burns' 46 | 47 | # The version info for the project you're documenting, acts as replacement for 48 | # |version| and |release|, also used in various other places throughout the 49 | # built documents. 50 | # 51 | # The short X.Y version. 52 | version = '0.6.0' 53 | # The full version, including alpha/beta/rc tags. 54 | release = '0.6.0' 55 | 56 | # The language for content autogenerated by Sphinx. Refer to documentation 57 | # for a list of supported languages. 58 | #language = None 59 | 60 | # There are two options for replacing |today|: either, you set today to some 61 | # non-false value, then it is used: 62 | #today = '' 63 | # Else, today_fmt is used as the format for a strftime call. 64 | #today_fmt = '%B %d, %Y' 65 | 66 | # List of patterns, relative to source directory, that match files and 67 | # directories to ignore when looking for source files. 68 | exclude_patterns = ['_build'] 69 | 70 | # The reST default role (used for this markup: `text`) to use for all documents. 71 | #default_role = None 72 | 73 | # If true, '()' will be appended to :func: etc. cross-reference text. 74 | #add_function_parentheses = True 75 | 76 | # If true, the current module name will be prepended to all description 77 | # unit titles (such as .. function::). 78 | #add_module_names = True 79 | 80 | # If true, sectionauthor and moduleauthor directives will be shown in the 81 | # output. They are ignored by default. 82 | #show_authors = False 83 | 84 | # The name of the Pygments (syntax highlighting) style to use. 85 | pygments_style = 'sphinx' 86 | 87 | # A list of ignored prefixes for module index sorting. 88 | #modindex_common_prefix = [] 89 | 90 | 91 | # -- Options for HTML output --------------------------------------------------- 92 | 93 | # The theme to use for HTML and HTML Help pages. See the documentation for 94 | # a list of builtin themes. 95 | html_theme = 'default' 96 | 97 | # Theme options are theme-specific and customize the look and feel of a theme 98 | # further. For a list of options available for each theme, see the 99 | # documentation. 100 | #html_theme_options = {} 101 | 102 | # Add any paths that contain custom themes here, relative to this directory. 103 | #html_theme_path = [] 104 | 105 | # The name for this set of Sphinx documents. If None, it defaults to 106 | # "Python client for the BrowserMob Proxy 2.0 REST API.
54 |BrowserMob Proxy is available on PyPI, so you can install it with pip:
57 |$ pip install browsermob-proxy
58 | Or with easy_install:
61 |$ easy_install browsermob-proxy
62 | Or by cloning the repo from GitHub:
65 |$ git clone git://github.com/AutomatedTester/browsermob-proxy-py.git
66 | Then install it by running:
69 |$ python setup.py install
70 | Manually:
76 |from browsermobproxy import Server
77 | server = Server("path/to/browsermob-proxy")
78 | server.start()
79 | proxy = server.create_proxy()
80 |
81 | from selenium import webdriver
82 | profile = webdriver.FirefoxProfile()
83 | profile.set_proxy(proxy.selenium_proxy())
84 | driver = webdriver.Firefox(firefox_profile=profile)
85 |
86 |
87 | proxy.new_har("google")
88 | driver.get("http://www.google.co.uk")
89 | proxy.har # returns a HAR JSON blob
90 |
91 | server.stop()
92 | driver.quit()
93 | Contents:
96 |
|
73 |
|
87 |
|
93 |
|
107 |
|
117 |
|
127 |
|
133 |
|
143 |
|
153 |
|
159 |
|
177 |
|
187 |
|
201 |
|
211 |
|
221 |
|
231 |
|
245 |
|
251 |
Initialises a new Client object
65 || Parameters: | url – This is where the BrowserMob Proxy lives | 70 |
|---|
Adds an ‘proxy’ entry to a desired capabilities dictionary with the 77 | BrowserMob proxy information
78 || Parameters: | capabilities – The Desired capabilities object from Selenium WebDriver | 83 |
|---|
This add automatic basic authentication
92 || Parameters: |
|
102 |
|---|
Sets a list of URL patterns to blacklist
111 || Parameters: |
|
120 |
|---|
Clears the DNS cache associated with the proxy instance
129 |shuts down the proxy and closes the port
135 |Gets the HAR that has been recorded
141 |This sets the headers that will set by the proxy on all requests
147 || Parameters: | headers – this is a dictionary of the headers to be set | 152 |
|---|
Limit the bandwidth through the proxy.
161 || Parameters: | options – A dictionary with all the details you want to set. downstreamKbps - Sets the downstream kbps upstreamKbps - Sets the upstream kbps latency - Add the given latency to each HTTP request | 166 |
|---|
This sets a new HAR to be recorded
175 || Parameters: |
|
184 |
|---|
This sets a new page to be recorded
193 || Parameters: | ref – A reference for the new page. Defaults to None | 198 |
|---|
Remap the hosts for a specific URL
207 || Parameters: |
|
216 |
|---|
Executes the javascript against each request
225 || Parameters: | js – the javascript to execute | 230 |
|---|
Executes the javascript against each response
239 || Parameters: | js – the javascript to execute | 244 |
|---|
Retries. No idea what its used for, but its in the API...
253 || Parameters: | retry_count – the number of retries | 258 |
|---|
Rewrites the requested url.
267 || Parameters: |
|
276 |
|---|
Returns a Selenium WebDriver Proxy class with details of the HTTP Proxy
285 |Configure various timeouts in the proxy
291 || Parameters: | options – A dictionary with all the details you want to set. request - request timeout (in seconds) read - read timeout (in seconds) connection - connection timeout (in seconds) dns - dns lookup timeout (in seconds) | 296 |
|---|
Waits for the network to be quiet
305 || Parameters: |
|
314 |
|---|
Returns a Selenium WebDriver Proxy class with details of the HTTP Proxy
323 |Sets a list of URL patterns to whitelist
329 || Parameters: |
|
338 |
|---|