Merge pull request #170 from whtsky/config-docs

Config docs

Author: helloqiu

.travis.yml

@@ -18,9 +18,9 @@ matrix:
       - PYTHON_VERSION=3.5
       - PYTHON_INSTALL_METHOD=macpython
     - osx_image: xcode7.3  # OS X 10.11
-    - osx_image: xcode8.1 # macOS 10.12
+    - osx_image: xcode8.2 # macOS 10.12
   allow_failures:
-    - osx_image: xcode8.1
+    - osx_image: xcode8.2
 cache:
   directories:
   - $HOME/.pyenv

docs/config.rst

@@ -0,0 +1,51 @@
+``WeRoBot.Config``
+=====================
+
+WeRoBot 使用 ``WeRoBot.Config`` 类来存储配置信息。  ``WeRoBot`` 类实例的 ``config`` 属性是一个 :class:`WeRobot.config.Config` 实例。
+
+:class:`WeRobot.config.Config` 继承自 `dict` 。因此， 你可以像使用普通 dict 一样使用它 ::
+
+    from werobot import WeRoBot
+    robot = WeRoBot(token='2333')
+
+    robot.config.update(
+        HOST='0.0.0.0',
+        PORT=80
+    )
+
+与普通 `dict` 不同的是， 你可以先把配置文件保存在一个对象或是文件中， 然后在 :class:`WeRoBot.config.Config` 中导入配置 ::
+
+    from werobot import WeRoBot
+    robot = WeRoBot(token='2333')
+
+    class MyConfig(object):
+        HOST = '0.0.0.0'
+        PORT = 80
+
+    robot.config.from_object(MyConfig)
+    robot.config.from_pyfile("config.py")
+
+
+默认配置
+----------
+
+.. code:: python
+
+    dict(
+        TOKEN=None,
+        SERVER="auto",
+        HOST="127.0.0.1",
+        PORT="8888",
+        SESSION_STORAGE=None,
+        APP_ID=None,
+        APP_SECRET=None,
+        ENCODING_AES_KEY=None
+    )
+
+
+API
+----------
+
+.. module:: werobot.config
+.. autoclass:: Config
+    :members:

docs/index.rst

@@ -15,6 +15,7 @@ WeRoBot 是一个微信公众号开发框架。
     events
     replies
     session
+    config
     contrib
     error-page
     client

werobot/config.py

@@ -25,6 +25,7 @@ class Config(dict):
     def from_pyfile(self, filename):
         """
         在一个 Python 文件中读取配置。
+
         :param filename: 配置文件的文件名。
         """
         d = imp.new_module('config')
@@ -37,6 +38,7 @@ def from_pyfile(self, filename):
     def from_object(self, obj):
         """
         在给定的 Python 对象中读取配置。
+
         :param obj: 一个 Python 对象
         """
         for key in dir(obj):

werobot/robot.py

@@ -19,9 +19,14 @@
 __all__ = ['BaseRoBot', 'WeRoBot']
 
 _DEFAULT_CONFIG = dict(
+    TOKEN=None,
     SERVER="auto",
     HOST="127.0.0.1",
-    PORT="8888"
+    PORT="8888",
+    SESSION_STORAGE=None,
+    APP_ID=None,
+    APP_SECRET=None,
+    ENCODING_AES_KEY=None
 )