Bug 1875996 - Review Request: python-typish - Python library for additional control over types
Summary: Review Request: python-typish - Python library for additional control over types
Keywords:
Status: CLOSED ERRATA
Alias: None
Product: Fedora
Classification: Fedora
Component: Package Review
Version: rawhide
Hardware: All
OS: Linux
medium
medium
Target Milestone: ---
Assignee: Andy Mender
QA Contact: Fedora Extras Quality Assurance
URL:
Whiteboard:
Depends On: 1875994
Blocks: 1875997
TreeView+ depends on / blocked
 
Reported: 2020-09-04 20:25 UTC by Fabian Affolter
Modified: 2020-09-30 00:15 UTC (History)
3 users (show)

Fixed In Version:
Doc Type: If docs needed, set a value
Doc Text:
Clone Of:
Environment:
Last Closed: 2020-09-30 00:15:28 UTC
Type: ---
Embargoed:
andymenderunix: fedora-review+


Attachments (Terms of Use)

Description Fabian Affolter 2020-09-04 20:25:04 UTC
Spec URL: https://fab.fedorapeople.org/packages/SRPMS/python-typish.spec
SRPM URL: https://fab.fedorapeople.org/packages/SRPMS/python-typish-1.7.0-1.fc32.src.rpm

Project URL: https://github.com/ramonhagenaars/typish

Description:
Suport for functions to allow thorough checks on types. Including instance
checks considering generics and typesafe duck-typing.

Koji scratch build:
fails due to missing dependency

rpmlint output:
$ rpmlint python-typish-1.7.0-1.fc32.src.rpm 
python-typish.src: W: spelling-error %description -l en_US Suport -> Sport, Support, Stupor
python-typish.src: W: spelling-error %description -l en_US typesafe -> type safe, type-safe, safety
1 packages and 0 specfiles checked; 0 errors, 2 warnings.

$ rpmlint python3-typish-1.7.0-1.fc32.noarch.rpm 
python3-typish.noarch: W: spelling-error %description -l en_US Suport -> Sport, Support, Stupor
python3-typish.noarch: W: spelling-error %description -l en_US typesafe -> type safe, type-safe, safety
1 packages and 0 specfiles checked; 0 errors, 2 warnings.

Fedora Account System Username: fab

Comment 1 Robert-André Mauchin 🐧 2020-09-05 12:34:35 UTC
Got test failures:

=================================== FAILURES ===================================
____________________ TestInstanceOf.test_instance_of_union _____________________
self = <tests.functions.test_instance_of.TestInstanceOf testMethod=test_instance_of_union>
    def test_instance_of_union(self):
        self.assertTrue(instance_of(F(), Union[int, A]))
        self.assertTrue(instance_of(F(), Union[A, int]))
        self.assertTrue(instance_of(F(), Union[A, str]))
>       self.assertTrue(instance_of(F(), Optional[str]))
E       AssertionError: False is not true
tests/functions/test_instance_of.py:35: AssertionError
_________________ TestIsTypeAnnotation.test_is_type_annotation _________________
self = <tests.functions.test_is_type_annotation.TestIsTypeAnnotation testMethod=test_is_type_annotation>
    def test_is_type_annotation(self):
        # builtins and typing.
        self.assertTrue(is_type_annotation(int))
>       self.assertTrue(is_type_annotation(List))
E       AssertionError: False is not true
tests/functions/test_is_type_annotation.py:21: AssertionError
____________________ TestSubclassOf.test_subclass_of_union _____________________
self = <tests.functions.test_subclass_of.TestSubclassOf testMethod=test_subclass_of_union>
    def test_subclass_of_union(self):
        self.assertTrue(subclass_of(F, Union[int, str]))
        self.assertTrue(subclass_of(F, Union[A, int]))
        self.assertTrue(subclass_of(F, Union[A, B]))
        self.assertTrue(not subclass_of(int, Union[A, B]))
>       self.assertTrue(subclass_of(F, Optional[A]))
E       AssertionError: False is not true
tests/functions/test_subclass_of.py:70: AssertionError
=========================== short test summary info ============================
FAILED tests/functions/test_instance_of.py::TestInstanceOf::test_instance_of_union
FAILED tests/functions/test_is_type_annotation.py::TestIsTypeAnnotation::test_is_type_annotation
FAILED tests/functions/test_subclass_of.py::TestSubclassOf::test_subclass_of_union
======================== 3 failed, 117 passed in 0.76s =========================

See https://github.com/ramonhagenaars/typish/issues/18

Consider disabling them for now?

Comment 2 Andy Mender 2020-09-05 14:05:13 UTC
> %check
> %pytest -v tests

The %check lines should look like this to skip the broken tests (adding a comment with the link to the ticket on GitHub is important as well):
%check
# skip tests which don't work in Python 3.9
# https://github.com/ramonhagenaars/typish/issues/18
%pytest -v tests -k 'not test_instance_of_union and not test_is_type_annotation and not test_subclass_of_union'

I tested this in COPR and it works: https://copr.fedorainfracloud.org/coprs/andymenderunix/metrics2mqtt-and-dependencies/build/1650390/

The rest of the review:

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

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


Issues:
=======
- 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/
  Review: Not quite sure where this comes from, since COPR pulls in the most
  recent version of pytest:
  python3-pytest noarch 6.0.1-1.fc33 fedora 1.5 M

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

Generic:
[x]: Package successfully compiles and builds into binary rpms on at least
     one supported primary architecture.
     Note: Using prebuilt packages
     Review: It's a noarch package.
[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". 46 files have unknown
     license. Detailed output of licensecheck in
     /home/amender/rpmbuild/SPECS/python-typish/copr-build-1650390/review-
     python-typish/licensecheck.txt
[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
[?]: 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 1 files.
[x]: Package complies to the Packaging Guidelines
[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]: 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 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:
[x]: Reviewer should test that the package builds in mock.
[-]: 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.
[-]: Description and summary sections in the package spec file contains
     translations for supported Non-English languages, if available.
[x]: Package should compile and build into binary rpms on all supported
     architectures.
     Review: It's a noarch package.
[!]: %check is present and all tests pass.
     Review: Test exclusions suggested.
[x]: Packages should try to preserve timestamps of original installed
     files.
[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: No rpmlint messages.
[x]: Spec file according to URL is the same as in SRPM.


Rpmlint
-------
Checking: python3-typish-1.7.0-1.fc34.noarch.rpm
          python-typish-1.7.0-1.fc34.src.rpm
python3-typish.noarch: W: spelling-error %description -l en_US Suport -> Sport, Support, Stupor
python3-typish.noarch: W: spelling-error %description -l en_US typesafe -> type safe, type-safe, safety
python-typish.src: W: spelling-error %description -l en_US Suport -> Sport, Support, Stupor
python-typish.src: W: spelling-error %description -l en_US typesafe -> type safe, type-safe, safety
2 packages and 0 specfiles checked; 0 errors, 4 warnings.




Rpmlint (installed packages)
----------------------------
0 packages and 0 specfiles checked; 0 errors, 0 warnings.
(none): E: no installed packages by name python3-typish



Source checksums
----------------
https://github.com/ramonhagenaars/typish/archive/1.7.0/typish-1.7.0.tar.gz :
  CHECKSUM(SHA256) this package     : 20526815fc4ca7ab914a12e6bfa8e7e64886d9165c1b05673d3e8b50fa6d0592
  CHECKSUM(SHA256) upstream package : 20526815fc4ca7ab914a12e6bfa8e7e64886d9165c1b05673d3e8b50fa6d0592


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



Provides
--------
python3-typish:
    python-typish
    python3-typish
    python3.9-typish
    python3.9dist(typish)
    python3dist(typish)

Comment 3 Fabian Affolter 2020-09-07 13:34:27 UTC
(In reply to Robert-André Mauchin 🐧 from comment #1)
> See https://github.com/ramonhagenaars/typish/issues/18
> 
> Consider disabling them for now?

Disabled

%changelog
* Mon Sep 07 2020 Fabian Affolter <mail> - 1.7.0-2
- Disable failing tests (rhbz#1875996)

Updated files:
Spec URL: https://fab.fedorapeople.org/packages/SRPMS/python-typish.spec
SRPM URL: https://fab.fedorapeople.org/packages/SRPMS/python-typish-1.7.0-2.fc32.src.rpm

Comment 4 Andy Mender 2020-09-07 17:39:46 UTC
Approved!

Comment 5 Fabian Affolter 2020-09-07 19:00:02 UTC
Thanks for the review.

Comment 6 Gwyn Ciesla 2020-09-08 13:17:36 UTC
(fedscm-admin):  The Pagure repository was created at https://src.fedoraproject.org/rpms/python-typish

Comment 7 Fedora Update System 2020-09-25 18:22:40 UTC
FEDORA-2020-e1f3bbcb42 has been submitted as an update to Fedora 33. https://bodhi.fedoraproject.org/updates/FEDORA-2020-e1f3bbcb42

Comment 8 Fedora Update System 2020-09-26 01:28:50 UTC
FEDORA-2020-e1f3bbcb42 has been pushed to the Fedora 33 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-e1f3bbcb42 \*`
You can provide feedback for this update here: https://bodhi.fedoraproject.org/updates/FEDORA-2020-e1f3bbcb42

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

Comment 9 Fedora Update System 2020-09-30 00:15:28 UTC
FEDORA-2020-e1f3bbcb42 has been pushed to the Fedora 33 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.