Bug 1847117 - Review Request: python-sphinxcontrib-zopeext - Sphinx extension for documenting Zope interfaces
Summary: Review Request: python-sphinxcontrib-zopeext - Sphinx extension for documenti...
Keywords:
Status: CLOSED ERRATA
Alias: None
Product: Fedora
Classification: Fedora
Component: Package Review
Version: rawhide
Hardware: All
OS: Linux
medium
medium
Target Milestone: ---
Assignee: Andrew Bauer
QA Contact: Fedora Extras Quality Assurance
URL:
Whiteboard:
Depends On:
Blocks:
TreeView+ depends on / blocked
 
Reported: 2020-06-15 17:31 UTC by Jerry James
Modified: 2020-06-26 00:45 UTC (History)
2 users (show)

Fixed In Version:
Doc Type: If docs needed, set a value
Doc Text:
Clone Of:
Environment:
Last Closed: 2020-06-26 00:45:28 UTC
Type: ---
Embargoed:
zonexpertconsulting: fedora-review+


Attachments (Terms of Use)

Description Jerry James 2020-06-15 17:31:18 UTC
Spec URL: https://jjames.fedorapeople.org/python-sphinxcontrib-zopeext/python-sphinxcontrib-zopeext.spec
SRPM URL: https://jjames.fedorapeople.org/python-sphinxcontrib-zopeext/python-sphinxcontrib-zopeext-0.2.4-1.fc33.src.rpm
Fedora Account System Username: jjames
Description: This sphinx extension provides an autointerface directive for Zope interfaces.

Comment 1 Andrew Bauer 2020-06-15 20:26:12 UTC
Posting the output of fedora-review for reference:

Package Review
==============

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


Issues:
=======
- Python packages must not contain %{pythonX_site(lib|arch)}/* in %files
  Note: Package contains %{pythonX_site(lib|arch)}/* in %files
  See: https://pagure.io/packaging-committee/issue/782
- Package must not depend on deprecated() packages.
  Note: python3-pytest4 is deprecated, you must not depend on it.
  See: https://docs.fedoraproject.org/en-US/packaging-
  guidelines/deprecating-packages/


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

Generic:
[ ]: Package is licensed with an open-source compatible license and meets
     other legal requirements as defined in the legal section of Packaging
     Guidelines.
[ ]: 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.
[ ]: License field in the package spec file matches the actual license.
     Note: Checking patched sources after %prep for licenses. Licenses
     found: "Unknown or generated". 17 files have unknown license. Detailed
     output of licensecheck in /home/abauer/1847117-python-sphinxcontrib-
     zopeext/licensecheck.txt
[ ]: Package does not own files or directories owned by other packages.
     Note: Dirs in package are owned also by: /usr/lib/python3.9/site-
     packages/sphinxcontrib(python3-sphinxcontrib-bibtex,
     python3-sphinxcontrib-httpdomain, python3-sphinxcontrib-phpdomain,
     python3-sphinxcontrib-qthelp, python3-sphinxcontrib-programoutput,
     python3-sphinxcontrib-serializinghtml, python3-sphinx,
     python3-sphinxcontrib-log-cabinet, python3-sphinxcontrib-autoprogram,
     python3-sphinxcontrib-seqdiag, python3-sphinxcontrib-htmlhelp,
     python3-sphinxcontrib-websupport, python3-sphinxcontrib-issuetracker,
     python3-sphinxcontrib-adadomain, python3-sphinxcontrib-devhelp,
     python3-sphinxcontrib-blockdiag, python3-sphinxcontrib-actdiag,
     python3-sphinxcontrib-spelling, python3-sphinxcontrib-applehelp,
     python3-sphinxcontrib-jsmath, python3-sphinxcontrib-asyncio)
[ ]: Package contains no bundled libraries without FPC exception.
[ ]: Changelog in prescribed format.
[ ]: 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
[ ]: Package uses nothing in %doc for runtime.
[ ]: Package consistently uses macros (instead of hard-coded directory
     names).
[ ]: Package is named according to the Package Naming Guidelines.
[ ]: Package does not generate any conflict.
[ ]: Package obeys FHS, except libexecdir and /usr/target.
[ ]: If the package is a rename of another package, proper Obsoletes and
     Provides are present.
[ ]: Requires correct, justified where necessary.
[ ]: Spec file is legible and written in American English.
[ ]: Package contains systemd file(s) if in need.
[ ]: 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.
[ ]: 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]: Package requires other packages for directories it uses.
[x]: Package must own all directories that it creates.
[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]: 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.
[ ]: 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]: 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.
[ ]: Final provides and requires are sane (see attachments).
[ ]: Package functions as described.
[ ]: Latest version is packaged.
[ ]: Package does not include license text files separate from upstream.
[ ]: Sources are verified with gpgverify first in %prep if upstream
     publishes signatures.
     Note: gpgverify is not used.
[ ]: Description and summary sections in the package spec file contains
     translations for supported Non-English languages, if available.
[ ]: Package should compile and build into binary rpms on all supported
     architectures.
[ ]: %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]: 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-sphinxcontrib-zopeext-0.2.4-1.fc33.noarch.rpm
          python-sphinxcontrib-zopeext-0.2.4-1.fc33.src.rpm
python3-sphinxcontrib-zopeext.noarch: W: spelling-error %description -l en_US autointerface -> auto interface, auto-interface, interface
python3-sphinxcontrib-zopeext.noarch: W: obsolete-not-provided python3-j1m.sphinxautointerface
python-sphinxcontrib-zopeext.src: W: spelling-error %description -l en_US autointerface -> auto interface, auto-interface, interface
2 packages and 0 specfiles checked; 0 errors, 3 warnings.




Rpmlint (installed packages)
----------------------------
warning: Found bdb Packages database while attempting sqlite backend: using bdb backend.
warning: Found bdb Packages database while attempting sqlite backend: using bdb backend.
python3-sphinxcontrib-zopeext.noarch: W: spelling-error %description -l en_US autointerface -> auto interface, auto-interface, interface
python3-sphinxcontrib-zopeext.noarch: W: invalid-url URL: https://pypi.org/project/sphinxcontrib-zopeext/ <urlopen error [Errno -2] Name or service not known>
python3-sphinxcontrib-zopeext.noarch: W: obsolete-not-provided python3-j1m.sphinxautointerface
1 packages and 0 specfiles checked; 0 errors, 3 warnings.



Source checksums
----------------
https://files.pythonhosted.org/packages/source/s/sphinxcontrib-zopeext/sphinxcontrib-zopeext-0.2.4.tar.gz :
  CHECKSUM(SHA256) this package     : f9b6ef34565b50153ad565106bbf12f7129d26f5c9feb7b141f76cbe90f4d780
  CHECKSUM(SHA256) upstream package : f9b6ef34565b50153ad565106bbf12f7129d26f5c9feb7b141f76cbe90f4d780


Requires
--------
python3-sphinxcontrib-zopeext (rpmlib, GLIBC filtered):
    python(abi)
    python3.9dist(sphinx)
    python3.9dist(zope-interface)



Provides
--------
python3-sphinxcontrib-zopeext:
    python-sphinxcontrib-zopeext
    python3-sphinxcontrib-zopeext
    python3.9-sphinxcontrib-zopeext
    python3.9dist(sphinxcontrib-zopeext)
    python3dist(sphinxcontrib-zopeext)



Generated by fedora-review 0.7.5 (5fa5b7e) last change: 2020-02-16
Command line :/usr/bin/fedora-review -b 1847117
Buildroot used: fedora-rawhide-x86_64
Active plugins: Shell-api, Python, Generic
Disabled plugins: Java, R, Ocaml, C/C++, Perl, fonts, Haskell, PHP, SugarActivity
Disabled flags: EPEL6, EPEL7, DISTTAG, BATCH, EXARCH

Comment 2 Andrew Bauer 2020-06-15 21:29:56 UTC
Fix glob in %files 
-------------------

Replace:
> %{python3_sitelib}/*

with:
> %{python3_sitelib}/%{srcname}-*.egg-info/
> %{python3_sitelib}/%{srcname}/

See:
https://docs.fedoraproject.org/en-US/packaging-guidelines/Python/#_example_python_spec_file
https://docs.fedoraproject.org/en-US/packaging-guidelines/Python_Eggs/


python3-pytest4 is deprecated
-----------------------------

python3-pytest4 is deprecated, but that build requirement is autogenerated from the py3_dist macro.
It seems safe to ignore this. One would expect py3_dist to choose python3-pytest5 automatically, once pytest4 goes away.

Some background reading I came across:

https://www.spinics.net/lists/fedora-devel/msg272130.html (python3-pytest5 is the replacement)
https://bugzilla.redhat.com/show_bug.cgi?id=1839477 (same error, but reviewer didn't flag it)



It looks good. I'm going to sleep on it and take another pass at this in the morning.

Comment 3 Jerry James 2020-06-15 21:42:48 UTC
(In reply to Andrew Bauer from comment #1)
> - Python packages must not contain %{pythonX_site(lib|arch)}/* in %files
>   Note: Package contains %{pythonX_site(lib|arch)}/* in %files
>   See: https://pagure.io/packaging-committee/issue/782

Oops, that was an oversight.  I meant to update that before submitting for review and forgot.  It's a good thing fedora-review is on its toes. :-)  Fixed.

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

It turns out that this is due to the python3-pytest-runner BR.  It also turns out that this package contains no useful tests, so I have dropped all of the test-related BRs and munged setup.py slightly to be able to build without them present.  If upstream adds actual tests, I will add back in the necessary BRs at that time.

(In reply to Andrew Bauer from comment #2)
> python3-pytest4 is deprecated, but that build requirement is autogenerated
> from the py3_dist macro.
> It seems safe to ignore this. One would expect py3_dist to choose
> python3-pytest5 automatically, once pytest4 goes away.
> 
> Some background reading I came across:
> 
> https://www.spinics.net/lists/fedora-devel/msg272130.html (python3-pytest5
> is the replacement)
> https://bugzilla.redhat.com/show_bug.cgi?id=1839477 (same error, but
> reviewer didn't flag it)

That reviewer was wrong.  The whole point of deprecating packages is to ensure that no new dependencies on them can be created.  You were right to flag this; I must remove the dependency (and have).

New URLs:
Spec URL: https://jjames.fedorapeople.org/python-sphinxcontrib-zopeext/python-sphinxcontrib-zopeext.spec
SRPM URL: https://jjames.fedorapeople.org/python-sphinxcontrib-zopeext/python-sphinxcontrib-zopeext-0.2.4-2.fc33.src.rpm

Comment 4 Andrew Bauer 2020-06-16 12:50:53 UTC
I made another pass at this while my morning coffee soaked in. Still looks good.

Package Approved.

One non-critical thing I would point out is the example file:
/usr/lib/python3.9/site-packages/sphinxcontrib/zopeext/example.py

During my own package reviews, I have been asked to move example scripts into docs. I've not seen any Fedora documentation that says you have to do this, but I generally agree it's a good idea. 

I'm sure you know this an cause rpmlint to complain of scripts in the docs folder, so there may be additional modifications to go along with this. In any case, this is totally optional.

Comment 5 Jerry James 2020-06-16 16:21:37 UTC
Thank you for the review, Andrew.  I'm not sure what the best approach is for example.py.  It is listed in the egg info, so I'm afraid to remove it lest the whole package break. (I actually had that happen when trying to remove test code from another python package.)  If it's okay with you, I think I'll leave it where it is.  It's only 1KB, so I think it isn't a big deal.

Comment 6 Andrew Bauer 2020-06-16 16:57:42 UTC
Yeah, I totally agree. If there were a whole bunch of examples, I'd be more inclined to move them to docs, but we are just talking about a single file. Let's just leave it as it is.

Comment 7 Gwyn Ciesla 2020-06-16 18:45:47 UTC
(fedscm-admin):  The Pagure repository was created at https://src.fedoraproject.org/rpms/python-sphinxcontrib-zopeext

Comment 8 Fedora Update System 2020-06-16 20:00:00 UTC
FEDORA-2020-11ae6c9262 has been submitted as an update to Fedora 32. https://bodhi.fedoraproject.org/updates/FEDORA-2020-11ae6c9262

Comment 9 Fedora Update System 2020-06-18 14:13:25 UTC
FEDORA-2020-11ae6c9262 has been pushed to the Fedora 32 testing repository.
In short time you'll be able to install the update with the following command:
`sudo dnf install --enablerepo=updates-testing --advisory=FEDORA-2020-11ae6c9262 \*`
You can provide feedback for this update here: https://bodhi.fedoraproject.org/updates/FEDORA-2020-11ae6c9262

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

Comment 10 Fedora Update System 2020-06-26 00:45:28 UTC
FEDORA-2020-11ae6c9262 has been pushed to the Fedora 32 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.