commit e82c2a0c40d5c00c758ad164bc1441ddb4c8567c
author Tzu-Li (Gordon) Tai <tzulitai@apache.org> Thu Nov 26 16:35:33 2020 +0800
committer Tzu-Li (Gordon) Tai <tzulitai@apache.org> Fri Nov 27 18:41:54 2020 +0800
tree 8e28eebc6aba3fa8778317ec9ce938d559f7a515
parent be8a94cde1e9d5feaa1050b17bce3d6f4dccbc25

[FLINK-20268] [python, docs] Update Python SDK README.md

This closes #179.

statefun-python-sdk/README.md

diff --git a/statefun-python-sdk/README.md b/statefun-python-sdk/README.md
index a39294b..daae600 100755
--- a/statefun-python-sdk/README.md
+++ b/statefun-python-sdk/README.md
@@ -40,7 +40,7 @@
 #### Define and Declare a Function
 
 ```
-from statefun import StatefulFunctions
+from statefun import StatefulFunctions, StateSpec
 
 functions = StatefulFunctions()
 
@@ -49,7 +49,29 @@
     print("Hey " + message.user_name)
 ```
 
-This code declares a function with a `FunctionType("demo", "greeter")` and binds the greet Python instance to it.
+This code declares a function with of type `FunctionType("demo", "greeter")` and binds it to the instance.
+
+#### Registering and accessing persisted state
+
+You can register persistent state that will be managed by the Stateful Functions workers
+for state consistency and fault-tolerance. The state values could be absent (`None` or a `google.protobuf.Any`) and
+they can be generally obtained via the context parameter:
+
+```
+from statefun import StatefulFunctions, StateSpec
+
+functions = StatefulFunctions()
+
+@functions.bind(
+    typename="demo/greeter",
+    states=[StateSpec('session')])
+def greet(context, message: LoginEvent):
+    session = context['session']
+    if not session:
+       session = start_session(message)
+       context['session'] = session
+    ...
+```
 
 #### Expose with a Request Reply Handler
 
@@ -90,26 +112,6 @@
       type: demo/greeter
     spec:
       endpoint: http://<end point url>/statefun
-      states:
-        - foo
-        - bar
-        - baz
-```
-
-#### Eager State Registration
-
-The request reply protocol requires that the state names would be registered in the module YAML file
-under the `states` section (see the example above). The state values could be absent (`None` or a `google.protobuf.Any`) and they can be generally obtained via the context parameter:
-
-```
-@functions.bind("demo/greeter")
-def greet(context, message: LoginEvent):
-    session = context['session']
-    if not session:
-       session = start_session(message)
-       context['session'] = session
-    ...
-
 ```
 
 ### Testing