openPMD/openPMD-api

Handle stdout & stderr messages more pythonic

Open

#192 opened on May 22, 2018

View on GitHubContributor guide
 (1 comment) (1 reaction) (0 assignees)C++ (57 forks)auto 404
discussionfrontend: Python3good first issuehelp wanted

Repository metrics

Stars
 (160 stars)
PR merge metrics
 (PR metrics pending)

Description

Currently (see #191), all output generated by the C++ API is piped to std::cout/std::cerr.

For ideal Python support - which includes pythonic output and logging - one would need to capture the output from C++ and redirect it to message handling facilities in python. This could be Python's stdout/stderr and logging on a very basic level or some advanced implementation that can differentiate and mute multiple levels of output (as present for example in PIConGPU).

Contributor guide

Research direction
Investigate the current stdout/stderr output from the C++ API and explore pybind11's ostream capturing to redirect messages to Python's logging or stdout/stderr for more pythonic handling.
Tech stack
cpppython
Domain
api
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GitC++Pythonpybind11
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
65