Bug#1066016: python-rdflib-doc: please make the build reproducible.

2024-03-14 Thread Michael R. Crusoe

control: repopen -1

On Thu, 14 Mar 2024 13:04:29 + James Addison  wrote:
> Hi Michael,
>
> Thank you for merging and uploading this change. Unfortunately it 
seems that
> my suggestion didn't solve the problem (based on inspecting the 
results of a
> recent reprotest[1] on Salsa - there's still a 'identifier=>' with

> randomness in the built documentation).
>
> That's my mistake for not testing the patch thoroughly enough. Please 
let me

> know how to proceed (for example, whether you'd prefer that I revert the
> change).

Well, the build failed, so the CI on Salsa wasn't able to test your MR. 
No worries, it isn't your fault!


I think the patch still helped, we can keep it while you continue your 
investigations. I really appreciate it!



--
Michael R. Crusoe



OpenPGP_signature.asc
Description: OpenPGP digital signature


Bug#1066016: python-rdflib-doc: please make the build reproducible.

2024-03-14 Thread James Addison
Package: python-rdflib-doc
Followup-For: Bug #1066016
X-Debbugs-Cc: cru...@debian.org

Hi Michael,

Thank you for merging and uploading this change.  Unfortunately it seems that
my suggestion didn't solve the problem (based on inspecting the results of a
recent reprotest[1] on Salsa - there's still a '' with
randomness in the built documentation).

That's my mistake for not testing the patch thoroughly enough.  Please let me
know how to proceed (for example, whether you'd prefer that I revert the
change).

This also means that the autodoc config setting may be more limited in
solving these kind of problems that I realized; I'll have to check some merge
requests that I have open for other packages.

Thank you,
James

[1] - https://salsa.debian.org/python-team/packages/rdflib/-/jobs/5445372



Bug#1066016: python-rdflib-doc: please make the build reproducible.

2024-03-10 Thread James Addison
Followup-For: Bug #1066016
Control: forwarded -1 
https://salsa.debian.org/python-team/packages/rdflib/-/merge_requests/2



Bug#1066016: python-rdflib-doc: please make the build reproducible.

2024-03-10 Thread James Addison
Package: python-rdflib-doc
Severity: wishlist
Tags: patch upstream
User: reproducible-bui...@lists.alioth.debian.org
Usertags: randomness

Dear Maintainer,

I'm an occasional volunteer contributor with the Reproducible Builds[1]
project, and noticed recently that the python-rdflib-doc package failed[2] an
automated reproducibility test on Debian.

>From investigation, it seems that most if not all of the cause of
non-reproducibility during the test was due to the Sphinx autodoc extension
evaluating some of the default Python method values (like
rdflib.extras.infixowl.Individual.factoryGraph[3]) at build-time and including
theevaluated value, which varied, in the documentation.

As a workaround, we can enable the 'autodoc_preserve_defaults'[4] configuration
setting, meaning that Sphinx will render the method signature defaults using the
original source code as-written, instead of evaluating the corresponding
values.

I'll offer a merge request on Salsa to make that change, and will link that to
this bugreport.

Thanks,
James

[1] - https://reproducible-builds.org/

[2] - 
https://tests.reproducible-builds.org/debian/rb-pkg/trixie/amd64/diffoscope-results/rdflib.html

[3] - https://sources.debian.org/src/rdflib/6.1.1-3/docs/conf.py/#L41
  
https://sources.debian.org/src/rdflib/6.1.1-3/rdflib/extras/infixowl.py/#L371

[4] - 
https://www.sphinx-doc.org/en/master/usage/extensions/autodoc.html#confval-autodoc_preserve_defaults