Merge branch 'develop' of github.com:tortoise/tortoise-orm into replace-pytz

Author: waketzheng

.github/workflows/ci.yml

@@ -45,7 +45,7 @@ jobs:
       TORTOISE_MSSQL_DRIVER: ODBC Driver 18 for SQL Server
     strategy:
       matrix:
-        python-version: ["3.9", "3.10", "3.11", "3.12", "3.13", "3.14"]
+        python-version: ["3.10", "3.11", "3.12", "3.13", "3.14"]
     steps:
       - uses: actions/cache@v5
         with:
@@ -77,6 +77,11 @@ jobs:
           DEST_SANIC: examples/sanic
           PYTHONDEVMODE: 1
           PYTEST_ARGS: "-n auto --cov=tortoise --cov-append --cov-branch --tb=native -q"
+      - name: Test No typing-extensions
+        if: matrix.python-version == 'py3.11'
+        run: |
+          uv pip uninstall typing-extensions
+          uv run --no-sync python examples/basic.py
       - name: Upload Coverage
         run: |
           uvx coveralls --service=github

.github/workflows/gh-pages-release.yml

@@ -10,7 +10,7 @@ jobs:
       - uses: actions/checkout@v6
       - uses: actions/setup-python@v6
         with:
-          python-version: "3.9"
+          python-version: "3.10"
       - uses: astral-sh/setup-uv@v7
       - name: Build docs
         run: make docs

.github/workflows/gh-pages.yml

@@ -11,7 +11,7 @@ jobs:
       - uses: actions/checkout@v6
       - uses: actions/setup-python@v6
         with:
-          python-version: "3.9"
+          python-version: "3.10"
       - uses: astral-sh/setup-uv@v7
       - name: Build docs
         run: make docs

.github/workflows/pypi.yml

@@ -10,7 +10,7 @@ jobs:
       - uses: actions/checkout@v6
       - uses: actions/setup-python@v6
         with:
-          python-version: '3.9'
+          python-version: '3.10'
       - uses: astral-sh/setup-uv@v7
       - name: Build dists
         run: make build

CHANGELOG.rst

@@ -12,6 +12,15 @@ Changelog
 
 0.26.0 (unreleased)
 -------------------
+Fixed
+^^^^^
+- Fix ``AttributeError`` when using ``tortoise-orm`` with Nuitka-compiled Python code (#2053)
+- Fix 'Self' in python standard library typing.py, but tortoise/model.py required it in 'typing_extensions' (#2051)
+- Fix annotations being selected in ValuesListQuery despite not specified in `.values_list` fields list (#2059)
+
+Changed
+^^^^^
+- feat: foreignkey to model type (#2027)
 
 0.25
 ====

CONTRIBUTORS.rst

@@ -66,6 +66,7 @@ Contributors
 * Frederic Aoustin ``@fraoustin``
 * Ludwig Hähne ``@pankrat``
 * Christian Tanul ``@scriptogre``
+* Qian Chen ``@shkey``
 
 Special Thanks
 ==============

README.rst

@@ -12,8 +12,6 @@ Tortoise ORM
    :target: https://github.com/tortoise/tortoise-orm/actions?query=workflow:ci
 .. image:: https://coveralls.io/repos/github/tortoise/tortoise-orm/badge.svg
    :target: https://coveralls.io/github/tortoise/tortoise-orm
-.. image:: https://app.codacy.com/project/badge/Grade/844030d0cb8240d6af92c71bfac764ff
-   :target: https://www.codacy.com/gh/tortoise/tortoise-orm/dashboard?utm_source=github.com&utm_medium=referral&utm_content=tortoise/tortoise-orm&utm_campaign=Badge_Grade
 
 Introduction
 ============
@@ -26,7 +24,7 @@ You can find the docs at `Documentation <https://tortoise.github.io>`_
    Tortoise ORM is a young project and breaking changes are to be expected.
    We keep a `Changelog <https://tortoise.github.io/CHANGELOG.html>`_ and it will have possible breakage clearly documented.
 
-Tortoise ORM supports CPython 3.9 and later for SQLite, MySQL, PostgreSQL, Microsoft SQL Server, and Oracle.
+Tortoise ORM supports CPython 3.10 and later for SQLite, MySQL, PostgreSQL, Microsoft SQL Server, and Oracle.
 
 Why was Tortoise ORM built?
 ---------------------------
@@ -108,7 +106,8 @@ Define the models by inheriting from ``tortoise.models.Model``.
 
 After defining the models, Tortoise ORM needs to be initialized to establish the relationships between models and connect to the database.
 The code below creates a connection to a SQLite DB database with the ``aiosqlite`` client. ``generate_schema`` sets up schema on an empty database.
-``generate_schema`` is for development purposes only, check out ``aerich`` or other migration tools for production use.
+``generate_schema`` is for development purposes only; use the built-in
+migrations for production use.
 
 .. code-block:: python3
 
@@ -189,10 +188,12 @@ With the Tortoise initialized, the models are available for use:
 Learn more at the `documentation site <https://tortoise.github.io>`_
 
 
-Migration
-=========
+Migrations
+==========
 
-Tortoise ORM uses `Aerich <https://github.com/tortoise/aerich>`_ as its database migration tool, see more detail at its `docs <https://github.com/tortoise/aerich>`_.
+Tortoise ORM ships with built-in migrations and a CLI. See the
+`migrations documentation <https://tortoise.github.io/migration.html>`_ for
+setup, commands, and examples.
 
 Contributing
 ============

docs/CONTRIBUTING.rst

@@ -93,7 +93,7 @@ Tortoise ORM follows a the following agreed upon style:
 * Always try to separate out terms clearly rather than concatenate words directly:
     * ``some_purpose`` instead of ``somepurpose``
     * ``SomePurpose`` instead of ``Somepurpose``
-* Keep in mind the targeted Python versions of ``>=3.9``:
+* Keep in mind the targeted Python versions of ``>=3.10``:
     * Do use f-strings
 * Please try and provide type annotations where you can, it will improve auto-completion in editors, and better static analysis.
 

docs/cli.rst

@@ -1,65 +1,130 @@
 .. _cli:
 
 ===========
-TortoiseCLI
+Tortoise CLI
 ===========
 
-This document describes how to use `tortoise-cli`, a cli tool for tortoise-orm, build on top of click and ptpython.
+This page documents the built-in CLI for schema migrations and interactive use.
 
-You can see `https://github.com/tortoise/tortoise-cli <https://github.com/tortoise/tortoise-cli>`_ for more details.
+Overview
+========
 
+The CLI resolves configuration from ``-c/--config``, ``--config-file``, or
+``[tool.tortoise]`` in ``pyproject.toml``. Migration commands mirror the
+runtime API while adding plan/history output.
 
-Quick Start
+Basic usage
 ===========
 
 .. code-block:: shell
 
-    > tortoise-cli -h                                                                                                                                                                 23:59:38
-    Usage: tortoise-cli [OPTIONS] COMMAND [ARGS]...
+    tortoise -h
+    tortoise -c settings.TORTOISE_ORM init
+    tortoise makemigrations
+    tortoise migrate
 
-    Options:
-      -V, --version      Show the version and exit.
-      -c, --config TEXT  TortoiseORM config dictionary path, like settings.TORTOISE_ORM
-      -h, --help         Show this message and exit.
+Configuration resolution
+========================
 
-    Commands:
-      shell  Start an interactive shell.
+You can supply configuration in one of these ways:
 
-Usage
-=====
+- ``-c/--config`` with a dotted path to a config object
+  (for example ``settings.TORTOISE_ORM``).
+- ``--config-file`` with a JSON/YAML config file path.
+- ``pyproject.toml`` with ``[tool.tortoise]`` and a ``tortoise_orm`` key.
 
-First, you need make a TortoiseORM config object, assuming that in `settings.py`.
+Commands
+========
+
+init
+----
+
+Create migrations packages for configured apps. This ensures each app has a
+``migrations`` module and the package is importable.
+
+.. code-block:: shell
+
+    tortoise init
+    tortoise init users billing
+
+makemigrations
+--------------
+
+Autodetect model changes and create new migration files.
 
 .. code-block:: shell
 
-    TORTOISE_ORM = {
-        "connections": {
-            "default": "sqlite://:memory:",
-        },
-        "apps": {
-            "models": {"models": ["examples.models"], "default_connection": "default"},
-        },
-    }
+    tortoise makemigrations
+    tortoise makemigrations --name add_posts_table
+    tortoise makemigrations users
+    tortoise makemigrations --empty users
+
+migrate / upgrade
+-----------------
+
+Apply migrations. ``migrate`` can move forward or backward depending on the
+target. ``upgrade`` is forward-only and will refuse to roll back.
 
+.. code-block:: shell
+
+    tortoise migrate
+    tortoise migrate users
+    tortoise migrate users 0002_add_field
+    tortoise migrate users.0002_add_field
 
-Interactive shell
-=================
+downgrade
+---------
 
-Then you can start an interactive shell for TortoiseORM.
+Unapply migrations for a specific app. ``downgrade`` is backward-only and will
+refuse to apply forward migrations. If no migration name is provided, it
+targets the first migration for that app.
 
 .. code-block:: shell
 
-    tortoise-cli -c settings.TORTOISE_ORM shell
+    tortoise downgrade users
+    tortoise downgrade users 0001_initial
 
+history
+-------
 
-Or you can set config by set environment variable.
+List applied migrations from the database.
 
 .. code-block:: shell
 
-    export TORTOISE_ORM=settings.TORTOISE_ORM
+    tortoise history
+    tortoise history users
+
+heads
+-----
+
+List migration heads on disk.
+
+.. code-block:: shell
+
+    tortoise heads
+    tortoise heads users
+
+shell
+-----
+
+Start an interactive shell with Tortoise initialized.
+
+.. code-block:: shell
+
+    tortoise shell
+
+Target shorthand
+================
+
+The migration commands accept Django-style targets:
 
-Then just run:
+- ``APP_LABEL`` means "latest" for that app.
+- ``APP_LABEL MIGRATION`` targets a specific migration name.
+- ``APP_LABEL.MIGRATION`` is equivalent to ``APP_LABEL MIGRATION`` and is
+  convenient for copy/paste from history output.
 
 .. code-block:: shell
 
-    tortoise-cli shell
+    tortoise migrate users.__latest__
+    tortoise migrate users 0003_add_index
+    tortoise downgrade users.__first__

docs/conf.py

@@ -1,4 +1,3 @@
-# -*- coding: utf-8 -*-
 #
 # Configuration file for the Sphinx documentation builder.
 #
@@ -182,10 +181,10 @@ def get_version_info():
 
 # The name for this set of Sphinx documents.  If None, it defaults to
 # "<project> v<release> documentation".
-html_title = "%s v%s Documentation" % (project, release)
+html_title = f"{project} v{release} Documentation"
 
 # A shorter title for the navigation bar.  Default is the same as html_title.
-html_short_title = "%s %s Documentation" % (project, version)
+html_short_title = f"{project} {version} Documentation"
 
 # The name of an image file (relative to this directory) to place at the top
 # of the sidebar.