distutils register command should print text, not bytes repr

[merwok]

BPO	20900
Nosy	@merwok, @berkerpeksag
Files	issue20900.patch

^{Note: these values reflect the state of the issue at the time it was migrated and might not reflect the current state.}

Show more details

GitHub fields:

assignee = None
closed_at = <Date 2016-06-10.20:04:09.471>
created_at = <Date 2014-03-12.20:59:23.239>
labels = ['easy', 'type-bug', 'library']
title = 'distutils register command should print text, not bytes repr'
updated_at = <Date 2016-06-10.20:04:09.470>
user = 'https://github.com/merwok'

bugs.python.org fields:

activity = <Date 2016-06-10.20:04:09.470>
actor = 'berker.peksag'
assignee = 'none'
closed = True
closed_date = <Date 2016-06-10.20:04:09.471>
closer = 'berker.peksag'
components = ['Distutils']
creation = <Date 2014-03-12.20:59:23.239>
creator = 'eric.araujo'
dependencies = []
files = ['34436']
hgrepos = []
issue_num = 20900
keywords = ['patch', 'easy']
message_count = 11.0
messages = ['213295', '213310', '213313', '213315', '213676', '213688', '213944', '214097', '268140', '268150', '268151']
nosy_count = 5.0
nosy_names = ['eric.araujo', 'Arfrever', 'python-dev', 'berker.peksag', 'ingrid']
pr_nums = []
priority = 'normal'
resolution = 'fixed'
stage = 'resolved'
status = 'closed'
superseder = None
type = 'behavior'
url = 'https://bugs.python.org/issue20900'
versions = ['Python 3.5', 'Python 3.6']

[merwok]

“python3 setup.py register --show-response“ will display something like "----------b'xxx'----------". The HTTP response body should be decoded to text for display, instead of the repr of a bytes object.

Setting the “easy” keyword: thanks to unittest.mock, writing a test for this should not be hard, and with a test we can have the confidence to change the code.

[ingrid]

I haven't had to register a python package before. Is there a way to reproduce this without actually creating an entry in PyPI?

[merwok]

To get a better idea of the problem, you can run the code for real using https://testpypi.python.org/pypi as repository URL. Then, unittest.mock provides a way to write a unit test that reproduces the bug without actually sending an HTTP request to any server.

[ingrid]

Ah, thanks! I'm looking at this now.

[ingrid]

Here is a patch. I made the register show-response format consistent with the upload show-response format and added tests for both. Please let me know if you have any feedback.

[merwok]

Thank you, the patch looks excellent. I’ll apply it in a day or two.

[merwok]

Were you able to reproduce the bug before you changed the code? I saw clean text when registering a release with success, and clean text too when trying to register a release for a project I was not owner of.

[ingrid]

I'm not quite clear on what you mean, could you please post an example output? Initially the response was not showing up at all for me because the announce call in register was missing a log level, but when I used log.INFO, the response did print for me, and it did look something like "----------b'xxx'----------".

On a side note, the announce function defined in cmd.py seems to default to a log level 1, and messages with a log level of 1 do not seem to be printed to stdout regardless of what self.verbose is set to. I'm not sure if that is intentional or a bug, but I thought it was worth mentioning.

[berkerpeksag]

bpo-20900.patch looks good to me. We are already testing output of "python -setup.py upload --show-response" in Lib/distutils/tests/test_upload.py so I removed test_show_reponse and tweaked test_upload to test the whole line:

-        self.assertIn('xyzzy\n', results[-1])
+        self.assertEqual(results[-1], 75 * '-' + '\nxyzzy\n' + 75 * '-')

[python-dev]

New changeset 02824cee7624 by Berker Peksag in branch '3.5':
Issue bpo-20900: distutils register command now decodes HTTP responses correctly
https://hg.python.org/cpython/rev/02824cee7624

New changeset b0be24a2f16c by Berker Peksag in branch 'default':
Issue bpo-20900: Merge from 3.5
https://hg.python.org/cpython/rev/b0be24a2f16c

[berkerpeksag]

Thanks for the patch ingrid!