Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Do not mangle Python stack traces in sphinx-build #25160

Closed
saraedum opened this issue Apr 13, 2018 · 23 comments
Closed

Do not mangle Python stack traces in sphinx-build #25160

saraedum opened this issue Apr 13, 2018 · 23 comments

Comments

@saraedum
Copy link
Member

This upstreams part of Debian's u2-better-sphinx-failure-modes.patch by Ximin Luo: we should not .strip() the lines that come out of Sphinx because this breaks indent in stack traces. Instead we should only rstrip() to remove the trailing newline.

After this one line change, I also wanted to make this doctestable, so I had to remove the global variable (which at least to me feels like a hack anyway.)

Finally, I added a copyright header sourced from the git log.

CC: @infinity0

Component: doctest framework

Author: Julian Rüth

Branch: 67aff77

Reviewer: Jeroen Demeyer

Issue created by migration from https://trac.sagemath.org/ticket/25160

@saraedum
Copy link
Member Author

Branch: u/saraedum/sphinxbuild-stack

@saraedum
Copy link
Member Author

Commit: 18afd6d

@saraedum
Copy link
Member Author

New commits:

9cc176aDo not break indent on Python stack traces
795cecbMake sphinxbuild.py doctestable
18afd6dAdd COPYRIGHT header

@sagetrac-git
Copy link
Mannequin

sagetrac-git mannequin commented Apr 13, 2018

Changed commit from 18afd6d to 0936a5d

@sagetrac-git
Copy link
Mannequin

sagetrac-git mannequin commented Apr 13, 2018

Branch pushed to git repo; I updated commit sha1. Last 10 new commits:

4e714a2Add checks for binder
84d541cfix README
73b963bPOSIX compliant test, [ instead of [[.
0d5dd3dFix sage-jupyter command in entrypoint
7cb69d7Mention that timings may vary
6a02f35Wrap BaseException so Pool.get() aborts
6a7640dAdd doctest for #25161
fcbfe1cMore standard logging usage
fc5bf18Merge remote-tracking branch 'trac/u/saraedum/docbuild-base-exception' into u/saraedum/gitlabci
0936a5dMerge remote-tracking branch 'trac/u/saraedum/sphinxbuild-stack' into u/saraedum/gitlabci

@sagetrac-git
Copy link
Mannequin

sagetrac-git mannequin commented Apr 13, 2018

Changed commit from 0936a5d to 0477b3c

@sagetrac-git
Copy link
Mannequin

sagetrac-git mannequin commented Apr 13, 2018

Branch pushed to git repo; I updated commit sha1. This was a forced push. New commits:

3f0c2f0Add doctest for #25160
0477b3cCheck for errors before ignoring output

@sagetrac-git
Copy link
Mannequin

sagetrac-git mannequin commented Apr 13, 2018

Branch pushed to git repo; I updated commit sha1. New commits:

ca66c03Revert "Check for errors before ignoring output"

@sagetrac-git
Copy link
Mannequin

sagetrac-git mannequin commented Apr 13, 2018

Changed commit from 0477b3c to ca66c03

@sagetrac-git
Copy link
Mannequin

sagetrac-git mannequin commented Apr 13, 2018

Branch pushed to git repo; I updated commit sha1. New commits:

5881359Remove raise exception logic

@sagetrac-git
Copy link
Mannequin

sagetrac-git mannequin commented Apr 13, 2018

Changed commit from ca66c03 to 5881359

@sagetrac-git
Copy link
Mannequin

sagetrac-git mannequin commented Apr 14, 2018

Changed commit from 5881359 to f46dee4

@sagetrac-git
Copy link
Mannequin

sagetrac-git mannequin commented Apr 14, 2018

Branch pushed to git repo; I updated commit sha1. New commits:

f46dee4Add UTF8 header to silence python warnings

@jdemeyer
Copy link
Contributor

comment:8

I think it would be better to write if self._error is not None instead of if self._error

@sagetrac-git
Copy link
Mannequin

sagetrac-git mannequin commented Apr 21, 2018

Changed commit from f46dee4 to 9dc5282

@sagetrac-git
Copy link
Mannequin

sagetrac-git mannequin commented Apr 21, 2018

Branch pushed to git repo; I updated commit sha1. New commits:

9dc5282Explicitly check for errors

@sagetrac-git
Copy link
Mannequin

sagetrac-git mannequin commented Apr 21, 2018

Changed commit from 9dc5282 to 67aff77

@sagetrac-git
Copy link
Mannequin

sagetrac-git mannequin commented Apr 21, 2018

Branch pushed to git repo; I updated commit sha1. New commits:

67aff77Merge remote-tracking branch 'trac/develop' into sphinxbuild-stack

@jdemeyer
Copy link
Contributor

Reviewer: Jeroen Demeyer

@loefflerd loefflerd mannequin modified the milestones: sage-8.2, sage-8.3 May 17, 2018
@vbraun
Copy link
Member

vbraun commented May 19, 2018

Changed branch from u/saraedum/sphinxbuild-stack to 67aff77

@vbraun vbraun closed this as completed in 9d3cfa6 May 19, 2018
@jdemeyer
Copy link
Contributor

Changed commit from 67aff77 to none

@jdemeyer
Copy link
Contributor

comment:15

Breakage at #27073.

@jdemeyer
Copy link
Contributor

NOTE: doctests ignore whitespace, so this test doesn't actually test the indentation anyway.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants