sqlmodel 0.0.39__tar.gz → 0.0.41__tar.gz

{sqlmodel-0.0.39 → sqlmodel-0.0.41}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: sqlmodel
-Version: 0.0.39
+Version: 0.0.41
 Summary: SQLModel, SQL databases in Python, designed for simplicity, compatibility, and robustness.
 Author-Email: =?utf-8?q?Sebasti=C3=A1n_Ram=C3=ADrez?= <tiangolo@gmail.com>
 License-Expression: MIT
@@ -97,18 +97,19 @@ As **SQLModel** is based on **Pydantic** and **SQLAlchemy**, it requires them. T
 
 ## Installation
 
-Make sure you create a [virtual environment](https://sqlmodel.tiangolo.com/virtual-environments/), activate it, and then install SQLModel, for example with:
+First, [install `uv`](https://docs.astral.sh/uv/getting-started/installation/), and then add SQLModel to your project:
 
 <div class="termy">
 
 ```console
-$ pip install sqlmodel
+$ uv add sqlmodel
 ---> 100%
-Successfully installed sqlmodel
 ```
 
 </div>
 
+If you prefer to use `pip`, install `sqlmodel` inside a virtual environment. See the [installation guide](install.md) for the alternative steps.
+
 ## Example
 
 For an introduction to databases, SQL, and everything else, see the [SQLModel documentation](https://sqlmodel.tiangolo.com/databases/).

{sqlmodel-0.0.39 → sqlmodel-0.0.41}/README.md

@@ -62,18 +62,19 @@ As **SQLModel** is based on **Pydantic** and **SQLAlchemy**, it requires them. T
 
 ## Installation
 
-Make sure you create a [virtual environment](https://sqlmodel.tiangolo.com/virtual-environments/), activate it, and then install SQLModel, for example with:
+First, [install `uv`](https://docs.astral.sh/uv/getting-started/installation/), and then add SQLModel to your project:
 
 <div class="termy">
 
 ```console
-$ pip install sqlmodel
+$ uv add sqlmodel
 ---> 100%
-Successfully installed sqlmodel
 ```
 
 </div>
 
+If you prefer to use `pip`, install `sqlmodel` inside a virtual environment. See the [installation guide](install.md) for the alternative steps.
+
 ## Example
 
 For an introduction to databases, SQL, and everything else, see the [SQLModel documentation](https://sqlmodel.tiangolo.com/databases/).

{sqlmodel-0.0.39 → sqlmodel-0.0.41}/docs_src/tutorial/fastapi/app_testing/tutorial001_py310/annotations/en/test_main_005.md

@@ -38,4 +38,4 @@
 
 6. Now in the dependency override function, we just return the same `session` object that came from outside it.
 
-    The `session` object comes from the parameter passed to the test function, and we just re-use it and return it here in the dependency override.
+    The `session` object comes from the parameter passed to the test function, and we just reuse it and return it here in the dependency override.

{sqlmodel-0.0.39 → sqlmodel-0.0.41}/pyproject.toml

@@ -41,7 +41,7 @@ dependencies = [
     "pydantic>=2.11.0",
     "typing-extensions>=4.5.0",
 ]
-version = "0.0.39"
+version = "0.0.41"
 
 [project.urls]
 Homepage = "https://github.com/fastapi/sqlmodel"
@@ -67,7 +67,7 @@ docs = [
     "mkdocstrings[python] >=1.0.3",
     "pillow >=12.1.1",
     "pyyaml >=5.3.1",
-    "typer >=0.24.1",
+    "typer >=0.26.1",
     "zensical>=0.0.42",
 ]
 github-actions = [
@@ -87,7 +87,7 @@ tests = [
     "pytest >=7.0.1",
     "ruff >=0.15.6",
     "ty>=0.0.25",
-    "typer >=0.24.1",
+    "typer >=0.26.1",
     "typing-extensions >=4.15.0",
 ]
 

{sqlmodel-0.0.39 → sqlmodel-0.0.41}/scripts/docs.py

@@ -99,13 +99,7 @@ def verify_readme() -> None:
 @app.command()
 def live(dirty: bool = False) -> None:
     """
-    Serve with livereload a docs site for a specific language.
-
-    This only shows the actual translated files, not the placeholders created with
-    build-all.
-
-    Takes an optional LANG argument with the name of the language to serve, by default
-    en.
+    Serve the docs site with livereload, at http://127.0.0.1:8008.
     """
     # Enable line numbers during local development to make it easier to highlight
     args = ["zensical", "serve", "--dev-addr", "127.0.0.1:8008"]

{sqlmodel-0.0.39 → sqlmodel-0.0.41}/sqlmodel/__init__.py

@@ -1,4 +1,4 @@
-__version__ = "0.0.39"
+__version__ = "0.0.41"
 
 # Re-export from SQLAlchemy
 from sqlalchemy.engine import create_engine as create_engine

{sqlmodel-0.0.39 → sqlmodel-0.0.41}/sqlmodel/_compat.py

@@ -184,7 +184,7 @@ def get_sa_type_from_type_annotation(annotation: Any) -> Any:
         bases = get_args(annotation)
         if len(bases) > 2:
             raise ValueError("Cannot have a (non-optional) union as a SQLAlchemy field")
-        # Non optional unions are not allowed
+        # Non-optional unions are not allowed
         if bases[0] is not NoneType and bases[1] is not NoneType:
             raise ValueError("Cannot have a (non-optional) union as a SQLAlchemy field")
         # Optional unions are allowed

{sqlmodel-0.0.39 → sqlmodel-0.0.41}/sqlmodel/ext/asyncio/session.py

@@ -105,7 +105,7 @@ class AsyncSession(_AsyncSession):
         🚨 You probably want to use `session.exec()` instead of `session.execute()`.
 
         This is the original SQLAlchemy `session.execute()` method that returns objects
-        of type `Row`, and that you have to call `scalars()` to get the model objects.
+        of type `Row`, on which you have to call `scalars()` to get the model objects.
 
         For example:
 
@@ -114,7 +114,7 @@ class AsyncSession(_AsyncSession):
         heroes = result.scalars().all()
         ```
 
-        instead you could use `exec()`:
+        Instead, you could use `exec()`:
 
         ```Python
         result = await session.exec(select(Hero))
@@ -136,7 +136,7 @@ class AsyncSession(_AsyncSession):
         🚨 You probably want to use `session.exec()` instead of `session.execute()`.
 
         This is the original SQLAlchemy `session.execute()` method that returns objects
-        of type `Row`, and that you have to call `scalars()` to get the model objects.
+        of type `Row`, on which you have to call `scalars()` to get the model objects.
 
         For example:
 
@@ -145,7 +145,7 @@ class AsyncSession(_AsyncSession):
         heroes = result.scalars().all()
         ```
 
-        instead you could use `exec()`:
+        Instead, you could use `exec()`:
 
         ```Python
         result = await session.exec(select(Hero))

{sqlmodel-0.0.39 → sqlmodel-0.0.41}/sqlmodel/main.py

@@ -3,6 +3,7 @@ from __future__ import annotations
 import builtins
 import ipaddress
 import uuid
+import warnings
 from collections.abc import Callable, Mapping, Sequence, Set
 from dataclasses import dataclass
 from datetime import date, datetime, time, timedelta
@@ -11,6 +12,7 @@ from enum import Enum
 from pathlib import Path
 from typing import (
     TYPE_CHECKING,
+    Annotated,
     Any,
     ClassVar,
     Literal,
@@ -89,6 +91,13 @@ IncEx: TypeAlias = (
 )
 OnDeleteType = Literal["CASCADE", "SET NULL", "RESTRICT"]
 
+MIN_ITEMS_DEPRECATION_MSG = (
+    "`min_items` is deprecated and will be removed, use `min_length` instead"
+)
+MAX_ITEMS_DEPRECATION_MSG = (
+    "`max_items` is deprecated and will be removed, use `max_length` instead"
+)
+
 
 def __dataclass_transform__(
     *,
@@ -253,8 +262,14 @@ def Field(
     multiple_of: float | None = None,
     max_digits: int | None = None,
     decimal_places: int | None = None,
-    min_items: int | None = None,
-    max_items: int | None = None,
+    min_items: Annotated[
+        int | None,
+        deprecated(MIN_ITEMS_DEPRECATION_MSG),
+    ] = None,
+    max_items: Annotated[
+        int | None,
+        deprecated(MAX_ITEMS_DEPRECATION_MSG),
+    ] = None,
     unique_items: bool | None = None,
     min_length: int | None = None,
     max_length: int | None = None,
@@ -296,8 +311,14 @@ def Field(
     multiple_of: float | None = None,
     max_digits: int | None = None,
     decimal_places: int | None = None,
-    min_items: int | None = None,
-    max_items: int | None = None,
+    min_items: Annotated[
+        int | None,
+        deprecated(MIN_ITEMS_DEPRECATION_MSG),
+    ] = None,
+    max_items: Annotated[
+        int | None,
+        deprecated(MAX_ITEMS_DEPRECATION_MSG),
+    ] = None,
     unique_items: bool | None = None,
     min_length: int | None = None,
     max_length: int | None = None,
@@ -348,8 +369,14 @@ def Field(
     multiple_of: float | None = None,
     max_digits: int | None = None,
     decimal_places: int | None = None,
-    min_items: int | None = None,
-    max_items: int | None = None,
+    min_items: Annotated[
+        int | None,
+        deprecated(MIN_ITEMS_DEPRECATION_MSG),
+    ] = None,
+    max_items: Annotated[
+        int | None,
+        deprecated(MAX_ITEMS_DEPRECATION_MSG),
+    ] = None,
     unique_items: bool | None = None,
     min_length: int | None = None,
     max_length: int | None = None,
@@ -381,8 +408,14 @@ def Field(
     multiple_of: float | None = None,
     max_digits: int | None = None,
     decimal_places: int | None = None,
-    min_items: int | None = None,
-    max_items: int | None = None,
+    min_items: Annotated[
+        int | None,
+        deprecated(MIN_ITEMS_DEPRECATION_MSG),
+    ] = None,
+    max_items: Annotated[
+        int | None,
+        deprecated(MAX_ITEMS_DEPRECATION_MSG),
+    ] = None,
     unique_items: bool | None = None,
     min_length: int | None = None,
     max_length: int | None = None,
@@ -403,6 +436,16 @@ def Field(
     schema_extra: dict[str, Any] | None = None,
 ) -> Any:
     current_schema_extra = schema_extra or {}
+
+    if min_items is not None:
+        warnings.warn(MIN_ITEMS_DEPRECATION_MSG, DeprecationWarning, stacklevel=2)
+        if min_length is None:
+            min_length = min_items
+    if max_items is not None:
+        warnings.warn(MAX_ITEMS_DEPRECATION_MSG, DeprecationWarning, stacklevel=2)
+        if max_length is None:
+            max_length = max_items
+
     # Extract possible alias settings from schema_extra so we can control precedence
     schema_validation_alias = current_schema_extra.pop("validation_alias", None)
     schema_serialization_alias = current_schema_extra.pop("serialization_alias", None)
@@ -420,8 +463,6 @@ def Field(
         "multiple_of": multiple_of,
         "max_digits": max_digits,
         "decimal_places": decimal_places,
-        "min_items": min_items,
-        "max_items": max_items,
         "unique_items": unique_items,
         "min_length": min_length,
         "max_length": max_length,
@@ -1006,6 +1047,6 @@ class SQLModel(BaseModel, metaclass=SQLModelMetaclass, registry=default_registry
         else:
             raise ValueError(
                 "Can't use sqlmodel_update() with something that "
-                f"is not a dict or SQLModel or Pydantic model: {obj}"
+                f"is not a dict, SQLModel, or Pydantic model: {obj}"
             )
         return self

{sqlmodel-0.0.39 → sqlmodel-0.0.41}/sqlmodel/orm/session.py

@@ -89,7 +89,7 @@ class Session(_Session):
         🚨 You probably want to use `session.exec()` instead of `session.execute()`.
 
         This is the original SQLAlchemy `session.execute()` method that returns objects
-        of type `Row`, and that you have to call `scalars()` to get the model objects.
+        of type `Row`, on which you have to call `scalars()` to get the model objects.
 
         For example:
 
@@ -97,7 +97,7 @@ class Session(_Session):
         heroes = session.execute(select(Hero)).scalars().all()
         ```
 
-        instead you could use `exec()`:
+        Instead, you could use `exec()`:
 
         ```Python
         heroes = session.exec(select(Hero)).all()
@@ -119,7 +119,7 @@ class Session(_Session):
         🚨 You probably want to use `session.exec()` instead of `session.execute()`.
 
         This is the original SQLAlchemy `session.execute()` method that returns objects
-        of type `Row`, and that you have to call `scalars()` to get the model objects.
+        of type `Row`, on which you have to call `scalars()` to get the model objects.
 
         For example:
 
@@ -127,7 +127,7 @@ class Session(_Session):
         heroes = session.execute(select(Hero)).scalars().all()
         ```
 
-        instead you could use `exec()`:
+        Instead, you could use `exec()`:
 
         ```Python
         heroes = session.exec(select(Hero)).all()
@@ -146,10 +146,10 @@ class Session(_Session):
         """
         🚨 You probably want to use `session.exec()` instead of `session.query()`.
 
-        `session.exec()` is SQLModel's own short version with increased type
+        `session.exec()` is SQLModel's own short version with improved type
         annotations.
 
-        Or otherwise you might want to use `session.execute()` instead of
+        Otherwise, you might want to use `session.execute()` instead of
         `session.query()`.
         """
     )
@@ -159,10 +159,10 @@ class Session(_Session):
         """
         🚨 You probably want to use `session.exec()` instead of `session.query()`.
 
-        `session.exec()` is SQLModel's own short version with increased type
+        `session.exec()` is SQLModel's own short version with improved type
         annotations.
 
-        Or otherwise you might want to use `session.execute()` instead of
+        Otherwise, you might want to use `session.execute()` instead of
         `session.query()`.
         """
         return super().query(*entities, **kwargs)

{sqlmodel-0.0.39 → sqlmodel-0.0.41}/tests/test_pydantic/test_field.py

@@ -54,3 +54,37 @@ def test_repr():
 
     instance = Model(id=123, foo="bar")
     assert "foo=" not in repr(instance)
+
+
+def test_min_items():
+    with pytest.warns(
+        DeprecationWarning,
+        match="`min_items` is deprecated and will be removed, use `min_length` instead",
+    ):
+
+        class Model(SQLModel):
+            items: list[int] = Field(min_items=2)
+
+    Model(items=[1, 2])
+
+    with pytest.raises(ValidationError) as exc_info:
+        Model(items=[1])
+    assert len(exc_info.value.errors()) == 1
+    assert exc_info.value.errors()[0]["type"] == "too_short"
+
+
+def test_max_items():
+    with pytest.warns(
+        DeprecationWarning,
+        match="`max_items` is deprecated and will be removed, use `max_length` instead",
+    ):
+
+        class Model(SQLModel):
+            items: list[int] = Field(max_items=2)
+
+    Model(items=[1, 2])
+
+    with pytest.raises(ValidationError) as exc_info:
+        Model(items=[1, 2, 3])
+    assert len(exc_info.value.errors()) == 1
+    assert exc_info.value.errors()[0]["type"] == "too_long"