Package mobi :: Package mtld :: Package da :: Package device :: Module config :: Class Config

Class Config

object --+
         |
        Config

DeviceApi Configurations. To change the default configs of the DeviceAtlas DeviceApi create an instance of this class, set your preferred configs and pass the instance to the constructor of a DeviceApi.

Note that you may change the configs even after the Config instance has been passed to the DeviceApi.

Author: DeviceAtlas Limited

Instance Methods

get_cookie_name(self)
Get the cookie name that the client side properties would be set to.

set_cookie_name(self, value)
To change the cookie name that the client side properties would be set to.

get_include_ua_props(self)
Get if the User-Agent dynamic properties are being included in the property set or not.

set_include_ua_props(self, value)
To disable or enable get_properties(HEADERS) including User-Agent dynamic properties.

get_include_lang_props(self)
Get if the language/locale properties should be included in the property set or not.

set_include_lang_props(self, value)
To disable or enable get_properties(HEADERS) including language and locale properties.

get_include_match_info(self)
To get if get_properties(HEADERS) include the matched and unmatched parts of the User-Agent to the property set.

set_include_match_info(self, value)
To disable or enable get_properties(HEADERS) including the matched and unmatched parts of the User-Agent to the property set.

get_return_none_when_no_properties(self)
Get if the value returned by get_properties(HEADERS) should be None when there are no properties found or an instance of Properties that has no Property inside it should be returned.

set_return_none_when_no_properties(self, value)
Set if the value returned by get_properties(HEADERS) should be None when there are no properties found or whether an empty Properties object should be returned instead.

get_max_cache_entries(self)
Get the max number of results to be cached.

set_max_cache_entries(self, value)
Set the max number of results to be cached.

bool

is_cache_enabled(self)
Abstraction to make it easier to check if the cache is enabled on the DeviceApi instance.

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __init__, __new__, __reduce__, __reduce_ex__, __repr__, __setattr__, __sizeof__, __str__, __subclasshook__

Class Variables
	DEFAULT_COOKIE_NAME = `u'DAPROPS'`
	DEFAULT_INCLUDE_UA_PROPS = `True`
	DEFAULT_INCLUDE_LANG_PROPS = `True`
	DEFAULT_INCLUDE_MATCH_INFO = `False`
	DEFAULT_RETURN_NONE_WHEN_NO_PROPERTIES = `False`
	DEFAULT_MAX_CACHE_ENTRIES = `4096`

Properties
	cookie_name Get the cookie name that the client side properties would be set to.
	include_ua_props Get if the User-Agent dynamic properties are being included in the property set or not.
	include_lang_props Get if the language/locale properties should be included in the property set or not.
	include_match_info To get if get_properties(HEADERS) include the matched and unmatched parts of the User-Agent to the property set.
	return_none_when_no_properties Get if the value returned by get_properties(HEADERS) should be None when there are no properties found or an instance of Properties that has no Property inside it should be returned.
	max_cache_entries Get the max number of results to be cached.
Inherited from `object`: `__class__`

Method Details

get_cookie_name(self)

Get the cookie name that the client side properties would be set to. When using get_properties(HEADERS), the detection would automatically use the contents of this cookie if it exists. If you want the client side properties to be used add the DeviceAtlas Client-side component (JS lib) to your web-site pages.

When the User-Agent or HTTP headers are set manually to get_properties() the client side properties (probably the value set to the cookie) can be manually passed to this methods as the second argument, note that this config is only used for get_properties(HEADERS).

set_cookie_name(self, value)

To change the cookie name that the client side properties would be set to. When using get_properties(HEADERS), the detection would automatically use the contents of this cookie if it exists. If you want the client side properties to be used add the DeviceAtlas Client-side component (JS lib) to your web-site pages.

When the User-Agent or HTTP headers are set manually to get_properties() the client side properties (probably the value set to the cookie) can be manually passed to this method as the second argument, note that this config is only used for get_properties(HEADERS). If you set the cookie-name to None then the client side properties cookie will be ignored.

Parameters:

value - The cookie name which the client side properties are set to. Set to None to turn off using the client side properties.

set_include_ua_props(self, value)

To disable or enable get_properties(HEADERS) including User-Agent dynamic properties. Some properties cannot be known before runtime and can change from User-Agent to User-Agent. The most common of these are the OS Version and the Browser Version. The DeviceApi is able to dynamically detect these changing properties with a small overhead. If you do not use these properties you can set this config to False to make the detection marginally faster.

Parameters:

value - True, to include the User-Agent dynamic properties; False, otherwise.

set_include_lang_props(self, value)

To disable or enable get_properties(HEADERS) including language and locale properties. To check the Accept-Language header and include properties to the property set for getting the client's language and locale preferences set to True. If you do not use these properties you can set this config to False to make the detection marginally faster.

Parameters:

value - True, to include language and locale properties; False, otherwise.

set_include_match_info(self, value)

To disable or enable get_properties(HEADERS) including the matched and unmatched parts of the User-Agent to the property set.

Parameters:

value - True, to include match info properties; False, otherwise.

set_return_none_when_no_properties(self, value)

Set if the value returned by get_properties(HEADERS) should be None when there are no properties found or whether an empty Properties object should be returned instead.

Parameters:

value - True, to return None instead of empty Properties object; False, otherwise.

set_max_cache_entries(self, value)

Set the max number of results to be cached. Depending on the frequency and distance factor of your User-Agents or headers passed to the API for detection, increasing the result cache may increase performance by preventing repeated lookups. For a large set of inputs (i.e. an almost unique set of user-agents) set to lower numbers or zero to disable.

Parameters:

value - An integer greater than equal to zero.

Raises:

e - ValueError if value is not an integer greater than or equal to zero.

is_cache_enabled(self)

Abstraction to make it easier to check if the cache is enabled on the DeviceApi instance.

Returns: bool: True, if the max number of results to be cached is greater than zero; False, otherwise.

Property Details

cookie_name

Get Method:: get_cookie_name(self) - Get the cookie name that the client side properties would be set to.
Set Method:: set_cookie_name(self, value) - To change the cookie name that the client side properties would be set to.

include_ua_props

Get if the User-Agent dynamic properties are being included in the property set or not.

Get Method:: get_include_ua_props(self) - Get if the User-Agent dynamic properties are being included in the property set or not.
Set Method:: set_include_ua_props(self, value) - To disable or enable get_properties(HEADERS) including User-Agent dynamic properties.

include_lang_props

Get if the language/locale properties should be included in the property set or not.

Get Method:: get_include_lang_props(self) - Get if the language/locale properties should be included in the property set or not.
Set Method:: set_include_lang_props(self, value) - To disable or enable get_properties(HEADERS) including language and locale properties.

include_match_info

To get if get_properties(HEADERS) include the matched and unmatched parts of the User-Agent to the property set.

Get Method:: get_include_match_info(self) - To get if get_properties(HEADERS) include the matched and unmatched parts of the User-Agent to the property set.
Set Method:: set_include_match_info(self, value) - To disable or enable get_properties(HEADERS) including the matched and unmatched parts of the User-Agent to the property set.

return_none_when_no_properties

Get if the value returned by get_properties(HEADERS) should be None when there are no properties found or an instance of Properties that has no Property inside it should be returned.

Get Method:: get_return_none_when_no_properties(self) - Get if the value returned by get_properties(HEADERS) should be None when there are no properties found or an instance of Properties that has no Property inside it should be returned.
Set Method:: set_return_none_when_no_properties(self, value) - Set if the value returned by get_properties(HEADERS) should be None when there are no properties found or whether an empty Properties object should be returned instead.

max_cache_entries

Get the max number of results to be cached.

Get Method:: get_max_cache_entries(self) - Get the max number of results to be cached.
Set Method:: set_max_cache_entries(self, value) - Set the max number of results to be cached.