Bug 2017670 - Review Request: python-tomli-w - A Python library for writing TOML
Summary: Review Request: python-tomli-w - A Python library for writing TOML
Keywords:
Status: CLOSED RAWHIDE
Alias: None
Product: Fedora
Classification: Fedora
Component: Package Review
Version: rawhide
Hardware: All
OS: Linux
medium
medium
Target Milestone: ---
Assignee: Miro Hrončok
QA Contact: Fedora Extras Quality Assurance
URL:
Whiteboard:
Depends On:
Blocks:
TreeView+ depends on / blocked
 
Reported: 2021-10-27 07:37 UTC by Tomáš Hrnčiar
Modified: 2021-11-04 14:27 UTC (History)
2 users (show)

Fixed In Version: python-tomli-w-0.4.0-1.fc36
Clone Of:
Environment:
Last Closed: 2021-11-04 14:27:43 UTC
Type: ---
Embargoed:
mhroncok: fedora-review+


Attachments (Terms of Use)

Description Tomáš Hrnčiar 2021-10-27 07:37:50 UTC
Spec URL: https://download.copr.fedorainfracloud.org/results/thrnciar/python-flit/fedora-rawhide-x86_64/02910428-python-tomli-w/python-tomli-w.spec
SRPM URL: https://download.copr.fedorainfracloud.org/results/thrnciar/python-flit/fedora-rawhide-x86_64/02910428-python-tomli-w/python-tomli-w-0.4.0-1.fc36.src.rpm
Description: Tomli-W is a Python library for writing TOML. It is a write-only counterpart to Tomli, which is a read-only TOML parser. Tomli-W is fully compatible with TOML v1.0.0.
Fedora Account System Username: thrnciar

Comment 1 Miro Hrončok 2021-10-27 09:34:30 UTC
spec sanity:


Consider using https://github.com/hukkin/tomli-w for URL, as this is the URL this project lists in its metadata as homepage.


Consider constructing the GitHub tarball URL to include the name of the project, it plays much more nicely in shared SOURCES folder:


  Source0:        https://github.com/hukkin/tomli-w/archive/%{version}/tomli-w-%{version}.tar.gz

Or even:

  Source0:        %{url}/archive/%{version}/tomli-w-%{version}.tar.gz


%description should be word-wrapped to 79 characters. rpmlint will complain otherwise.




Note that there is a build dependency loop with flit from https://src.fedoraproject.org/rpms/python-flit/pull-request/16 -- is there a way to build this without flit?

Comment 2 Miro Hrončok 2021-10-27 10:01:47 UTC
(In reply to Miro Hrončok from comment #1)
> Note that there is a build dependency loop with flit from
> https://src.fedoraproject.org/rpms/python-flit/pull-request/16 -- is there a
> way to build this without flit?



Something like this works:


# (no idea if there is a hash-less URL for whls yet)
Source1:        https://files.pythonhosted.org/packages/f2/1b/4a0eae0293fbc806ddb43f4bd24d54cef40dcd022a76d8b59986aa813a6a/tomli_w-%{version}-py3-none-any.whl
BuildRequires:  python3-devel
BuildRequires:  python3-pip

# no %%generate_buildrequires

...

%build
mkdir -p %{_pyproject_wheeldir}
cp -p %{SOURCE1} %{_pyproject_wheeldir}

%install
%pyproject_install
...


This could be under a bootstrap bcond in tomli and tomli-w.

Comment 3 Miro Hrončok 2021-10-27 10:11:41 UTC
(In reply to Miro Hrončok from comment #2)
> # (no idea if there is a hash-less URL for whls yet)
> Source1:       
> https://files.pythonhosted.org/packages/f2/1b/
> 4a0eae0293fbc806ddb43f4bd24d54cef40dcd022a76d8b59986aa813a6a/tomli_w-
> %{version}-py3-none-any.whl

https://files.pythonhosted.org/packages/py3/t/tomli_w/tomli_w-0.4.0-py3-none-any.whl

Comment 5 Miro Hrončok 2021-10-29 11:51:07 UTC
Note that conditional source definitions are discouraged (forbidden?) because they prevent an SRPM generated with one bcond-value to be re-used to build with another bcond-value.

I also think this special "use a wheel for bootstrap" case deserves some explanation in a comment.
I would especially note that any patches are not applied to the wheel and if we need to do that, special care needs to be applied.



The duplicated %build/%install section seems a bit unusual, have you considered repeating the conditional in the sections instead?



%prep
%autosetup -p1 -n tomli-w-%{version}


%if %{without bootstrap}
%generate_buildrequires
%pyproject_buildrequires -t
%endif


%build
%if %{with bootstrap}
mkdir -p %{_pyproject_wheeldir}
cp -p %{SOURCE1} %{_pyproject_wheeldir}
%else
%pyproject_wheel
%endif


%install
%pyproject_install
%pyproject_save_files tomli_w


%if %{without bootstrap}
%check
%tox
%endif


%files -n python3-tomli-w -f %{pyproject_files}
%doc README.md
%doc CHANGELOG.md
%license LICENSE

Comment 6 Miro Hrončok 2021-10-29 13:52:09 UTC
BTW, to speed this review up, we can leave the bootstrap problem out and figure it out later.

Comment 7 Miro Hrončok 2021-10-29 13:59:28 UTC
The bootstrap thing won't be necessary after all, see https://src.fedoraproject.org/rpms/python-flit/pull-request/16#comment-88571

Comment 10 Miro Hrončok 2021-10-29 14:38:02 UTC
Package Review
==============


Package APPROVED.

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



===== 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", "Expat License", "*No copyright* Expat
     License".
[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.
[-]: Large documentation must go in a -doc subpackage. Large could be size
     (~1MB) or number of files.
     Note: Documentation size is 10240 bytes in 2 files.
[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: No rpmlint messages.
[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]: Package requires other packages for directories it uses.
[x]: Package must own all directories that it creates.
[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 must not depend on deprecated() packages.
[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]: Packages must not store files under /srv, /opt or /usr/local

Python:
[x]: Python eggs must not download any dependencies during the build
     process.
[x]: 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).
[?]: Package functions as described.
[?]: Latest version is packaged.
[x]: Package does not include license text files separate from upstream.
[-]: Sources are verified with gpgverify first in %prep if upstream
     publishes signatures.
[?]: Package should compile and build into binary rpms on all supported
     architectures.
[x]: %check is present and all tests pass.
[?]: 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]: Spec file according to URL is the same as in SRPM.


Rpmlint
-------
Checking: python3-tomli-w-0.4.0-1.fc36.noarch.rpm
          python-tomli-w-0.4.0-1.fc36.src.rpm
2 packages and 0 specfiles checked; 0 errors, 0 warnings.




Rpmlint (installed packages)
----------------------------
Cannot parse rpmlint output:


Source checksums
----------------
https://github.com/hukkin/tomli-w/archive/0.4.0/tomli-w-0.4.0.tar.gz :
  CHECKSUM(SHA256) this package     : c0fa7eae695178a6faa0c19781522a83e183a272542af5b637d52c887c8a8628
  CHECKSUM(SHA256) upstream package : c0fa7eae695178a6faa0c19781522a83e183a272542af5b637d52c887c8a8628


Requires
--------
python3-tomli-w (rpmlib, GLIBC filtered):
    python(abi)



Provides
--------
python3-tomli-w:
    python-tomli-w
    python3-tomli-w
    python3.10-tomli-w
    python3.10dist(tomli-w)
    python3dist(tomli-w)



Generated by fedora-review 0.7.0 (fed5495) last change: 2019-03-17
Command line :try-fedora-review -b 2017670 -m fedora-rawhide-x86_64 --mock-options=--enablerepo=local
Buildroot used: fedora-rawhide-x86_64
Active plugins: Generic, Shell-api, Python
Disabled plugins: Ruby, Perl, C/C++, SugarActivity, Java, R, Ocaml, fonts, PHP, Haskell
Disabled flags: EPEL6, EPEL7, DISTTAG, BATCH, EXARCH

Comment 11 Gwyn Ciesla 2021-11-02 15:30:44 UTC
(fedscm-admin):  The Pagure repository was created at https://src.fedoraproject.org/rpms/python-tomli-w

Comment 12 Miro Hrončok 2021-11-04 13:16:02 UTC
I see this was built.

Please add python-sig, configure Koschei and release-monitoring.org and close this bugzilla when done.

Thanks.

Comment 13 Tomáš Hrnčiar 2021-11-04 14:27:43 UTC
 > Please add python-sig, configure Koschei and release-monitoring.org and
> close this bugzilla when done.

Done, I am closing this bugzilla.


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