encodingsniffer.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
import locale
 
from .platform import JYTHON, PY2, PY3, UNIXY, WINDOWS
 
 
if UNIXY:
    DEFAULT_CONSOLE_ENCODING = 'UTF-8'
    DEFAULT_SYSTEM_ENCODING = 'UTF-8'
else:
    DEFAULT_CONSOLE_ENCODING = 'cp437'
    DEFAULT_SYSTEM_ENCODING = 'cp1252'
 
 
def get_system_encoding():
    platform_getters = [(True, _get_python_system_encoding),
                        (JYTHON, _get_java_system_encoding),
                        (UNIXY, _get_unixy_encoding),
                        (WINDOWS, _get_windows_system_encoding)]
    return _get_encoding(platform_getters, DEFAULT_SYSTEM_ENCODING)
 
 
def get_console_encoding():
    platform_getters = [(True, _get_stream_output_encoding),
                        (UNIXY, _get_unixy_encoding),
                        (WINDOWS, _get_windows_output_encoding)]
    return _get_encoding(platform_getters, DEFAULT_CONSOLE_ENCODING)
 
 
def _get_encoding(platform_getters, default):
    for platform, getter in platform_getters:
        if platform:
            encoding = getter()
            if _is_valid(encoding):
                return encoding
    return default
 
 
def _get_python_system_encoding():
    # `locale.getpreferredencoding(False)` returns exactly what we want, but
    # it doesn't seem to work outside Windows on Python 2. Luckily on these
    # platforms `sys.getfilesystemencoding()` seems to do the right thing.
    if PY2 and not WINDOWS:
        return sys.getfilesystemencoding()
    return locale.getpreferredencoding(False)
 
 
def _get_java_system_encoding():
    from java.lang import System
    return System.getProperty('file.encoding')
 
 
def _get_unixy_encoding():
    # Cannot use `locale.getdefaultlocale()` because it raises ValueError
    # if encoding is invalid. Using same environment variables here anyway.
    # https://docs.python.org/3/library/locale.html#locale.getdefaultlocale
    for name in 'LC_ALL', 'LC_CTYPE', 'LANG', 'LANGUAGE':
        if name in os.environ:
            # Encoding can be in format like `UTF-8` or `en_US.UTF-8`
            encoding = os.environ[name].split('.')[-1]
            if _is_valid(encoding):
                return encoding
    return None
 
 
def _get_stream_output_encoding():
    # Python < 3.6 on Windows returns different encoding depending on are
    # outputs redirected or not, and Python >= 3.6 always use UTF-8. We
    # want the real console encoding regardless the platform.
    if WINDOWS and PY3:
        return None
    # Stream may not have encoding attribute if intercepted outside RF in
    # Python. Encoding is None if process output is redirected and Python < 3.
    for stream in sys.__stdout__, sys.__stderr__, sys.__stdin__:
        encoding = getattr(stream, 'encoding', None)
        if _is_valid(encoding):
            return encoding
    return None
 
 
def _get_windows_system_encoding():
    return _get_code_page('GetACP')
 
 
def _get_windows_output_encoding():
    return _get_code_page('GetOEMCP')
 
 
def _get_code_page(method_name):
    from ctypes import cdll
    try:
        method = getattr(cdll.kernel32, method_name)
    except TypeError:       # Occurred few times with IronPython on CI.
        return None
    method.argtypes = ()    # Needed with Jython.
    return 'cp%s' % method()
 
 
def _is_valid(encoding):
    if not encoding:
        return False
    try:
        'test'.encode(encoding)
    except LookupError:
        return False
    else:
        return True