argparse.ArgumentParser not support unicode in print help

[gkraser]

BPO	9779
Nosy	@merwok
Files	test_ap.py: unit test argparsebug.py: source code illustrating bug argparsenobug.py: Source code using subclass as a workaround

^{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 2010-11-01.16:38:05.379>
created_at = <Date 2010-09-05.07:36:09.098>
labels = ['invalid', 'type-bug', 'library']
title = 'argparse.ArgumentParser not support unicode in print help'
updated_at = <Date 2016-02-01.19:01:49.799>
user = 'https://bugs.python.org/gkraser'

bugs.python.org fields:

activity = <Date 2016-02-01.19:01:49.799>
actor = 'markastern'
assignee = 'none'
closed = True
closed_date = <Date 2010-11-01.16:38:05.379>
closer = 'bethard'
components = ['Library (Lib)']
creation = <Date 2010-09-05.07:36:09.098>
creator = 'gkraser'
dependencies = []
files = ['18757', '41774', '41775']
hgrepos = []
issue_num = 9779
keywords = []
message_count = 6.0
messages = ['115630', '116134', '116293', '120138', '259342', '259343']
nosy_count = 4.0
nosy_names = ['bethard', 'eric.araujo', 'gkraser', 'markastern']
pr_nums = []
priority = 'normal'
resolution = 'not a bug'
stage = None
status = 'closed'
superseder = None
type = 'behavior'
url = 'https://bugs.python.org/issue9779'
versions = ['Python 2.7']

[gkraser]

argparse.ArgumentParser not support unicode in print help.

Example:

# -*- coding: utf-8 -*-
import argparse
import unittest

class Test1(unittest.TestCase):
    def test_unicode_desc(self):
        h = u'Rus Рус'      # unicode
        print h             # ok
        parser = argparse.ArgumentParser(description=h)
        parser.print_help() # error

[merwok]

Do the docs say this should be supported? I’m a die-hard unicode user, but this treads the line between fix and feature, so if the docs don’t restrict help to str, this could be fixed, otherwise we’re out of luck for the 2.x series.

[bethard]

Are you sure this is an argparse issue, and not a terminal issue? Here's what I see:

>>> parser = argparse.ArgumentParser(description=u'Rus Рус')
>>> print(parser.description)
Rus Рус
>>> sys.stderr.write(parser.description)
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
UnicodeEncodeError: 'ascii' codec can't encode characters in position 4-6: ordinal not in range(128)
>>> parser.format_help()
u'usage: [-h]\n\nRus \u0420\u0443\u0441\n\noptional arguments:\n  -h, --help  show this help message and exit\n'
>>> sys.stderr.write(parser.format_help())
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
UnicodeEncodeError: 'ascii' codec can't encode characters in position 17-19: ordinal not in range(128)

To me, it looks like sys.stderr doesn't like the unicode, even though at the interactive prompt I can print things okay.

[bethard]

Closing as invalid, as to me this looks like a classic terminal encoding issue and not an argparse issue, and there was no response from the user who filed the issue. If someone still thinks this is an argparse issue, please provide a test and reopen the issue.

[markastern]

This bit me also. For anybody else reading this, argparsenobug.py includes a class that provides a workaround.

python argparsebug.py --help

works, but:

python argparsebug.py --help > <some file>
python argparsebug.py --help | more

give the error.

However:

python argparsenobug.py --help
python argparsenobug.py --help > <some file>
python argparsenobug.py --help | more

all work.

[markastern]

And here is the source code with the workaround class