从python文件生成doc,没有文档字符串和python文件中的任何注释

时间:2014-02-08 09:39:05

标签: python

如何从python文件创建doc? 我想从所有对象和类创建树和def,我通过读取变量来解释所有方法。 我想为我的python文件创建doc,这对任何doc都不好。例如,这是我的python文件:

from core.server import handler
from core.ras import ras_main,ras
from core.lib.sort import SortedList,SortedDic
from core.lib.general import *
from core.lib.multi_strs import MultiStr
from core.ippool import ippool_main

class RasHandler(handler.Handler):
    def __init__(self):
       handler.Handler.__init__(self,"ras")
        self.registerHandlerMethod("addNewRas")
        self.registerHandlerMethod("getRasInfo")
        self.registerHandlerMethod("getActiveRasIPs")
        self.registerHandlerMethod("getRasDescriptions")
        self.registerHandlerMethod("getInActiveRases")
        self.registerHandlerMethod("getRasTypes")
        self.registerHandlerMethod("getRasAttributes")
        self.registerHandlerMethod("getRasPorts")
        self.registerHandlerMethod("updateRasInfo")
        self.registerHandlerMethod("updateAttributes")
        self.registerHandlerMethod("resetAttributes")
        self.registerHandlerMethod("getPortTypes")
        self.registerHandlerMethod("addPort")
        self.registerHandlerMethod("delPort")
        self.registerHandlerMethod("updatePort")
        self.registerHandlerMethod("deActiveRas")
        self.registerHandlerMethod("deleteRas")
        self.registerHandlerMethod("reActiveRas")
        self.registerHandlerMethod("getRasPortInfo")
        self.registerHandlerMethod("getRasIPpools")
        self.registerHandlerMethod("addIPpoolToRas")
        self.registerHandlerMethod("delIPpoolFromRas")

    def addNewRas(self,request):
        request.needAuthType(request.ADMIN)
        creator_obj=request.getAuthNameObj()
        creator_obj.canDo("CHANGE RAS")
        request.checkArgs("ras_ip","ras_type","radius_secret","ras_description","comment")

        ras_id=ras_main.getActionManager().addNewRas(request["ras_ip"].strip(),
                                                     request["ras_description"].strip(),
                                                     request["ras_type"],
                                                     request["radius_secret"],
                                                     request["comment"],
                                                     creator_obj.getAdminID(),
                                                     creator_obj.getISPID(),
                                                     request.getRemoteAddr()
                                                     )
        return ras_id

    def getRasInfo(self,request):
        request.needAuthType(request.ADMIN)
        requester_obj=request.getAuthNameObj()
        requester_obj.canDo("GET RAS INFORMATION")
        request.checkArgs("ras_ip")

        requester_obj.checkAccessToRasByIP(request["ras_ip"])
        ras_obj=ras_main.getLoader().getRasByIP(request["ras_ip"])
        return ras_obj.getInfo()

    def getActiveRasIPs(self,request):
        request.needAuthType(request.ADMIN)
        creator_obj=request.getAuthNameObj()

        if request.has_key("type_filter"):
            types = request.fixList("type_filter")
            def typeFilter(ras_obj):
                if ras_obj.getType() in types:
                    return ras_obj.getRasIP()

                return None

            ras_ips = filter(None, ras_main.getLoader().runOnAllRases(typeFilter))
        else:
            ras_ips = ras_main.getLoader().getAllRasIPs()

        ras_ips = filter(creator_obj.hasAccessToRasByIP, ras_ips)

        sorted=SortedList(ras_ips)
        sorted.sort(False)
        return sorted.getList()


    def getRasDescriptions(self,request):
        """
            return list of tuples in format [(ras_description,ras_ip)]

        """
        request.needAuthType(request.ADMIN)
        requester_obj=request.getAuthNameObj()
        desc_to_ip_map = ras_main.getLoader().getRasDescToIPMap()

        for ras_desc, ras_ip in desc_to_ip_map.items():
            if not requester_obj.hasAccessToRasByIP(ras_ip):
                del(desc_to_ip_map[ras_desc])

        sorted=SortedDic(desc_to_ip_map)
        sorted.sortByKey(False)
        return sorted.getList()

    def getInActiveRases(self,request):
        request.needAuthType(request.ADMIN)
        creator_obj=request.getAuthNameObj()
        creator_obj.canDo("LIST RAS")
        return ras_main.getActionManager().getInActiveRases()

    def getRasTypes(self,request):
        """
            return a list of all available ras types
        """
        request.needAuthType(request.ADMIN)
        creator_obj=request.getAuthNameObj()
        creator_obj.canDo("GET RAS INFORMATION")
        type_list=ras_main.getFactory().getAllTypes()
        sorted = SortedList(type_list)
        sorted.sort(False)
        return sorted.getList()

    def getRasAttributes(self,request):
        request.needAuthType(request.ADMIN)
        request.checkArgs("ras_ip")

        requester_obj=request.getAuthNameObj()
        requester_obj.canDo("GET RAS INFORMATION")
        requester_obj.checkAccessToRasByIP(request["ras_ip"])

        return ras_main.getLoader().getRasByIP(request["ras_ip"]).getAllAttributes()

如何从此创建doc? 例如,我希望这些信息可用于我的结果。 如:多少def,多少级别,以及def和class之间的关系。 不要使用help()和dir()方法,因为我没有任何依赖模块。 我认为应该通过re模块使用解析python文件并使用正则表达式。 怎么做? 我无法导入此文件。我想使用它,如文本文件!

1 个答案:

答案 0 :(得分:0)

即使您不编写文档字符串也不编写注释,仍可以键入:

help(your_object)

获取自动生成的课程文档。 your_object可以是任何类型的对象,即:

  • 一堂课
  • 一个类实例
  • 一个功能
  • 模块
  • 等。

因此,如果您需要给定文件的文档(我理解一个模块),您可以这样做:

import your_module
help(your_dodule)

如果您的文件名为your_file.py且包含一个名为your_class的类,则可以执行以下操作:

python -i your_file.py
help(your_class)

您甚至可以从shell提示符(而不是python解释器提示符)生成文档。再次假设您要为your_file.py生成文档,请执行以下操作:

pydoc your_file

最后,如果要为此模块生成html文档,请执行以下操作:

pydoc -w your_file