kiwi-el8/kiwi/utils/codec.py
Alberto Planas 0c095a98b1 Replace @staticmethod with @classmethod when needed
@classmethod are used in Python to represent methods that can
query and update the class (cls parameter). Is expected to be
used for metaprograming, or advanced techniques that require the
access to the class itself, before we have an instance.

@staticmethod are used to associate a function to a class. It will
not be have access to the instance (self) not the class (cls). In
other programming languages are known as class methods.

This patch replace all the @classmethod with @staticmethod when
there is not need to access to the cls parameter, because the
intention is to be used as normal functions.
2019-03-26 16:27:43 +01:00

56 lines
1.8 KiB
Python

# Copyright (c) 2015 SUSE Linux GmbH. All rights reserved.
#
# This file is part of kiwi.
#
# kiwi is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# kiwi is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with kiwi. If not, see <http://www.gnu.org/licenses/>
#
from kiwi.logger import log
from kiwi.exceptions import KiwiDecodingError
class Codec(object):
"""
**Performs conversions of literal byte sequences to strings**
"""
@staticmethod
def decode(literal):
"""
Decodes the given literal with the default charset. In case of
failure attemps to decode using utf-8 charset.
:param bytes literal: literal to decode
:return: decoded string
:rtype: str
"""
try:
return Codec._wrapped_decode(literal)
except Exception:
log.warning("Failed decoding literal. Forcing UTF-8 decoding")
try:
return Codec._wrapped_decode(literal, 'utf_8')
except Exception:
raise KiwiDecodingError(
'Locale setup is not utf-8 compatible'
)
@staticmethod
def _wrapped_decode(literal, charset=None):
# This decode wrapper is only implemented to facilitate unit testing
if charset:
return literal.decode(charset)
else:
return literal.decode()