"""从浏览器接收用户输入
本模块提供了一系列函数来从浏览器接收用户不同的形式的输入
输入函数大致分为两类,一类是单项输入::
name = input("What's your name")
print("Your name is %s" % name)
另一类是使用 `input_group` 的输入组::
info = input_group("User info",[
input('Input your name', name='name'),
input('Input your age', name='age', type=NUMBER)
])
print(info['name'], info['age'])
输入组中需要在每一项输入函数中提供 ``name`` 参数来用于在结果中标识不同输入项.
.. note::
PyWebIO 根据是否在输入函数中传入 ``name`` 参数来判断输入函数是在 `input_group` 中还是被单独调用。
所以当你想要单独调用一个输入函数时,请不要设置 ``name`` 参数;而在 `input_group` 中调用输入函数时,**务必提供** ``name`` 参数
输入默认可以忽略,如果需要用户必须提供值,则需要在输入函数中传入 ``required=True`` ( ``checkbox()` 和 `acrions()` 不支持 ``required`` 参数)
"""
import logging
from base64 import b64decode
from collections.abc import Mapping
from functools import partial
from .io_ctrl import single_input, input_control, output_register_callback
from .session import get_current_session, get_current_task_id
from .utils import Setter
logger = logging.getLogger(__name__)
TEXT = 'text'
NUMBER = "number"
FLOAT = "float"
PASSWORD = "password"
URL = "url"
DATE = "date"
TIME = "time"
CHECKBOX = 'checkbox'
RADIO = 'radio'
SELECT = 'select'
TEXTAREA = 'textarea'
__all__ = ['TEXT', 'NUMBER', 'FLOAT', 'PASSWORD', 'URL', 'DATE', 'TIME', 'input', 'textarea', 'select',
'checkbox', 'radio', 'actions', 'file_upload', 'input_group']
def _parse_args(kwargs, excludes=()):
"""处理传给各类输入函数的原始参数
- excludes: 排除的参数
- 对为None的参数忽略处理
:return:(spec参数,valid_func)
"""
kwargs = {k: v for k, v in kwargs.items() if v is not None and k not in excludes}
kwargs.update(kwargs.get('other_html_attrs', {}))
kwargs.pop('other_html_attrs', None)
valid_func = kwargs.pop('valid_func', lambda _: None)
return kwargs, valid_func
def input(label='', type=TEXT, *, valid_func=None, name=None, value=None, placeholder=None, required=None,
readonly=None, datalist=None, help_text=None, **other_html_attrs):
r"""文本输入
:param str label: 输入框标签
:param str type: 输入类型. 可使用的常量:`TEXT` , `NUMBER` , `FLOAT` , `PASSWORD` , `URL` , `DATE` , `TIME`
其中 `DATE` , `TIME` 类型在某些浏览器上不被支持,详情见 https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#Browser_compatibility
:param Callable valid_func: 输入值校验函数. 如果提供,当用户输入完毕或提交表单后校验函数将被调用.
``valid_func`` 接收输入值作为参数,当输入值有效时,返回 ``None`` ,当输入值无效时,返回错误提示字符串. 比如::
def check_age(age):
if age>30:
return 'Too old'
elif age<10:
return 'Too young'
input('Input your age', type=NUMBER, valid_func=check_age)
:param name: 输入框的名字. 与 `input_group` 配合使用,用于在输入组的结果中标识不同输入项. **在单个输入中,不可以设置该参数!**
:param str value: 输入框的初始值
:param str placeholder: 输入框的提示内容。提示内容会在输入框未输入值时以浅色字体显示在输入框中
:param bool required: 当前输入是否为必填项
:param bool readonly: 输入框是否为只读
:param list datalist: 输入建议内容列表,在页面上的显示效果为下拉候选列表,用户可以忽略建议内容列表而输入其他内容。仅当输入类型 ``type`` 为 `TEXT` 时可用
:param str help_text: 输入框的帮助文本。帮助文本会以小号字体显示在输入框下方
:param other_html_attrs: 在输入框上附加的额外html属性。参考: https://developer.mozilla.org/zh-CN/docs/Web/HTML/Element/input#%E5%B1%9E%E6%80%A7
:return: 用户输入的值
"""
item_spec, valid_func = _parse_args(locals())
# 参数检查
allowed_type = {TEXT, NUMBER, FLOAT, PASSWORD, URL, DATE, TIME}
assert type in allowed_type, 'Input type not allowed.'
def preprocess_func(d):
if type == NUMBER:
d = int(d)
elif type == FLOAT:
d = float(d)
return d
if type == FLOAT:
item_spec['type'] = TEXT
return single_input(item_spec, valid_func, preprocess_func)
def textarea(label='', *, rows=6, code=None, maxlength=None, minlength=None, valid_func=None, name=None, value=None,
placeholder=None, required=None, readonly=None, help_text=None, **other_html_attrs):
r"""文本输入域
:param int rows: 输入文本的行数(显示的高度)。输入的文本超出设定值时会显示滚动条
:param int maxlength: 允许用户输入的最大字符长度 (Unicode) 。未指定表示无限长度
:param int minlength: 允许用户输入的最小字符长度(Unicode)
:param dict code: 通过提供 `Codemirror `_ 参数让文本输入域具有代码编辑器样式::
res = textarea('Text area', code={
'mode': "python",
'theme': 'darcula'
})
更多配置可以参考 https://codemirror.net/doc/manual.html#config
:param - label, valid_func, name, value, placeholder, required, readonly, help_text, other_html_attrs: 与 `input` 输入函数的同名参数含义一致
:return: 用户输入的文本
"""
item_spec, valid_func = _parse_args(locals())
item_spec['type'] = TEXTAREA
return single_input(item_spec, valid_func, lambda d: d)
def _parse_select_options(options):
# 转换 select、checkbox、radio函数中的 options 参数为统一的格式
# option 可用形式:
# {value:, label:, [selected:,] [disabled:]}
# (value, label, [selected,] [disabled])
# value 单值,label等于value
opts_res = []
for opt in options:
if isinstance(opt, Mapping):
assert 'value' in opt and 'label' in opt, 'options item must have value and label key'
elif isinstance(opt, (list, tuple)):
assert len(opt) > 1 and len(opt) <= 4, 'options item format error'
opt = dict(zip(('label', 'value', 'selected', 'disabled'), opt))
else:
opt = dict(value=opt, label=opt)
opt['value'] = str(opt['value'])
opts_res.append(opt)
return opts_res
def _set_options_selected(options, value):
"""使用value为options的项设置selected"""
if not isinstance(value, (list, tuple)):
value = [value]
for opt in options:
if opt['value'] in value:
opt['selected'] = True
return options
def select(label='', options=None, *, multiple=None, valid_func=None, name=None, value=None, required=None,
help_text=None, **other_html_attrs):
r"""下拉选择框。默认单选,设置 multiple 参数后,可以多选。但都至少要选择一个选项。
:param list options: 可选项列表。列表项的可用形式有:
* dict: ``{label:选项标签, value: 选项值, [selected:是否默认选中,] [disabled:是否禁止选中]}``
* tuple or list: ``(label, value, [selected,] [disabled])``
* 单值: 此时label和value使用相同的值
注意:
1. options 中的 value 最终会转换成字符串。 select 返回值也是字符串(或字符串列表)
2. 若 ``multiple`` 选项不为 ``True`` 则可选项列表最多仅能有一项的 ``selected`` 为 ``True``。
:param bool multiple: 是否可以多选. 默认单选
:param value: 下拉选择框初始选中项的值。当 ``multiple=True`` 时, ``value`` 需为list,否则为单个选项的值。
你也可以通过设置 ``options`` 列表项中的 ``selected`` 字段来设置默认选中选项。
最终选中项为 ``value`` 参数和 ``options`` 中设置的并集。
:type value: list or str
:param bool required: 是否至少选择一项
:param - label, valid_func, name, help_text, other_html_attrs: 与 `input` 输入函数的同名参数含义一致
:return: 字符串/字符串列表。如果 ``multiple=True`` 时,返回用户选中的 options 中的值的列表;不设置 ``multiple`` 时,返回用户选中的 options 中的值
"""
assert options is not None, ValueError('Required `options` parameter in select()')
item_spec, valid_func = _parse_args(locals(), excludes=['value'])
item_spec['options'] = _parse_select_options(options)
if value is not None:
item_spec['options'] = _set_options_selected(item_spec['options'], value)
item_spec['type'] = SELECT
return single_input(item_spec, valid_func, lambda d: d)
def checkbox(label='', options=None, *, inline=None, valid_func=None, name=None, value=None, help_text=None,
**other_html_attrs):
r"""勾选选项。可以多选,也可以不选。
:param list options: 可选项列表。格式与 `select` 函数的 ``options`` 参数含义一致
:param bool inline: 是否将选项显示在一行上。默认每个选项单独占一行
:param list value: 勾选选项初始选中项。为选项值的列表。
你也可以通过设置 ``options`` 列表项中的 ``selected`` 字段来设置默认选中选项。
:param - label, valid_func, name, help_text, other_html_attrs: 与 `input` 输入函数的同名参数含义一致
:return: 用户选中的 options 中的值的列表。当用户没有勾选任何选项时,返回空列表
"""
assert options is not None, ValueError('Required `options` parameter in checkbox()')
item_spec, valid_func = _parse_args(locals())
item_spec['options'] = _parse_select_options(options)
if value is not None:
del item_spec['value']
item_spec['options'] = _set_options_selected(item_spec['options'], value)
item_spec['type'] = CHECKBOX
return single_input(item_spec, valid_func, lambda d: d)
def radio(label='', options=None, *, inline=None, valid_func=None, name=None, value=None, required=None,
help_text=None, **other_html_attrs):
r"""单选选项
:param list options: 可选项列表。格式与 `select` 函数的 ``options`` 参数含义一致
:param bool inline: 是否将选项显示在一行上。默认每个选项单独占一行
:param str value: 单选选项初始选中项的值。
你也可以通过设置 ``options`` 列表项中的 ``selected`` 字段来设置默认选中选项。
:param bool required: 是否至少选择一项
:param - label, valid_func, name, help_text, other_html_attrs: 与 `input` 输入函数的同名参数含义一致
:return: 用户选中的选项的值(字符串)
"""
assert options is not None, ValueError('Required `options` parameter in radio()')
item_spec, valid_func = _parse_args(locals())
item_spec['options'] = _parse_select_options(options)
if value is not None:
del item_spec['value']
item_spec['options'] = _set_options_selected(item_spec['options'], value)
if required is not None:
del item_spec['required']
item_spec['options'][-1]['required'] = required
item_spec['type'] = RADIO
return single_input(item_spec, valid_func, lambda d: d)
def _parse_action_buttons(buttons):
"""
:param label:
:param actions: action 列表
action 可用形式:
* dict: ``{label:选项标签, value:选项值, [type: 按钮类型], [disabled:是否禁止选择]}``
* tuple or list: ``(label, value, [type], [disabled])``
* 单值: 此时label和value使用相同的值
:return: 规格化后的 buttons
"""
act_res = []
for act in buttons:
if isinstance(act, Mapping):
assert 'label' in act, 'actions item must have label key'
assert 'value' in act or act.get('type', 'submit') != 'submit' or act.get('disabled'), \
'actions item must have value key for submit type'
elif isinstance(act, (list, tuple)):
assert len(act) in (2, 3, 4), 'actions item format error'
act = dict(zip(('label', 'value', 'type', 'disabled'), act))
else:
act = dict(value=act, label=act)
act.setdefault('type', 'submit')
assert act['type'] in ('submit', 'reset', 'cancel', 'callback'), \
"submit type muse be 'submit'/'reset'/'cancel'/'callback', not %r" % act['type']
act_res.append(act)
return act_res
def actions(label='', buttons=None, name=None, help_text=None):
r"""按钮选项。
在表单上显示为一组按钮,用户点击按钮后依据按钮类型的不同有不同的表现。
当 ``actions()`` 作为 `input_group()` 的 ``inputs`` 中最后一个输入项,并且输入项中含有 ``type=submit`` 的按钮时,表单默认的提交按钮会被当前 ``actions()`` 替换
:param list buttons: 选项列表。列表项的可用形式有:
* dict: ``{label:选项标签, value:选项值, [type: 按钮类型], [disabled:是否禁止选择]}`` .
若 ``type='reset'/'cancel'`` 或 ``disabled=True`` 可省略 ``value``
* tuple or list: ``(label, value, [type], [disabled])``
* 单值: 此时label和value使用相同的值
其中 ``type`` 可选值为:
* ``'submit'`` : 点击按钮后,将整个表单提交,最终表单中本项的值为被点击按钮的 ``value`` 值。 ``'submit'`` 为 ``type`` 的默认值
* ``'callback'`` : 点击按钮后,将运行一个回调,回调函数通过 ``value`` 字段指定,可以在回调函数内设置表单中本项的值。具体用法见下文。
* ``'cancel'`` : 取消输入。点击按钮后, ``actions()`` 将直接返回 ``None``
* ``'reset'`` : 点击按钮后,将整个表单重置,输入项将变为初始状态。
注意:点击 ``type=reset`` 的按钮后,并不会提交表单, ``actions()`` 调用也不会返回
:param - label, name, help_text: 与 `input` 输入函数的同名参数含义一致
:return: 若用户点击点击 ``type=submit`` 按钮进行表单提交,返回用户点击的按钮的值;若用户点击点击 ``type=callback`` 按钮,返回值通过回调函数设置;
若用户点击 ``type=cancel`` 按钮或通过其它方式提交表单,则返回 ``None``
** ``type=callback`` 时的用法 **
回调函数需要接收一个 ``set_value`` 位置参数, ``set_value`` 是一个可调用对象,签名为 ``set_value(value, label)`` ,其中 ``label`` 参数可选,
调用 ``set_value`` 将会设置 actions 输入项的值,``value`` 参数可以为任意PytHon对象, ``value`` 参数并不会传递给用户浏览器,用户表单上仅会显示 ``label`` 参数,
默认 ``label`` 为 ``value`` 的字符串表示。
示例代码见下方"处理复杂输入"的场景。
Note: 当使用 :ref:`基于协程的会话实现 ` 时,回调函数可以使用协程函数.
**actions使用场景**
.. _custom_form_ctrl_btn:
替换默认的提交按钮::
info = input_group('Add user', [
input('username', type=TEXT, name='username', required=True),
input('password', type=PASSWORD, name='password', required=True),
actions('actions', [
{'label': '保存', 'value': 'save'},
{'label': '保存并添加下一个', 'value': 'save_and_continue'},
{'label': '重置', 'type': 'reset'},
{'label': '取消', 'type': 'cancel'},
], name='action', help_text='actions'),
])
if info is not None:
save_user(info['username'], info['password'])
if info['action'] == 'save_and_continue':
add_next()
处理复杂输入::
def get_name(set_val):
popup('Set name', [
put_buttons(['Set result'], onclick=[lambda: set_val('Wang Weimin')])
])
res = input_group('', [
actions('Name', [
dict(label='Set name', value=get_name, type='callback'),
], name='name'),
])
put_text(res['name'])
"""
assert buttons is not None, ValueError('Required `buttons` parameter in actions()')
item_spec, valid_func = _parse_args(locals())
item_spec['type'] = 'actions'
item_spec['buttons'] = _parse_action_buttons(buttons)
def preprocess_func(data, value_setter=None):
if value_setter is None:
return data
return data or value_setter.val
value_setter = None
callback_btns = [btn for btn in item_spec['buttons'] if btn['type'] == 'callback']
if callback_btns:
value_setter = Setter()
task_id = get_current_task_id()
def _set_value(value, label=None):
if label is None:
label = str(value)
value_setter.val = value
msg = dict(command='update_input', task_id=task_id, spec={
'target_name': item_spec.get('name', 'data'),
'attributes': {'action_result': label}
})
get_current_session().send_task_command(msg)
for btn in callback_btns:
callback = btn['value']
btn['value'] = output_register_callback(lambda _: callback(_set_value))
return single_input(item_spec, valid_func, partial(preprocess_func, value_setter=value_setter))
def file_upload(label='', accept=None, name=None, placeholder='Choose file', required=None, help_text=None,
**other_html_attrs):
r"""文件上传。
:param accept: 单值或列表, 表示可接受的文件类型。单值或列表项支持的形式有:
* 以 ``.`` 字符开始的文件扩展名(例如:``.jpg, .png, .doc``)。
注意:截止本文档编写之时,微信内置浏览器还不支持这种语法
* 一个有效的 MIME 类型。
例如: ``application/pdf`` 、 ``audio/*`` 表示音频文件、``video/*`` 表示视频文件、``image/*`` 表示图片文件
参考 https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types
:type accept: str or list
:param str placeholder: 未上传文件时,文件上传框内显示的文本
:param bool required: 是否必须要上传文件
:param - label, name, help_text, other_html_attrs: 与 `input` 输入函数的同名参数含义一致
:return: 用户没有上传文件时,返回 ``None`` ;上传文件返回dict: ``{'filename': 文件名, 'content':文件二进制数据(bytes object)}``
"""
item_spec, valid_func = _parse_args(locals())
item_spec['type'] = 'file'
def read_file(data): # data: None or {'filename':, 'dataurl'}
if data is None:
return data
header, encoded = data['dataurl'].split(",", 1)
data['content'] = b64decode(encoded)
return data
return single_input(item_spec, valid_func, read_file)
def input_group(label='', inputs=None, valid_func=None, cancelable=False):
r"""输入组。向页面上展示一组输入
:param str label: 输入组标签
:param list inputs: 输入项列表。列表的内容为对单项输入函数的调用,并在单项输入函数中传入 ``name`` 参数。
:param Callable valid_func: 输入组校验函数。
函数签名:``callback(data) -> (name, error_msg)``
``valid_func`` 接收整个表单的值为参数,当校验表单值有效时,返回 ``None`` ,当某项输入值无效时,返回出错输入项的 ``name`` 值和错误提示. 比如::
def check_form(data):
if len(data['name']) > 6:
return ('name', '名字太长!')
if data['age'] <= 0:
return ('age', '年龄不能为负数!')
data = input_group("Basic info",[
input('Input your name', name='name'),
input('Repeat your age', name='age', type=NUMBER)
], valid_func=check_form)
print(data['name'], data['age'])
:param bool cancelable: 表单是否可以取消。若 ``cancelable=True`` 则会在表单底部显示一个"取消"按钮。
注意:若 ``inputs`` 中最后一项输入为 `actions()` ,则忽略 ``cancelable``
:return: 若用户取消表单,返回 ``None`` ,否则返回一个 ``dict`` , 其键为输入项的 ``name`` 值,字典值为输入项的值
"""
assert inputs is not None, ValueError('Required `inputs` parameter in input_group()')
spec_inputs = []
preprocess_funcs = {}
item_valid_funcs = {}
for single_input_return in inputs:
try:
single_input_return.send(None) # 协程模式下,带有name参数的单项输入函数通过send(None)来获取协程参数
except StopIteration as e:
input_kwargs = e.args[0]
except AttributeError:
input_kwargs = single_input_return
else:
raise RuntimeError("Can't get kwargs from single input")
assert all(k in input_kwargs for k in ('item_spec', 'preprocess_func', 'valid_func')), RuntimeError(
"`inputs` value error in `input_group`. Did you forget to add `name` parameter in input function?")
input_name = input_kwargs['item_spec']['name']
if input_name in preprocess_funcs:
raise ValueError("Can't use same `name`:%s in different input in input group!!" % input_name)
preprocess_funcs[input_name] = input_kwargs['preprocess_func']
item_valid_funcs[input_name] = input_kwargs['valid_func']
spec_inputs.append(input_kwargs['item_spec'])
if all('auto_focus' not in i for i in spec_inputs): # 每一个输入项都没有设置auto_focus参数
for i in spec_inputs:
text_inputs = {TEXT, NUMBER, PASSWORD, SELECT} # todo update
if i.get('type') in text_inputs:
i['auto_focus'] = True
break
spec = dict(label=label, inputs=spec_inputs, cancelable=cancelable)
return input_control(spec, preprocess_funcs=preprocess_funcs, item_valid_funcs=item_valid_funcs,
form_valid_funcs=valid_func)