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 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574
|
from __future__ import annotations
import inspect
import logging
import os
from collections.abc import Mapping, Sequence
from enum import Flag, auto
from functools import wraps
from threading import Lock
from typing import Any, Callable, TypeVar
from urllib.parse import urljoin
from uuid import uuid1
from typing_extensions import Any, Concatenate, ParamSpec, TypeAlias
import webview.http as http
from webview.errors import JavascriptException, WebViewException
from webview.event import Event, EventContainer
from webview.localization import original_localization
from webview.menu import Menu
from webview.util import (base_uri, escape_string, is_app, is_local_url, parse_file_type)
from webview.dom.dom import DOM
from webview.dom.element import Element
from webview.screen import Screen
from webview.state import State
P = ParamSpec('P')
T = TypeVar('T')
logger = logging.getLogger('pywebview')
def _api_call(function: WindowFunc[P, T], event_type: str) -> WindowFunc[P, T]:
"""
Decorator to call a pywebview API, checking for _webview_ready and raisings
appropriate Exceptions on failure.
"""
@wraps(function)
def wrapper(self: Window, *args: P.args, **kwargs: P.kwargs) -> T:
event = getattr(self.events, event_type)
try:
if not event.wait(20):
raise WebViewException('Main window failed to start')
if self.gui is None:
raise WebViewException('GUI is not initialized')
return function(self, *args, **kwargs)
except NameError:
raise WebViewException('Create a web view window first, before invoking this function')
return wrapper
def _shown_call(function: Callable[P, T]) -> Callable[P, T]:
return _api_call(function, 'shown')
def _loaded_call(function: Callable[P, T]) -> Callable[P, T]:
return _api_call(function, 'loaded')
def _before_load_call(function: Callable[P, T]) -> Callable[P, T]:
return _api_call(function, 'before_load')
def _pywebview_ready_call(function: Callable[P, T]) -> Callable[P, T]:
return _api_call(function, '_pywebviewready')
class FixPoint(Flag):
NORTH = auto()
WEST = auto()
EAST = auto()
SOUTH = auto()
class Window:
def __init__(
self,
uid: str,
title: str,
url: str | None,
html: str = '',
width: int = 800,
height: int = 600,
x: int | None = None,
y: int | None = None,
resizable: bool = True,
fullscreen: bool = False,
min_size: tuple[int, int] = (200, 100),
hidden: bool = False,
frameless: bool = False,
easy_drag: bool = True,
shadow: bool = True,
focus: bool = True,
minimized: bool = False,
maximized: bool = False,
on_top: bool = False,
confirm_close: bool = False,
background_color: str = '#FFFFFF',
js_api: Any = None,
text_select: bool = False,
transparent: bool = False,
zoomable: bool = False,
draggable: bool = False,
vibrancy: bool = False,
menu: list[Menu] = [],
localization: Mapping[str, str] | None = None,
http_port: int | None = None,
server: type[http.ServerType] | None = None,
server_args: http.ServerArgs = {},
screen: Screen = None
) -> None:
self.uid = uid
self._title = title
self.original_url = None if html else url # original URL provided by user
self.real_url = None
self.html = html
self.initial_width = width
self.initial_height = height
self.initial_x = x
self.initial_y = y
self.resizable = resizable
self.fullscreen = fullscreen
self.min_size = min_size
self.confirm_close = confirm_close
self.background_color = background_color
self.text_select = text_select
self.frameless = frameless
self.easy_drag = easy_drag
self.shadow = shadow
self.focus = focus
self.hidden = hidden
self.on_top = on_top
self.minimized = minimized
self.maximized = maximized
self.transparent = transparent
self.zoomable = zoomable
self.draggable = draggable
self.localization_override = localization
self.vibrancy = vibrancy
self.screen = screen
self.menu = menu
# Server config
self._http_port = http_port
self._server = server
self._server_args = server_args
# HTTP server path magic
self._url_prefix = None
self._common_path = None
self._server = None
self._js_api = js_api
self._functions: dict[str, Callable[..., Any]] = {}
self._callbacks: dict[str, Callable[..., Any] | None] = {}
self.events = EventContainer()
self.events.closed = Event(self)
self.events.closing = Event(self, True)
self.events.loaded = Event(self)
self.events.before_load = Event(self, True)
self.events.before_show = Event(self, True)
self.events.initialized = Event(self, True)
self.events.shown = Event(self)
self.events.minimized = Event(self)
self.events.maximized = Event(self)
self.events.restored = Event(self)
self.events.resized = Event(self)
self.events.moved = Event(self)
self.events.request_sent = Event(self)
self.events.response_received = Event(self)
self.events._pywebviewready = Event(self)
self._expose_lock = Lock()
self.dom = DOM(self)
self.gui = None
self.native = None # set in the gui after window creation
self._state = State(self)
def _initialize(self, gui, server: http.BottleServer | None = None, server_args: http.ServerArgs = dict):
self.gui = gui
self.localization = original_localization.copy()
if self.localization_override:
self.localization.update(self.localization_override)
if is_app(self.original_url) and (server is None or server == http.global_server):
*_, server = http.start_server(
urls=[self.original_url],
http_port=self._http_port,
server=self._server,
**(self._server_args or server_args),
)
elif server is None:
server = http.global_server
self._url_prefix = server.address if not server is None else None
self._common_path = server.common_path if not server is None else None
self._server = server
self.js_api_endpoint = (
http.global_server.js_api_endpoint if not http.global_server is None else None
)
self.real_url = self._resolve_url(self.original_url)
abort = self.events.initialized.set(gui.renderer)
return not abort
@property
def width(self) -> int:
self.events.shown.wait(15)
width, _ = self.gui.get_size(self.uid)
return width
@property
def height(self) -> int:
self.events.shown.wait(15)
_, height = self.gui.get_size(self.uid)
return height
@property
def state(self) -> State:
return self._state
@state.setter
def state(self, state: State) -> None:
if not isinstance(state, State):
raise TypeError('State must be an instance of State class')
self._state = state
@property
def title(self) -> str:
return self._title
@title.setter
def title(self, title: str) -> None:
self.events.loaded.wait(15)
self._title = title
self.gui.set_title(title, self.uid)
@property
def x(self) -> int:
self.events.shown.wait(15)
x, _ = self.gui.get_position(self.uid)
return x
@property
def y(self) -> int:
self.events.shown.wait(15)
_, y = self.gui.get_position(self.uid)
return y
@property
def on_top(self) -> bool:
return self.__on_top
@on_top.setter
def on_top(self, on_top: bool) -> None:
self.__on_top = on_top
if hasattr(self, 'gui') and self.gui != None:
self.gui.set_on_top(self.uid, on_top)
@_shown_call
def load_url(self, url: str) -> None:
"""
Load a new URL into a previously created WebView window. This function must be invoked after WebView windows is
created with create_window(). Otherwise an exception is thrown.
:param url: url to load
:param uid: uid of the target instance
"""
if ((self._server is None) or (not self._server.running)) and (
(is_app(url) or is_local_url(url))
):
self._url_prefix, self._common_path, self.server = http.start_server([url])
self.real_url = self._resolve_url(url)
self.events.loaded.clear()
self.events.before_load.clear()
self.events._pywebviewready.clear()
logger.debug(f'Loading URL: {self.real_url}')
self.gui.load_url(self.real_url, self.uid)
@_shown_call
def load_html(self, html: str, base_uri: str = base_uri()) -> None:
"""
Load a new HTML content into a previously created WebView window. This function must be invoked after WebView windows is
created with create_window(). Otherwise an exception is thrown.
:param html: HTML content to load.
:param base_uri: Base URI for resolving links. Default is the directory of the application entry point.
"""
self.events.loaded.clear()
self.events.before_load.clear()
self.events._pywebviewready.clear()
logger.debug(f'Loading HTML: {html[:30]}')
self.gui.load_html(html, base_uri, self.uid)
@_loaded_call
def load_css(self, stylesheet: str) -> None:
""""
Load a CSS stylesheet into the current web view window
"""
sanitized_css = stylesheet.replace('\n', '').replace('\r', '').replace('"', "'")
js_code = f'pywebview._loadCss("{sanitized_css}")'
self.run_js(js_code)
@_shown_call
def set_title(self, title: str) -> None:
"""
Set a new title of the window
"""
self._title = title
self.gui.set_title(title, self.uid)
@_loaded_call
def clear_cookies(self):
"""
Clear all the cookies
"""
return self.gui.clear_cookies(self.uid)
@_loaded_call
def get_cookies(self):
"""
Get cookies for the current website
"""
return self.gui.get_cookies(self.uid)
@_loaded_call
def get_current_url(self) -> str | None:
"""
Get the URL currently loaded in the target webview
"""
return self.gui.get_current_url(self.uid)
@_shown_call
def destroy(self) -> None:
"""
Destroy a web view window
"""
self.gui.destroy_window(self.uid)
@_shown_call
def show(self) -> None:
"""
Show a web view window.
"""
self.gui.show(self.uid)
@_shown_call
def hide(self) -> None:
"""
Hide a web view window.
"""
self.gui.hide(self.uid)
@_shown_call
def set_window_size(self, width: int, height: int) -> None:
"""
Resize window
:param width: desired width of target window
:param height: desired height of target window
"""
logger.warning(
'This function is deprecated and will be removed in future releases. Use resize() instead'
)
self.resize(width, height)
@_shown_call
def resize(
self, width: int, height: int, fix_point: FixPoint = FixPoint.NORTH | FixPoint.WEST
) -> None:
"""
Resize window
:param width: desired width of target window
:param height: desired height of target window
:param fix_point: Fix window to specified point during resize.
Must be of type FixPoint. Different points can be combined
with bitwise operators.
Example: FixPoint.NORTH | FixPoint.WEST
"""
self.gui.resize(width, height, self.uid, fix_point)
@_shown_call
def maximize(self) -> None:
"""
Maximize window.
"""
self.gui.maximize(self.uid)
@_shown_call
def minimize(self) -> None:
"""
Minimize window.
"""
self.gui.minimize(self.uid)
@_shown_call
def restore(self) -> None:
"""
Restore minimized window.
"""
self.gui.restore(self.uid)
@_shown_call
def toggle_fullscreen(self) -> None:
"""
Toggle fullscreen mode
"""
self.gui.toggle_fullscreen(self.uid)
@_shown_call
def move(self, x: int, y: int) -> None:
"""
Move Window
:param x: desired x coordinate of target window
:param y: desired y coordinate of target window
"""
self.gui.move(x, y, self.uid)
@_before_load_call
def run_js(self, script: str) -> Any:
"""
Run JavaScript code as is without any modifications. Result of the code is
not guaranteed to be returned and depends on the platform
:param script: JavaScript code to run
"""
return self.gui.evaluate_js(script, self.uid, False)
@_pywebview_ready_call
def evaluate_js(self, script: str, callback: Callable[..., Any] | None = None) -> Any:
"""
Evaluate given JavaScript code and return the result. The code is executed in eval statement
in order to support returning the last evaluated value in the script without the return statement.
Promises are supported and resolved values are returned to the callback function.
Exceptions are caught and rethrown as JavascriptException in Python code. Javascript code is
evaluated synchronously and the result is returned to the caller.
:param script: The JavaScript code to be evaluated
:callback: Optional callback function that will be called for resolved promises
:return: Return value of the evaluated code
"""
unique_id = uuid1().hex
self._callbacks[unique_id] = callback
if self.gui.renderer == 'cef':
return_result = f'window.external.return_result(pywebview.stringify(value), "{unique_id}");'
elif self.gui.renderer == 'android-webkit':
return_result = 'return pywebview.stringify(value);'
else:
return_result = 'pywebview.stringify(value);'
if callback:
escaped_script = f"""
var value = eval("{escape_string(script)}");
if (pywebview._isPromise(value)) {{
value.then(function evaluate_async(result) {{
pywebview._asyncCallback(pywebview.stringify(result), "{unique_id}")
}}).catch(function evaluate_async(error) {{
pywebview._asyncCallback(pywebview.stringify(error), "{unique_id}")
}});
"true";
}} else {{ {return_result} }}
"""
else:
escaped_script = f"""
var value;
try {{
value = eval("{escape_string(script)}");
}} catch (e) {{
value = {{
name: e.name,
pywebviewJavascriptError420: true,
}}
var keys = Object.getOwnPropertyNames(e);
keys.forEach(function(key) {{ value[key] = e[key] }})
}}
{return_result};
"""
if self.gui.renderer == 'cef':
result = self.gui.evaluate_js(escaped_script, self.uid, True, unique_id)
elif self.gui.renderer == 'android-webkit':
escaped_script = f"""
(function() {{
{escaped_script}
}})()
"""
result = self.gui.evaluate_js(escaped_script, self.uid, True)
else:
result = self.gui.evaluate_js(escaped_script, self.uid, True)
if isinstance(result, dict) and result.get('pywebviewJavascriptError420'):
del result['pywebviewJavascriptError420']
raise JavascriptException(result)
else:
return result
@_shown_call
def create_confirmation_dialog(self, title: str, message: str) -> bool:
"""
Create a confirmation dialog
:param title: Dialog title
:param message: Dialog detail message
:return: True for OK, False for Cancel
"""
return self.gui.create_confirmation_dialog(title, message, self.uid)
@_shown_call
def create_file_dialog(
self,
dialog_type: int = 10,
directory: str = '',
allow_multiple: bool = False,
save_filename: str = '',
file_types: Sequence[str] = tuple(),
) -> Sequence[str] | None:
"""
Create a file dialog
:param dialog_type: Dialog type: open file (FileDialog.OPEN), save file (FileDialog.SAVE), open folder (FileDialog.OPEN). Default
is open file.
:param directory: Initial directory
:param allow_multiple: Allow multiple selection. Default is false.
:param save_filename: Default filename for save file dialog.
:param file_types: Allowed file types in open file dialog. Should be a tuple of strings in the format:
filetypes = ('Description (*.extension[;*.extension[;...]])', ...)
:return: A tuple of selected files, None if cancelled.
"""
for f in file_types:
parse_file_type(f)
if not os.path.exists(directory):
directory = ''
return self.gui.create_file_dialog(
dialog_type, directory, allow_multiple, save_filename, file_types, self.uid
)
def expose(self, *functions: Callable[..., Any]) -> None:
if not all(map(callable, functions)):
raise TypeError('Parameter must be a function')
func_list: list[dict[str, Any]] = []
with self._expose_lock:
for func in functions:
name = func.__name__
self._functions[name] = func
params = list(inspect.getfullargspec(func).args)
func_list.append({'func': name, 'params': params})
if self.events.loaded.is_set():
self.run_js(f'window.pywebview._createApi({func_list})')
def _resolve_url(self, url: str) -> str | None:
if is_app(url):
return self._url_prefix
if is_local_url(url) and self._url_prefix and self._common_path is not None:
filename = os.path.relpath(url, self._common_path)
return urljoin(self._url_prefix, filename)
else:
return url
WindowFunc: TypeAlias = Callable[Concatenate[Window, P], T]
|