How to document a Python variable?

Question

How can I document a variable in Python. In JavaScript / JSDoc I can do something like that.:

/** @type {Array<Number>} */
var foo;
/** @type {Number[]} */
var bar;

Some IDEs than can give better code completion.

Is this also possible in Python?

python.org/dev/peps/pep-0484/#type-comments ... for questions like this first google "pep8" and your question... you will find the reference in the python style guide — Joran Beasley
– Joran Beasley, Commented Sep 30, 2016 at 22:47
its probably important to note that for the most part the type is unenforced... and of coarse whether you get any typehinting or help depends on the IDE you are using — Joran Beasley
– Joran Beasley, Commented Sep 30, 2016 at 22:51
Thank you, it seems to work, but I have to write # type: list[int] instead of # type: List[int]. Is that correct? It also seems that PyCharm supports it. — BuZZ-dEE
– BuZZ-dEE, Commented Sep 30, 2016 at 22:52
x, y, z = [], [], [] # type: (List[int], List[int], List[str]) is how it is defined in the spec ... your particular IDE may not implement it in this way ... — Joran Beasley
– Joran Beasley, Commented Sep 30, 2016 at 22:54

Joran Beasley · Accepted Answer · 2016-09-30 23:02:40Z

1

x, y, z = [], [], [] # type: (List[int], List[int], List[str]) is how it is defined in the spec ... your particular IDE may or may not implement it in this way ...

see also: https://www.python.org/dev/peps/pep-0484/#type-comments

answered Sep 30, 2016 at 23:02

Joran Beasley

114k13 gold badges167 silver badges187 bronze badges

Sign up to request clarification or add additional context in comments.

Collectives™ on Stack Overflow

How to document a Python variable?

1 Answer 1

Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

Comments

Your Answer

Sign up or log in

Post as a guest

Related