add output.page()

Author: wang0618

docs/spec.rst

@@ -395,6 +395,23 @@ The ``spec`` fields of ``download`` commands:
 * name: str, File name when downloading
 * content: str, File content in base64 encoding.
 
+open_page
+^^^^^^^^^^^^^^^
+Open new page
+
+The ``spec`` fields of ``new_page`` commands:
+
+* page_id: str, page id to be created
+
+close_page
+^^^^^^^^^^^^^^^
+Close a page
+
+The ``spec`` fields of ``close_page`` commands:
+
+* page_id: str, page id to be closed
+
+
 Event
 ------------
 

pywebio/io_ctrl.py

@@ -214,7 +214,11 @@ def inner(*args, **kwargs):
 
 def send_msg(cmd, spec=None, task_id=None):
     msg = dict(command=cmd, spec=spec, task_id=task_id or get_current_task_id())
-    get_current_session().send_task_command(msg)
+    s = get_current_session()
+    page = s.get_page_id()
+    if page is not None:
+        msg['page'] = page
+    s.send_task_command(msg)
 
 
 def single_input_kwargs(single_input_return):

pywebio/output.py

@@ -72,6 +72,8 @@
 |                    | `popup`:sup:`*†`          | Show popup                                                 |
 |                    +---------------------------+------------------------------------------------------------+
 |                    | `close_popup`             | Close the current popup window.                            |
+|                    +---------------------------+------------------------------------------------------------+
+|                    | `page`                    | Open a new page.                                           |
 +--------------------+---------------------------+------------------------------------------------------------+
 | Layout and Style   | `put_row`:sup:`*†`        | Use row layout to output content                           |
 |                    +---------------------------+------------------------------------------------------------+
@@ -231,7 +233,7 @@
            'put_table', 'put_buttons', 'put_image', 'put_file', 'PopupSize', 'popup', 'put_button',
            'close_popup', 'put_widget', 'put_collapse', 'put_link', 'put_scrollable', 'style', 'put_column',
            'put_row', 'put_grid', 'span', 'put_processbar', 'set_processbar', 'put_loading',
-           'output', 'toast', 'get_scope', 'put_info', 'put_error', 'put_warning', 'put_success']
+           'output', 'toast', 'get_scope', 'put_info', 'put_error', 'put_warning', 'put_success', 'page']
 
 
 # popup size
@@ -1809,3 +1811,70 @@ async def coro_wrapper(*args, **kwargs):
             return coro_wrapper
         else:
             return wrapper
+
+
+def page(func=None):
+    """
+    Open a page. Can be used as context manager and decorator.
+
+    :Usage:
+
+    ::
+
+        with page() as scope_name:
+            input()
+            put_xxx()
+
+        @page()  # or @page
+        def content():
+            input()
+            put_xxx()
+    """
+
+    if func is None:
+        return page_()
+    return page_()(func)
+
+
+class page_:
+    page_id: str
+
+    def __enter__(self):
+        self.page_id = random_str(10)
+        send_msg('open_page', dict(page_id=self.page_id))
+        get_current_session().push_page(self.page_id)
+
+    def __exit__(self, exc_type, exc_val, exc_tb):
+        """
+        If this method returns True, it means that the context manager can handle the exception,
+        so that the with statement terminates the propagation of the exception
+        """
+        get_current_session().pop_page()
+        send_msg('close_page', dict(page_id=self.page_id))
+
+        # todo: catch Page Close Exception
+        return False  # Propagate Exception
+
+    def __call__(self, func):
+        """decorator implement"""
+
+        @wraps(func)
+        def wrapper(*args, **kwargs):
+            self.__enter__()
+            try:
+                return func(*args, **kwargs)
+            finally:
+                self.__exit__(None, None, None)
+
+        @wraps(func)
+        async def coro_wrapper(*args, **kwargs):
+            self.__enter__()
+            try:
+                return await func(*args, **kwargs)
+            finally:
+                self.__exit__(None, None, None)
+
+        if iscoroutinefunction(func):
+            return coro_wrapper
+        else:
+            return wrapper

pywebio/session/base.py

@@ -62,6 +62,7 @@ def __init__(self, session_info):
         self.internal_save = dict(info=session_info)  # some session related info, just for internal used
         self.save = {}  # underlying implement of `pywebio.session.data`
         self.scope_stack = defaultdict(lambda: ['ROOT'])  # task_id -> scope栈
+        self.page_stack = defaultdict(lambda: [])  # task_id -> page id
 
         self.deferred_functions = []  # 会话结束时运行的函数
         self._closed = False
@@ -94,6 +95,26 @@ def push_scope(self, name):
         task_id = type(self).get_current_task_id()
         self.scope_stack[task_id].append(name)
 
+    def get_page_id(self):
+        task_id = type(self).get_current_task_id()
+        if task_id not in self.page_stack:
+            return None
+        try:
+            return self.page_stack[task_id][-1]
+        except IndexError:
+            return None
+
+    def pop_page(self):
+        task_id = type(self).get_current_task_id()
+        try:
+            return self.page_stack[task_id].pop()
+        except IndexError:
+            raise ValueError("Internal Error: No page to exit") from None
+
+    def push_page(self, page_id):
+        task_id = type(self).get_current_task_id()
+        self.page_stack[task_id].append(page_id)
+
     def send_task_command(self, command):
         raise NotImplementedError
 

webiojs/src/handlers/base.ts

@@ -1,4 +1,5 @@
 import {Command, Session} from "../session";
+import {DeliverMessage} from "../models/page";
 
 
 export interface CommandHandler {
@@ -35,10 +36,13 @@ export class CommandDispatcher {
     }
 
     dispatch_message(msg: Command): boolean {
-        if (msg.command in this.command2handler) {
+        if (msg.page !== undefined && msg.page) {
+            DeliverMessage(msg);
+        } else if (msg.command in this.command2handler) {
             this.command2handler[msg.command].handle_message(msg);
-            return true;
+        } else {
+            return false
         }
-        return false
+        return true;
     }
 }

webiojs/src/handlers/page.ts

@@ -0,0 +1,18 @@
+import {Command} from "../session";
+import {CommandHandler} from "./base";
+import {ClosePage, OpenPage} from "../models/page";
+
+export class PageHandler implements CommandHandler {
+    accept_command: string[] = ['open_page', 'close_page'];
+
+    constructor() {
+    }
+
+    handle_message(msg: Command) {
+        if (msg.command === 'open_page') {
+            OpenPage(msg.spec.page_id);
+        } else if (msg.command === 'close_page') {
+            ClosePage(msg.spec.page_id);
+        }
+    }
+}

webiojs/src/main.ts

@@ -11,6 +11,7 @@ import {ToastHandler} from "./handlers/toast";
 import {EnvSettingHandler} from "./handlers/env";
 import {PinHandler} from "./handlers/pin";
 import {customMessage} from "./i18n"
+import {PageHandler} from "./handlers/page";
 
 // 获取后端API的绝对地址
 function backend_absaddr(addr: string) {
@@ -40,9 +41,10 @@ function set_up_session(webio_session: Session, output_container_elem: JQuery, i
     let download_ctrl = new DownloadHandler();
     let toast_ctrl = new ToastHandler();
     let env_ctrl = new EnvSettingHandler();
+    let page_ctrl = new PageHandler();
 
     let dispatcher = new CommandDispatcher(output_ctrl, input_ctrl, popup_ctrl, session_ctrl,
-        script_ctrl, download_ctrl, toast_ctrl, env_ctrl, pin_ctrl);
+        script_ctrl, download_ctrl, toast_ctrl, env_ctrl, pin_ctrl, page_ctrl);
 
     webio_session.on_server_message((msg: Command) => {
         try {

webiojs/src/models/page.ts

@@ -0,0 +1,32 @@
+// page id to page window reference
+import {Command, SubPageSession} from "../session";
+import {LazyPromise} from "../utils";
+
+let subpages: { [page_id: string]: Window } = {};
+
+
+export function OpenPage(page_id: string) {
+    if (page_id in subpages)
+        throw `Can't open page, the page id "${page_id}" is duplicated`;
+    subpages[page_id] = window.open(window.location.href);
+
+    // the `_pywebio_page` will be resolved in new opened page in `SubPageSession.start_session()`
+    // @ts-ignore
+    subpages[page_id]._pywebio_page = new LazyPromise()
+}
+
+export function ClosePage(page_id: string) {
+    if (!(page_id in subpages))
+        throw `Can't close page, the page (id "${page_id}") is not found`;
+    subpages[page_id].close()
+}
+
+export function DeliverMessage(msg: Command) {
+    if (!(msg.page in subpages))
+        throw `Can't deliver message, the page (id "${msg.page}") is not found`;
+    // @ts-ignore
+    subpages[msg.page]._pywebio_page.promise.then((page: SubPageSession) => {
+        msg.page = undefined;
+        page.server_message(msg);
+    });
+}

webiojs/src/session.ts

@@ -5,6 +5,7 @@ import {t} from "./i18n";
 export interface Command {
     command: string
     task_id: string
+    page: string,
     spec: any
 }
 
@@ -89,7 +90,7 @@ export class SubPageSession implements Session {
         safe_poprun_callbacks(this._session_create_callbacks, 'session_create_callback');
 
         // @ts-ignore
-        window._pywebio_page.promise.resolve(this);
+        window._pywebio_page.resolve(this);
     };
 
     // called by opener, transfer command to this session