asgi-user-agents 0.3.0

User Agent integration for ASGI applications.

asgi-user-agents

User Agents integration for ASGI applications. Works with Starlette, FastAPI, Quart, Litestar -- or any other web framework supporting ASGI that exposes the ASGI scope.

---

Table of Contents

• Installation
• How does it work?
• Usage
• Framework integrations
  • Litestar
  • FastAPI
• API Reference
  • UAMiddleware
  • UADetails
  • UARequest
• Development
  • env
  • hooks
  • test
  • types
  • co
  • pr
• Author
• Credits
• Analysis
• License

Installation

NOTE: This is alpha software. Please be sure to pin your dependencies.

Latest Release

pip install asgi-user-agents

Development Version

pip install git+https://github.com/hasansezertasan/asgi-user-agents.git

How does it work?

It simply adds a ua attribute to the request scope. This attribute is an instance of the UADetails class which abstracts the UserAgent class from the user-agents package 📄.

Usage

It's pretty simple. Just add the middleware to your ASGI application and access the ua attribute from the request scope.

from asgi_user_agents import UAMiddleware
from asgi_user_agents import UARequest as Request
from fastapi.applications import FastAPI
from starlette.middleware import Middleware
from starlette.responses import JSONResponse, Response


app = FastAPI(middleware=[Middleware(UAMiddleware)])


@app.get("/")
async def index(request: Request) -> Response:
    ua = request.scope["ua"]
    data = {
        "ua_string": ua.ua_string,
        "os": ua.os,
        "os.family": ua.os.family,
        "os.version": ua.os.version,
        "os.version_string": ua.os.version_string,
        "browser": ua.browser,
        "browser.family": ua.ua.browser.family,
        "browser.version": ua.ua.browser.version,
        "browser.version_string": ua.ua.browser.version_string,
        "device": ua.device,
        "device.family": ua.device.family,
        "device.brand": ua.device.brand,
        "device.model": ua.device.model,
        "is_provided": ua.is_provided,
        "is_tablet": ua.is_tablet,
        "is_mobile": ua.is_mobile,
        "is_touch_capable": ua.is_touch_capable,
        "is_pc": ua.is_pc,
        "is_bot": ua.is_bot,
        "is_email_client": ua.is_email_client,
    }
    return JSONResponse(data)

Framework integrations

For Litestar and FastAPI, optional contrib subpackages provide framework-idiomatic access. The core UAMiddleware still works for any ASGI framework — contrib is additive convenience.

Install with the relevant extra:

pip install asgi-user-agents[litestar]
pip install asgi-user-agents[fastapi]

Litestar

Use UAPlugin to inject ua: UADetails and user_agent: UserAgent into route handlers. No middleware needed.

from litestar import Litestar, get

from asgi_user_agents import UADetails
from asgi_user_agents.contrib.litestar import UAPlugin


@get("/")
async def index(ua: UADetails) -> dict:
    return {"is_bot": ua.is_bot, "browser": ua.browser.family}


app = Litestar(route_handlers=[index], plugins=[UAPlugin()])

If you already registered a dependency named ua or user_agent, UAPlugin will not overwrite it.

FastAPI

Use install_ua(app) plus the prebuilt UADep / UserAgentDep annotated dependencies.

from fastapi import FastAPI

from asgi_user_agents.contrib.fastapi import UADep, install_ua

app = install_ua(FastAPI())


@app.get("/")
async def index(ua: UADep) -> dict:
    return {"is_bot": ua.is_bot, "browser": ua.browser.family}

install_ua is idempotent. The plain dependency functions get_ua and get_user_agent are also exported if you prefer to wire them yourself.

API Reference

UAMiddleware

An ASGI middleware that sets scope["ua"] to an instance of UADetails (scope refers to the ASGI scope).

app = UAMiddleware(app)

UADetails

A helper that provides shortcuts for accessing User-Agent request header.

ua = UADetails(scope)

• ua: UserAgent - The UserAgent instance from the user-agents package.
• ua_string: str - The user agent string.
• is_provided: bool - True if the user agent string is provided.
• os: OperatingSystem - The operating system details of the user agent. It's a named tuple with the following fields:
  • family: str - The family of the operating system.
  • version: str - The version of the operating system.
  • version_string: str - The version of the operating system as a string.
• browser: Browser - The browser details of the user agent. It's a named tuple with the following fields:
  • family: str - The family of the browser.
  • version: str - The version of the browser.
  • version_string: str - The version of the browser as a string.
• device: Device - The device details of the user agent. It's a named tuple with the following fields:
  • family: str - The family of the device.
  • brand: str - The brand of the device.
  • model: str - The model of the device.
• is_tablet: bool - True if the request was made by a tablet.
• is_mobile: bool - True if the request was made by a mobile device.
• is_touch_capable: bool - True if the request was made by a touch-capable device.
• is_pc: bool - True if the request was made by a PC.
• is_bot: bool - True if the request was made by a bot.
• is_email_client: bool - True if the request was made by an email client.

UARequest

For Starlette-based frameworks, use this instead of the standard starlette.requests.Request so that code editors understand that request.scope["ua"] contains an UADetails instance:

from asgi_user_agents import UARequest as Request

async def home(request: Request):
    reveal_type(request.scope["ua"])  # Revealed type is 'UADetails'

Development

Clone the repository and cd into the project directory:

git clone https://github.com/hasansezertasan/asgi-user-agents
cd asgi-user-agents

Install hatch, you can follow the instructions, or simply run one of the following commands:

mise use hatch

uv tool install hatch

pipx install hatch

The commands below can also be executed using the xc task runner, which combines the usage instructions with the actual commands. Simply run xc, it will popup an interactive menu with all available tasks.

env

Initialize the environment and install the dependencies:

hatch shell

hooks

Initialize pre-commit hooks by running the following command:

pre-commit install

test

Make your changes on a new branch and run the tests:

hatch test -a

types

Make sure that the code is typed, linted, and formatted correctly:

hatch run types:all

co

Stage your changes and commit them:

Inputs: MESSAGE

git add .
git commit -m "$MESSAGE"

pr

Create a pull request and wait for the review 🤓.

gh pr new -B main

Author

• Hasan Sezer Taşan, It's me 👋.

Credits

• This project wouldn't be possible without the user-agents package 🙏.
• The project structure is inspired by the asgi-htmx 🚀 package and contains some code snippets from it 😅 (even this file).

Analysis

• Snyk Python Package Health Analysis
• Libraries.io - PyPI
• Safety DB
• PePy Download Stats
• PyPI Download Stats
• Pip Trends Download Stats

License

asgi-user-agents is distributed under the terms of the MIT license.