journal

Package Contents

journal.copyright()

Return the pyre journal copyright note

journal.license()

Print the pyre journal license

journal.version()

Return the pyre journal version

journal._journal_version = [1, 0, 0]
journal._journal_license = pyre journal 1.0 Copyright (c) 1998-2019 Michael A.G. Aïvázis All Rights Reserved

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

  • Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
  • Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
  • Neither the name pyre nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS “AS IS” AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

journal.boot()

Initialize the journal package.

Attempt to locate the C++ extension and use it if available; fall back on the pure python implementation. Either way, return a marker that enables clients to check whether there is support for journal messages from C/C++/FORTRAN.

journal.package
class journal.debug

Bases: journal.Diagnostic.Diagnostic, journal.Channel.Channel

This class is the implementation of the debug channel

severity = debug
_index
class journal.firewall

Bases: journal.Diagnostic.Diagnostic, journal.Channel.Channel

This class is the implementation of the firewall channel

fatal = False
severity = firewall
_index
stackdepth
log(self, message=None, stackdepth=0)

Record my message to my device

class journal.info

Bases: journal.Diagnostic.Diagnostic, journal.Channel.Channel

This class is the implementation of the info channel

severity = info
_index
class journal.warning

Bases: journal.Diagnostic.Diagnostic, journal.Channel.Channel

This class is the implementation of the warning channel

severity = warning
_index
class journal.error

Bases: journal.Diagnostic.Diagnostic, journal.Channel.Channel

This class is the implementation of the error channel

severity = error
_index
stackdepth
log(self, message=None, stackdepth=0)

Make a journal entry and build an exception ready to be raised by the caller

class journal.console

Bases: pyre.component

A device that sends journal messages to the standard output

renderer
doc = the formatting strategy for journal entries
record(self, page, metadata)

Record a journal entry

class journal.file

Bases: pyre.component

This is a sample documentation string for class Console

log
doc = the file in which to save the journal entries
renderer
doc = the formatting strategy for journal entries
record(self, page, metadata)

Record a journal entry

exception journal.FirewallError(firewall, **kwds)

Bases: pyre.framework.exceptions.PyreError

Exception raised whenever a fatal firewall is encountered

description = firewall breached; aborting...
journal.extension