elapi 2.4.5__tar.gz → 2.4.7__tar.gz

{elapi-2.4.5 → elapi-2.4.7}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: elapi
-Version: 2.4.5
+Version: 2.4.7
 Summary: elAPI is a powerful, extensible API client for eLabFTW.
 Keywords: elabftw,api
 Author: Alexander Haller, Mahadi Xion
@@ -143,7 +143,7 @@ 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.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`,
+versions: `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 strict version support

{elapi-2.4.5 → elapi-2.4.7}/README.md

@@ -93,7 +93,7 @@ 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.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`,
+versions: `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 strict version support

{elapi-2.4.5 → elapi-2.4.7}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "elapi"
-version = "2.4.5"
+version = "2.4.7"
 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"

elapi-2.4.7/src/elapi/VERSION

@@ -0,0 +1 @@
+2.4.7

{elapi-2.4.5 → elapi-2.4.7}/src/elapi/api/_names.py

@@ -32,6 +32,8 @@ class ElabScopes(IntEnum):
 
 class ElabVersionDefaults:
     supported_versions: tuple[str, ...] = (
+        "5.3.9",
+        "5.3.8",
         "5.3.7",
         "5.3.6",
         "5.3.5",

elapi-2.4.7/src/elapi/api/_supported_versions/5.3.8.json

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

elapi-2.4.7/src/elapi/api/_supported_versions/5.3.9.json

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

{elapi-2.4.5 → elapi-2.4.7}/src/elapi/configuration/validators.py

@@ -329,7 +329,8 @@ class ElabVersionModeWithFallbackConfigurationValidator(
                 f"The default value '{self.fallback_value}' will be used instead."
             )
             return self.fallback_value
-        if value.lower() not in ElabStrictVersionMatchModes:
+        if value.lower() not in ElabStrictVersionMatchModes.__members__.values():
+            # Python 3.11.2 doesn't support "v in ElabStrictVersionMatchModes"
             logger.warning(
                 f"'{self.key_name.lower()}' is detected in configuration file, "
                 f"but it's value '{value}' is not valid. Valid values: "

{elapi-2.4.5 → elapi-2.4.7}/src/elapi/plugins/bill_teams/specification.py

@@ -1,14 +1,14 @@
 from dataclasses import dataclass
 from datetime import datetime
 
+from ...configuration import DEFAULT_EXPORT_DATA_FORMAT
+from ...plugins.commons.export import Export
 from .names import (
     REGISTRY_SUB_PLUGIN_NAME,
     TARGET_GROUP_NAME,
-    TARGET_GROUP_OWNER_NAME,
     TARGET_GROUP_NAME_SINGULAR,
+    TARGET_GROUP_OWNER_NAME,
 )
-from ...configuration import DEFAULT_EXPORT_DATA_FORMAT
-from ...plugins.commons.export import Export
 
 BILLING_INFO_OUTPUT_EXTENSION: str = DEFAULT_EXPORT_DATA_FORMAT
 BILLING_INFO_OUTPUT_TEAMS_INFO_FILE_NAME_STUB: str = f"{TARGET_GROUP_NAME}_info"
@@ -59,10 +59,27 @@ class OwnersDataSpecification:
     TEAM_ACRONYM_EXT: str = "team_acronymext"
     TEAM_ACRONYM_INT: str = "team_acronymint"
     TEAM_GONE: str = "team_gone"
+    # Mostly extra column names for completeness's sake.
+    # We will likely not need to use them in bill-teams.
     TEAM_SPECIAL: str = "team_special"
     TEAM_LIME_SURVEY: str = "team_limesurvey"
     TEAM_SIGNED_CONTRACT: str = "team_signedcontract"
     TEAM_END_DATE: str = "team_enddate"
+    TEAM_CONTRACT_2_SECT: str = "team_contracttosecretary"
+    TEAM_DOUBLE_SIGNED: str = "team_doublesignedcontract"
+    TEAM_SENT_SIGNED_CONTRACT: str = "team_sentsignedcontract"
+    TEAM_CONTRACT_NAME: str = "team_contractname"
+    TEAM_SET_EXPIRATION: str = "team_setexpiration"
+    TEAM_SET_REMINDER: str = "team_setreminder"
+    TEAM_COMMENT: str = "team_comment"
+
+
+@dataclass
+class TeamGoneStatus:
+    not_gone: str = "0"
+    contract_expired: str = "1"
+    deleted: str = "deleted"  # team deleted from the eLabFTW server
+    pattern: str = rf"^[{not_gone}{contract_expired}]$|^{deleted}$"
 
 
 @dataclass

{elapi-2.4.5 → elapi-2.4.7}/src/elapi/plugins/bill_teams/validators.py

@@ -1,5 +1,6 @@
 import datetime
 import json
+from copy import copy
 from json import JSONDecodeError
 from pathlib import Path
 from types import NoneType
@@ -18,6 +19,7 @@ from .specification import (
     REGISTRY_KEY_OWNERS_INFO_DATE,
     REGISTRY_KEY_TEAMS_INFO_DATE,
     OwnersDataSpecification,
+    TeamGoneStatus,
 )
 
 logger = Logger()
@@ -30,7 +32,7 @@ class OwnersInformationContainer:
     def __init__(self, data: dict, /):
         self.data = data
 
-    def get(self, team_id: Union[str, int], column_name: str) -> Union[int, str]:
+    def get(self, team_id: Union[str, int], column_name: str) -> str:
         if not isinstance(team_id, int):
             try:
                 team_id = int(team_id)
@@ -201,7 +203,28 @@ class OwnersInformationValidator(Validator):
             # See: https://stackoverflow.com/a/48850520, https://stackoverflow.com/a/24999035
         except (SanitizationError, FormatError) as e:
             raise ValidationError(e)
-        if len(owner_ids) != 0:
+        # spec.TEAM_GONE is validated weakly
+        for owner_team_id in copy(owner_ids):
+            team_gone_status = self.owners.get(owner_team_id, spec.TEAM_GONE)
+            try:
+                formatter.format(
+                    owner_team_id,
+                    spec.TEAM_GONE,
+                    expected_pattern=TeamGoneStatus.pattern,
+                    function_to_apply=lambda x: str(x).lower(),
+                )
+                # format sets spec.TEAM_GONE to self.owners.data!
+            except (SanitizationError, FormatError):
+                logger.debug(
+                    f"Column '{spec.TEAM_GONE}' has value that is unexpected: "
+                    f"'{team_gone_status}'. While this column is not "
+                    f"really used for the final billing output table, this issue "
+                    f"should still be fixed."
+                )
+            # Regardless of the validation errors, we check for "deleted".
+            if self.owners.get(owner_team_id, spec.TEAM_GONE) == TeamGoneStatus.deleted:
+                owner_ids.discard(owner_team_id)
+        if owner_ids:
             logger.info(
                 f"The following team IDs '{', '.join(map(str, owner_ids))}' exist in the "
                 f"metadata ('{BILLING_INFO_OUTPUT_OWNERS_INFO_FILE_NAME_STUB}') "

elapi-2.4.5/src/elapi/VERSION

@@ -1 +0,0 @@
-2.4.5