Issue 32222: pygettext doesn't extract docstrings for functions with type annotated params (original) (raw)

Created on 2017-12-05 10:36 by Tobotimus, last changed 2022-04-11 14:58 by admin. This issue is now closed.

Messages (6)
msg307652 - (view)	Author: Toby Harradine (Tobotimus) *	Date: 2017-12-05 10:36
### Expected Behaviour When running pygettext with the -D CLI flag, all module, class, method and function docstrings should be extracted and outputted to the .pot file. ### Actual Behaviour In the case of functions whose parameters have PEP 484 type annotations, their docstrings are not being extracted. I have attached two files, one .py file and its corresponding .pot file, as examples of this behaviour.
msg307654 - (view)	Author: Toby Harradine (Tobotimus) *	Date: 2017-12-05 10:47
Correction for above: the type annotation syntax is actually from PEP 3107, not PEP 484. I should also point out that this behaviour is occurring for annotated return types of functions and methods as well. This is occurring on both Windows and Linux.
msg307791 - (view)	Author: Toby Harradine (Tobotimus) *	Date: 2017-12-07 07:34
Another correction; I said that this is occurring for return type annotations; this is not true. This is only occurring for functions with annotated *arguments*. The cause of this issue is in pygettext's TokenEater.__suiteseen method. This method eats tokens until it sees a colon operator, after which it assumes a function docstring may follow. In the case of a function with annotated arguments, obviously this is incorrect, as colons would appear before the final colon of the 'suite'.
msg312967 - (view)	Author: Serhiy Storchaka (serhiy.storchaka) *	Date: 2018-02-26 22:48
New changeset eee72d4778a5513038edd5236cdd87ccce2bc60a by Serhiy Storchaka (Tobotimus) in branch 'master': bpo-32222: Fix pygettext skipping docstrings for funcs with arg typehints (GH-4745) https://github.com/python/cpython/commit/eee72d4778a5513038edd5236cdd87ccce2bc60a
msg312970 - (view)	Author: miss-islington (miss-islington)	Date: 2018-02-26 23:23
New changeset 51d95ffc2fb3337dc87277c9af25ecc9a01f991b by Miss Islington (bot) in branch '3.7': bpo-32222: Fix pygettext skipping docstrings for funcs with arg typehints (GH-4745) https://github.com/python/cpython/commit/51d95ffc2fb3337dc87277c9af25ecc9a01f991b
msg377943 - (view)	Author: Irit Katriel (iritkatriel) *	Date: 2020-10-04 14:46
I think this is resolved and can be closed.