view roundup/anypy/strings.py @ 8264:09e8d1a4c796

docs: clarify wording, fix index, add superseder link Make superseder, messages etc. properties index entries point to the right place. Link to description of using Superseder in the original overview. fix bad wording on boolean properties.
author John Rouillard <rouilj@ieee.org>
date Wed, 08 Jan 2025 11:39:54 -0500
parents 4261449081be
children
line wrap: on
line source

# Roundup represents text internally using the native Python str type.
# In Python 3, these are Unicode strings.  In Python 2, these are
# encoded using UTF-8, and the Python 2 unicode type is only used in a
# few places, generally for interacting with external modules
# requiring that type to be used.

import ast
import io
import sys

_py3 = sys.version_info[0] > 2

if _py3:
    StringIO = io.StringIO
else:
    StringIO = io.BytesIO


def b2s(b):
    """Convert a UTF-8 encoded bytes object to the internal string format."""
    if _py3:
        return b.decode('utf-8')
    else:
        return b


def s2b(s):
    """Convert a string object to UTF-8 encoded bytes."""
    if _py3:
        return s.encode('utf-8')
    else:
        return s


def bs2b(s):
    """Convert a string object or UTF-8 encoded bytes to UTF-8 encoded bytes.
    """
    if _py3:
        if isinstance(s, bytes):
            return s
        else:
            return s.encode('utf-8')
    else:
        return s


def s2u(s, errors='strict'):
    """Convert a string object to a Unicode string."""
    if _py3:
        return s
    else:
        return unicode(s, 'utf-8', errors)  # noqa: F821


def u2s(u):
    """Convert a Unicode string to the internal string format."""
    if _py3:
        return u
    else:
        return u.encode('utf-8')


def us2u(s, errors='strict'):
    """Convert a string or Unicode string to a Unicode string."""
    if _py3 or isinstance(s, unicode):    # noqa: F821
        return s
    else:
        return unicode(s, 'utf-8', errors)    # noqa: F821


def us2s(u):
    """Convert a string or Unicode string to the internal string format."""
    if _py3:
        return u
    elif isinstance(u, unicode):    # noqa: F821
        return u.encode('utf-8')
    else:
        return u


def uany2s(u):
    """Convert a Unicode string or other object to the internal string format.

    Objects that are not Unicode strings are passed to str()."""
    if _py3:
        return str(u)
    elif isinstance(u, unicode):    # noqa: F821
        return u.encode('utf-8')
    else:
        return str(u)


def is_us(s):
    """Return whether an object is a string or Unicode string."""
    if _py3:
        return isinstance(s, str)
    else:
        return isinstance(s, (str, unicode))  # noqa: F821


def uchr(c):
    """Return the Unicode string containing the given character."""
    if _py3:
        return chr(c)
    else:
        return unichr(c)  # noqa: F821

# CSV files used for export and import represent strings in the style
# used by repr in Python 2; this means that each byte of the UTF-8
# representation is represented by a \x escape if not a printable
# ASCII character.  When such a representation is interpreted by eval
# in Python 3, the effect is that the Unicode characters in the
# resulting string correspond to UTF-8 bytes, so encoding the string
# as ISO-8859-1 produces the correct byte-string which must then be
# decoded as UTF-8 to produce the correct Unicode string.  The same
# representations are also used for journal storage in RDBMS
# databases, so that the database can be compatible between Python 2
# and Python 3.


def repr_export(v):
    """Return a Python-2-style representation of a value for export to CSV."""
    if _py3:
        if isinstance(v, str):
            return repr(s2b(v))[1:]
        elif isinstance(v, dict):
            repr_vals = []
            for key, value in sorted(v.items()):
                repr_vals.append('%s: %s' % (repr_export(key),
                                             repr_export(value)))
            return '{%s}' % ', '.join(repr_vals)
        else:
            return repr(v)
    else:
        return repr(v)


def eval_import(s):
    """Evaluate a Python-2-style value imported from a CSV file."""
    try:
        if _py3:
            try:
                v = ast.literal_eval(s)
            except SyntaxError:
                # handle case where link operation reports id a long
                # int ('issue', 5002L, "status") rather than as a
                # string.  This was a bug that existed and was fixed
                # before or with v1.2.0
                import re  # noqa: PLC0415
                v = ast.literal_eval(re.sub(r', ([0-9]+)L,', r', \1,', s))

            if isinstance(v, str):
                return v.encode('iso-8859-1').decode('utf-8')
            elif isinstance(v, dict):
                v_mod = {}
                # ruff: noqa: PLW2901
                for key, value in v.items():
                    if isinstance(key, str):
                        key = key.encode('iso-8859-1').decode('utf-8')
                    if isinstance(value, str):
                        value = value.encode('iso-8859-1').decode('utf-8')
                    v_mod[key] = value
                return v_mod
            else:
                return v
        else:
            return ast.literal_eval(s)

    except (ValueError, SyntaxError) as e:
        raise ValueError(
            ("Error %(exception)s trying to parse value '%(value)s'") %
            {'exception': e, 'value': s})

Roundup Issue Tracker: http://roundup-tracker.org/