API categories | API index

Functions in the cefpython module.

Table of contents:

• Functions
  • CreateBrowser
  • CreateBrowserSync
  • ExceptHook
  • GetAppSetting
  • GetAppPath
  • GetBrowserByWindowHandle
  • GetCommandLineSwitch
  • GetGlobalClientCallback
  • GetModuleDirectory
  • GetVersion
  • Initialize
  • IsThread
  • MessageLoop
  • MessageLoopWork
  • PostTask
  • PostDelayedTask
  • QuitMessageLoop
  • SetGlobalClientCallback
  • SetOsModalLoop
  • Shutdown

Not yet implemented - currently this method just calls CreateBrowserSync. In upstream CEF this method creates browser asynchronously. Currently CEF Python depends on browser being created synchronously in a few parts of code.

All parameters are optional.

This function can only be called on the UI thread.

The "window_title" parameter will be used only when parent window provided in window_info was set to 0. This is for use with hello_world.py and tutorial.py examples which don't use any third party GUI framework for creation of top-level window.

After the call to CreateBrowserSync() the page is not yet loaded, if you want your next lines of code to do some stuff on the webpage you will have to implement LoadHandler.OnLoadingStateChange callback.

Global except hook to exit app cleanly on error. CEF has a multiprocess architecture and when exiting you need to close all processes (main Browser process, Renderer process, GPU process, etc.) by calling Shutdown(). This hook does the following: in case of exception write it to the "error.log" file, display it to the console, shutdown CEF and exit application immediately by ignoring "finally" (_exit()).

See also Tutorial: Handling Python exceptions.

Returns ApplicationSettings option that was passed to Initialize(). Returns None if key is not found.

Get path to where application resides.

Get browser by outer or inner window handle. An outer window handle is the one that was passed to CreateBrowserSync(). An inner window handle is a CEF internal window handle.

Returns the CommandLineSwitches switch that was passed to Initialize(). Returns None if key is not found.

Returns a global client callback that was set using SetGlobalClientCallback(). Returns None if callback was not set.

Get the cefpython module directory. This method is useful to get full path to CEF binaries. This is required when setting ApplicationSettings options like: 'browser_subprocess_path', 'resources_dir_pat' and 'locales_dir_path'.

Return CEF Python and CEF versions dictionary with keys:

• version
• chrome_version
• cef_version
• cef_api_hash_platform
• cef_api_hash_universal
• cef_commit_hash
• cef_commit_number