Replace utf with string in public API

As decided with the team, methods containing the word `utf` is
renamed with `string`. (`read_utf` -> `read_string` etc.).

For backwards compatibility, old methods are still there but we
have a deprecation documentation for them.

Author: mdumandag

docs/serialization.rst

@@ -98,16 +98,16 @@ The following is an example of a class that extends
             return 1
 
         def write_data(self, output):
-            output.write_utf(self.street)
+            output.write_string(self.street)
             output.write_int(self.zip_code)
-            output.write_utf(self.city)
-            output.write_utf(self.state)
+            output.write_string(self.city)
+            output.write_string(self.state)
 
         def read_data(self, input):
-            self.street = input.read_utf()
+            self.street = input.read_string()
             self.zip_code = input.read_int()
-            self.city = input.read_utf()
-            self.state = input.read_utf()
+            self.city = input.read_string()
+            self.state = input.read_string()
 
 
 .. Note:: Refer to ``ObjectDataInput``/``ObjectDataOutput`` classes in
@@ -199,10 +199,10 @@ following:
             return 1
 
         def write_portable(self, writer):
-            writer.write_utf("foo", self.foo)
+            writer.write_string("foo", self.foo)
 
         def read_portable(self, reader):
-            self.foo = reader.read_utf("foo")
+            self.foo = reader.read_string("foo")
 
 
 .. Note:: Refer to ``PortableReader``/``PortableWriter`` classes in the
@@ -299,12 +299,12 @@ Foo class:
             return 2
 
         def write_portable(self, writer):
-            writer.write_utf("foo", self.foo)
-            writer.write_utf("foo2", self.foo2)
+            writer.write_string("foo", self.foo)
+            writer.write_string("foo2", self.foo2)
 
         def read_portable(self, reader):
-            self.foo = reader.read_utf("foo")
-            self.foo2 = reader.read_utf("foo2")
+            self.foo = reader.read_string("foo")
+            self.foo2 = reader.read_string("foo2")
 
 You should consider the following when you perform versioning:
 
@@ -377,10 +377,10 @@ Let’s say your custom ``MusicianSerializer`` will serialize
             pass
 
         def write(self, output, obj):
-            output.write_utf(obj.name)
+            output.write_string(obj.name)
 
         def read(self, input):
-            name = input.read_utf()
+            name = input.read_string()
             return Musician(name)
 
 Note that the serializer ``id`` must be unique as Hazelcast will use it
@@ -487,10 +487,10 @@ is shown below.
             pass
 
         def write(self, output, obj):
-            output.write_utf(some_third_party_serializer.serialize(obj))
+            output.write_string(some_third_party_serializer.serialize(obj))
 
         def read(self, input):
-            return some_third_party_serializer.deserialize(input.read_utf())
+            return some_third_party_serializer.deserialize(input.read_string())
 
 You should register the global serializer to the client.
 

docs/using_python_client_with_hazelcast_imdg.rst

@@ -1150,10 +1150,10 @@ The following is an example for ``EntryProcessor`` which is an
             self.value = value
 
         def read_data(self, object_data_input):
-            self.value = object_data_input.read_utf()
+            self.value = object_data_input.read_string()
 
         def write_data(self, object_data_output):
-            object_data_output.write_utf(self.value)
+            object_data_output.write_string(self.value)
 
         def get_factory_id(self):
             return 5
@@ -1364,13 +1364,13 @@ Assume that you have an ``employee`` map containing the instances of
             return 1000
 
         def read_portable(self, reader):
-            self.name = reader.read_utf("name")
+            self.name = reader.read_string("name")
             self.age = reader.read_int("age")
             self.active = reader.read_boolean("active")
             self.salary = reader.read_double("salary")
 
         def write_portable(self, writer):
-            writer.write_utf("name", self.name)
+            writer.write_string("name", self.name)
             writer.write_int("age", self.age)
             writer.write_boolean("active", self.active)
             writer.write_double("salary", self.salary)

examples/map/map_portable_query_example.py

@@ -14,11 +14,11 @@ def __init__(self, name=None, age=None):
         self.age = age
 
     def write_portable(self, writer):
-        writer.write_utf("name", self.name)
+        writer.write_string("name", self.name)
         writer.write_int("age", self.age)
 
     def read_portable(self, reader):
-        self.name = reader.read_utf("name")
+        self.name = reader.read_string("name")
         self.age = reader.read_int("age")
 
     def get_factory_id(self):

examples/map/map_portable_versioning_example.py

@@ -20,11 +20,11 @@ def __init__(self, name=None, age=None):
         self.age = age
 
     def write_portable(self, writer):
-        writer.write_utf("name", self.name)
+        writer.write_string("name", self.name)
         writer.write_int("age", self.age)
 
     def read_portable(self, reader):
-        self.name = reader.read_utf("name")
+        self.name = reader.read_string("name")
         self.age = reader.read_int("age")
 
     def get_factory_id(self):
@@ -57,14 +57,14 @@ def __init__(self, name=None, age=None, manager=None):
         self.manager = manager
 
     def write_portable(self, writer):
-        writer.write_utf("name", self.name)
+        writer.write_string("name", self.name)
         writer.write_int("age", self.age)
-        writer.write_utf("manager", self.manager)
+        writer.write_string("manager", self.manager)
 
     def read_portable(self, reader):
-        self.name = reader.read_utf("name")
+        self.name = reader.read_string("name")
         self.age = reader.read_int("age")
-        self.manager = reader.read_utf("manager")
+        self.manager = reader.read_string("manager")
 
     def get_factory_id(self):
         return self.FACTORY_ID
@@ -103,14 +103,14 @@ def __init__(self, name=None, age=None, manager=None):
         self.manager = manager
 
     def write_portable(self, writer):
-        writer.write_utf("name", self.name)
-        writer.write_utf("age", self.age)
-        writer.write_utf("manager", self.manager)
+        writer.write_string("name", self.name)
+        writer.write_string("age", self.age)
+        writer.write_string("manager", self.manager)
 
     def read_portable(self, reader):
-        self.name = reader.read_utf("name")
-        self.age = reader.read_utf("age")
-        self.manager = reader.read_utf("manager")
+        self.name = reader.read_string("name")
+        self.age = reader.read_string("age")
+        self.manager = reader.read_string("manager")
 
     def get_factory_id(self):
         return self.FACTORY_ID

examples/org-website/custom_serializer_sample.py

@@ -10,10 +10,10 @@ def __init__(self, value=None):
 
 class CustomSerializer(StreamSerializer):
     def write(self, out, obj):
-        out.write_utf(obj.value)
+        out.write_string(obj.value)
 
     def read(self, inp):
-        return CustomSerializableType(inp.read_utf())
+        return CustomSerializableType(inp.read_string())
 
     def get_type_id(self):
         return 10

examples/org-website/executor_service_sample.py

@@ -11,10 +11,10 @@ def __init__(self, message=None):
         self.message = message
 
     def write_portable(self, writer):
-        writer.write_utf("message", self.message)
+        writer.write_string("message", self.message)
 
     def read_portable(self, reader):
-        self.message = reader.read_utf("message")
+        self.message = reader.read_string("message")
 
     def get_factory_id(self):
         return self.FACTORY_ID

examples/org-website/identified_data_serializable_sample.py

@@ -13,11 +13,11 @@ def __init__(self, id=None, name=None):
 
     def read_data(self, object_data_input):
         self.id = object_data_input.read_int()
-        self.name = object_data_input.read_utf()
+        self.name = object_data_input.read_string()
 
     def write_data(self, object_data_output):
         object_data_output.write_int(self.id)
-        object_data_output.write_utf(self.name)
+        object_data_output.write_string(self.name)
 
     def get_factory_id(self):
         return self.FACTORY_ID

examples/org-website/portable_serializable_sample.py

@@ -12,15 +12,15 @@ def __init__(self, id=None, name=None, last_order=None):
         self.name = name
         self.last_order = last_order
 
-    def read_portable(self, object_data_input):
-        self.id = object_data_input.read_int("id")
-        self.name = object_data_input.read_utf("name")
-        self.last_order = object_data_input.read_long("last_order")
-
-    def write_portable(self, object_data_output):
-        object_data_output.write_int("id", self.id)
-        object_data_output.write_utf("name", self.name)
-        object_data_output.write_long("last_order", self.last_order)
+    def read_portable(self, reader):
+        self.id = reader.read_int("id")
+        self.name = reader.read_string("name")
+        self.last_order = reader.read_long("last_order")
+
+    def write_portable(self, writer):
+        writer.write_int("id", self.id)
+        writer.write_string("name", self.name)
+        writer.write_long("last_order", self.last_order)
 
     def get_factory_id(self):
         return self.FACTORY_ID

examples/org-website/query_sample.py

@@ -14,12 +14,12 @@ def __init__(self, username=None, age=None, active=None):
         self.active = active
 
     def write_portable(self, writer):
-        writer.write_utf("username", self.username)
+        writer.write_string("username", self.username)
         writer.write_int("age", self.age)
         writer.write_boolean("active", self.active)
 
     def read_portable(self, reader):
-        self.username = reader.read_utf("username")
+        self.username = reader.read_string("username")
         self.age = reader.read_int("age")
         self.active = reader.read_boolean("active")
 

examples/serialization/global_serialization_example.py

@@ -23,12 +23,12 @@ def __init__(self):
         super(GlobalSerializer, self).__init__()
 
     def read(self, inp):
-        utf = inp.read_utf()
-        obj = cPickle.loads(utf.encode())
+        string = inp.read_string()
+        obj = cPickle.loads(string.encode())
         return obj
 
     def write(self, out, obj):
-        out.write_utf(cPickle.dumps(obj, 0).decode("utf-8"))
+        out.write_string(cPickle.dumps(obj, 0).decode("utf-8"))
 
     def get_type_id(self):
         return self.GLOBAL_SERIALIZER_ID