GG-35197 Fix supported versions and other docs (#58)

isapego · web-flow · commit ff3266a7ccb1 · 2022-05-05T11:07:28.000+03:00
diff --git a/README.md b/README.md
@@ -3,7 +3,7 @@ GridGain Community Edition thin (binary protocol) client, written in Python 3.
 
 ## Prerequisites
 
-- Python 3.6 or above (3.6, 3.7, 3.8 and 3.9 are tested),
+- Python 3.7 or above (3.7, 3.8, 3.9 and 3.10 are tested),
 - Access to GridGain node, local or remote. The current thin client
   version was tested on GridGain CE 8.7 and 8.8 (binary client protocol 1.7.0).
 
@@ -49,12 +49,12 @@ There is an optional C extension to speedup some computational intensive tasks.
   
   ***NB!* Docker is required.**
   
-- On Windows MSVC 14.x required, and it should be in path, also python versions 3.6, 3.7, 3.8 and 3.9 both for x86 and 
+- On Windows MSVC 14.x required, and it should be in path, also python versions 3.7, 3.8, 3.9 and 3.10 both for x86 and
   x86-64 should be installed. You can disable some of these versions but you'd need to edit script for that.
 - For building `wheels` for Windows, invoke script `.\scripts\BuildWheels.ps1` using PowerShell. Just make sure that
   your execution policy allows execution of scripts in your environment.
   
-  Ready wheels for `x86` and `x86-64` for different python versions (3.6, 3.7, 3.8 and 3.9) will be
+  Ready wheels for `x86` and `x86-64` for different python versions (3.7, 3.8, 3.9 and 3.10) will be
   located in `distr` directory.
 
 ### Updating from older version
@@ -83,19 +83,18 @@ at *RTD* for your convenience.
 If you want to build the documentation from source, do the developer
 installation as described above, then run the following commands:
 ```
-$ cd pygridgain
+$ cd <client_root_directory>
 $ pip install -r requirements/docs.txt
 $ cd docs
 $ make html
 ```
 
-Then open `pygridgain/docs/generated/html/index.html`
+Then open `<client_root_directory>/docs/generated/html/index.html`
 in your browser.
 
 ## Examples
 Some examples of using pygridgain are provided in
-`pygridgain/examples` folder. They are extensively
-commented in the
+`examples` folder. They are extensively commented in the
 “[Examples of usage](https://pygridgain.readthedocs.io/en/latest/examples.html)”
 section of the documentation.
 
diff --git a/docs/async_examples.rst b/docs/async_examples.rst
@@ -38,7 +38,7 @@ Let's connect to cluster and perform key-value queries.
 .. literalinclude:: ../examples/async_key_value.py
   :language: python
   :dedent: 4
-  :lines: 23-38
+  :lines: 22-37
 
 Scan
 ====
@@ -62,20 +62,20 @@ in cache settings dictionary on creation.
 .. literalinclude:: ../examples/expiry_policy.py
   :language: python
   :dedent: 12
-  :lines: 73-76
+  :lines: 74-77
 
 .. literalinclude:: ../examples/expiry_policy.py
   :language: python
   :dedent: 12
-  :lines: 82-90
+  :lines: 83-91
 
 Secondly, expiry policy can be set for all cache operations, which are done under decorator. To create it use
 :py:meth:`~pygridgain.cache.BaseCache.with_expire_policy`
 
 .. literalinclude:: ../examples/expiry_policy.py
   :language: python
   :dedent: 12
-  :lines: 97-106
+  :lines: 98-107
 
 Transactions
 ------------
@@ -218,4 +218,4 @@ Finally, delete the tables used in this example with the following queries:
 .. _expiry_policy.py: https://github.com/gridgain/python-thin-client/blob/master/examples/expiry_policy.py
 .. _async_key_value.py: https://github.com/gridgain/python-thin-client/blob/master/examples/async_key_value.py
 .. _async_sql.py: https://github.com/gridgain/python-thin-client/blob/master/examples/async_sql.py
-.. _transactions.py: https://github.com/gridgain/python-thin-client/blob/master/examples/transactions.py
+.. _transactions.py: https://github.com/gridgain/python-thin-client/blob/master/examples/transactions.py
diff --git a/docs/datatypes/cache_props.rst b/docs/datatypes/cache_props.rst
diff --git a/docs/examples.rst b/docs/examples.rst
@@ -96,20 +96,20 @@ in cache settings dictionary on creation.
 .. literalinclude:: ../examples/expiry_policy.py
   :language: python
   :dedent: 12
-  :lines: 32-35
+  :lines: 33-36
 
 .. literalinclude:: ../examples/expiry_policy.py
   :language: python
   :dedent: 12
-  :lines: 41-47
+  :lines: 42-48
 
 Secondly, expiry policy can be set for all cache operations, which are done under decorator. To create it use
 :py:meth:`~pygridgain.cache.BaseCache.with_expire_policy`
 
 .. literalinclude:: ../examples/expiry_policy.py
   :language: python
   :dedent: 12
-  :lines: 54-61
+  :lines: 55-62
 
 Scan
 ====
@@ -773,3 +773,4 @@ with the following message:
 .. _attrs: https://pypi.org/project/attrs/
 .. _get_and_put_complex.py: https://github.com/gridgain/python-thin-client/tree/master/examples/get_and_put_complex.py
 .. _Collection: https://ignite.apache.org/docs/latest/binary-client-protocol/data-format#collection
+.. _simple class names: https://ignite.apache.org/docs/latest/data-modeling/binary-marshaller#binary-name-mapper-and-binary-id-mapper
diff --git a/docs/readme.rst b/docs/readme.rst
@@ -34,7 +34,7 @@ through a raw TCP socket.
 Prerequisites
 -------------
 
-- *Python 3.6* or above (3.6, 3.7, 3.8 and 3.9 are tested),
+- *Python 3.7* or above (3.7, 3.8, 3.9 and 3.10 are tested),
 - Access to *GridGain* node, local or remote. The current thin client
   version was tested on *GridGain CE 8.7* (binary client protocols 1.2.0
   to 1.7.0).
diff --git a/docs/source/pygridgain.aio_cluster.rst b/docs/source/pygridgain.aio_cluster.rst
@@ -13,7 +13,7 @@
     limitations under the License.
 
 pygridgain.aio_cluster module
-===========================
+=============================
 
 .. automodule:: pygridgain.aio_cluster
     :members:
diff --git a/docs/source/pygridgain.cluster.rst b/docs/source/pygridgain.cluster.rst
@@ -13,7 +13,7 @@
     limitations under the License.
 
 pygridgain.cluster module
-=======================
+=========================
 
 .. automodule:: pygridgain.cluster
     :members:
diff --git a/docs/source/pygridgain.connection.protocol_context.rst b/docs/source/pygridgain.connection.protocol_context.rst
@@ -13,7 +13,7 @@
     limitations under the License.
 
 pygridgain.connection.protocol_context package
-===========================
+==============================================
 
 .. automodule:: pygridgain.connection.protocol_context
-    :members:
+    :members:
diff --git a/docs/source/pygridgain.datatypes.cluster_state.rst b/docs/source/pygridgain.datatypes.cluster_state.rst
@@ -13,7 +13,7 @@
     limitations under the License.
 
 pygridgain.datatypes.cluster_state module
-=======================================
+=========================================
 
 .. automodule:: pygridgain.datatypes.cluster_state
     :members:
diff --git a/docs/source/pygridgain.datatypes.expiry_policy.rst b/docs/source/pygridgain.datatypes.expiry_policy.rst
@@ -13,7 +13,7 @@
     limitations under the License.
 
 pygridgain.datatypes.expiry_policy module
-=======================================
+=========================================
 
 .. automodule:: pygridgain.datatypes.expiry_policy
     :members:
diff --git a/docs/source/pygridgain.datatypes.rst b/docs/source/pygridgain.datatypes.rst
@@ -13,7 +13,7 @@
     limitations under the License.
 
 pygridgain.datatypes package
-==========================
+============================
 
 .. automodule:: pygridgain.datatypes
     :members:
@@ -40,3 +40,4 @@ Submodules
    pygridgain.datatypes.primitive_objects
    pygridgain.datatypes.sql
    pygridgain.datatypes.standard
+   pygridgain.datatypes.transactions
diff --git a/docs/source/pygridgain.datatypes.transactions.rst b/docs/source/pygridgain.datatypes.transactions.rst
@@ -13,8 +13,8 @@
     limitations under the License.
 
 pygridgain.datatypes.transactions module
-=======================================
+========================================
 
 .. automodule:: pygridgain.datatypes.transactions
     :members:
-    :show-inheritance:
+    :show-inheritance:
diff --git a/docs/source/pygridgain.monitoring.rst b/docs/source/pygridgain.monitoring.rst
@@ -13,7 +13,7 @@
     limitations under the License.
 
 pygridgain.monitoring module
-===========================
+============================
 
 .. automodule:: pygridgain.monitoring
     :members:
diff --git a/docs/source/pygridgain.rst b/docs/source/pygridgain.rst
@@ -13,7 +13,7 @@
     limitations under the License.
 
 pygridgain package
-================
+==================
 
 .. automodule:: pygridgain
     :members:
diff --git a/docs/source/pygridgain.transaction.rst b/docs/source/pygridgain.transaction.rst
@@ -13,7 +13,7 @@
     limitations under the License.
 
 pygridgain.transaction module
-===========================
+=============================
 
 .. automodule:: pygridgain.transaction
     :members:
diff --git a/examples/async_key_value.py b/examples/async_key_value.py
@@ -13,7 +13,6 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 #
-
 import asyncio
 
 from pygridgain import AioClient
diff --git a/examples/docker-compose.yml b/examples/docker-compose.yml
@@ -14,6 +14,7 @@
 # limitations under the License.
 #
 
+version: "3"
 services:
   ignite_0:
     image: gridgain/community:latest
diff --git a/pygridgain/datatypes/standard.py b/pygridgain/datatypes/standard.py
@@ -18,7 +18,7 @@
 import decimal
 from io import SEEK_CUR
 from math import ceil
-from typing import Tuple
+from typing import Tuple, Union
 import uuid
 
 from pygridgain.constants import *
@@ -365,7 +365,7 @@ def build_c_type(cls):
         return cls._object_c_type
 
     @classmethod
-    def from_python_not_null(cls, stream, value: [date, datetime], **kwargs):
+    def from_python_not_null(cls, stream, value: Union[date, datetime], **kwargs):
         if type(value) is date:
             value = datetime.combine(value, time())
         data_type = cls.build_c_type()
diff --git a/pygridgain/monitoring.py b/pygridgain/monitoring.py
@@ -56,8 +56,6 @@ def on_query_success(self, event):
 
 .. note:: Debug logging is also available, standard ``logging`` is used. Just set ``DEBUG`` level to
     *pygridgain* logger.
-|
-|
 """
 from typing import Optional, Sequence
 
diff --git a/requirements/docs.txt b/requirements/docs.txt
@@ -2,5 +2,5 @@
 # (look up the prebuilt docs in `docs/generated`)
 
 -r install.txt
-Sphinx==1.7.5
+Sphinx==4.1.2
 sphinxcontrib-fulltoc==1.2.0
diff --git a/requirements/tests.txt b/requirements/tests.txt
@@ -6,5 +6,5 @@ pytest-cov==2.11.1
 pytest-asyncio==0.14.0
 teamcity-messages==1.28
 psutil==5.8.0
-jinja2==2.11.3
+jinja2==3.0.3
 flake8==3.8.4
diff --git a/scripts/BuildWheels.ps1 b/scripts/BuildWheels.ps1
@@ -14,7 +14,7 @@
 # limitations under the License.
 #
 
-$PyVers="36","37","38","39"
+$PyVers="37","38","39","310"
 
 [System.Collections.ArrayList]$PyVersFull = $PyVers
 foreach ($Ver in $PyVers)
diff --git a/scripts/build_wheels.sh b/scripts/build_wheels.sh
@@ -28,7 +28,7 @@ function repair_wheel {
 
 # Compile wheels
 for PYBIN in /opt/python/*/bin; do
-    if [[ $PYBIN =~ ^(.*)cp3[6789](.*)$ ]]; then
+    if [[ $PYBIN =~ ^(.*)cp3[7891](.*)$ ]]; then
         "${PYBIN}/pip" wheel /pygridgain/ --no-deps -w /wheels
     fi
 done
diff --git a/scripts/create_distr.sh b/scripts/create_distr.sh
@@ -17,7 +17,7 @@
 
 DISTR_DIR="$(pwd)/distr/"
 SRC_DIR="$(pwd)"
-DEFAULT_DOCKER_IMAGE="quay.io/pypa/manylinux1_x86_64"
+DEFAULT_DOCKER_IMAGE="quay.io/pypa/manylinux2010_x86_64"
 
 usage() {
     cat <<EOF
@@ -51,7 +51,7 @@ run_wheel_arch() {
     if [[ $1 =~ ^(i686|x86)$ ]]; then
         PLAT="manylinux1_i686"
         PRE_CMD="linux32"
-        DOCKER_IMAGE="quay.io/pypa/manylinux1_i686"
+        DOCKER_IMAGE="quay.io/pypa/manylinux2010_i686"
     elif [[ $1 =~ ^(x86_64)$ ]]; then
         PLAT="manylinux1_x86_64"
         PRE_CMD=""
diff --git a/scripts/create_sdist.sh b/scripts/create_sdist.sh
@@ -19,7 +19,7 @@ set -e -u -x
 
 # Create source dist.
 for PYBIN in /opt/python/*/bin; do
-    if [[ $PYBIN =~ ^(.*)cp3[6789](.*)$ ]]; then
+    if [[ $PYBIN =~ ^(.*)cp3[7891](.*)$ ]]; then
         cd pygridgain
         "${PYBIN}/python" setup.py sdist --formats=gztar,zip --dist-dir /dist
         break;
diff --git a/setup.py b/setup.py
@@ -94,7 +94,7 @@ def run_setup(with_binary=True):
     setuptools.setup(
         name='pygridgain',
         version=version,
-        python_requires='>=3.6',
+        python_requires='>=3.7',
         author='GridGain Systems',
         author_email='info@gridgain.com',
         description='GridGain binary client Python API',
@@ -108,10 +108,10 @@ def run_setup(with_binary=True):
         classifiers=[
             'Programming Language :: Python',
             'Programming Language :: Python :: 3',
-            'Programming Language :: Python :: 3.6',
             'Programming Language :: Python :: 3.7',
             'Programming Language :: Python :: 3.8',
             'Programming Language :: Python :: 3.9',
+            'Programming Language :: Python :: 3.10',
             'Programming Language :: Python :: 3 :: Only',
             'Intended Audience :: Developers',
             'Topic :: Database :: Front-Ends',
