index.rst 2.8 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798
  1. PyWebIO
  2. ==========
  3. PyWebIO是一个用于在浏览器上获取输入和进行输出的工具库。可以将原有的通过终端交互的脚本快速服务化,供其他人在网络上通过浏览器访问使用;PyWebIO还可以方便地整合进现有的Web服务,非常适合于构建对UI要求不高的后端服务。
  4. 特点
  5. ------------
  6. - 使用同步而不是基于回调的方式获取输入,无需在各个步骤之间保存状态,使用更方便
  7. - 代码侵入性小,对于旧脚本代码仅需修改输入输出逻辑
  8. - 支持多用户与并发请求
  9. - 支持整合到现有的Web服务,目前支持与Tornado和Flask的集成
  10. - 同时支持基于线程的执行模型和基于协程的执行模型
  11. Install
  12. ------------
  13. ::
  14. pip3 install pywebio
  15. **系统要求**: PyWebIO要求 Python 版本在 3.5.2 及以上
  16. .. _hello_word:
  17. Hello, world
  18. --------------
  19. 这是一个使用PywWebIO计算 `BMI指数 <https://en.wikipedia.org/wiki/Body_mass_index>`_ 的脚本::
  20. # A simple script to calculate BMI
  21. from pywebio.input import input
  22. from pywebio.output import put_text
  23. def bmi():
  24. height = input("请输入你的身高(cm):")
  25. weight = input("请输入你的体重(kg):")
  26. BMI = float(weight) / (float(height) / 100) ** 2
  27. top_status = [(14.9, '极瘦'), (18.4, '偏瘦'),
  28. (22.9, '正常'), (27.5, '过重'),
  29. (40.0, '肥胖'), (float('inf'), '非常肥胖')]
  30. for top, status in top_status:
  31. if BMI <= top:
  32. put_text('你的 BMI 值: %.1f,身体状态:%s' % (BMI, status))
  33. break
  34. if __name__ == '__main__':
  35. bmi()
  36. 如果没有使用PywWebIO,这只是一个非常简单的脚本,而通过使用PywWebIO提供的输入输出函数,你可以在浏览器中与代码进行交互:
  37. .. image:: /assets/demo.*
  38. 将上面代码最后一行对 ``bmi()`` 的直接调用改为使用 `pywebio.start_server(bmi, port=80) <pywebio.platform.start_server>` 便可以在80端口提供 ``bmi()`` 服务。
  39. 将 ``bmi()`` 服务整合到现有的Web 框架请参考 :ref:`与Web框架集成 <integration_web_framework>`
  40. Documentation
  41. -------------
  42. 这个文档同时也提供 `PDF 和 Epub 格式 <https://readthedocs.org/projects/pywebio/downloads/>`_.
  43. .. toctree::
  44. :maxdepth: 3
  45. :caption: 使用手册
  46. guide
  47. input
  48. output
  49. session
  50. server
  51. misc
  52. .. toctree::
  53. :maxdepth: 2
  54. :caption: 实现文档
  55. arch
  56. spec
  57. Indices and tables
  58. ----------------------
  59. * :ref:`genindex`
  60. * :ref:`modindex`
  61. * :ref:`search`
  62. Discussion and support
  63. ----------------------
  64. * Need help when use PyWebIO? Send me Email ``wang0.618&qq.com`` (replace ``&`` whit ``@`` ).
  65. * Report bugs on the `GitHub issue <https://github.com/wang0618/pywebio/issues>`_.