Merge pull request #4 from zhanghaitao3/feat/gaussdb-sha256-auth

Feat/complete migration to async_gaussdb with GaussDB compatibility

Author: liubao68

.flake8

@@ -3,3 +3,4 @@ select = C90,E,F,W,Y0
 ignore = E402,E731,W503,W504,E252
 exclude = .git,__pycache__,build,dist,.eggs,.github,.local,.venv*,.tox
 per-file-ignores = *.pyi: F401,F403,F405,F811,E127,E128,E203,E266,E301,E302,E305,E501,E701,E704,E741,B303,W503,W504
+max-line-length = 89

.github/ISSUE_TEMPLATE.md

@@ -10,15 +10,15 @@ the problem is provided, with clear instructions on how to run it.
 Thank you!
 -->
 
-* **asyncpg version**:
+* **async_gaussdb version**:
 * **PostgreSQL version**:
 * **Do you use a PostgreSQL SaaS?  If so, which?  Can you reproduce
   the issue with a local PostgreSQL install?**:
 * **Python version**:
 * **Platform**:
 * **Do you use pgbouncer?**:
-* **Did you install asyncpg with pip?**:
-* **If you built asyncpg locally, which version of Cython did you use?**:
+* **Did you install async_gaussdb with pip?**:
+* **If you built async_gaussdb locally, which version of Cython did you use?**:
 * **Can the issue be reproduced under both asyncio and
   [uvloop](https://github.com/magicstack/uvloop)?**:
 

.github/RELEASING.rst

@@ -1,17 +1,17 @@
-Releasing asyncpg
+Releasing async_gaussdb
 =================
 
-When making an asyncpg release follow the below checklist.
+When making an async_gaussdb release follow the below checklist.
 
-1. Remove the ``.dev0`` suffix from ``__version__`` in ``asyncpg/__init__.py``.
+1. Remove the ``.dev0`` suffix from ``__version__`` in ``async_gaussdb/__init__.py``.
 
 2. Make a release commit:
 
    .. code-block:: shell
 
-      $ git commit -a -m "asyncpg vX.Y.0"
+      $ git commit -a -m "async_gaussdb vX.Y.0"
 
-   Here, X.Y.0 is the ``__version__`` in ``asyncpg/__init__.py``.
+   Here, X.Y.0 is the ``__version__`` in ``async_gaussdb/__init__.py``.
 
 3. Force push into the "releases" branch on Github:
 
@@ -51,5 +51,5 @@ When making an asyncpg release follow the below checklist.
    rather than Markdown.)
 
 10. Open master for development by bumping the minor component of
-    ``__version__`` in ``asyncpg/__init__.py`` and appending the ``.dev0``
+    ``__version__`` in ``async_gaussdb/__init__.py`` and appending the ``.dev0``
     suffix.

.github/release_log.py

@@ -13,7 +13,7 @@
 import sys
 
 
-BASE_URL = 'https://api.github.com/repos/magicstack/asyncpg/compare'
+BASE_URL = 'https://api.github.com/repos/magicstack/async_gaussdb/compare'
 
 
 def main():

.github/workflows/release.yml

@@ -7,7 +7,7 @@ on:
       - "ci"
       - "[0-9]+.[0-9x]+*"
     paths:
-      - "asyncpg/_version.py"
+      - "async_gaussdb/_version.py"
 
 jobs:
   validate-release-request:
@@ -20,7 +20,7 @@ jobs:
         require_team: Release Managers
         require_approval: no
         github_token: ${{ secrets.RELEASE_BOT_GITHUB_TOKEN }}
-        version_file: asyncpg/_version.py
+        version_file: async_gaussdb/_version.py
         version_line_pattern: |
           __version__(?:\s*:\s*typing\.Final)?\s*=\s*(?:['"])([[:PEP440:]])(?:['"])
 
@@ -192,7 +192,7 @@ jobs:
 
     environment:
       name: pypi
-      url: https://pypi.org/p/asyncpg
+      url: https://pypi.org/p/async_gaussdb
     permissions:
       id-token: write
       attestations: write

.github/workflows/tests.yml

@@ -46,7 +46,7 @@ jobs:
       with:
         github_token: ${{ secrets.RELEASE_BOT_GITHUB_TOKEN }}
         missing_version_ok: yes
-        version_file: asyncpg/_version.py
+        version_file: async_gaussdb/_version.py
         version_line_pattern: |
           __version__(?:\s*:\s*typing\.Final)?\s*=\s*(?:['"])([[:PEP440:]])(?:['"])
 
@@ -101,7 +101,7 @@ jobs:
       with:
         github_token: ${{ secrets.RELEASE_BOT_GITHUB_TOKEN }}
         missing_version_ok: yes
-        version_file: asyncpg/_version.py
+        version_file: async_gaussdb/_version.py
         version_line_pattern: |
           __version__(?:\s*:\s*typing\.Final)?\s*=\s*(?:['"])([[:PEP440:]])(?:['"])
 

.gitmodules

@@ -1,3 +1,3 @@
-[submodule "asyncpg/pgproto"]
-	path = asyncpg/pgproto
+[submodule "async_gaussdb/pgproto"]
+	path = async_gaussdb/pgproto
 	url = https://github.com/MagicStack/py-pgproto.git

MANIFEST.in

@@ -1,5 +1,5 @@
 recursive-include docs *.py *.rst Makefile *.css
 recursive-include examples *.py
 recursive-include tests *.py *.pem
-recursive-include asyncpg *.pyx *.pxd *.pxi *.py *.pyi *.c *.h
+recursive-include async_gaussdb *.pyx *.pxd *.pxi *.py *.pyi *.c *.h
 include LICENSE README.rst Makefile performance.png .flake8

Makefile

@@ -10,21 +10,21 @@ all: compile
 
 clean:
 	rm -fr dist/ doc/_build/
-	rm -fr asyncpg/pgproto/*.c asyncpg/pgproto/*.html
-	rm -fr asyncpg/pgproto/codecs/*.html
-	rm -fr asyncpg/pgproto/*.so
-	rm -fr asyncpg/protocol/*.c asyncpg/protocol/*.html
-	rm -fr asyncpg/protocol/*.so build *.egg-info
-	rm -fr asyncpg/protocol/codecs/*.html
+	rm -fr async_gaussdb/pgproto/*.c async_gaussdb/pgproto/*.html
+	rm -fr async_gaussdb/pgproto/codecs/*.html
+	rm -fr async_gaussdb/pgproto/*.so
+	rm -fr async_gaussdb/protocol/*.c async_gaussdb/protocol/*.html
+	rm -fr async_gaussdb/protocol/*.so build *.egg-info
+	rm -fr async_gaussdb/protocol/codecs/*.html
 	find . -name '__pycache__' | xargs rm -rf
 
 
 compile:
-	env ASYNCPG_BUILD_CYTHON_ALWAYS=1 $(PYTHON) -m pip install -e .
+	env ASYNCGAUSSDB_BUILD_CYTHON_ALWAYS=1 $(PYTHON) -m pip install -e .
 
 
 debug:
-	env ASYNCPG_DEBUG=1 $(PYTHON) -m pip install -e .
+	env ASYNCGAUSSDB_DEBUG=1 $(PYTHON) -m pip install -e .
 
 test:
 	PYTHONASYNCIODEBUG=1 $(PYTHON) -m unittest -v tests.suite

README.rst

@@ -1,37 +1,43 @@
-asyncpg -- A fast PostgreSQL Database Client Library for Python/asyncio
-=======================================================================
+async_gaussdb-gaussdb -- A fast GaussDB/openGauss Database Client Library for Python/asyncio
+=====================================================================================
 
-.. image:: https://github.com/MagicStack/asyncpg/workflows/Tests/badge.svg
-   :target: https://github.com/MagicStack/asyncpg/actions?query=workflow%3ATests+branch%3Amaster
+.. image:: https://github.com/MagicStack/async_gaussdb/workflows/Tests/badge.svg
+   :target: https://github.com/MagicStack/async_gaussdb/actions?query=workflow%3ATests+branch%3Amaster
    :alt: GitHub Actions status
-.. image:: https://img.shields.io/pypi/v/asyncpg.svg
-   :target: https://pypi.python.org/pypi/asyncpg
+.. image:: https://img.shields.io/pypi/v/async_gaussdb.svg
+   :target: https://pypi.python.org/pypi/async_gaussdb
 
-**asyncpg** is a database interface library designed specifically for
-PostgreSQL and Python/asyncio.  asyncpg is an efficient, clean implementation
-of PostgreSQL server binary protocol for use with Python's ``asyncio``
-framework.  You can read more about asyncpg in an introductory
-`blog post <http://magic.io/blog/asyncpg-1m-rows-from-postgres-to-python/>`_.
+**async_gaussdb-gaussdb** is a database interface library designed specifically for
+GaussDB and openGauss databases with Python/asyncio. This fork of async_gaussdb is
+optimized for GaussDB/openGauss compatibility, including native SHA256
+authentication support and enhanced features for enterprise database environments.
 
-asyncpg requires Python 3.8 or later and is supported for PostgreSQL
-versions 9.5 to 17.  Other PostgreSQL versions or other databases
-implementing the PostgreSQL protocol *may* work, but are not being
-actively tested.
+async_gaussdb-gaussdb requires Python 3.8 or later and is specifically designed for
+GaussDB and openGauss databases. It includes compatibility fixes and
+optimizations for openGauss-specific features and enterprise database requirements.
+
+**Key Features for GaussDB/openGauss:**
+* Native SHA256 authentication support
+* Optimized for openGauss protocol compatibility
+* Enhanced error handling for enterprise database features
+* Support for GaussDB-specific data types and functions
+* Comprehensive test suite adapted for openGauss
 
 
 Documentation
 -------------
 
 The project documentation can be found
-`here <https://magicstack.github.io/asyncpg/current/>`_.
+`here <https://magicstack.github.io/async_gaussdb/current/>`_.
 
 
 Performance
 -----------
 
-In our testing asyncpg is, on average, **5x** faster than psycopg3.
+async_gaussdb-gaussdb maintains the high performance characteristics of the original
+async_gaussdb library while being optimized for GaussDB/openGauss environments.
 
-.. image:: https://raw.githubusercontent.com/MagicStack/asyncpg/master/performance.png?fddca40ab0
+.. image:: https://raw.githubusercontent.com/MagicStack/async_gaussdb/master/performance.png?fddca40ab0
     :target: https://gistpreview.github.io/?0ed296e93523831ea0918d42dd1258c2
 
 The above results are a geometric mean of benchmarks obtained with PostgreSQL
@@ -42,34 +48,34 @@ in June 2023 (click on the chart to see full details).
 Features
 --------
 
-asyncpg implements PostgreSQL server protocol natively and exposes its
-features directly, as opposed to hiding them behind a generic facade
-like DB-API.
-
-This enables asyncpg to have easy-to-use support for:
+async_gaussdb-gaussdb implements the GaussDB/openGauss server protocol natively and
+exposes its features directly, optimized for enterprise database environments:
 
-* **prepared statements**
-* **scrollable cursors**
-* **partial iteration** on query results
+* **SHA256 authentication** - Native support for GaussDB/openGauss authentication
+* **prepared statements** - Optimized for openGauss query execution
+* **scrollable cursors** - Full cursor support for large result sets
+* **partial iteration** on query results - Memory-efficient data processing
 * automatic encoding and decoding of composite types, arrays,
   and any combination of those
 * straightforward support for custom data types
+* **openGauss compatibility** - Comprehensive test suite and error handling
+* **Enterprise features** - Optimized for production GaussDB environments
 
 
 Installation
 ------------
 
-asyncpg is available on PyPI.  When not using GSSAPI/SSPI authentication it
-has no dependencies.  Use pip to install::
+async_gaussdb-gaussdb is available on PyPI. When not using GSSAPI/SSPI authentication it
+has no dependencies. Use pip to install::
 
-    $ pip install asyncpg
+    $ pip install async-gaussdb
 
 If you need GSSAPI/SSPI authentication, use::
 
-    $ pip install 'asyncpg[gssauth]'
+    $ pip install 'async-gaussdb[gssauth]'
 
 For more details, please `see the documentation
-<https://magicstack.github.io/asyncpg/current/installation.html>`_.
+<https://magicstack.github.io/async_gaussdb/current/installation.html>`_.
 
 
 Basic Usage
@@ -78,11 +84,19 @@ Basic Usage
 .. code-block:: python
 
     import asyncio
-    import asyncpg
+    import async_gaussdb
 
     async def run():
-        conn = await asyncpg.connect(user='user', password='password',
-                                     database='database', host='127.0.0.1')
+        # Connect to GaussDB/openGauss
+        conn = await async_gaussdb.connect(
+            user='omm',
+            password='your_password',
+            database='postgres',
+            host='127.0.0.1',
+            port=5432
+        )
+        
+        # Execute queries with full GaussDB support
         values = await conn.fetch(
             'SELECT * FROM mytable WHERE id = $1',
             10,
@@ -92,7 +106,52 @@ Basic Usage
     asyncio.run(run())
 
 
+GaussDB/openGauss Specific Features
+----------------------------------
+
+This library includes enhanced support for GaussDB and openGauss databases:
+
+.. code-block:: python
+
+    import asyncio
+    import async_gaussdb
+
+    async def run():
+        # Connect with SHA256 authentication (GaussDB/openGauss specific)
+        conn = await async_gaussdb.connect(
+            user='omm',
+            password='your_password',
+            database='postgres',
+            host='127.0.0.1',
+            port=5432
+        )
+        
+        # Use GaussDB-specific features
+        # The library automatically handles openGauss protocol differences
+        values = await conn.fetch(
+            'SELECT * FROM mytable WHERE id = $1',
+            10,
+        )
+        await conn.close()
+
+    asyncio.run(run())
+
+
+Development with Docker
+----------------------
+
+A Dockerfile is provided for development with openGauss:
+
+.. code-block:: bash
+
+    # Build the development image
+    docker build -t async_gaussdb-gaussdb-dev .
+    
+    # Run the container
+    docker run -it async_gaussdb-gaussdb-dev
+
+
 License
 -------
 
-asyncpg is developed and distributed under the Apache 2.0 license.
+async_gaussdb-gaussdb is developed and distributed under the Apache 2.0 license.