Consider adding `doctest.skip_if` decorator
@sobolevn ci sta già lavorando.
Dal 29/3/2024.
- Lingua principale
- Python
- Stelle
- 77.2k
- Fork
- 35.9k
- Metriche di merge delle PR
- Metriche PR in attesa
Descrizione
Feature or enhancement
Right now there's no way to skip the whole test / class doctest. You can only skip individual statements with # doctest: +SKIP
This causes problems in several use-cases:
- You have a doctest that should be skipped based on the platform
- We have doctests that should be skipped based on a resource availability
- Libraries might want to skip some doctests based on the Python version / any other lib version
Right now we have this hack:
However, this is just test functions. For library functions it would be much harder to do.
You have to jiggle __doc__ attribute around.
Since https://github.com/python/cpython/pull/117297 we now have correct skipped count for doctest + unittest integration.
So, I propose adding this decorator to doctest.py
def skip_if(condition):
def decorator(func):
if condition and HAVE_DOCSTRINGS:
func.__doc__ = ">>> pass # doctest: +SKIP"
return func
return decorator
It will allow us skipping some tests conditionally with the proper reported results.
Refs https://github.com/python/cpython/pull/116758
CC @serhiy-storchaka and @furkanonder
Linked PRs
- gh-122935
Guida per i contributori
Apri la guida per i contributori
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Valutazione
Questa issue non è ancora stata valutata.