跳转到主要内容

一个Django包,允许轻松识别访问者的浏览器、操作系统和设备信息(手机、平板电脑或具有触摸功能)。

项目描述

Django User Agents

Django包,允许轻松识别访问者的浏览器、操作系统和设备信息,包括访问者是否使用手机、平板电脑或触摸设备。底层使用user-agents

安装

  1. 安装django-user-agents,您需要确保首先安装了user-agents

    pip install pyyaml ua-parser user-agents
    pip install django-user-agents
  2. 配置settings.py

    INSTALLED_APPS = (
        # Other apps...
        'django_user_agents',
    )
    
    # Cache backend is optional, but recommended to speed up user agent parsing
    CACHES = {
        'default': {
            'BACKEND': 'django.core.cache.backends.memcached.MemcachedCache',
            'LOCATION': '127.0.0.1:11211',
        }
    }
    
    # Name of cache backend to cache user agents. If it not specified default
    # cache alias will be used. Set to `None` to disable caching.
    USER_AGENTS_CACHE = 'default'

用法

中间件

settings.py中添加UserAgentMiddleware

MIDDLEWARE_CLASSES = (
    # other middlewares...
    'django_user_agents.middleware.UserAgentMiddleware',
)

现在将在request中添加一个user_agent属性,您可以在views.py中使用它

def my_view(request):

    # Let's assume that the visitor uses an iPhone...
    request.user_agent.is_mobile # returns True
    request.user_agent.is_tablet # returns False
    request.user_agent.is_touch_capable # returns True
    request.user_agent.is_pc # returns False
    request.user_agent.is_bot # returns False

    # Accessing user agent's browser attributes
    request.user_agent.browser  # returns Browser(family=u'Mobile Safari', version=(5, 1), version_string='5.1')
    request.user_agent.browser.family  # returns 'Mobile Safari'
    request.user_agent.browser.version  # returns (5, 1)
    request.user_agent.browser.version_string   # returns '5.1'

    # Operating System properties
    request.user_agent.os  # returns OperatingSystem(family=u'iOS', version=(5, 1), version_string='5.1')
    request.user_agent.os.family  # returns 'iOS'
    request.user_agent.os.version  # returns (5, 1)
    request.user_agent.os.version_string  # returns '5.1'

    # Device properties
    request.user_agent.device  # returns Device(family='iPhone')
    request.user_agent.device.family  # returns 'iPhone'

如果您启用了django.core.context_processors.requestuser_agent也将通过request在模板中可用

{% if request.user_agent.is_mobile %}
    Do stuff here...
{% endif %}

视图用法

django-user_agents 包含了一个名为 get_user_agent 的函数,它接受一个 request 参数,并返回一个 UserAgent 实例。示例用法

from django_user_agents.utils import get_user_agent

def my_view(request):
    user_agent = get_user_agent(request)
    if user_agent.is_mobile:
        # Do stuff here...
    elif user_agent.is_tablet:
        # Do other stuff...

模板用法

django-user_agents 包含了一些模板过滤器

  • is_mobile

  • is_tablet

  • is_touch_capable

  • is_pc

  • is_bot

您可以使用这些过滤器,就像使用其他任何 django 模板过滤器一样

{% load user_agents %}

{% if request|is_mobile %}
    Mobile device stuff...
{% endif %}

{% if request|is_tablet %}
    Tablet stuff...
{% endif %}

{% if request|is_pc %}
    PC stuff...
{% endif %}

{% if request|is_touch_capable %}
    Touch capable device stuff...
{% endif %}

{% if request|is_bot %}
    Bot stuff...
{% endif %}

您可以在这里了解有关用户代理属性的更多信息。

运行测试

`which django-admin.py` test django_user_agents --settings=django_user_agents.tests.settings --pythonpath=.

变更日志

0.4.0

  • 为 Django 2.0 至 2.2 添加了支持。感谢 @adamchainz 和 @joehybird!

0.3.1

  • 修复了当请求没有 META 属性时的一个错误

0.3.0

  • Python 3,感谢 @hwkns!

0.2.2

  • 修复了一个错误,该错误会导致当用户代理长度超过 250 个字符时缓存设置/读取失败

0.2.1

  • 修复了打包问题

0.2.0

  • 添加了模板过滤器

  • 在 utils.py 中添加了 get_user_agent 函数

0.1.1

  • 修复了空 HTTP_USER_AGENT 时的 KeyError 异常

0.1

  • 初始发布

项目详情


下载文件

下载您平台上的文件。如果您不确定要选择哪个,请了解有关 安装软件包 的更多信息。

源代码分发

django-user_agents-0.4.0.tar.gz (8.5 kB 查看哈希值)

上传时间 源代码

构建分发

django_user_agents-0.4.0-py3-none-any.whl (8.6 kB 查看哈希值)

上传时间 Python 3

由以下机构支持