nteract/papermill

Running tests produces lots of output

Open

#228 opened on Oct 8, 2018

View on GitHub
 (3 comments) (0 reactions) (0 assignees)Python (5,381 stars) (402 forks)batch import
enhancementhelp wantednew-contributor-friendly

Description

I just setup a new dev environment for papermill with conda create ... and then pip install -r requirements-dev.txt and executed pytest in the top level directory of the repository.

The tests pass but I end up with several screens full of:

/Users/username/miniconda/envs/papermill/lib/python3.6/importlib/_bootstrap.py:219: ImportWarning: can't resolve package from __spec__ or __package__, falling back on __name__ and __path__
  return f(*args, **kwds)

and other warnings that come from papermill itself like:

/Users/username/git/nteract/papermill/papermill/iorw.py:46: UserWarning: The specified input file (/Users/username/git/nteract/papermill/papermill/tests/parameters/example.yaml) does not end in '.ipynb' or '.json'
  "The specified input file ({}) does not end in '.ipynb' or '.json'".format(path)

Does anyone know what causes the first kind of error/console output? I'd like to work on removing/reducing it. Lots of noisy output from our tests that is "known to be harmless" trains us in ignoring the output (at least it trains me to do that). The warnings from inside papermill are probably easier to track down/capture.

Contributor guide

Tech stack
python
Domain
testingdeveloper experience
Issue type
refactor
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
pytestPython warningspapermill test suite
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75
Research direction
Investigate pytest configuration in papermill to suppress ImportWarning by adding filterwarnings in pytest.ini or conftest.py. For the UserWarning from iorw.py, consider modifying the warning to only appear in non test contexts, or update the test to use proper file extensions. Review the test suite to identify all sources of noisy output and apply appropriate fixes.