API

Core Class

class cabu.core.Cabu(import_name='cabu', db=None, *args, **kwargs)

load_config(settings='cabu.default_settings')

Get the given settings module to create a config dict in the class.

All variables defined in upper case in the settings module are imported in the directory and overrided by the corresponding environment variables.

Parameters:settings (Optional[str]) – A module path where stands the settings.

Drivers Class

cabu.drivers.load_chrome(config)

Start Chrome webdriver with the given configuration.

Parameters:config (dict) – The configuration loaded previously in Cabu. Returns:webdriver – An instance of Chrome webdriver. Return type:selenium.webdriver

cabu.drivers.load_driver(config, vdisplay=None)

Initialize a weddriver selected in config with given config.

Parameters:config (dict) – The configuration loaded previously in Cabu. Returns:webdriver – An instance of selenium webdriver or None. Return type:selenium.webdriver

cabu.drivers.load_firefox(config)

Start Firefox webdriver with the given configuration.

Parameters:config (dict) – The configuration loaded previously in Cabu. Returns:webdriver – An instance of Firefox webdriver. Return type:selenium.webdriver

cabu.drivers.load_phantomjs(config)

Start PhantomJS webdriver with the given configuration.

Parameters:config (dict) – The configuration loaded previously in Cabu. Returns:webdriver – An instance of phantomJS webdriver. Return type:selenium.webdriver

cabu.drivers.load_vdisplay(config)

Initialize a vdisplay (Xvfb subprocess instance).

Parameters:config (dict) – The configuration loaded previously in Cabu. Returns:An instance of Xvfb wrapper. Return type:vdisplay

cabu.drivers.unload_driver(driver)

Shutdown given webdriver instance.

Parameters:driver (selenium.webdriver) – The running webdriver.

cabu.drivers.unload_vdisplay(vdisplay)

Shutdown given Xvfb instance.

Parameters:vdisplay (XvfbWrapper) – The running virtual X server.

Auth Module

cabu.auth.authenticate()

Response helper for un-authorized attempts to access to the app.

Returns:response – A Flask Response object with a custom message and a 401 status. Return type:object

cabu.auth.check_auth(username, password)

Determines if the given params are similar to the ones stored on config.

This small function compares the given username and password to the ones and returning a boolean accordingly.

Parameters:

• username (str) – The username used for basic_auth.
• password (str) – The password used for basic_auth.

Returns:

auth – True if authorized, False if not.

Return type:

bool

cabu.auth.requires_admin(f)

Decorator to define endpoints that requires Basic Auth.

Parameters:f (func) – An route function. Returns:response – 401 if unauthorized. f (func): The route to call. Return type:object

Bucket Class

class cabu.utils.bucket.Bucket(bucket_name, access_key, secret_key)

Convenient class to export datas to an Amazon S3 bucket.

Parameters:

• bucket_name (str) – The name of the bucket to export.
• access_key (str) – The access_key of the owner of the bucket to export.
• secret_key (str) – The secret_key of the owner of the bucket to export.

delete(filename)

Delete the file on the distant S3 bucket with the given filename.

Parameters:filename (str) – A string representing the name of the file to delete. Returns:response – The object returned by requests. Return type:object

get(filename)

Get the file on the distant S3 bucket with the given filename.

Parameters:filename (str) – A string representing the name of the file to get. Returns:response – The object returned by requests. Return type:object

put(filename, data)

Put given datas in the file with the given filename in the S3 bucket.

Parameters:

• filename (str) – A string representing the name of the file to store.
• datas (str|object) – The datas to export.

Returns:

response – The object returned by requests.

Return type:

object

Cookies Class

class cabu.utils.cookies.CookieStorage(db)

Interface between Cookies and Database.

Parameters:db (Database) – The Database class instance to wrap.

clean()

Delete all the cookies stored in the database.

Returns:raw_result – The result of the cleaning. Return type:str

delete(key)

Delete the value of the given cookie key.

Parameters:key (str) – The name of the cookie key to delete. Returns:raw_result – The result of the attempt to delete the cookie. Return type:str

get(key)

Get the value of the given cookie key.

Parameters:key (str) – The name of the cookie key to retrieve. Returns:value – The value of the key or None if undefined. Return type:str

set(key, value)

Set the value of the defined cookie key.

Parameters:

• key (str) – The name of the cookie key to set.
• value (str) – The value associated to the cookie key to set.

Returns:

raw_result – The result of the attempt to store the cookie.

Return type:

str

Link Extractor Module

cabu.utils.link_extractor.extract_links(response_content, unique=False, blacklist_domains=[], whitelist_domains=[], regex=None, zen_path=None, blacklist_extensions=[], whitelist_extensions=[])

Extract links from a response content.

Parameters:

• response_content (str) – The HTML page received in a Response Object.
• unique (bool) – A parameter defining if the list can contain duplicates. Defaults to False.
• blacklist_domains (list) – List of domains to exclude from the result.
• whitelist_domains (list) – List of domains to include from the result.
• regex (list) – A regular expression filter on the link. Defaults to None.
• zen_path (list) – A selector to restrict the XPath to parse with bs4.

Returns:

links – A list of extracted and filtered links.

Return type:

list

cabu.utils.link_extractor.filter_links(links, regex, include=True)

Filter a list of links based on the given params.

Parameters:

• regex (str) – A regular expression filter to apply on every links.
• include (bool) – Determines if the regex exclude or include matchs.

Returns:

links_filtered – The list filtered according to the arguments.

Return type:

list