fail2ban.helpers module
***********************

class fail2ban.helpers.FormatterWithTraceBack(fmt, *args, **kwargs)

   Bases: "logging.Formatter"

   Custom formatter which expands %(tb) and %(tbc) with tracebacks

   TODO: might need locking in case of compressed tracebacks

   -[ Methods ]-

   +------------+--------------------------------------------------------------------------------------------+
   | "converte  | Convert seconds since the Epoch to a time tuple expressing local time.                     |
   | r"([secon  |                                                                                            |
   | ds])       |                                                                                            |
   +------------+--------------------------------------------------------------------------------------------+
   | "format"(  | Format the specified record as text.                                                       |
   | self,      |                                                                                            |
   | record)    |                                                                                            |
   +------------+--------------------------------------------------------------------------------------------+
   | "formatEx  | Format and return the specified exception information as a string.                         |
   | ception"(  |                                                                                            |
   | self, ei)  |                                                                                            |
   +------------+--------------------------------------------------------------------------------------------+
   | "formatSt  | This method is provided as an extension point for specialized formatting of stack          |
   | ack"(self, | information.                                                                               |
   | stack_inf  |                                                                                            |
   | o)         |                                                                                            |
   +------------+--------------------------------------------------------------------------------------------+
   | "formatTi  | Return the creation time of the specified LogRecord as formatted text.                     |
   | me"(self,  |                                                                                            |
   | record[,   |                                                                                            |
   | datefmt])  |                                                                                            |
   +------------+--------------------------------------------------------------------------------------------+
   | "usesTime  | Check if the format uses the creation time of the record.                                  |
   | "(self)    |                                                                                            |
   +------------+--------------------------------------------------------------------------------------------+

   +-------------------+------------+
   | **formatMessage** |            |
   +-------------------+------------+

   converter([seconds]) -> (tm_year,tm_mon,tm_mday,tm_hour,tm_min, tm_sec,tm_wday,tm_yday,tm_isdst)

      Convert seconds since the Epoch to a time tuple expressing local
      time. When 'seconds' is not passed in, convert the current time
      instead.

   default_msec_format = '%s,%03d'

   default_time_format = '%Y-%m-%d %H:%M:%S'

   format(self, record)

      Format the specified record as text.

      The record's attribute dictionary is used as the operand to a
      string formatting operation which yields the returned string.
      Before formatting the dictionary, a couple of preparatory steps
      are carried out. The message attribute of the record is computed
      using LogRecord.getMessage(). If the formatting string uses the
      time (as determined by a call to usesTime(), formatTime() is
      called to format the event time. If there is exception
      information, it is formatted using formatException() and
      appended to the message.

   formatException(self, ei)

      Format and return the specified exception information as a
      string.

      This default implementation just uses
      traceback.print_exception()

   formatMessage(self, record)

   formatStack(self, stack_info)

      This method is provided as an extension point for specialized
      formatting of stack information.

      The input data is a string as returned from a call to
      "traceback.print_stack()", but with the last trailing newline
      removed.

      The base implementation just returns the value passed in.

   formatTime(self, record, datefmt=None)

      Return the creation time of the specified LogRecord as formatted
      text.

      This method should be called from format() by a formatter which
      wants to make use of a formatted time. This method can be
      overridden in formatters to provide for any specific
      requirement, but the basic behaviour is as follows: if datefmt
      (a string) is specified, it is used with time.strftime() to
      format the creation time of the record. Otherwise, an
      ISO8601-like (or RFC 3339-like) format is used. The resulting
      string is returned. This function uses a user-configurable
      function to convert the creation time to a tuple. By default,
      time.localtime() is used; to change this for a particular
      formatter instance, set the 'converter' attribute to a function
      with the same signature as time.localtime() or time.gmtime(). To
      change it for all formatters, for example if you want all
      logging times to be shown in GMT, set the 'converter' attribute
      in the Formatter class.

   usesTime(self)

      Check if the format uses the creation time of the record.

class fail2ban.helpers.TraceBack(compress=False)

   Bases: "object"

   Customized traceback to be included in debug messages

   -[ Methods ]-

   +------------+--------------------------------------------------------------------------------------------+
   | "__call__  | Call self as a function.                                                                   |
   | "(self)    |                                                                                            |
   +------------+--------------------------------------------------------------------------------------------+

fail2ban.helpers.excepthook(exctype, value, traceback)

   Except hook used to log unhandled exceptions to Fail2Ban log

fail2ban.helpers.formatExceptionInfo()

   Consistently format exception information

fail2ban.helpers.getLogger(name)

   Get logging.Logger instance with Fail2Ban logger name convention

fail2ban.helpers.mbasename(s)

   Custom function to include directory name if filename is too common

   Also strip .py at the end

fail2ban.helpers.splitwords(s)

   Helper to split words on any comma, space, or a new line

   Returns empty list if input is empty (or None) and filters out
   empty entries
