Your message dated Sun, 29 Oct 2017 17:27:37 +0000
with message-id <[email protected]>
and subject line Bug#877637: fixed in sphinx 1.6.5-2
has caused the Debian Bug report #877637,
regarding python3-sphinx: Unreproducible (html) output using 
py3/ext.autodoc/dict attributes
to be marked as done.

This means that you claim that the problem has been dealt with.
If this is not the case it is now your responsibility to reopen the
Bug report if necessary, and/or fix the problem forthwith.

(NB: If you are a system administrator and have no idea what this
message is talking about, this may indicate a serious mail system
misconfiguration somewhere. Please contact [email protected]
immediately.)


-- 
877637: https://bugs.debian.org/cgi-bin/bugreport.cgi?bug=877637
Debian Bug Tracking System
Contact [email protected] with problems
--- Begin Message ---
Package: python3-sphinx
Version: 1.6.4-1
Severity: normal

Dear Maintainer,

in python3, PYTHONHASHSEED's default value has become "random" at some
point. It seems this make projects using ext.autodoc prone to generate
unreproducible documentation (order the dicts are iterated vary).

   * What led up to the situation?
   * What exactly did you do (or not do) that was effective (or
     ineffective)?

sphinx documentation with 'ext.autodoc' extension enabled and, in code,
classes having attributes like so:

---
class X(object):
        Y = {"a": "aah",
             "b": "beh",
             "c": "zeh",
             "d": "deh"}
---

   * What was the outcome of this action?

Randomly different HTML output.

   * What outcome did you expect instead?

The very same HTML output.

Please see the little script attached, which produces a minimal
setup with this behaviour.

PYTHONHASHSEED=0 set explicitly works around the problem.

Is this a known problem, or even unfixable? If so, is there a commonly
accepted workaround (I humbly searched but found little
on the subject)?

Thx!

S

-- System Information:
Debian Release: buster/sid
  APT prefers unstable
  APT policy: (500, 'unstable'), (500, 'stable')
Architecture: amd64 (x86_64)

Kernel: Linux 4.12.0-0.bpo.2-amd64 (SMP w/4 CPU cores)
Locale: LANG=de_DE.UTF-8, LC_CTYPE=de_DE.UTF-8 (charmap=UTF-8), 
LANGUAGE=de_DE.UTF-8 (charmap=UTF-8)
Shell: /bin/sh linked to /bin/dash
Init: sysvinit (via /sbin/init)

Versions of packages python3-sphinx depends on:
ii  python3            3.5.3-3
ii  python3-alabaster  0.7.8-1
ii  python3-babel      2.4.0+dfsg.1-2
ii  python3-docutils   0.14+dfsg-1
ii  python3-imagesize  0.7.1-1
ii  python3-jinja2     2.9.6-1
ii  python3-pygments   2.2.0+dfsg-1
ii  python3-requests   2.18.1-1
ii  python3-six        1.11.0-1
ii  sphinx-common      1.6.4-1

Versions of packages python3-sphinx recommends:
ii  python3-pil  4.2.1-1

Versions of packages python3-sphinx suggests:
pn  dvipng                     <none>
pn  imagemagick-6.q16          <none>
pn  latexmk                    <none>
ii  libjs-mathjax              2.7.0-2
pn  python3-sphinx-rtd-theme   <none>
pn  sphinx-doc                 <none>
pn  texlive-fonts-recommended  <none>
pn  texlive-generic-extra      <none>
pn  texlive-latex-extra        <none>
pn  texlive-latex-recommended  <none>

-- no debconf information
#!/bin/bash -e

read -p "Generate test project in cwd??" DUMMY

mkdir -p src/
cat >src/module.py <<EOF
class X(object):
        Y = {"a": "aah",
             "b": "beh",
             "c": "zeh",
             "d": "deh"}
EOF

cat >conf.py <<EOF
extensions = ['sphinx.ext.autodoc']
autodoc_member_order = 'bysource'
EOF

cat >contents.rst <<EOF
dummy
=====
EOF

/usr/share/sphinx/scripts/python3/sphinx-apidoc --force --output-dir . ./src/

export PYTHONPATH=$(pwd)/src
#export PYTHONHASHSEED=random  # py3 default; unreproducible
#export PYTHONHASHSEED=0       # fixed seed; reproducible

for i in 1 2; do
        rm -rf _build/html html${i}/
        /usr/share/sphinx/scripts/python3/sphinx-build . _build/html/
        cp -a _build/html html${i}
done

diff -u -r -x '*.pickle' -x '.doctrees/*' html1 html2
echo "OK (same HTML output)"

--- End Message ---
--- Begin Message ---
Source: sphinx
Source-Version: 1.6.5-2

We believe that the bug you reported is fixed in the latest version of
sphinx, which is due to be installed in the Debian FTP archive.

A summary of the changes between this version and the previous one is
attached.

Thank you for reporting the bug, which will now be closed.  If you
have further comments please address them to [email protected],
and the maintainer will reopen the bug report if appropriate.

Debian distribution maintenance software
pp.
Dmitry Shachnev <[email protected]> (supplier of updated sphinx package)

(This message was generated automatically at their request; if you
believe that there is a problem with it please contact the archive
administrators by mailing [email protected])


-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA512

Format: 1.8
Date: Sun, 29 Oct 2017 19:12:40 +0300
Source: sphinx
Binary: python-sphinx python3-sphinx sphinx-common sphinx-doc libjs-sphinxdoc
Architecture: source
Version: 1.6.5-2
Distribution: unstable
Urgency: medium
Maintainer: Debian Python Modules Team 
<[email protected]>
Changed-By: Dmitry Shachnev <[email protected]>
Description:
 libjs-sphinxdoc - JavaScript support for Sphinx documentation
 python-sphinx - documentation generator for Python projects (implemented in 
Pytho
 python3-sphinx - documentation generator for Python projects (implemented in 
Pytho
 sphinx-common - documentation generator for Python projects - common data
 sphinx-doc - documentation generator for Python projects - documentation
Closes: 877637
Changes:
 sphinx (1.6.5-2) unstable; urgency=medium
 .
   * Backport two upstream patches to improve builds reproducibility:
     - reproducible_dicts.diff to sort dictionary keys (closes: #877637).
     - reproducible_epub.diff to make EPUB generation reproducible.
Checksums-Sha1:
 e24c143da197a8a24b506cbf45b946598277f81f 3693 sphinx_1.6.5-2.dsc
 c496bad722383e90def3095ec0804297a9c7fd5d 38132 sphinx_1.6.5-2.debian.tar.xz
 d8b4894d8b6eed32e6804cbfb0f2c15744ba6426 5379 sphinx_1.6.5-2_source.buildinfo
Checksums-Sha256:
 4a4682f430f682b82503fc48099b675de37b4ff139c77b217ff46b37071a457a 3693 
sphinx_1.6.5-2.dsc
 eccbed12b61bdae658b9c60e03ec22b27f4583f61ac4b0ac68c7a5196117f185 38132 
sphinx_1.6.5-2.debian.tar.xz
 3163ddca6db661c23ae51245bacc4529b1faf1e10154bc4bd708b7bc213d1c22 5379 
sphinx_1.6.5-2_source.buildinfo
Files:
 8a584d438c03cba95a304bc671941eda 3693 python optional sphinx_1.6.5-2.dsc
 45f40c2c938ad739dfb3b967b9ef43f2 38132 python optional 
sphinx_1.6.5-2.debian.tar.xz
 f1893425e72b9e88eb1a6774819f2ea8 5379 python optional 
sphinx_1.6.5-2_source.buildinfo

-----BEGIN PGP SIGNATURE-----

iQIzBAEBCgAdFiEEbEPcK+5mZmLK5jNU1v5xA2P4XdMFAln2BdoACgkQ1v5xA2P4
XdOdmg/8C+gDxafaZbpq8bUKqc/b1/uYSvrEMMk4rDPxsdi//kKK2NYdAu890G3t
u1+0xOOcLWu2ifWY7WmKtF2gEJD1sGdOn7TQCvxzataKRKCp1N6HNWIa09y4SQFM
oCfLoP4/KdMdmA5851R/K6lbTfV9sJ7EcLvrJ3pd3J1e0qLWfRdt/oC2oJ917Kmj
QWiLE7kMXIX83F1girJfs8asH//4R+/COJJBPaaTt2HDIjL3JPXeTsH9ee7Pt6kI
O4W2NYGMJ7diyRtxwVW2mW312JIzbIaQfsLNiLheJLVcQ2Qr05bUrog8X1Vl/dYs
5L7MImcQlmIE0vhh/i7yHlEIHhC1XirE1czLwI49tcYSCxFPCu4uFqNx7Vdjz9+S
uo6V8+teAM1+f2mzuPLB1acsRBNbaU/cfdTek9T1X+wYYCBB0TNyC/tskJBQX0R7
ohVMuEb07gsmfqS6UE3aTrcce9PIm55JeC3zfX7O2zZXPY2ORZXxYLM+ua9l8Q8x
aKFZHdlWqwOphw9Pa86tuH0f973jaZNkeQa//7enbLJbYsFdZ8nFNZSSEuHTgTfX
un5lP538v7iD+WNxZ4c9ljBZNaLDB1OlBVmR2yY/hGzDr7ADGx8U44Cp5f2ZYT0R
jqNVd2RP5J4c7Fj4Lk0V0kBQTJPs4dUQqZ5j7ppsvvOJ2ebdhL0=
=oLl4
-----END PGP SIGNATURE-----

--- End Message ---
_______________________________________________
Python-modules-team mailing list
[email protected]
http://lists.alioth.debian.org/cgi-bin/mailman/listinfo/python-modules-team

Reply via email to