Follow-up doc update for cefpython123 #678

linesight · 2025-02-18T07:15:45Z

This is a follow-up pull request for
#669

Most are doc update. Very small code update
src/extern/cef/cef_types.pxd
src/dpi_aware_win.pyx
are included

…pstream

Fixes: cztomczak#546 Had to include harfbuzz manually as newer Pango change this. See: eiskaltdcpp/eiskaltdcpp#413 https://gitlab.gnome.org/GNOME/pango/-/issues/387 Also had to add `-Wno-deprecated-declarations` to get this to compile because of the following errors that didn't seem to be coming from this code directly: warning: ‘GTimeVal’ is deprecated: Use 'GDateTime' instead warning: ‘GTypeDebugFlags’ is deprecated

…k#484). These callbacks were never called previously. Rename --no-run-examples flag to --unittests in build scripts.

… code at frame.pyx

…nd CanSaveCookie; restore network_cookies.py and make slight tweak to use CanSendCookie and CanSaveCookie

…ac.h

… is using complex iframe which is not good with cefpython javascript binding

Update CEF to version 123.0.7 with Chromium-123.0.6312.46 (Windows tested)

…f_types.pxd

cztomczak · 2025-02-18T11:53:55Z

README.md

@@ -55,7 +55,7 @@ Below is a table with supported platforms, python versions and architectures.

 OS | Py2 | Py3 | 32bit | 64bit | Requirements
 --- | --- | --- | --- | --- | ---
-Windows | 2.7 | 3.4 / 3.5 / 3.6 / 3.7 / 3.8 / 3.9 | Yes | Yes | Windows 7+ (Note that Python 3.9 supports Windows 8.1+)
+Windows | 2.7 | 3.4 / 3.5 / 3.6 / 3.7 / 3.8 / 3.9 / 3.10 / 3.11 | Yes | Yes | Windows 7+ (Note that Python 3.9 supports Windows 8.1+)


That OS table is in Install section and has instructions to use pip install cefpython3==66.1 which doesn't yet support 3.10 and 3.11.

cztomczak · 2025-02-18T11:56:52Z

docs/Migration-guide.md

+- removed `CanSetCookie`
+- added `CanSendCookie`
+- added `CanSaveCookie`


Let's mention CookieAccessFilter handler where new methods are, and also mention the old handler in which old cookie methods were.

cztomczak · 2025-02-18T12:00:13Z

docs/Migration-guide.md

+- added `CanSaveCookie`
+
+## v123+ LifeSpan Handler callback


Change the title to LifespanHandler.OnBeforePopup new param

Actually change it to LifespanHandler.OnBeforePopup changes and remove the section v123+ cef_types changed. Put information about the WOD_ constants changes here.

cztomczak · 2025-02-18T12:08:58Z

docs/Migration-guide.md

+
+Per https://github.com/chromiumembedded/cef/issues/3452 windows high-dpi support is now enabled
+You shouldn't normally need to use DpiAware class 


Change to:

## v123+ High DPI support changes DpiAware.EnableHighDpiSupport was removed on Windows. High-DPI support is now enabled by default in Chromium. It is recommended to embed a DPI awareness manifest in the subprocess executable, because setting process awareness during runtime is not always reliable.

cztomczak · 2025-02-18T12:13:13Z

docs/Migration-guide.md

+You shouldn't normally need to use DpiAware class 
+
+## v123+ plugin support is removed


We need proper sentences in documentation. Please start with an upper leter.

cztomczak · 2025-02-18T12:21:55Z

docs/Migration-guide.md

+As cef has removed plugin support https://github.com/chromiumembedded/cef/commit/28c7f040016a0271ec2612cc5021599fb55a1054
+previous popular plugin such as flash, pdf would no longer work
+`OnBeforePluginLoad` handler is removed


Please change to:
CEF has removed plugin support. RequestHandler.`_OnBeforePluginLoad` was removed. Flash plugin is not supported anymore.

Use similar style as in the rest of the document to reference handlers and callbacks.

PDF is supported in CEF via chrome extension. They removed PPAPI plugin support, so it only changed internal implementation for PDF. No need to get into these details in docs.

cztomczak · 2025-02-18T12:28:52Z

api/DpiAware.md

This whole document needs to be rewritten, as it is outdated and makes confusion.

Calling SetProcessDpiAware should generate DEPRECATED log message. Also this method's code should be removed and just leave a dummy method for backwards compatibility.

IsProcessDpiAware - remove from docs, but leave in code for BC (backwards compatibility).

Remove CalculateWindowSize from docs, but keep in code for BC.

Introduction section needs to be rewritten, as it's not true.

cztomczak · 2025-02-18T12:30:20Z

api/DpiAware.md

@@ -5,6 +5,8 @@

 Available only on Windows. All methods of this class are static, access them through [cefpython](cefpython.md).`WindowUtils`.

+Usage of this class is not encouraged, as upstream chromium is already support high-dpi by default


Remove that sentence. Scale and GetSystemDpi are still needed to set appropriate window sizes.

cztomczak · 2025-02-18T12:32:34Z

api/DpiAware.md

@@ -21,9 +23,6 @@ Table of contents:

 ## Introduction

-By default if DPI awareness is not enabled in application, then OS performs display scaling. That causes text to look blurry on high DPI displays. To resolve this you have to
- call `cef.DpiAware.EnableHighDpiSupport` method. High DPI support is available only on Windows.
-
 Enabling High DPI support in app can be done by embedding a DPI awareness xml manifest in both main executable and subprocess executable (see [Issue #112](../issues/112) comment #2), or by calling the `cef.DpiAware.EnableHighDpiSupport` method.


Add information that it is recommended to embed a DPI awareness manifeest in subprocess executable. If it's not embedded Chromium will set DPI awareness for processes during runtime, but it's not always reliable, so it's best to embed a manifest.

cztomczak · 2025-02-18T12:33:44Z

api/DpiAware.md

-latest CEF. This method now internally calls `EnableHighDpiSupport()`.
-
-Enables DPI awareness for the running process. Embedding a DPI manifest in .exe is the prefered way, as it gives more reliable results, otherwise some display bugs may appear (discussed in the "Introduction" section on this page).
+Calling this method is deprecated, it is a dummy function now.


Remove that method from docs. In code generate only a DEPRECATED warning log message and do not execute any code.

cztomczak · 2025-02-18T12:34:25Z

docs/Build-instructions.md

@@ -48,13 +47,13 @@ Before you can build CEF Python or CEF you must satisfy

 ## Quick build instructions for Windows

-Complete steps for building CEF Python v50+ with Python 2.7 using
+Complete steps for building CEF Python v123+ with Python 3.11 using


Keep it just Python 3.

cztomczak · 2025-02-18T12:34:52Z

docs/Build-instructions.md

 prebuilt binaries and libraries from GitHub Releases.

 When cloning repository you should checkout a stable branch which
 are named "cefpythonXX" where XX is Chromium version number.

-1) Tested and works fine on Windows 7 64-bit
+1) Tested and works fine on Windows 11 64-bit


Is Windows 10 not supported anymore?

windows 10 should still work. My personal machine was upgraded from win 10 to win 11 last year, so this proposed doc update is mostly reflecting my own environment. I don't have super strong preference whether to put win 10 or win 11 at this line, but knowning win 10 is ending support this year
https://learn.microsoft.com/en-us/lifecycle/products/windows-10-home-and-pro
For a future proof doc, I slightly prefer putting win 11 here

cztomczak · 2025-02-18T12:36:18Z

docs/Build-instructions.md

@@ -235,37 +234,6 @@ requirements common for all platforms.
  cefpython version to avoid issues.


-## Build using prebuilt CEF binaries and libraries


Why did you remove this?

As of this writing, there is nothing to download from

[GH releases](https://github.com/cztomczak/cefpython/tags)

for cefpython123. I don't know whether you would continue to support this style of build instruction or not. To be safe, I only include the build instruction that works

cztomczak · 2025-02-18T12:38:45Z

docs/Migration-guide.md

+* [v123+ cef_types changed](#v123-cef_types-changed)
+* [v123+ Windows dpiaware change](#v123-windows-dpiaware-change)
+* [v123+ plugin support is removed](#v123-plugin-support-is-removed)
+* [v123+ cookie related code is changed](#v123-cookie-related-code-is-changed)


See how other sections in this document are written and please use similar style and reference to handlers and callbacks.

cztomczak · 2025-02-18T12:39:59Z

docs/Migration-guide.md

+## v123+ Response's function `GetHeader` is renamed to `GetHeaderByName`
+
+## v123+ CookieManager's `GetBlockingManager`, `CreateManager` and `SetSupportedSchemes` functions are removed


See how other sections in Migration Guide document are named and continue using the same style and references.

cztomczak · 2025-02-18T12:44:04Z

The problem with this PR and the previous one PR is that it changes documentation, however official releases are still using CEF 66. So documentation is confusing. I have to rollback previous merge of cefpython123 PR.

SOLUTION: Create cefpython123 branch and send PR requests with code and documentation changes to that branch.

linesight · 2025-02-18T17:38:45Z

The problem with this PR and the previous one PR is that it changes documentation, however official releases are still using CEF 66. So documentation is confusing. I have to rollback previous merge of cefpython123 PR.

SOLUTION: Create cefpython123 branch and send PR requests with code and documentation changes to that branch.

The problem of your solution is, there is no way for pull requester to make a cefpython123 branch at your repository. This is especially true if we expect future pull request to support newer cef and more substantial doc update, such as cefpython124/cefpython133 etc. It is better to provide peace of mind for pull requester not to worry about the difference between documentation difference of official release and pull request destination branch. I can live with "send PR requests with code and documentation changes to that (cefpython123) branch", but need a long term guideline for future.

linesight and others added 30 commits January 27, 2024 20:59

py3 update for automate-git.py and automate.py

523362f

--disable-syntax-validation option at gclient has been removed from u…

5a5df95

…pstream

update spotify prebuilt cef url

92a6c69

fix

e8a5dc7

add support for cef 123 version

f49ab60

Fix CefListValue "int index" params (cztomczak#461).

24abdc3

getting partical fix from cztomczak@d6deaf8

5309afe

getting partical fix (part 2) from cztomczak@d6deaf8

0a6a22d

undo previous unittest change (partly)

daacb75

Fix V8ContextHandler.OnContextCreated and OnContextReleased (cztomcza…

748f104

…k#484). These callbacks were never called previously. Rename --no-run-examples flag to --unittests in build scripts.

add python311 support

cd70070

undo previous accidental change to common.py

e67aa83

update misc place for py311 support

2c8819c

better handle MainMessageLoopExternalPump, remove some previouis test…

af864f0

… code at frame.pyx

add mainframe validation at javascript_bindings.pyx

cffcf93

undo unexpected change to src/compile_time_constatns.pxi

b7aa32c

not use obsolete base/cef_ptr_util.h

ffbfdad

add back cef_mac.h and cef_linux.h

b3d38bc

address pull request feedback

615af96

restore previous language_level line at cython_setup.py

52edcd8

remove obsolete stuff

720782b

Merge branch 'master' into cefpython123

44fda11

delete previously commented code

3550c40

address pull request feedback

c68cb2e

delete previously commented code

cf1778b

update osr_test.py to respect current event data type

541f136

delete OnPluginCrashed; add initial implementation of CanSendCookie a…

c4c0806

…nd CanSaveCookie; restore network_cookies.py and make slight tweak to use CanSendCookie and CanSaveCookie

add back upstream cef 6312 branch's cef_types_linux.h and cef_types_m…

8286fb1

…ac.h

remove commented SendProcessMessage from cef_browser.pxd

099f5a1

linesight and others added 6 commits February 17, 2025 11:42

one more place to use str type for uniqueFrameId

eddbce1

bring back SendFocusEvent in browser.pyx for backward compatibility

db1d3ac

replace ondomread.py example using example.com, as google.com website…

1585ccf

… is using complex iframe which is not good with cefpython javascript binding

Merge pull request cztomczak#669 from linesight/cefpython123

12ef37c

Update CEF to version 123.0.7 with Chromium-123.0.6312.46 (Windows tested)

improve cefpython123 doc

9da9f3c

more doc cleanup; remove obsolete 'ignore_certificate_errors' from ce…

ec81ee2

…f_types.pxd

cztomczak reviewed Feb 18, 2025

View reviewed changes

cztomczak force-pushed the master branch from 12ef37c to 5217c04 Compare February 18, 2025 13:15

address pull request feedback

cda1015

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Follow-up doc update for cefpython123 #678

Follow-up doc update for cefpython123 #678

linesight commented Feb 18, 2025

cztomczak Feb 18, 2025 •

edited

Loading

cztomczak Feb 18, 2025

cztomczak Feb 18, 2025

cztomczak Feb 18, 2025

cztomczak Feb 18, 2025

cztomczak Feb 18, 2025

cztomczak Feb 18, 2025

cztomczak Feb 18, 2025

cztomczak Feb 18, 2025

cztomczak Feb 18, 2025

cztomczak Feb 18, 2025

cztomczak Feb 18, 2025

cztomczak Feb 18, 2025

linesight Feb 18, 2025

cztomczak Feb 18, 2025

linesight Feb 18, 2025

cztomczak Feb 18, 2025

cztomczak Feb 18, 2025

cztomczak commented Feb 18, 2025

linesight commented Feb 18, 2025


		Per https://github.com/chromiumembedded/cef/issues/3452 windows high-dpi support is now enabled
		You shouldn't normally need to use DpiAware class

		You shouldn't normally need to use DpiAware class

		## v123+ plugin support is removed

		@@ -5,6 +5,8 @@

		Available only on Windows. All methods of this class are static, access them through [cefpython](cefpython.md).`WindowUtils`.

		Usage of this class is not encouraged, as upstream chromium is already support high-dpi by default

		@@ -235,37 +234,6 @@ requirements common for all platforms.
		cefpython version to avoid issues.


		## Build using prebuilt CEF binaries and libraries

		## v123+ Response's function `GetHeader` is renamed to `GetHeaderByName`

		## v123+ CookieManager's `GetBlockingManager`, `CreateManager` and `SetSupportedSchemes` functions are removed

Follow-up doc update for cefpython123 #678

Are you sure you want to change the base?

Follow-up doc update for cefpython123 #678

Conversation

linesight commented Feb 18, 2025

cztomczak Feb 18, 2025 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

cztomczak commented Feb 18, 2025

linesight commented Feb 18, 2025

cztomczak Feb 18, 2025 •

edited

Loading