python學習筆記-為自定義類或者函數編寫help文檔，以及進行文檔測試

Kerr1Gan 發布于2019-07-25 11:18 / 2089人閱讀

摘要：在中我們可以利用模塊名或者類名的方式來查看類或者函數的文檔。例如，我們添加了文檔測試內容后如下所示由于我們寫了所以以上文檔測試只有在以入口文件執行的時候才會進行文檔測試。因此并不會在實際應用在執行文檔測試。

在python中我們可以利用help("模塊名")或者help(類名)的方式來查看類或者函數的文檔。但是它們是如何編寫的呢？
其實它們在類最前面或者方法的最前面用"""三個雙引號包裹了多行注釋。這些內容就會被Python當成幫助文檔。

那幫助文檔一般會寫什么內容呢？主要包括以下內容：

該類或者函數的主要作用

傳入的值和輸出的值

一些特殊情況的說明

文檔測試內容

以上內容是個人的總結，但是并沒有看到相關的資料。

我們來舉一個例子：

class Apple(object):
    """ This is an Apple Class"""

    def get_color(self):
        """
        Get the Color of Apple.
        get_color(self) -> str
        """
        return "red"

在python terminal輸入

>>> from CallDemo import Apple
>>> help(Apple)

Help on class Apple in module CallDemo:

class Apple(__builtin__.object)
 |  This is an Apple Class
 |  
 |  Methods defined here:
 |  
 |  get_color(self)
 |      Get the Color of Apple.
 |      get_color(self) -> str
 |  
 |  ----------------------------------------------------------------------
 |  Data descriptors defined here:
 |  
 |  __dict__
 |      dictionary for instance variables (if defined)
 |  
 |  __weakref__
 |      list of weak references to the object (if defined)

利用doctest進行文檔測試

我們在注釋中我們也可以doctest模塊進行文檔測試。

例如，我們添加了文檔測試內容后如下所示：

class Apple(object):
    """
    This is an Apple Class

    Example:
        >>> apple = Apple()
        >>> apple.get_color()
        "red"
        >>> apple.set_count(20)
        >>> apple.get_count()
        400

    """

    def get_color(self):
        """
        Get the Color of Apple.
        get_color(self) -> str
        """
        return "red"

    def set_count(self, count):
        self._count = count

    def get_count(self):
        return self._count * self._count


if __name__ == "__main__":
    import doctest

    doctest.testmod()

由于我們寫了

if __name__ == "__main__":
    import doctest

    doctest.testmod()

所以以上文檔測試只有在以入口文件執行的時候才會進行文檔測試。因此并不會在實際應用在執行文檔測試。

GPU云服務器云服務器 cdn 產品定義文檔電子文檔類怎么存儲 php 函數文檔測試數據文檔

文章版權歸作者所有，未經允許請勿轉載,若此文章存在違規行為，您可以聯系管理員刪除。

轉載請注明本文地址：http://specialneedsforspecialkids.com/yun/38322.html

[零基礎學python]Python文檔

摘要：軟件文檔或者源代碼文檔是指與軟件系統及其軟件工程過程有關聯的文本實體。而則認為軟件文檔是被軟件工程師之間用作溝通交流的一種方式，溝通的信息主要是有關所開發的軟件系統。則強調文檔的權威性，他認為文檔應該提供對軟件系統的精確描述。文檔，這個詞語在經常在程序員的嘴里冒出來，有時候他們還經常以文檔有沒有或者全不全為標準來衡量一個軟件項目是否高大上。那么，軟件中的文檔是什么呢？有什么要求呢？p...

why_rookie 2019-07-24 17:41 評論0 收藏0
[譯] Python 學習 —— __init__() 方法 4

摘要：同時，有多個類級別的靜態構造函數的方法。這個累贅，無論如何，是被傳遞到每個單獨的對象構造函數表達式中。我們可能只有幾個特定的擔憂，提供額外關鍵字參數給構造函數。注：原書作者 Steven F. Lott，原書名為 Mastering Object-oriented Python 沒有__init__()的無狀態對象下面這個示例，是一個簡化去掉了__init__()的類。這是一個常見...

yvonne 2019-07-31 11:38 評論0 收藏0
Django 學習小組：博客開發實戰第一周教程 —— 編寫博客的 Model 與主頁面

摘要：學習小組是由我發起的一個促進新手互相學習互相幫助的組織。當然如果你不喜歡英文，可以看我們的中文翻譯版本入門教程中文翻譯版。如果模板文件中有如下代碼那么渲染時就會循環渲染篇文章，并且也會被存儲在數據庫中文章的標題取代。本教程內容已過時，更新版教程請訪問： django 博客開發入門教程。本節是 Django Blog 項目的開篇，是?Django 學習小組的集體學習成果。Django...

陳江龍 2019-07-25 10:25 評論0 收藏0
[零基礎學python]類的細節

摘要：在對象接口后包裝其實現的細節，從而隔離了代碼的修改對用戶產生的影響。類提供了一個新的本地作用域，最小化了變量名沖突。類其實并沒有結束，不過本講座到此對類暫告一段。前面對類的有關內容已經描述不少了，其實話題遠遠沒有結束，不過對于初學者，掌握這些已經算是入門，在以后的實踐中，還需要進行體會和感悟。這幾天和幾個朋友以各種途徑討論過OOP的相關問題，他們是：令狐蟲、Frank、晉劍、小馮...

Fundebug 2019-07-24 17:44 評論0 收藏0
使用 Python 編寫一個 Memcached 的 CLI

摘要：原文地址近期在項目中使用到了相比較為齊全的工具這個非關系型數據庫客戶端只能通過與服務器端進行交互于是有了為這個數據編寫個簡便的客戶端工具的想法。如果用戶沒有傳入對應的參數則使用默認的參數進行綁定。原文地址: http://52sox.com/use-python-write-a-memcached-cli/ 近期在項目中使用到了Memcached,相比redis較為齊全的工具,這個非...

RdouTyping 2019-08-06 12:25 評論0 收藏0