Merge pull request #15 from dangtrungtin/master

Adding python client for Windows

Author: knonomura

CMakeLists.txt

@@ -0,0 +1,46 @@
+cmake_minimum_required(VERSION 3.14)
+
+project(griddb_python)
+
+set(C_LIB E:/c_client-master/c_client-master/bin/x64/Release)
+set(C_HEADER E:/c_client-master/c_client-master/client/c/include)
+set(SOURCE_HEADER E:/cmake-fun/SourceCode/src)
+set(PYTHON_RESOURCE C:/Users/griddb/AppData/Local/Programs/Python/Python36/)
+set(SWIG_RESOURCE E:/swigwin-3.0.12)
+
+set(PYTHON_LIBRARIES ${PYTHON_RESOURCE}/libs)
+set(PYTHON_INCLUDE_DIRS ${PYTHON_RESOURCE}/include)
+set(PYTHON_LIBRARY ${PYTHON_RESOURCE}/libs)
+set(PYTHON_INCLUDE_DIR ${PYTHON_RESOURCE}/include)
+find_package(PythonLibs 3 REQUIRED)
+find_package(PythonInterp 3 REQUIRED)
+
+set(SWIG_DIR ${SWIG_RESOURCE}/Lib)
+set(SWIG_EXECUTABLE ${SWIG_RESOURCE}/swig.exe)
+find_package(SWIG REQUIRED)
+include(${SWIG_USE_FILE})
+
+set(CMAKE_SWIG_FLAGS -c++)
+set(CMAKE_CXX_FLAGS "/DLL /LD /D_USRDLL /D_WINDLL /MT /MD")
+
+include_directories(${C_HEADER} ${PYTHON_RESOURCE}/include ${SOURCE_HEADER})
+link_directories(${PYTHON_RESOURCE}/libs ${C_LIB})
+
+set_property(SOURCE ${SOURCE_HEADER}/griddb.i PROPERTY CPLUSPLUS ON)
+swig_add_library(griddb_python TYPE SHARED LANGUAGE python SOURCES ${SOURCE_HEADER}/griddb.i
+${SOURCE_HEADER}/TimeSeriesProperties.cpp
+${SOURCE_HEADER}/ContainerInfo.cpp
+${SOURCE_HEADER}/AggregationResult.cpp
+${SOURCE_HEADER}/Container.cpp
+${SOURCE_HEADER}/Store.cpp
+${SOURCE_HEADER}/StoreFactory.cpp
+${SOURCE_HEADER}/PartitionController.cpp
+${SOURCE_HEADER}/Query.cpp
+${SOURCE_HEADER}/QueryAnalysisEntry.cpp
+${SOURCE_HEADER}/RowKeyPredicate.cpp
+${SOURCE_HEADER}/RowSet.cpp
+${SOURCE_HEADER}/TimestampUtils.cpp
+${SOURCE_HEADER}/Field.cpp
+${SOURCE_HEADER}/Util.cpp)
+
+target_link_libraries(griddb_python gridstore_c)

cmake_build_guide.org

@@ -0,0 +1,79 @@
+#+TITLE: Cmake Build Guide For GridDB Python Client
+
+#+STARTUP: showall
+#+STARTUP: logdone
+#+STARTUP: hidestars
+
+#+OPTIONS: author:nil timestamp:nil creator:nil 
+#+OPTIONS: ^:nil _:nil
+
+#+DRAWERS: NOTE
+
+[TABLE-OF-CONTENTS]
+
+#+STYLE: <STYLE type="text/css">
+#+STYLE: <!-
+#+STYLE: .break { page-break-before: always; }
+#+STYLE: -->
+#+STYLE: </STYLE>
+
+#+HTML: <DIV class="break"></DIV><BR>
+
+* Building the GridDB python client
+
+This section shows how to build the GridDB python client on a single machine.
+
+** Confirming the environment
+
+Confirm that OS is Windows 10 64 bit
+
+** Required software to build GridDB python client
+- cmake: version 3.14.5
+- python: version 3.6.4
+- swig: version 3.0.12
+- GridDB C client: version 4.2.0
+In order to build, we also need to install Visual Studio 2017
+
+** Installing required software
+*** Install cmake
+- Download zip package from https://github.com/Kitware/CMake/releases/download/v3.14.5/cmake-3.14.5-win64-x64.zip
+- Extract the zip package and get resource of cmake tool
+*** Install python
+- Download and install python 3.6.4 from https://www.python.org/ftp/python/3.6.4/python-3.6.4-amd64.exe
+- Set path for PYTHON_RESOURCE in *CmakeList.txt*
+#+BEGIN_EXAMPLE
+set(PYTHON_RESOURCE C:/Users/username/AppData/Local/Programs/Python/Python36)
+#+END_EXAMPLE
+*** Install swig
+- Download zip package from https://sourceforge.net/projects/swig/files/swigwin/swigwin-3.0.12/swigwin-3.0.12.zip/download
+- Extract the zip package then set path for SWIG_RESOURCE in *CmakeList.txt*
+#+BEGIN_EXAMPLE
+set(SWIG_RESOURCE E:/swigwin-3.0.12)
+#+END_EXAMPLE
+*** Install GridDB C client
+- Please refer to https://github.com/griddb/c_client to install GridDB C client.
+- After installing GridDB C client, set path for C_LIB (path for gridstore_c.lib) and C_HEADER (path for gridstore.h) in *CmakeList.txt*
+#+BEGIN_EXAMPLE
+set(C_LIB E:/c_client-master/bin/x64/Release)
+set(C_HEADER E:/c_client-master/client/c/include)
+#+END_EXAMPLE
+** Building GridDB python client
+Before building Griddb python client, please set link for SOURCE_HEADER (link to folder store cpp headers) in *CmakeList.txt*
+#+BEGIN_EXAMPLE
+set(SOURCE_HEADER E:/SourceCode/src)
+#+END_EXAMPLE
+*** Generate standard build files from cmake
+- Open <PATH_TO_CMAKE>/cmake-3.14.5-win64-x64/bin/cmake-gui.exe
+- Set link for *source code* in cmake gui: link to folder store *CmakeList.txt*
+- Set link for *the binaries* in cmake gui: link to folder which generated files are store (sln file, py file)
+- Run *Configure* with set *Specify the generator for this project*  is *Visual Studio 15 2017*, and for *Optional toolset to use* is *x64*
+- Run *Generate* to get standard build files
+*** Build python client
+- Open <PATH_TO_OUTPUT_CMAKE>/griddb_python.sln by Visual Studio 2017
+- Build *griddb_python* project to get *_griddb_python.pyd* library and *griddb_python.py* interface
+** Run sample to check for building Python client
+- Put *_griddb_python.pyd*, *gridstore_c.dll* libraries and *griddb_python.py* interface into folder store *sample1.py*
+#+BEGIN_EXAMPLE
+<PATH_TO>/python.exe sample1.py 239.0.0.1 <port> <cluster> <username> <password>
+#+END_EXAMPLE
+

src/TimestampUtils.cpp

@@ -27,8 +27,8 @@ namespace griddb {
     /**
      * Convert from Python timestamp to GridDB timestamp
      */
-    long TimestampUtils::get_time_millis(double timestamp){
-        return long(timestamp * 1000);
+    int64_t TimestampUtils::get_time_millis(double timestamp){
+        return int64_t(timestamp * 1000);
     }
 
 } /* namespace griddb */

src/TimestampUtils.h

@@ -29,7 +29,7 @@ class TimestampUtils {
     public:
         TimestampUtils();
         ~TimestampUtils();
-        static long get_time_millis(double timestamp);
+        static int64_t get_time_millis(double timestamp);
 };
 
 } /* namespace griddb */

src/gstype_python.i

@@ -214,7 +214,7 @@ static PyObject* convertFieldToObject(GSValue* value, GSType type, bool timestam
     int i;
     switch (type) {
         case GS_TYPE_LONG:
-            return PyLong_FromLong(value->asLong);
+            return SWIG_From_dec(long long)(value->asLong);
         case GS_TYPE_STRING:
             return convertStrToObj(value->asString);
         case GS_TYPE_INTEGER:
@@ -291,7 +291,9 @@ static bool convertObjectToGSTimestamp(PyObject* value, GSTimestamp* timestamp)
         }
         return true;
     } else if (checkPyObjIsLong(value)) {
-        utcTimestamp = PyLong_AsLong(value);
+        int64_t tmp;
+        SWIG_AsVal_dec(long long)(value, (long long *)&tmp);
+        utcTimestamp = tmp;
         if (utcTimestamp == 0) { // int type for timestamp input is not correct except 0 value.
             *timestamp = 0;
             return true;
@@ -345,8 +347,8 @@ static bool convertObjectToDouble(PyObject* value, double* floatValPtr) {
     }
     if (PyInt_Check(value)) {
         //input can be integer
-        long int intVal;
-        checkConvert = SWIG_AsVal_long(value, &intVal);
+        int64_t intVal;
+        checkConvert = SWIG_AsVal_dec(long long)(value, (long long *)&intVal);
         if (!SWIG_IsOK(checkConvert)) {
             return false;
         }
@@ -376,8 +378,8 @@ static bool convertObjectToFloat(PyObject* value, float* floatValPtr) {
     }
     if (PyInt_Check(value)) {
         //input can be integer
-        long int intVal;
-        checkConvert = SWIG_AsVal_long(value, &intVal);
+        int64_t intVal;
+        checkConvert = SWIG_AsVal_dec(long long)(value, (long long *)&intVal);
         if (!SWIG_IsOK(checkConvert)) {
             return false;
         }
@@ -553,7 +555,7 @@ static bool convertToRowKeyFieldWithType(griddb::Field &field, PyObject* value,
             if (PyBool_Check(value)) {
                 return false;
             }
-            checkConvert = SWIG_AsVal_long(value, &field.value.asLong);
+            checkConvert = SWIG_AsVal_dec(long long)(value, (long long *)&field.value.asLong);
             if (!SWIG_IsOK(checkConvert)) {
                 return false;
             }
@@ -611,7 +613,7 @@ static bool convertToFieldWithType(GSRow *row, int column, PyObject* value, GSTy
             if (PyBool_Check(value)) {
                 return false;
             }
-            checkConvert = SWIG_AsVal_long(value, &longVal);
+            checkConvert = SWIG_AsVal_dec(long long)(value, (long long *)&longVal);
             if (!SWIG_IsOK(checkConvert)) {
                 return false;
             }
@@ -840,7 +842,7 @@ static bool convertToFieldWithType(GSRow *row, int column, PyObject* value, GSTy
             }
             for (i = 0; i < size; i++) {
                 vbool = PyBool_Check(PyList_GetItem(value, i));
-                checkConvert = SWIG_AsVal_long(PyList_GetItem(value, i), ((int64_t *)longArrVal + i));
+                checkConvert = SWIG_AsVal_dec(long long)(PyList_GetItem(value, i), ((long long *)longArrVal + i));
                 if (!SWIG_IsOK(checkConvert) || vbool) {
                     delete [] longArrVal;
                     return false;
@@ -1466,7 +1468,7 @@ static bool getRowFields(GSRow* row, int columnCount, GSType* typeList, bool tim
             case GS_TYPE_LONG: {
                 int64_t longValue;
                 ret = gsGetRowFieldAsLong(row, (int32_t) i, &longValue);
-                PyList_SetItem(outList, i, PyLong_FromLong(longValue));
+                PyList_SetItem(outList, i, SWIG_From_dec(long long)(longValue));
                 break;
             }
             case GS_TYPE_STRING: {
@@ -1590,7 +1592,7 @@ static bool getRowFields(GSRow* row, int columnCount, GSType* typeList, bool tim
                 ret = gsGetRowFieldAsLongArray(row, (int32_t) i, (const int64_t **)&longArr, &size);
                 PyObject* list = PyList_New(size);
                 for (int j = 0; j < size; j++) {
-                    PyList_SetItem(list, j, PyLong_FromLong(longArr[j]));
+                    PyList_SetItem(list, j, SWIG_From_dec(long long)(longArr[j]));
                 }
                 PyList_SetItem(outList, i, list);
                 break;
@@ -2126,7 +2128,7 @@ static bool getRowFields(GSRow* row, int columnCount, GSType* typeList, bool tim
                 SWIG_fail;
             }
             $1.columnInfo[i].name = v;
-            $1.columnInfo[i].type = PyLong_AsLong(PyList_GetItem(columInfoList, 1));
+            $1.columnInfo[i].type = PyInt_AsLong(PyList_GetItem(columInfoList, 1));
         }
     }
 }