trac-admin command fails with TracError includes non-ASCII chars

[trac-ja@…]

When TracError includes non-ASCII chars (i.e. Subversion's error message) at running trac-admin, command dumps stacktrace as UnicodeDecodeError.

This is a patch againsts Trac-0.11rc1:

trac/admin/console.py

@@ -106 +106 @@
             raise
         except TracError, e:
-            print>>sys.stderr, 'Command failed: %s' % to_unicode(e)
+            msg = u'Command failed: %s' % to_unicode(e)
+            msg = msg.encode(sys.stderr.encoding)
+            print>>sys.stderr, msg
             rv = 2
         if not self.interactive:

[Emmanuel Blot]

Replying to trac-ja@i-act.co.jp:

When TracError includes non-ASCII chars (i.e. Subversion's error message) at running trac-admin, command dumps stacktrace as UnicodeDecodeError.

AFAICT, this patch is not valid: sys.stderr.encoding may be None, and would cause a fatal error on sane environment.
Search the Trac DB, this kind of issue has already been addressed.

[Emmanuel Blot]

Replying to eblot:

AFAICT, this patch is not valid: sys.stderr.encoding may be None, and would cause a fatal error on sane environment.
Search the Trac DB, this kind of issue has already been addressed.

See #4742

[trac-ja@…]

Patch update:

trac/admin/console.py

@@ -105 +105 @@
         except SystemExit:
             raise
         except TracError, e:
-            print>>sys.stderr, 'Command failed: %s' % e
+            cons_charset = getattr(sys.stderr, 'encoding', None) or 'utf-8'
+            msg = 'Command failed: %s' % to_unicode(e)
+            print>>sys.stderr, msg.encode(cons_charset)
             rv = 2
         if not self.interactive:
             return rv

[Christian Boos]

It might be worth to have some additional utility function in trac.util.text, e.g.

def console_print(out, *args):
    cons_charset = getattr(out, 'encoding', None) or 'utf-8'
    print>>out, *[to_unicode(a).encode(cons_charset) for a in args]

(untested)

What do you think?

[Christian Boos]

Use console_print helper instead of direct print, for converting the output to the console charset

[Christian Boos]

The 7303-fix-print-to-console.patch​ is a follow-up to the patches on #6677. You need those changes as soon as you have a failure involving an unicode path.

The unit-tests are all OK, but as the changes are quite pervasive I didn't test all the code paths and it would be good to get additional review/testing on this.

[Christian Boos]

Patch applied in r7362.