Type declaration in docstring and code analysis


I wonder, if there is any document describing how to write type declarations in docstring to help code analyser and code completion.

I tried some constructions with :type: and :rtype: tags and got some working examples:

type1 or type2 or ...

list of type

dict of type - is there any way to describe key type?

tuple of type

generator of type - works partially for code completion, generator's attributes and methods are visible, type's attributes and methods are not

Where I can find additional information about that?

Kind regards,


Please sign in to leave a comment.