From mboxrd@z Thu Jan 1 00:00:00 1970 Received: from eggs.gnu.org ([2001:470:142:3::10]:46748) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1j1t0j-00053q-Mr for guix-patches@gnu.org; Wed, 12 Feb 2020 09:29:07 -0500 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1j1t0i-0004wa-8B for guix-patches@gnu.org; Wed, 12 Feb 2020 09:29:05 -0500 Received: from debbugs.gnu.org ([209.51.188.43]:52026) by eggs.gnu.org with esmtps (TLS1.0:RSA_AES_128_CBC_SHA1:16) (Exim 4.71) (envelope-from ) id 1j1t0g-0004vJ-MH for guix-patches@gnu.org; Wed, 12 Feb 2020 09:29:04 -0500 Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1j1t0g-0001W8-HJ for guix-patches@gnu.org; Wed, 12 Feb 2020 09:29:02 -0500 Subject: [bug#39572] [PATCH] gnu: Add python-sphinx-autodoc-typehints. Resent-Message-ID: Date: Wed, 12 Feb 2020 09:28:06 -0500 Message-ID: <17039ccc811.f87a728432739.1646525153556191072@zoho.com> In-Reply-To: <20200212074827.GE26092@E5400> References: <20200212001420.24513-1-sirgazil@zoho.com> <20200212074827.GE26092@E5400> MIME-Version: 1.0 Content-Type: text/plain; charset="UTF-8" Content-Transfer-Encoding: quoted-printable List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: guix-patches-bounces+kyle=kyleam.com@gnu.org Sender: "Guix-patches" Reply-to: sirgazil , sirgazil via Guix-patches From: sirgazil via Guix-patches via To: Efraim Flashner Cc: 39572 <39572@debbugs.gnu.org> ---- On Wed, 12 Feb 2020 02:48:27 -0500 Efraim Flashner wrote ---- > Overall the package looks good. I ran into an issue with the tests, > namely that they weren't run. (This is becoming a common issue with our > python packages as they change how the test suite is run) >=20 > On Tue, Feb 11, 2020 at 07:14:20PM -0500, sirgazil via Guix-patches via = wrote: > > * gnu/packages/sphinx.scm (python-sphinx-autodoc-typehints): New varia= ble. > > --- > > gnu/packages/sphinx.scm | 25 +++++++++++++++++++++++++ > > 1 file changed, 25 insertions(+) > >=20 > > diff --git a/gnu/packages/sphinx.scm b/gnu/packages/sphinx.scm > > index 4e4abccb04..41bde173c3 100644 > > --- a/gnu/packages/sphinx.scm > > +++ b/gnu/packages/sphinx.scm > > @@ -13,6 +13,7 @@ > > ;;; Copyright =C2=A9 2019 Nicolas Goaziou > > ;;; Copyright =C2=A9 2019 Alexandros Theodotou > > ;;; Copyright =C2=A9 2019 Brett Gilio > > +;;; Copyright =C2=A9 2020 sirgazil > > ;;; > > ;;; This file is part of GNU Guix. > > ;;; > > @@ -597,3 +598,27 @@ to be able to read and render the Doxygen xml out= put.") > > "A utility tool that provides several features that make it easy= to > > translate and to apply translation to Sphinx generated document.") > > (license license:bsd-2))) > > + > > +(define-public python-sphinx-autodoc-typehints > > + (package > > + (name "python-sphinx-autodoc-typehints") > > + (version "1.10.3") > > + (source > > + (origin > > + (method url-fetch) > > + (uri (pypi-uri "sphinx-autodoc-typehints" version)) > > + (sha256 > > + (base32 > > + "1w6zy3cyp24jsdi8dcynrinafw2a0k5vblqy9lncm6j7cw0iicx6")))) > > + (build-system python-build-system) >=20 > I added the following snippet here to run the tests: >=20 > (arguments > `(#:phases > (modify-phases %standard-phases > (replace 'check > (lambda _ > (invoke "pytest")))))) >=20 > And added python-pytest to the native-inputs but it turns out that > wasn't enough: >=20 > starting phase `check' > ImportError while loading conftest '/tmp/guix-build-python-sphinx-autodo= c-typehints-1.10.3.drv-0/sphinx-autodoc-typehints-1.10.3/tests/conftest.py'= . > tests/conftest.py:8: in > from sphobjinv import Inventory > E ModuleNotFoundError: No module named 'sphobjinv' > command "pytest" failed with status 4 >=20 > According to here=C2=B9 there are a couple of other dependencies that ar= e > needed to run the tests, including sphobjinv which isn't packaged yet. Oh, I read "extras_require" as "completely optional". I'll be more careful = with that. > > + (native-inputs > > + `(("python-setuptools-scm" ,python-setuptools-scm))) > > + (propagated-inputs > > + `(("python-sphinx" ,python-sphinx))) > > + (home-page "https://github.com/agronholm/sphinx-autodoc-typehints= ") > > + (synopsis "Type hints support for the Sphinx autodoc extension") > > + (description > > + "This extension allows you to use Python 3 annotations for > > +documenting acceptable argument types and return value types of > > +functions.") > > + (license license:expat))) > > --=20 > > 2.25.0 > >=20 >=20 > =C2=B9 https://github.com/agronholm/sphinx-autodoc-typehints/blob/1.10.3= /setup.cfg >=20 > --=20 > Efraim Flashner =D7=90=D7=A4=D7=A8=D7=99=D7= =9D =D7=A4=D7=9C=D7=A9=D7=A0=D7=A8 > GPG key =3D A28B F40C 3E55 1372 662D 14F7 41AA E7DC CA3D 8351 > Confidentiality cannot be guaranteed on emails sent or received unencryp= ted >=20 Thank you very much for your review, Efraim. I'll check if I'm able to pack= age whatever is missing.