encoding.py

Go to the documentation of this file.

#  Copyright 2008-2015 Nokia Networks
#  Copyright 2016-     Robot Framework Foundation
#
#  Licensed under the Apache License, Version 2.0 (the "License");
#  you may not use this file except in compliance with the License.
#  You may obtain a copy of the License at
#
#      http://www.apache.org/licenses/LICENSE-2.0
#
#  Unless required by applicable law or agreed to in writing, software
#  distributed under the License is distributed on an "AS IS" BASIS,
#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
#  See the License for the specific language governing permissions and
#  limitations under the License.
 
import os
import sys
 
from .encodingsniffer import get_console_encoding, get_system_encoding
from .compat import isatty
from .platform import JYTHON, IRONPYTHON, PY3
from .robottypes import is_unicode
from .unic import unic
 
 
CONSOLE_ENCODING = get_console_encoding()
SYSTEM_ENCODING = get_system_encoding()
# IronPython and Jython streams have wrong encoding if outputs are redirected.
# Jython gets it right if PYTHONIOENCODING is set, though.
NON_TTY_ENCODING_CAN_BE_TRUSTED = \
    not (IRONPYTHON or JYTHON and not os.getenv('PYTHONIOENCODING'))
 
 
 
def console_decode(string, encoding=CONSOLE_ENCODING, force=False):
    if is_unicode(string) and not (IRONPYTHON and force):
        return string
    encoding = {'CONSOLE': CONSOLE_ENCODING,
                'SYSTEM': SYSTEM_ENCODING}.get(encoding.upper(), encoding)
    try:
        return string.decode(encoding)
    except UnicodeError:
        return unic(string)
 
 
 
def console_encode(string, errors='replace', stream=sys.__stdout__):
    encoding = _get_console_encoding(stream)
    if PY3 and encoding != 'UTF-8':
        return string.encode(encoding, errors).decode(encoding)
    if PY3 or IRONPYTHON:
        return string
    return string.encode(encoding, errors)
 
 
def _get_console_encoding(stream):
    encoding = getattr(stream, 'encoding', None)
    if encoding and (NON_TTY_ENCODING_CAN_BE_TRUSTED or isatty(stream)):
        return encoding
    return CONSOLE_ENCODING if isatty(stream) else SYSTEM_ENCODING
 
 
# These interpreters handle communication with system APIs using Unicode.
if PY3 or JYTHON or IRONPYTHON:
 
    def system_decode(string):
        return string if is_unicode(string) else unic(string)
 
    def system_encode(string, errors='replace'):
        return string if is_unicode(string) else unic(string)
 
else:
 
    
    def system_decode(string):
        try:
            return string.decode(SYSTEM_ENCODING)
        except UnicodeError:
            return unic(string)
 
    
    def system_encode(string, errors='replace'):
        if not is_unicode(string):
            string = unic(string)
        return string.encode(SYSTEM_ENCODING, errors)