Changeset 264715 in webkit

Timestamp:

Jul 22, 2020 11:35:42 AM (4 years ago)

Author:

Jonathan Bedard

Message:

[webkitcorepy] Add string_utils (Part 1)
​https://bugs.webkit.org/show_bug.cgi?id=214405

Reviewed by Dewei Zhu.

Centralize handling of unicode encoding/decoding along with various tools
for printing strings.

• Scripts/libraries/webkitcorepy/webkitcorepy/init.py:
• Scripts/libraries/webkitcorepy/webkitcorepy/string_utils.py: Added.

(encode): Encode a string as bytes.
(decode): Decode a bytes as a string.
(ordinal): Convert a number to 1st, 2nd, 3rd, 4th, ect.
(pluralize): Convert a string to it's plurlarized version, if provided number indicates
it should be.
(join): Join a list of elements in a human-readable form.
(out_of): Create a fraction which takes up a constant amount of characters.
(elapsed): Describe the amount of time elapsed as a human-readable string.

• Scripts/libraries/webkitcorepy/webkitcorepy/tests/string_utils_unittest.py: Added.

(StringUtils): Test string_utils.

• Scripts/webkitpy/common/unicode_compatibility.py: Replaced with webkitcorepy.string_utils.

Location:

trunk/Tools

Files:

• ChangeLog (modified) (1 diff)
• Scripts/libraries/webkitcorepy/README.md (modified) (1 diff)
• Scripts/libraries/webkitcorepy/webkitcorepy/__init__.py (modified) (1 diff)
• Scripts/libraries/webkitcorepy/webkitcorepy/string_utils.py (added)
• Scripts/libraries/webkitcorepy/webkitcorepy/tests/string_utils_unittest.py (added)
• Scripts/libraries/webkitcorepy/webkitcorepy/version.py (modified) (1 diff)
• Scripts/webkitpy/common/unicode_compatibility.py (modified) (2 diffs)

trunk/Tools/ChangeLog

@@ +1 @@
+2020-07-22  Jonathan Bedard  <jbedard@apple.com>
+
+        [webkitcorepy] Add string_utils (Part 1)
+        https://bugs.webkit.org/show_bug.cgi?id=214405
+
+        Reviewed by Dewei Zhu.
+
+        Centralize handling of unicode encoding/decoding along with various tools
+        for printing strings.
+
+        * Scripts/libraries/webkitcorepy/webkitcorepy/__init__.py:
+        * Scripts/libraries/webkitcorepy/webkitcorepy/string_utils.py: Added.
+        (encode): Encode a string as bytes.
+        (decode): Decode a bytes as a string.
+        (ordinal): Convert a number to 1st, 2nd, 3rd, 4th, ect.
+        (pluralize): Convert a string to it's plurlarized version, if provided number indicates
+        it should be.
+        (join): Join a list of elements in a human-readable form.
+        (out_of): Create a fraction which takes up a constant amount of characters.
+        (elapsed): Describe the amount of time elapsed as a human-readable string.
+        * Scripts/libraries/webkitcorepy/webkitcorepy/tests/string_utils_unittest.py: Added.
+        (StringUtils): Test string_utils.
+        * Scripts/webkitpy/common/unicode_compatibility.py: Replaced with webkitcorepy.string_utils.
+
 2020-07-22  Aakash Jain  <aakash_jain@apple.com>
 

trunk/Tools/Scripts/libraries/webkitcorepy/README.md

@@ -11 +11 @@
 version = Version(1, 2, 3)
 ```
+
+Unicode stream management across Python 2 and 3
+```
+from webkitcorepy import BytesIO, StringIO, UnicodeIO, unicode
+```
+
+Encoding and decoding byte strings and unicode strings
+```
+from webkitcorepy import string_utils
+
+string_utils.encode(...)
+string_utils.decode(...)
+```

trunk/Tools/Scripts/libraries/webkitcorepy/webkitcorepy/__init__.py

@@ -22 +22 @@
 
 from webkitcorepy.version import Version
-version = Version(0, 0, 1)
+from webkitcorepy.string_utils import BytesIO, StringIO, UnicodeIO, unicode
+
+version = Version(0, 0, 2)

trunk/Tools/Scripts/libraries/webkitcorepy/webkitcorepy/version.py

@@ -21 +21 @@
 # SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 
-import collections
 import re
 
-from functools import total_ordering
+from webkitcorepy.string_utils import unicode
 
 

trunk/Tools/Scripts/webkitpy/common/unicode_compatibility.py

@@ -1 @@
-# Copyright (C) 2019 Apple Inc. All rights reserved.
+# Copyright (C) 2019-2020 Apple Inc. All rights reserved.
 #
 # Redistribution and use in source and binary forms, with or without
@@ -21 +21 @@
 # OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 
-import io
-import sys
-
-
-BytesIO = io.BytesIO
-if sys.version_info > (3, 0):
-    StringIO = io.StringIO
-else:
-    from StringIO import StringIO
-UnicodeIO = io.StringIO
-
-unicode = str if sys.version_info > (3, 0) else unicode
-
+from webkitcorepy import UnicodeIO, StringIO, BytesIO, unicode, string_utils
 
 def encode_if_necessary(value, encoding='utf-8', errors='strict'):
-    # In Python 3, string types must be encoded
-    if type(value) == unicode:
-        return value.encode(encoding, errors=errors)
-    return value
+    return string_utils.encode(value, encoding=encoding, errors=errors)
 
 
 def encode_for(value, target_type, **kwargs):
-    if target_type == bytes:
-        return encode_if_necessary(value, **kwargs)
-
-    if sys.version_info < (3, 0) and target_type == str:
-        return encode_if_necessary(value, **kwargs)
-    return value
+    return string_utils.encode(value, target_type=target_type, **kwargs)
 
 
 def decode_if_necessary(value, encoding='utf-8', errors='strict'):
-    # In Python 2, string types might need to be decoded
-    if type(value) == bytes:
-        return value.decode(encoding, errors=errors)
-    return value
+    return string_utils.decode(value, encoding=encoding, errors=errors)
 
 
 def decode_for(value, target_type):
-    if value is None:
-        return None
-    if type(value) == target_type:
-        return value
-    if target_type == unicode:
-        return decode_if_necessary(bytes(value))
-    return value
+    return string_utils.decode(value, target_type=target_type)