• About Us
  • Blog
  • Basket
  • Account
  • Sign In
  •  

Python API

What's Covered

This tutorial illustrates the basic use of the 51Degrees API. It will show you how to create a provider, how to create a dataset and how to obtain a value for the IsMobile property.

Code and Explanation

Getting started example of using 51Degrees trie device detection. The example shows how to:

  1. Import settings from the 51Degrees settings file

    dataFile = settings.V3_WRAPPER_TRIE_DATABASE
    properties = settings.PROPERTIES
    

  2. Instantiate the 51Degrees trie device detection provider with these properties

    provider = fiftyone_degrees_mobile_detector_v3_trie_wrapper.Provider(
    	dataFile,
    	properties)
    

  3. Produce a match for a single HTTP User-Agent header

    match = provider.getMatch(userAgent)
    

  4. Extract the value of the IsMobile property

    match.getValues('IsMobile')
    

This example can be run in any directory, but assumes your settings file contains a valid dataFile location and has the IsMobile property selected. By comparing this to the gettingstarted.py example which uses the pattern method, you can see the differences are the module name, the data file, and it does not use a cache or pool, so these do not need to be set.

Full Source File
from FiftyOneDegrees import fiftyone_degrees_mobile_detector_v3_trie_wrapper
from fiftyone_degrees.mobile_detector.conf import settings
import sys

'''
Imports settings from the settings file. The Default settings file, and
details on how to change it can be output by running the command
<p><pre class="prettyprint lang-py">
51degrees-mobile-detector settings
</p></pre>
'''
dataFile = settings.V3_TRIE_WRAPPER_DATABASE
properties = settings.PROPERTIES
'''
Initialises the device detection provider with settings from the settings
file. By default this will use the included Lite data file For more info
see:
<a href="https://51degrees.com/compare-data-options">compare data options
</a>
'''
provider = fiftyone_degrees_mobile_detector_v3_trie_wrapper.Provider(
    dataFile,
    properties)

# User-Agent string of an iPhone mobile device.
mobileUserAgent = ("Mozilla/5.0 (iPhone; CPU iPhone OS 7_1 like Mac OS X) "
"AppleWebKit/537.51.2 (KHTML, like Gecko) 'Version/7.0 Mobile/11D167 "
"Safari/9537.53")

# User-Agent string of Firefox Web browser version 41 on desktop.
desktopUserAgent = ("Mozilla/5.0 (Windows NT 6.3; WOW64; rv:41.0) "
"Gecko/20100101 Firefox/41.0")

# User-Agent string of a MediaHub device.
mediaHubUserAgent = ("Mozilla/5.0 (Linux; Android 4.4.2; X7 Quad Core "
"Build/KOT49H) AppleWebKit/537.36 (KHTML, like Gecko) Version/4.0 "
"Chrome/30.0.0.0 Safari/537.36")

def main():
    sys.stdout.write('Starting Getting Started Trie Example.\n')

# Carries out a match with a mobile User-Agent.
    sys.stdout.write('\nMobile User-Agent: %s\n' % mobileUserAgent)
    match = provider.getMatch(mobileUserAgent)
    sys.stdout.write('   IsMobile: %s\n' % match.getValues('IsMobile'))

# Carries out a match with a desktop User-Agent.
    sys.stdout.write('\nDesktop User-Agent: %s\n' % desktopUserAgent)
    match = provider.getMatch(desktopUserAgent)
    sys.stdout.write('   IsMobile: %s\n' % match.getValues('IsMobile'))

# Carries out a match with a MediaHub User-Agent.
    sys.stdout.write('\nMedia Hub User-Agent: %s\n' % mediaHubUserAgent)
    match = provider.getMatch(mediaHubUserAgent)
    sys.stdout.write('   IsMobile: %s\n' % match.getValues('IsMobile'))

if __name__ == '__main__':
    main()

Full Source File

Summary

In this tutorial you have seen how to use the detector to retrieve the IsMobile property for a pre-defined User-Agent string. The example can easily be modified to retrieve the value of any other property. Premium and Enterprise data files provide considerably more properties such as IsCrawler, PriceBand, HardwareVendor and ScreenInchesWidth. For a full list of properties and the data file versions they exist in please see the Property Dictionary.