improving example output (rootdir: $REGENDOC_TMPDIR)?

[obestwalter]

Since 2.8 example output looks like this:

======= test session starts ========
platform linux -- Python 3.4.3, pytest-2.8.7, py-1.4.31, pluggy-0.3.1
rootdir: $REGENDOC_TMPDIR, inifile:
collected 0 items
======= no tests ran in 0.12 seconds ========

before it looked like this:

=========================== test session starts ============================
platform linux -- Python 3.4.1 -- py-1.4.27 -- pytest-2.7.1
rootdir: /tmp/doc-exec-162, inifile:
collected 0 items

This is basically a cosmetic thing, but I think it would be better to have something looking like a real path there again to decrease the confusion potential - especially for newcomers.

Might also be an easy first issue for someone wanting to make themselves familiar with some of pytests build tools?

[pytestbot]

GitMate.io thinks a possibly related issue is #62 (better html output for examples (sphinx highlighter)).

[nicoddemus]

Hi @obestwalter,

I agree that using a real path would be better.

I thought this would be configured here:

pytest/doc/en/Makefile

Lines 15 to 23 in 4d0297b

	REGENDOC_ARGS := \
	--normalize "/in \d+.\d+ seconds/in 0.12 seconds/" \
	--normalize "@/tmp/pytest-of-.*/pytest-\d+@PYTEST_TMPDIR@" \
	--normalize "@pytest-(\d+)\\.[^ ,]+@pytest-\1.x.y@" \
	--normalize "@(This is pytest version )(\d+)\\.[^ ,]+@\1\2.x.y@" \
	--normalize "@py-(\d+)\\.[^ ,]+@py-\1.x.y@" \
	--normalize "@pluggy-(\d+)\\.[.\d,]+@pluggy-\1.x.y@" \
	--normalize "@hypothesis-(\d+)\\.[.\d,]+@hypothesis-\1.x.y@" \
	--normalize "@Python (\d+)\\.[^ ,]+@Python \1.x.y@"

But it doesn't seem to be the case. I'm sure @RonnyPfannschmidt knows where this is configured though.

[RonnyPfannschmidt]

@obestwalter at each execution its a different folder, thats simpy not directly usable

im happy to accept a pr to regendoc to fix this to something more visually pleasing

[nicoddemus]

Yeah, I think the idea is to hard-code a folder: /tmp/regendoc for example

[nicoddemus]

If anybody wants to give this a try:

https://bitbucket.org/pytest-dev/regendoc/src/2c4caebaee58674fcc38986a66018cf8020c2c58/regendoc/__init__.py#lines-102:116

https://github.com/pytest-dev/regendoc/blob/b1f13cebff6f19c782ee92c3f72de6c1ccbe2dfb/regendoc/__init__.py#L102-L116

[RonnyPfannschmidt]

@nicoddemus its already on github https://github.com/pytest-dev/regendoc/

[nicoddemus]

Oh right, even better then 😁

[obestwalter]

If all occurrences can be replaced with something generic I would go for something like /path/to/project to make clear that this is a generic example folder in a documentation snippet (and that the root is usually the root of your project).

[RonnyPfannschmidt]

@obestwalter i disagree, since its not the project dir in that case

edit: s/sine/since/

[nicoddemus]

@RonnyPfannschmidt sorry, what do you mean by sine?

rootdir: $REGENDOC_TMPDIR, inifile:

I agree with @obestwalter that rootdir: /path/to/project seems appropriate... do you have another thing in mind?

[RonnyPfannschmidt]

/path/to/example

[obestwalter]

Also good :)

[obestwalter]

Thanks for the fix @aswinm - closing this then :)