Re: [felix+debian@gueux.org: Bug#955862: RFS: sphinx-autoapi/1.2.1-1 [ITP]]

[Félix Sipma]

On 2020-04-20 16:16+0200, Thomas Goirand wrote:

On 4/20/20 2:45 PM, Félix Sipma wrote:

On 2020-04-20 12:06+0200, Thomas Goirand wrote:

I'm not sure, the doc still accounts for half of the package. But let's
pretend it's ok.

We are talking about 80KB for the whole package. If it's not a blocker
for you I prefer keeping it like that.

Fine, ok.

Now, the package contains a test suite. It'd be nice to run it. If you
add, as dependency: python3-mock, python3-pytest, then pybuild runs the
tests automatically. It needs to be overridden though, to avoid running
integration tests which are failing (or these tests must be fixed).

Can you do that? Then I'll happily upload...

I added the dependencies, and disabled the integration tests which
requires golang and dotnet sphinxcontrib extensions. I don't have the
energy to package these myself...

Of course! However, when I build the package:

The text files are in build/sphinx/text.
dh_auto_test -O--buildsystem=pybuild
I: pybuild base:217: cd
/<<PKGBUILDDIR>>/.pybuild/cpython3_3.8_sphinx-autoapi/build; python3.8
-m unittest discover -v

----------------------------------------------------------------------
Ran 0 tests in 0.000s

So, it's running zero tests now. I'm unsure what you did, but that's not
correct. When it tried myself, a lot of tests ran with success.

I added python3-mock and python3-pytest to actually run the tests, then
I just disabled one specific test through

    `export PYBUILD_TEST_ARGS=-k-test_integration`



    ...
    The text files are in build/sphinx/text.
       dh_auto_test -O--buildsystem=pybuild
    I: pybuild base:217: cd 
/<<PKGBUILDDIR>>/.pybuild/cpython3_3.8_sphinx-autoapi/build; python3.8 -m 
pytest -k-test_integration
    ============================= test session starts 
==============================
    platform linux -- Python 3.8.2, pytest-4.6.9, py-1.8.1, pluggy-0.13.0
    rootdir: /<<PKGBUILDDIR>>
    collected 235 items / 14 deselected / 221 selected

    ........................................................................ [ 
52%]
    ........................................................                 [ 
77%]
    tests/test_domains.py ......                                             [ 
80%]
    tests/test_objects.py .......                                            [ 
83%]
    tests/python/test_parser.py ..........                                   [ 
88%]
    tests/python/test_pyintegration.py ..........................            
[100%]

    /usr/lib/python3/dist-packages/jinja2/sandbox.py:19
      /usr/lib/python3/dist-packages/jinja2/sandbox.py:19: DeprecationWarning: 
Using or importing the ABCs from 'collections' instead of from 
'collections.abc' is deprecated since Python 3.3, and in 3.9 it will stop 
working
        from collections import Mapping

      
/<<PKGBUILDDIR>>/.pybuild/cpython3_3.8_sphinx-autoapi/build/tests/test_domains.py:147:
 DeprecationWarning: invalid escape sequence \s
        self.assertEqual(ret, "With surrounding characters s :any:`FOO`\s")

      
/<<PKGBUILDDIR>>/.pybuild/cpython3_3.8_sphinx-autoapi/build/tests/test_domains.py:152:
 DeprecationWarning: invalid escape sequence \s
        self.assertEqual(ret, "With surrounding characters s ``FOO``\s")

    
.pybuild/cpython3_3.8_sphinx-autoapi/build/tests/python/test_pyintegration.py::test_napoleon_integration_loaded
    
.pybuild/cpython3_3.8_sphinx-autoapi/build/tests/python/test_pyintegration.py::test_class_class_content
    
.pybuild/cpython3_3.8_sphinx-autoapi/build/tests/python/test_pyintegration.py::test_both_class_content
    
.pybuild/cpython3_3.8_sphinx-autoapi/build/tests/python/test_pyintegration.py::test_init_class_content
    
.pybuild/cpython3_3.8_sphinx-autoapi/build/tests/python/test_pyintegration.py::test_hiding_inheritance
    
.pybuild/cpython3_3.8_sphinx-autoapi/build/tests/python/test_pyintegration.py::test_inherited_members
      /usr/lib/python3/dist-packages/sphinx/domains/python.py:400: 
RemovedInSphinx40Warning: PyClassmember is deprecated.
        warnings.warn('PyClassmember is deprecated.',

I use `dgit sbuild` to build the package, and the other tests are actually ran (I just tried again)... tests/test_astroid_utils.py ............................................ [ 19%] =============================== warnings summary =============================== tests/test_domains.py:147 tests/test_domains.py:152 .pybuild/cpython3_3.8_sphinx-autoapi/build/tests/python/test_pyintegration.py::TestSimpleModule::test_manual_directives -- Docs: https://docs.pytest.org/en/latest/warnings.html

    ============ 221 passed, 14 deselected, 10 warnings in 3.96 seconds 
============
       create-stamp debian/debhelper-build-stamp
       dh_testroot -O--buildsystem=pybuild
       dh_prep -O--buildsystem=pybuild
       dh_auto_install -O--buildsystem=pybuild



Could you have another look?

I: pybuild base:217: /usr/bin/python3 setup.py install --root /<<PKGBUILDDIR>>/debian/python3-sphinx-autoapi ...

Could you please also give me the upload rights for this package when it
will enter sid?

I'm sorry, but considering the process and how many mistakes I had to
point at which were easy to spot, I wont take this responsibility. I
however will agree to review subsequent uploads.

Regards,

--
Félix

No problem. I got the "how many mistakes I had to point at which were easy to spot", as I did not submit a new package for a long time and forgot about some of the packaging subtleties, probably did not put enough energy to get this package quality to the top level from the beginning, and also (thanks!) because I had to learn new tricks I did not know before (like using dh_sphinxdoc). But, just to have an idea, what do you mean by "considering the process"?

signature.asc
Description: PGP signature