Skip to content

Commit

Permalink
Add warning about pipeline stalling (#640)
Browse files Browse the repository at this point in the history
  • Loading branch information
astaric committed May 30, 2023
1 parent c2c2275 commit 33f0083
Showing 1 changed file with 9 additions and 0 deletions.
9 changes: 9 additions & 0 deletions docs/local_commands.rst
Expand Up @@ -99,6 +99,15 @@ using ``|`` (bitwise-or)::
>>> chain()
'-rw-r--r-- 1 sebulba Administ 0 Apr 27 11:54 setup.py\n'

.. note::
Unlike common posix shells, plumbum only captures stderr of the last command in a pipeline.
If any of the other commands writes a large amount of text to the stderr, the whole pipeline
will stall (large amount equals to >64k on posix systems). This can happen with bioinformatics
tools that write progress information to stderr. To avoid this issue, you can discard stderr
of the first commands or redirect it to a file.

>>> chain = (bwa["mem", ...] >= "/dev/null") | samtools["view", ...]

.. _guide-local-commands-redir:

Input/Output Redirection
Expand Down

0 comments on commit 33f0083

Please sign in to comment.