_compat.py 2.3 KB
Newer Older
1
2
3
4
# -*- coding: utf-8 -*-
# libolm python bindings
# Copyright © 2015-2017 OpenMarket Ltd
# Copyright © 2018 Damir Jelić <poljar@termina.org.uk>
5
6
7
8
9
10
11
12
13
14
15
16
#
# 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.
17
18
19
20

from builtins import bytes, str
from typing import AnyStr

poljar's avatar
poljar committed
21
from future.utils import native_str
22

23
24
25
26
27
28
29
30
try:
    import secrets
    URANDOM = secrets.token_bytes  # pragma: no cover
except ImportError:  # pragma: no cover
    from os import urandom
    URANDOM = urandom  # type: ignore


31
32
33
34
35
36
37
38
39
40
def to_bytearray(string):
    # type: (AnyStr) -> bytes
    if isinstance(string, bytes):
        return bytearray(string)
    elif isinstance(string, str):
        return bytearray(string, "utf-8")

    raise TypeError("Invalid type {}".format(type(string)))


41
42
43
44
45
46
47
48
def to_bytes(string):
    # type: (AnyStr) -> bytes
    if isinstance(string, bytes):
        return string
    elif isinstance(string, str):
        return bytes(string, "utf-8")

    raise TypeError("Invalid type {}".format(type(string)))
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69


def to_native_str(byte_string, errors="replace"):
    """Turn a byte string into a native string decoding it as UTF-8.

    Args:
        byte_string (bytes): The bytestring that will be converted to a native
            string.
        errors (str, optional): The error handling scheme that should be used
            to handle unicode decode errors. Can be one of "strict" (raise an
            UnicodeDecodeError exception, "ignore" (remove the offending
            characters), "replace" (replace the offending character with
            U+FFFD), "xmlcharrefreplace" as well as any other name registered
            with codecs.register_error that can handle UnicodeEncodeErrors.

    Returns the decoded native string.
    """
    try:
        return native_str(byte_string, errors=errors)
    except TypeError:
        return bytes(byte_string).decode(errors=errors)