search

ionelmc / cookiecutter-pylibrary

Enhanced cookiecutter template for Python libraries.
BSD 2-Clause "Simplified" License
1.25k stars 207 forks source link

Run doctests on all python versions #154

Closed dHannasch closed 5 years ago

dHannasch commented 5 years ago

It seems like if we have doctests, they are part of the test suite and should probably be run with all Python versions used to run the rest of the test suite.

ionelmc commented 5 years ago

Ooof... so there is a reason I didn't do it like this from the beginning - doctests are very fussy and hard to write to run on many python versions. The way it works now is - you either run them in the docs env (the point of them being: avoid broken examples) or you run them via pytest (where you have more options for easier testing). I think that is fine and shouldn't change.

dHannasch commented 5 years ago

doctests are very fussy and hard to write to run on many python versions.

That does sound like a reason to treat doctests as "second-class" tests and not try to make them work on all versions. I've never personally observed the fussiness --- are you talking about things like unicode strings appearing differently in Python 2 output? Would it work to have them run on all py3* envs?

ionelmc commented 5 years ago

Behold: a doctest suite - https://github.com/ionelmc/python-tblib/blob/master/README.rst

I wish I never done something like that, it's a pain in the ass - trying to figure out what to replace with ... to make the damn thing pass in all pythons. That's why doctests should be "second class" - a mere "example not totally broken validation" - to discourage ppl from jumping into something like that.