optimze search_response

Author: qiyuewuyi

CHANGELOG.rst

@@ -3,6 +3,11 @@ TableStore SDK for Python 版本记录
 
 Python SDK的版本号遵循 `Semantic Versioning <http://semver.org/>`_ 规则。
 
+Version 5.2.1
+-------------
+
+- Opimize SearchResponse
+
 Version 5.2.0
 -------------
 

README.rst

@@ -1,4 +1,4 @@
-Aliyun TableStore SDK for Python
+Aliyun Tablestore SDK for Python
 ==================================
 
 .. image:: https://img.shields.io/badge/license-apache2-brightgreen.svg
@@ -11,13 +11,13 @@ Aliyun TableStore SDK for Python
 概述
 ----
 
-- 此Python SDK基于 `阿里云表格存储服务 <http://www.aliyun.com/product/ots/>`_  API构建。
-- 阿里云表格存储是构建在阿里云飞天分布式系统之上的NoSQL数据存储服务，提供海量结构化数据的存储和实时访问。
+- 此Python SDK基于 `阿里云表格存储服务 <http://www.aliyun.com/product/ots/>`_  API 构建。
+- 阿里云表格存储是构建在阿里云飞天分布式系统之上的 NoSQL 数据存储服务，提供海量结构化数据的存储和实时访问。
 
 运行环境
 ---------
 
-- 安装Python即可运行，支持python2.6、Python2.7、python3.3、python3.4、python3.5和python3.6。
+- 安装Python即可运行，支持python2.6、Python2.7、python3.3、python3.4、python3.5 和 python3.6。
 
 安装方法
 ---------
@@ -69,13 +69,13 @@ Github安装
 - `批量读（从多张表，一次性读出多行数据） <https://github.com/aliyun/aliyun-tablestore-python-sdk/blob/master/examples/batch_get_row.py>`_
 - `范围扫描（给定一个范围，扫描出该范围内的所有数据） <https://github.com/aliyun/aliyun-tablestore-python-sdk/blob/master/examples/get_range.py>`_
 - `主键自增列（主键自动生成一个递增ID） <https://github.com/aliyun/aliyun-tablestore-python-sdk/blob/master/examples/pk_auto_incr.py>`_
+- `全局二级索引 <https://github.com/aliyun/aliyun-tablestore-python-sdk/blob/master/examples/secondary_index_operations.py>`_
+- `局部事务（提交事务） <https://github.com/aliyun/aliyun-tablestore-python-sdk/blob/master/examples/transaction_and_commit.py>`_
+- `局部事务（舍弃事务） <https://github.com/aliyun/aliyun-tablestore-python-sdk/blob/master/examples/transaction_and_abort.py>`_
 - `Search <https://github.com/aliyun/aliyun-tablestore-python-sdk/blob/master/examples/search_index.py>`_
 - `Parallel Scan <https://github.com/aliyun/aliyun-tablestore-python-sdk/blob/master/examples/parallel_scan.py>`_
 - `Max/Min/Sum/Avg/Count/DistinctCount <https://github.com/aliyun/aliyun-tablestore-python-sdk/blob/master/examples/agg.py>`_
 - `GroupBy <https://github.com/aliyun/aliyun-tablestore-python-sdk/blob/master/examples/group_by.py>`_
-- `全局二级索引 <https://github.com/aliyun/aliyun-tablestore-python-sdk/blob/master/examples/secondary_index_operations.py>`_
-- `局部事务（提交事务） <https://github.com/aliyun/aliyun-tablestore-python-sdk/blob/master/examples/transaction_and_commit.py>`_
-- `局部事务（舍弃事务） <https://github.com/aliyun/aliyun-tablestore-python-sdk/blob/master/examples/transaction_and_abort.py>`_
 
 执行测试
 ---------
@@ -105,10 +105,10 @@ Github安装
 
 贡献代码
 --------
-- 我们非常欢迎大家为TableStore Python SDK以及其他TableStore SDK贡献代码。
-- 感谢 `@Wall-ee <https://github.com/Wall-ee>`_ 对4.3.0版本的贡献。
+- 我们非常欢迎大家为Tablestore Python SDK以及其他Tablestore SDK贡献代码。
+- 非常感谢 `@Wall-ee <https://github.com/Wall-ee>`_ 对4.3.0版本的贡献。
 
 联系我们
 --------
-- `阿里云TableStore官方网站 <http://www.aliyun.com/product/ots>`_
+- `阿里云Tablestore官方网站 <http://www.aliyun.com/product/ots>`_
 - `阿里云官网联系方式 <https://help.aliyun.com/document_detail/61890.html>`_

examples/search_index.py

@@ -10,6 +10,23 @@
 nested_index_name = 'nested_search_index'
 client = None
 
+def term_query_with_multiple_version_response(table_name, index_name):
+    query = TermQuery('k', 'key000')
+    search_response = client.search(table_name, index_name, 
+                                    SearchQuery(query, limit=100, get_total_count=True), 
+                                    ColumnsToGet(return_type=ColumnReturnType.ALL))
+
+    print ("***** 1.0.0 ~ 5.1.0 version: tuple *****")
+    items = search_response.v1_response()
+    print(items)
+
+    print("***** 1.0.0 ~ 5.1.0 version: iter *****")
+    for item in search_response:
+        print(item)
+
+    print ("***** 5.2.0 version *****")
+    print(search_response.rows)
+
 def match_all_query(table_name, index_name):
     # simple queries: match all query and scan to get all data with next token
     query = MatchAllQuery()
@@ -174,6 +191,7 @@ def function_score_query(table_name, index_name):
 
     _print_rows(search_response.rows, search_response.total_count)
 
+
 def prepare_data(rows_count):
     print ('Begin prepare data: %d' % rows_count)
     for i in range(rows_count):
@@ -268,6 +286,7 @@ def delete_search_index(index_name):
     describe_search_index()
 
     # perform queries
+    term_query_with_multiple_version_response(table_name, index_name)
     match_all_query(table_name, index_name)
     match_query(table_name, index_name)
     match_phrase_query(table_name, index_name)

tablestore/__init__.py

@@ -1,6 +1,6 @@
 # -*- coding: utf8 -*-
 
-__version__ = '5.2.0'
+__version__ = '5.2.1'
 __all__ = [
     'OTSClient',
 

tablestore/metadata.py

@@ -900,25 +900,51 @@ def __init__(self, column_names=[], return_type=ColumnReturnType.NONE):
         self.column_names = column_names
         self.return_type = return_type
 
-class SearchResponse(object):
+class IterableResponse(object):
+    def __init__(self):
+        self.index = 0
+        self.response = tuple()
+
+    def __iter__(self):
+        return iter(self.response)
+
+    def _add_response(self, *responses):
+        self.response = tuple(responses)
+
+    def v1_response(self):
+        return self.response
+
+class SearchResponse(IterableResponse):
 
     def __init__(self, rows, agg_results, group_by_results, next_token, is_all_succeed, total_count):
+        super(SearchResponse, self).__init__()
+
         self.rows = rows
         self.agg_results = agg_results
         self.group_by_results = group_by_results
         self.next_token = next_token
         self.is_all_succeed = is_all_succeed
         self.total_count = total_count
 
-class ComputeSplitsResponse(object):
+        self._add_response(self.rows, self.next_token, self.total_count, self.is_all_succeed, 
+                           self.agg_results, self.group_by_results)        
+
+class ComputeSplitsResponse(IterableResponse):
 
     def __init__(self, session_id, splits_size):
+        super(ComputeSplitsResponse, self).__init__()
+
         self.session_id = session_id
         self.splits_size = splits_size
 
+        self._add_response(self.session_id, self.splits_size)
 
-class ParallelScanResponse(object):
+class ParallelScanResponse(IterableResponse):
 
     def __init__(self, rows, next_token):
+        super(ParallelScanResponse, self).__init__()
+
         self.rows = rows
         self.next_token = next_token
+
+        self._add_response(self.rows, self.next_token)

tablestore/protocol.py

@@ -248,7 +248,6 @@ def parse_response(self, api_name, status, headers, body):
             error_message = 'Response format is invalid, %s, RequestID: %s, " \
                 "HTTP status: %s, Body: %s.' % (str(e), request_id, status, body)
             self.logger.error(error_message)
-            #raise OTSClientError(error_message, status)
             raise e
 
         if self.logger.level <= logging.DEBUG:

tests/parallel_scan_test.py

@@ -90,20 +90,45 @@ def test_compute_splits_with_tablename_is_not_exist(self):
             self.assert_error(e, 400, "OTSParameterInvalid", "table [not_exist] does not exist")
 
     def test_parallel_scan_normal(self):
-        compute_splits_response = self.client_test.compute_splits(self.table_name, self.index_name)        
+        compute_splits_response = self.client_test.compute_splits(self.table_name, self.index_name)
+
+        self.assert_equal(1, compute_splits_response.splits_size)
+        self.assertTrue(len(compute_splits_response.session_id) > 0)
+
+        self.assert_equal(compute_splits_response.session_id, compute_splits_response.v1_response()[0])
+        self.assert_equal(compute_splits_response.splits_size, compute_splits_response.v1_response()[1])
+
+        pos = 0
+        for item in compute_splits_response:
+            if pos == 0:
+                self.assert_equal(compute_splits_response.session_id, item)
+            elif pos == 1:
+                self.assert_equal(compute_splits_response.splits_size, item)
+            pos += 1
 
         query = TermQuery('d', 0.1)
         scan_query = ScanQuery(query, limit = 70, next_token = None, current_parallel_id = 0, 
                                max_parallel = compute_splits_response.splits_size, alive_time = 30)
         parallel_scan_response = self.client_test.parallel_scan(
             self.table_name, self.index_name, scan_query, compute_splits_response.session_id, 
-            columns_to_get = ColumnsToGet(return_type=ColumnReturnType.ALL_FROM_INDEX))
+            columns_to_get = ColumnsToGet(return_type = ColumnReturnType.ALL_FROM_INDEX))
 
         self.assert_equal(70, len(parallel_scan_response.rows))
         self.assertTrue(parallel_scan_response.next_token is not None)
 
+        self.assert_equal(70, len(parallel_scan_response.v1_response()[0]))
+        self.assertTrue(parallel_scan_response.v1_response()[1] is not None)
+
+        pos = 0
+        for item in parallel_scan_response:
+            if pos == 0:
+                self.assert_equal(70, len(item))
+            elif pos == 1:
+                self.assertTrue(item is not None)
+            pos += 1
+
         scan_query_2 = ScanQuery(query, limit = 70, next_token = parallel_scan_response.next_token, current_parallel_id = 0, 
-                               max_parallel = compute_splits_response.splits_size, alive_time = 30)
+                                 max_parallel = compute_splits_response.splits_size, alive_time = 30)
         parallel_scan_response2 = self.client_test.parallel_scan(
             self.table_name, self.index_name, scan_query_2, compute_splits_response.session_id, 
             columns_to_get = ColumnsToGet(return_type=ColumnReturnType.ALL_FROM_INDEX))

tests/search_index_test.py

@@ -273,6 +273,23 @@ def _check_query_result(self, search_response, rows_count, has_next_token, expec
         self.assert_equal(len(search_response.next_token) > 0, has_next_token)
         self.assert_equal(search_response.total_count, expect_total_count)
 
+        self.assert_equal(len(search_response.v1_response()[0]), rows_count)
+        self.assert_equal(search_response.v1_response()[3], True)
+        self.assert_equal(len(search_response.v1_response()[1]) > 0, has_next_token)
+        self.assert_equal(search_response.v1_response()[2], expect_total_count)
+
+        pos = 0
+        for item in search_response:
+            if pos == 0:
+                self.assert_equal(len(item), rows_count)
+            elif pos == 1:
+                self.assert_equal(len(item) > 0, has_next_token)
+            elif pos == 2:
+                self.assert_equal(item, expect_total_count)
+            elif pos == 3:
+                self.assert_equal(item, True)
+            pos += 1
+
         return search_response.rows
 
     def _test_prefix_query(self, table_name, index_name):