support for both psycopg2 and 3 (#32)

* support for both psycopg2 and 3

* fix

* more imports

* monkey patch

* update PG versions

* adapt README

.github/workflows/test.yml

@@ -17,7 +17,8 @@ jobs:
 
     strategy:
       matrix:
-        pg-version: ['9.6', '10', '11']
+        psycopg-version: [2, 3]
+        pg-version: [12, 13, 14, 15, 16]
       fail-fast: true
 
     # Service containers to run with `runner-job`
@@ -59,9 +60,10 @@ jobs:
         run: |
           pip install -r requirements.txt
           pip install -r requirements-test.txt
+          pip install -r requirements-psycopg${{ matrix.psycopg-version }}.txt
 
       - name: Install pirogue
-        run: python -m pip install -e .
+        run: python -m pip install -e .[psycopg${{ matrix.psycopg-version }}]
 
       - name: Setup tests
         run: |

.gitignore

@@ -7,3 +7,4 @@ __pycache__/
 *.egg-info
 .idea
 .DS_Store
+*.orig

README.md

@@ -1,4 +1,6 @@
 # pirogue
 A tool to automatically create views and triggers on PostgreSQL databases
 
+It supports both psycopg 2 and 3. One or the other is required.
+
 Read the docs: https://opengisch.github.io/pirogue

pirogue/information_schema.py

@@ -1,4 +1,7 @@
-from psycopg import Cursor
+try:
+    from psycopg import Cursor
+except ImportError:
+    from psycopg2.extensions import cursor as Cursor
 
 from pirogue.exceptions import (
     InvalidSkipColumns,

pirogue/multiple_inheritance.py

@@ -1,6 +1,12 @@
 import os
 
-import psycopg
+try:
+    import psycopg
+except ImportError:
+    import psycopg2 as psycopg
+    import psycopg2.sql as __sql
+
+    psycopg.sql = __sql
 
 from pirogue.exceptions import InvalidDefinition, TableHasNoPrimaryKey, VariableError
 from pirogue.information_schema import (

pirogue/simple_joins.py

@@ -1,6 +1,9 @@
 import os
 
-import psycopg
+try:
+    import psycopg
+except ImportError:
+    import psycopg2 as psycopg
 
 from pirogue.exceptions import InvalidDefinition, NoReferenceFound, TableHasNoPrimaryKey
 from pirogue.information_schema import primary_key, reference_columns

pirogue/single_inheritance.py

@@ -1,6 +1,9 @@
 import os
 
-import psycopg
+try:
+    import psycopg
+except ImportError:
+    import psycopg2 as psycopg
 
 from pirogue.exceptions import TableHasNoPrimaryKey
 from pirogue.information_schema import default_value, primary_key, reference_columns

pirogue/utils.py

@@ -1,4 +1,7 @@
-from psycopg import Cursor
+try:
+    from psycopg import Cursor
+except ImportError:
+    from psycopg2.extensions import cursor as Cursor
 
 from pirogue.exceptions import InvalidColumn, TableHasNoPrimaryKey
 from pirogue.information_schema import columns, default_value, primary_key

pyproject.toml

@@ -36,6 +36,8 @@ enabled = true
 readme = {file = ["README.md"], content-type = "text/markdown"}
 dependencies = {file = ["requirements.txt"]}
 optional-dependencies.test = {file = ["requirements-test.txt"]}
+optional-dependencies.psycopg2 = {file = ["requirements-psycopg2.txt"]}
+optional-dependencies.psycopg3 = {file = ["requirements-psycopg3.txt"]}
 
 [tool.isort]
 profile = "black"

requirements-psycopg2.txt

@@ -0,0 +1 @@
+psycopg2>=2.9.9

requirements-psycopg3.txt

@@ -0,0 +1 @@
+psycopg>=3.1.18

requirements.txt

@@ -1,2 +1 @@
 pyyaml>=6.0.1
-psycopg>=3.1.18

test/test_multiple_inheritance.py

@@ -2,7 +2,11 @@
 
 import unittest
 
-import psycopg
+try:
+    import psycopg
+except ImportError:
+    import psycopg2 as psycopg
+
 import yaml
 
 from pirogue import MultipleInheritance

test/test_simple_joins.py

@@ -2,7 +2,11 @@
 
 import unittest
 
-import psycopg
+try:
+    import psycopg
+except ImportError:
+    import psycopg2 as psycopg
+
 import yaml
 
 from pirogue import MultipleInheritance, SimpleJoins