index.rst 2.9 KB

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