صفحهٔ اصلی گشت‌و‌گذار راهنما
ثبت نام ورود
root
/
PyWebIO
mirrorاز https://github.com/pywebio/PyWebIO.git
1
0
انشعاب 0
پرونده‌ها مشکلات 0 ویکی
فهرست منبع

feat: add `pywebio.config()`

wangweimin 3 سال پیش
والد
31b26d0985
کامیت
4da937181a
6فایلهای تغییر یافته به همراه130 افزوده شده و 35 حذف شده
نمای یکپارچه نمایش آمار تفاوت ها
  1. 0 2
      docs/guide.rst
  2. 1 0
      pywebio/__init__.py
  3. 2 1
      pywebio/platform/__init__.py
  4. 14 3
      pywebio/platform/tpl/index.html
  5. 104 21
      pywebio/platform/utils.py
  6. 9 8
      pywebio/utils.py

+ 0 - 2
docs/guide.rst
مشاهده فایل 

@@ -663,8 +663,6 @@ And if the files have been modified after run `path_deploy() <pywebio.platform.p
 
 
 
 You can also use the command ``pywebio-path-deploy`` to start a server just like using `path_deploy() <pywebio.platform.path_deploy>`. For more information, refer ``pywebio-path-deploy --help``
 
 You can also use the command ``pywebio-path-deploy`` to start a server just like using `path_deploy() <pywebio.platform.path_deploy>`. For more information, refer ``pywebio-path-deploy --help``
 
 
 
-In Server mode, you can use `pywebio.platform.seo()` to set the `SEO <https://en.wikipedia.org/wiki/Search_engine_optimization>`_ information. If ``seo()`` is not used, the `docstring <https://www.python.org/dev/peps/pep-0257/>`_ of the task function will be regarded as SEO information by default.
 
-
 
 .. attention::
 
 .. attention::
 
 
 
     Note that in Server mode, all functions from ``input``, ``output`` and ``session`` modules can only be called in the context of task functions. For example, the following code is **not allowed**::
 
     Note that in Server mode, all functions from ``input``, ``output`` and ``session`` modules can only be called in the context of task functions. For example, the following code is **not allowed**::

+ 1 - 0
pywebio/__init__.py
مشاهده فایل 

@@ -8,6 +8,7 @@ from .__version__ import __description__, __url__, __version__
 
 from .exceptions import SessionException, SessionClosedException, SessionNotFoundException
 
 from .exceptions import SessionException, SessionClosedException, SessionNotFoundException
 
 from .platform import start_server
 
 from .platform import start_server
 
 from .platform.bokeh import try_install_bokeh_hook
 
 from .platform.bokeh import try_install_bokeh_hook
 
+from .platform.utils import config
 
 from .utils import STATIC_PATH
 
 from .utils import STATIC_PATH
 
 
 
 try_install_bokeh_hook()
 
 try_install_bokeh_hook()

+ 2 - 1
pywebio/platform/__init__.py
مشاهده فایل 

@@ -110,7 +110,7 @@ Also other dependency packages are required. You can install them with the follo
 
 
 
 Other
 
 Other
 
 --------------
 
 --------------
 
-.. autofunction:: pywebio.platform.seo
 
+.. autofunction:: pywebio.config
 
 .. autofunction:: pywebio.platform.run_event_loop
 
 .. autofunction:: pywebio.platform.run_event_loop
 
 
 
 """
 
 """
 
@@ -118,4 +118,5 @@ Other
 
 from .httpbased import run_event_loop
 
 from .httpbased import run_event_loop
 
 from .tornado import start_server
 
 from .tornado import start_server
 
 from .utils import seo
 
 from .utils import seo
 
+from .utils import config
 
 from .path_deploy import path_deploy_http, path_deploy
 
 from .path_deploy import path_deploy_http, path_deploy

+ 14 - 3
pywebio/platform/tpl/index.html
مشاهده فایل 

@@ -17,6 +17,12 @@
 
     <link rel="stylesheet" href="{{ base_url }}codemirror/base16-light.min.css">
 
     <link rel="stylesheet" href="{{ base_url }}codemirror/base16-light.min.css">
 
     <link rel="stylesheet" href="{{ base_url }}css/toastify.min.css">
 
     <link rel="stylesheet" href="{{ base_url }}css/toastify.min.css">
 
     <link rel="stylesheet" href="{{ base_url }}css/app.css">
 
     <link rel="stylesheet" href="{{ base_url }}css/app.css">
 
+    {% for css in css_file %}
 
+        {% if css %}<link rel="stylesheet" href="{{ css }}">{% end %}
 
+    {% end %}
 
+    {% if css_style %}
 
+    <style>{% raw css_style %}</style>
 
+    {% end %}
 
 </head>
 
 </head>
 
 <body>
 
 <body>
 
 <div class="pywebio">
 
 <div class="pywebio">
 
@@ -60,9 +66,12 @@
 
         $('#output-container').html('<div class="alert alert-danger" role="alert"> Sorry, this website does not support IE browser. ☹ </div>');
 
         $('#output-container').html('<div class="alert alert-danger" role="alert"> Sorry, this website does not support IE browser. ☹ </div>');
 
 </script>
 
 </script>
 
 <script src="{{ base_url }}js/pywebio.min.js"></script>
 
 <script src="{{ base_url }}js/pywebio.min.js"></script>
 
-
 
-<script src="{{ base_url }}js/require.min.js"></script> <!-- JS module loader -->
 
+{% for js in js_file %}
 
+    {% if js %}<script src="{{ js }}"></script>{% end %}
 
+{% end %}
 
 {% if script %}
 
 {% if script %}
 
+<script src="{{ base_url }}js/require.min.js"></script> <!-- JS module loader -->
 
+
 
 <script>
 
 <script>
 
 
 
     require.config({
 
     require.config({
 
@@ -92,6 +101,8 @@
 
     });
 
     });
 
 </script>
 
 </script>
 
 {% end %}
 
 {% end %}
 
-
 
+{% if js_code %}
 
+<script>{% raw js_code %}</script>
 
+{% end %}
 
 </body>
 
 </body>
 
 </html>
 
 </html>

+ 104 - 21
pywebio/platform/utils.py
مشاهده فایل 

@@ -12,7 +12,7 @@ from tornado import template
 
 from ..__version__ import __version__ as version
 
 from ..__version__ import __version__ as version
 
 from ..exceptions import PyWebIOWarning
 
 from ..exceptions import PyWebIOWarning
 
 from ..utils import isgeneratorfunction, iscoroutinefunction, get_function_name, get_function_doc, \
 
 from ..utils import isgeneratorfunction, iscoroutinefunction, get_function_name, get_function_doc, \
 
-    get_function_seo_info
 
+    get_function_attr
 
 
 
 """
 
 """
 
 The maximum size in bytes of a http request body or a websocket message, after which the request or websocket is aborted
 
 The maximum size in bytes of a http request body or a websocket message, after which the request or websocket is aborted
 
@@ -25,7 +25,9 @@ DEFAULT_CDN = "https://cdn.jsdelivr.net/gh/wang0618/PyWebIO-assets@v{version}/"
 
 
 
 BOOTSTRAP_VERSION = '4.4.1'
 
 BOOTSTRAP_VERSION = '4.4.1'
 
 
 
-AppMeta = namedtuple('App', 'title description')
 
+_global_config = {'title': 'PyWebIO Application'}
 
+config_keys = ['title', 'description', 'js_file', 'js_code', 'css_style', 'css_file']
 
+AppMeta = namedtuple('App', config_keys)
 
 
 
 _here_dir = path.dirname(path.abspath(__file__))
 
 _here_dir = path.dirname(path.abspath(__file__))
 
 _index_page_tpl = template.Template(open(path.join(_here_dir, 'tpl', 'index.html'), encoding='utf8').read())
 
 _index_page_tpl = template.Template(open(path.join(_here_dir, 'tpl', 'index.html'), encoding='utf8').read())
 
@@ -50,9 +52,10 @@ def render_page(app, protocol, cdn):
 
 
 
     bootstrap_css = bootstrap_css_url()
 
     bootstrap_css = bootstrap_css_url()
 
 
 
-    return _index_page_tpl.generate(title=meta.title or 'PyWebIO Application',
 
-                                    description=meta.description, protocol=protocol,
 
-                                    script=True, content='', base_url=cdn, bootstrap_css=bootstrap_css)
 
+    return _index_page_tpl.generate(title=meta.title, description=meta.description, protocol=protocol,
 
+                                    script=True, content='', base_url=cdn, bootstrap_css=bootstrap_css,
 
+                                    js_file=meta.js_file or [], js_code=meta.js_code, css_style=meta.css_style,
 
+                                    css_file=meta.css_file or [])
 
 
 
 
 
 def bootstrap_css_url():
 
 def bootstrap_css_url():
 
@@ -64,6 +67,7 @@ def bootstrap_css_url():
 
     bootswatch_themes = {'flatly', 'yeti', 'cerulean', 'pulse', 'journal', 'cosmo', 'sandstone', 'simplex', 'minty',
 
     bootswatch_themes = {'flatly', 'yeti', 'cerulean', 'pulse', 'journal', 'cosmo', 'sandstone', 'simplex', 'minty',
 
                          'slate', 'superhero', 'lumen', 'spacelab', 'materia', 'litera', 'sketchy', 'cyborg', 'solar',
 
                          'slate', 'superhero', 'lumen', 'spacelab', 'materia', 'litera', 'sketchy', 'cyborg', 'solar',
 
                          'lux', 'united', 'darkly'}
 
                          'lux', 'united', 'darkly'}
 
+
 
     if theme_name in bootswatch_themes:
 
     if theme_name in bootswatch_themes:
 
         return 'https://cdn.jsdelivr.net/npm/bootswatch@{version}/dist/{theme}/bootstrap.min.css'.format(
 
         return 'https://cdn.jsdelivr.net/npm/bootswatch@{version}/dist/{theme}/bootstrap.min.css'.format(
 
             version=BOOTSTRAP_VERSION, theme=theme_name)
 
             version=BOOTSTRAP_VERSION, theme=theme_name)
 
@@ -92,10 +96,10 @@ def cdn_validation(cdn, level='warn', stacklevel=3):
 
 
 
 
 
 def parse_app_metadata(func):
 
 def parse_app_metadata(func):
 
-    """解析pywebio app元数据"""
 
-    seo_info = get_function_seo_info(func)
 
-    if seo_info:
 
-        return AppMeta(*seo_info)
 
+    """Get metadata form pywebio task function, fallback to global config in empty meta field."""
 
+    prefix = '_pywebio_'
 
+    attrs = get_function_attr(func, [prefix + k for k in config_keys])
 
+    meta = AppMeta(**{k: attrs.get(prefix + k) for k in config_keys})
 
 
 
     doc = get_function_doc(func)
 
     doc = get_function_doc(func)
 
     parts = doc.strip().split('\n\n', 1)
 
     parts = doc.strip().split('\n\n', 1)
 
@@ -104,7 +108,16 @@ def parse_app_metadata(func):
 
     else:
 
     else:
 
         title, description = parts[0], ''
 
         title, description = parts[0], ''
 
 
 
-    return AppMeta(title, description)
 
+    if not meta.title:
 
+        meta = meta._replace(title=title, description=description)
 
+
 
+    # fallback to global config
 
+    for key in config_keys:
 
+        if not getattr(meta, key, None) and _global_config.get(key):
 
+            kwarg = {key: _global_config.get(key)}
 
+            meta = meta._replace(**kwarg)
 
+
 
+    return meta
 
 
 
 
 
 _app_list_tpl = template.Template("""
 
 _app_list_tpl = template.Template("""
 
@@ -274,7 +287,7 @@ def seo(title, description=None, app=None):
 
     :param str description: Application description
 
     :param str description: Application description
 
     :param callable app: PyWebIO task function
 
     :param callable app: PyWebIO task function
 
 
 
-    If not ``seo()`` is not used, the `docstring <https://www.python.org/dev/peps/pep-0257/>`_ of the task function will be regarded as SEO information by default.
 
+    If ``seo()`` is not used, the `docstring <https://www.python.org/dev/peps/pep-0257/>`_ of the task function will be regarded as SEO information by default.
 
 
 
     ``seo()`` can be used in 2 ways: direct call and decorator::
 
     ``seo()`` can be used in 2 ways: direct call and decorator::
 
 
 
@@ -299,18 +312,88 @@ def seo(title, description=None, app=None):
 
         ])
 
         ])
 
 
 
     .. versionadded:: 1.1
 
     .. versionadded:: 1.1
 
+    .. deprecated:: 1.4
 
+        Use :func:`pywebio.config` instead.
 
     """
 
     """
 
+    import warnings
 
+    warnings.warn("`pywebio.platform.seo()` is deprecated since v1.4 and will remove in the future version, "
 
+                  "use `pywebio.config` instead", DeprecationWarning, stacklevel=2)
 
 
 
     if app is not None:
 
     if app is not None:
 
-        return seo(title, description)(app)
 
-
 
-    def decorator(func):
 
-        try:
 
-            func = partial(func)
 
-            func._pywebio_title = title
 
-            func._pywebio_description = description or ''
 
-        except Exception:
 
+        return config(title=title, description=description)(app)
 
+
 
+    return config(title=title, description=description)
 
+
 
+
 
+def config(*, title=None, description=None, js_code=None, js_file=[], css_style=None, css_file=[]):
 
+    """PyWebIO application configuration
 
+
 
+    :param str title: Application title
 
+    :param str description: Application description
 
+    :param str js_code: The javascript code that you want to inject to page.
 
+    :param str/list js_file: The javascript files that inject to page, can be a URL in str or a list of it.
 
+    :param str css_style: The CSS style that you want to inject to page.
 
+    :param str/list css_file: The CSS files that inject to page, can be a URL in str or a list of it.
 
+
 
+    ``config()`` can be used in 2 ways: direct call and decorator.
 
+    If you call ``config()`` directly, the configuration will be global.
 
+    If you use ``config()`` as decorator, the configuration will only work on single PyWebIO application function.
 
+    ::
 
+
 
+        config(title="My application")
 
+
 
+        @config(css_style="* { color:red }")
 
+        def app():
 
+            put_text("hello PyWebIO")
 
+
 
+    ``title`` and ``description`` are used for SEO, which are provided when indexed by search engines.
 
+    If no ``title`` and ``description`` set for a PyWebIO application function,
 
+    the `docstring <https://www.python.org/dev/peps/pep-0257/>`_ of the function will be used as title and description by default::
 
+
 
+        def app():
 
+            \"""Application title
 
+
 
+            Application description...
 
+            (A empty line is used to separate the description and title)
 
+            \"""
 
             pass
 
             pass
 
-        return func
 
 
 
-    return decorator
 
+    The above code is equal to::
 
+
 
+        @config(title="Application title", description="Application description...")
 
+        def app():
 
+            pass
 
+
 
+    .. versionadded:: 1.4
 
+    """
 
+    if isinstance(js_file, str):
 
+        js_file = [js_file]
 
+    if isinstance(css_file, str):
 
+        css_file = [css_file]
 
+
 
+    configs = locals()
 
+
 
+
 
+    class Decorator:
 
+        def __init__(self):
 
+            self.called = False
 
+
 
+        def __call__(self, func):
 
+            self.called = True
 
+            try:
 
+                func = partial(func)  # to make a copy of the function
 
+                for key, val in configs.items():
 
+                    if val:
 
+                        setattr(func, '_pywebio_%s' % key, val)
 
+            except Exception:
 
+                pass
 
+            return func
 
+
 
+        def __del__(self):  # if not called as decorator, set the config to global
 
+            if self.called:
 
+                return
 
+
 
+            global _global_config
 
+            _global_config = configs
 
+
 
+    return Decorator()

+ 9 - 8
pywebio/utils.py
مشاهده فایل 

@@ -180,18 +180,19 @@ def get_function_doc(func):
 
     return inspect.getdoc(func) or ''
 
     return inspect.getdoc(func) or ''
 
 
 
 
 
-def get_function_seo_info(func):
 
-    """获取使用 pywebio.platform.utils.seo() 设置在函数上的SEO信息
 
-    """
 
-    if hasattr(func, '_pywebio_title'):
 
-        return func._pywebio_title, func._pywebio_description
 
+def get_function_attr(func, attrs):
 
+    """Get the attribute values of the given function, even if the function is decorated by `functools.partial` """
 
+    values = {attr: getattr(func, attr) for attr in attrs if hasattr(func, attr)}
 
 
 
     while isinstance(func, functools.partial):
 
     while isinstance(func, functools.partial):
 
         func = func.func
 
         func = func.func
 
-        if hasattr(func, '_pywebio_title'):
 
-            return func._pywebio_title, func._pywebio_description
 
+        values.update({
 
+            attr: getattr(func, attr)
 
+            for attr in attrs
 
+            if hasattr(func, attr) and attr not in values
 
+        })
 
 
 
-    return None
 
+    return values
 
 
 
 
 
 class LimitedSizeQueue(queue.Queue):
 
 class LimitedSizeQueue(queue.Queue):