用于 attrs 的 Pycharm 插件？

Question

attrs 是一个用于减少样板代码的有用包。示例：

class SomeClass(object):
    a_number = attr.ib(default=42)
    list2_of_numbers = attr.ib(default=attr.Factory(list))

PyCharm 不为生成的__init__ 方法提供代码补全，有没有插件可以做到这一点？或者其他一些解决方法？

Answer 1

2018 年 8 月更新 - 根据 Hynek's Answer，PyCharm 2018.2 提供 attrs 支持。我迟到了一个月，因为我最近没有在 Python 中工作很多......

我的原始答案如下，虽然它仅适用于您使用 PyCharm 2018.1 或更低版本...

---

我知道的唯一解决方法（截至 PyCharm 2017.2.4）是在类声明中定义一个冗余的 __init__。 PyCharm 的代码完成可以使用此方法，但在运行时 attrs 生成的__init__ 将覆盖它。例如（type hints）：

import attr
from typing import List, Optional


@attr.s
class SomeClass:

    def __init__(self, a_number: int = 42,
                 list2_of_numbers : Optional[List[int]] = None) -> None:
        ...

    a_number: int = attr.ib(default=42)
    list2_of_numbers: List[int] = attr.ib(default=attr.Factory(list))

PyCharm code completion screen shot

我还尝试使用存根文件从类声明中删除虚拟__init__，以便在支持时删除 .pyi，但它不起作用。

当然，这首先违背了使用 attrs 的目的（即减少类声明样板，帮助可维护性等）

如果您添加、删除或修改 attr.ib()，您需要记住手动更新与 attrs 理念相反的 __init__ 签名。

仅供参考，Jonas Obrist tweeted one of the Jetbrains Devs 关于今年早些时候关于 2017.3 版本的 attrs 支持，所以祈祷...

编辑

实际上，有一个稍微更可口的解决方法。只需将init=False 传递给attr.s 并像往常一样定义您的__init__ 方法。您仍然没有充分利用 attrs 的 full 魔力，但是嘿……总比没有好。

注意在您的手册__init__ 中初始化您的默认值，而不是针对该类的 attr.ib 声明。根据the docs，attr.ib 的默认值只会在 attrs 生成的__init__ 内初始化。

除此之外，据我所知，您仍然可以获得其他笨拙的方法、验证和所有其他优点。

import attr
from typing import List, Optional


@attr.s(init=False)
class SomeClass:

    a_number: int = attr.ib()
    list2_of_numbers: List[int] = attr.ib()

    def __init__(self, a_number: int = 42,
                 list2_of_numbers : Optional[List[int]] = None) -> None:
        self.a_number: int = a_number
        self.list2_of_numbers: List[int] = list2_of_numbers or []
        # Replicate behaviour of attrs-generated __init__
        attr.validate(self)

Answer 2

好消息：PyCharm 2018.2 增加了对 attrs 的支持。

Answer 3

最近（18 年初）在这方面出现了一些有趣的发展：

• add PEP 484 stubs 的 attrs PR，可被 PyCharm 识别（但不添加对 __init__ 和 cmp 特殊方法的支持）
• 一个 python 类型的 PR 到 add those stubs to the official third-party collection
• 一个mypy PR到add support for attrs special methods
• a ticket for adding this feature to PyCharm（上面提到的）获得了很多选票（添加你的！）
• PyCharm 2018.1 EAP2 增加了对dataclasses 的支持，这是python 3.7 标准库中的一个新模块，深受attrs 的启发

预计其中一些问题将在未来几个月内得到解决。希望他们都是！