EAF Base API
What is this?
When using one of my Porn site APIs, you probably came across this package and wondered what it actually does, so here's a detailed answer.
A lot of Porn sites use very similar methods for m3u8 (HLS) parsing and other things. I also wanted to implement proxy
support, and there was a lot of code that I would have rewritten in every API again and again. That's why I made this API
package. The BaseCore class does all the necessary stuff like m3u8 parsing, a great caching system, network request
fetching with retry attempts and proxy support.
Documentation (IMPORTANT!)
You can find the documentation here ->: https://github.com/EchterAlsFake/API_Docs/blob/master/Porn_APIs/eaf_base_api.md
Source-aware media models
Use media_field() for every attribute populated by a remote loader. The first
source is the highest-priority source if multiple sources provide the same field.
Each configured loader is async and returns a complete mapping for all fields
assigned to that source; loaders do not mutate the model directly.
from dataclasses import dataclass
from typing import ClassVar
from base_api import BaseMedia, media_field
@dataclass(kw_only=True, slots=True)
class Video(BaseMedia):
title: str | None = media_field("html", "api")
available_qualities: list[int] | None = media_field("html")
loader_methods: ClassVar[dict[str, str]] = {
"html": "_load_html",
"api": "_load_api",
}
async def _load_html(self) -> dict[str, object]:
data = await fetch_and_parse_html(self.url)
return {
"title": data.get("title"),
"available_qualities": data.get("available_qualities"),
}
async def _load_api(self) -> dict[str, object]:
data = await fetch_and_parse_api(self.url)
return {"title": data.get("title")}
Load exactly the information a caller needs:
video = Video(url=url, core=core)
await video.load_fields("title", "available_qualities")
# Or request a known source explicitly.
await video.load_sources("html")
# Convenience form that loads one field and returns it.
title = await video.get_field("title")
An unresolved field raises DataNotLoadedError with the exact field and eligible
sources. A loader returning None marks the field as loaded and does not raise.
Loader mappings are validated before any values are committed, preventing partial
model updates after parser failures.
HTTP requests and caching
BaseCore exposes one method per response representation. Use the core as an
async context manager so its connection pool is closed deterministically:
from base_api import BaseCore, CachePolicy
async with BaseCore() as core:
response = await core.request("https://example.com/status")
text = await core.fetch_text("https://example.com/page")
data = await core.fetch_bytes("https://example.com/file")
fresh_text = await core.fetch_text(
"https://example.com/live",
cache_policy=CachePolicy.REFRESH,
)
uncached_text = await core.fetch_text(
"https://example.com/volatile",
cache_policy=CachePolicy.BYPASS,
)
Only successful GET text responses are cached. Cache keys distinguish parameters,
request bodies, headers, and cookies without storing credentials in plaintext.
CachePolicy.USE reads and writes the cache, REFRESH skips the read and replaces
the entry, and BYPASS neither reads nor writes. Concurrent misses for the same
request share one network operation.
Network failures and retryable HTTP statuses are retried automatically for
idempotent methods. Set retry_non_idempotent=True only when repeating a POST or
PATCH is known to be safe.
Concurrent page and media iteration
Helper uses bounded asyncio task sets. Completion order is the default because
it exposes fast media without waiting for slower earlier media. Original page and
extractor order is available with ResultOrder.ORIGINAL.
from base_api import Helper, ResultOrder
helper = Helper(core=core, constructor=Video)
stream = helper.iterator(
page_urls,
extractor_videos,
max_page_concurrency=3,
max_item_concurrency=20,
load_fields=("title", "available_qualities"),
order=ResultOrder.COMPLETION, # The default.
)
# The context manager guarantees immediate task cleanup if this loop breaks early.
async with stream:
async for result in stream:
if not result.succeeded:
logger.error("%s failed: %s", result.stage, result.error)
continue
video = result.unwrap()
Use order=ResultOrder.ORIGINAL when presentation order matters. Page and item
failures independently support ErrorMode.YIELD, ErrorMode.SKIP, or
ErrorMode.RAISE. RetryPolicy provides a strict maximum attempt count and
optional exponential delay; error handlers return an ErrorAction and cannot
create an unbounded retry loop.
Can I use this for myself?
Yes, you can, but I may change stuff here and there from time to time, and it would maybe break your project. I would not recommend you to install and use it as a package, but just copy the code you need.
I can recommend everyone the download functions for HLS streaming since, for example, the threaded preset is very well optimized. If you just use mine, you need to consume less caffeine and brain cells to make such a function :)
License
Licensed under The AGPLv3 license.
Copyright (C) 2024-2026 Johannes Habel
Metadata
Release files for eaf_base_api 4.0.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| eaf_base_api-4.0.0.tar.gz | 62.0 kB | Without provenance | Details for eaf_base_api-4.0.0.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| eaf_base_api-4.0.0-py3-none-any.whl | Python 3 | none | any | Details for eaf_base_api-4.0.0-py3-none-any.whl |
Total release size: 125.5 kB
Release files / eaf_base_api-4.0.0.tar.gz
| Download URL | eaf_base_api-4.0.0.tar.gz |
|---|---|
| Size | 62.0 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
451748ff0cf0908b419e17b5f1498ea3686881cca9a7a669d1b0dbfa094dfc55
|
|
BLAKE2b-256 checksum How to use checksums |
777090901a40caa829830338bdaa4746f8bddca0c952bda6f750241f3e255b90
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
uv/0.10.5 {"installer":{"name":"uv","version":"0.10.5","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Arch Linux","version":null,"id":null,"libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}
|
Release files / eaf_base_api-4.0.0-py3-none-any.whl
| Download URL | eaf_base_api-4.0.0-py3-none-any.whl |
|---|---|
| Size | 63.5 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
45d28f489b16e4e122b015f8b6619949b6bd784f7e120a94cb457ac3d2492f51
|
|
BLAKE2b-256 checksum How to use checksums |
eb98e24a237971b58d12932d3f2c23efe1c3acd5de3eecd3dd7961cbb75cf01c
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
uv/0.10.5 {"installer":{"name":"uv","version":"0.10.5","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Arch Linux","version":null,"id":null,"libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}
|
Security for eaf_base_api 4.0.0
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.