input.py 27 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591
  1. """从浏览器接收用户输入
  2. 本模块提供了一系列函数来从浏览器接收用户不同的形式的输入
  3. 输入函数大致分为两类,一类是单项输入::
  4. name = input("What's your name")
  5. print("Your name is %s" % name)
  6. 另一类是使用 `input_group` 的输入组::
  7. info = input_group("User info",[
  8. input('Input your name', name='name'),
  9. input('Input your age', name='age', type=NUMBER)
  10. ])
  11. print(info['name'], info['age'])
  12. 输入组中需要在每一项输入函数中提供 ``name`` 参数来用于在结果中标识不同输入项.
  13. .. note::
  14. PyWebIO 根据是否在输入函数中传入 ``name`` 参数来判断输入函数是在 `input_group` 中还是被单独调用。
  15. 所以当你想要单独调用一个输入函数时,请不要设置 ``name`` 参数;而在 `input_group` 中调用输入函数时,**务必提供** ``name`` 参数
  16. 输入默认可以忽略,如果需要用户必须提供值,则需要在输入函数中传入 ``required=True`` (部分输入函数不支持 ``required`` 参数)
  17. """
  18. import logging
  19. from base64 import b64decode
  20. from collections.abc import Mapping
  21. from functools import partial
  22. from .io_ctrl import single_input, input_control, output_register_callback
  23. from .session import get_current_session, get_current_task_id
  24. from .utils import Setter
  25. logger = logging.getLogger(__name__)
  26. TEXT = 'text'
  27. NUMBER = "number"
  28. FLOAT = "float"
  29. PASSWORD = "password"
  30. URL = "url"
  31. DATE = "date"
  32. TIME = "time"
  33. CHECKBOX = 'checkbox'
  34. RADIO = 'radio'
  35. SELECT = 'select'
  36. TEXTAREA = 'textarea'
  37. __all__ = ['TEXT', 'NUMBER', 'FLOAT', 'PASSWORD', 'URL', 'DATE', 'TIME', 'input', 'textarea', 'select',
  38. 'checkbox', 'radio', 'actions', 'file_upload', 'input_group']
  39. def _parse_args(kwargs, excludes=()):
  40. """处理传给各类输入函数的原始参数
  41. - excludes: 排除的参数
  42. - 对为None的参数忽略处理
  43. :return:(spec参数,valid_func)
  44. """
  45. kwargs = {k: v for k, v in kwargs.items() if v is not None and k not in excludes}
  46. kwargs.update(kwargs.get('other_html_attrs', {}))
  47. kwargs.pop('other_html_attrs', None)
  48. valid_func = kwargs.pop('valid_func', lambda _: None)
  49. return kwargs, valid_func
  50. def input(label='', type=TEXT, *, valid_func=None, name=None, value=None, action=None, placeholder=None, required=None,
  51. readonly=None, datalist=None, help_text=None, **other_html_attrs):
  52. r"""文本输入
  53. :param str label: 输入框标签
  54. :param str type: 输入类型. 可使用的常量:`TEXT` , `NUMBER` , `FLOAT` , `PASSWORD` , `URL` , `DATE` , `TIME`
  55. 其中 `DATE` , `TIME` 类型在某些浏览器上不被支持,详情见 https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#Browser_compatibility
  56. :param Callable valid_func: 输入值校验函数. 如果提供,当用户输入完毕或提交表单后校验函数将被调用.
  57. ``valid_func`` 接收输入值作为参数,当输入值有效时,返回 ``None`` ,当输入值无效时,返回错误提示字符串. 比如::
  58. def check_age(age):
  59. if age>30:
  60. return 'Too old'
  61. elif age<10:
  62. return 'Too young'
  63. input('Input your age', type=NUMBER, valid_func=check_age)
  64. :param name: 输入框的名字. 与 `input_group` 配合使用,用于在输入组的结果中标识不同输入项. **在单个输入中,不可以设置该参数!**
  65. :param str value: 输入框的初始值
  66. :type action: tuple(label:str, callback:callable)
  67. :param action: 在输入框右侧显示一个按钮,可通过点击按钮为输入框设置值。
  68. ``label`` 为按钮的显示文本, ``callback`` 为按钮点击的回调函数。
  69. 回调函数需要接收一个 ``set_value`` 位置参数, ``set_value`` 是一个可调用对象,接受单参数调用和双参数调用。
  70. 单参数调用时,签名为 ``set_value(value:str)`` ,调用set_value即可将表单项的值设置为传入的 ``value`` 参数。
  71. 双参数调用时,签名为 ``set_value(value:any, label:str)`` ,其中:
  72. * ``value`` 参数为最终输入项的返回值,可以为任意Python对象,并不会传递给用户浏览器
  73. * ``label`` 参数用于显示在用户表单项上
  74. 使用双参数调用 ``set_value`` 后,用户表单项会变为只读状态。
  75. 双参数调用的使用场景为:表单项的值通过回调动态生成,同时希望用户表单显示的和实际提交的数据不同(例如表单项上可以显示更人性化的内容,而表单项的值则可以保存更方便被处理的对象)
  76. 使用示例::
  77. import time
  78. def set_now_ts(set_value):
  79. set_value(int(time.time()))
  80. input('Timestamp', type=NUMBER, action=('Now', set_now_ts))
  81. from datetime import date,timedelta
  82. def select_date(set_value):
  83. with popup('Select Date'):
  84. put_buttons(['Today'], onclick=[lambda: set_value(date.today(), 'Today')])
  85. put_buttons(['Yesterday'], onclick=[lambda: set_value(date.today() - timedelta(days=1), 'Yesterday')])
  86. d = input('Date', action=('Select', select_date), readonly=True)
  87. put_text(type(d), d)
  88. Note: 当使用 :ref:`基于协程的会话实现 <coroutine_based_session>` 时,回调函数 ``callback`` 可以为协程函数.
  89. :param str placeholder: 输入框的提示内容。提示内容会在输入框未输入值时以浅色字体显示在输入框中
  90. :param bool required: 当前输入是否为必填项
  91. :param bool readonly: 输入框是否为只读
  92. :param list datalist: 输入建议内容列表,在页面上的显示效果为下拉候选列表,用户可以忽略建议内容列表而输入其他内容。仅当输入类型 ``type`` 为 `TEXT` 时可用
  93. :param str help_text: 输入框的帮助文本。帮助文本会以小号字体显示在输入框下方
  94. :param other_html_attrs: 在输入框上附加的额外html属性。参考: https://developer.mozilla.org/zh-CN/docs/Web/HTML/Element/input#%E5%B1%9E%E6%80%A7
  95. :return: 用户输入的值
  96. """
  97. item_spec, valid_func = _parse_args(locals(), excludes=('action',))
  98. # 参数检查
  99. allowed_type = {TEXT, NUMBER, FLOAT, PASSWORD, URL, DATE, TIME}
  100. assert type in allowed_type, 'Input type not allowed.'
  101. if type == FLOAT:
  102. item_spec['type'] = TEXT
  103. value_setter = None
  104. if action:
  105. label, callback = action
  106. task_id = get_current_task_id()
  107. value_setter = Setter()
  108. def _set_value(value, label=value_setter):
  109. spec = {
  110. 'target_name': item_spec.get('name', 'data'),
  111. 'attributes': {'value': value}
  112. }
  113. if label is not value_setter:
  114. value_setter.label = label
  115. spec['attributes']['value'] = label
  116. spec['attributes']['readonly'] = True
  117. value_setter.value = value
  118. msg = dict(command='update_input', task_id=task_id, spec=spec)
  119. get_current_session().send_task_command(msg)
  120. callback_id = output_register_callback(lambda _: callback(_set_value))
  121. item_spec['action'] = dict(label=label, callback_id=callback_id)
  122. def preprocess_func(d): # 将用户提交的原始数据进行转换
  123. if value_setter is not None and value_setter.label == d:
  124. return value_setter.value
  125. if type == NUMBER:
  126. d = int(d)
  127. elif type == FLOAT:
  128. d = float(d)
  129. return d
  130. return single_input(item_spec, valid_func, preprocess_func)
  131. def textarea(label='', *, rows=6, code=None, maxlength=None, minlength=None, valid_func=None, name=None, value=None,
  132. placeholder=None, required=None, readonly=None, help_text=None, **other_html_attrs):
  133. r"""文本输入域
  134. :param int rows: 输入文本的行数(显示的高度)。输入的文本超出设定值时会显示滚动条
  135. :param int maxlength: 允许用户输入的最大字符长度 (Unicode) 。未指定表示无限长度
  136. :param int minlength: 允许用户输入的最小字符长度(Unicode)
  137. :param dict code: 通过提供 `Codemirror <https://codemirror.net/>`_ 参数让文本输入域具有代码编辑器样式::
  138. res = textarea('Text area', code={
  139. 'mode': "python",
  140. 'theme': 'darcula'
  141. })
  142. 更多配置可以参考 https://codemirror.net/doc/manual.html#config
  143. :param - label, valid_func, name, value, placeholder, required, readonly, help_text, other_html_attrs: 与 `input` 输入函数的同名参数含义一致
  144. :return: 用户输入的文本
  145. """
  146. item_spec, valid_func = _parse_args(locals())
  147. item_spec['type'] = TEXTAREA
  148. return single_input(item_spec, valid_func, lambda d: d)
  149. def _parse_select_options(options):
  150. # 转换 select、checkbox、radio函数中的 options 参数为统一的格式
  151. # option 可用形式:
  152. # {value:, label:, [selected:,] [disabled:]}
  153. # (value, label, [selected,] [disabled])
  154. # value 单值,label等于value
  155. opts_res = []
  156. for opt in options:
  157. if isinstance(opt, Mapping):
  158. assert 'value' in opt and 'label' in opt, 'options item must have value and label key'
  159. elif isinstance(opt, (list, tuple)):
  160. assert len(opt) > 1 and len(opt) <= 4, 'options item format error'
  161. opt = dict(zip(('label', 'value', 'selected', 'disabled'), opt))
  162. else:
  163. opt = dict(value=opt, label=opt)
  164. opt['value'] = str(opt['value'])
  165. opts_res.append(opt)
  166. return opts_res
  167. def _set_options_selected(options, value):
  168. """使用value为options的项设置selected"""
  169. if not isinstance(value, (list, tuple)):
  170. value = [value]
  171. for opt in options:
  172. if opt['value'] in value:
  173. opt['selected'] = True
  174. return options
  175. def select(label='', options=None, *, multiple=None, valid_func=None, name=None, value=None, required=None,
  176. help_text=None, **other_html_attrs):
  177. r"""下拉选择框。默认单选,设置 multiple 参数后,可以多选。但都至少要选择一个选项。
  178. :param list options: 可选项列表。列表项的可用形式有:
  179. * dict: ``{label:选项标签, value: 选项值, [selected:是否默认选中,] [disabled:是否禁止选中]}``
  180. * tuple or list: ``(label, value, [selected,] [disabled])``
  181. * 单值: 此时label和value使用相同的值
  182. 注意:
  183. 1. options 中的 value 最终会转换成字符串。 select 返回值也是字符串(或字符串列表)
  184. 2. 若 ``multiple`` 选项不为 ``True`` 则可选项列表最多仅能有一项的 ``selected`` 为 ``True``。
  185. :param bool multiple: 是否可以多选. 默认单选
  186. :param value: 下拉选择框初始选中项的值。当 ``multiple=True`` 时, ``value`` 需为list,否则为单个选项的值。
  187. 你也可以通过设置 ``options`` 列表项中的 ``selected`` 字段来设置默认选中选项。
  188. 最终选中项为 ``value`` 参数和 ``options`` 中设置的并集。
  189. :type value: list or str
  190. :param bool required: 是否至少选择一项
  191. :param - label, valid_func, name, help_text, other_html_attrs: 与 `input` 输入函数的同名参数含义一致
  192. :return: 字符串/字符串列表。如果 ``multiple=True`` 时,返回用户选中的 options 中的值的列表;不设置 ``multiple`` 时,返回用户选中的 options 中的值
  193. """
  194. assert options is not None, ValueError('Required `options` parameter in select()')
  195. item_spec, valid_func = _parse_args(locals(), excludes=['value'])
  196. item_spec['options'] = _parse_select_options(options)
  197. if value is not None:
  198. item_spec['options'] = _set_options_selected(item_spec['options'], value)
  199. item_spec['type'] = SELECT
  200. return single_input(item_spec, valid_func, lambda d: d)
  201. def checkbox(label='', options=None, *, inline=None, valid_func=None, name=None, value=None, help_text=None,
  202. **other_html_attrs):
  203. r"""勾选选项。可以多选,也可以不选。
  204. :param list options: 可选项列表。格式与 `select` 函数的 ``options`` 参数含义一致
  205. :param bool inline: 是否将选项显示在一行上。默认每个选项单独占一行
  206. :param list value: 勾选选项初始选中项。为选项值的列表。
  207. 你也可以通过设置 ``options`` 列表项中的 ``selected`` 字段来设置默认选中选项。
  208. :param - label, valid_func, name, help_text, other_html_attrs: 与 `input` 输入函数的同名参数含义一致
  209. :return: 用户选中的 options 中的值的列表。当用户没有勾选任何选项时,返回空列表
  210. """
  211. assert options is not None, ValueError('Required `options` parameter in checkbox()')
  212. item_spec, valid_func = _parse_args(locals())
  213. item_spec['options'] = _parse_select_options(options)
  214. if value is not None:
  215. del item_spec['value']
  216. item_spec['options'] = _set_options_selected(item_spec['options'], value)
  217. item_spec['type'] = CHECKBOX
  218. return single_input(item_spec, valid_func, lambda d: d)
  219. def radio(label='', options=None, *, inline=None, valid_func=None, name=None, value=None, required=None,
  220. help_text=None, **other_html_attrs):
  221. r"""单选选项
  222. :param list options: 可选项列表。格式与 `select` 函数的 ``options`` 参数含义一致
  223. :param bool inline: 是否将选项显示在一行上。默认每个选项单独占一行
  224. :param str value: 单选选项初始选中项的值。
  225. 你也可以通过设置 ``options`` 列表项中的 ``selected`` 字段来设置默认选中选项。
  226. :param bool required: 是否至少选择一项
  227. :param - label, valid_func, name, help_text, other_html_attrs: 与 `input` 输入函数的同名参数含义一致
  228. :return: 用户选中的选项的值(字符串)
  229. """
  230. assert options is not None, ValueError('Required `options` parameter in radio()')
  231. item_spec, valid_func = _parse_args(locals())
  232. item_spec['options'] = _parse_select_options(options)
  233. if value is not None:
  234. del item_spec['value']
  235. item_spec['options'] = _set_options_selected(item_spec['options'], value)
  236. if required is not None:
  237. del item_spec['required']
  238. item_spec['options'][-1]['required'] = required
  239. item_spec['type'] = RADIO
  240. return single_input(item_spec, valid_func, lambda d: d)
  241. def _parse_action_buttons(buttons):
  242. """
  243. :param label:
  244. :param actions: action 列表
  245. action 可用形式:
  246. * dict: ``{label:选项标签, value:选项值, [type: 按钮类型], [disabled:是否禁止选择]}``
  247. * tuple or list: ``(label, value, [type], [disabled])``
  248. * 单值: 此时label和value使用相同的值
  249. :return: 规格化后的 buttons
  250. """
  251. act_res = []
  252. for act in buttons:
  253. if isinstance(act, Mapping):
  254. assert 'label' in act, 'actions item must have label key'
  255. assert 'value' in act or act.get('type', 'submit') != 'submit' or act.get('disabled'), \
  256. 'actions item must have value key for submit type'
  257. elif isinstance(act, (list, tuple)):
  258. assert len(act) in (2, 3, 4), 'actions item format error'
  259. act = dict(zip(('label', 'value', 'type', 'disabled'), act))
  260. else:
  261. act = dict(value=act, label=act)
  262. act.setdefault('type', 'submit')
  263. assert act['type'] in ('submit', 'reset', 'cancel', 'callback'), \
  264. "submit type muse be 'submit'/'reset'/'cancel'/'callback', not %r" % act['type']
  265. act_res.append(act)
  266. return act_res
  267. def actions(label='', buttons=None, name=None, help_text=None):
  268. r"""按钮选项。
  269. 在表单上显示为一组按钮,用户点击按钮后依据按钮类型的不同有不同的表现。
  270. 当 ``actions()`` 作为 `input_group()` 的 ``inputs`` 中最后一个输入项,并且输入项中含有 ``type=submit`` 的按钮时,表单默认的提交按钮会被当前 ``actions()`` 替换
  271. :param list buttons: 选项列表。列表项的可用形式有:
  272. * dict: ``{label:选项标签, value:选项值, [type: 按钮类型], [disabled:是否禁止选择]}`` .
  273. 若 ``type='reset'/'cancel'`` 或 ``disabled=True`` 可省略 ``value``
  274. * tuple or list: ``(label, value, [type], [disabled])``
  275. * 单值: 此时label和value使用相同的值
  276. 其中 ``type`` 可选值为:
  277. * ``'submit'`` : 点击按钮后,将整个表单提交,最终表单中本项的值为被点击按钮的 ``value`` 值。 ``'submit'`` 为 ``type`` 的默认值
  278. * ``'callback'`` : 点击按钮后,将运行一个回调,回调函数通过 ``value`` 字段指定,可以在回调函数内设置表单中本项的值。具体用法见下文。
  279. * ``'cancel'`` : 取消输入。点击按钮后, ``actions()`` 将直接返回 ``None``
  280. * ``'reset'`` : 点击按钮后,将整个表单重置,输入项将变为初始状态。
  281. 注意:点击 ``type=reset`` 的按钮后,并不会提交表单, ``actions()`` 调用也不会返回
  282. :param - label, name, help_text: 与 `input` 输入函数的同名参数含义一致
  283. :return: 若用户点击点击 ``type=submit`` 按钮进行表单提交,返回用户点击的按钮的值;若用户点击点击 ``type=callback`` 按钮,返回值通过回调函数设置;
  284. 若用户点击 ``type=cancel`` 按钮或通过其它方式提交表单,则返回 ``None``
  285. **type=callback的用法**
  286. 回调函数需要接收一个 ``set_value`` 位置参数, ``set_value`` 是一个可调用对象,调用 ``set_value`` 将会设置 actions 输入项的值,
  287. 调用签名为 ``set_value(value:any, label:str)`` ,其中
  288. * ``value`` 参数为最终 actions 输入项的返回值,可以为任意Python对象,并不会传递给用户浏览器
  289. * ``label`` 参数可选,用于显示在用户表单上, ``label`` 默认为 ``value`` 的字符串表示
  290. 示例代码见下方"通过其他操作设置项值"使用场景。
  291. Note: 当使用 :ref:`基于协程的会话实现 <coroutine_based_session>` 时,回调函数可以使用协程函数.
  292. **actions使用场景**
  293. .. _custom_form_ctrl_btn:
  294. 替换默认的提交按钮::
  295. info = input_group('Add user', [
  296. input('username', type=TEXT, name='username', required=True),
  297. input('password', type=PASSWORD, name='password', required=True),
  298. actions('actions', [
  299. {'label': '保存', 'value': 'save'},
  300. {'label': '保存并添加下一个', 'value': 'save_and_continue'},
  301. {'label': '重置', 'type': 'reset'},
  302. {'label': '取消', 'type': 'cancel'},
  303. ], name='action', help_text='actions'),
  304. ])
  305. if info is not None:
  306. save_user(info['username'], info['password'])
  307. if info['action'] == 'save_and_continue':
  308. add_next()
  309. 通过其他操作设置项值::
  310. def get_name(set_val):
  311. popup('Set name', [
  312. put_buttons(['Set result'], onclick=[lambda: set_val('Wang Weimin')])
  313. ])
  314. res = input_group('', [
  315. actions('Name', [
  316. dict(label='Set name', value=get_name, type='callback'),
  317. ], name='name'),
  318. ])
  319. put_text(res['name'])
  320. """
  321. assert buttons is not None, ValueError('Required `buttons` parameter in actions()')
  322. item_spec, valid_func = _parse_args(locals())
  323. item_spec['type'] = 'actions'
  324. item_spec['buttons'] = _parse_action_buttons(buttons)
  325. def preprocess_func(data, value_setter=None):
  326. if value_setter is None:
  327. return data
  328. return data or value_setter.val
  329. value_setter = None
  330. callback_btns = [btn for btn in item_spec['buttons'] if btn['type'] == 'callback']
  331. if callback_btns:
  332. value_setter = Setter()
  333. task_id = get_current_task_id()
  334. def _set_value(value, label=None):
  335. if label is None:
  336. label = str(value)
  337. value_setter.val = value
  338. msg = dict(command='update_input', task_id=task_id, spec={
  339. 'target_name': item_spec.get('name', 'data'),
  340. 'attributes': {'action_result': label}
  341. })
  342. get_current_session().send_task_command(msg)
  343. for btn in callback_btns:
  344. callback = btn['value']
  345. btn['value'] = output_register_callback(lambda _: callback(_set_value))
  346. return single_input(item_spec, valid_func, partial(preprocess_func, value_setter=value_setter))
  347. def _parse_file_size(size):
  348. if isinstance(size, (int, float)):
  349. return int(size)
  350. assert isinstance(size, str), '`size` must be int/float/str, got %s' % type(size)
  351. for idx, i in enumerate(['k', 'm', 'g'], 1):
  352. if i in size:
  353. s = size.lower().replace(i, '')
  354. base = 2 ** (idx * 10)
  355. return int(float(s) * base)
  356. return int(size)
  357. def file_upload(label='', accept=None, name=None, placeholder='Choose file', multiple=False, max_size=0,
  358. max_total_size=0, required=None, help_text=None, **other_html_attrs):
  359. r"""文件上传。
  360. :param accept: 单值或列表, 表示可接受的文件类型。单值或列表项支持的形式有:
  361. * 以 ``.`` 字符开始的文件扩展名(例如:``.jpg, .png, .doc``)。
  362. 注意:截止本文档编写之时,微信内置浏览器还不支持这种语法
  363. * 一个有效的 MIME 类型。
  364. 例如: ``application/pdf`` 、 ``audio/*`` 表示音频文件、``video/*`` 表示视频文件、``image/*`` 表示图片文件
  365. 参考 https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types
  366. :type accept: str or list
  367. :param str placeholder: 未上传文件时,文件上传框内显示的文本
  368. :param bool multiple: 是否允许多文件上传
  369. :param int/str max_size: 单个文件的最大大小,超过限制将会禁止上传。默认为0,表示不限制上传文件的大小。
  370. 可以为数字表示的字节数,或以 `K` / `M` / `G` 结尾的表示的字符串(分别表示 千字节、兆字节、吉字节,大小写不敏感)。例如:
  371. ``max_size=500`` , ``max_size='40K'`` , ``max_size='3M'``
  372. :param int/str max_total_size: 所有文件的最大大小,超过限制将会禁止上传。仅在 ``multiple=True`` 时可用,默认不限制上传文件的大小。 格式同 ``max_size`` 参数
  373. :param bool required: 是否必须要上传文件。默认为 `False`
  374. :param - label, name, help_text, other_html_attrs: 与 `input` 输入函数的同名参数含义一致
  375. :return: ``multiple=False`` 时(默认),返回dict: ``{'filename': 文件名, 'content':文件二进制数据(bytes object), mime_type: 文件的MIME类型, last_modified: 文件上次修改时间(时间戳) }`` ;
  376. 若用户没有上传文件,返回 ``None`` 。
  377. ``multiple=True`` 时,返回列表,列表项格式同上文 ``multiple=False`` 时的返回值;若用户没有上传文件,返回空列表。
  378. .. note::
  379. 若上传大文件请留意Web框架的文件上传大小限制设置。在使用 :func:`start_server <pywebio.platform.start_server>` 启动PyWebIO应用时,
  380. 可通过 `websocket_max_message_size` 参数设置允许上传的最大文件大小
  381. """
  382. item_spec, valid_func = _parse_args(locals())
  383. item_spec['type'] = 'file'
  384. item_spec['max_size'] = _parse_file_size(max_size)
  385. item_spec['max_total_size'] = _parse_file_size(max_total_size)
  386. def read_file(data): # data: None or [{'filename':, 'dataurl', 'mime_type', 'last_modified'}, ...]
  387. for d in data:
  388. header, encoded = d['dataurl'].split(",", 1)
  389. d['content'] = b64decode(encoded)
  390. if not multiple:
  391. return data[0] if len(data) >= 1 else None
  392. return data
  393. return single_input(item_spec, valid_func, read_file)
  394. def input_group(label='', inputs=None, valid_func=None, cancelable=False):
  395. r"""输入组。向页面上展示一组输入
  396. :param str label: 输入组标签
  397. :param list inputs: 输入项列表。列表的内容为对单项输入函数的调用,并在单项输入函数中传入 ``name`` 参数。
  398. :param Callable valid_func: 输入组校验函数。
  399. 函数签名:``callback(data) -> (name, error_msg)``
  400. ``valid_func`` 接收整个表单的值为参数,当校验表单值有效时,返回 ``None`` ,当某项输入值无效时,返回出错输入项的 ``name`` 值和错误提示. 比如::
  401. def check_form(data):
  402. if len(data['name']) > 6:
  403. return ('name', '名字太长!')
  404. if data['age'] <= 0:
  405. return ('age', '年龄不能为负数!')
  406. data = input_group("Basic info",[
  407. input('Input your name', name='name'),
  408. input('Repeat your age', name='age', type=NUMBER)
  409. ], valid_func=check_form)
  410. print(data['name'], data['age'])
  411. :param bool cancelable: 表单是否可以取消。若 ``cancelable=True`` 则会在表单底部显示一个"取消"按钮。
  412. 注意:若 ``inputs`` 中最后一项输入为 `actions()` ,则忽略 ``cancelable``
  413. :return: 若用户取消表单,返回 ``None`` ,否则返回一个 ``dict`` , 其键为输入项的 ``name`` 值,字典值为输入项的值
  414. """
  415. assert inputs is not None, ValueError('Required `inputs` parameter in input_group()')
  416. spec_inputs = []
  417. preprocess_funcs = {}
  418. item_valid_funcs = {}
  419. for single_input_return in inputs:
  420. try:
  421. single_input_return.send(None) # 协程模式下,带有name参数的单项输入函数通过send(None)来获取协程参数
  422. except StopIteration as e:
  423. input_kwargs = e.args[0]
  424. except AttributeError:
  425. input_kwargs = single_input_return
  426. else:
  427. raise RuntimeError("Can't get kwargs from single input")
  428. assert all(k in input_kwargs for k in ('item_spec', 'preprocess_func', 'valid_func')), RuntimeError(
  429. "`inputs` value error in `input_group`. Did you forget to add `name` parameter in input function?")
  430. input_name = input_kwargs['item_spec']['name']
  431. if input_name in preprocess_funcs:
  432. raise ValueError("Can't use same `name`:%s in different input in input group!!" % input_name)
  433. preprocess_funcs[input_name] = input_kwargs['preprocess_func']
  434. item_valid_funcs[input_name] = input_kwargs['valid_func']
  435. spec_inputs.append(input_kwargs['item_spec'])
  436. if all('auto_focus' not in i for i in spec_inputs): # 每一个输入项都没有设置auto_focus参数
  437. for i in spec_inputs:
  438. text_inputs = {TEXT, NUMBER, PASSWORD, SELECT, URL} # todo update
  439. if i.get('type') in text_inputs:
  440. i['auto_focus'] = True
  441. break
  442. spec = dict(label=label, inputs=spec_inputs, cancelable=cancelable)
  443. return input_control(spec, preprocess_funcs=preprocess_funcs, item_valid_funcs=item_valid_funcs,
  444. form_valid_funcs=valid_func)