Reformat common to standardized format

[osm/common.git] / osm_common / fsbase.py

diff --git a/osm_common/fsbase.py b/osm_common/fsbase.py
index 6f82cd3..219dbe1 100644 (file)
--- a/osm_common/fsbase.py
+++ b/osm_common/fsbase.py
@@ -16,7 +16,10 @@
 # limitations under the License.
 
 
+import logging
 from http import HTTPStatus
+from osm_common.common_utils import FakeLock
+from threading import Lock
 
 __author__ = "Alfonso Tierno <alfonso.tiernosepulveda@telefonica.com>"
 
@@ -28,8 +31,24 @@ class FsException(Exception):
 
 
 class FsBase(object):
-    def __init__(self):
-        pass
+    def __init__(self, logger_name="fs", lock=False):
+        """
+        Constructor of FsBase
+        :param logger_name: logging name
+        :param lock: Used to protect simultaneous access to the same instance class by several threads:
+            False, None: Do not protect, this object will only be accessed by one thread
+            True: This object needs to be protected by several threads accessing.
+            Lock object. Use thi Lock for the threads access protection
+        """
+        self.logger = logging.getLogger(logger_name)
+        if not lock:
+            self.lock = FakeLock()
+        elif lock is True:
+            self.lock = Lock()
+        elif isinstance(lock, Lock):
+            self.lock = lock
+        else:
+            raise ValueError("lock parameter must be a Lock class or boolean")
 
     def get_params(self):
         return {}
@@ -43,6 +62,12 @@ class FsBase(object):
     def mkdir(self, folder):
         raise FsException("Method 'mkdir' not implemented")
 
+    def dir_rename(self, src, dst):
+        raise FsException("Method 'dir_rename' not implemented")
+
+    def dir_ls(self, storage):
+        raise FsException("Method 'dir_ls' not implemented")
+
     def file_exists(self, storage):
         raise FsException("Method 'file_exists' not implemented")
 
@@ -57,3 +82,9 @@ class FsBase(object):
 
     def file_delete(self, storage, ignore_non_exist=False):
         raise FsException("Method 'file_delete' not implemented")
+
+    def sync(self, from_path=None):
+        raise FsException("Method 'sync' not implemented")
+
+    def reverse_sync(self, from_path):
+        raise FsException("Method 'reverse_sync' not implemented")