sferriol-python 0.5.0__tar.gz → 0.6.0__tar.gz

{sferriol_python-0.5.0 → sferriol_python-0.6.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: sferriol-python
-Version: 0.5.0
+Version: 0.6.0
 Summary: python utilities
 Home-page: https://gitlab.in2p3.fr/sferriol-ip2i/sferriol-python
 Author: Sylvain Ferriol

{sferriol_python-0.5.0 → sferriol_python-0.6.0}/sferriol/python/__init__.py

@@ -4,6 +4,8 @@ import time
 import types
 from typing import Any, Callable
 
+import _asyncio as asyncio
+
 
 def load_module_from_file(fpath):
     """
@@ -42,6 +44,7 @@ def method(obj):
     Decorator used to define a function as a new method of the object obj.
     The method name is the function name.
     """
+
     def _(func):
         name = func.__name__
         setattr(obj, name, types.MethodType(func, obj))

sferriol_python-0.6.0/sferriol/python/_asyncio.py

@@ -0,0 +1,13 @@
+import asyncio
+
+
+async def run_shell_cmd(cmd: str) -> (int, str, str):
+    """Execute shell command
+
+    Returns:
+      Tuple (returned code, stdout, stderr)
+    """
+    proc = await asyncio.create_subprocess_shell(
+        cmd, stdout=asyncio.subprocess.PIPE, stderr=asyncio.subprocess.PIPE)
+    stdout, stderr = await proc.communicate()
+    return proc.returncode, stdout.decode().strip(), stderr.decode().strip()

{sferriol_python-0.5.0 → sferriol_python-0.6.0}/sferriol/python/env.py

@@ -2,18 +2,17 @@ import os
 import tomllib
 
 
-def load(default=None, os_env_prefix=None):
+def load(default=None, env_file=None, os_env_prefix=None):
     """
     Return env dictionary loaded from, in order:
       1. a default dictionary
-      2. a toml file where path is, in order, in default['env_file'] or in OS_ENV_PREFIX__ENV_FILE os env. variable
+      2. a toml file where path is, in order, in env_file or in OS_ENV_PREFIX__ENV_FILE os env. variable
       3. os env. variables OS_ENV_PREFIX__K where K is each key in previous dictionary in uppercase 
     """
     di = default.copy() if default else dict()
     os_env_prefix = os_env_prefix.upper() + '__' if os_env_prefix else None
 
     # from the env file
-    env_file = di.get('env_file', None)
     if os_env_prefix:
         env_file = os.getenv(os_env_prefix + 'ENV_FILE', env_file)
     if env_file is not None:

sferriol_python-0.6.0/sferriol/python/net.py

@@ -0,0 +1,128 @@
+# -*- coding: utf-8 -*-
+#
+#  Copyright 2023 sferriol <s.ferriol@ip2i.in2p3.fr>
+"""Network utilities"""
+import fcntl
+import socket
+import struct
+
+
+def are_in_same_network(ip_addr1: str, ip_addr2: str,
+                        netmask_addr: str) -> bool:
+    """Returns True if two addresses are in the same network specified by its netmask
+
+    Examples:
+    >>> are_in_same_network('1.2.3.4', '1.2.3.5', '255.255.255.0')
+    True
+    """
+    a1 = socket.inet_aton(ip_addr1)
+    a2 = socket.inet_aton(ip_addr2)
+    n = socket.inet_aton(netmask_addr)
+    return all([a1[i] & n[i] == a2[i] & n[i] for i in range(4)])
+
+
+def get_interface_ip_address(if_str: str) -> str:
+    """Returns the ip address of the interface
+
+    Args:
+      if_str name of the interface or ip address of its network
+
+    Examples:
+    >>> get_interface_ip_address('lo')
+    '127.0.0.1'
+    """
+    if_name = get_interface_name(if_str) if is_ipv4_address(if_str) else if_str
+    if if_name in list_interfaces():
+        s = socket.socket(socket.AF_INET, socket.SOCK_DGRAM)
+        return socket.inet_ntoa(
+            fcntl.ioctl(s.fileno(), 0x8915,
+                        struct.pack('256s', bytes(if_name[:15],
+                                                  'utf-8')))[20:24])
+
+
+def get_interface_name(ip_addr: str) -> str:
+    """Returns the interface name
+
+    Args:
+    ip_addr ip address of interface network
+
+    Examples:
+    >>> get_interface_name('127.0.0.1')
+    'lo'
+    """
+    interfaces = list_interfaces()
+    ret = None
+    for if_name in interfaces:
+        try:
+            if_addr = get_interface_ip_address(if_name)
+            netmask_addr = get_netmask_address(if_name)
+        except OSError:
+            continue
+        else:
+            if are_in_same_network(ip_addr, if_addr, netmask_addr):
+                ret = if_name
+                break
+    return ret
+
+
+def get_netmask_address(if_name: str) -> str:
+    """Returns the netmask of an interface
+
+    Examples:
+    >>> get_netmask_address('lo')
+    '255.0.0.0'
+    """
+    s = socket.socket(socket.AF_INET, socket.SOCK_DGRAM)
+    return socket.inet_ntoa(
+        fcntl.ioctl(s.fileno(), 0x891b,
+                    struct.pack('256s', bytes(if_name[:15], 'utf-8')))[20:24])
+
+
+def is_interface_connected(if_name: str) -> bool:
+    """Returns if interface has a carrier up status
+
+    Examples:
+    >>> is_interface_connected('lo')
+    True
+    """
+    file = f'/sys/class/net/{if_name}/carrier'
+    with open(file) as f:
+        return int(f.read().strip()) == 1
+
+
+def is_ipv4_address(ip_addr: str) -> bool:
+    """Returns if the addr has en IPV4 format
+
+    Examples:
+    >>> is_ipv4_address('1.2.3.4')
+    True
+    >>> is_ipv4_address('toto')
+    False
+    
+    """
+    nbrs = ip_addr.strip().split('.')
+    return len(nbrs) == 4 and all([n.isdigit() for n in nbrs])
+
+
+def is_port_in_use(port: int) -> bool:
+    """Test if the port is already used"""
+    with socket.socket(socket.AF_INET, socket.SOCK_STREAM) as s:
+        return s.connect_ex(('localhost', port)) == 0
+
+
+def list_interfaces() -> tuple[str, ...]:
+    """Returns all network interfaces available"""
+    return (k[1] for k in socket.if_nameindex())
+
+
+def unused_port() -> int:
+    """Return an unsued port
+
+    Returns:
+      Port value
+    """
+    sock = socket.socket()
+    sock.bind(('127.0.0.1', 0))
+    _, port = sock.getsockname()
+    sock.close()
+    return port

{sferriol_python-0.5.0 → sferriol_python-0.6.0}/sferriol_python.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: sferriol-python
-Version: 0.5.0
+Version: 0.6.0
 Summary: python utilities
 Home-page: https://gitlab.in2p3.fr/sferriol-ip2i/sferriol-python
 Author: Sylvain Ferriol

{sferriol_python-0.5.0 → sferriol_python-0.6.0}/sferriol_python.egg-info/SOURCES.txt

@@ -4,6 +4,7 @@ pyproject.toml
 setup.cfg
 setup.py
 sferriol/python/__init__.py
+sferriol/python/_asyncio.py
 sferriol/python/env.py
 sferriol/python/json.py
 sferriol/python/net.py

sferriol_python-0.5.0/sferriol/python/net.py

@@ -1,24 +0,0 @@
-# -*- coding: utf-8 -*-
-#
-#  Copyright 2023 sferriol <s.ferriol@ip2i.in2p3.fr>
-"""Network utilities"""
-import socket
-
-
-def is_port_in_use(port: int) -> bool:
-    """Test if the port is already used"""
-    with socket.socket(socket.AF_INET, socket.SOCK_STREAM) as s:
-        return s.connect_ex(('localhost', port)) == 0
-
-
-def unused_port() -> int:
-    """Return an unsued port
-
-    Returns:
-      Port value
-    """
-    sock = socket.socket()
-    sock.bind(('127.0.0.1', 0))
-    _, port = sock.getsockname()
-    sock.close()
-    return port