Merge branch 'master' into render_column_type

Author: agronholm

.github/workflows/publish.yml

@@ -10,32 +10,50 @@ on:
 
 jobs:
   build:
+    name: Build the source tarball and the wheel
     runs-on: ubuntu-latest
     environment: release
     steps:
-    - uses: actions/checkout@v3
+    - uses: actions/checkout@v4
     - name: Set up Python
-      uses: actions/setup-python@v4
+      uses: actions/setup-python@v5
       with:
         python-version: 3.x
     - name: Install dependencies
       run: pip install build
     - name: Create packages
       run: python -m build
     - name: Archive packages
-      uses: actions/upload-artifact@v3
+      uses: actions/upload-artifact@v4
       with:
         name: dist
         path: dist
 
   publish:
+    name: Publish build artifacts to the PyPI
     needs: build
     runs-on: ubuntu-latest
     environment: release
     permissions:
       id-token: write
     steps:
     - name: Retrieve packages
-      uses: actions/download-artifact@v3
+      uses: actions/download-artifact@v4
     - name: Upload packages
       uses: pypa/gh-action-pypi-publish@release/v1
+
+  release:
+    name: Create a GitHub release
+    needs: build
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+    steps:
+    - uses: actions/checkout@v4
+    - id: changelog
+      uses: agronholm/release-notes@v1
+      with:
+        path: CHANGES.rst
+    - uses: ncipollo/release-action@v1
+      with:
+        body: ${{ steps.changelog.outputs.changelog }}

.github/workflows/test.yml

@@ -10,43 +10,32 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        python-version: ["3.7", "3.8", "3.9", "3.10", "3.11", "3.12"]
-        sqlalchemy-version: ["1.4", "2.0"]
+        python-version: ["3.9", "3.10", "3.11", "3.12", "3.13"]
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v3
+    - uses: actions/checkout@v4
     - name: Set up Python ${{ matrix.python-version }}
-      uses: actions/setup-python@v4
+      uses: actions/setup-python@v5
       with:
         python-version: ${{ matrix.python-version }}
         allow-prereleases: true
         cache: pip
         cache-dependency-path: pyproject.toml
-    - name: Install dependencies SQLAlchemy 1.4
-      if: matrix.sqlalchemy-version == 1.4
-      run: pip install -e .[test,sqlmodel] coveralls SQLAlchemy==1.4.*
-    - name: Install dependencies SQLAlchemy 2.0
-      if: matrix.sqlalchemy-version == 2.0
-      run: pip install -e .[test] coveralls SQLAlchemy==2.0.*
+    - name: Install dependencies
+      run: pip install -e .[test]
     - name: Test with pytest
       run: coverage run -m pytest
     - name: Upload Coverage
-      run: coveralls --service=github
-      env:
-        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-        COVERALLS_FLAG_NAME: ${{ matrix.test-name }}
-        COVERALLS_PARALLEL: true
-        SQLALCHEMY_WARN_20: "true"
+      uses: coverallsapp/github-action@v2
+      with:
+        parallel: true
 
   coveralls:
     name: Finish Coveralls
-    needs: [test]
+    needs: test
     runs-on: ubuntu-latest
-    container: python:3-slim
     steps:
     - name: Finished
-      run: |
-        pip install coveralls
-        coveralls --service=github --finish
-      env:
-        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+      uses: coverallsapp/github-action@v2
+      with:
+        parallel-finished: true

.pre-commit-config.yaml

@@ -5,7 +5,7 @@
 # * Run "pre-commit install".
 repos:
   - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v4.4.0
+    rev: v5.0.0
     hooks:
       - id: check-toml
       - id: check-yaml
@@ -16,18 +16,14 @@ repos:
       - id: trailing-whitespace
 
   - repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: v0.0.290
+    rev: v0.9.2
     hooks:
       - id: ruff
         args: [--fix, --show-fixes]
-
-  - repo: https://github.com/psf/black
-    rev: 23.9.1
-    hooks:
-      - id: black
+      - id: ruff-format
 
   - repo: https://github.com/pre-commit/mirrors-mypy
-    rev: v1.5.1
+    rev: v1.14.1
     hooks:
       - id: mypy
         additional_dependencies:

CHANGES.rst

@@ -1,6 +1,20 @@
 Version history
 ===============
 
+**UNRELEASED**
+
+- Dropped support for Python 3.8
+
+**3.0.0rc5**
+
+- Fixed pgvector support not working
+
+**3.0.0rc4**
+
+- Dropped support for Python 3.7
+- Dropped support for SQLAlchemy 1.x
+- Added support for the ``pgvector`` extension (with help from KellyRousselHoomano)
+
 **3.0.0rc3**
 
 - Added support for SQLAlchemy 2 (PR by rbuffat with help from mhauru)

README.rst

@@ -18,7 +18,7 @@ latest SQLAlchemy version).
 Features
 ========
 
-* Supports SQLAlchemy 1.4.x and 2
+* Supports SQLAlchemy 2.x
 * Produces declarative code that almost looks like it was hand written
 * Produces `PEP 8`_ compliant code
 * Accurately determines relationships, including many-to-many, one-to-one
@@ -45,6 +45,11 @@ To include support for the PostgreSQL ``GEOMETRY``, ``GEOGRAPHY``, and ``RASTER`
 (which should be considered as tested only under a few environments) specify the
 ``geoalchemy2`` extra:
 
+To include support for the PostgreSQL ``PGVECTOR`` extension type, specify the
+``pgvector`` extra::
+
+    pip install sqlacodegen[pgvector]
+
 .. code-block:: bash
 
     pip install sqlacodegen[geoalchemy2]
@@ -110,7 +115,7 @@ values must be delimited by commas, e.g. ``--options noconstraints,nobidi``):
 
   * all the options from ``declarative``
 
-* ``sqlmodel``
+* ``sqlmodels``
 
   * all the options from ``declarative``
 

pyproject.toml

@@ -21,18 +21,17 @@ classifiers = [
     "Topic :: Software Development :: Code Generators",
     "Programming Language :: Python",
     "Programming Language :: Python :: 3",
-    "Programming Language :: Python :: 3.7",
-    "Programming Language :: Python :: 3.8",
     "Programming Language :: Python :: 3.9",
     "Programming Language :: Python :: 3.10",
     "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
 ]
-requires-python = ">=3.7"
+requires-python = ">=3.9"
 dependencies = [
-    "SQLAlchemy >= 1.4.36",
+    "SQLAlchemy >= 2.0.23",
     "inflect >= 4.0.0",
     "importlib_metadata; python_version < '3.10'",
-    "greenlet >= 3.0.0a1; python_version >= '3.12'",
 ]
 dynamic = ["version"]
 
@@ -42,16 +41,16 @@ dynamic = ["version"]
 
 [project.optional-dependencies]
 test = [
-    "pytest",
-    "pytest-cov",
+    "sqlacodegen[sqlmodel]",
+    "pytest >= 7.4",
+    "coverage >= 7",
     "psycopg2-binary",
     "mysql-connector-python",
 ]
-sqlmodel = [
-    "sqlmodel",
-]
+sqlmodel = ["sqlmodel >= 0.0.22"]
 citext = ["sqlalchemy-citext >= 1.7.0"]
 geoalchemy2 = ["geoalchemy2 >= 0.11.1"]
+pgvector = ["pgvector >= 0.2.4"]
 
 [project.entry-points."sqlacodegen.generators"]
 tables = "sqlacodegen.generators:TablesGenerator"
@@ -67,22 +66,24 @@ version_scheme = "post-release"
 local_scheme = "dirty-tag"
 
 [tool.ruff]
-select = [
-    "E", "F", "W",  # default Flake8
+src = ["src"]
+
+[tool.ruff.lint]
+extend-select = [
     "I",            # isort
     "ISC",          # flake8-implicit-str-concat
     "PGH",          # pygrep-hooks
     "RUF100",       # unused noqa (yesqa)
     "UP",           # pyupgrade
+    "W",            # pycodestyle warnings
 ]
 src = ["src"]
 
 [tool.mypy]
 strict = true
-plugins = ["sqlalchemy.ext.mypy.plugin"]
 
 [tool.pytest.ini_options]
-addopts = "-rsx --tb=short"
+addopts = "-rsfE --tb=short"
 testpaths = ["tests"]
 
 [coverage.run]
@@ -93,15 +94,10 @@ relative_files = true
 show_missing = true
 
 [tool.tox]
-legacy_tox_ini = """
-[tox]
-envlist = py37, py38, py39, py310, py311, py312
+env_list = ["py39", "py310", "py311", "py312", "py313"]
 skip_missing_interpreters = true
-isolated_build = true
 
-[testenv]
-extras = test
-setenv =
-  SQLALCHEMY_WARN_20 = true
-commands = python -m pytest {posargs}
-"""
+[tool.tox.env_run_base]
+package = "editable"
+commands = [["python", "-m", "pytest", { replace = "posargs", extend = true }]]
+extras = ["test"]

src/sqlacodegen/cli.py

@@ -18,6 +18,11 @@
 except ImportError:
     geoalchemy2 = None
 
+try:
+    import pgvector.sqlalchemy
+except ImportError:
+    pgvector = None
+
 if sys.version_info < (3, 10):
     from importlib_metadata import entry_points, version
 else:
@@ -48,37 +53,55 @@ def main() -> None:
     parser.add_argument(
         "--tables", help="tables to process (comma-delimited, default: all)"
     )
-    parser.add_argument("--noviews", action="store_true", help="ignore views")
+    parser.add_argument(
+        "--noviews",
+        action="store_true",
+        help="ignore views (always true for sqlmodels generator)",
+    )
     parser.add_argument("--outfile", help="file to write output to (default: stdout)")
     args = parser.parse_args()
 
     if args.version:
         print(version("sqlacodegen"))
         return
+
     if not args.url:
         print("You must supply a url\n", file=sys.stderr)
         parser.print_help()
         return
 
     if citext:
-        print(f"Using sqlalchemy-citext {citext.__version__}")
+        print(f"Using sqlalchemy-citext {version('citext')}")
 
     if geoalchemy2:
-        print(f"Using geoalchemy2 {geoalchemy2.__version__}")
+        print(f"Using geoalchemy2 {version('geoalchemy2')}")
+
+    if pgvector:
+        print(f"Using pgvector {version('pgvector')}")
 
     # Use reflection to fill in the metadata
     engine = create_engine(args.url)
     metadata = MetaData()
     tables = args.tables.split(",") if args.tables else None
     schemas = args.schemas.split(",") if args.schemas else [None]
     options = set(args.options.split(",")) if args.options else set()
-    for schema in schemas:
-        metadata.reflect(engine, schema, not args.noviews, tables)
 
     # Instantiate the generator
     generator_class = generators[args.generator].load()
     generator = generator_class(metadata, engine, options)
 
+    if not generator.views_supported:
+        name = generator_class.__name__
+        print(
+            f"VIEW models will not be generated when using the '{name}' generator",
+            file=sys.stderr,
+        )
+
+    for schema in schemas:
+        metadata.reflect(
+            engine, schema, (generator.views_supported and not args.noviews), tables
+        )
+
     # Open the target file (if given)
     with ExitStack() as stack:
         outfile: TextIO