\r\n

51Degrees Device Detection Python  4.4

Device Detection services for 51Degrees Pipeline

Search

Documentation

onpremise/gettingstarted_web/app.py

This example is available in full on GitHub.

This example requires a local data file. The free 'Lite' data file can be acquired by pulling the git submodules under this repository (run `git submodule update --recursive`) or from the device-detection-data GitHub repository.

The Lite data file is only used for illustration, and has limited accuracy and capabilities. Find out about the more capable data files that are available on our pricing page

Required PyPi Dependencies:

• fiftyone_devicedetection
• flask

Overview

The DeviceDetectionPipelineBuilder class is used to create a Pipeline instance from the configuration that is supplied. The fiftyone_pipeline_core.web module contains helpers which deal with automatically populating evidence from a web request.

 flowdata.evidence.add_from_dict(webevidence(request))

 # *********************************************************************

 # This Original Work is copyright of 51 Degrees Mobile Experts Limited.

 # Copyright 2023 51 Degrees Mobile Experts Limited, Davidson House,

 # Forbury Square, Reading, Berkshire, United Kingdom RG1 3EU.

 #

 # This Original Work is licensed under the European Union Public Licence

 # (EUPL) v.1.2 and is subject to its terms as set out below.

 #

 # If a copy of the EUPL was not distributed with this file, You can obtain

 # one at https://opensource.org/licenses/EUPL-1.2.

 #

 # The 'Compatible Licences' set out in the Appendix to the EUPL (as may be

 # amended by the European Commission) shall be deemed incompatible for

 # the purposes of the Work and the provisions of the compatibility

 # clause in Article 5 of the EUPL shall not apply.

 #

 # If using the Work as, or as part of, a network application, by

 # including the attribution notice(s) required under Article 5 of the EUPL

 # in the end user terms of the application under an appropriate heading,

 # such notice(s) shall fulfill the requirements of that article.

 # *********************************************************************

 

 

 

 

 # The module can also handling setting response headers (e.g. Accept-CH for User-Agent

 # Client Hints) and serving requests for client-side JavaScript and JSON resources.

 # ```{py}

 # set_response_header(flowdata, response)

 # ```

 #

 # The results of detection can be accessed by through the flowdata object once

 # processed. This can then be used to interrogate the data.

 # ```{py}

 # flowdata.process()

 # device = flowdata.device

 # hardware_vendor = device.hardwarevendor

 # ```

 #

 # Results can also be accessed in client-side code by using the `fod` object. See the

 # [JavaScriptBuilderElementBuilder](https://51degrees.com/pipeline-python/4.3/classpipeline-python_1_1fiftyone__pipeline__core_1_1fiftyone__pipeline__core_1_1javascriptbuilde778a9036818b19ab55d981a40be4a4d7.html)

 # for details on available settings such as changing the `fod` name.

 # ```{js}

 # window.onload = function () {

 # fod.complete(function(data) {

 # var hardwareName = data.device.hardwarename;

 # alert(hardwareName.join(", "));

 # }

 # }

 # ```

 #

 # ## View

 # @include templates/index.html

 #

 # ## App

 

 import os

 from pathlib import Path

 import sys

 from fiftyone_devicedetection_examples.example_utils import ExampleUtils

 from flask.helpers import make_response

 from flask import Flask, request, render_template

 from fiftyone_pipeline_core.logger import Logger

 from fiftyone_pipeline_core.pipelinebuilder import PipelineBuilder

 from fiftyone_pipeline_core.web import webevidence, set_response_header

 import json

 

 class GettingStartedWeb():

  app = Flask(__name__)

 

  def build(self, config, logger):

  # Here we add some callback settings for the page to make a request with extra evidence from the client side, in this case the Flask /json route we will make below

 

  GettingStartedWeb.pipeline = PipelineBuilder().add_logger(logger).build_from_configuration(config)

  return self

 

  def run(self):

 

  GettingStartedWeb.app.run()

 

  # First we make a JSON route that will be called from the client side and will return

  # a JSON encoded property database using any additional evidence provided by the client

 

  @staticmethod

  @app.route('/json', methods=['POST'])

  def jsonroute():

 

  # Create the flowdata object for the JSON route

  flowdata = GettingStartedWeb.pipeline.create_flowdata()

 

  # Add any information from the request (headers, cookies and additional

  # client side provided information)

 

  flowdata.evidence.add_from_dict(webevidence(request))

 

  # Process the flowdata

 

  flowdata.process()

 

  # Return the JSON from the JSONBundler engine

 

  return json.dumps(flowdata.jsonbundler.json)

 

  # In the main route we dynamically update the screen's device property display

  # using the above JSON route

 

  @staticmethod

  @app.route('/')

  def server():

 

  # Create the flowdata object for the JSON route

  flowdata = GettingStartedWeb.pipeline.create_flowdata()

 

  # Add any information from the request (headers, cookies and additional

  # client side provided information)

 

  flowdata.evidence.add_from_dict(webevidence(request))

 

  # Process the flowdata

 

  flowdata.process()

 

  response = make_response()

 

  # Some browsers require that extra HTTP headers are explicitly

  # requested. So set whatever headers are required by the browser in

  # order to return the evidence needed by the pipeline.

  # More info on this can be found at

  # https://51degrees.com/blog/user-agent-client-hints

 

  set_response_header(flowdata, response)

 

  # Generate the HTML

  response.set_data(render_template(

  'index.html',

  data=flowdata,

  utils=ExampleUtils,

  response=response))

 

  return response

 

 

  # Typically, something like this will not be necessary.

  # The device detection API will accept an absolute or relative path for the data file.

  # However, if a relative path is specified, it will only look in the current working

  # directory.

  # In our examples, we have many different projects and we don't want to have a copy of

  # the data file for every single one.

  # In order to handle this, we dynamically search the project directories for the data

  # file location and then override the configured setting with the absolute path if

  # necessary.

  # In a real-world scenario, you can just put the data file in your working directory

  # or use an absolute path in the configuration file.

  @staticmethod

  def build_config():

 

  # Load the configuration file

  configFile = Path(__file__).resolve().parent.joinpath("config.json").read_text()

  config = json.loads(configFile)

 

  dataFile = ExampleUtils.get_data_file_from_config(config)

  foundDataFile = False

  if not dataFile:

  raise Exception("A data file must be specified in the config.json file.")

  # The data file location provided in the configuration may be using an absolute or

  # relative path. If it is relative then search for a matching file using the

  # ExampleUtils.find_file function.

  elif os.path.isabs(dataFile) == False:

  newPath = ExampleUtils.find_file(dataFile)

  if newPath:

  # Add an override for the absolute path to the data file.

  ExampleUtils.set_data_file_in_config(config, newPath)

  foundDataFile = True

  else:

  foundDataFile = os.path.exists(dataFile)

 

  if foundDataFile == False:

  raise Exception("Failed to find a device detection data file matching " +

  f"'{dataFile}'. If using the lite file, then make sure the " +

  "device-detection-data submodule has been updated by running " +

  "`git submodule update --recursive`. Otherwise, ensure that the filename " +

  "is correct in config.json.")

 

  return config

 

 def main(argv):

  # Configure a logger to output to the console.

  logger = Logger(min_level="info")

 

  config = GettingStartedWeb.build_config()

 

  GettingStartedWeb().build(config, logger).run()

 

 if __name__ == "__main__":

  main(sys.argv[1:])

Generated by doxygen 1.8.15