skchem.utils.Suppressor

Complexity

Total Complexity

4

Size/Duplication

Total Lines	28
Duplicated Lines	0 %

3 Methods

Rating	Name	Duplication	Size	Complexity
A	Suppressor.__init__()	0	5	2
A	Suppressor.__exit__()	0	7	1
A	Suppressor.__enter__()	0	4	1

#! /usr/bin/env python
#
# Copyright (C) 2007-2009 Rich Lewis <rl403@cam.ac.uk>
# License: 3-clause BSD

"""
skchem.utils.suppress

Class for suppressing C extensions output
"""
import os

##
# Taken from:
# http://stackoverflow.com/questions/11130156/suppress-stdout-stderr-print-from-python-functions
##

class Suppressor(object):
    """
    A context manager for doing a "deep suppression" of stdout and stderr in
    Python, i.e. will suppress all print, even if the print originates in a
    compiled C/Fortran sub-function.
       This will not suppress raised exceptions, since exceptions are printed
    to stderr just before a script exits, and after the context manager has
    exited (at least, I think that is why it lets exceptions through).
    """

    def __init__(self):
        # Open a pair of null files
        self.null_fds = [os.open(os.devnull, os.O_RDWR) for _ in range(2)]
        # Save the actual stdout (1) and stderr (2) file descriptors.
        self.save_fds = (os.dup(1), os.dup(2))

    def __enter__(self):
        # Assign the null pointers to stdout and stderr.
        os.dup2(self.null_fds[0], 1)
        os.dup2(self.null_fds[1], 2)

    def __exit__(self, *_):
        # Re-assign the real stdout/stderr back to (1) and (2)
        os.dup2(self.save_fds[0], 1)
        os.dup2(self.save_fds[1], 2)
        # Close the null files
        os.close(self.null_fds[0])
        os.close(self.null_fds[1])