#!/usr/bin/env python ''' This Source Code Form is copyright of 51Degrees Mobile Experts Limited. Copyright 2017 51Degrees Mobile Experts Limited, 5 Charlotte Close, Caversham, Reading, Berkshire, United Kingdom RG4 7BY This Source Code Form is the subject of the following patents and patent applications, owned by 51Degrees Mobile Experts Limited of 5 Charlotte Close, Caversham, Reading, Berkshire, United Kingdom RG4 7BY: European Patent No. 2871816; European Patent Application No. 17184134.9; United States Patent Nos. 9,332,086 and 9,350,823; and United States Patent Application No. 15/686,066. This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0. If a copy of the MPL was not distributed with this file, You can obtain one at http://mozilla.org/MPL/2.0/. This Source Code Form is "Incompatible With Secondary Licenses", as defined by the Mozilla Public License, v. 2.0. ''' ''' Getting started example of using 51Degrees device detection. The example shows how to:
  1. Import settings from the 51Degrees settings file

    dataFile = settings.V3_WRAPPER_DATABASE
    properties = settings.PROPERTIES
    cacheSize = settings.CACHE_SIZE
    poolSize = settings.POOL_SIZE
    

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

    provider = fiftyone_degrees_mobile_detector_v3_wrapper.Provider(dataFile,
    	properties,
    	cacheSize,
    	poolSize)
    

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

    match = provider.getMatch(userAgent)
    

  4. Extract the value of the IsMobile property as boolean

    def isMobile(userAgent):
    	match = provider.getMatch(userAgent)
    	if (match.getValue('IsMobile') == 'True'):
    		return True
    
    

This example can be run in any directory, but assumes your settings file contains a valid dataFile location and has the IsMobile property selected.
''' # // Snippet Start from FiftyOneDegrees import fiftyone_degrees_mobile_detector_v3_wrapper from fiftyone_degrees.mobile_detector.conf import settings import sys dataFile = settings.V3_WRAPPER_DATABASE properties = settings.PROPERTIES cacheSize = settings.CACHE_SIZE poolSize = settings.POOL_SIZE provider = fiftyone_degrees_mobile_detector_v3_wrapper.Provider(dataFile, properties, cacheSize, poolSize) # 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") ''' isMobile function. Takes a User-Agent as an argument, carries out a match and returns a boolean value for the IsMobile property of the matched device. ''' def isMobile(userAgent): match = provider.getMatch(userAgent) if (match.getValue('IsMobile') == 'True'): return True def main(): sys.stdout.write('Mobile User-Agent: %s\n' % mobileUserAgent) # Determines whether the mobile User-Agent is a mobile device. if isMobile(mobileUserAgent): sys.stdout.write(' Mobile\n') else: sys.stdout.write(' Non-Mobile\n') # Determines whether the desktop User-Agent is a mobile device. sys.stdout.write('Desktop User-Agent: %s\n' % desktopUserAgent) if isMobile(desktopUserAgent): sys.stdout.write(' Mobile\n') else: sys.stdout.write(' Non-Mobile\n') # Determines whether the MediaHub User-Agent is a mobile device. sys.stdout.write('Media Hub User-Agent: %s\n' % mediaHubUserAgent) if isMobile(mediaHubUserAgent): sys.stdout.write(' Mobile\n') else: sys.stdout.write(' Non-Mobile\n') if __name__ == '__main__': main() # // Snippet End