YunoHost/yunohost
1
0
Fork 0
mirror of https://github.com/YunoHost/yunohost.git synced 2024-09-03 20:06:10 +02:00
Code Issues Projects Releases Packages Wiki Activity

quality: fix type confusion + mypy not actually checking the functions because of the is_unit_operation decorator, which requires typing wizardry to understan the signature change

Browse source
This commit is contained in:
Alexandre Aubin 2024-08-15 19:29:12 +02:00
parent efce7f9f05
commit fe1c04fb2c
2 changed files with 17 additions and 19 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

24
src/log.py
View file

@ -388,12 +388,17 @@ def log_show(
def log_share(path): def log_share(path):
return log_show(path, share=True) return log_show(path, share=True)
from typing import TypeVar, Callable, Concatenate, ParamSpec
#FuncT = TypeVar("FuncT", bound=Callable[..., Any])
Param = ParamSpec("Param")
RetType = TypeVar("RetType")
def is_unit_operation( def is_unit_operation(
entities=["app", "domain", "group", "service", "user"], entities = ["app", "domain", "group", "service", "user"],
exclude=["password"], exclude = ["password"],
operation_key=None, ) -> Callable[[Callable[Concatenate["OperationLogger", Param], RetType]], Callable[Param, RetType]]:
):
""" """
Configure quickly a unit operation Configure quickly a unit operation
@ -410,17 +415,10 @@ def is_unit_operation(
called 'password' are removed. If an argument is an object, you need to called 'password' are removed. If an argument is an object, you need to
exclude it or create manually the unit operation without this decorator. exclude it or create manually the unit operation without this decorator.
operation_key A key to describe the unit operation log used to create the
filename and search a translation. Please ensure that this key prefixed by
'log_' is present in locales/en.json otherwise it won't be translatable.
""" """
def decorate(func): def decorate(func: Callable[Concatenate["OperationLogger", Param], RetType]) -> Callable[Param, RetType]:
def func_wrapper(*args, **kwargs): def func_wrapper(*args, **kwargs):
op_key = operation_key
if op_key is None:
op_key = func.__name__
# If the function is called directly from an other part of the code # If the function is called directly from an other part of the code
# and not by the moulinette framework, we need to complete kwargs # and not by the moulinette framework, we need to complete kwargs
@ -471,7 +469,7 @@ def is_unit_operation(
context[field] = value.name context[field] = value.name
except Exception: except Exception:
context[field] = "IOBase" context[field] = "IOBase"
operation_logger = OperationLogger(op_key, related_to, args=context) operation_logger = OperationLogger(func.__name__, related_to, args=context)
try: try:
# Start the actual function, and give the unit operation # Start the actual function, and give the unit operation

12
src/user.py
View file

@ -234,7 +234,7 @@ def user_create(
uid_guid_found = False uid_guid_found = False
while not uid_guid_found: while not uid_guid_found:
# LXC uid number is limited to 65536 by default # LXC uid number is limited to 65536 by default
uid = str(random.randint(1001, 65000)) uid: str = str(random.randint(1001, 65000))
uid_guid_found = uid not in all_uid and uid not in all_gid uid_guid_found = uid not in all_uid and uid not in all_gid
if not loginShell: if not loginShell:
@ -931,7 +931,7 @@ def user_import(operation_logger: "OperationLogger", csvfile: TextIO, update: bo
user["username"], user["username"],
user["domain"], user["domain"],
user["password"], user["password"],
user["mailbox-quota"], mailbox_quota=user["mailbox-quota"],
from_import=True, from_import=True,
fullname=(user["firstname"] + " " + user["lastname"]).strip(), fullname=(user["firstname"] + " " + user["lastname"]).strip(),
) )
@ -1008,7 +1008,7 @@ def user_group_list(full: bool = False, include_primary_groups: bool = True) ->
@is_unit_operation([("groupname", "group")]) @is_unit_operation([("groupname", "group")])
def user_group_create( def user_group_create(
operation_logger: "OperationLogger", groupname: str, gid: Optional[int] = None, primary_group: bool = False, sync_perm: bool = True operation_logger: "OperationLogger", groupname: str, gid: Optional[str] = None, primary_group: bool = False, sync_perm: bool = True
) -> dict[str, str]: ) -> dict[str, str]:
""" """
Create group Create group
@ -1044,17 +1044,17 @@ def user_group_create(
if not gid: if not gid:
# Get random GID # Get random GID
all_gid = {x.gr_gid for x in grp.getgrall()} all_gid = {str(x.gr_gid) for x in grp.getgrall()}
uid_guid_found = False uid_guid_found = False
while not uid_guid_found: while not uid_guid_found:
gid = random.randint(200, 99999) gid = str(random.randint(200, 99999))
uid_guid_found = gid not in all_gid uid_guid_found = gid not in all_gid
attr_dict = { attr_dict = {
"objectClass": ["top", "groupOfNamesYnh", "posixGroup"], "objectClass": ["top", "groupOfNamesYnh", "posixGroup"],
"cn": groupname, "cn": groupname,
"gidNumber": gid, "gidNumber": [gid],
} }
# Here we handle the creation of a primary group # Here we handle the creation of a primary group