➜
This issue tracker has been migrated to GitHub,
and is currently read-only.
For more information,
see the GitHub FAQs in the Python's Developer Guide.
Created on 2017-12-05 10:36 by Tobotimus, last changed 2022-04-11 14:58 by admin. This issue is now closed.
| Files | ||||
|---|---|---|---|---|
| File name | Uploaded | Description | Edit | |
| test_typehinted_funcs.py | Tobotimus, 2017-12-05 10:36 | Input file for pygettext to demonstrate behaviour | ||
| pygettext_output.pot | Tobotimus, 2017-12-05 10:37 | Output file from pygettext for test_typehinted_funcs.py | ||
| test_returntypehinted_funcs.py | Tobotimus, 2017-12-05 10:47 | Demonstrating behaviour with return type annotations | ||
| Pull Requests | |||
|---|---|---|---|
| URL | Status | Linked | Edit |
| PR 4745 | merged | Tobotimus, 2017-12-07 09:31 | |
| PR 5915 | merged | miss-islington, 2018-02-26 22:49 | |
| PR 5916 | merged | miss-islington, 2018-02-26 22:50 | |
| 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. |
|||
| History | |||
|---|---|---|---|
| Date | User | Action | Args |
| 2022-04-11 14:58:55 | admin | set | github: 76403 |
| 2020-10-06 01:16:00 | methane | set | status: open -> closed resolution: fixed stage: patch review -> resolved |
| 2020-10-04 14:46:20 | iritkatriel | set | nosy:
+ iritkatriel messages: + msg377943 |
| 2018-02-26 23:23:30 | miss-islington | set | nosy:
+ miss-islington messages: + msg312970 |
| 2018-02-26 22:50:25 | miss-islington | set | pull_requests: + pull_request5687 |
| 2018-02-26 22:49:27 | miss-islington | set | pull_requests: + pull_request5686 |
| 2018-02-26 22:48:16 | serhiy.storchaka | set | messages: + msg312967 |
| 2017-12-15 12:09:41 | serhiy.storchaka | set | assignee: serhiy.storchaka nosy: + serhiy.storchaka versions: + Python 3.7, - Python 3.5 |
| 2017-12-07 09:31:54 | Tobotimus | set | keywords:
+ patch stage: patch review pull_requests: + pull_request4648 |
| 2017-12-07 07:34:51 | Tobotimus | set | messages: + msg307791 |
| 2017-12-05 10:47:39 | Tobotimus | set | files:
+ test_returntypehinted_funcs.py messages: + msg307654 |
| 2017-12-05 10:37:30 | Tobotimus | set | files: + pygettext_output.pot |
| 2017-12-05 10:36:15 | Tobotimus | create | |