animedex.transport.useragent

User-Agent string composition for animedex HTTP requests.

The transport injects a minimal project-identifying User-Agent on every outgoing request unless the caller passes their own. The default form is animedex/<version> with no contact suffix: live-testing the eight wired backends showed every one accepts the bare animedex/<version> form, so the verbose animedex/<v> (+<email>) shape earlier code shipped was over-engineered.

Two backends genuinely require some non-empty UA at the wire (MangaDex returns 400 on empty; Danbooru’s Cloudflare front returns a challenge HTML on empty). The other six accept any value including empty. Our default satisfies all eight.

A caller that needs a different UA - identifying their own bot, testing what an upstream does with empty/spoofed values, or any other reason - can pass custom to compose_user_agent(). The project’s posture is to surface upstream contracts but never override the caller’s explicit intent: an empty or hostile UA the caller asked for is the caller’s problem, not the transport’s.

default_user_agent

animedex.transport.useragent.default_user_agent() → str[source]

Compose the project-default User-Agent string.

Reads animedex.config.meta so the version stays in sync with the package metadata. The resulting string is a bare name/version form (e.g. "animedex/0.0.1") - no parens, no contact suffix, no descriptors. Every backend we target accepts this form on the wire.

Returns:: User-Agent string for animedex’s own requests.
Return type:: str

compose_user_agent

animedex.transport.useragent.compose_user_agent(custom: str | None) → str[source]

Pick the User-Agent for an outgoing request.

Honours a non-empty caller-provided string verbatim, otherwise returns default_user_agent(). Empty strings collapse to the default rather than being passed through, so a misconfigured caller still satisfies the upstream’s mandatory-UA contract.

Parameters:: custom (str or None) – Caller-supplied User-Agent, or None /"" to use the default.
Returns:: User-Agent string to send on the wire.
Return type:: str

selftest

animedex.transport.useragent.selftest() → bool[source]

Smoke-test the User-Agent composer.

Asserts the default string carries the project name, version, and contact email, and that an explicit override is honoured. Stays fully offline and finishes in microseconds so the diagnostic runner can include it on every CLI invocation.

Returns:: True on success.
Return type:: bool