fb-tools 2.4.2__tar.gz → 2.5.0__tar.gz

{fb_tools-2.4.2/lib/fb_tools.egg-info → fb_tools-2.5.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: fb_tools
-Version: 2.4.2
+Version: 2.5.0
 Summary: Modules for common used objects, error classes and methods.
 Home-page: https://github.com/fbrehm/python_fb_tools
 Author: Frank Brehm

{fb_tools-2.4.2 → fb_tools-2.5.0}/lib/fb_tools/__init__.py

@@ -12,8 +12,10 @@ DDNS_CFG_BASENAME = 'ddns.ini'
 MAX_TIMEOUT = 3600
 UTF8_ENCODING = 'utf-8'
 DEFAULT_ENCODING = UTF8_ENCODING
+DEFAULT_TERMINAL_WIDTH = 99
+DEFAULT_TERMINAL_HEIGHT = 40
 
-__version__ = '2.4.2'
+__version__ = '2.5.0'
 
 from .mailaddress import MailAddress, QualifiedMailAddress, MailAddressList     # noqa
 from .multi_config import BaseMultiConfig                                       # noqa

{fb_tools-2.4.2 → fb_tools-2.5.0}/lib/fb_tools/app.py

@@ -38,7 +38,7 @@ from .xlate import __lib_dir__ as __xlate_lib_dir__
 from .xlate import __mo_file__ as __xlate_mo_file__
 from .xlate import __module_dir__ as __xlate_module_dir__
 
-__version__ = '2.2.1'
+__version__ = '2.2.2'
 LOG = logging.getLogger(__name__)
 
 SIGNAL_NAMES = {
@@ -353,6 +353,30 @@ class BaseApplication(HandlingObject):
 
         return res
 
+    # -------------------------------------------------------------------------
+    def _get_log_formatter(self, is_term=True):
+
+        # create formatter
+        if is_term:
+            format_str = ''
+            if self.verbose > 1:
+                format_str = '[%(asctime)s]: '
+            format_str += self.appname + ': '
+        else:
+            format_str = '[%(asctime)s]: ' + self.appname + ': '
+        if self.verbose:
+            if self.verbose > 1:
+                format_str += '%(name)s(%(lineno)d) %(funcName)s() '
+            else:
+                format_str += '%(name)s '
+        format_str += '%(levelname)s - %(message)s'
+        if is_term and self.terminal_has_colors:
+            formatter = ColoredFormatter(format_str)
+        else:
+            formatter = logging.Formatter(format_str)
+
+        return formatter
+
     # -------------------------------------------------------------------------
     def init_logging(self):
         """
@@ -376,22 +400,7 @@ class BaseApplication(HandlingObject):
         root_logger = logging.getLogger()
         root_logger.setLevel(root_loglevel)
 
-        # create formatter
-        format_str = ''
-        if self.verbose:
-            format_str = '[%(asctime)s]: '
-        format_str += self.appname + ': '
-        if self.verbose:
-            if self.verbose > 1:
-                format_str += '%(name)s(%(lineno)d) %(funcName)s() '
-            else:
-                format_str += '%(name)s '
-        format_str += '%(levelname)s - %(message)s'
-        formatter = None
-        if self.terminal_has_colors:
-            formatter = ColoredFormatter(format_str)
-        else:
-            formatter = logging.Formatter(format_str)
+        formatter = self._get_log_formatter()
 
         # create log handler for console output
         lh_console = logging.StreamHandler(sys.stderr)

{fb_tools-2.4.2 → fb_tools-2.5.0}/lib/fb_tools/cfg_app.py

@@ -27,11 +27,17 @@ from .argparse_actions import CfgFileOptionAction
 from .argparse_actions import LogFileOptionAction
 # from .error import FbCfgAppError
 from .common import pp, to_bool
+from .errors import CommonPathError
+from .errors import DirectoryAccessError
+from .errors import DirectoryNotDirError
+from .errors import DirectoryNotExistsError
+from .errors import FileAccessError
+from .errors import FileNotRegularFileError
 from .errors import MultiConfigError
 from .multi_config import BaseMultiConfig
 from .xlate import XLATOR
 
-__version__ = '2.2.5'
+__version__ = '2.3.1'
 LOG = logging.getLogger(__name__)
 
 
@@ -42,6 +48,8 @@ _ = XLATOR.gettext
 class FbConfigApplication(BaseApplication):
     """Class for configured application objects."""
 
+    default_logfile = None
+
     # -------------------------------------------------------------------------
     def __init__(
         self, version=__pkg_version__, cfg_class=BaseMultiConfig, initialized=False,
@@ -58,7 +66,7 @@ class FbConfigApplication(BaseApplication):
         self._use_chardet = True
         self.use_chardet = use_chardet
         self._additional_cfg_file = None
-        self._logfile = None
+        self._logfile = self.default_logfile
         self._cfg_class = cfg_class
         self._append_appname_to_stems = append_appname_to_stems
         self._config_dir = config_dir
@@ -139,10 +147,14 @@ class FbConfigApplication(BaseApplication):
             help=_('Configuration files to use additional to the standard configuration files.'),
         )
 
+        help_txt = _('A logfile for storing all logging output.')
+        if self.default_logfile:
+            help_txt += ' ' + _('Default: {!r}.').format(str(self.default_logfile))
+
         cfg_options.add_argument(
             '--logfile', '--log',
             metavar=_('FILE'), dest='logfile', action=LogFileOptionAction,
-            help=_('A logfile for storing all logging output.'),
+            help=help_txt,
         )
 
     # -------------------------------------------------------------------------
@@ -201,7 +213,11 @@ class FbConfigApplication(BaseApplication):
             self.logfile = self.cfg.logfile.resolve()
 
         if self.logfile:
-            self.init_file_logging()
+            try:
+                self.init_file_logging()
+            except CommonPathError as e:
+                LOG.error(_('Got a {c}: {e}.').format(c=e.__class__.__name__, e=e))
+                self.exit(8)
 
     # -------------------------------------------------------------------------
     def init_file_logging(self):
@@ -209,33 +225,26 @@ class FbConfigApplication(BaseApplication):
         if not self.logfile:
             return
 
+        if not self.do_init_logging:
+            return
+
         logdir = self.logfile.parent
 
         # Checking the parent directory of the Logfile
         if not logdir.exists():
-            msg = _('Directory {!r} does not exists.').format(str(logdir))
-            LOG.error(msg)
-            self.exit(6)
+            raise DirectoryNotExistsError(logdir)
         if not logdir.is_dir():
-            msg = _('Path {!r} exists, but is not a directory.').format(str(logdir))
-            LOG.error(msg)
-            self.exit(6)
+            raise DirectoryNotDirError(logdir)
 
         # Checking logfile, if it is already existing
         if self.logfile.exists():
             if not self.logfile.is_file():
-                msg = _('File {!r} is not a regular file.').format(str(self.logfile))
-                LOG.error(msg)
-                self.exit(6)
+                raise FileNotRegularFileError(self.logfile)
             if not os.access(self.logfile, os.W_OK):
-                msg = _('File {!r} is not writeable.').format(self.logfile)
-                LOG.error(msg)
-                self.exit(6)
+                raise FileAccessError(self.logfile, _('file is not writeable.'))
         else:
             if not os.access(logdir, os.W_OK):
-                msg = _('Directory {!r} is not writeable.').format(str(logdir))
-                LOG.error(msg)
-                self.exit(6)
+                raise DirectoryAccessError(logdir, _('no write access to directory.'))
 
         LOG.debug(_('Start logging into file {!r} ...').format(str(self.logfile)))
 

{fb_tools-2.4.2 → fb_tools-2.5.0}/lib/fb_tools/common.py

@@ -34,10 +34,10 @@ except ImportError:
 import six
 
 # Own modules
-
+from .errors import InvalidTimeIntervalError
 from .xlate import XLATOR
 
-__version__ = '2.0.2'
+__version__ = '2.1.0'
 
 _ = XLATOR.gettext
 
@@ -91,6 +91,18 @@ RE_UNIT_EIBYTES = re.compile(r'^\s*Ei(?:B(?:yte)?)?\s*$', re.IGNORECASE)
 RE_UNIT_ZBYTES = re.compile(r'^\s*Z(?:B(?:yte)?)?\s*$', re.IGNORECASE)
 RE_UNIT_ZIBYTES = re.compile(r'^\s*Zi(?:B(?:yte)?)?\s*$', re.IGNORECASE)
 
+DEBUG_TIMEINTERVAL2DELTA = False
+
+RE_UNIT_TIME_SECOND = re.compile(
+    r'\s*(\d+(?:\.\d*)?)\s*(?:s(?:ec(?:onds?)?)?)?(?:\s*,)?', re.IGNORECASE)
+RE_UNIT_TIME_MINUTE = re.compile(
+    r'\s*(\d+(?:\.\d*)?)\s*m(?:in(?:utes?)?)?(?:\s*,)?', re.IGNORECASE)
+RE_UNIT_TIME_HOUR = re.compile(r'\s*(\d+(?:\.\d*)?)\s*h(?:ours?)?(?:\s*,)?', re.IGNORECASE)
+RE_UNIT_TIME_DAY = re.compile(r'\s*(\d+(?:\.\d*)?)\s*d(?:ays?)?(?:\s*,)?', re.IGNORECASE)
+RE_UNIT_TIME_WEEK = re.compile(r'\s*(\d+(?:\.\d*)?)\s*w(?:eeks?)?(?:\s*,)?', re.IGNORECASE)
+RE_UNIT_TIME_MONTH = re.compile(r'\s*(\d+(?:\.\d*)?)\s*mon(?:ths?)?(?:\s*,)?', re.IGNORECASE)
+RE_UNIT_TIME_YEAR = re.compile(r'\s*(\d+(?:\.\d*)?)\s*y(?:ears?)?(?:\s*,)?', re.IGNORECASE)
+
 
 # =============================================================================
 def pp(value, indent=4, width=99, depth=None):
@@ -842,6 +854,123 @@ def indent(text, prefix, initial_prefix=None, predicate=None):
 
     return ''.join(lines)
 
+# =============================================================================
+def set_debug_timeinterval2delta(enable_debug=False):
+    """Set the module property DEBUG_TIMEINTERVAL2DELTA to a boolean value."""
+    global DEBUG_TIMEINTERVAL2DELTA
+
+    if to_bool(enable_debug):
+        DEBUG_TIMEINTERVAL2DELTA = True
+    else:
+        DEBUG_TIMEINTERVAL2DELTA = False
+
+# =============================================================================
+def timeinterval2delta(interval):
+    """
+    Try to convert the given textual time interval into a datetime.timeinterval object.
+
+    The interval may consists of tokens of float values with a measurement unit.
+    If a token is a float value without a measurement unit, then seconds are assumed.
+    Valid measurement units (as regular expressions) are:
+    * 's(ec(onds?)?)?'
+    * 'm(in(utes?)?)?' == 60 seconds
+    * 'h(ours?)*' == 3600 seconds
+    * 'd(ays?)?' == 3600 * 24 seconds
+    * 'w(eeks?)?' == 3600 * 24 * 7 seconds
+    * 'mon(ths?)?' == 3600 * 24 * 30 seconds
+    * 'y(ears?)?' == 3600 * 24 * 365 seconds
+
+    @raise InvalidTimeIntervalError: if the interval could not be interpreted
+    """
+    if interval is None:
+        raise InvalidTimeIntervalError(None)
+    intrvl = str(interval).strip()
+    if intrvl == '':
+        raise InvalidTimeIntervalError(interval)
+
+    seconds = 0
+
+    if DEBUG_TIMEINTERVAL2DELTA:
+        LOG.debug('Start value: {!r}'.format(intrvl))
+
+    m = RE_UNIT_TIME_YEAR.search(intrvl)
+    if m:
+        years = float(m[1])
+        intrvl = RE_UNIT_TIME_YEAR.sub('', intrvl, 1)
+        seconds += years * 3600 * 24 * 365
+        if DEBUG_TIMEINTERVAL2DELTA:
+            LOG.debug(
+                'After year: match {m!r}, years {y!r}, new value {i!r}, new secs {s}.'.format(
+                    m=m[1], y=years, i=intrvl, s=seconds))
+
+    m = RE_UNIT_TIME_MONTH.search(intrvl)
+    if m:
+        months = float(m[1])
+        intrvl = RE_UNIT_TIME_MONTH.sub('', intrvl, 1)
+        seconds += months * 3600 * 24 * 30
+        if DEBUG_TIMEINTERVAL2DELTA:
+            LOG.debug(
+                'After months: match {m!r}, months {mo!r}, new value {i!r}, new secs {s}.'.format(
+                    m=m[1], mo=months, i=intrvl, s=seconds))
+
+    m = RE_UNIT_TIME_WEEK.search(intrvl)
+    if m:
+        weeks = float(m[1])
+        intrvl = RE_UNIT_TIME_WEEK.sub('', intrvl, 1)
+        seconds += weeks * 3600 * 24 * 7
+        if DEBUG_TIMEINTERVAL2DELTA:
+            LOG.debug(
+                'After weeks: match {m!r}, weeks {w!r}, new value {i!r}, new secs {s}.'.format(
+                    m=m[1], w=weeks, i=intrvl, s=seconds))
+
+    m = RE_UNIT_TIME_DAY.search(intrvl)
+    if m:
+        days = float(m[1])
+        intrvl = RE_UNIT_TIME_DAY.sub('', intrvl, 1)
+        seconds += days * 3600 * 24
+        if DEBUG_TIMEINTERVAL2DELTA:
+            LOG.debug(
+                'After days: match {m!r}, days {d!r}, new value {i!r}, new secs {s}.'.format(
+                    m=m[1], d=days, i=intrvl, s=seconds))
+
+    m = RE_UNIT_TIME_HOUR.search(intrvl)
+    if m:
+        hours = float(m[1])
+        intrvl = RE_UNIT_TIME_HOUR.sub('', intrvl, 1)
+        seconds += hours * 3600
+        if DEBUG_TIMEINTERVAL2DELTA:
+            LOG.debug(
+                'After hours: match {m!r}, hours {h!r}, new value {i!r}, new secs {s}.'.format(
+                    m=m[1], h=hours, i=intrvl, s=seconds))
+
+    m = RE_UNIT_TIME_MINUTE.search(intrvl)
+    if m:
+        minutes = float(m[1])
+        intrvl = RE_UNIT_TIME_MINUTE.sub('', intrvl, 1)
+        seconds += minutes * 60
+        if DEBUG_TIMEINTERVAL2DELTA:
+            LOG.debug(
+                'After minutes: match {m!r}, minutes {mi!r}, new value {i!r}, '
+                'new secs {s}.'.format(m=m[1], mi=minutes, i=intrvl, s=seconds))
+
+    m = RE_UNIT_TIME_SECOND.search(intrvl)
+    if m:
+        secs = float(m[1])
+        intrvl = RE_UNIT_TIME_SECOND.sub('', intrvl, 1)
+        seconds += secs
+        if DEBUG_TIMEINTERVAL2DELTA:
+            LOG.debug(
+                'After seconds: match {m!r}, seconds {se!r}, new value {i!r}, '
+                'new secs {s}.'.format(m=m[1], se=secs, i=intrvl, s=seconds))
+
+    intrvl = intrvl.strip()
+    if DEBUG_TIMEINTERVAL2DELTA:
+        LOG.debug('Final value: {i!r}, seconds at last: {s}'.format(i=intrvl, s=seconds))
+    if intrvl != '':
+        raise InvalidTimeIntervalError(interval)
+
+    return datetime.timedelta(seconds=seconds)
+
 
 # =============================================================================