sqlacodegen 2.3.0__tar.gz → 3.0.0__tar.gz

sqlacodegen-3.0.0/.github/ISSUE_TEMPLATE/bug_report.yaml

@@ -0,0 +1,66 @@
+name: Bug Report
+description: File a bug report
+labels: ["bug"]
+body:
+  - type: markdown
+    attributes:
+      value: >
+        If you observed a crash in the project, or saw unexpected behavior in it, report
+        your findings here.
+  - type: checkboxes
+    attributes:
+      label: Things to check first
+      options:
+        - label: >
+            I have searched the existing issues and didn't find my bug already reported
+            there
+          required: true
+        - label: >
+            I have checked that my bug is still present in the latest release
+          required: true
+  - type: input
+    id: project-version
+    attributes:
+      label: Sqlacodegen version
+      description: What version of Sqlacodegen were you running?
+    validations:
+      required: true
+  - type: input
+    id: sqlalchemy-version
+    attributes:
+      label: SQLAlchemy version
+      description: What version of SQLAlchemy were you running?
+    validations:
+      required: true
+  - type: dropdown
+    id: rdbms
+    attributes:
+      label: RDBMS vendor
+      description: >
+        What RDBMS (relational database management system) did you run the tool against?
+      options:
+        - PostgreSQL
+        - MySQL (or compatible)
+        - SQLite
+        - MSSQL
+        - Oracle
+        - DB2
+        - Other
+        - N/A
+    validations:
+      required: true
+  - type: textarea
+    id: what-happened
+    attributes:
+      label: What happened?
+      description: >
+        Unless you are reporting a crash, tell us what you expected to happen instead.
+    validations:
+      required: true
+  - type: textarea
+    id: schema
+    attributes:
+      label: Database schema for reproducing the bug
+      description: >
+        If applicable, paste the database schema (as a series of `CREATE TABLE` and
+        other SQL commands) here.

sqlacodegen-3.0.0/.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1 @@
+blank_issues_enabled: false

sqlacodegen-3.0.0/.github/ISSUE_TEMPLATE/features_request.yaml

@@ -0,0 +1,35 @@
+name: Feature request
+description: Suggest a new feature
+labels: ["enhancement"]
+body:
+  - type: markdown
+    attributes:
+      value: >
+        If you have thought of a new feature that would increase the usefulness of this
+        project, please use this form to send us your idea.
+  - type: checkboxes
+    attributes:
+      label: Things to check first
+      options:
+        - label: >
+            I have searched the existing issues and didn't find my feature already
+            requested there
+          required: true
+  - type: textarea
+    id: feature
+    attributes:
+      label: Feature description
+      description: >
+        Describe the feature in detail. The more specific the description you can give,
+        the easier it should be to implement this feature.
+    validations:
+      required: true
+  - type: textarea
+    id: usecase
+    attributes:
+      label: Use case
+      description: >
+        Explain why you need this feature, and why you think it would be useful to
+        others too.
+    validations:
+      required: true

sqlacodegen-3.0.0/.github/workflows/publish.yml

@@ -0,0 +1,59 @@
+name: Publish packages to PyPI
+
+on:
+  push:
+    tags:
+      - "[0-9]+.[0-9]+.[0-9]+"
+      - "[0-9]+.[0-9]+.[0-9]+.post[0-9]+"
+      - "[0-9]+.[0-9]+.[0-9]+[a-b][0-9]+"
+      - "[0-9]+.[0-9]+.[0-9]+rc[0-9]+"
+
+jobs:
+  build:
+    name: Build the source tarball and the wheel
+    runs-on: ubuntu-latest
+    environment: release
+    steps:
+    - uses: actions/checkout@v4
+    - name: Set up Python
+      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@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@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 }}

sqlacodegen-3.0.0/.github/workflows/test.yml

@@ -0,0 +1,41 @@
+name: test suite
+
+on:
+  push:
+    branches: [master]
+  pull_request:
+
+jobs:
+  test:
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.9", "3.10", "3.11", "3.12", "3.13"]
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v4
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v5
+      with:
+        python-version: ${{ matrix.python-version }}
+        allow-prereleases: true
+        cache: pip
+        cache-dependency-path: pyproject.toml
+    - name: Install dependencies
+      run: pip install -e .[test]
+    - name: Test with pytest
+      run: coverage run -m pytest
+    - name: Upload Coverage
+      uses: coverallsapp/github-action@v2
+      with:
+        parallel: true
+
+  coveralls:
+    name: Finish Coveralls
+    needs: test
+    runs-on: ubuntu-latest
+    steps:
+    - name: Finished
+      uses: coverallsapp/github-action@v2
+      with:
+        parallel-finished: true

{sqlacodegen-2.3.0 → sqlacodegen-3.0.0}/.gitignore

@@ -9,5 +9,7 @@
 .vscode
 .cache
 .pytest_cache
+.mypy_cache
 dist
 build
+venv*

sqlacodegen-3.0.0/.pre-commit-config.yaml

@@ -0,0 +1,38 @@
+# This is the configuration file for pre-commit (https://pre-commit.com/).
+# To use:
+# * Install pre-commit (https://pre-commit.com/#installation)
+# * Copy this file as ".pre-commit-config.yaml"
+# * Run "pre-commit install".
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v5.0.0
+    hooks:
+      - id: check-toml
+      - id: check-yaml
+      - id: debug-statements
+      - id: end-of-file-fixer
+      - id: mixed-line-ending
+        args: [ "--fix=lf" ]
+      - id: trailing-whitespace
+
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.9.7
+    hooks:
+      - id: ruff
+        args: [--fix, --show-fixes]
+      - id: ruff-format
+
+  - repo: https://github.com/pre-commit/mirrors-mypy
+    rev: v1.15.0
+    hooks:
+      - id: mypy
+        additional_dependencies:
+          - pytest
+          - "sqlalchemy[mypy] < 2.0"
+
+  - repo: https://github.com/pre-commit/pygrep-hooks
+    rev: v1.10.0
+    hooks:
+    - id: rst-backticks
+    - id: rst-directive-colons
+    - id: rst-inline-touching-normal

sqlacodegen-3.0.0/CHANGES.rst

@@ -0,0 +1,201 @@
+Version history
+===============
+
+**3.0.0**
+
+- Dropped support for Python 3.8
+- Changed nullable relationships to include ``Optional`` in their type annotations
+- Fixed SQLModel code generation
+- Fixed two rendering issues in ``ENUM`` columns when a non-default schema is used: an
+  unwarranted positional argument and missing the ``schema`` argument
+- Fixed ``AttributeError`` when metadata contains user defined column types
+- Fixed ``AssertionError`` when metadata contains a column type that is a type decorator
+  with an all-uppercase name
+- Fixed MySQL ``DOUBLE`` column types being rendered with the wrong arguments
+
+**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)
+- Renamed ``--option`` to ``--options`` and made its values delimited by commas
+- Restored CIText and GeoAlchemy2 support (PR by stavvy-rotte)
+
+**3.0.0rc2**
+
+- Added support for generating SQLModel classes (PR by Andrii Khirilov)
+- Fixed code generation when a single-column index is unique or does not match the
+  dialect's naming convention (PR by Leonardus Chen)
+- Fixed another problem where sequence schemas were not properly separated from the
+  sequence name
+- Fixed invalid generated primary/secondaryjoin expressions in self-referential
+  many-to-many relationships by using lambdas instead of strings
+- Fixed ``AttributeError`` when the declarative generator encounters a table name
+  already in singular form when ``--option use_inflect`` is enabled
+- Increased minimum SQLAlchemy version to 1.4.36 to address issues with ``ForeignKey``
+  and indexes, and to eliminate the PostgreSQL UUID column type annotation hack
+
+**3.0.0rc1**
+
+- Migrated all packaging/testing configuration to ``pyproject.toml``
+- Fixed unwarranted ``ForeignKey`` declarations appearing in column attributes when
+  there are named, single column foreign key constraints (PR by Leonardus Chen)
+. Fixed ``KeyError`` when rendering an index without any columns
+- Fixed improper handling of schema prefixes in sequence names in server defaults
+- Fixed identically named tables from different schemas resulting in invalid generated
+  code
+- Fixed imports caused by ``server_default`` conflicting with class attribute names
+- Worked around PostgreSQL UUID columns getting ``Any`` as the type annotation
+
+**3.0.0b3**
+
+- Dropped support for Python < 3.7
+- Dropped support for SQLAlchemy 1.3
+- Added a ``__main__`` module which can be used as an alternate entry point to the CLI
+- Added detection for sequence use in column defaults on PostgreSQL
+- Fixed ``sqlalchemy.exc.InvalidRequestError`` when encountering a column named
+  "metadata" (regression from 2.0)
+- Fixed missing ``MetaData`` import with ``DeclarativeGenerator`` when only plain tables
+  are generated
+- Fixed invalid data classes being generated due to some relationships having been
+  rendered without a default value
+- Improved translation of column names into column attributes where the column name has
+  whitespace at the beginning or end
+- Modified constraint and index rendering to add them explicitly instead of using
+  shortcuts like ``unique=True``, ``index=True`` or ``primary=True`` when the constraint
+  or index has a name that does not match the default naming convention
+
+**3.0.0b2**
+
+- Fixed ``IDENTITY`` columns not rendering properly when they are part of the primary
+  key
+
+**3.0.0b1**
+
+**NOTE**: Both the API and the command line interface have been refactored in a
+backwards incompatible fashion. Notably several command line options have been moved to
+specific generators and are no longer visible from ``sqlacodegen --help``. Their
+replacement are documented in the README.
+
+- Dropped support for Python < 3.6
+- Added support for Python 3.10
+- Added support for SQLAlchemy 1.4
+- Added support for bidirectional relationships (use ``--option nobidi``) to disable
+- Added support for multiple schemas via ``--schemas``
+- Added support for ``IDENTITY`` columns
+- Disabled inflection during table/relationship name generation by default
+  (use ``--option use_inflect`` to re-enable)
+- Refactored the old ``CodeGenerator`` class into separate generator classes, selectable
+  via ``--generator``
+- Refactored several command line options into generator specific options:
+
+  - ``--noindexes`` → ``--option noindexes``
+  - ``--noconstraints`` → ``--option noconstraints``
+  - ``--nocomments`` → ``--option nocomments``
+  - ``--nojoined`` → ``--option nojoined`` (``declarative`` and ``dataclass`` generators
+    only)
+  - ``--noinflect`` → (now the default; use ``--option use_inflect`` instead)
+    (``declarative`` and ``dataclass`` generators only)
+- Fixed missing import for ``JSONB`` ``astext_type`` argument
+- Fixed generated column or relationship names colliding with imports or each other
+- Fixed ``CompileError`` when encountering server defaults that contain colons (``:``)
+
+**2.3.0**
+
+- Added support for rendering computed columns
+- Fixed ``--nocomments`` not taking effect (fix proposed by AzuresYang)
+- Fixed handling of MySQL ``SET`` column types (and possibly others as well)
+
+**2.2.0**
+
+- Added support for rendering table comments (PR by David Hirschfeld)
+- Fixed bad identifier names being generated for plain tables (PR by softwarepk)
+
+**2.1.0**
+
+- Dropped support for Python 3.4
+- Dropped support for SQLAlchemy 0.8
+- Added support for Python 3.7 and 3.8
+- Added support for SQLAlchemy 1.3
+- Added support for column comments (requires SQLAlchemy 1.2+; based on PR by koalas8)
+- Fixed crash on unknown column types (``NullType``)
+
+**2.0.1**
+
+- Don't adapt dialect specific column types if they need special constructor arguments
+  (thanks Nicholas Martin for the PR)
+
+**2.0.0**
+
+- Refactored code for better reuse
+- Dropped support for Python 2.6, 3.2 and 3.3
+- Dropped support for SQLAlchemy < 0.8
+- Worked around a bug regarding Enum on SQLAlchemy 1.2+ (``name`` was missing)
+- Added support for Geoalchemy2
+- Fixed invalid class names being generated (fixes #60; PR by Dan O'Huiginn)
+- Fixed array item types not being adapted or imported
+  (fixes #46; thanks to Martin Glauer and Shawn Koschik for help)
+- Fixed attribute name of columns named ``metadata`` in mapped classes (fixes #62)
+- Fixed rendered column types being changed from the original (fixes #11)
+- Fixed server defaults which contain double quotes (fixes #7, #17, #28, #33, #36)
+- Fixed ``secondary=`` not taking into account the association table's schema name
+  (fixes #30)
+- Sort models by foreign key dependencies instead of schema and name (fixes #15, #16)
+
+**1.1.6**
+
+- Fixed compatibility with SQLAlchemy 1.0
+- Added an option to only generate tables
+
+**1.1.5**
+
+- Fixed potential assignment of columns or relationships into invalid attribute names
+  (fixes #10)
+- Fixed unique=True missing from unique Index declarations
+- Fixed several issues with server defaults
+- Fixed potential assignment of columns or relationships into invalid attribute names
+- Allowed pascal case for tables already using it
+- Switched from Mercurial to Git
+
+**1.1.4**
+
+- Fixed compatibility with SQLAlchemy 0.9.0
+
+**1.1.3**
+
+- Fixed compatibility with SQLAlchemy 0.8.3+
+- Migrated tests from nose to pytest
+
+**1.1.2**
+
+- Fixed non-default schema name not being present in __table_args__ (fixes #2)
+- Fixed self referential foreign key causing column type to not be rendered
+- Fixed missing "deferrable" and "initially" keyword arguments in ForeignKey constructs
+- Fixed foreign key and check constraint handling with alternate schemas (fixes #3)
+
+**1.1.1**
+
+- Fixed TypeError when inflect could not determine the singular name of a table for a
+  many-to-1 relationship
+- Fixed _IntegerType, _StringType etc. being rendered instead of proper types on MySQL
+
+**1.1.0**
+
+- Added automatic detection of joined-table inheritance
+- Fixed missing class name prefix in primary/secondary joins in relationships
+- Instead of wildcard imports, generate explicit imports dynamically (fixes #1)
+- Use the inflect library to produce better guesses for table to class name conversion
+- Automatically detect Boolean columns based on CheckConstraints
+- Skip redundant CheckConstraints for Enum and Boolean columns
+
+**1.0.0**
+
+- Initial release

sqlacodegen-3.0.0/CONTRIBUTING.rst

@@ -0,0 +1,47 @@
+Contributing to sqlacodegen
+===========================
+
+If you wish to contribute a fix or feature to sqlacodegen, please follow the following
+guidelines.
+
+When you make a pull request against the main sqlacodegen codebase, Github runs the
+sqlacodegen test suite against your modified code. Before making a pull request, you
+should ensure that the modified code passes tests locally. To that end, the use of tox_
+is recommended. The default tox run first runs ``pre-commit`` and then the actual test
+suite. To run the checks on all environments in parallel, invoke tox with ``tox -p``.
+
+To build the documentation, run ``tox -e docs`` which will generate a directory named
+``build`` in which you may view the formatted HTML documentation.
+
+sqlacodegen uses pre-commit_ to perform several code style/quality checks. It is
+recommended to activate pre-commit_ on your local clone of the repository (using
+``pre-commit install``) to ensure that your changes will pass the same checks on GitHub.
+
+.. _tox: https://tox.readthedocs.io/en/latest/install.html
+.. _pre-commit: https://pre-commit.com/#installation
+
+Making a pull request on Github
+-------------------------------
+
+To get your changes merged to the main codebase, you need a Github account.
+
+#. Fork the repository (if you don't have your own fork of it yet) by navigating to the
+   `main sqlacodegen repository`_ and clicking on "Fork" near the top right corner.
+#. Clone the forked repository to your local machine with
+   ``git clone git@github.com/yourusername/sqlacodegen``.
+#. Create a branch for your pull request, like ``git checkout -b myfixname``
+#. Make the desired changes to the code base.
+#. Commit your changes locally. If your changes close an existing issue, add the text
+   ``Fixes #XXX.`` or ``Closes #XXX.`` to the commit message (where XXX is the issue
+   number).
+#. Push the changeset(s) to your forked repository (``git push``)
+#. Navigate to Pull requests page on the original repository (not your fork) and click
+   "New pull request"
+#. Click on the text "compare across forks".
+#. Select your own fork as the head repository and then select the correct branch name.
+#. Click on "Create pull request".
+
+If you have trouble, consult the `pull request making guide`_ on opensource.com.
+
+.. _main sqlacodegen repository: https://github.com/agronholm/sqlacodegen
+.. _pull request making guide: https://opensource.com/article/19/7/create-pull-request-github