Python模块文档在argumen中实例化类

Question

我有一个类，我正试图与斯芬克斯文件。包含以下类的模块（仅显示类的第一部分）

class StructureContainer:
    """
    Data structure for describing a collection of Particles
    """

    def __init__(self, ptclC=ParticleContainer()):
       …

包含在我的sphinx文档中，代码如下：

.. automodule:: structureContainer
   :members:
   :show-inheritance:

效果很好。但是中上面ptclC的默认值应该是另一个类“ParticleContainer”的默认构造函数。但是在文档中，它看起来就像是在文档本身中实例化构造函数一样（抱歉，我不能发布图像）

class structureContainer.StructureContainer(ptclC=<particles.ParticleContainer instance at 0x1071ed710>,

如何在HTML文档中保留对象实例信息

Answer 1

所以，要详细说明并解决你的问题

def __init__(self, ptclC=None):
     if ptclC is None:        
         ptclC =ParticleContainer()

我之所以回答这个问题，是因为我认为Sphinx正确地显示了您正在函数定义时实例化