Merge branch 'dev'

Author: kinegratii

.travis.yml

@@ -11,7 +11,11 @@ env:
   - DJANGO_VERSION=2.0
 install:
   - pip install -r requirements.txt
+  - pip install -r requirements_dev.txt
   - pip install -q Django==$DJANGO_VERSION
   - pip install -q pyecharts==0.4.1
+  - python setup.py install
 script:
-  make test
+  - nosetests tests
+  - python example/manage.py test --noinput
+  - flake8 django_echarts tests example --ignore=E501 --max-complexity 10

django_echarts/__init__.py

@@ -2,5 +2,5 @@
 A django app for Echarts integration with pyecharts as chart builder.
 """
 
-__version__ = '0.3.4'
+__version__ = '0.3.5'
 __author__ = 'kinegratii'

django_echarts/datasets/charts.py

@@ -1,46 +1,59 @@
 # coding=utf8
-
+from collections import OrderedDict
 from django_echarts.utils.interfaces import merge_js_dependencies
 
 
 class NamedCharts:
     """
-    A list containing multiple named charts.
+    A data structure class containing multiple named charts.
     """
 
     def __init__(self, page_title='EChart', **kwargs):
         self.page_title = page_title
-        self._names = []
-        self._charts = []
-
-        for name, chart in kwargs.items():
-            self.add_chart(chart=chart, name=name)
+        self._charts = OrderedDict()
+        for k, v in kwargs.items():
+            self.add_chart(chart=v, name=k)
 
     def add_chart(self, chart, name=None):
         name = name or self._next_name()
-        self._names.append(name)
-        self._charts.append(chart)
+        self._charts[name] = chart
         return self
 
+    def _next_name(self):
+        return 'c{}'.format(len(self._charts))
+
+    # List-like feature
+
     def __iter__(self):
-        for chart in self._charts:
+        for chart in self._charts.values():
             yield chart
 
     def __len__(self):
         return len(self._charts)
 
+    # Dict-like feature
+
     def __contains__(self, item):
-        return item in self._names
+        return item in self._charts
 
-    def __getattr__(self, item):
-        try:
-            i = self._names.index(item)
-            return self._charts[i]
-        except ValueError:
-            return super().__getattr__(item)
+    def __getitem__(self, item):
+        if isinstance(item, int):
+            # c[1], Just compatible with Page
+            return list(self._charts.values())[item]
+        return self._charts[item]
 
-    def _next_name(self):
-        return 'c{}'.format(len(self._charts))
+    def __setitem__(self, key, value):
+        self._charts[key] = value
+
+    # Compatible
+
+    def add(self, achart_or_charts):
+        if not isinstance(achart_or_charts, (list, tuple, set)):
+            achart_or_charts = achart_or_charts,  # Make it a sequence
+        for c in achart_or_charts:
+            self.add_chart(chart=c)
+
+    # Chart-like feature
 
     @property
     def js_dependencies(self):

django_echarts/utils/interfaces.py

@@ -26,6 +26,14 @@ def to_css_length(l):
         return l
 
 
+def _flat(ele):
+    if hasattr(ele, 'js_dependencies'):
+        return list(ele.js_dependencies)
+    if isinstance(ele, (list, tuple, set)):
+        return ele
+    return ele,
+
+
 def merge_js_dependencies(*chart_or_name_list):
     front_required_items = ['echarts']
     front_optional_items = ['echartsgl']
@@ -41,14 +49,8 @@ def _add(_item):
             dependencies.append(_item)
 
     for d in chart_or_name_list:
-        if hasattr(d, 'js_dependencies'):
-            for x in d.js_dependencies:
-                _add(x)
-        elif isinstance(d, (list, tuple, set)):
-            for x in d:
-                _add(x)
-        elif isinstance(d, str):
-            _add(d)
+        for _d in _flat(d):
+            _add(_d)
     return front_required_items + [x for x in front_optional_items if x in fist_items] + dependencies
 
 

docs/_static/namedcharts-vs-page.png

@@ -1,6 +1,11 @@
 更新日志
 =========
 
+v0.3.5 (20180504)
+-----------------
+
+- `NamedCharts` 命名图表访问改为字典访问方式
+
 v0.3.4 (20180423)
 -----------------
 

docs/changelog.rst

@@ -55,9 +55,9 @@
 # built documents.
 #
 # The short X.Y version.
-version = '0.3.4'
+version = '0.3.5'
 # The full version, including alpha/beta/rc tags.
-release = '0.3.4'
+release = '0.3.5'
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.

docs/conf.py

@@ -155,7 +155,8 @@ django_echarts 提供两种方式的渲染视图，即：
 基本使用
 ++++++++
 
-视图代码
+
+在创建一个 `NamedCharts` 实例 `charts` ，后，使用 `add_chart` 添加一个图表对象，可以使用 `name` 为之起一个引用名称，如果没有指定引用名称，则使用 c0,c1 命名。
 
 ::
 
@@ -174,25 +175,50 @@ django_echarts 提供两种方式的渲染视图，即：
             names, lifes = fetch(battery_lifes, 'name', 'battery_life')
             bar = Bar('设备电量', page_title='设备电量', width='100%')
             bar.add("设备电量", names, lifes)
-            charts = NamedCharts().add_chart(pie, name='pie').add_chart(bar, name='bar')
+            charts = NamedCharts().add_chart(pie, name='pie').add_chart(bar)
             return charts
 
-在创建一个 `NamedCharts` 实例 `charts` ，后，使用 `add_chart` 添加一个图表对象，可以使用 `name` 为之起一个引用变量，之后可以像属性一样访问该图表对象。
+元素访问
+++++++++
+
+.. versionchanged:: 0.3.5
+   图表访问方式从 *属性访问* 改为 *字典访问* 。
+
+对于 包含若干图表的 `NamedCharts` 实例，可以像字典一样访问该图表对象。
+
+Python 代码的访问方式
+
+::
+
+    # 访问 pie 对象 page_title
+    print(charts['pie'].page_title)
+
+    # 访问 bar 对象 page_title
+    print(charts['c1'].page_title) # 推荐
+    print(charts[1].page_title) # 不再推荐
+
+模板代码的访问方式：
 
 ::
 
-    print(charts.pie.page_title) # 等价于 charts[0].page_title
+    {{ charts.pie.page_title }}
+    {{ charts.c1.page_title }}
 
-但是在 Django 模板中不推荐使用 `{{ charts.0.page_title }}` 的方式引用列表的元素，可以使用 `{{ charts.pie.page_title }}` 。
+注意
+
+::
+
+    无论是 Jinja2 模板还是 Django 模板，均不提倡使用 `charts.1` 形式访问列表中的某一个元素。
 
 NamedCharts VS Page
 +++++++++++++++++++
 
-区别。
+`NamedCharts` 内部使用 `collections.OrderedDict` 保存图表名称和实例，支持字典访问方式，同时扩展原有的 `Page` 的列表特性。
+
+具体差别如下表：
 
 .. image:: /_static/namedcharts-vs-page.png
 
-`NamedCharts` 内部使用两个列表分别保存图表名称和实例，对外保持一个列表的相关方法，同时支持属性访问，
 
 模板标签
 ---------
@@ -352,7 +378,7 @@ django-echarts 提供了一个包含若干个命令的 CLI 工具，这些命令
 ++++++++
 
 .. versionadded:: 0.2.2
-   新增 `download_lib_js` 和 `download_map_js` 命令。
+    新增 `download_lib_js` 和 `download_map_js` 命令。
 
 django-echarts 提供了一些下载命令，可以从远程地址下载文件到项目的静态目录中。这些命令包括：
 

docs/topics.rst

@@ -1,6 +1,5 @@
 # coding=utf8
 
-import json
 
 from pyecharts import Bar, Kline, Map, Pie, WordCloud
 

example/demo/demo_data.py

@@ -1,7 +1,7 @@
 # coding=utf8
 
 
-from django.conf.urls import url, include
+from django.conf.urls import url
 
 from demo import frontend_views, backend_views