pyrelukko 0.6.1__py3-none-any.whl → 0.8.0__py3-none-any.whl

pyrelukko/{retry.py → decorators.py}

@@ -1,6 +1,7 @@
 """
 TBD
 """
+import os
 import time
 from functools import wraps
 
@@ -43,3 +44,38 @@ def retry(logger, exceptions, tries=4, delay=5,
             return f(*args, **kwargs)
         return f_retry  # true decorator
     return deco_retry
+
+
+SKIP_RELUKKO = {
+    "id": "00000000-0000-0000-0000-000000000000",
+    "lock_name": "WE TRUST YOU",
+    "creator": "Dummy Dummy",
+    "ip": "0.0.0.0",
+    "expires_at": "1970-01-01T00:00:00Z",
+    "created_at": "1970-01-01T00:00:00Z",
+    "updated_at": "1970-01-01T00:00:00Z"
+}
+
+
+def skip_http_call():
+    """
+    Decorator for pyrlukko methods.
+
+    It skips the actual method if the environment variable
+    `RELUKKO_TRUST_ME_IT_IS_LOCKED` is set and returns instead a static lock
+    dictionary or list with the same static lock dictionary.
+
+    Useful when developing and the resource is for sure locked, e.g through the
+    Web UI.
+    """
+    def deco_skip(f):
+
+        @wraps(f)
+        def f_skip(*args, **kwargs):
+            if os.environ.get('RELUKKO_TRUST_ME_IT_IS_LOCKED'):
+                if f.__name__ == "get_locks":
+                    return [ SKIP_RELUKKO ]
+                return SKIP_RELUKKO
+            return f(*args, **kwargs)
+        return f_skip  # true decorator
+    return deco_skip

pyrelukko/pyrelukko.py

@@ -18,7 +18,7 @@ from urllib3.util.retry import Retry
 from websockets import ConnectionClosed as WsConnectionClosed
 from websockets.asyncio.client import connect as ws_connect
 
-from .retry import retry
+from .decorators import retry, skip_http_call
 
 SSL_KWARGS = [
     'check_hostname',
@@ -300,6 +300,7 @@ class RelukkoClient:
 
         return _do_request()
 
+    @skip_http_call()
     def acquire_relukko(self, lock_name, creator, max_run_time):
         """
         TBD
@@ -336,6 +337,7 @@ class RelukkoClient:
             return thread_store[0]
         return None
 
+    @skip_http_call()
     def get_lock(self, lock_id: str) -> Dict:
         """
         TBD
@@ -343,6 +345,7 @@ class RelukkoClient:
         url = f"{self.base_url}/v1/locks/{lock_id}"
         return self._make_request(url, "GET")
 
+    @skip_http_call()
     def get_locks(self)  -> List:
         """
         TBD
@@ -350,6 +353,7 @@ class RelukkoClient:
         url = f"{self.base_url}/v1/locks/"
         return self._make_request(url, "GET")
 
+    @skip_http_call()
     def update_relukko(
             self, lock_id: str, creator: str=None, expires_at: datetime=None):
         """
@@ -367,6 +371,7 @@ class RelukkoClient:
         url = f"{self.base_url}/v1/locks/{lock_id}"
         return self._make_request(url, "PUT", payload)
 
+    @skip_http_call()
     def delete_relukko(self, lock_id: str):
         """
         TBD
@@ -374,6 +379,7 @@ class RelukkoClient:
         url = f"{self.base_url}/v1/locks/{lock_id}"
         return self._make_request(url, "DELETE")
 
+    @skip_http_call()
     def keep_relukko_alive(self, lock_id: str):
         """
         TBD
@@ -381,6 +387,7 @@ class RelukkoClient:
         url = f"{self.base_url}/v1/locks/{lock_id}/keep_alive"
         return self._make_request(url, "GET")
 
+    @skip_http_call()
     def keep_relukko_alive_put(self, lock_id: str, seconds: int):
         """
         TBD
@@ -391,6 +398,7 @@ class RelukkoClient:
         }
         return self._make_request(url, "PUT", payload)
 
+    @skip_http_call()
     def add_to_expires_at_time(self, lock_id: str):
         """
         TBD
@@ -398,6 +406,7 @@ class RelukkoClient:
         url = f"{self.base_url}/v1/locks/{lock_id}/add_to_expire_at"
         return self._make_request(url, "GET")
 
+    @skip_http_call()
     def add_to_expires_at_time_put(self, lock_id: str, seconds: int):
         """
         TBD

pyrelukko/testcontainers.py

@@ -14,6 +14,7 @@ def relukko_backend():
                     base_url=backend.get_api_url(), api_key="somekey")
                 yield relukko, backend
 """
+import os
 import socket
 
 from testcontainers.core.network import Network
@@ -24,10 +25,12 @@ from testcontainers.postgres import PostgresContainer
 
 class RelukkoContainer(ServerContainer):
     def __init__(self, net: Network,
-                 image="registry.gitlab.com/relukko/relukko:latest", db_url=None):
+                 image="registry.gitlab.com/relukko/relukko:latest",
+                 db_url=None):
+        container_image = os.environ.get('CI_RELUKKO_CONTAINER_IMAGE') or image
         self.db_url = db_url
         self.net = net
-        super(RelukkoContainer, self).__init__(image=image, port=3000)
+        super(RelukkoContainer, self).__init__(image=container_image, port=3000)
 
     def _configure(self):
         self.with_env("DATABASE_URL", self.db_url)

pyrelukko/version.py

@@ -1,2 +1,2 @@
 # pylint: disable=all
-__version__ = "0.6.1"
+__version__ = "0.8.0"

pyrelukko-0.8.0.dist-info/METADATA

@@ -0,0 +1,40 @@
+Metadata-Version: 2.3
+Name: pyrelukko
+Version: 0.8.0
+Summary: Relukko client.
+Author-email: Reto Zingg <g.d0b3rm4n@gmail.com>
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Topic :: Internet :: WWW/HTTP
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Requires-Dist: requests >=2.32.3
+Requires-Dist: websockets >= 14.1
+Project-URL: Homepage, https://gitlab.com/relukko/pyrelukko
+Project-URL: Issues, https://gitlab.com/relukko/pyrelukko/-/issues
+
+# PyRelukko
+
+[![PyPI - Version](https://img.shields.io/pypi/v/pyrelukko.svg)](https://pypi.org/project/pyrelukko)
+[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/pyrelukko.svg)](https://pypi.org/project/pyrelukko)
+![Python Version from PEP 621 TOML](https://img.shields.io/python/required-version-toml?tomlFilePath=https%3A%2F%2Fgitlab.com%2Frelukko%2Fpyrelukko%2F-%2Fraw%2Fmaster%2Fpyproject.toml%3Fref_type%3Dheads)
+![Gitlab Pipeline Status](https://img.shields.io/gitlab/pipeline-status/relukko%2Fpyrelukko?branch=master)
+![PyPI - Downloads](https://img.shields.io/pypi/dm/pyrelukko)
+![PyPI - License](https://img.shields.io/pypi/l/pyrelukko)
+![GitLab License](https://img.shields.io/gitlab/license/relukko%2Fpyrelukko)
+![PyPI - Format](https://img.shields.io/pypi/format/pyrelukko)
+![PyPI - Status](https://img.shields.io/pypi/status/pyrelukko)
+![PyPI - Implementation](https://img.shields.io/pypi/implementation/pyrelukko)
+![PyPI - Wheel](https://img.shields.io/pypi/wheel/pyrelukko)
+![GitLab Stars](https://img.shields.io/gitlab/stars/relukko%2Fpyrelukko)
+![GitLab Forks](https://img.shields.io/gitlab/forks/relukko%2Fpyrelukko)
+-----
+
+Python library to access a
+[Relukko back-end](https://gitlab.com/relukko/relukko).
+

pyrelukko-0.8.0.dist-info/RECORD

@@ -0,0 +1,9 @@
+pyrelukko/__init__.py,sha256=n-mTJV7AOfr4bljtDxok3E3gXIBRk-kFa2_Ql3S8Ht0,61
+pyrelukko/decorators.py,sha256=O570z9yJ8wIWtX7B7OMbOy1X8WLOLWpe1Kp-quYHhmE,2611
+pyrelukko/pyrelukko.py,sha256=gdUGIZ4zMunLgaAHFBlxOqpvoSyzOJCDZQoFHwywfXY,13718
+pyrelukko/testcontainers.py,sha256=hWcMn3fWcxp9oD78SfWllDDnkLhDchO4B_WwpWS-vWc,3471
+pyrelukko/version.py,sha256=t8WZzhgAY9BatyKcAF1YBxq4xBN63Yn5B8qpZtlLtJQ,44
+pyrelukko-0.8.0.dist-info/LICENSE,sha256=aEI4dThWmRUiEPch0-KaZQmHZgTyuz88Edmp25H6tAw,1089
+pyrelukko-0.8.0.dist-info/WHEEL,sha256=CpUCUxeHQbRN5UGRQHYRJorO5Af-Qy_fHMctcQ8DSGI,82
+pyrelukko-0.8.0.dist-info/METADATA,sha256=Eopk6nougkKLCk47_pTfFaLMNd72MPIpxw69bsFRV6A,2034
+pyrelukko-0.8.0.dist-info/RECORD,,

pyrelukko-0.6.1.dist-info/METADATA

@@ -1,24 +0,0 @@
-Metadata-Version: 2.3
-Name: pyrelukko
-Version: 0.6.1
-Summary: Relukko client.
-Author-email: Reto Zingg <g.d0b3rm4n@gmail.com>
-Requires-Python: >=3.10
-Description-Content-Type: text/markdown
-Classifier: Development Status :: 4 - Beta
-Classifier: Intended Audience :: Developers
-Classifier: License :: OSI Approved :: MIT License
-Classifier: Topic :: Internet :: WWW/HTTP
-Classifier: Topic :: Software Development :: Libraries :: Python Modules
-Classifier: Programming Language :: Python :: 3.11
-Classifier: Programming Language :: Python :: 3.12
-Classifier: Programming Language :: Python :: 3.13
-Requires-Dist: requests >=2.32.3
-Requires-Dist: websockets >= 14.1
-Project-URL: Homepage, https://gitlab.com/relukko/pyrelukko
-Project-URL: Issues, https://gitlab.com/relukko/pyrelukko/-/issues
-
-# PyRelukko
-Python library to access a
-[Relukko back-end](https://gitlab.com/relukko/relukko).
-

pyrelukko-0.6.1.dist-info/RECORD

@@ -1,9 +0,0 @@
-pyrelukko/__init__.py,sha256=n-mTJV7AOfr4bljtDxok3E3gXIBRk-kFa2_Ql3S8Ht0,61
-pyrelukko/pyrelukko.py,sha256=Pjn2pf4rg1rDgAHzUSFdLnooHttn0ZLh3g_29Fxi0RM,13499
-pyrelukko/retry.py,sha256=XeCc0trPhAggdEnu2nwtpFderlHaDQFTXH_O1dLeiGQ,1587
-pyrelukko/testcontainers.py,sha256=mSUfnyBFVmt9N9LoI_EwXG4EomY8pQCvHzff2ESio-8,3354
-pyrelukko/version.py,sha256=-uxD-uvgHyGDV97RE6sWoC15xz0uG1dBpD0xE_sq6Sg,44
-pyrelukko-0.6.1.dist-info/LICENSE,sha256=aEI4dThWmRUiEPch0-KaZQmHZgTyuz88Edmp25H6tAw,1089
-pyrelukko-0.6.1.dist-info/WHEEL,sha256=CpUCUxeHQbRN5UGRQHYRJorO5Af-Qy_fHMctcQ8DSGI,82
-pyrelukko-0.6.1.dist-info/METADATA,sha256=k7WLcnWt0dwnAynM98FJSqNM29TtVnHnVvDFrB8iOj8,887
-pyrelukko-0.6.1.dist-info/RECORD,,