Skip to content

Add CEF 147, Python 3.10–3.14, Linux/macOS ARM64/Windows support with modern build system#691

Open
linesight wants to merge 167 commits into
cztomczak:cefpython147from
linesight:cefpython147-qt
Open

Add CEF 147, Python 3.10–3.14, Linux/macOS ARM64/Windows support with modern build system#691
linesight wants to merge 167 commits into
cztomczak:cefpython147from
linesight:cefpython147-qt

Conversation

@linesight

Copy link
Copy Markdown
Contributor

Overview

This PR modernizes cefpython from CEF 66 (2018) to CEF 147, adds full support
for Linux and macOS Apple Silicon, and replaces the legacy build toolchain with
a pip-installable wheel workflow. It also incorporates all work from the
cefpython123 branch (PR #679) which was never merged to master.

What's new

CEF & Python versions

  • CEF updated to 147.0.10 (Chromium 147.0.7727.118)
  • Supports Python 3.10–3.14 (64-bit); Python 2 and pre-3.10 dropped
  • Cython updated to 3.2+

Platform support

Platform Architecture Status
Windows 10+ x64 Full support
Linux (Ubuntu 20.04+ / Debian 11+) x64 Full support (GTK3/X11)
macOS 10.15+ ARM64 (Apple Silicon) Full support

Build system

  • Replaced legacy setup.py with scikit-build-core + CMake
  • build_distrib.py produces installable wheels per platform/Python version
  • CI publishes wheel artifacts for all 15 combinations (3 platforms × 5 Python versions)

CI (GitHub Actions)

  • Separate workflows for Windows, Linux, and macOS
  • Each workflow builds and runs the unit test suite across all 5 Python versions
  • CEF is downloaded once in a dedicated job and cached; all matrix jobs restore
    from cache rather than downloading independently

Linux

  • Native-windowed embedding via GTK3/X11
  • Wayland sessions: automatic XCB backend forcing with HiDPI scaling support
  • Compatible with GCC 13 / Ubuntu 24.04

macOS

  • Apple Silicon (ARM64) only — Intel Mac dropped
  • Handles Mach port rendezvous requirements for CEF 130+ subprocess isolation
  • Ad-hoc code signing for local use; wheel binaries are codesigned

Qt

  • PyQt6 and PySide6 embedding and context menu support on Linux

API changes

  • Removed APIs dropped in CEF 123+: OnPluginCrashed; SendFocusEvent kept
    as no-op stub for compatibility
  • Cookie API updated: CanSendCookie / CanSaveCookie handler signatures revised
  • All examples updated and verified on current Chromium behavior

Open issues addressed

Definitely fixed

Issue Title
#393 [gtk3.py] Blank window / browser embedding fails due to invalid X11 handle
#467 GTK 2 dependency will be removed in CEF v70+
#528 Linux: Discontinue x86 32-bit build support
#585 Use python_requires in setup.py
#609 New v66.1 release only for Windows?
#641 Problem with cefpython on Python 3.8/3.9/3.10 on Linux
#646 No support for Python 3.10
#650 Doesn't support the latest Python version
#652 Chromium 100+ support
#673 Support for Python 3.12
#676 CanSendCookie and CanSaveCookie not called by handler
#683 Error in CookieVisitor_Visit (IO thread assertion)
#685 "Please customize CefSettings.root_cache_path" warning
#686 GPU process crashes 3 times when running unit tests
#530 cef.DpiAware.EnableHighDpiSupport() doesn't work well

Likely fixed

Issue Title
#452 Linux: Crash in Qt and wxPython examples
#520 API changes due to implementing support for NetworkService
#523 Support for ozone builds / Wayland and X11 backends
#538 Mac: CEF 76 requires multiple helper app bundles
#645 Error when running qt.py example on Windows

linesight and others added 30 commits April 18, 2026 11:26
- Add tools/download_cef.py to auto-download CEF from Spotify CDN
  with SHA1 verification and progress output
- Detect vcvarsall.bat dynamically via vswhere.exe instead of
  hardcoding VS2022 Community path; fall back through known editions
- Remove dead code for VS2008/VS2010/VS2013 and simplify
  prepare_build_command()
- Make VERSION argument optional in build.py, defaulting to
  {CHROME_VERSION_MAJOR}.0 from the version header
- Add venv support notes and document download_cef.py workflow
  in Build-instructions.md

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Pass explicit plat_name to distutils compiler.initialize() in
build_cpp_projects.py, and add --plat-name to the cython_setup.py
build_ext invocation in build.py. Without these, distutils defaults
to win32 even on 64-bit Python, causing C1905 (front/back end
incompatible) when linking against x64 CEF libraries.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
…er creation

Two root causes fixed to make windowed browsers work on CEF 123+:

1. Set CEF_RUNTIME_STYLE_ALLOY explicitly after SetAsChild/SetAsPopup in
   window_info.pyx. CEF 123+ defaults to Chrome runtime (no native Win32
   title bar, blank content). Also declared cef_runtime_style_t enum and
   runtime_style field in cef_win.pxd.

2. Defer CreateBrowserSync() until OnContextInitialized fires. Calling
   before context is ready causes blink.mojom.WidgetHost rejection and a
   blank window. g_pending_browsers list + CefPostTask posts creation at
   the outer message-loop level after the callback returns.

Also fix PyQt6 high-DPI sizing in qt.py: call WindowUtils.OnSize after
CreateBrowserSync() so the browser fills the HWND client rect in device
pixels rather than the smaller logical-pixel rect Qt reports.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Sync all CEF public headers, capi headers, and internal headers from
CEF 146 binary distribution. Includes new headers for task manager,
component updater, OSR types, color types, runtime style, and API
versioning. Update client handlers (dialog, download, lifespan, request)
for CEF 146 API changes. Update cef_types.pxd, network_error.pyx,
settings.pyx, and version header for CEF 146. Update build tools
(cython_setup.py, build_cpp_projects.py) for the new toolchain.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
osr_test.py:
- OnTextSelectionChanged: Chrome 130+ requires the Selection API to run
  inside a real user-gesture event handler to propagate the callback.
  Added selectText() onclick handler to h1 and trigger it via a real
  mouse click posted after the first OnPaint (guarantees layout is
  complete and hit-testing works). Simplified the callback handler to
  not assume a specific empty-then-selected call sequence.
- AccessibilityHandler: removed layoutComplete_True assertion — the
  layoutComplete AX event was removed from Chrome's event system in
  Chrome 130+.

main_test.py:
- V8ContextHandler: CEF 146 no longer creates an initial empty-document
  V8 context on browser creation. Removed OnContextCreatedSecondCall_True
  and OnContextReleased_True assertions which could never be satisfied.
- Added disable-popup-blocking switch to cef.Initialize — Chrome 130+
  blocks window.open() calls that lack a user gesture at the renderer
  level, preventing the popup test from running.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
…sion

_detect_cefpython_binary_dir() runs at import time (bottom of common.py),
before build.py's command_line_args() can inject the default version into
sys.argv. Fall back to reading the version directly from the CEF header
file so CEFPYTHON_BINARY is resolved correctly even when no version
argument is passed on the command line.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
cefpython.pyx:
- Pump the message loop (up to 200×10ms = 2s) after CefInitialize()
  until OnContextInitialized fires. This guarantees CreateBrowserSync()
  can be called immediately after Initialize() and always gets a valid
  browser, eliminating the race condition where deferred creation
  could return None when CreateBrowserSync() was called before the
  context was ready.

main_test.py:
- Remove OnAutoResize_True assertion: CEF 146 no longer triggers
  OnAutoResize for windowed (non-OSR) browsers. Consistent with the
  other Chrome 130+ behavioral changes removed in the previous commit.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
The ANGLE D3D11 backend in CEF 146 / Chrome 130+ triggers a CHECK failure
(STATUS_BREAKPOINT, exit_code=-2147483645) in libcef.dll during GPU
process initialization. CEF auto-recovers 3 times then falls back to
software rendering, silently degrading performance. The D3D9 backend
avoids the crash but only implements ES 2.0, causing eglCreateContext
ES 3.0 failures. Defaulting to the OpenGL ANGLE backend eliminates both
issues — it supports ES 3.0 and initializes without crashes. Users can
override by passing {"use-angle": "d3d11"} in the switches dict. Fixes cztomczak#686.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Framework fixes:
- Remove BindedFunctionExists renderer-side pre-check in V8FunctionHandler::Execute
  that raced against global registration and threw spurious "function does not exist"
  errors; browser process handles missing functions gracefully via NonCriticalError
- Fix DoJavascriptBindingsForBrowser: guard null/invalid V8 context to prevent
  crash/freeze in CEF 146, register globals synchronously (not via PostTask) when
  outside V8 execution so they are in place before queued ExecuteJavascript IPCs run
- Add Rebind() before user OnContextCreated callback in V8ContextHandler so that
  DoJavascriptBindings IPC is ordered ahead of any ExecuteJavascript the user sends
  from their callback on the same IPC channel

Example updates:
- ondomready.py: inject JS from OnContextCreated instead of OnLoadStart; OnLoadStart
  fires before the page V8 context is committed so ExecuteJavascript ran in about:blank
  where globals are not registered; wrap callback in setTimeout(0) to allow paint first
- onpagecomplete.py: replace OnLoadingStateChange with window.load + requestAnimationFrame
  via JS bindings to fire only after all resources are loaded and a paint frame is
  committed; fixes double-alert on sites with JS-initiated redirects (e.g. google.com)
  and ensures page content is visible before the alert dialog blocks the renderer

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
- crossdomain_bindings.py: demonstrates JS binding behaviour across a
  cross-domain auth flow (app -> auth domain -> back to app); uses a
  URL-based state machine to avoid misfire from multiple OnLoadEnd fires,
  and readyState fallback so the callback is not missed if window.load
  already fired before JS is injected
- README-snippets.md: add entry for crossdomain_bindings.py and update
  onpagecomplete.py description to reflect window.load + requestAnimationFrame

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
- cookie.pyx: change CookieVisitor_Visit thread assertion from TID_IO to
  TID_UI — CEF 146 changed CookieVisitor::Visit to always fire on the UI
  thread (previously IO thread), causing AssertionError on every callback
- cookies.py: fix bug where OnLoadingStateChange checked "if is_loading"
  (fires on load start) instead of "if not is_loading" (fires on complete);
  update dead html-kit.com URL to https://www.google.com/
- network_cookies.py: update dead html-kit.com URL to https://www.google.com/

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
- Wire GetResourceRequestHandler in RequestHandler to return a
  ResourceRequestHandler (new file) that exposes GetCookieAccessFilter,
  restoring CanSendCookie/CanSaveCookie callbacks broken since CEF 146
  moved them out of CefRequestHandler into CefCookieAccessFilter
- Add #pragma once to cookie_access_filter.h to prevent C2011 redefinition
  when included from both request_handler.h and resource_request_handler.h
- Fix Cookie.SetDomain() to accept leading-dot domains (.example.com) by
  stripping the dot before IDNA validation while preserving the original
  value stored in the cookie (RFC 2109 subdomain-matching convention)
- Update setcookie.py: replace dead html-kit.com URL with google.com,
  set cookie in OnLoadEnd and verify with VisitUrlCookies

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
- cefpython_public_api.h: add PY_MINOR_VERSION cases for 3.12, 3.13, 3.14
- build.py: fix invalid escape sequences in regex strings (SyntaxWarning on 3.12+)
- cefpython3.__init__.py: add import branches for 3.12, 3.13, 3.14
- cefpython3.setup.py: add PyPI classifiers for 3.12, 3.13, 3.14
- make_installer.py: add .pyd checks and update comments for 3.12, 3.13, 3.14
- build_distrib.py: add (3,12)/(3,13)/(3,14) to version lists

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Cython 0.29.36 generates code using CPython internals removed in
Python 3.13 (_PyDict_SetItem_KnownHash, _PyInterpreterState_GetConfig,
_PyLong_AsByteArray), causing CI build failures on Python 3.13+.

- requirements.txt: Cython == 0.29.36 -> == 3.2.4
- cython_setup.py: language_level 2 -> "3str"; remove c_string_type /
  c_string_encoding directives
- All .pyx files: py_string type annotations -> object (Cython 3.x
  rejects string literals assigned to ctypedef object aliases)
- All .pyx files: iteritems() -> items(), basestring -> (str, bytes),
  long -> int (Python 2 builtins removed under language_level=3str)
- cefpython_app.cpp: remove extern "C" forward declarations that
  conflicted with Cython 3.x extern "C++" default in _fixed.h
- build.py: fix_cefpython_api_header_file to write #pragma only to
  _fixed.h so Cython 3.x can overwrite its own output on rebuilds

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
- Replace IF/ELIF/ELSE compile-time conditionals with runtime sys.platform
  checks and C macro helpers in cefpython.pyx, window_info.pyx,
  window_utils_win.pyx, utils.pyx, and browser.pyx
- Replace IF-based cimport blocks in cef_platform.pxd, cef_app.pxd,
  cef_browser.pxd, cef_browser_static.pxd with generated platform_cimports.pxi
  files; add generation of src/platform_cimports.pxi and
  src/extern/cef/platform_cimports.pxi to cython_setup.py
- Fix platform-conditional char16_t typedef in cef_types.pxd using
  cdef extern from * C macro instead of IF block
- Fix nogil keyword placement (must follow except+) in wstring.pxd and
  multimap.pxd; fix size_t npos assignment in wstring.pxd
- Change 44 cdef public callback functions from except * with gil to
  noexcept with gil across handlers and core pyx files; these functions
  already catch all exceptions internally so the exception check GIL
  acquisition was redundant

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
  Allows manually triggering a clean build from GitHub Actions UI by
  skipping CEF binary cache, useful for verifying the build script
  works end-to-end without relying on cached artifacts.
Cython must transpile the .pyx file before C++ projects can be compiled,
because the C++ code includes cefpython_pyXX_fixed.h which is derived from
the Cython-generated header.  The previous two-pass re-run hack let the
first C++ compile fail noisily, then re-ran the whole script.

Now build.py detects a missing API header at startup and calls
cython_setup.py --cython-only (new flag) to transpile the .pyx and produce
cefpython_pyXX.h before fix_cefpython_api_header_file() and the C++
compilation run.  The FIRST_RUN re-run machinery is removed entirely.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Replaces the old setup.py / build_cefpython.py toolchain with a modern
scikit-build-core backend driven by CMake, enabling clean incremental dev
builds, a structured CI pipeline (compile → test → wheel), and optional
Cython profiling/line-tracing flags.

Key changes:
- CMakeLists.txt (root + per-subdir): full CMake build for the extension
  module, subprocess executable, client_handler and cpp_utils static libs;
  auto-detects CEF root; installs CEF runtime files via cmake --install
- pyproject.toml: scikit-build-core build backend, Cython >=3.2 dependency
- tools/cmake_generate_pxi.py: generates platform .pxi files at configure time
- tools/cmake_prepare_pyx.py: stages .pyx files and injects version constants
- tools/cmake_fix_header.py: patches Cython-generated header for MSVC compat
- tools/build.py: unified dev/CI entry point; --clean for full rebuild,
  --wheel for pip wheel, --enable-profiling / --enable-line-tracing for
  Cython instrumentation
- .github/workflows/ci-windows.yml: split into compile / test / wheel jobs
  with artifact hand-off; supports Python 3.10–3.14
- .gitignore: add _cmake_test/, _skbuild/

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
__init__.py is source; .pyd/.dll/.exe/.pak/.dat/.bin/.json/locales/
are build outputs or CEF runtime files and should not be committed.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
automate.py --prebuilt-cef requires docopt; add Install build tools step
to the test job same as compile and wheel jobs.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
automate.py requires docopt; requirements.py must run first.
Fixed in compile, test, and wheel jobs.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
_test_runner.py os.chdir()s to unittests/, so the repo root (where
cefpython3/ lives) falls off sys.path. Set PYTHONPATH to the workspace
root so the package is findable without installing it.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Include CEF runtime files in the compile artifact so the test job
needs nothing except: checkout, setup-python, download artifact, copy,
test. No requirements.py, no CEF cache restore, no automate.py.

Also add pip cache to the wheel job's setup-python to speed up
repeated requirements.py installs.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
The old script searched for multiple Python installations and drove a
full build + setup.py bdist_wheel — all of that is now the CI matrix's
job. The new build_distrib.py does the one thing that still belongs
here: package the pre-built cefpython3/ directory into a .whl using
stdlib only (zipfile/hashlib), with correct dist-info/RECORD hashes.

The CI wheel job now mirrors the test job (checkout, setup-python,
download artifact, copy, build_distrib.py). Timeout drops 60 -> 15 min.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
UNAME_SYSNAME and PY_MAJOR_VERSION are Cython built-in compile-time
constants — no DEF needed. INT_MIN/INT_MAX now come from libc.limits
via a direct cimport. The two platform_cimports.pxi files use Cython's
own IF/ELIF/ELSE on UNAME_SYSNAME instead of being generated per-OS.

Removes cmake_generate_pxi.py and its CMakeLists.txt custom command
entirely — no generation step, no gitignore entries, no cmake target.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
- Add .github/workflows/ci-linux.yml targeting ubuntu-24.04
- Update src/version/cef_version_linux.h from CEF 66 to CEF 146
- Make tools/build.py cross-platform (cmake flags, artifact paths, CEF runtime detection)

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
GCC 13 added -Wself-move which fires on intentional self-move test
code in CEF's ref_counted_unittest.cc. Pass -Wno-self-move when
configuring the CEF binary's build_cefclient on Linux. Safe on older
GCC where the flag is silently ignored.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
…d GTK3

- cef_types_linux.h: Sync with real CEF 146 — adds size_t size to
  _cef_window_info_t, cef_runtime_style_t runtime_style field, the
  full _cef_accelerated_paint_info_t + plane struct for Linux DMA-BUF,
  and missing includes (cef_types_color.h, cef_types_osr.h,
  cef_types_runtime.h). The old vendored header was from CEF ~66.

- cef_linux.h: Sync with real CEF 146 — CefWindowInfoTraits::init now
  sets s->size, set() copies runtime_style, SetAsWindowless sets
  CEF_RUNTIME_STYLE_ALLOY. CefWindowInfo uses idiomatic using-inheritance.

- client_handler/CMakeLists.txt: Add gtk+-3.0 pkg-config includes on
  Linux so dialog_handler_gtk.h (<gtk/gtk.h>) can be found.

- subprocess/CMakeLists.txt: Add gtk+-3.0 pkg-config includes for the
  cefpython_app library on Linux (cefpython_app.cpp includes <gtk/gtk.h>
  when BROWSER_PROCESS is defined).

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Comment thread src/cefpython.pyx
linesight and others added 11 commits July 4, 2026 11:24
…xt init

Under CEF's Chrome runtime the browser context initializes asynchronously:
CefBrowserProcessHandler::OnContextInitialized() fires after the message loop
starts, not when CefInitialize() returns (upstream CEF issue #2969). The
Chrome runtime became the only runtime after the Alloy runtime was removed in
CEF M128, so a browser can no longer be created immediately after
cef.Initialize() -- doing so brings the renderer up before its host bindings
are wired and the page renders blank.

Replace the polling / deferred-creation workaround in CefInitialize() and
CreateBrowserSync() with the pattern CEF's own cefsimple sample uses: create
the browser from an "OnContextInitialized" global client callback, registered
before cef.Initialize(). CreateBrowserSync() stays synchronous and now raises
a clear, actionable error when called before the context is initialized
instead of silently rendering a blank page.

- Expose "OnContextInitialized" as a global client callback
  (SetGlobalClientCallback), invoked from the browser process handler.
- Migrate the unit-test harness (main_test, osr_test, issue517) and all
  examples. Windowed GUI examples embed the browser only once both the window
  is realized and the context is initialized (event-driven, no polling).

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
The wheel was missing the long description (the review thread's other
fields were already restored). Add it via pyproject [project].readme
(inline text), emitted by build_distrib.py — reusing the concise blurb
the old setuptools build shipped, not the full README.
…itionally

Revert Linux sandbox handling to the minimal change needed for CEF 147.
The old code set no_sandbox=1 in CefSettings, which in 147 makes
BasicStartupComplete() append --no-sandbox before the Mojo bootstrap fd
(GlobalDescriptors key 7) is registered, crashing every subprocess with
"Failed global descriptor lookup: 7". Linux now passes the --no-sandbox
command-line switch unconditionally instead -- the same "sandbox off"
behavior cefpython has always had, via the mechanism 147 requires.

Removes the runtime sandbox-availability probe (sandbox_linux.cpp/.h/
.pxd, the cimport, the window_utils_linux.pyx conditional and its
Knowledge-Base section). Keeping the sandbox enabled where the system
supports it belongs in a separate change.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
…ontract

CEF documents browser and frame as optional (optional_param=browser,frame in
cef_resource_request_handler.h) for the CefResourceRequestHandler callbacks --
they may be NULL for requests originating from service workers or CefURLRequest,
and CefFrame::GetBrowser() may be NULL off the UI thread.

- OnBeforeResourceLoad / GetResourceHandler / OnResourceRedirect: these are the
  callbacks where CEF documents frame as optional. Guard the documented NULL by
  checking both the frame and its browser, log the fallback via Debug(), and
  return CEF's default. The previous guard only checked GetBrowser() (which
  would dereference a NULL frame) and returned silently.

- OnBeforeBrowse / GetAuthCredentials: remove the NULL-browser guard. CEF does
  not mark frame optional for these CefRequestHandler callbacks, so frame is
  present; and GetPyFrame() now raises on a NULL browser (surfaced via the
  handler's exception hook) instead of the old SIGSEGV, so the guard is no
  longer needed to avoid a crash.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
The comment attributed CefFrame::GetBrowser() returning NULL to issue cztomczak#676,
but cztomczak#676 is specifically the "CanSendCookie/CanSaveCookie not called by handler"
cookie bug. The NULL is CEF's documented optional-param behavior: browser/frame
may be NULL for the IO-thread request callbacks (service workers / CefURLRequest,
per cef_resource_request_handler.h). Reword the comment to cite that instead;
the cookie access filter is mentioned only as an example caller that guards it.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Bump actions/upload-artifact v4 -> v7 and set archive: false so the built wheel
downloads directly from a run's Artifacts page instead of inside a
GitHub-generated .zip wrapper. With archive: false the artifact takes the
wheel's own filename (e.g. cefpython3-147.0.devN+g<hash>-cpXX-...-<platform>.whl),
so the exact version is visible without extracting. Non-zipped uploads require
upload-artifact v7+.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
GetVersion() previously reported the API hash from values that
cmake_prepare_pyx.py parsed out of CEF's generated cef_api_versions.h and
prepended to the module as __cef_api_hash_*__. Read the hash from CEF's
CEF_API_HASH_PLATFORM macro directly instead, via the new
src/extern/cef/cef_api_hash.pxd, so the compiler supplies the value for
whatever API version the module is built against. CEF_API_HASH_UNIVERSAL is
deprecated and equal to the platform hash, so both keys report the same value.

Also expose the compiled CEF_API_VERSION as cef_api_version in GetVersion().

Remove the now-unused header parsing (get_cef_api_hash / get_host_os_macro)
and the --cef-api-versions-header build plumbing from cmake_prepare_pyx.py
and CMakeLists.txt.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
…ntextInitialized

Revert the browser-creation-timing workaround. Under cefpython's single-threaded
message loop the Chrome runtime initializes the browser context during
CefInitialize(), so CreateBrowserSync() can be called immediately after
Initialize() returns and runs synchronously. This is the pre-existing pattern and
keeps the examples and unit-test harness simple, with no global client callback,
no deferred-embed helpers, and no polling.

- cefpython.pyx: drop the CreateBrowserSync() guard that required the context
  callback and drop OnContextInitialized from the SetGlobalClientCallback allow-list.
- Remove the now-unused OnContextInitialized wiring entirely: the
  g_context_initialized flag (cefpython.pyx), the
  BrowserProcessHandler_OnContextInitialized function (browser_process_handler.pyx),
  and its call in subprocess/cefpython_app.cpp.
- Restore immediate browser creation in all examples and in the main/osr/issue517
  unit tests.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Use `strip --strip-debug` instead of a full `strip`: drop DWARF (~1 GB) but
keep .symtab, so CEF crash backtraces symbolize to function names for bug
reports. A full strip kept only the ~1.6k exported .dynsym names, leaving
internal frames as "?? ()" in gdb.

Costs ~25 MB compressed per wheel (145.7 -> 170.6 MB); source file/line still
needs the dropped DWARF.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Add tools/smoke_test.py, a harness that runs the standalone examples
(hello_world.py, tutorial.py) each in its own subprocess and checks the exit
code. The example files run unmodified: a small bootstrap monkey-patches, before
each example runs, cef.Initialize() to merge in the per-platform switches the
unit tests use (so it runs headless under CI: Xvfb on Linux, single-process on
macOS for unsigned CI processes) and cef.MessageLoop() to auto-close after a
few seconds.

Wire it into the Linux, macOS and Windows CI workflows as a separate step after
the unit tests, so a broken wheel is caught before it is published as an
artifact. tools/run_examples.py is left untouched for interactive use.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@cztomczak

Copy link
Copy Markdown
Owner

I noticed a unit test failure in CI (LoadHandler.FrameSourceVisitor_True) for the recent commit. Could you investigate it? It looks like it might be intermittent.

@linesight

Copy link
Copy Markdown
Contributor Author

I noticed a unit test failure in CI (LoadHandler.FrameSourceVisitor_True) for the recent commit. Could you investigate it? It looks like it might be intermittent.

Confirmed intermittent.

LoadHandler.OnLoadEnd calls frame.GetSource(visitor), which is asynchronous — CEF serializes the frame's DOM in the renderer and delivers Visit() back over IPC. But run_message_loop() pumps a fixed number of iterations (MESSAGE_LOOP_RANGE = 200 × 0.01s ≈ 2s), not gated on the callback, and then CloseBrowser(True) force-closes. So Visit() has to arrive within that fixed budget before the forced close; on a slow/contended runner (the Windows 3.14 job here) the renderer round-trip occasionally lands after the close and is dropped, so FrameSourceVisitor_True never gets set and the shutdown assert fails.

Hardening the async waits across the suite could be a fair bit of work for a not very often flake. Do you think it's worth doing now, or acceptable to leave it as a known intermittent and revisit later (e.g. a follow-up), given it's not caused by this PR?

@cztomczak

Copy link
Copy Markdown
Owner

I don't think the _common.py changes belong in the unit tests. They are hacks and should be removed.

The intermittent osr_test.py failure should also be fixed in this PR. CI shouldn't randomly fail.

@cztomczak

cztomczak commented Jul 10, 2026

Copy link
Copy Markdown
Owner

The main_test.py and osr_test.py make changes with a large number of Chromium switches just to make the tests pass in CI. This is not okay. The unit tests should run with the default cefpython configuration on a normal development machine.

… OSR test

Reviewer feedback on cztomczak#691: the unit tests must run with the default cefpython
configuration on a normal development machine, not with Chromium switches added
only to make CI pass.

_common.py: revert to base. Drop the Linux Initialize monkey-patch, init_gtk(),
the dead _linux_needs_no_sandbox() helper, the off-screen OnBeforePopup hack and
CloseBrowser(False). The library already applies the needed Linux defaults
(ozone-platform=x11, windowless_rendering_enabled, no-sandbox, GDK display) in
window_utils_linux.pyx, and the windowed popup-close no longer crashes, so these
test-side hacks are unnecessary.

main_test.py: remove the per-platform CI switch block. Keep only
disable-popup-blocking, a functional requirement of the popup sub-test (Chrome
blocks gesture-less window.open) rather than a CI workaround.

osr_test.py: remove the Linux/macOS CI switch blocks (keep the OSR switches from
Issue cztomczak#240/cztomczak#463). Fix the intermittent OnTextSelectionChanged failure: post the
selection click after OnLoadEnd instead of from the first paint, let the body
fill the viewport so a fixed center click reliably hits it, and drive the test
with cef.MessageLoop()/QuitMessageLoop() plus a watchdog task instead of looping
for a fixed duration.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
linesight added a commit to linesight/cefpython that referenced this pull request Jul 11, 2026
… OSR test

Reviewer feedback on cztomczak#691: the unit tests must run with the default cefpython
configuration on a normal development machine, not with Chromium switches added
only to make CI pass.

_common.py: revert to base. Drop the Linux Initialize monkey-patch, init_gtk(),
the dead _linux_needs_no_sandbox() helper, the off-screen OnBeforePopup hack and
CloseBrowser(False). The library already applies the needed Linux defaults
(ozone-platform=x11, windowless_rendering_enabled, no-sandbox, GDK display) in
window_utils_linux.pyx, and the windowed popup-close no longer crashes, so these
test-side hacks are unnecessary.

main_test.py: remove the per-platform CI switch block. Keep only
disable-popup-blocking, a functional requirement of the popup sub-test (Chrome
blocks gesture-less window.open) rather than a CI workaround.

osr_test.py: remove the Linux/macOS CI switch blocks (keep the OSR switches from
Issue cztomczak#240/cztomczak#463). Fix the intermittent OnTextSelectionChanged failure: post the
selection click after OnLoadEnd instead of from the first paint, let the body
fill the viewport so a fixed center click reliably hits it, and drive the test
with cef.MessageLoop()/QuitMessageLoop() plus a watchdog task instead of looping
for a fixed duration.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
linesight and others added 3 commits July 10, 2026 23:31
Replace the --single-process / CFProcessPath workaround with the canonical CEF
macOS multi-process design so the unit tests run under the default cefpython
configuration.

- Build five process-specific "cefpython Helper*.app" bundles (generic, Alerts,
  GPU, Plugin, Renderer), each with a unique CFBundleIdentifier, from a shared
  helper-Info.plist.in template; drop the old flat subprocess Info.plist.
- Wire the runtime paths on macOS: browser_subprocess_path -> generic helper
  executable, main_bundle_path -> real NSBundle (else the packaged helper app)
  so every process shares a valid CEF BaseBundleID for Mach port rendezvous.
  Add main_bundle_path to CefSettings bindings and MacGetMainBundlePath().
- Sign staged code inside-out (framework --deep, modules, each helper --deep)
  and verify strictly; package the signed tree in build_distrib.py, validating
  the complete helper set. Stage/copy helpers in build.py and CMake install.
- Update the installer, PyInstaller hook/spec (framework + helper binaries,
  PyInstaller 6), screenshot example, chromectrl wrapper, docs and .gitignore
  for the helper-bundle layout; GetModuleDirectory() honors PyInstaller _MEIPASS.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
GitHub is deprecating the Node.js 20 runtime. Bump the flagged actions to their
first Node 24 major: checkout v4->v5, setup-python v5->v6, cache/cache-restore
v4->v5. upload-artifact is already on v7 (Node 24). GitHub-hosted runners meet
the required runner version (>= 2.327.1).

Also set the pull_request trigger to branches: ["master"] so the three workflow
files are byte-identical to the cefpython147 branch.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
CI intermittently failed test_main at check_auto_asserts ->
assertTrue(g_js_code_completed): the fixed run_message_loop() (200 x 10ms = 2s)
could end before the JavaScript bindings round-trip finished on a slow runner.
This is timing-dependent and can occur on any platform.

Replace the fixed-iteration loop with run_message_loop_until(condition), which
pumps MessageLoopWork() until the whole asynchronous flow has actually
completed (JS done, popup created and destroyed, DevTools shown then closed,
load progress 1.0, and every handler callback fired) or a generous timeout
elapses, turning a race into a clear assertion.

Also:
- close_devtools() retries via PostDelayedTask until ShowDevTools() has taken
  effect instead of assuming 800ms is always enough.
- After CloseBrowser(), wait for the browser registry entry to disappear before
  checking asserts and shutting down.
- Register cef.Shutdown() via addCleanup so an assertion/timeout failure still
  releases CEF and its child processes (idempotent with the explicit shutdown).

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@linesight

Copy link
Copy Markdown
Contributor Author

above test harness concern is fixed

@cztomczak

Copy link
Copy Markdown
Owner

I see lots of Chromium flags removed from unit tests e.g. disable-dev-shm-usage, disable-gpu and others. So is this not needed? How does it run currently under github CI?

@cztomczak

Copy link
Copy Markdown
Owner

I guess at some point you started using xvfb - so all these switches aren't required anymore?

@cztomczak

Copy link
Copy Markdown
Owner

It's best to run unit tests using default cefpython configuration, however I didn't state that this is a must for CI (although prefered to be as close to default configuration if possible). To be clear,my comment on unit tests was that the unit test scripts should use cefpython configuration as default, however I am aware that CI has limitations. But by just running "python main_test.py" it shouldn't use CI configuration as default - that was my point.

The main_test hardening added a pre-Shutdown wait for
GetBrowserByIdentifier(MAIN_BROWSER_ID) to return None. All five macOS jobs
timed out there even though the JavaScript, popup, DevTools and handler
callbacks had completed.

CloseBrowser(True) starts an asynchronous native close and does not guarantee
that a synchronously created macOS browser reaches OnBeforeClose before
Shutdown. This matches upstream CEF issues chromiumembedded/cef#3469 and
chromiumembedded/cef#3810. cefpython removes the browser from its registry in
OnBeforeClose, so registry disappearance is not a portable pre-Shutdown
condition.

Remove only that close wait and restore the existing 25-iteration
MessageLoopWork grace period. Keep the condition-driven pre-close completion
gate that fixes the original Windows Python 3.14 timing failure, and let
cef.Shutdown() perform its existing final browser cleanup.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@linesight

Copy link
Copy Markdown
Contributor Author

Linux CI was already using Xvfb before this cleanup. It currently runs:

xvfb-run python unittests/_test_runner.py

Xvfb only supplies the X11 display. The unit tests themselves do not detect CI or inject CI-specific Chromium switches. Flags such as disable-dev-shm-usage, in-process-gpu and no-zygote were troubleshooting leftovers and turned out not to be needed on the hosted runner.

@cztomczak

Copy link
Copy Markdown
Owner

Why is main_test_async_completed func inside _common.py? It's name even states that it is main test functionality, so it should be in main test.

Reviewer feedback: main_test_async_completed() is specific to main_test and
does not belong in the shared _common module.

Move the predicate into main_test.py. Add a generic is_js_code_completed()
accessor beside the shared state in _common.py so the existing wildcard import
can read the live rebound boolean without adding a duplicate module import.
The shared callback and assertion state remain available to both main_test and
osr_test.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@linesight

Copy link
Copy Markdown
Contributor Author

Why is main_test_async_completed func inside _common.py? It's name even states that it is main test functionality, so it should be in main test.

fixed

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants