add pin.get_pin_values()

Author: wang0618

docs/spec.rst

@@ -271,12 +271,14 @@ Unique attributes of different types:
   * template:
   * data:
 
-pin_value
+pin_values
 ^^^^^^^^^^^^^^^
 
-The ``spec`` fields of ``pin_value`` commands:
+Get the value of the pin widgets. The ``spec`` fields of ``pin_values`` commands:
 
-* name
+* names: list, The names of the pin widget
+
+The client will respond with a ``js_yield`` event, with the data field containing ``{ pin_name: pin_value, ... }``
 
 pin_update
 ^^^^^^^^^^^^^^^

pywebio/pin.py

@@ -118,6 +118,7 @@
     Use `pin.pin.use_strict()` to enable strict mode for getting pin widget value.
     An ``AssertionError`` will be raised when try to get value of pin widgets that are currently not in the page.
 
+.. autofunction:: get_pin_values
 .. autofunction:: pin_wait_change
 .. autofunction:: pin_update
 .. autofunction:: pin_on_change
@@ -137,7 +138,7 @@
 _pin_name_chars = set(string.ascii_letters + string.digits + '_-')
 
 __all__ = ['put_input', 'put_textarea', 'put_select', 'put_checkbox', 'put_radio', 'put_slider', 'put_actions',
-           'put_file_upload', 'pin', 'pin_update', 'pin_wait_change', 'pin_on_change']
+           'put_file_upload', 'pin', 'pin_update', 'pin_wait_change', 'pin_on_change', 'get_pin_values']
 
 
 def _pin_output(single_input_return, scope, position):
@@ -258,11 +259,32 @@ def get_client_val():
 
 
 @chose_impl
-def get_pin_value(name, strict):
-    send_msg('pin_value', spec=dict(name=name))
+def _get_pin_value(name, strict):
+    send_msg('pin_values', spec=dict(names=[name]))
     data = yield get_client_val()
-    assert not strict or data, 'pin widget "%s" doesn\'t exist.' % name
-    return (data or {}).get('value')
+    if strict:
+        assert name in data, 'pin widget "%s" doesn\'t exist.' % name
+    return data.get(name)
+
+
+@chose_impl
+def _get_pin_values(names: list[str]):
+    send_msg('pin_values', spec=dict(names=names))
+    data = yield get_client_val()
+    return data
+
+
+def get_pin_values(names: list[str]) -> dict[str, Any]:
+    """
+    Get the value of multiple pin widgets.
+    Compared to using the :data:`pin` object to get the value of the pin widget one by one,
+    this function can get the value of multiple pin widgets at once and is more efficient
+    when getting the value of multiple pin widgets.
+
+    :return: A dict, the key is the name of the pin widget, and the value is the value of the pin widget.
+       If the pin widget does not exist, the dict will not contain the corresponding key.
+    """
+    return _get_pin_values(names)
 
 
 class Pin_:
@@ -283,7 +305,7 @@ def __getattr__(self, name: str):
 
     def __getitem__(self, name: str):
         check_dom_name_value(name, 'pin `name`')
-        return get_pin_value(name, self._strict)
+        return _get_pin_value(name, self._strict)
 
     def __setattr__(self, name: str, value):
         """

webiojs/src/handlers/pin.ts

@@ -1,6 +1,6 @@
 import {ClientEvent, Command, Session} from "../session";
 import {CommandHandler} from "./base";
-import {GetPinValue, PinChangeCallback, PinUpdate, WaitChange, IsFileInput} from "../models/pin";
+import {GetPinValues, PinChangeCallback, PinUpdate, WaitChange, IsFileInput} from "../models/pin";
 import {state} from "../state";
 import {serialize_file, serialize_json} from "../utils";
 import {t} from "../i18n";
@@ -9,18 +9,19 @@ import {t} from "../i18n";
 export class PinHandler implements CommandHandler {
     session: Session;
 
-    accept_command = ['pin_value', 'pin_update', 'pin_wait', 'pin_onchange'];
+    accept_command = ['pin_values', 'pin_update', 'pin_wait', 'pin_onchange'];
 
     constructor(session: Session) {
         this.session = session;
     }
 
     handle_message(msg: Command) {
-        if (msg.command === 'pin_value') {
-            let val = GetPinValue(msg.spec.name);  // undefined or value
+        if (msg.command === 'pin_values') {
+            let values = GetPinValues(msg.spec.names);
             let send_msg = {
-                event: "js_yield", task_id: msg.task_id,
-                data: val === undefined ? null : {value: val}
+                event: "js_yield", 
+                task_id: msg.task_id,
+                data: values
             };
             this.submit(send_msg, IsFileInput(msg.spec.name));
         } else if (msg.command === 'pin_update') {

webiojs/src/models/pin.ts

@@ -12,12 +12,22 @@ export function IsFileInput(name: string): boolean {
     return name2input[name] !== undefined && name2input[name].spec.type == "file";
 }
 
-export function GetPinValue(name: string) {
+function _getPinValue(name: string) {
     if (name2input[name] == undefined || !document.contains(name2input[name].element[0]))
         return undefined;
     return name2input[name].get_value();
 }
 
+export function GetPinValues(names: string[]) {
+    let values: { [k: string]: any } = {};
+    for (let name of names) {
+        let val = _getPinValue(name);
+        if (val !== undefined)
+            values[name] = val;
+    }
+    return values;
+}
+
 export function PinUpdate(name: string, attributes: { [k: string]: any }) {
     name2input[name].update_input({attributes: attributes});
 }