[Bug 2326298] Review Request: python-pydoctor - API documentation generator that works by static analysis

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



https://bugzilla.redhat.com/show_bug.cgi?id=2326298

Benson Muite <benson_muite@xxxxxxxxxxxxx> changed:

           What    |Removed                     |Added
----------------------------------------------------------------------------
              Flags|needinfo?(benson_muite@emai |
                   |lplus.org)                  |



--- Comment #16 from Benson Muite <benson_muite@xxxxxxxxxxxxx> ---
Package Review
==============

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



===== 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", "MIT License", "*No copyright* MIT
     License", "BSD 3-Clause License". 244 files have unknown license.
     Detailed output of licensecheck in
     /FedoraPackaging/reviews/python-pydoctor/2326298-python-
     pydoctor/licensecheck.txt
[x]: If the package is under multiple licenses, the licensing breakdown
     must be documented in the spec.
[x]: Package must own all directories that it creates.
     Note: Directories without known owners: /usr/lib/python3.13,
     /usr/lib/python3.13/site-packages
[x]: Package contains no bundled libraries without FPC exception.
[x]: Changelog in prescribed format.
[x]: Sources contain only permissible code or content.
[ ]: Macros in Summary, %description expandable at SRPM build time.
     Note: Macros in: python3-pydoctor (description)
[-]: 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.
[ ]: 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 23728 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: 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]: 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:
[-]: 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]: 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.
[x]: 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.
     Note: gpgverify is not used.
[x]: Package should compile and build into binary rpms on all supported
     architectures.
[!]: %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-pydoctor-24.11.1-1.20241208git24.11.1.fc42.noarch.rpm
          python-pydoctor-24.11.1-1.20241208git24.11.1.fc42.src.rpm
============================ 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
rpmlintrc: [PosixPath('/tmp/tmp04ybnajs')]
checks: 32, packages: 2

python3-pydoctor.noarch: E: zero-length
/usr/lib/python3.13/site-packages/pydoctor/themes/base/extra.css
python3-pydoctor.noarch: E: zero-length
/usr/lib/python3.13/site-packages/pydoctor/themes/base/header.html
python3-pydoctor.noarch: E: zero-length
/usr/lib/python3.13/site-packages/pydoctor/themes/base/subheader.html
python3-pydoctor.noarch: W: unexpanded-macro %description -l C %{description}
python-pydoctor.src: E: spelling-error ('epydoc', '%description -l en_US epydoc
-> epoch')
python-pydoctor.src: E: spelling-error ('zope', '%description -l en_US zope ->
ope, zone, nope')
python3-pydoctor.noarch: W: no-manual-page-for-binary pydoctor
python3-pydoctor.noarch: W: description-shorter-than-summary
 2 packages and 0 specfiles checked; 5 errors, 3 warnings, 16 filtered, 5
badness; has taken 2.2 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: 1

python3-pydoctor.noarch: E: zero-length
/usr/lib/python3.13/site-packages/pydoctor/themes/base/extra.css
python3-pydoctor.noarch: E: zero-length
/usr/lib/python3.13/site-packages/pydoctor/themes/base/header.html
python3-pydoctor.noarch: E: zero-length
/usr/lib/python3.13/site-packages/pydoctor/themes/base/subheader.html
python3-pydoctor.noarch: W: unexpanded-macro %description -l C %{description}
python3-pydoctor.noarch: W: no-manual-page-for-binary pydoctor
python3-pydoctor.noarch: W: description-shorter-than-summary
 1 packages and 0 specfiles checked; 3 errors, 3 warnings, 12 filtered, 3
badness; has taken 1.3 s 



Source checksums
----------------
https://github.com/twisted/pydoctor/archive/24.11.1/pydoctor-24.11.1.tar.gz :
  CHECKSUM(SHA256) this package     :
2f9648f19b45d8a8b3fece3f3f4160a50d798257807cdb9d8cc1f0a82770fcb5
  CHECKSUM(SHA256) upstream package :
2f9648f19b45d8a8b3fece3f3f4160a50d798257807cdb9d8cc1f0a82770fcb5


Requires
--------
python3-pydoctor (rpmlib, GLIBC filtered):
    (python3.13dist(lunr) < 0.8~~ with python3.13dist(lunr) >= 0.6.2)
    /usr/bin/python3
    python(abi)
    python3.13dist(attrs)
    python3.13dist(cachecontrol)
    python3.13dist(cachecontrol[filecache])
    python3.13dist(configargparse)
    python3.13dist(docutils)
    python3.13dist(platformdirs)
    python3.13dist(requests)
    python3.13dist(twisted)
    python3.13dist(urllib3)



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



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


Comments:
a) License tag is not needed:
$ rpm -qL python3-pydoctor-24.11.1-1.20241208git24.11.1.fc42.noarch.rpm
/usr/lib/python3.13/site-packages/pydoctor-24.11.1.dist-info/LICENSE.txt
/usr/share/licenses/python3-pydoctor/LICENSE.txt

Please change
%pyproject_save_files %{srcname}
to
%pyproject_save_files %{srcname} -l

and change
%files -n python3-%{srcname} -f %{pyproject_files}
%license LICENSE.txt
%doc README.rst CONTRIBUTING.rst
to
%files -n python3-%{srcname} -f %{pyproject_files}
%doc README.rst CONTRIBUTING.rst

see
https://docs.fedoraproject.org/en-US/packaging-guidelines/Python/#_build_macros

b) Fonts seem to be only imported in css files:
pydoctor/themes/readthedocs/readthedocstheme.css:    src:
url(fonts/lato-normal.woff2) format("woff2"), url(fonts/lato-normal.woff)
format("woff");
pydoctor/themes/readthedocs/readthedocstheme.css:    src:
url(fonts/lato-bold.woff2) format("woff2"), url(fonts/lato-bold.woff)
format("woff");
pydoctor/themes/readthedocs/readthedocstheme.css:    src:
url(fonts/Roboto-Slab-Regular.woff2) format("woff2"),
url(fonts/Roboto-Slab-Regular.woff) format("woff");
pydoctor/themes/readthedocs/readthedocstheme.css:    src:
url(fonts/Roboto-Slab-Bold.woff2) format("woff2"),
url(fonts/Roboto-Slab-Bold.woff) format("woff");


They could be replaced by ttf that is packaged in Fedora, but it is not
blocking.

c) Tests still do not run.
https://github.com/twisted/cython-test-exception-raiser
seems to be required, but is not yet packaged.

Will attach a spec file that enables tests. Feel free to modify if it helps.


At present the following tests fail:
FAILED pydoctor/test/test_commandline.py::test_main_project_name_guess -
DeprecationWarning: datetime.datetime.utcfromtimestamp() is deprecated and
scheduled for removal in a future version. Use timezone-aware objects to
represent datetimes in UTC: datetime.datetime.fromtimestamp(timestamp,
datetime.UTC).
FAILED
pydoctor/test/test_cyclic_imports_base_classes.py::test_cyclic_imports_base_classes
- AssertionError: assert 1 == 0
 +  where 1 = wait()
 +    where wait = <Popen: returncode: 1 args: ['/usr/bin/python3',
'test_cyclic_imports_base_c...>.wait
FAILED pydoctor/test/test_commandline.py::test_main_project_name_option -
DeprecationWarning: datetime.datetime.utcfromtimestamp() is deprecated and
scheduled for removal in a future version. Use timezone-aware objects to
represent datetimes in UTC: datetime.datetime.fromtimestamp(timestamp,
datetime.UTC).
FAILED pydoctor/test/test_commandline.py::test_main_return_zero_on_warnings -
DeprecationWarning: datetime.datetime.utcfromtimestamp() is deprecated and
scheduled for removal in a future version. Use timezone-aware objects to
represent datetimes in UTC: datetime.datetime.fromtimestamp(timestamp,
datetime.UTC).
FAILED pydoctor/test/test_commandline.py::test_main_return_non_zero_on_warnings
- DeprecationWarning: datetime.datetime.utcfromtimestamp() is deprecated and
scheduled for removal in a future version. Use timezone-aware objects to
represent datetimes in UTC: datetime.datetime.fromtimestamp(timestamp,
datetime.UTC).
FAILED pydoctor/test/test_commandline.py::test_main_symlinked_paths -
DeprecationWarning: datetime.datetime.utcfromtimestamp() is deprecated and
scheduled for removal in a future version. Use timezone-aware objects to
represent datetimes in UTC: datetime.datetime.fromtimestamp(timestamp,
datetime.UTC).
FAILED pydoctor/test/test_commandline.py::test_main_source_outside_basedir -
DeprecationWarning: datetime.datetime.utcfromtimestamp() is deprecated and
scheduled for removal in a future version. Use timezone-aware objects to
represent datetimes in UTC: datetime.datetime.fromtimestamp(timestamp,
datetime.UTC).
FAILED pydoctor/test/test_commandline.py::test_make_intersphix -
DeprecationWarning: datetime.datetime.utcfromtimestamp() is deprecated and
scheduled for removal in a future version. Use timezone-aware objects to
represent datetimes in UTC: datetime.datetime.fromtimestamp(timestamp,
datetime.UTC).
FAILED pydoctor/test/test_commandline.py::test_index_symlink -
DeprecationWarning: datetime.datetime.utcfromtimestamp() is deprecated and
scheduled for removal in a future version. Use timezone-aware objects to
represent datetimes in UTC: datetime.datetime.fromtimestamp(timestamp,
datetime.UTC).
FAILED pydoctor/test/test_commandline.py::test_index_hardlink -
DeprecationWarning: datetime.datetime.utcfromtimestamp() is deprecated and
scheduled for removal in a future version. Use timezone-aware objects to
represent datetimes in UTC: datetime.datetime.fromtimestamp(timestamp,
datetime.UTC).
FAILED pydoctor/test/test_commandline.py::test_apidocs_help -
DeprecationWarning: datetime.datetime.utcfromtimestamp() is deprecated and
scheduled for removal in a future version. Use timezone-aware objects to
represent datetimes in UTC: datetime.datetime.fromtimestamp(timestamp,
datetime.UTC).
FAILED pydoctor/test/test_commandline.py::test_htmlbaseurl_option_all_pages -
DeprecationWarning: datetime.datetime.utcfromtimestamp() is deprecated and
scheduled for removal in a future version. Use timezone-aware objects to
represent datetimes in UTC: datetime.datetime.fromtimestamp(timestamp,
datetime.UTC).
FAILED pydoctor/test/test_configparser.py::test_unquote_naughty_quoted_strings
- requests.exceptions.ConnectionError:
HTTPSConnectionPool(host='raw.githubusercontent.com', port=443): Max retries
exceeded with url: /minimaxir/big-list-of-naughty-strings/master/blns.txt
(Caused by NameResolutionError("<urllib3.connection.HTTPSConnection object at
0x7fffa8980690>: Failed to resolve 'raw.githubusercontent.com' ([Errno -3]
Temporary failure in name resolution)"))


See https://koji.fedoraproject.org/koji/taskinfo?taskID=127493857


-- 
You are receiving this mail because:
You are always notified about changes to this product and component
You are on the CC list for the bug.
https://bugzilla.redhat.com/show_bug.cgi?id=2326298

Report this comment as SPAM: https://bugzilla.redhat.com/enter_bug.cgi?product=Bugzilla&format=report-spam&short_desc=Report%20of%20Bug%202326298%23c16

-- 
_______________________________________________
package-review mailing list -- package-review@xxxxxxxxxxxxxxxxxxxxxxx
To unsubscribe send an email to package-review-leave@xxxxxxxxxxxxxxxxxxxxxxx
Fedora Code of Conduct: https://docs.fedoraproject.org/en-US/project/code-of-conduct/
List Guidelines: https://fedoraproject.org/wiki/Mailing_list_guidelines
List Archives: https://lists.fedoraproject.org/archives/list/package-review@xxxxxxxxxxxxxxxxxxxxxxx
Do not reply to spam, report it: https://pagure.io/fedora-infrastructure/new_issue




[Index of Archives]     [Fedora Users]     [Fedora Desktop]     [Fedora SELinux]     [Yosemite Conditions]     [KDE Users]

  Powered by Linux