Question: Type Annotations and Docs

[OzupeSir]

I am learning to use the attrs package and I have two questions to ask:

1. When using 'converter' to modify the input type when creating a property, it will cause IDE to make an error in judging the input type. For example, I originally wanted this input to be int, but it prompted me that it should be str. Is there any good way to solve this problem?

2. When using the class xxxx to create traditional classes, it is common to add instantiation comments in the __init__ method. Now, with attrs, the instantiation process no longer has parameter prompts. Is there any other good way to solve the problem of document prompts during instantiation besides adding comments directly to the class?

import attrs


@attrs.define
class Com:
    """
    Initialize Com2 instance.

    :param code: Code of the Com2 instance.
    """
    code: str = attrs.field(converter=str)

class Com2:
    def __init__(self, code: int):
        """
        Initialize Com2 instance.

        :param code: Code of the Com2 instance.
        """
        self.code: str = str(code)

if __name__ == '__main__':
    com = Com(code=1)

    com2 = Com2(code=2)

[nwolf721]

1. I'm fairly certain there's no straightforward solution as of right now
2. Use "var" instead of "param"

[hynek]

Generally speaking, this is a PyCharm issue and a paying customer, you should ask them to fix it. 😇 Customers asking for these features is the only signal available.

Unfortunately, support for advanced features like converters is spotty across the landscape, though.

Closing, since this is nothing we can do about. We hope we can add more information about the status quo of PyCharm to our typing docs page in the near future (😇 @judy2k).