Repository navigation
Expand file tree
/
Copy pathscreenshot.py
More file actions
251 lines (217 loc) · 9.52 KB
/
Copy pathscreenshot.py
File metadata and controls
251 lines (217 loc) · 9.52 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
"""
Example of using CEF browser in off-screen rendering mode
(windowless) to create a screenshot of a web page. This
example doesn't depend on any third party GUI framework.
This example is discussed in Tutorial in the Off-screen
rendering section.
Before running this script you have to install Pillow image
library (PIL module):
pip install Pillow
With optionl arguments to this script you can resize viewport
so that screenshot includes whole page with height like 5000px
which would be an equivalent of scrolling down multiple pages.
By default when no arguments are provided will load cefpython
project page on Github with 5000px height.
Usage:
python screenshot.py
python screenshot.py https://github.com/cztomczak/cefpython 1024 5000
python screenshot.py https://www.google.com/ncr 1024 768
Tested configurations:
- CEF Python v57.0+
- Pillow 2.3.0 / 4.1.0
NOTE: There are limits in Chromium on viewport size. For some
websites with huge viewport size it won't work. In such
case it is required to reduce viewport size to an usual
size of a window and perform scrolling programmatically
using javascript while making a screenshot for each of
the scrolled region. Then at the end combine all the
screenshots into one. To force a paint event in OSR
mode call cef.Invalidate().
"""
from cefpython3 import cefpython as cef
import os
import platform
import subprocess
import sys
try:
from PIL import Image, __version__ as PILLOW_VERSION
except ImportError:
print("[screenshot.py] Error: PIL module not available. To install"
" type: pip install Pillow")
sys.exit(1)
# Config
URL = "https://github.com/cztomczak/cefpython"
VIEWPORT_SIZE = (1024, 5000)
SCREENSHOT_PATH = os.path.join(os.path.abspath(os.path.dirname(__file__)),
"screenshot.png")
def main():
check_versions()
sys.excepthook = cef.ExceptHook # To shutdown all CEF processes on error
if os.path.exists(SCREENSHOT_PATH):
print("[screenshot.py] Remove old screenshot")
os.remove(SCREENSHOT_PATH)
command_line_arguments()
# Off-screen-rendering requires setting "windowless_rendering_enabled"
# option.
settings = {
"windowless_rendering_enabled": True,
}
switches = {
# GPU acceleration is not supported in OSR mode, so must disable
# it using these Chromium switches (Issue #240 and #463)
"disable-gpu": "",
"disable-gpu-compositing": "",
}
if not sys.platform.startswith("darwin"):
# Tweaking OSR performance (Issue #240). On macOS ARM the viz
# Surfaces API is required for OSR browser creation, so these
# switches must not be passed on macOS.
switches["enable-begin-frame-scheduling"] = ""
switches["disable-surfaces"] = "" # This is required for PDF ext to work
browser_settings = {
# Tweaking OSR performance (Issue #240)
"windowless_frame_rate": 30, # Default frame rate in CEF is 30
}
cef.Initialize(settings=settings, switches=switches)
create_browser(browser_settings)
cef.MessageLoop()
cef.Shutdown()
print("[screenshot.py] Opening screenshot with default application")
open_with_default_application(SCREENSHOT_PATH)
def check_versions():
ver = cef.GetVersion()
print("[screenshot.py] CEF Python {ver}".format(ver=ver["version"]))
print("[screenshot.py] Chromium {ver}".format(ver=ver["chrome_version"]))
print("[screenshot.py] CEF {ver}".format(ver=ver["cef_version"]))
print("[screenshot.py] Python {ver} {arch}".format(
ver=platform.python_version(),
arch=platform.architecture()[0]))
print("[screenshot.py] Pillow {ver}".format(ver=PILLOW_VERSION))
assert tuple(int(x) for x in cef.__version__.split(".")) >= (57, 0), "CEF Python v57.0+ required to run this"
def command_line_arguments():
if len(sys.argv) == 4:
url = sys.argv[1]
width = int(sys.argv[2])
height = int(sys.argv[3])
if url.startswith("http://") or url.startswith("https://"):
global URL
URL = url
else:
print("[screenshot.py] Error: Invalid url argument")
sys.exit(1)
if width > 0 and height > 0:
global VIEWPORT_SIZE
VIEWPORT_SIZE = (width, height)
else:
print("[screenshot.py] Error: Invalid width and height")
sys.exit(1)
elif len(sys.argv) > 1:
print("[screenshot.py] Error: Expected arguments: url width height")
sys.exit(1)
def create_browser(settings):
# Create browser in off-screen-rendering mode (windowless mode)
# by calling SetAsOffscreen method. In such mode parent window
# handle can be NULL (0).
parent_window_handle = 0
window_info = cef.WindowInfo()
window_info.SetAsOffscreen(parent_window_handle)
print("[screenshot.py] Viewport size: {size}"
.format(size=str(VIEWPORT_SIZE)))
print("[screenshot.py] Loading url: {url}"
.format(url=URL))
browser = cef.CreateBrowserSync(window_info=window_info,
settings=settings,
url=URL)
print('created browser ', browser)
browser.SetClientHandler(LoadHandler())
browser.SetClientHandler(RenderHandler())
browser.SetFocus(True)
# You must call WasResized at least once to let know CEF that
# viewport size is available and that OnPaint may be called.
browser.WasResized()
def save_screenshot(browser):
# Browser object provides GetUserData/SetUserData methods
# for storing custom data associated with browser. The
# "OnPaint.buffer_string" data is set in RenderHandler.OnPaint.
buffer_string = browser.GetUserData("OnPaint.buffer_string")
if not buffer_string:
raise Exception("buffer_string is empty, OnPaint never called?")
image = Image.frombytes("RGBA", VIEWPORT_SIZE, buffer_string,
"raw", "RGBA", 0, 1)
image.save(SCREENSHOT_PATH, "PNG")
print("[screenshot.py] Saved image: {path}".format(path=SCREENSHOT_PATH))
# See comments in exit_app() why PostTask must be used
cef.PostTask(cef.TID_UI, exit_app, browser)
def open_with_default_application(path):
if sys.platform.startswith("darwin"):
subprocess.call(("open", path))
elif os.name == "nt":
# noinspection PyUnresolvedReferences
os.startfile(path)
elif os.name == "posix":
subprocess.call(("xdg-open", path))
def exit_app(browser):
# Important note:
# Do not close browser nor exit app from OnLoadingStateChange
# OnLoadError or OnPaint events. Closing browser during these
# events may result in unexpected behavior. Use cef.PostTask
# function to call exit_app from these events.
print("[screenshot.py] Close browser and exit app")
browser.CloseBrowser()
cef.QuitMessageLoop()
class LoadHandler(object):
def OnLoadingStateChange(self, browser, is_loading, **_):
"""Called when the loading state has changed."""
if not is_loading:
# Loading is complete
sys.stdout.write(os.linesep)
print("[screenshot.py] Web page loading is complete")
print("[screenshot.py] Will save screenshot in 2 seconds")
# Give up to 2 seconds for the OnPaint call. Most of the time
# it is already called, but sometimes it may be called later.
cef.PostDelayedTask(cef.TID_UI, 2000, save_screenshot, browser)
def OnLoadError(self, browser, frame, error_code, failed_url, **_):
"""Called when the resource load for a navigation fails
or is canceled."""
if not frame.IsMain():
# We are interested only in loading main url.
# Ignore any errors during loading of other frames.
return
print("[screenshot.py] ERROR: Failed to load url: {url}"
.format(url=failed_url))
print("[screenshot.py] Error code: {code}"
.format(code=error_code))
# See comments in exit_app() why PostTask must be used
cef.PostTask(cef.TID_UI, exit_app, browser)
class RenderHandler(object):
def __init__(self):
self.OnPaint_called = False
def GetViewRect(self, rect_out, **_):
"""Called to retrieve the view rectangle which is relative
to screen coordinates. Return True if the rectangle was
provided."""
# rect_out --> [x, y, width, height]
rect_out.extend([0, 0, VIEWPORT_SIZE[0], VIEWPORT_SIZE[1]])
return True
def OnPaint(self, browser, element_type, paint_buffer, **_):
"""Called when an element should be painted."""
if self.OnPaint_called:
sys.stdout.write(".")
sys.stdout.flush()
else:
sys.stdout.write("[screenshot.py] OnPaint")
self.OnPaint_called = True
if element_type == cef.PET_VIEW:
# Buffer string is a huge string, so for performance
# reasons it would be better not to copy this string.
# I think that Python makes a copy of that string when
# passing it to SetUserData.
buffer_string = paint_buffer.GetBytes(mode="rgba",
origin="top-left")
# Browser object provides GetUserData/SetUserData methods
# for storing custom data associated with browser.
browser.SetUserData("OnPaint.buffer_string", buffer_string)
else:
raise Exception("Unsupported element_type in OnPaint")
if __name__ == '__main__':
main()