woob.browser.url

class woob.browser.url.BrowserParamURL(*args)

Bases: woob.browser.url.URL

A URL that automatically fills some params from browser attributes.

URL patterns having groups named “browser_*” will pick the relevant attribute from the browser. For example:

foo = BrowserParamURL(r’/foo?bar=(?P<browser_token>w+)’)

The browser is expected to have a .token attribute and it will be passed automatically when just calling foo.go(), it’s equivalent to foo.go(browser_token=browser.token).

Warning: all browser_* params will be passed, having multiple patterns with different groups in a BrowserParamURL is risky.

build(**kwargs)

Build an url with the given arguments from URL’s regexps.

Parameters

param – Query string parameters

Return type

str

Raises

UrlNotResolvable if unable to resolve a correct url with the given arguments.

class woob.browser.url.URL(*args)

Bases: object

A description of an URL on the PagesBrowser website.

It takes one or several regexps to match urls, and an optional Page class which is instancied by PagesBrowser.open if the page matches a regex.

build(**kwargs)

Build an url with the given arguments from URL’s regexps.

Parameters

param – Query string parameters

Return type

str

Raises

UrlNotResolvable if unable to resolve a correct url with the given arguments.

go(params=None, data=None, json=None, method=None, headers=None, **kwargs)

Request to go on this url.

Arguments are optional parameters for url.

>>> url = URL('http://exawple.org/(?P<pagename>).html')
>>> url.stay_or_go(pagename='index')
handle(response)

Handle a HTTP response to get an instance of the klass if it matches.

id2url(func)

Helper decorator to get an URL if the given first parameter is an ID.

is_here(**kwargs)

Returns True if the current page of browser matches this URL. If arguments are provided, and only then, they are checked against the arguments that were used to build the current page URL.

match(url, base=None)

Check if the given url match this object.

open(params=None, data=None, json=None, method=None, headers=None, is_async=False, callback=<function URL.<lambda>>, **kwargs)

Request to open on this url.

Arguments are optional parameters for url.

Parameters

data – POST data

>>> url = URL('http://exawple.org/(?P<pagename>).html')
>>> url.open(pagename='index')
stay_or_go(headers=None, **kwargs)

Request to go on this url only if we aren’t already here.

Arguments are optional parameters for url.

>>> url = URL('http://exawple.org/(?P<pagename>).html')
>>> url.stay_or_go(pagename='index')
exception woob.browser.url.UrlNotResolvable

Bases: Exception

Raised when trying to locate on an URL instance which url pattern is not resolvable as a real url.

woob.browser.url.normalize_url(url)

Normalize URL by lower-casing the domain and other fixes.

Lower-cases the domain, removes the default port and a trailing dot.

>>> normalize_url('http://EXAMPLE:80')
'http://example'
woob.browser.url.test_normalize_url()