Reviewed: https://review.opendev.org/664940 Committed: https://git.openstack.org/cgit/openstack/nova/commit/?id=f545a25cc443c41dcd9bdd028064c28b53f56037 Submitter: Zuul Branch: master
commit f545a25cc443c41dcd9bdd028064c28b53f56037 Author: Stephen Finucane <[email protected]> Date: Wed Jun 12 15:10:59 2019 +0100 Fix double word hacking test At present, 'pycodestyle' feeds the following string into the 'tokenizer' library: ["'This is the the best comment'"] (note the added quotes because this isn't valid Python otherwise) On previous versions of Python, this tokenizer would parse the string like so: (3, "'This is the the best comment'", (1, 0), (1, 30), "'This is the the best comment'") (0, '', (2, 0), (2, 0), '') where (3 = 'STRING', 0 = 'ENDMARKER') However, with the fix [1] backported to recent versions of Python, this now resolves to: (3, "'This is the the best comment'", (1, 0), (1, 30), "'This is the the best comment'") (4, '', (1, 30), (1, 31), '') (0, '', (2, 0), (2, 0), '') where (3 = 'STRING', 4 = 'NEWLINE', 0 = 'ENDMARKER') Typically, 'pycodestyle' will run physical line checks on each line as it parses the token: https://github.com/PyCQA/pycodestyle/blob/2.5.0/pycodestyle.py#L2036 For the former case above, the line doesn't include a newline which means we never parse a 'NEWLINE' token with a logical line (the fifth element of the token tuple) corresponding to our full line. This means we don't here but that wasn't an issue previously since there's a fallthrough case that handled tokens remaining at the end of the parse: https://github.com/PyCQA/pycodestyle/blob/2.5.0/pycodestyle.py#L2114-L2116 Unfortunately, because we now have an additional newline character to parse, one that's on a separate line to our test string no less, we run logical checks on it: https://github.com/PyCQA/pycodestyle/blob/2.5.0/pycodestyle.py#L2105-L2107 This is an issue since the logical check wipes stored tokens meaning we've nothing to check when we get to the fallthrough case: https://github.com/PyCQA/pycodestyle/blob/2.5.0/pycodestyle.py#L2012 This fixes changes things so that a newline is included (and also adds quotes so it's valid Python, but that's mostly unrelated). This means we end up with the following instead: ["'This is the the best comment'\n"] On both Python without the bugfix and with it, this parses as: (3, "'This is the the best comment'", (1, 0), (1, 30), "'This is the the best comment'\n") (4, '\n', (1, 30), (1, 31), "'This is the the best comment'\n") (0, '', (2, 0), (2, 0), '') where (3 = 'STRING', 4 = 'NEWLINE', 0 = 'ENDMARKER') Which triggers things in 'pycodestyle' correctly. https://github.com/PyCQA/pycodestyle/blob/2.5.0/pycodestyle.py#L2044-L2046 This isn't _really_ a fix since there's clearly still a bug in either 'pycodestyle' or Python (I think the latter, since it's adding a newline to a file that explicitly doesn't have one), but the chances of us hitting this bug in practice are rather low - you'd need to make a mistake on the very last line of a file without a newline at the end which is something Vim, for example, won't even let you do without setting special flags - and therefore it can be reasonably ignored. [1] https://bugs.python.org/issue33899 Change-Id: Ia597594e0469c0e83d7ad22b0678390aaebaffe7 Signed-off-by: Stephen Finucane <[email protected]> Closes-Bug: #1804062 ** Changed in: nova Status: In Progress => Fix Released -- You received this bug notification because you are a member of Yahoo! Engineering Team, which is subscribed to OpenStack Compute (nova). https://bugs.launchpad.net/bugs/1804062 Title: test_hacking fails for python 3.6.7 and newer Status in Ubuntu Cloud Archive: Triaged Status in Ubuntu Cloud Archive queens series: Triaged Status in Ubuntu Cloud Archive rocky series: Triaged Status in Ubuntu Cloud Archive stein series: Triaged Status in masakari: New Status in OpenStack Compute (nova): Fix Released Status in nova package in Ubuntu: Triaged Status in nova source package in Bionic: Triaged Status in nova source package in Cosmic: Triaged Status in nova source package in Disco: Triaged Status in nova source package in Eoan: Triaged Bug description: The check for double words in test_hacking is failing in python 3.6.7 (released in ubuntu 18.04 within the last few days) and in new versions of 3.7.x. This is is because of this change to python: https://bugs.python.org/issue33899 . This is causing failures in python 36 unit tests for nova. The fix ought to be adding a newline to the code sample. Maybe. To manage notifications about this bug go to: https://bugs.launchpad.net/cloud-archive/+bug/1804062/+subscriptions -- Mailing list: https://launchpad.net/~yahoo-eng-team Post to : [email protected] Unsubscribe : https://launchpad.net/~yahoo-eng-team More help : https://help.launchpad.net/ListHelp
