Tags plugin configuration check and test

[mpd-sima.git] / sima / utils / utils.py

diff --git a/sima/utils/utils.py b/sima/utils/utils.py
index 93bac25e78084dd94b92708fc7c83b5c91daefd8..429b0f9befcce12e7283a5414d155474383afc76 100644 (file)
--- a/sima/utils/utils.py
+++ b/sima/utils/utils.py
@@ -1,6 +1,6 @@
 # -*- coding: utf-8 -*-
 #
 # -*- coding: utf-8 -*-
 #

-# Copyright (c) 2010, 2011, 2013 Jack Kaliko <kaliko@azylum.org>
+# Copyright (c) 2010, 2011, 2013, 2014, 2015, 2020 kaliko <kaliko@azylum.org>

 #
 #  This file is part of sima
 #
 #
 #  This file is part of sima
 #


@@ -20,14 +20,16 @@
 #
 """generic tools and utilities for sima
 """
 #
 """generic tools and utilities for sima
 """

+# pylint: disable=C0111

 
 

+import logging

 import traceback
 import sys
 
 from argparse import ArgumentError, Action
 from base64 import b64decode as push
 from codecs import getencoder
 import traceback
 import sys
 
 from argparse import ArgumentError, Action
 from base64 import b64decode as push
 from codecs import getencoder

-from datetime import datetime, timedelta
+from datetime import datetime

 from os import environ, access, getcwd, W_OK, R_OK
 from os.path import dirname, isabs, join, normpath, exists, isdir, isfile
 from time import sleep
 from os import environ, access, getcwd, W_OK, R_OK
 from os.path import dirname, isabs, join, normpath, exists, isdir, isfile
 from time import sleep


@@ -68,8 +70,7 @@ def normalize_path(path):
 
 def exception_log():
     """Log unknown exceptions"""
 
 def exception_log():
     """Log unknown exceptions"""

-    import logging
-    log = logging.getLogger('sima')
+    log = logging.getLogger(__name__)

     log.error('Unhandled Exception!!!')
     log.error(''.join(traceback.format_exc()))
     log.info('Please report the previous message'
     log.error('Unhandled Exception!!!')
     log.error(''.join(traceback.format_exc()))
     log.info('Please report the previous message'


@@ -78,20 +79,9 @@ def exception_log():
     log.info('Quiting now!')
     sys.exit(1)
 
     log.info('Quiting now!')
     sys.exit(1)
 

-def purge_cache(obj, age=4):
-    now = datetime.utcnow()
-    if now.hour == obj.timestamp.hour:
-        return
-    obj.timestamp = datetime.utcnow()
-    cache = obj.cache
-    delta = timedelta(hours=age)
-    for url in list(cache.keys()):
-        timestamp = cache.get(url).created()
-        if now - timestamp > delta:
-            cache.pop(url)
-

 
 class SigHup(Exception):
 
 class SigHup(Exception):

+    """SIGHUP raises this Exception"""

     pass
 
 # ArgParse Callbacks
     pass
 
 # ArgParse Callbacks


@@ -123,9 +113,11 @@ class Wfile(FileAction):
     """Is file writable
     """
     def checks(self):
     """Is file writable
     """
     def checks(self):

+        if isdir(self._file):
+            self.parser.error('need a file not a directory: {}'.format(self._file))

         if not exists(self._dir):
             #raise ArgumentError(self, '"{0}" does not exist'.format(self._dir))
         if not exists(self._dir):
             #raise ArgumentError(self, '"{0}" does not exist'.format(self._dir))

-            self.parser.error('file does not exist: {0}'.format(self._dir))
+            self.parser.error('directory does not exist: {0}'.format(self._dir))

         if not exists(self._file):
             # Is parent directory writable then
             if not access(self._dir, W_OK):
         if not exists(self._file):
             # Is parent directory writable then
             if not access(self._dir, W_OK):


@@ -158,7 +150,8 @@ class Wdir(FileAction):
         if not access(self._file, W_OK):
             self.parser.error('no write access to "{0}"'.format(self._file))
 
         if not access(self._file, W_OK):
             self.parser.error('no write access to "{0}"'.format(self._file))
 

-class Throttle():
+class Throttle:
+    """throttle decorator"""

     def __init__(self, wait):
         self.wait = wait
         self.last_called = datetime.now()
     def __init__(self, wait):
         self.wait = wait
         self.last_called = datetime.now()


@@ -172,18 +165,24 @@ class Throttle():
             return result
         return wrapper
 
             return result
         return wrapper
 

-class Cache():
-    def __init__(self, elem, last=None):
-        self.elem = elem
-        self.requestdate = last
-        if not last:
-            self.requestdate = datetime.utcnow()
+class MPDSimaException(Exception):
+    pass
+
+# http client exceptions (for webservices)
+class WSError(MPDSimaException):
+    pass
+
+class WSNotFound(WSError):
+    pass

 
 

-    def created(self):
-        return self.requestdate
+class WSTimeout(WSError):
+    pass

 
 

-    def get(self):
-        return self.elem
+class WSHTTPError(WSError):
+    pass
+
+class PluginException(MPDSimaException):
+    pass

 
 # VIM MODLINE
 # vim: ai ts=4 sw=4 sts=4 expandtab
 
 # VIM MODLINE
 # vim: ai ts=4 sw=4 sts=4 expandtab