elapi 2.4.11__tar.gz → 2.4.12__tar.gz

{elapi-2.4.11 → elapi-2.4.12}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: elapi
-Version: 2.4.11
+Version: 2.4.12
 Summary: elAPI is a powerful, extensible API client for eLabFTW.
 Keywords: elabftw,api
 Author: Alexander Haller, Mahadi Xion
@@ -33,6 +33,7 @@ Requires-Dist: httpx-aiohttp>=0.1.12,<0.2
 Requires-Dist: pydantic>=2.12.3
 Requires-Dist: urllib3>=2.6.3
 Requires-Dist: aiohttp>=3.13.5
+Requires-Dist: lxml>=6.1.0
 Requires-Dist: jinja2>=3.1.6,<3.2 ; extra == 'mail'
 Requires-Dist: nameparser>=1.1.3 ; extra == 'mail'
 Requires-Dist: yagmail>=0.15.293,<0.16 ; extra == 'mail'
@@ -148,7 +149,8 @@ your configuration details.
 
 elAPI is compatible with the following Python versions: `3.11`, `3.12`, `3.13`, `3.14`. elAPI supports
 the [eLabFTW REST API v2](https://doc.elabftw.net/api/v2/), and can be used with the following eLabFTW
-versions: `5.5.8`, `5.5.7`, `5.5.6`, `5.5.5`, `5.5.4`, `5.5.3`, `5.5.2`, `5.5.1`, `5.5.0`, `5.4.6`, `5.4.5`, `5.4.4`, `5.4.3`, `5.4.2`, `5.4.1`,
+versions: `5.5.11`, `5.5.10`, `5.5.9`, `5.5.8`, `5.5.7`, `5.5.6`, `5.5.5`, `5.5.4`, `5.5.3`, `5.5.2`, `5.5.1`, `5.5.0`,
+`5.4.6`, `5.4.5`, `5.4.4`, `5.4.3`, `5.4.2`, `5.4.1`,
 `5.4.0`, `5.3.11`, `5.3.10`, `5.3.9`, `5.3.8`, `5.3.7`, `5.3.6`,
 `5.3.5`, `5.3.4`, `5.3.3`, `5.3.2`, `5.3.1`, `5.3.0`, `5.2.8`, `5.2.7`, `5.2.6`, `5.2.5`, `5.2.4`,
 `5.2.3`, `5.2.2`, `5.2.1`, `5.2.0`, `5.1.1`.

{elapi-2.4.11 → elapi-2.4.12}/README.md

@@ -96,7 +96,8 @@ your configuration details.
 
 elAPI is compatible with the following Python versions: `3.11`, `3.12`, `3.13`, `3.14`. elAPI supports
 the [eLabFTW REST API v2](https://doc.elabftw.net/api/v2/), and can be used with the following eLabFTW
-versions: `5.5.8`, `5.5.7`, `5.5.6`, `5.5.5`, `5.5.4`, `5.5.3`, `5.5.2`, `5.5.1`, `5.5.0`, `5.4.6`, `5.4.5`, `5.4.4`, `5.4.3`, `5.4.2`, `5.4.1`,
+versions: `5.5.11`, `5.5.10`, `5.5.9`, `5.5.8`, `5.5.7`, `5.5.6`, `5.5.5`, `5.5.4`, `5.5.3`, `5.5.2`, `5.5.1`, `5.5.0`,
+`5.4.6`, `5.4.5`, `5.4.4`, `5.4.3`, `5.4.2`, `5.4.1`,
 `5.4.0`, `5.3.11`, `5.3.10`, `5.3.9`, `5.3.8`, `5.3.7`, `5.3.6`,
 `5.3.5`, `5.3.4`, `5.3.3`, `5.3.2`, `5.3.1`, `5.3.0`, `5.2.8`, `5.2.7`, `5.2.6`, `5.2.5`, `5.2.4`,
 `5.2.3`, `5.2.2`, `5.2.1`, `5.2.0`, `5.1.1`.

{elapi-2.4.11 → elapi-2.4.12}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "elapi"
-version = "2.4.11"
+version = "2.4.12"
 description = "elAPI is a powerful, extensible API client for eLabFTW."
 authors = [{ name = "Alexander Haller, Mahadi Xion", email = "elabftw@uni-heidelberg.de" }]
 requires-python = ">=3.11.0,<4"
@@ -40,6 +40,7 @@ dependencies = [
     # Used by yagmail, but added explicitly here to get an important security update
     "aiohttp>=3.13.5",
     # Used by httpx-aiohttp, but added explicitly here to get an important security update
+    "lxml>=6.1.0",
 ]
 license-files = [
     "LICENSE",
@@ -74,7 +75,7 @@ build-backend = "uv_build"
 [dependency-groups]
 dev = [
     "mypy>=1.18.2",
-    "pip>=25.1.1", # vendy requires pip
+    "pip>26.0.1", # vendy requires pip
     "ptpython>=3.0.23,<4",
     "vendy>=0.0.3",
 ]

elapi-2.4.12/src/elapi/VERSION

@@ -0,0 +1 @@
+2.4.12

{elapi-2.4.11 → elapi-2.4.12}/src/elapi/api/_handle_unexp_response.py

@@ -1,11 +1,23 @@
 import json
+from typing import TypedDict
 
 from ..loggers import Logger
 from ..utils import UnexpectedAPIResponseType
 from ._names import ElabUserGroups
 
 logger = Logger()
-NewUserTeamsType = list[dict[str, int | bool | str]]
+
+
+class _ElabUserTeamsDict(TypedDict, total=False):
+    id: int
+    name: str
+    usergroup: int
+    is_admin: bool
+    is_owner: bool
+    is_archived: bool
+
+
+NewUserTeamsType = list[_ElabUserTeamsDict]
 
 _DEBUG_LOG_EMIT_ONCE: bool = False
 
@@ -13,7 +25,7 @@ _DEBUG_LOG_EMIT_ONCE: bool = False
 def handle_new_user_teams(user_teams: str | NewUserTeamsType) -> NewUserTeamsType:
     global _DEBUG_LOG_EMIT_ONCE
 
-    struct_user_teams: list[dict[str, int | bool | str]] = []
+    struct_user_teams: list[_ElabUserTeamsDict] = []
     match user_teams:
         case list():
             struct_user_teams = user_teams

{elapi-2.4.11 → elapi-2.4.12}/src/elapi/api/_names.py

@@ -32,6 +32,9 @@ class ElabScopes(IntEnum):
 
 class ElabVersionDefaults:
     supported_versions: tuple[str, ...] = (
+        "5.5.11",
+        "5.5.10",
+        "5.5.9",
         "5.5.8",
         "5.5.7",
         "5.5.6",

elapi-2.4.12/src/elapi/api/_supported_versions/5.5.10.json

@@ -0,0 +1,62 @@
+{
+    "apikeys": [],
+    "compounds": [],
+    "config": [],
+    "dspace": [],
+    "event": [],
+    "events": [],
+    "experiments": [
+        "comments",
+        "compounds_links",
+        "experiments_links",
+        "items_links",
+        "revisions",
+        "steps",
+        "tags",
+        "uploads"
+    ],
+    "experiments_templates": [
+        "revisions",
+        "steps",
+        "tags"
+    ],
+    "exports": [],
+    "extra_fields_keys": [],
+    "favtags": [],
+    "idps": [
+        "certs",
+        "endpoints"
+    ],
+    "idps_sources": [],
+    "import": [],
+    "info": [],
+    "items": [
+        "comments",
+        "compounds_links",
+        "experiments_links",
+        "items_links",
+        "revisions",
+        "steps",
+        "tags",
+        "uploads"
+    ],
+    "items_types": [
+        "steps",
+        "tags"
+    ],
+    "reports": [],
+    "storage_units": [],
+    "teams": [
+        "experiments_categories",
+        "experiments_status",
+        "items_status",
+        "resources_categories",
+        "teamgroups"
+    ],
+    "todolist": [],
+    "unfinished_steps": [],
+    "users": [
+        "notifications",
+        "uploads"
+    ]
+}

elapi-2.4.12/src/elapi/api/_supported_versions/5.5.11.json

@@ -0,0 +1,62 @@
+{
+    "apikeys": [],
+    "compounds": [],
+    "config": [],
+    "dspace": [],
+    "event": [],
+    "events": [],
+    "experiments": [
+        "comments",
+        "compounds_links",
+        "experiments_links",
+        "items_links",
+        "revisions",
+        "steps",
+        "tags",
+        "uploads"
+    ],
+    "experiments_templates": [
+        "revisions",
+        "steps",
+        "tags"
+    ],
+    "exports": [],
+    "extra_fields_keys": [],
+    "favtags": [],
+    "idps": [
+        "certs",
+        "endpoints"
+    ],
+    "idps_sources": [],
+    "import": [],
+    "info": [],
+    "items": [
+        "comments",
+        "compounds_links",
+        "experiments_links",
+        "items_links",
+        "revisions",
+        "steps",
+        "tags",
+        "uploads"
+    ],
+    "items_types": [
+        "steps",
+        "tags"
+    ],
+    "reports": [],
+    "storage_units": [],
+    "teams": [
+        "experiments_categories",
+        "experiments_status",
+        "items_status",
+        "resources_categories",
+        "teamgroups"
+    ],
+    "todolist": [],
+    "unfinished_steps": [],
+    "users": [
+        "notifications",
+        "uploads"
+    ]
+}

elapi-2.4.12/src/elapi/api/_supported_versions/5.5.9.json

@@ -0,0 +1,59 @@
+{
+    "apikeys": [],
+    "compounds": [],
+    "config": [],
+    "dspace": [],
+    "event": [],
+    "events": [],
+    "experiments": [
+        "comments",
+        "compounds_links",
+        "experiments_links",
+        "items_links",
+        "revisions",
+        "steps",
+        "tags",
+        "uploads"
+    ],
+    "experiments_templates": [
+        "revisions",
+        "steps",
+        "tags"
+    ],
+    "exports": [],
+    "extra_fields_keys": [],
+    "favtags": [],
+    "idps": [],
+    "idps_sources": [],
+    "import": [],
+    "info": [],
+    "items": [
+        "comments",
+        "compounds_links",
+        "experiments_links",
+        "items_links",
+        "revisions",
+        "steps",
+        "tags",
+        "uploads"
+    ],
+    "items_types": [
+        "steps",
+        "tags"
+    ],
+    "reports": [],
+    "storage_units": [],
+    "teams": [
+        "experiments_categories",
+        "experiments_status",
+        "items_status",
+        "resources_categories",
+        "teamgroups"
+    ],
+    "todolist": [],
+    "unfinished_steps": [],
+    "users": [
+        "notifications",
+        "uploads"
+    ]
+}

{elapi-2.4.11 → elapi-2.4.12}/src/elapi/path.py

@@ -240,7 +240,7 @@ class ProperPath:
                 f"Could not open file {self._error_helper_compare_path_source(self.name, file)}. "
                 f"Exception: {e!r}"
             )
-            self.PathException = e
+            self.PathException = e.__class__
             raise e
         except (os_exception := OSError) as e:
             self.err_logger.debug(

{elapi-2.4.11 → elapi-2.4.12}/src/elapi/plugins/bill_teams/bill_teams.py

@@ -1,6 +1,8 @@
+from collections import defaultdict
 from datetime import datetime
+from functools import cached_property
 from pathlib import Path
-from typing import Union
+from typing import TypedDict, Union
 
 from dateutil import parser
 from dateutil.relativedelta import relativedelta
@@ -14,6 +16,30 @@ from ..commons import AsyncInformation, Information, RecursiveInformation
 logger = Logger()
 
 
+class TeamMembersDict(TypedDict):
+    firstname: str
+    lastname: str
+    email: str
+    usergroup: str
+    is_archived: bool
+    is_expired: bool
+
+
+class TeamsDict(TypedDict, total=False):
+    active_member_count: int
+    admins: dict[str, TeamMembersDict]
+    members: dict[str, TeamMembersDict]
+    on_trial: bool
+    team_created_at: str
+    team_id: int
+    team_name: str
+    total_archived_member_count: int
+    total_expired_member_count: int
+    total_member_count: int
+    total_unarchived_member_count: int
+    trial_ends_at: str
+
+
 class UsersInformation:
     __slots__ = "users", "user_id_prefix"
     endpoint_name = "users"
@@ -27,6 +53,7 @@ class UsersInformation:
         )
         for user in all_users:
             if (user_teams := user.get("teams")) is not None:
+                # noinspection PyTypeChecker
                 if handle_new_user_teams(user_teams) is not None:
                     return all_users
                 return await fallback_all_users.items()
@@ -102,7 +129,7 @@ class OwnersInformation:
 
 
 class TeamsList:
-    __slots__ = "users", "teams", "contract"
+    __slots__ = "users", "teams", "contract", "__dict__"
 
     def __init__(
         self,
@@ -112,16 +139,12 @@ class TeamsList:
         self.users = users_information
         self.teams = teams_information
 
-    @property
+    @cached_property
     def BILL_RUN_DATE(self) -> datetime:
+        # cached_property is used to make sure that the same
+        # current datetime is used for all comparisons
         return datetime.now()
 
-    @BILL_RUN_DATE.setter
-    def BILL_RUN_DATE(self, value):
-        raise AttributeError(
-            "BILL_RUN_DATE is always the current date. It cannot be modified!"
-        )
-
     @property
     def LAUNCH_DATE(self) -> datetime:
         return datetime(2023, 8, 1, 0, 0, 0)
@@ -141,62 +164,44 @@ class TeamsList:
                 return True
         return False
 
-    def _get_owners(self, admins_only: bool = False) -> dict:
+    def _get_teams(self, admins_only: bool = False) -> dict:
         # Generate teams information with team owners
-        team_members: dict[str, dict[str, dict[str, str | bool | int]]] = {}
-        admins: dict[str, dict[str, dict[str, str | bool | int]]] = {}
-        teams: dict[str, dict[str, str | int | dict]] = {}
+        # noinspection PyTypeChecker
+        team_members: defaultdict[str, dict[str, TeamMembersDict]] = defaultdict(dict)
+        # noinspection PyTypeChecker
+        admins: defaultdict[str, dict[str, TeamMembersDict]] = defaultdict(dict)
+        teams: dict[str, TeamsDict] = {}
         for u in self.users:
             user_teams = handle_new_user_teams(u["teams"])
-            for team in user_teams:  # O(n^2): user_teams is again an iterable!
+            for team in user_teams:  # O(n^2): we iterate over the "teams" field
                 uid = u["userid"]
                 # Get teams user count
                 team_id = str(team["id"])
-                if not team_members.get(team_id):
-                    team_members[team_id] = {
+                team_members[team_id].update(
+                    {
                         uid: {
                             "firstname": u["firstname"],
                             "lastname": u["lastname"],
                             "email": u["email"],
                             "usergroup": team["usergroup"],
-                            "expired": self.is_user_expired(user_data=u),
+                            "is_archived": bool(team["is_archived"]),
+                            "is_expired": self.is_user_expired(user_data=u),
                         }
                     }
-                else:
-                    team_members[team_id].update(
+                )
+                if team["usergroup"] == ElabUserGroups.admin:
+                    admins[team_id].update(
                         {
                             uid: {
                                 "firstname": u["firstname"],
                                 "lastname": u["lastname"],
                                 "email": u["email"],
                                 "usergroup": team["usergroup"],
-                                "expired": self.is_user_expired(user_data=u),
+                                "is_archived": bool(team["is_archived"]),
+                                "is_expired": self.is_user_expired(user_data=u),
                             }
                         }
                     )
-                if team["usergroup"] == ElabUserGroups.admin:
-                    if not admins.get(team_id):
-                        admins[team_id] = {
-                            uid: {
-                                "firstname": u["firstname"],
-                                "lastname": u["lastname"],
-                                "email": u["email"],
-                                "usergroup": team["usergroup"],
-                                "expired": self.is_user_expired(user_data=u),
-                            }
-                        }
-                    else:
-                        admins[team_id].update(
-                            {
-                                uid: {
-                                    "firstname": u["firstname"],
-                                    "lastname": u["lastname"],
-                                    "email": u["email"],
-                                    "usergroup": team["usergroup"],
-                                    "expired": self.is_user_expired(user_data=u),
-                                }
-                            }
-                        )
                 # Get team basic information
                 teams[team_id] = {}
                 teams[team_id]["team_name"] = team["name"]
@@ -214,10 +219,22 @@ class TeamsList:
                 teams[team_id]["members"] = {}
                 teams[team_id]["members"] = team_members[team_id]
             teams[team_id]["admins"] = admins.get(team_id, {})
-            teams[team_id]["total_unarchived_member_count"] = len(team_members[team_id])
-            teams[team_id]["active_member_count"]: int = 0
+            teams[team_id]["total_member_count"] = len(team_members[team_id])
+            teams[team_id]["total_unarchived_member_count"] = 0
+            teams[team_id]["total_archived_member_count"] = 0
+            teams[team_id]["total_expired_member_count"] = 0
+            teams[team_id]["active_member_count"] = 0
             for k in team_members[team_id]:
-                if team_members[team_id][k]["expired"] is False:
+                if not team_members[team_id][k]["is_archived"]:
+                    teams[team_id]["total_unarchived_member_count"] += 1
+                if team_members[team_id][k]["is_archived"]:
+                    teams[team_id]["total_archived_member_count"] += 1
+                if team_members[team_id][k]["is_expired"]:
+                    teams[team_id]["total_expired_member_count"] += 1
+                if not (
+                    team_members[team_id][k]["is_expired"]
+                    or team_members[team_id][k]["is_archived"]
+                ):
                     teams[team_id]["active_member_count"] += 1
             # Add trial information
             trial_starts_at = self.team_trial_start_date(
@@ -225,12 +242,12 @@ class TeamsList:
             )
             trial_ends_at = trial_starts_at + self.TRIAL_PERIOD
             teams[team_id]["trial_ends_at"] = str(trial_ends_at)
-            teams[team_id]["on_trial"] = trial_ends_at > datetime.now()
+            teams[team_id]["on_trial"] = trial_ends_at > self.BILL_RUN_DATE
 
         return teams
 
     def items(self, admins_only: bool = False) -> dict:
-        return self._get_owners(admins_only)
+        return self._get_teams(admins_only)
 
 
 class OwnersList:

{elapi-2.4.11 → elapi-2.4.12}/src/elapi/plugins/bill_teams/cli.py

@@ -9,6 +9,7 @@ from types import NoneType
 
 import typer
 
+from ...path import ProperPath
 from ...utils import UnexpectedAPIResponseType
 from .generate_table import is_team_on_trial
 from .names import PLUGIN_NAME, REGISTRY_SUB_PLUGIN_NAME, TARGET_GROUP_NAME
@@ -135,6 +136,17 @@ else:
         # meant to suppress raising the final exception once all attempts have been made
     )
     def get_teams(
+        users_data_path: Annotated[
+            Optional[str],
+            typer.Option(
+                "--users-data-path",
+                "-U",
+                help="File path to users JSON data. If passed, "
+                "this will be considered as the source of user data truth. The JSON structure "
+                "must match the API response of 'elapi get users'",
+                show_default=False,
+            ),
+        ] = None,
         admins_only: Annotated[
             bool,
             typer.Option(
@@ -183,6 +195,16 @@ else:
         from ...api.validators import HostIdentityValidator, PermissionValidator
         from ...core_validators import Validate
 
+        if users_data_path is not None:
+            try:
+                users_data_path_ = ProperPath(users_data_path)
+            except (ValueError, TypeError):
+                print_typer_error(
+                    f"--users-data '{users_data_path}' must be a valid file path."
+                )
+                raise Exit(1)
+        else:
+            users_data_path_ = None
         global_session = GlobalSharedSession(
             async_rate_limit=(
                 async_rate_limit := _retry_init_handler.get_updated_rate_limit(
@@ -237,11 +259,16 @@ else:
             UsersInformation,
         )
 
-        users_info, teams_info = UsersInformation(), TeamsInformation()
+        teams_info = TeamsInformation()
 
         async def gather_teams_list() -> TeamsList:
+            if users_data_path_ is not None:
+                with users_data_path_.open("r", encoding="utf-8") as users_data_file:
+                    users_info = json.load(users_data_file)
+            else:
+                users_info = await UsersInformation().items()
             try:
-                tl = TeamsList(await users_info.items(), await teams_info.aitems())
+                tl = TeamsList(users_info, await teams_info.aitems())
             except (RuntimeError, InterruptedError) as error:
                 logger.error(
                     f"Retrieving users/teams data has failed. Exception details: {error}"

elapi-2.4.11/src/elapi/VERSION

@@ -1 +0,0 @@
-2.4.11