[Bug 2140076] New: Review Request: python-interface-meta - Provides a convenient way to expose an extensible API
https://bugzilla.redhat.com/show_bug.cgi?id=2140076
Bug ID: 2140076 Summary: Review Request: python-interface-meta - Provides a convenient way to expose an extensible API Product: Fedora Version: rawhide Status: NEW Component: Package Review Assignee: nobody@fedoraproject.org Reporter: sanjay.ankur@gmail.com QA Contact: extras-qa@fedoraproject.org CC: package-review@lists.fedoraproject.org Target Milestone: --- Classification: Fedora
Spec URL: https://ankursinha.fedorapeople.org/python-interface-meta/python-interface-m... SRPM URL: https://ankursinha.fedorapeople.org/python-interface-meta/python-interface-m...
Description: interface_meta provides a convenient way to expose an extensible API with enforced method signatures and consistent documentation.
This library has been extracted (with some modifications) from omniduct, a library also principally written by this author, where it was central to the extensible plugin architecture. It places an emphasis on the functionality required to create a well-documented extensible plugin system, whereby the act of subclassing is sufficient to register the plugin and ensure compliance to the parent API. As such, this library boasts the following features:
- All subclasses of an interface must conform to the parent's API. - Hierarchical runtime property existence and method signature checking. Methods are permitted to add additional optional arguments, but otherwise must conform to the API of their parent class (which themselves may have extended the API of the interface). - Subclass definition time hooks (e.g. for registration of subclasses into a library of plugins, etc). - Optional requirement for methods in subclasses to explicity decorate methods with an override decorator when replacing methods on an interface, making it clearer as to when a class is introducing new methods versus replacing those that form the part of the interface API. - Generation of clear docstrings on implementations that stitches together the base interface documentation with any downstream extensions and quirks. - Support for extracting the quirks documentation for a method from other method docstrings, in the event that subclass implementations are done in an internal method. - Compatibility with ABCMeta from the standard library.
Fedora Account System Username: ankursinha
https://bugzilla.redhat.com/show_bug.cgi?id=2140076
--- Comment #1 from Ankur Sinha (FranciscoD) sanjay.ankur@gmail.com --- This package built on koji: https://koji.fedoraproject.org/koji/taskinfo?taskID=93779718
https://bugzilla.redhat.com/show_bug.cgi?id=2140076
Ankur Sinha (FranciscoD) sanjay.ankur@gmail.com changed:
What |Removed |Added ---------------------------------------------------------------------------- Doc Type|--- |If docs needed, set a value Blocks| |1276941 (fedora-neuro)
Referenced Bugs:
https://bugzilla.redhat.com/show_bug.cgi?id=1276941 [Bug 1276941] Fedora NeuroImaging and NeuroScience tracking bug
https://bugzilla.redhat.com/show_bug.cgi?id=2140076
Ankur Sinha (FranciscoD) sanjay.ankur@gmail.com changed:
What |Removed |Added ---------------------------------------------------------------------------- Whiteboard| |Trivial
https://bugzilla.redhat.com/show_bug.cgi?id=2140076
Sandro gui1ty@penguinpee.nl changed:
What |Removed |Added ---------------------------------------------------------------------------- Flags| |fedora-review? Assignee|nobody@fedoraproject.org |gui1ty@penguinpee.nl CC| |gui1ty@penguinpee.nl Status|NEW |ASSIGNED
--- Comment #2 from Sandro gui1ty@penguinpee.nl --- Taken.
https://bugzilla.redhat.com/show_bug.cgi?id=2140076
Sandro gui1ty@penguinpee.nl changed:
What |Removed |Added ---------------------------------------------------------------------------- Flags|fedora-review? |fedora-review+ Status|ASSIGNED |POST
--- Comment #3 from Sandro gui1ty@penguinpee.nl --- Issues: =======
One minor nitpick: Since you have tests conditionalized, I would suggest the following in %check:
%if %{with tests} %{pytest} %else %pyproject_import_test %endif
This way the minimal import tests are run as required by Python Packaging Guidelines.
Nonetheless, APPROVED!
Package Review ==============
Legend: [x] = Pass, [!] = Fail, [-] = Not applicable, [?] = Not evaluated [ ] = Manual review needed
===== MUST items =====
Generic: [x]: Package successfully compiles and builds into binary rpms on at least one supported primary architecture. Note: Using prebuilt packages [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. [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. [x]: 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]: 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. [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. [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]: Spec use %global instead of %define unless justified. [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.
===== EXTRA items =====
Generic: [x]: Rpmlint is run on all installed packages. Note: There are rpmlint messages (see attachment).
Rpmlint ------- => no errors, no warnings
Rpmlint (installed packages) ---------------------------- Cannot parse rpmlint output:
Source checksums ---------------- https://github.com/matthewwardrop/interface_meta/archive/v1.3.0/python-inter... : CHECKSUM(SHA256) this package : 6a96da34ef2a319cab788f6b0cb8afca03186adcc21e1da36f4985329cf86511 CHECKSUM(SHA256) upstream package : 6a96da34ef2a319cab788f6b0cb8afca03186adcc21e1da36f4985329cf86511
Requires -------- python3-interface-meta (rpmlib, GLIBC filtered): python(abi)
Provides -------- python3-interface-meta: python-interface-meta python3-interface-meta python3.11-interface-meta python3.11dist(interface-meta) python3dist(interface-meta)
Generated by fedora-review 0.8.0 (e988316) last change: 2022-04-07 Command line :/usr/bin/fedora-review --no-colors --prebuilt --rpm-spec --name python-interface-meta --mock-config /var/lib/copr-rpmbuild/results/configs/child.cfg Buildroot used: fedora-rawhide-x86_64 Active plugins: Shell-api, Python, Generic Disabled plugins: Java, SugarActivity, fonts, Perl, PHP, C/C++, Haskell, Ocaml, R Disabled flags: EPEL6, EPEL7, DISTTAG, BATCH, EXARCH
https://bugzilla.redhat.com/show_bug.cgi?id=2140076
--- Comment #4 from Sandro gui1ty@penguinpee.nl --- (In reply to Sandro from comment #3)
Issues:
One minor nitpick: Since you have tests conditionalized, I would suggest the following in %check:
%if %{with tests} %{pytest} %else %pyproject_import_test %endif
Sorry the correct macro is %pyproject_check_import
https://bugzilla.redhat.com/show_bug.cgi?id=2140076
--- Comment #5 from Ankur Sinha (FranciscoD) sanjay.ankur@gmail.com --- Thanks very much again, Sandro.
I've removed the conditional entirely. It was just there from the spec template that I use---mostly for packages that sometimes need networking for tests. No need for it here.
Updated spec/srpm:
Spec URL: https://ankursinha.fedorapeople.org/python-interface-meta/python-interface-m... SRPM URL: https://ankursinha.fedorapeople.org/python-interface-meta/python-interface-m...
Requesting SCM now.
https://bugzilla.redhat.com/show_bug.cgi?id=2140076
--- Comment #6 from Gwyn Ciesla gwync@protonmail.com --- (fedscm-admin): The Pagure repository was created at https://src.fedoraproject.org/rpms/python-interface-meta
https://bugzilla.redhat.com/show_bug.cgi?id=2140076
Ankur Sinha (FranciscoD) sanjay.ankur@gmail.com changed:
What |Removed |Added ---------------------------------------------------------------------------- Status|POST |CLOSED Resolution|--- |NEXTRELEASE Last Closed| |2022-11-04 16:27:27
package-review@lists.fedoraproject.org
-
bugzilla＠redhat.com