Inheritance diagram for scripts.multiemitter.MultiEmitter:

Public Member Functions
	__init__ (self, logging_level=logging.WARNING)

	FileEmitter (self, filename, key=None)

	Associate (self, key, emitter)

	Find (self, key)

	Flush (self, writer=None)

Protected Attributes
	_key_to_emitter

	_filename_to_emitter

Detailed Description

A set of Emitters that write to different files.

Each entry has a key.

file --> emitter
key --> emitter

Definition at line 17 of file multiemitter.py.

Constructor & Destructor Documentation

◆ init()

scripts.multiemitter.MultiEmitter.__init__	(	self,
		logging_level = `logging.WARNING`
	)

Definition at line 27 of file multiemitter.py.

    def __init__(self, logging_level=logging.WARNING):
        self._key_to_emitter = {}  # key -> Emitter
        self._filename_to_emitter = {}  # filename -> Emitter
 
        _logger.setLevel(logging_level)
 

Member Function Documentation

◆ Associate()

scripts.multiemitter.MultiEmitter.Associate	(	self,
		key,
		emitter
	)

Associates a key with an emitter.

Definition at line 51 of file multiemitter.py.

    def Associate(self, key, emitter):
        """Associates a key with an emitter."""
        self._key_to_emitter[key] = emitter
 

◆ FileEmitter()

scripts.multiemitter.MultiEmitter.FileEmitter	(	self,
		filename,
		key = `None`
	)

Creates an emitter for writing to a file.

When this MultiEmitter is flushed, the contents of the emitter are written
to the file.

Arguments:
filename: a string, the path name of the file
key: provides an access key to retrieve the emitter.

Returns: the emitter.

Definition at line 33 of file multiemitter.py.

    def FileEmitter(self, filename, key=None):
        """Creates an emitter for writing to a file.
 
    When this MultiEmitter is flushed, the contents of the emitter are written
    to the file.
 
    Arguments:
      filename: a string, the path name of the file
      key: provides an access key to retrieve the emitter.
 
    Returns: the emitter.
    """
        e = emitter.Emitter()
        self._filename_to_emitter[filename] = e
        if key:
            self.Associate(key, e)
        return e
 

◆ Find()

scripts.multiemitter.MultiEmitter.Find	(	self,
		key
	)

Returns the emitter associated with |key|.

Definition at line 55 of file multiemitter.py.

    def Find(self, key):
        """Returns the emitter associated with |key|."""
        return self._key_to_emitter[key]
 

◆ Flush()

scripts.multiemitter.MultiEmitter.Flush	(	self,
		writer = `None`
	)

Writes all pending files.

Arguments:
writer: a function called for each file and it's lines.

Definition at line 59 of file multiemitter.py.

    def Flush(self, writer=None):
        """Writes all pending files.
 
    Arguments:
      writer: a function called for each file and it's lines.
    """
        if not writer:
            writer = _WriteFile
        for file in sorted(self._filename_to_emitter.keys()):
            emitter = self._filename_to_emitter[file]
            writer(file, emitter.Fragments())
 
 

Member Data Documentation

◆ _filename_to_emitter

scripts.multiemitter.MultiEmitter._filename_to_emitter

protected

Definition at line 29 of file multiemitter.py.

◆ _key_to_emitter

scripts.multiemitter.MultiEmitter._key_to_emitter