Changeset 71394 for grass/trunk/lib/python/script/utils.py

Timestamp:

Aug 11, 2017, 3:18:29 PM (7 years ago)

Author:

zarch

Message:

script.utils: Convert to string/bytes if needed, add doctests and unittests

File:

• grass/trunk/lib/python/script/utils.py (modified) (4 diffs)

grass/trunk/lib/python/script/utils.py

@@ +1 @@
+# -*- coding: utf-8 -*-
 """
 Useful functions to be used in Python scripts.
@@ -24 +25 @@
 import shlex
 import re
+
+
+try:
+    from builtins import unicode
+except ImportError:
+    # python3
+    unicode = str
+
 
 def float_or_dms(s):
@@ -164 +173 @@
 
     :param bytes bytes_: the bytes to decode
-    """
+
+    Example
+    -------
+
+    >>> decode(b'S\xc3\xbcdtirol')
+    u'Südtirol'
+    >>> decode(u'Südtirol')
+    u'Südtirol'
+    >>> decode(1234)
+    u'1234'
+    """
+    if isinstance(bytes_, unicode):
+        return bytes_
     if isinstance(bytes_, bytes):
         enc = _get_encoding()
         return bytes_.decode(enc)
-    return bytes_
+    return unicode(bytes_)
 
 
@@ -178 +199 @@
 
     :param str string: the string to encode
+
+    Example
+    -------
+
+    >>> encode(b'S\xc3\xbcdtirol')
+    b'S\xc3\xbcdtirol'
+    >>> decode(u'Südtirol')
+    b'S\xc3\xbcdtirol'
+    >>> decode(1234)
+    b'1234'
     """
     if isinstance(string, bytes):
         return string
-    enc = _get_encoding()
-    return string.encode(enc)
+    if isinstance(string, unicode):
+        enc = _get_encoding()
+        return string.encode(enc)
+    return bytes(string)