linuxfabrik-lib 8.0.0__tar.gz → 8.2.0__tar.gz

{linuxfabrik_lib-8.0.0 → linuxfabrik_lib-8.2.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: linuxfabrik-lib
-Version: 8.0.0
+Version: 8.2.0
 Summary: Python libraries used in various Linuxfabrik projects, including the 'Linuxfabrik Monitoring Plugins' project.
 Author-email: "Linuxfabrik GmbH, Zurich, Switzerland" <info@linuxfabrik.ch>
 License: This is free and unencumbered software released into the public domain.
@@ -222,7 +222,8 @@ A typical monitoring plugin using these libraries:
 import lib.args
 import lib.base
 import lib.url
-from lib.globals import (STATE_CRIT, STATE_OK, STATE_UNKNOWN, STATE_WARN)
+from lib.globals import STATE_CRIT, STATE_OK, STATE_UNKNOWN, STATE_WARN
+
 
 def main():
     # Parse arguments with custom threshold types
@@ -237,11 +238,14 @@ def main():
 
     # Evaluate thresholds
     state = lib.base.get_state(result['usage'], args.warning, args.critical)
-    perfdata = lib.base.get_perfdata('usage', result['usage'], '%', args.warning, args.critical, 0, 100)
+    perfdata = lib.base.get_perfdata(
+        'usage', result['usage'], '%', args.warning, args.critical, 0, 100
+    )
 
     # Output and exit
     lib.base.oao('Usage is {}%'.format(result['usage']), state, perfdata)
 
+
 if __name__ == '__main__':
     main()
 ```

{linuxfabrik_lib-8.0.0 → linuxfabrik_lib-8.2.0}/README.md

@@ -151,7 +151,8 @@ A typical monitoring plugin using these libraries:
 import lib.args
 import lib.base
 import lib.url
-from lib.globals import (STATE_CRIT, STATE_OK, STATE_UNKNOWN, STATE_WARN)
+from lib.globals import STATE_CRIT, STATE_OK, STATE_UNKNOWN, STATE_WARN
+
 
 def main():
     # Parse arguments with custom threshold types
@@ -166,11 +167,14 @@ def main():
 
     # Evaluate thresholds
     state = lib.base.get_state(result['usage'], args.warning, args.critical)
-    perfdata = lib.base.get_perfdata('usage', result['usage'], '%', args.warning, args.critical, 0, 100)
+    perfdata = lib.base.get_perfdata(
+        'usage', result['usage'], '%', args.warning, args.critical, 0, 100
+    )
 
     # Output and exit
     lib.base.oao('Usage is {}%'.format(result['usage']), state, perfdata)
 
+
 if __name__ == '__main__':
     main()
 ```

{linuxfabrik_lib-8.0.0 → linuxfabrik_lib-8.2.0}/db_sqlite.py

@@ -20,11 +20,13 @@ This is one typical use case of this library (taken from `disk-io`):
 >>> lib.base.coe(lib.db_sqlite.cut(conn, _max=args.COUNT * len(disks)))
 >>> lib.base.coe(lib.db_sqlite.commit(conn))
 
->>> result = lib.base.coe(lib.db_sqlite.select(
-...     conn,
-...     'SELECT * FROM perfdata WHERE name = :name ORDER BY timestamp DESC LIMIT 2',
-...     {'name': disk},
-... ))
+>>> result = lib.base.coe(
+...     lib.db_sqlite.select(
+...         conn,
+...         'SELECT * FROM perfdata WHERE name = :name ORDER BY timestamp DESC LIMIT 2',
+...         {'name': disk},
+...     )
+... )
 
 >>> lib.db_sqlite.close(conn)
 """

{linuxfabrik_lib-8.0.0 → linuxfabrik_lib-8.2.0}/feedparser.py

@@ -14,7 +14,7 @@ Time zone handling is not implemented.
 """
 
 __author__ = 'Linuxfabrik GmbH, Zurich/Switzerland'
-__version__ = '2026082501'
+__version__ = '2026092201'
 
 import sys
 
@@ -65,7 +65,8 @@ def fetch_soup(
     encoding : str, optional
         Encoding to use for the URL fetch operation. Default is `'urlencode'`.
     retries : int, optional
-        How many extra attempts to make if the request fails or the body is not a feed.
+        How many extra attempts to make if the request fails in a way that may clear up
+        (see `url.fetch()`) or the body is not a feed.
         `0` (default) means a single attempt. Useful against flaky endpoints (e.g. a status
         page behind a load balancer) that occasionally answer with something else.
 
@@ -80,21 +81,22 @@ def fetch_soup(
     --------
     >>> success, soup = fetch_soup('https://example.com/feed.xml', retries=3)
     """
-    attempt = 0
-    while True:
-        success, xml = url.fetch(
-            feed_url,
-            encoding=encoding,
-            insecure=insecure,
-            no_proxy=no_proxy,
-            proxy=proxy,
-            timeout=timeout,
-        )
-        result = parse_soup(xml, feed_url) if success else (False, xml)
-
-        if result[0] or attempt >= retries:
-            return result
-        attempt += 1
+    # `fetch()` owns the retries: it repeats a request that may succeed next time and,
+    # through `retry_if`, an answer that arrived but is not a feed. A 404 or a refused
+    # redirect comes back the same and is reported at once.
+    success, xml = url.fetch(
+        feed_url,
+        encoding=encoding,
+        insecure=insecure,
+        no_proxy=no_proxy,
+        proxy=proxy,
+        retries=retries,
+        retry_if=lambda body: not parse_soup(body, feed_url)[0],
+        timeout=timeout,
+    )
+    if not success:
+        return (False, xml)
+    return parse_soup(xml, feed_url)
 
 
 def parse(
@@ -128,7 +130,8 @@ def parse(
     encoding : str, optional
         Encoding to use for the URL fetch operation. Default is `'urlencode'`.
     retries : int, optional
-        How many extra attempts to make if the request fails or the body is not a feed.
+        How many extra attempts to make if the request fails in a way that may clear up
+        (see `url.fetch()`) or the body is not a feed.
         `0` (default) means a single attempt. See `fetch_soup()`.
 
     Returns

{linuxfabrik_lib-8.0.0 → linuxfabrik_lib-8.2.0}/grassfish.py

@@ -21,7 +21,16 @@ from . import url
 
 
 def fetch_json(
-    token, host, port, uri, version, func, insecure=False, no_proxy=False, proxy=None, timeout=8
+    token,
+    host,
+    port,
+    uri,
+    version,
+    func,
+    insecure=False,
+    no_proxy=False,
+    proxy=None,
+    timeout=8,
 ):
     """
     Fetch JSON data from a Grassfish API endpoint.

{linuxfabrik_lib-8.0.0 → linuxfabrik_lib-8.2.0}/huawei_dorado.py

@@ -23,7 +23,7 @@ readable label instead of `'Unknown'`, regardless of which firmware answers.
 # pylint: disable=C0302
 
 __author__ = 'Linuxfabrik GmbH, Zurich/Switzerland'
-__version__ = '2026092101'
+__version__ = '2026092202'
 
 import json
 from time import sleep as _sleep
@@ -1048,11 +1048,14 @@ def get_data(endpoint, args, max_attempts=3):
 
     Notes
     -----
-    - Makes at most three attempts, forcing a fresh login before the second one, and waits one
-      second between attempts. The retry count is kept low on purpose, so one call stays within
-      the caller's own timeout: the worst case is three requests plus one login,
-      plus two seconds of waiting. This budget is per call. A caller that chains several calls
-      has to size its own timeout for the sum.
+    - Makes at most three attempts and waits one second between attempts. The first attempt
+      the appliance rejects is followed by one fresh login. The retry count is kept low on
+      purpose, so one call stays within the caller's own timeout: the worst case is three
+      requests plus one login, plus two seconds of waiting. This budget is per call. A caller
+      that chains several calls has to size its own timeout for the sum.
+    - A request that got no answer at all (a timeout, a refused connection) does not force a
+      fresh login. It says nothing about the session, and on a slow appliance the extra login
+      only makes the next attempt slower while discarding a session that is still valid.
     - A rejected request is retried instead of aborting the caller: a transport failure, an HTTP
       error status and a response that is not the documented `{'error': {'code': ...}}` envelope
       all count as a failed attempt and are handed back in that envelope. The caller therefore
@@ -1076,13 +1079,18 @@ def get_data(endpoint, args, max_attempts=3):
     }
     """
     result = {}
+    relogged = False
 
     for attempt in range(1, max_attempts + 1):
-        # On the second attempt, drop the cached session and log in again; a
-        # rejected request is most likely an expired session that retrying
-        # with the same token cannot fix. The third attempt then reuses that
-        # fresh token to absorb a remaining transient error.
-        ibasetoken, cookie, device_id = get_creds(args, force_relogin=attempt == 2)
+        # After the appliance rejected a request, drop the cached session and log in again
+        # once; a rejected request is most likely an expired session that retrying with
+        # the same token cannot fix. A request that never got an answer (a timeout, a
+        # refused connection) says nothing about the session, so it is retried with the
+        # cached one: logging in again would cost a round trip on an appliance that is
+        # already slow, and throw a valid session away.
+        force_relogin = attempt > 1 and not relogged and get_error_code(result) != 'n/a'
+        relogged = relogged or force_relogin
+        ibasetoken, cookie, device_id = get_creds(args, force_relogin=force_relogin)
         # The device ID comes from the session, not from `args`: it may have been the
         # appliance's own answer rather than a caller-supplied value, and a re-login can
         # in principle hand back a different one.
@@ -1244,6 +1252,40 @@ def get_error_code(result):
     return error
 
 
+def get_expboard_model(em):
+    """
+    Convert a Huawei expansion board model code into a human-readable description.
+
+    Parameters
+    ----------
+    em : int or str
+        The expansion board model code to interpret.
+        A missing or malformed value renders as `'Unknown'`.
+
+    Returns
+    -------
+    str
+        A human-readable description of the expansion board model.
+        Returns `'Unknown'` if the code is not recognized.
+
+    Examples
+    --------
+    >>> get_expboard_model(0)
+    'SAS'
+
+    >>> get_expboard_model('7')
+    'Smart NVMe'
+    """
+    mapping = {
+        0: 'SAS',
+        1: 'FC',
+        5: 'NVMe',
+        6: 'Smart SAS',
+        7: 'Smart NVMe',
+    }
+    return mapping.get(as_code(em), 'Unknown')
+
+
 def get_health_status(hs):
     """
     Convert a Huawei health status code into a human-readable description.
@@ -1396,6 +1438,45 @@ def get_host_access_state(has):
     return mapping.get(as_code(has), 'Unknown')
 
 
+def get_hypermetro_domain_running_status(rs):
+    """
+    Convert a HyperMetro domain's `RUNNINGSTATUS` code into a human-readable description.
+
+    Parameters
+    ----------
+    rs : int or str
+        The running status code to interpret.
+        A missing or malformed value renders as `'Unknown'`.
+
+    Returns
+    -------
+    str
+        A human-readable description including the original code in brackets.
+        Returns `'Unknown'` if the code is not recognized.
+
+    Notes
+    -----
+    - Covers the block `HyperMetroDomain` object (type `15362`). Both REST Interface
+      References list only these three codes for it. The file system HyperMetro domain
+      (`FsHyperMetroDomain`, type `162`) is a different object with an enumeration of its
+      own that runs from `0` up, so its codes must not be read through this function.
+
+    Examples
+    --------
+    >>> get_hypermetro_domain_running_status(1)
+    'Normal (1)'
+
+    >>> get_hypermetro_domain_running_status('35')
+    'Invalid (35)'
+    """
+    mapping = {
+        1: 'Normal (1)',
+        33: 'To be recovered (33)',
+        35: 'Invalid (35)',
+    }
+    return mapping.get(as_code(rs), 'Unknown')
+
+
 def get_hypermetro_domain_running_status_state(rs):
     """
     Convert a HyperMetro domain's `RUNNINGSTATUS` code into the state a consumer reports for it.
@@ -1408,31 +1489,29 @@ def get_hypermetro_domain_running_status_state(rs):
     Returns
     -------
     int
-        `STATE_OK` for a normal domain, `STATE_CRIT` for a faulty or invalid one, `STATE_WARN`
-        for every other code, including one the enumeration does not know and a missing value.
+        `STATE_OK` for a normal domain, `STATE_CRIT` for an invalid one, `STATE_WARN` for
+        every other code, including one the enumeration does not know and a missing value.
 
     Notes
     -----
-    - Scoped to the `HyperMetroDomain` object for the same reason as
-      `get_hypermetro_domain_running_status()`: the codes are renumbered from `0` up and every
-      one of them collides with the shared enumeration, so `get_running_status_state()` cannot
-      be used here.
-    - Split (`3`) warns rather than going critical. A split domain no longer mirrors, but each
-      side still serves its own I/O, and an administrator splits a domain deliberately during
-      maintenance.
+    - Scoped to the block `HyperMetroDomain` object for the same reason as
+      `get_hypermetro_domain_running_status()`.
+    - Verified against V700R001C10SPH128 on a Dorado 6000 V6: a healthy domain reports `1`.
+    - To be recovered (`33`) warns rather than going critical. The domain is still there and
+      the appliance is working its way back to a mirrored state on its own.
 
     Examples
     --------
-    >>> get_hypermetro_domain_running_status_state(0) == STATE_OK
+    >>> get_hypermetro_domain_running_status_state(1) == STATE_OK
     True
 
-    >>> get_hypermetro_domain_running_status_state('2') == STATE_CRIT
+    >>> get_hypermetro_domain_running_status_state('35') == STATE_CRIT
     True
     """
     code = as_code(rs)
-    if code == 0:
+    if code == 1:
         return STATE_OK
-    if code in (2, 5):
+    if code == 35:
         return STATE_CRIT
     return STATE_WARN
 
@@ -1871,20 +1950,23 @@ def get_performance(uuid, data_ids, args):
 # `(label, uom, factor)`. The label is the metric name a consumer emits, `uom` is the
 # Nagios unit of measurement, and `factor` converts the vendor's unit into it.
 #
-# Two conversions are worth naming. The response times are documented in microseconds and
-# go out in seconds, the unit Nagios knows. The bandwidths and I/O sizes are documented as
-# MB/s and KB, and are read as binary multiples: every capacity this API reports is binary
-# (sectors of 512 bytes), and so is what DeviceManager itself displays.
+# Three conversions are worth naming. The response times are documented in microseconds and
+# go out in seconds, the unit Nagios knows. The bandwidths are documented as MB/s and are
+# read as binary multiples: every capacity this API reports is binary (sectors of 512
+# bytes), and so is what DeviceManager itself displays. The average I/O sizes are
+# documented as KB but arrive in bytes: on a Dorado 6000 V6 running V700R001C10SPH128,
+# a storage pool reading 590 MB/s at 22413 IOPS reported an average read I/O size of
+# 27648, which is 27 KiB per I/O in bytes and would be 27 MiB per I/O in KB.
 PERFORMANCE_INDICATORS = {
     18: ('usage_percent', '%', 1),
     19: ('queue_length', None, 1),
     21: ('block_bandwidth', 'B', 1024 * 1024),
     22: ('total_iops', None, 1),
     23: ('read_bandwidth', 'B', 1024 * 1024),
-    24: ('avg_read_io_size', 'B', 1024),
+    24: ('avg_read_io_size', 'B', 1),
     25: ('read_iops', None, 1),
     26: ('write_bandwidth', 'B', 1024 * 1024),
-    27: ('avg_write_io_size', 'B', 1024),
+    27: ('avg_write_io_size', 'B', 1),
     28: ('write_iops', None, 1),
     68: ('cpu_usage_percent', '%', 1),
     69: ('cache_usage_percent', '%', 1),
@@ -2099,12 +2181,8 @@ def get_running_status(rs):
 
     Notes
     -----
-    - Not scoped to `HyperMetroDomain` and `dr_star`. Both renumber `RUNNINGSTATUS` instead
-      of sharing this enumeration, and both collide on the low codes this function is most
-      likely to be handed: `2` is faulty on a HyperMetro domain and disabled on a DR Star
-      trio, not running. Read through this function either would look healthy, so they have
-      their own mappings in `get_hypermetro_domain_running_status()` and
-      `get_dr_star_running_status()`.
+    - Not scoped to `HyperMetroDomain`. A HyperMetro domain has an enumeration of its own,
+      so it has its own mapping in `get_hypermetro_domain_running_status()`.
     - Code `94` is the one value whose meaning differs between the two documented firmware
       generations: 6.1.0 defines it as error, V700R001C10 as faulty. The response carries no
       firmware marker, so it renders as `'Error/Faulty'`, which holds under both revisions.

{linuxfabrik_lib-8.0.0 → linuxfabrik_lib-8.2.0}/icinga.py

@@ -84,8 +84,12 @@ def api_post(
     ... }
     >>> result = lib.base.coe(
     ...     lib.icinga.api_post(
-    ...         uri, args.USERNAME, args.PASSWORD, data=data,
-    ...         method_override='GET', timeout=3
+    ...         uri,
+    ...         args.USERNAME,
+    ...         args.PASSWORD,
+    ...         data=data,
+    ...         method_override='GET',
+    ...         timeout=3,
     ...     )
     ... )
     """

{linuxfabrik_lib-8.0.0 → linuxfabrik_lib-8.2.0}/keycloak.py

@@ -19,7 +19,9 @@ Typical use case:
     # obtain an admin access token and call the Admin REST API (fetch the realm's details).
     oidc_config = lib.base.coe(lib.keycloak.discover_oidc_endpoints(args))
     admin_token = lib.base.coe(lib.keycloak.obtain_admin_token(args, oidc_config))
-    server_info = lib.base.coe(lib.keycloak.get_data(args, admin_token, '/admin/serverinfo'))
+    server_info = lib.base.coe(
+        lib.keycloak.get_data(args, admin_token, '/admin/serverinfo')
+    )
 """
 
 __author__ = 'Linuxfabrik GmbH, Zurich/Switzerland'

{linuxfabrik_lib-8.0.0 → linuxfabrik_lib-8.2.0}/lftest.py

@@ -21,7 +21,7 @@ import tempfile
 from . import base, disk, shell
 
 __author__ = 'Linuxfabrik GmbH, Zurich/Switzerland'
-__version__ = '2026092101'
+__version__ = '2026092201'
 
 
 def attach_each(test_class, items, action, id_func=str):
@@ -108,7 +108,23 @@ RUN_ID_ENV = 'LFTEST_RUN_ID'
 RUN_ID_LABEL = 'ch.linuxfabrik.lftest.run'
 
 
-def prepare_container_env():
+def in_test_process():
+    """Return whether this process is a unit test rather than a monitoring plugin.
+
+    A plugin imports this module for its `--test` fixtures and must not be given a
+    test environment, so anything that changes how a plugin talks to the outside
+    world asks here first. A test is recognised by `unittest`, which every
+    `unit-test/run` imports before it reaches this module, and by the markers the
+    runners put into the environment.
+    """
+    return (
+        'unittest' in sys.modules
+        or NO_CONTAINER_ENV in os.environ
+        or RUN_ID_ENV in os.environ
+    )
+
+
+def prepare_container_env(force=False):
     """Point testcontainers at rootless podman, unless the caller said otherwise.
 
     testcontainers-python reads `DOCKER_HOST` and nothing else, so a host that
@@ -122,8 +138,22 @@ def prepare_container_env():
     Called on import, so it takes effect however a test was started: through
     `tools/run-unit-tests` or by running `unit-test/run` directly. Values the
     caller already set are kept, which is how a docker host or a running reaper
-    stays in charge.
+    stays in charge. A helper that starts a container calls it again with `force`,
+    so it does not depend on what the import saw.
+
+    Outside a test process this does nothing, unless `force` says otherwise.
+    `DOCKER_HOST` is read by the `docker` client as well, so a plugin that ends up
+    with the podman socket in it reports `Cannot connect to the Docker daemon` on a
+    host where docker is running fine.
+
+    Parameters
+    ----------
+    force : bool, optional
+        Prepare the environment even outside a test
+        process, for a caller that starts a container itself.
     """
+    if not force and not in_test_process():
+        return
     if 'DOCKER_HOST' not in os.environ:
         os.environ['DOCKER_HOST'] = os.environ.get(
             'CONTAINER_HOST', f'unix:///run/user/{os.getuid()}/podman/podman.sock'
@@ -255,6 +285,8 @@ def network():
     ...     ):
     ...         pass
     """
+    # see run_container()
+    prepare_container_env(force=True)
     require_container_runtime()
     from testcontainers.core.network import Network
 
@@ -453,6 +485,9 @@ def run_container(
     ...     )
     ...     # point the executable at this url
     """
+    # A caller that starts a container needs the socket whatever this process
+    # looks like, so this does not lean on the import-time guess.
+    prepare_container_env(force=True)
     require_container_runtime()
     from datetime import timedelta
 

{linuxfabrik_lib-8.0.0 → linuxfabrik_lib-8.2.0}/linuxfabrik_lib.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: linuxfabrik-lib
-Version: 8.0.0
+Version: 8.2.0
 Summary: Python libraries used in various Linuxfabrik projects, including the 'Linuxfabrik Monitoring Plugins' project.
 Author-email: "Linuxfabrik GmbH, Zurich, Switzerland" <info@linuxfabrik.ch>
 License: This is free and unencumbered software released into the public domain.
@@ -222,7 +222,8 @@ A typical monitoring plugin using these libraries:
 import lib.args
 import lib.base
 import lib.url
-from lib.globals import (STATE_CRIT, STATE_OK, STATE_UNKNOWN, STATE_WARN)
+from lib.globals import STATE_CRIT, STATE_OK, STATE_UNKNOWN, STATE_WARN
+
 
 def main():
     # Parse arguments with custom threshold types
@@ -237,11 +238,14 @@ def main():
 
     # Evaluate thresholds
     state = lib.base.get_state(result['usage'], args.warning, args.critical)
-    perfdata = lib.base.get_perfdata('usage', result['usage'], '%', args.warning, args.critical, 0, 100)
+    perfdata = lib.base.get_perfdata(
+        'usage', result['usage'], '%', args.warning, args.critical, 0, 100
+    )
 
     # Output and exit
     lib.base.oao('Usage is {}%'.format(result['usage']), state, perfdata)
 
+
 if __name__ == '__main__':
     main()
 ```

{linuxfabrik_lib-8.0.0 → linuxfabrik_lib-8.2.0}/psi.py

@@ -34,9 +34,16 @@ Typical use case:
     else:
         thresholds = {'avg60': ('5', '10')}
         states = lib.psi.get_states(pressure, 'full', thresholds)
-        print(lib.psi.get_summary(
-            pressure, 'memory', 'memory', ('some', 'full'), 'full', states,
-        ))
+        print(
+            lib.psi.get_summary(
+                pressure,
+                'memory',
+                'memory',
+                ('some', 'full'),
+                'full',
+                states,
+            )
+        )
 """
 
 import errno

{linuxfabrik_lib-8.0.0 → linuxfabrik_lib-8.2.0}/pyproject.toml

@@ -6,7 +6,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "linuxfabrik-lib"
-version = "8.0.0"
+version = "8.2.0"
 description = "Python libraries used in various Linuxfabrik projects, including the 'Linuxfabrik Monitoring Plugins' project."
 readme = "README.md"
 authors = [

{linuxfabrik_lib-8.0.0 → linuxfabrik_lib-8.2.0}/redfish.py

@@ -11,7 +11,7 @@
 """This library parses data returned from the Redfish API."""
 
 __author__ = 'Linuxfabrik GmbH, Zurich/Switzerland'
-__version__ = '2026092103'
+__version__ = '2026092201'
 
 import atexit
 import base64
@@ -1576,10 +1576,16 @@ def get_auth_header(args, cache_expire=0, cache_filename=CACHE_FILENAME):
         f'no usable session token in the cache, logging in with up to {login_retries + 1} '
         f'attempt(s)',
     )
-    # no cached token: create a new session via the SessionService
+    # No cached token: create a new session via the SessionService. The token and the
+    # session's URL come from the X-Auth-Token and Location headers, which is all a
+    # client needs (DSP0266 1.21.0, 13.3.4.2 "Session login"). The body with the new
+    # Session resource is required there too, but not every service sends it: the DMTF
+    # Redfish Mockup Server answers "204 No Content". Treating that as a failed login
+    # would fall back to HTTP Basic although the headers carry a valid session.
     success, result = _fetch_json(
         'login',
         f'{args.URL}/redfish/v1/SessionService/Sessions',
+        allow_empty=True,
         data={'UserName': args.USERNAME, 'Password': args.PASSWORD},
         encoding='serialized-json',
         extended=True,

{linuxfabrik_lib-8.0.0 → linuxfabrik_lib-8.2.0}/rocket.py

@@ -273,7 +273,9 @@ def get_rooms_get(
     return True, result
 
 
-def get_stats(rc_url, auth_token, user_id, insecure=False, no_proxy=False, proxy=None, timeout=3):
+def get_stats(
+    rc_url, auth_token, user_id, insecure=False, no_proxy=False, proxy=None, timeout=3
+):
     """
     Retrieve Rocket.Chat statistics using an API token.
 
@@ -340,7 +342,9 @@ def get_stats(rc_url, auth_token, user_id, insecure=False, no_proxy=False, proxy
     return True, result
 
 
-def get_token(rc_url, user, password, insecure=False, no_proxy=False, proxy=None, timeout=3):
+def get_token(
+    rc_url, user, password, insecure=False, no_proxy=False, proxy=None, timeout=3
+):
     """
     Retrieve an API token from Rocket.Chat using user credentials.
 
@@ -410,7 +414,9 @@ def get_token(rc_url, user, password, insecure=False, no_proxy=False, proxy=None
     return True, f'{auth_token}:{user_id}'
 
 
-def send2webhook(rc_url, webhook, data, insecure=False, no_proxy=False, proxy=None, timeout=3):
+def send2webhook(
+    rc_url, webhook, data, insecure=False, no_proxy=False, proxy=None, timeout=3
+):
     """
     Send a JSON payload to a Rocket.Chat incoming webhook.
 
@@ -473,7 +479,13 @@ def send2webhook(rc_url, webhook, data, insecure=False, no_proxy=False, proxy=No
 
 
 def send_message(
-    webhook_url, data, header=None, insecure=False, no_proxy=False, proxy=None, timeout=3
+    webhook_url,
+    data,
+    header=None,
+    insecure=False,
+    no_proxy=False,
+    proxy=None,
+    timeout=3,
 ):
     """
     Post a JSON message payload to a Rocket.Chat incoming webhook (complete URL).