Support an alternative to invisible-code-block for doctests

[Adrián Chaves]

It took me a while to realize that invisible-code-block only works with code blocks.

As far as I can tell, it is currently not possible to write invisible code as context for a documentation example that has lines of output.

[Chris Withers]

Can you give a simple example or two of what you're looking to do and what your proposed solution would look like?

[Adrián Chaves]

I tried to do this:

.. invisible-code-block: python
    remember_me = b'see how namespaces work?'

>>> remember_me
b'see how namespaces work?'

or

.. invisible-code-block: python
    remember_me = b'see how namespaces work?'

::

    >>> remember_me
    b'see how namespaces work?'

But I am told that “remember_me” is undefined, because it seems to work only for code-block, which does not allow to perform output check, as far as I know.

[Chris Withers]

I'll looks like you're missing the whitespace line after .. invisible-code-block, here's an example of invisible code blocks and doctest sections interacting on the same namespace:

https://github.com/Simplistix/testfixtures/blob/master/docs/comparing.txt#L440-L464

What test runner are you using? pytest -v shows what blocks are being picked up, if your invisible code block isn't there, it's not correctly formatted.

[Adrián Chaves]

It works indeed. Thanks!!!

[Adrián Chaves]

For the record, I believe the underlying issue was not actually Sybil, but pytest using regular doctest. I was accidentally combining both type of tests, Sybil’s were picking up the hidden code, but doctest’s was not, and I though it was Sybil as well.

[Chris Withers]

Oh yes, now that you mention it, I remember this and it's a pretty frustating bug in pytest:
pytest-dev/pytest#4954 (comment)
Please follow up there in the hope it might get some priority :-)

[Chris Withers]

Following up on this a long while later, adding addopts = -p no:doctest to your pytest config gets its doctest parser out of the way.