Merge pull request egrcc#56 from johnnyluck/master

egrcc · egrcc · commit ba72000471c4 · 2016-04-25T01:07:15.000+08:00
Add new feature Post and Column for zhihu with documentation and test
diff --git a/README.rst b/README.rst
@@ -351,7 +351,101 @@ Collection 代表一个收藏夹，处理收藏夹相关操作。创建一个 Co
     print answers 
     # <generator object get_all_answer at 0x7fe12a29b280>
     # 代表所有答案的生成器对象
+
+
+Post：获取知乎文章
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Post 代表一个文章， Post 对象需传入该文章的 url ，如：
+
+.. code-block:: python
+
+    from zhihu import Post
+    
+    url = "http://zhuanlan.zhihu.com/p/20235601"
+    post = Post(url)
+
+得到 Post 对象后，可以获取该文章的一些信息：
+
+.. code-block:: python
+
+    # -*- coding: utf-8 -*-
+    from zhihu import Post
+    
+    url = "http://zhuanlan.zhihu.com/p/20770968"
+    post = Post(url)
+
+    # 获取该文章的标题
+    title = post.get_title()
+    # 获取该文章的内容
+    content = post.get_content()
+    # 获取该文章的作者
+    author = post.get_author()
+    # 获取该文章的所属专栏
+    column = post.get_column()
+    # 获取该文章所属话题
+    topics = post.get_topics()
+
+    print title  # 输出：夜读书|四月十九日
+    print content
+    # 输出：
+    # <p>各位，晚上好。<br> ...
+    # ......
+    print author
+    # 输出： <zhihu.User instance at 0x75ec0fd0>
+    for topic in topics:
+        print topic,  # 输出：阅读
+    print column  
+    # 输出：<zhihu.Column instance at 0x75eb3eb8>
+    # Column类对象
+    
+Column：获取知乎专栏
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Column 代表一个专栏 Column 对象需传入该专栏 url ，如：
+
+.. code-block:: python
+
+    from zhihu import Column
     
+    url = "http://zhuanlan.zhihu.com/daily"
+    column = Column(url)
+
+得到 Column 对象后，可以获取该专栏的一些信息：
+
+.. code-block:: python
+
+    # -*- coding: utf-8 -*-
+    from zhihu import Column
+    
+    url = "http://zhuanlan.zhihu.com/daily"
+    column = Column(url)
+
+    # 获取该专栏的标题
+    title = column.get_title()
+    # 获取该专栏的描述
+    description = column.get_description()
+    # 获取该专栏的作者
+    creator = column.get_creator()
+    # 获取该专栏的文章数
+    posts_num = column.get_posts_num()
+    # 获取该专栏的所有文章
+    posts = column.get_all_posts()
+
+    print title  # 输出：知乎日报
+    print description
+    # 输出：
+    # 知乎日报启动画面接受所有摄影师朋友们的投稿，将作品链接（如 Flickr、LOFTER 等等），发至邮箱 qidong (at) zhihu.com，并附上您的知乎个人页面地址即可。
+    # 
+    # 详细投稿要求: http://t.cn/zQyEpN5
+
+    print creator  
+    # 输出：<zhihu.User instance at 0x75e33eb8>
+    # User类对象
+    print posts_num # 150 
+    print posts
+    # 输出：<generator object get_all_posts at 0x75e33bc0>
+    # Post类对象
 
 综合实例
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -669,7 +763,104 @@ zhihu.Collection ---- 知乎收藏夹操作类
   **Returns**： 包含该收藏夹下前 n 个回答的 generator 对象。其中每一个元素为代表一个回答的 Answer 对象
 
 
+zhihu.Column ---- 知乎专栏操作类
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+*class* zhihu. **Column** (*Column_url*)
+
+ Column 以 url 为唯一标识，创建一个 Column 对象实例必须传入一个代表知乎专栏的 url （如：http://zhuanlan.zhihu.com/daily），需包含“http(s)://”。如果传入的不是代表专栏的 url ，程序会报错。通过调用 Column 类的一系列方法，获得该专栏的一些信息。
+ 
+ **Parameters**：
+  * **column_url** -- 该专栏的链接，字符串
+  
+ **Returns**： 一个 Column 实例对象
+
+ **get_title** ()
+ 
+  得到该专栏的题目。
+  
+  **Returns**： 一个代表题目的字符串 
+ 
+ **get_creator** ()
+ 
+  得到该专栏的创建者 。
+  
+  **Returns**： 一个 User 对象
+ 
+ **get_description** ()
+ 
+  得到该专栏的描述
+  
+  **Returns**： 一个专栏描述的字符串
+
+ **get_followers_num** ()
+
+  得到该专栏的关注人数
+
+  **Returns**： 一个 int 型的整数
+ 
+ **get_posts_num** ()
+
+  得到该专栏的所有文章数
+
+  **Returns**： 一个 int 型的整数
+ 
+ **get_content** ()
+ 
+  得到该答案的内容。
+  
+  **Returns**： 一个字符串
+
+ **get_posts** ()
+
+  得到该专栏的所有文章
+
+  **Returns**：包含所有文章的 generator 对象。其中每一个元素为代表一个文章 Post 对象
+ 
+
+zhihu.Post ---- 知乎文章操作类
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+*class* zhihu. **Post** (*Post_url*)
+
+ Post 以 url 为唯一标识，创建一个 Post 对象实例必须传入一个代表知乎文章的 url （如：http://zhuanlan.zhihu.com/p/20235601），需包含“http(s)://”。如果传入的不是代表文章的 url ，程序会报错。通过调用 Post 类的一系列方法，获得该文章的一些信息。
+ 
+ **Parameters**：
+  * **post_url** -- 该文章的链接，字符串
+  
+ **Returns**： 一个 Post 实例对象
+
+ **get_title** ()
+ 
+  得到该文章的题目。
+  
+  **Returns**： 一个代表题目的字符串 
+ 
+ **get_author** ()
+ 
+  得到该文章的作者 。
+  
+  **Returns**： 一个 User 对象
+ 
+ **get_content** ()
+ 
+  得到该文章的内容
+  
+  **Returns**： 一个文章描述的字符串
 
+ **get_topics** ()
+ 
+  得到该文章的话题。
+  
+  **Returns**： 一个列表
+
+ **get_column** ()
+
+  得到该文章的所属专栏
+
+  **Returns**：一个 Column 的实例对象
+ 
+  
 联系我
 ----------
 
diff --git a/test.py b/test.py
@@ -25,6 +25,8 @@
 from zhihu import Answer
 from zhihu import User
 from zhihu import Collection
+from zhihu import Post
+from zhihu import Column
 
 
 def question_test(url):
@@ -197,6 +199,56 @@ def collection_test(collection_url):
     # 代表所有答案的生成器对象
 
 
+def post_test(post_url):
+    post = Post(post_url)
+    
+    # 获取该文章的标题
+    title = post.get_title()
+    # 获取该文章的内容
+    content = post.get_content()
+    # 获取该文章的作者
+    author = post.get_author()
+    # 获取该文章的所属专栏
+    column = post.get_column()
+    # 获取该文章所属话题
+    topics = post.get_topics()
+    
+    print title  # 输出：
+    print content
+    for topic in topics:
+        print topic,  # 输出：
+    print "\n"
+    print author  
+    # 输出：<zhihu.User instance at 0x7f8b6582d0e0>
+    # User类对象
+    print column  
+    # 输出：<zhihu.Column instance at 0x7f8b6582d0e0>
+    # Column类对象
+
+
+def column_test(column_url):
+
+    column = Column(column_url)
+    
+    # 获取该专栏的标题
+    title = column.get_title()
+    # 获取该专栏的描述
+    description = column.get_description()
+    # 获取该专栏的作者
+    creator = column.get_creator()
+    # 获取该专栏的文章数
+    posts_num = column.get_posts_num()
+    # 获取该专栏的所有文章
+    posts = column.get_all_posts()
+    
+    print title  
+    print description
+    print creator  
+    # 输出：<zhihu.User instance at 0x7f8b6582d0e0>
+    # User类对象
+    print posts_num  
+    print posts
+    
 def test():
     url = "http://www.zhihu.com/question/24269892"
     question = Question(url)
@@ -231,6 +283,10 @@ def main():
     user_test(user_url)
     collection_url = "http://www.zhihu.com/collection/36750683"
     collection_test(collection_url)
+    post_url = "http://zhuanlan.zhihu.com/p/20770968"
+    post_test(post_url)
+    column_url = "http://zhuanlan.zhihu.com/daily"
+    column_test(column_url)
     test()
 
 
diff --git a/zhihu.py b/zhihu.py
