如何在 sphinx 中记录用 @dataclass 注释的可调用类？

Question

我研究了这个主题，但找不到明确的解决方案。有一个类似的

我的问题是我有一个带有 attr.dataclass 和 typing_extensions.final 注释的 class，我不希望它们被记录下来，但我仍然想描述 class 从如何调用的角度来看。

例如，

@final
@dataclass(frozen=True, slots=True)
class Casting(object):

  _int_converter_function = int
  _float_converter_function = float

  def __call__(self, casting, value_to_cast):
    if casting['type'] == 'integer':
        return self._int_converter_function(value_to_cast)
    return self._float_converter_function(value_to_cast)

这大约相当于（远非准确）：

class Casting(object):

  def __init__(
    self,
    int_converter_function = int,
    float_converter_function = float,
  ):
    self.int_converter_function = int_converter_function
    self.float_converter_function = float_converter_function

  def converter(self, casting, value):
    self.value = value
    yield
    type = casting['type']
    if type == 'integer':
      yield self.int_converter_function(value)
    else:
      yield self.float_converter_function(value)

最新的很明显，我可以用文档字符串记录每个方法，在 Sphinx 中做：

.. autoclass:: package.Casting
  :members:
  .. automethod:: __init__(self, int_converter_function, float_converter_function)

如何对注释做同样的事情？

更新：

我发现我的问题应该更具体一些。我要

从文档中完全删除 dataclass，但仍然保留文档中的 class。它把 class 搞得一团糟，以至于文档无法阅读。
在 __init__ 上创建文档字符串，但也将其与可调用描述分开。我离开了 .

文档示例：

"""Cast one type of code to another.

Constructor arguments:

    :param int_converter_function: function to convert to int

    :param float_converter_function: function to convert to float

Callable arguments:

:param casting: :term:`casting` object
:type casting: dict

:param value_to_cast: input value

:return: Casted value

Example
    >>> cast = Casting(int)
    >>> cast({'type': 'integer'}, '123')
    123
    >>> cast({'type': 'decimal'}, '123.12')
    Decimal('123.12')

"""

更新 2：

完整的 class 如下：

# -*- coding: utf-8 -*-

from attr import dataclass
from typing_extensions import final


@final
@dataclass(frozen=True, slots=True)
class Casting(object):
    """Cast one type of code to another.

    Constructor arguments:

        :param int_converter_function: function to convert to int

        :param float_converter_function: function to convert to float

    Callable arguments:

    :param casting: :term:`casting` object
    :type casting: dict

    :param value_to_cast: input value

    :return: Casted value

    Example
        >>> cast = Casting(int)
        >>> cast({'type': 'integer'}, '123')
        123
        >>> cast({'type': 'decimal'}, '123.12')
        Decimal('123.12')

    """

    _int_converter_function = int
    _float_converter_function = float

    def __call__(self, casting, value_to_cast):
        if casting['type'] == 'integer':
            return self._int_converter_function(value_to_cast)
        return self._float_converter_function(value_to_cast)

我想从文档中删除 package.casting.dataclass。

Answer 1

正如@mzjn 在评论中提到的那样，如果 automodule 配置正确，:exclude-members: dataclass 应该可以完成工作。

我犯了一个难以追踪的愚蠢错误。如果您在单独的行中写入 :exclude-members: 和 <name-of-module>，那么文件中的所有类都将被忽略。

与 make constructor 和 callable function 相关的另一部分看起来很漂亮我提取到单独的 SO question.

如何在 sphinx 中记录用 @dataclass 注释的可调用类？

How to document callable classes annotated with @dataclass in sphinx?

python

python-sphinx

callable-object

如何在 sphinx 中记录用 @dataclass 注释的可调用 类？

How to document callable classes annotated with @dataclass in sphinx?

python

python-sphinx

callable-object

如何在 sphinx 中记录用 @dataclass 注释的可调用类？