Code Improvement (pyecharts#462)

* 🔨 remove magic constants

* 📚 advertise that render_notebook is removed. fix pyecharts#456 forever

README.md

@@ -87,7 +87,7 @@ pyecharts exposes chart API and template API so that it can work on some common
 
 ### Work on Jupyter Notebook
 
-In the Notebook cell ,you can simply call the instance itself to diplay the chart.
+In the Notebook cell, you can simply pass on chart instance itself to Jupyter, which will diplay the chart. Please note **render_notebook** function has been removed.
 
 All chart classes in pyecharts implement the `_repr_html_` interface about [IPython Rich Display](http://ipython.readthedocs.io/en/stable/config/integrating.html#rich-display) .
 

pyecharts/base.py

@@ -141,6 +141,11 @@ def cast(seq):
                 v_lst.append(seq[key])
         return k_lst, v_lst
 
+    def render_notebook(self):
+        warnings.warn('Implementation has been removed. ' +
+                      'Please pass the chart instance directly to Jupyter.' +
+                      'If you need more help, please read documentation')
+
     def _repr_html_(self):
         """ 渲染配置项并将图形显示在 notebook 中
         chart/page => charts

pyecharts/constants.py

@@ -12,6 +12,8 @@
 JPEG = 'jpeg'
 DEFAULT_HTML = 'html'
 JUPYTER_PRESENTATIONS = [SVG, PNG, JPEG, DEFAULT_HTML]
+ENVIRONMENT_PLUGIN_TYPE = 'pyecharts_environment'
+JS_EXTENSION_PLUGIN_TYPE = 'pyecharts_js_extension'
 
 SYMBOL = {
     "plane": 'path://M1705.06,1318.313v-89.254l-319.9-221.799l0.073-208.'

pyecharts/engine.py

@@ -1,13 +1,15 @@
 # coding=utf-8
 from __future__ import unicode_literals
 
+import codecs
+
 from jinja2 import Environment, FileSystemLoader, environmentfunction, Markup
+from lml.plugin import PluginManager, PluginInfo
 
-import codecs
 import pyecharts.conf as conf
 import pyecharts.utils as utils
+import pyecharts.constants as constants
 
-from lml.plugin import PluginManager, PluginInfo
 
 LINK_SCRIPT_FORMATTER = '<script type="text/javascript" src="{}"></script>'
 EMBED_SCRIPT_FORMATTER = '<script type="text/javascript">\n{}\n</script>'
@@ -136,7 +138,8 @@ def __init__(self, *args, **kwargs):
         self.globals.update(ECHAERTS_TEMPLATE_FUNCTIONS)
 
 
-@PluginInfo('pyecharts_environment', tags=['html'])
+@PluginInfo(constants.ENVIRONMENT_PLUGIN_TYPE,
+            tags=[constants.DEFAULT_HTML])
 class EchartsEnvironment(BaseEnvironment):
     """
     Built-in jinja2 template engine for pyecharts
@@ -214,7 +217,8 @@ def __init__(self):
         Register with lml that this class manages 'pyecharts_environment'
         extension
         """
-        super(EnvironmentManager, self).__init__('pyecharts_environment')
+        super(EnvironmentManager, self).__init__(
+            constants.ENVIRONMENT_PLUGIN_TYPE)
 
     def get_a_environment(self, file_type, **kwargs):
         """

pyecharts/js_extensions.py

@@ -8,6 +8,7 @@
 from lml.plugin import PluginManager
 
 import pyecharts.exceptions as exceptions
+import pyecharts.constants as constants
 
 # here are all plugins from pyecharts team
 OFFICIAL_PLUGINS = [
@@ -84,7 +85,8 @@ def _resolve_jshost(self, jshost, use_github=False):
 
 class JsExtensionManager(PluginManager):
     def __init__(self):
-        super(JsExtensionManager, self).__init__('pyecharts_js_extension')
+        super(JsExtensionManager, self).__init__(
+            constants.JS_EXTENSION_PLUGIN_TYPE)
         self.js_extensions = []
 
     def get_all_extensions(self):
@@ -101,7 +103,7 @@ def get_a_extension(self, name):
         if len(self.js_extensions) == 0:
             self.get_all_extensions()
         for __extension__ in self.js_extensions:
-            if __extension__.registry['JS_FOLDER'] == name:
+            if __extension__.registry[REGISTRY_JS_FOLDER] == name:
                 return __extension__
         return None