Bug 2318408 - Review Request: python-sqlmodel - SQL databases in Python, designed for simplicity, compatibility, and robustness
Summary: Review Request: python-sqlmodel - SQL databases in Python, designed for simpl...
Keywords:
Status: CLOSED ERRATA
Alias: None
Product: Fedora
Classification: Fedora
Component: Package Review
Version: rawhide
Hardware: All
OS: Linux
medium
medium
Target Milestone: ---
Assignee: Benson Muite
QA Contact: Fedora Extras Quality Assurance
URL:
Whiteboard:
Depends On:
Blocks:
TreeView+ depends on / blocked
 
Reported: 2024-10-13 13:45 UTC by Ben Beasley
Modified: 2024-12-04 05:16 UTC (History)
2 users (show)

Fixed In Version:
Clone Of:
Environment:
Last Closed: 2024-11-19 20:26:28 UTC
Type: ---
Embargoed:
benson_muite: fedora-review+


Attachments (Terms of Use)

Description Ben Beasley 2024-10-13 13:45:25 UTC
Spec URL: https://music.fedoraproject.org/python-sqlmodel.spec
SRPM URL: https://music.fedoraproject.org/python-sqlmodel-0.0.22-1.fc40.src.rpm
Description:

SQLModel is a library for interacting with SQL databases from Python code, with
Python objects. It is designed to be intuitive, easy to use, highly compatible,
and robust.

SQLModel is based on Python type annotations, and powered by Pydantic and
SQLAlchemy.

The key features are:

  • Intuitive to write: Great editor support. Completion everywhere. Less time
    debugging. Designed to be easy to use and learn. Less time reading docs.
  • Easy to use: It has sensible defaults and does a lot of work underneath to
    simplify the code you write.
  • Compatible: It is designed to be compatible with FastAPI, Pydantic, and
    SQLAlchemy.
  • Extensible: You have all the power of SQLAlchemy and Pydantic underneath.
  • Short: Minimize code duplication. A single type annotation does a lot of
    work. No need to duplicate models in SQLAlchemy and Pydantic.

Fedora Account System Username: music

This is by the same author as FastAPI and Typer, and has the same odd structure with regular and -slim versions; see https://src.fedoraproject.org/rpms/python-fastapi and https://src.fedoraproject.org/rpms/python-typer.

This is an optional test dependency for python-fastapi.

Comment 2 Fedora Review Service 2024-11-19 15:07:20 UTC
Copr build:
https://copr.fedorainfracloud.org/coprs/build/8280409
(succeeded)

Review template:
https://download.copr.fedorainfracloud.org/results/@fedora-review/fedora-review-2318408-python-sqlmodel/fedora-rawhide-x86_64/08280409-python-sqlmodel/fedora-review/review.txt

Found issues:

- python3-pytest7 is deprecated, you must not depend on it.
  Read more: https://docs.fedoraproject.org/en-US/packaging-guidelines/deprecating-packages/

Please know that there can be false-positives.

---
This comment was created by the fedora-review-service
https://github.com/FrostyX/fedora-review-service

If you want to trigger a new Copr build, add a comment containing new
Spec and SRPM URLs or [fedora-review-service-build] string.

Comment 3 Benson Muite 2024-11-19 16:44:52 UTC
Package Review
==============

Legend:
[x] = Pass, [!] = Fail, [-] = Not applicable, [?] = Not evaluated
[ ] = Manual review needed


Issues:
=======
- Package must not depend on deprecated() packages.
  Note: python3-pytest7 is deprecated, you must not depend on it.
  See: https://docs.fedoraproject.org/en-US/packaging-
  guidelines/deprecating-packages/


===== MUST items =====

Generic:
[x]: Package is licensed with an open-source compatible license and meets
     other legal requirements as defined in the legal section of Packaging
     Guidelines.
[x]: License field in the package spec file matches the actual license.
     Note: Checking patched sources after %prep for licenses. Licenses
     found: "Unknown or generated", "*No copyright* MIT License", "MIT
     License". 693 files have unknown license. Detailed output of
     licensecheck in /home/FedoraPackaging/reviews/python-sqlmodel/2318408-
     python-sqlmodel/licensecheck.txt
[x]: License file installed when any subpackage combination is installed.
[x]: Package must own all directories that it creates.
     Note: Directories without known owners: /usr/lib/python3.13/site-
     packages, /usr/lib/python3.13
[x]: Package contains no bundled libraries without FPC exception.
[x]: Changelog in prescribed format.
[x]: Sources contain only permissible code or content.
[-]: Package contains desktop file if it is a GUI application.
[-]: Development files must be in a -devel package
[x]: Package uses nothing in %doc for runtime.
[x]: Package consistently uses macros (instead of hard-coded directory
     names).
[x]: Package is named according to the Package Naming Guidelines.
[x]: Package does not generate any conflict.
[x]: Package obeys FHS, except libexecdir and /usr/target.
[-]: If the package is a rename of another package, proper Obsoletes and
     Provides are present.
[x]: Requires correct, justified where necessary.
[x]: Spec file is legible and written in American English.
[-]: Package contains systemd file(s) if in need.
[x]: Package is not known to require an ExcludeArch tag.
[x]: Package complies to the Packaging Guidelines
[x]: Package successfully compiles and builds into binary rpms on at least
     one supported primary architecture.
[x]: Package installs properly.
[x]: Rpmlint is run on all rpms the build produces.
     Note: There are rpmlint messages (see attachment).
[x]: If (and only if) the source package includes the text of the
     license(s) in its own file, then that file, containing the text of the
     license(s) for the package is included in %license.
[x]: The License field must be a valid SPDX expression.
[x]: Package requires other packages for directories it uses.
[x]: Package does not own files or directories owned by other packages.
[x]: Package uses either %{buildroot} or $RPM_BUILD_ROOT
[x]: Package does not run rm -rf %{buildroot} (or $RPM_BUILD_ROOT) at the
     beginning of %install.
[x]: Macros in Summary, %description expandable at SRPM build time.
[x]: Dist tag is present.
[x]: Package does not contain duplicates in %files.
[x]: Permissions on files are set properly.
[x]: Package use %makeinstall only when make install DESTDIR=... doesn't
     work.
[x]: Package is named using only allowed ASCII characters.
[x]: Package does not use a name that already exists.
[x]: Package is not relocatable.
[x]: Sources used to build the package match the upstream source, as
     provided in the spec URL.
[x]: Spec file name must match the spec package %{name}, in the format
     %{name}.spec.
[x]: File names are valid UTF-8.
[x]: Large documentation must go in a -doc subpackage. Large could be size
     (~1MB) or number of files.
     Note: Documentation size is 9152 bytes in 2 files.
[x]: Packages must not store files under /srv, /opt or /usr/local

Python:
[-]: Python eggs must not download any dependencies during the build
     process.
[-]: A package which is used by another package via an egg interface should
     provide egg info.
[x]: Package meets the Packaging Guidelines::Python
[x]: Package contains BR: python2-devel or python3-devel
[x]: Packages MUST NOT have dependencies (either build-time or runtime) on
     packages named with the unversioned python- prefix unless no properly
     versioned package exists. Dependencies on Python packages instead MUST
     use names beginning with python2- or python3- as appropriate.
[x]: Python packages must not contain %{pythonX_site(lib|arch)}/* in %files
[x]: Binary eggs must be removed in %prep

===== SHOULD items =====

Generic:
[-]: If the source package does not include license text(s) as a separate
     file from upstream, the packager SHOULD query upstream to include it.
[x]: Final provides and requires are sane (see attachments).
[x]: Fully versioned dependency in subpackages if applicable.
     Note: No Requires: %{name}%{?_isa} = %{version}-%{release} in
     python3-sqlmodel , python3-sqlmodel-slim
[ ]: Package functions as described.
[x]: Latest version is packaged.
[x]: Package does not include license text files separate from upstream.
[x]: Patches link to upstream bugs/comments/lists or are otherwise
     justified.
[-]: Sources are verified with gpgverify first in %prep if upstream
     publishes signatures.
     Note: gpgverify is not used.
[x]: Package should compile and build into binary rpms on all supported
     architectures.
[x]: %check is present and all tests pass.
[x]: Packages should try to preserve timestamps of original installed
     files.
[x]: Reviewer should test that the package builds in mock.
[x]: Buildroot is not present
[x]: Package has no %clean section with rm -rf %{buildroot} (or
     $RPM_BUILD_ROOT)
[x]: No file requires outside of /etc, /bin, /sbin, /usr/bin, /usr/sbin.
[x]: Packager, Vendor, PreReq, Copyright tags should not be in spec file
[x]: Sources can be downloaded from URI in Source: tag
[x]: SourceX is a working URL.
[x]: Spec use %global instead of %define unless justified.

===== EXTRA items =====

Generic:
[x]: Rpmlint is run on all installed packages.
     Note: There are rpmlint messages (see attachment).
[x]: Spec file according to URL is the same as in SRPM.


Rpmlint
-------
Checking: python3-sqlmodel-0.0.22-1.fc42.noarch.rpm
          python3-sqlmodel-slim-0.0.22-1.fc42.noarch.rpm
          python-sqlmodel-0.0.22-1.fc42.src.rpm
=============================================== rpmlint session starts ===============================================
rpmlint: 2.5.0
configuration:
    /usr/lib/python3.12/site-packages/rpmlint/configdefaults.toml
    /etc/xdg/rpmlint/fedora-legacy-licenses.toml
    /etc/xdg/rpmlint/fedora-spdx-licenses.toml
    /etc/xdg/rpmlint/fedora.toml
    /etc/xdg/rpmlint/scoring.toml
    /etc/xdg/rpmlint/users-groups.toml
    /etc/xdg/rpmlint/warn-on-functions.toml
rpmlintrc: [PosixPath('/tmp/tmp_bjzk083')]
checks: 32, packages: 3

python3-sqlmodel.noarch: W: python-leftover-require python3-sqlmodel-slim
python3-sqlmodel.noarch: W: no-documentation
========= 3 packages and 0 specfiles checked; 0 errors, 2 warnings, 15 filtered, 0 badness; has taken 4.9 s ==========




Rpmlint (installed packages)
----------------------------
============================ rpmlint session starts ============================
rpmlint: 2.5.0
configuration:
    /usr/lib/python3.13/site-packages/rpmlint/configdefaults.toml
    /etc/xdg/rpmlint/fedora-spdx-licenses.toml
    /etc/xdg/rpmlint/fedora.toml
    /etc/xdg/rpmlint/scoring.toml
    /etc/xdg/rpmlint/users-groups.toml
    /etc/xdg/rpmlint/warn-on-functions.toml
checks: 32, packages: 2

python3-sqlmodel.noarch: W: python-leftover-require python3-sqlmodel-slim
python3-sqlmodel.noarch: W: no-documentation
 2 packages and 0 specfiles checked; 0 errors, 2 warnings, 11 filtered, 0 badness; has taken 1.2 s 



Source checksums
----------------
https://github.com/fastapi/sqlmodel/archive/0.0.22/sqlmodel-0.0.22.tar.gz :
  CHECKSUM(SHA256) this package     : b9bffd6db6c4a5428e23f4d53dec305c45ec19e58875a0ed1061e963748b2ee2
  CHECKSUM(SHA256) upstream package : b9bffd6db6c4a5428e23f4d53dec305c45ec19e58875a0ed1061e963748b2ee2


Requires
--------
python3-sqlmodel (rpmlib, GLIBC filtered):
    (python3.13dist(pydantic) < 3~~ with python3.13dist(pydantic) >= 1.10.13)
    (python3.13dist(sqlalchemy) < 2.1~~ with python3.13dist(sqlalchemy) >= 2.0.14)
    python(abi)
    python3-sqlmodel-slim

python3-sqlmodel-slim (rpmlib, GLIBC filtered):
    (python3.13dist(pydantic) < 3~~ with python3.13dist(pydantic) >= 1.10.13)
    (python3.13dist(sqlalchemy) < 2.1~~ with python3.13dist(sqlalchemy) >= 2.0.14)
    python(abi)



Provides
--------
python3-sqlmodel:
    python-sqlmodel
    python3-sqlmodel
    python3.13-sqlmodel
    python3.13dist(sqlmodel)
    python3dist(sqlmodel)

python3-sqlmodel-slim:
    python-sqlmodel-slim
    python3-sqlmodel-slim
    python3.13-sqlmodel-slim
    python3.13dist(sqlmodel-slim)
    python3dist(sqlmodel-slim)



Generated by fedora-review 0.10.0 (e79b66b) last change: 2023-07-24
Command line :/usr/bin/fedora-review -b 2318408
Buildroot used: fedora-rawhide-x86_64
Active plugins: Python, Shell-api, Generic
Disabled plugins: fonts, PHP, Haskell, SugarActivity, R, Ocaml, C/C++, Java, Perl
Disabled flags: EXARCH, EPEL6, EPEL7, DISTTAG, BATCH

Comments:
a) Would be nice to have some documentation, but not a blocker.  Seems only webpages
can be generated directly from what is provided.
b) Consider adding
%doc SECURITY.md
c) Approved
d) Is it possible to complete review of https://bugzilla.redhat.com/show_bug.cgi?id=2322082

Comment 4 Benson Muite 2024-11-19 17:48:29 UTC
python-typer and python-fastapi spec files have reasons for the
unusual package splits.  Maybe helpful to add similar comments
in the current spec file or refer to the other two packages.

Comment 5 Ben Beasley 2024-11-19 19:31:54 UTC
Thank you for the review!

(In reply to Benson Muite from comment #4)
> python-typer and python-fastapi spec files have reasons for the
> unusual package splits.  Maybe helpful to add similar comments
> in the current spec file or refer to the other two packages.

I have

# This package corresponds to two PyPI projects (sqlmodel-slim, and sqlmodel)
# co-developed in one repository. Since the two are versioned identically and
# released at the same time, it makes sense to build them from a single source
# package.

at the top of the spec file, which is almost identical to the comments
in the python-fastapi and python-typer spec files. Is there a different
comment that you had in mind?

https://release-monitoring.org/project/283800/

Comment 6 Fedora Admin user for bugzilla script actions 2024-11-19 19:32:34 UTC
The Pagure repository was created at https://src.fedoraproject.org/rpms/python-sqlmodel

Comment 7 Fedora Update System 2024-11-19 20:21:31 UTC
FEDORA-2024-04ee7e26e3 (python-sqlmodel-0.0.22-1.fc42) has been submitted as an update to Fedora 42.
https://bodhi.fedoraproject.org/updates/FEDORA-2024-04ee7e26e3

Comment 8 Fedora Update System 2024-11-19 20:26:28 UTC
FEDORA-2024-04ee7e26e3 (python-sqlmodel-0.0.22-1.fc42) has been pushed to the Fedora 42 stable repository.
If problem still persists, please make note of it in this bug report.

Comment 9 Fedora Update System 2024-11-19 20:47:50 UTC
FEDORA-2024-44fe4d6b74 (python-sqlmodel-0.0.22-1.fc41) has been submitted as an update to Fedora 41.
https://bodhi.fedoraproject.org/updates/FEDORA-2024-44fe4d6b74

Comment 10 Fedora Update System 2024-11-19 21:20:59 UTC
FEDORA-2024-7f399c958d (python-sqlmodel-0.0.22-1.fc40) has been submitted as an update to Fedora 40.
https://bodhi.fedoraproject.org/updates/FEDORA-2024-7f399c958d

Comment 11 Benson Muite 2024-11-20 03:54:14 UTC
The split between the files is not clear,  For the other two
packages, the main reason seems to be to provide a command
line interface, so the slim package contains all the working
code.  The full package adds syntactic sugar that may/may not
get in the way of the user.

Comment 12 Ben Beasley 2024-11-20 04:33:22 UTC
(In reply to Benson Muite from comment #11)
> The split between the files is not clear,  For the other two
> packages, the main reason seems to be to provide a command
> line interface, so the slim package contains all the working
> code.  The full package adds syntactic sugar that may/may not
> get in the way of the user.

The -slim thing, and particularly the way it is implemented, is decidedly idiosyncratic to the primary developer of these three packages, but it’s not something we can really opt out of downstream. We need dependencies on python3dist(sqlmodel), python3dist(sqlmodel-slim), or a future python3dist(sqlmodel-slim[standard]) to each be satisfiable, non-conflicting, and bring in the correct set of dependencies.

Right now, python3-sqlmodel and python3-sqlmodel-slim have the same external dependencies,

(python3.13dist(pydantic) < 3~~ with python3.13dist(pydantic) >= 1.10.13)
(python3.13dist(sqlalchemy) < 2.1~~ with python3.13dist(sqlalchemy) >= 2.0.14)

but in https://github.com/fastapi/sqlmodel/pull/916 upstream writes,

“In the future SQLModel will include the standard default recommended packages, and sqlmodel-slim will come without those recommended standard packages and with a group of optional dependencies sqlmodel-slim[standard], equivalent to sqlmodel, for those that want to opt out of those packages.”

You can see this with python3-typer and python3-typer-slim:

$ rpm -q --requires -p results_python-typer/0.13.1/1.fc41/python3-typer-slim-0.13.1-1.fc41.noarch.rpm | grep -v rpmlib
python(abi) = 3.13
python3.13dist(click) >= 8
python3.13dist(typing-extensions) >= 3.7.4.3
$ rpm -q --requires -p results_python-typer/0.13.1/1.fc41/python3-typer-slim+standard-0.13.1-1.fc41.noarch.rpm | grep -v rpmlib
python(abi) = 3.13
python3-typer-slim = 0.13.1-1.fc41
python3.13dist(rich) >= 10.11
python3.13dist(shellingham) >= 1.3
$ rpm -q --requires -p results_python-typer/0.13.1/1.fc41/python3-typer-0.13.1-1.fc41.noarch.rpm | grep -v rpmlib
python(abi) = 3.13
python3-typer-cli = 0.13.1-1.fc41
python3-typer-slim = 0.13.1-1.fc41
python3.13dist(click) >= 8
python3.13dist(rich) >= 10.11
python3.13dist(shellingham) >= 1.3
python3.13dist(typing-extensions) >= 3.7.4.3

The PyPI wheels for sqlmodel and sqlmodel-slim contain the same code as each other but have potentially different dependencies, with sqlmodel’s being a superset of sqlmodel-slim‘s. This is true of typer and typer-slim, and of fastapi and fastapi-slim: both wheels ship the same code. In Fedora, we could have python3-sqlmodel and python3-sqlmodel-slim co-own %{python3_sitelib}/sqlmodel and all of its contents, but since python3-sqlmodel is supposed to have all the dependencies python3-sqlmodel-slim does (and possibly more), using a dependency is just as correct, has no real disadvantages, and has fewer caveats around differing versions and file conflicts.

I agree that this is all a very weird way of handling optional dependencies, and it’s somewhat confusing, but it is a very intentional upstream design decision, and the naming and arrangement of the subpackages is just a direct reflection of what upstream publishes.

Comment 13 Fedora Update System 2024-11-20 15:46:00 UTC
FEDORA-2024-7f399c958d has been pushed to the Fedora 40 testing repository.
Soon you'll be able to install the update with the following command:
`sudo dnf install --enablerepo=updates-testing --refresh --advisory=FEDORA-2024-7f399c958d \*`
You can provide feedback for this update here: https://bodhi.fedoraproject.org/updates/FEDORA-2024-7f399c958d

See also https://fedoraproject.org/wiki/QA:Updates_Testing for more information on how to test updates.

Comment 14 Fedora Update System 2024-11-20 17:13:30 UTC
FEDORA-2024-44fe4d6b74 has been pushed to the Fedora 41 testing repository.
Soon you'll be able to install the update with the following command:
`sudo dnf install --enablerepo=updates-testing --refresh --advisory=FEDORA-2024-44fe4d6b74 \*`
You can provide feedback for this update here: https://bodhi.fedoraproject.org/updates/FEDORA-2024-44fe4d6b74

See also https://fedoraproject.org/wiki/QA:Updates_Testing for more information on how to test updates.

Comment 15 Fedora Update System 2024-11-24 20:18:10 UTC
FEDORA-2024-3f4d4c0d43 (python-fastapi-0.115.5-3.fc41, python-jiter-0.7.1-1.fc41, and 5 more) has been submitted as an update to Fedora 41.
https://bodhi.fedoraproject.org/updates/FEDORA-2024-3f4d4c0d43

Comment 16 Fedora Update System 2024-11-25 03:43:31 UTC
FEDORA-2024-3f4d4c0d43 has been pushed to the Fedora 41 testing repository.
Soon you'll be able to install the update with the following command:
`sudo dnf upgrade --enablerepo=updates-testing --refresh --advisory=FEDORA-2024-3f4d4c0d43`
You can provide feedback for this update here: https://bodhi.fedoraproject.org/updates/FEDORA-2024-3f4d4c0d43

See also https://fedoraproject.org/wiki/QA:Updates_Testing for more information on how to test updates.

Comment 17 Fedora Update System 2024-11-27 02:51:57 UTC
FEDORA-2024-3f4d4c0d43 has been pushed to the Fedora 41 testing repository.
Soon you'll be able to install the update with the following command:
`sudo dnf upgrade --enablerepo=updates-testing --refresh --advisory=FEDORA-2024-3f4d4c0d43`
You can provide feedback for this update here: https://bodhi.fedoraproject.org/updates/FEDORA-2024-3f4d4c0d43

See also https://fedoraproject.org/wiki/QA:Updates_Testing for more information on how to test updates.

Comment 18 Fedora Update System 2024-11-28 02:45:12 UTC
FEDORA-2024-7f399c958d (python-sqlmodel-0.0.22-1.fc40) has been pushed to the Fedora 40 stable repository.
If problem still persists, please make note of it in this bug report.

Comment 19 Fedora Update System 2024-12-04 05:16:19 UTC
FEDORA-2024-3f4d4c0d43 (python-fastapi-0.115.5-3.fc41, python-jiter-0.7.1-1.fc41, and 5 more) has been pushed to the Fedora 41 stable repository.
If problem still persists, please make note of it in this bug report.


Note You need to log in before you can comment on or make changes to this bug.