Merge pull request #8 from GoodManWEN/dev

GoodManWEN · web-flow · commit 3be229f6185f · 2021-01-08T03:50:02.000Z
Dev
diff --git a/.github/workflows/python-package.yml b/.github/workflows/python-package.yml
@@ -5,9 +5,14 @@ name: Build
 
 on:
   push:
-    branches: [ main ]
+    branches:
+      - 'master'
+      - '[0-9].[0-9]+'  # matches to backport branches, e.g. 3.6
+      - dev
   pull_request:
-    branches: [ main ]
+    branches:
+      - 'master'
+      - '[0-9].[0-9]+'
   schedule:
     - cron:  '0 9 1 * *'  # Runs at 09:00 UTC on the 1st of every month
 
@@ -17,26 +22,44 @@ jobs:
     runs-on: ${{ matrix.os }}
     strategy:
       matrix:
-        os: [macos-latest, ubuntu-latest, windows-latest]
+        os: [ubuntu-latest]
         python-version: ['3.7' , '3.8' , '3.9']
 
     steps:
-    - uses: actions/checkout@v2
-    - name: Set up Python ${{ matrix.python-version }}
-      uses: actions/setup-python@v2
-      with:
-        python-version: ${{ matrix.python-version }}
-    - name: Install dependencies
-      run: |
-        python -m pip install --upgrade pip
-        python -m pip install flake8 pytest pytest-asyncio
-        pip install -r requirements.txt
-    - name: Lint with flake8
-      run: |
-        # stop the build if there are Python syntax errors or undefined names
-        flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics
-        # exit-zero treats all errors as warnings. The GitHub editor is 127 chars wide
-        flake8 . --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics
-    - name: Test with pytest
-      run: |
-        pytest
+      - name: Checkout
+        uses: actions/checkout@v2 # You need to checkout first, then you can use your repo in following actions.
+        with:
+          repository: GoodManWEN/oracle-client-action
+      - name: Setup Oracledb client
+        uses: GoodManWEN/oracle-client-action@main
+      - name: Checkout
+        uses: actions/checkout@v2
+        with:
+          repository: GoodManWEN/oracle-11g-server-action
+      - name: Setup Oracledb 11gR2 server
+        uses: GoodManWEN/oracle-11g-server-action@main
+        with:
+          host port: 1521 
+          oracle version: '1.0.0'
+      - name: Checkout
+        uses: actions/checkout@v2
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v2
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Install dependencies
+        run: |  # sleep to make sure Oracle server is fully loaded
+          sleep 60            
+          python -m pip install --upgrade pip
+          python -m pip install flake8 pytest pytest-asyncio
+          pip install -r requirements.txt
+      - name: Lint with flake8
+        run: |
+          # stop the build if there are Python syntax errors or undefined names
+          flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics
+          # exit-zero treats all errors as warnings. The GitHub editor is 127 chars wide
+          flake8 . --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics
+      - name: Test with pytest
+        run: |
+          sleep 30
+          pytest
diff --git a/README.md b/README.md
@@ -18,7 +18,8 @@ Easy to use , buy may not the best practice for efficiency concern.
     pip install cx_Oracle_async
     
 ## Usage
-- Nearly all the same with aiomysql (with very limited functions of cource)
+- Nearly all the same with aiomysql (with very limited functions of cource).
+- If you're connecting to database which is on a different machine with python process , you need to install oracle client module in order to use this library. Check [cx-Oracle's installation guide](https://cx-oracle.readthedocs.io/en/latest/user_guide/installation.html).
 - No automaticly date format transition built-in.
 
 ## Performance
@@ -33,24 +34,22 @@ single line insertion | N/A (todo) | N/A | N/A
 *Oracle 19c*<br>
 *You can find performance test codes [here](https://github.com/GoodManWEN/cx_Oracle_async/blob/main/misc).*
 
-## Example
+## Examples
+Before running examples , make sure you've already installed a [oracle client](https://github.com/GoodManWEN/cx_Oracle_async#usage) on your machine.
 ```Python3
 # all_usages.py
 import asyncio
 import cx_Oracle_async
 
 async def main():
-    loop = asyncio.get_running_loop()
     oracle_pool = await cx_Oracle_async.create_pool(
         host='localhost', 
         port='1521',
         user='user', 
         password='password',
-        db='orcl', 
-        loop=loop,
-        autocommit=False,  # this option has no use.
-        minsize = 2,
-        maxsize = 4,
+        service_name='orcl', 
+        min = 2,
+        max = 4,
     )
 
     async with oracle_pool.acquire() as connection:
@@ -74,6 +73,30 @@ async def main():
             await cursor.execute(sql_3 , (60 , ))
             print(await cursor.fetchall())
 
+    await oracle_pool.close()
+
 if __name__ == '__main__':
     asyncio.run(main())
 ```
+
+Or you can connect to database via makedsn style:
+```Python3
+# makedsn.py
+import asyncio
+import cx_Oracle_async
+
+async def main():
+    # same api as cx_Oracle.makedsn with 4 limited parameters(host , port , sid , service_name).
+    dsn = cx_Oracle_async.makedsn(host = 'localhost' , port = '1521' , service_name = 'orcl')
+    oracle_pool = await cx_Oracle_async.create_pool(
+        user='user', 
+        password='password',
+        dsn = dsn
+    )
+
+    ...
+
+    await oracle_pool.close()
+
+asyncio.run(main())
+```
diff --git a/cx_Oracle_async/__init__.py b/cx_Oracle_async/__init__.py
@@ -1,7 +1,8 @@
 __version__ = ''
 
-from .utils import create_pool
+from .utils import create_pool , makedsn
 
 __all__ = (
 	'create_pool',
+	'makedsn'
 )
diff --git a/cx_Oracle_async/utils.py b/cx_Oracle_async/utils.py
@@ -1,5 +1,5 @@
 from ThreadPoolExecutorPlus import ThreadPoolExecutor
-import cx_Oracle as csor
+import cx_Oracle as cxor
 import platform
 import asyncio
 import os
@@ -12,6 +12,8 @@
     DEFAULT_MAXIMUM_WORKER_NUM = (os.cpu_count() or 1) * 32
     DEFAULT_MAXIMUM_WORKER_TIMES = 3
 
+makedsn = cxor.makedsn
+
 class AsyncCursorWrapper:
 
     def __init__(self , loop , thread_pool , cursor):
@@ -115,10 +117,59 @@ def _test():
 
         await self._loop.run_in_executor(self._thread_pool , _test)
 
-async def create_pool(host = 'localhost', port = '1521' , user = 'sys', password = '', db = 'orcl', loop = None, minsize = 2 , maxsize = 4 , encoding = 'UTF-8' , autocommit=False):
+async def create_pool(
+        user=None, 
+        password=None, 
+        dsn=None, 
+        min=2, 
+        max=4, 
+        increment=1, 
+        connectiontype=cxor.Connection, 
+        threaded=True, 
+        getmode=cxor.SPOOL_ATTRVAL_NOWAIT, 
+        events=False, 
+        homogeneous=True, 
+        externalauth=False, 
+        encoding='UTF-8', 
+        edition=None, 
+        timeout=0, 
+        waitTimeout=0, 
+        maxLifetimeSession=0, 
+        sessionCallback=None, 
+        maxSessionsPerShard=0,
+        host=None,
+        port=None,
+        service_name=None,
+        sid=None,
+        loop=None
+    ):
     if loop == None:
         loop = asyncio.get_running_loop()
-    pool = csor.SessionPool(user , password , f"{host}:{port}/{db}", min = minsize , max = maxsize , increment = 1 , threaded = True , encoding = encoding)
+    if dsn == None:
+        if service_name != None:
+            dsn = makedsn(host = host, port = port, sid = sid , service_name = service_name)
+        else:
+            dsn = makedsn(host = host, port = port, sid = sid)
+    pool = cxor.SessionPool(
+        user=user, 
+        password=password, 
+        dsn=dsn, 
+        min=min, 
+        max=max, 
+        increment=increment, 
+        connectiontype=connectiontype, 
+        threaded=threaded, 
+        getmode=getmode, 
+        events=events, 
+        homogeneous=homogeneous, 
+        externalauth=externalauth, 
+        encoding=encoding, 
+        edition=edition, 
+        timeout=timeout, 
+        waitTimeout=waitTimeout, 
+        maxLifetimeSession=maxLifetimeSession, 
+        sessionCallback=sessionCallback, 
+        maxSessionsPerShard=maxSessionsPerShard)
     pool = AsyncPoolWrapper(pool)
     await pool.preexciting()
     return pool
diff --git a/tests/test_behavior.py b/tests/test_behavior.py
@@ -0,0 +1,58 @@
+import os , sys
+sys.path.append(os.getcwd())
+import pytest
+import asyncio
+from cx_Oracle_async import *
+
+@pytest.mark.asyncio
+async def test_new_table():
+    dsn = makedsn(
+        host = 'localhost', 
+        port = '1521', 
+        sid = 'xe'
+    )
+    oracle_pool = await create_pool(
+        user = 'system',
+        password = 'oracle',
+        dsn = dsn
+    )
+    
+    async with oracle_pool.acquire() as connection:
+        async with connection.cursor() as cursor:
+            # check if dept exesits
+            await cursor.execute("SELECT COUNT(*) FROM USER_TABLES WHERE TABLE_NAME = UPPER(:a)" , ('DEPT' , ))
+            ret = await cursor.fetchone()
+            assert ret 
+            if ret[0] > 0:
+                await cursor.execute("DTOP TABLE DEPT")
+
+            sql = f"""
+                CREATE TABLE DEPT
+                   (DEPTNO NUMBER(2) CONSTRAINT PK_DEPT PRIMARY KEY,
+                    DNAME VARCHAR2(14),
+                    LOC VARCHAR2(13) 
+                )
+            """
+            await cursor.execute(sql)
+
+            # Single Insertion 
+            sql = "INSERT INTO DEPT(DEPTNO , DNAME , LOC) VALUES (:a , :b , :c)"
+            await cursor.execute(sql , (10 ,'ACCOUNTING','NEW YORK'))
+            await connection.commit()
+
+            # Multiple Insertion
+            data = [
+                (30,'SALES','CHICAGO'),
+                (40,'OPERATIONS','BOSTON'),
+            ]
+            await cursor.executemany(sql , data)
+            await connection.commit()
+
+            # Check
+            await cursor.execute("SELECT DNAME , LOC FROM DEPT WHERE DEPTNO BETWEEN :a AND :b" , (10 , 30))
+            ret = await cursor.fetchall()
+            assert len(ret) == 2
+            assert ret[0][0] == 'ACCOUNTING'
+            assert ret[1][1] == 'CHICAGO'
+
+    await oracle_pool.close()
diff --git a/tests/test_connection.py b/tests/test_connection.py
@@ -0,0 +1,38 @@
+import os , sys
+sys.path.append(os.getcwd())
+import pytest
+import asyncio
+from cx_Oracle_async import *
+
+@pytest.mark.asyncio
+async def test_different_connect_ways():
+    dsn = makedsn(
+        host = 'localhost', 
+        port = '1521', 
+        sid = 'xe'
+    )
+    oracle_pool = await create_pool(
+        user = 'system',
+        password = 'oracle',
+        dsn = dsn
+    )
+    ret = await oracle_pool.close()
+    assert ret == None
+
+    oracle_pool = await create_pool(
+        host = 'localhost',
+        port = '1521',
+        user = 'system',
+        password = 'oracle',
+        sid = 'xe',
+        min = 2 ,
+        max = 4
+    )
+
+    async with oracle_pool.acquire() as connection:
+        async with connection.cursor() as cursor:
+            pass
+
+    ret = await oracle_pool.close()
+    assert ret == None
+    

Original file line number	Diff line number	Diff line change
`@@ -1,7 +1,8 @@`
`1`	`1`	`__version__ = ''`
`2`	`2`
`3`		`-from .utils import create_pool`
	`3`	`+from .utils import create_pool , makedsn`
`4`	`4`
`5`	`5`	`__all__ = (`
`6`	`6`	`'create_pool',`
	`7`	`+ 'makedsn'`
`7`	`8`	`)`