Python API reference
Generated from the source code of JBrowser 1.5.4.
Every module of the jbrowser package in this version: 76 modules, 150 classes. Each page lists the public classes, signals, methods, functions and constants with their docstrings, and links to the source.
Application#
jbrowser
| Module | Summary |
|---|---|
jbrowser |
JBrowser: a spatial, privacy-focused web browser for Windows 11. |
jbrowser.app |
Application bootstrap: environment, single instance, services, window, orderly shutdown. |
jbrowser.context |
AppContext: the dependency container that owns and wires every service. |
jbrowser.paths |
Filesystem layout for JBrowser's persistent state. |
jbrowser.single_instance |
Single-instance guard: a second launch forwards its URLs to the running window. |
Core#
jbrowser.core
| Module | Summary |
|---|---|
jbrowser.core.aeszip |
Password-protected ZIP files with AES-256 encryption (the WinZip AES format, AE-2). |
jbrowser.core.commands |
Command registry: single source of truth for actions, shortcuts and the cheat sheet. |
jbrowser.core.fuzzy |
Small, fast fuzzy matcher used by the Lazy Toolbar. |
jbrowser.core.jsonstore |
Crash-safe JSON / binary persistence helpers. |
jbrowser.core.motion |
Global motion policy: every animation in JBrowser asks this object for its duration. |
jbrowser.core.settings |
Centralised, observable settings store backed by a JSON file. |
jbrowser.core.urls |
URL heuristics: omnibox input classification, host/domain helpers. |
jbrowser.core.workers |
Background download helpers shared by the tracker-list and threat-list updaters. |
Models#
jbrowser.models
| Module | Summary |
|---|---|
jbrowser.models.infobar |
Data describing an in-card info bar (permission prompt, save password, crash, ...). |
jbrowser.models.space |
Space model: an isolated workspace with its own web profile. |
jbrowser.models.state |
BrowserState: the single, centralised store of spaces, cards, focus and selection. |
jbrowser.models.tab |
Tab state model and the asynchronous, coalescing tab-update pipeline. |
Web engine#
jbrowser.engine
| Module | Summary |
|---|---|
jbrowser.engine.identity |
The browser JBrowser presents itself as: the current Chrome version, as a Chromium browser. |
jbrowser.engine.js |
JavaScript injected into pages. Kept in Python so the frozen build needs no data files. |
jbrowser.engine.lifecycle |
Tab lifecycle: out-of-sight render throttling and the smart memory saver (tab sleeping). |
jbrowser.engine.page |
QWebEnginePage subclass and the isolated-world bridge object. |
jbrowser.engine.profiles |
One isolated QWebEngineProfile per space. |
jbrowser.engine.registry |
EngineRegistry: creates/destroys a TabController for every Tab in the state store. |
jbrowser.engine.tab_controller |
TabController: owns one card's QWebEnginePage and translates engine events into Tab-model updates (via the coalescing pipeline), info bars and lifecycle operations. |
Services#
jbrowser.services
| Module | Summary |
|---|---|
jbrowser.services.adfilter |
Adblock Plus / EasyList filter engine: URL-pattern blocking, exceptions and element hiding. |
jbrowser.services.archive |
The Archive: cards closed in the last 48 hours, ready to be reopened. |
jbrowser.services.blocklist_data |
Built-in third-party blocklist: ad networks, trackers, fingerprinters, cryptominers, telemetry. |
jbrowser.services.bookmarks |
Bookmarks / favorites store. |
jbrowser.services.cookies |
Mirrors each space's cookie store so cookies can be browsed and deleted from the UI. |
jbrowser.services.downloads |
Download manager: accepts engine downloads, tracks progress, persists completed items. |
jbrowser.services.favicons |
Persistent favicon cache keyed by host (never written for incognito spaces). |
jbrowser.services.favourites |
Sidebar favourites: sites pinned above the spaces (Arc-style), available in every space. |
jbrowser.services.history |
SQLite-backed browsing history with per-space tagging and frecency ranking. |
jbrowser.services.network |
DNS resolver selection (DNS-over-HTTPS), proxy routing and localhost developer tooling. |
jbrowser.services.permissions |
Human-readable descriptions for web permission types. |
jbrowser.services.privacy |
Privacy sandbox: third-party tracker blocking, GPC / DNT, HTTPS upgrades, dev host routing. |
jbrowser.services.search |
Search engines, keyword shortcuts and live (Google) search suggestions. |
jbrowser.services.session |
Session persistence: spaces, card layout and full back/forward history per card. |
jbrowser.services.threats |
Phishing & malware protection. |
jbrowser.services.updater |
Automatic updates from GitHub Releases. |
jbrowser.services.userscripts |
User scripts (JavaScript) and user styles (CSS), scoped by domain pattern and space. |
jbrowser.services.vault |
Encrypted local password vault. |
Platform (Windows)#
jbrowser.platform
| Module | Summary |
|---|---|
jbrowser.platform.win |
Windows 11 integration via the Win32 / DWM APIs (ctypes). |
User interface#
jbrowser.ui
| Module | Summary |
|---|---|
jbrowser.ui.actions |
Registers every browser command with its shortcuts, palette keywords and live state. |
jbrowser.ui.archive |
Archive popup: cards closed in the last 48 hours, grouped by when they were closed. |
jbrowser.ui.canvas |
The infinite horizontal canvas: cards laid out left→right, panned smoothly, resized with animated transitions, and reporting viewport visibility to the lifecycle manager. |
jbrowser.ui.card |
WebCard: a single web viewport living on the horizontal canvas. |
jbrowser.ui.chrome_window |
Translucent tool windows (Settings, History, Downloads, ...). |
jbrowser.ui.controller |
BrowserController: executes user intents against the state store, engine and UI surfaces. |
jbrowser.ui.favorites_bar |
Collapsible bookmarks bar (Ctrl+Shift+B). |
jbrowser.ui.gallery |
The Gallery (Ctrl+Shift+G, or the Gallery button on the ribbon): every card of a space, or of all spaces, as a grid of live thumbnails. |
jbrowser.ui.hotkeys |
Hotkey cheat sheet (Ctrl+/ or F1), generated from the command registry. |
jbrowser.ui.icons |
Vector icons rendered from the Windows 11 "Segoe Fluent Icons" font (MDL2 fallback), plus the procedurally drawn JBrowser logo. No image assets are required at runtime. |
jbrowser.ui.lazy_toolbar |
The Lazy Toolbar: a centred command overlay that replaces new-tab pages and the omnibox. |
jbrowser.ui.onboarding |
The first-run welcome: a fade-in logo intro, three story slides, setup pages and a guided tour of the real interface. |
jbrowser.ui.sidebar |
Vertical sidebar: favourites, spaces, the active space's cards and tools. |
jbrowser.ui.site_info |
Site information panel opened from the security icon in the address pill. |
jbrowser.ui.sounds |
Short UI sound effects (welcome screen), played with low latency through QSoundEffect. |
jbrowser.ui.theme |
Theme engine: dark/light palettes with alpha-layered surfaces over Mica / Acrylic. |
jbrowser.ui.titlebar |
Custom title bar: grouped navigation, the address pill, tools and window controls. |
jbrowser.ui.widgets |
Reusable, custom-painted widgets that follow the theme and the global motion policy. |
jbrowser.ui.window |
MainWindow: frameless-looking Windows 11 window hosting sidebar, title bar and canvases. |
Dialogs and tool windows#
jbrowser.ui.dialogs
| Module | Summary |
|---|---|
jbrowser.ui.dialogs.auth |
HTTP / proxy authentication prompt. |
jbrowser.ui.dialogs.base |
Shared base for small modal dialogs (credentials, bookmark editor, space editor, ...). |
jbrowser.ui.dialogs.bookmarks |
Bookmarks manager with Netscape-format (HTML) import/export. |
jbrowser.ui.dialogs.downloads |
Download manager window: live progress, speed/ETA, pause/resume/cancel and file launcher. |
jbrowser.ui.dialogs.history |
Searchable, space-filterable history vault with date-range filtering and 1-click clearing. |
jbrowser.ui.dialogs.media |
Screen / window picker for getDisplayMedia() screen-sharing requests. |
jbrowser.ui.dialogs.network |
Proxy configuration (global or per space) and the localhost developer toolkit. |
jbrowser.ui.dialogs.passwords |
Password manager UI for the encrypted local vault. |
jbrowser.ui.dialogs.popup |
Script-opened popup windows (window.open with features — OAuth / payment flows). |
jbrowser.ui.dialogs.settings |
Settings window. |
jbrowser.ui.dialogs.site_data |
Cookie manager and site permission manager. |
jbrowser.ui.dialogs.space |
Create / edit a space (name, icon, color, incognito). |
jbrowser.ui.dialogs.update |
The Update JBrowser dialog: release notes, download progress and install. |
jbrowser.ui.dialogs.userscripts |
Editor for injectable user scripts (JS) and user styles (CSS), per space or domain. |