將Python 3轉換爲可以通過autodoc讀取的「簡單」python

我在Python 3中編寫了一個程序，並且正在使用Sphinx來記錄它。 Sphinx的autodoc很棒，但它只適用於Python 2.一些模塊在autodoc中工作正常，但是模塊不能。一些示例：Python 2抱怨Python 3風格的元類，以及Python 2中不再存在的某些模塊，如configparser。這很煩人，因爲它無法從該文件導入文檔。將Python 3轉換爲可以通過autodoc讀取的「簡單」python

我不想在Python 2中重寫整個程序，但是我想使用autodoc。

我想到的一個想法是一個小程序，它讀取每個Python文件並刪除所有功能，但只留下基本功能和類的文檔字符串（因爲autodoc導入每個模塊並讀取特定函數或類的文檔字符串）。

import configparser 
import os 

class TestClass: 
    """ 
    I am a class docstring. 
    """ 
    def method(self, argument): 
     """ 
     I am a method docstring. 
     """ 
     #Some code here 
     print(os.getcwd()) 

def TestFunction(): 
    """ 
    I am a function docstring. 
    """ 
    #Some more useless code here 
    return os.path.join("foo", "bar")

成...

class TestClass: 
    """ 
    I am a class docstring. 
    """ 
    def method(self, argument): 
     """ 
     I am a method docstring. 
     """ 
     pass 

def TestFunction(): 
    """ 
    I am a function docstring. 
    """ 
    pass

這樣處理的碼可通過車博士讀，但仍然有文檔字符串這是我真正需要的。這是解決這個問題的最好方法，並且沒有人對如何編寫轉換代碼的小程序有任何建議。

我可以很容易地用一些正則表達式去除元類問題，但是我正在努力解決其餘問題。

m = re.search("\(metaclass=.*\)", file_content) 
if m: 
    file_content = "".join(file_content[:m.start()], file_content[m.end():])

請問AST模塊是有用的？

謝謝。

來源

2011-04-09 James

你可以只安裝獅身人面像的開發版本，它支持Python 3

pip-3.2 install hg+https://bitbucket.org/birkenfeld/sphinx

我測試車博士功能上你的類和它的工作。

來源

2011-04-11 20:25:54

哇，謝謝你。迄今爲止最好的解決方案。 – James 2011-04-11 21:02:34

通常情況下，解決方案是在代碼中添加try/except子句。

的Python 2.6有configparser但它被稱爲ConfigParser（Python 3中改變了駝峯名全部小寫）

所以像：

try: 
    import configparser 
except ImportError: 
    #we are in 2.x 
    import ConfigParser as configparser

你可能想要做一些事情像這是破碎的地方。兩者之間。雖然我不確定要處理兩者之間的元類。

來源

2011-04-09 16:30:39

確實會有效......但我並不想完全通過我的代碼來解決autodoc問題。這有效地將我的程序移植到Python 2和Python 3中！我真正需要的是一個小的（我希望！）腳本來將代碼處理爲autodoc可以無任何問題導入的表單。不管怎麼說，還是要謝謝你。 – James 2011-04-09 19:26:57

兩件事情，保羅的答案可能是想要的，創建一個僅限於Python 3的版本限制了你的應用程序的使用。並非所有人都在使用python 3，因爲有些庫尚未被移植。在python 3更爲主流之前，在2.x和3.x之間編寫兼容的代碼是最理想的解決方案。 – 2011-04-09 20:17:18

有一個3to2 library可以將Python 3代碼轉換爲Python 2.您可以將其與Sphinx一起使用。

來源

2011-04-09 16:53:51

將Python 3轉換爲可以通過autodoc讀取的「簡單」python

回答

相關問題