dsp-tools 9.1.0.post11__py3-none-any.whl → 18.3.0.post13__py3-none-any.whl

dsp_tools/commands/{project/models → get/legacy_models}/project.py

@@ -19,10 +19,10 @@ from typing import Optional
 from typing import Union
 from urllib.parse import quote_plus
 
-from dsp_tools.commands.project.models.model import Model
-from dsp_tools.models.exceptions import BaseError
-from dsp_tools.models.langstring import LangString
-from dsp_tools.utils.connection import Connection
+from dsp_tools.clients.connection import Connection
+from dsp_tools.commands.get.legacy_models.model import Model
+from dsp_tools.error.exceptions import BaseError
+from dsp_tools.legacy_models.langstring import LangString
 
 
 class Project(Model):
@@ -87,12 +87,11 @@ class Project(Model):
     _description: LangString
     _keywords: set[str]
     _ontologies: set[str]
+    _enabled_licenses: set[str]
     _selfjoin: bool
     _status: bool
     _logo: Optional[str]
 
-    SYSTEM_PROJECT: str = "http://www.knora.org/ontology/knora-admin#SystemProject"
-
     def __init__(
         self,
         con: Connection,
@@ -103,6 +102,7 @@ class Project(Model):
         description: LangString = None,
         keywords: Optional[set[str]] = None,
         ontologies: Optional[set[str]] = None,
+        enabled_licenses: Optional[set[str]] = None,
         selfjoin: Optional[bool] = None,
         status: Optional[bool] = None,
         logo: Optional[str] = None,
@@ -118,6 +118,7 @@ class Project(Model):
         :param description: LangString instance containing the description [required for CREATE]
         :param keywords: Set of keywords [required for CREATE]
         :param ontologies: Set of ontologies that belong to this project [optional]
+        :param enabled_licenses: Set of enabled licenses [optional]
         :param selfjoin: Allow selfjoin [required for CREATE]
         :param status: Status of project (active if True) [required for CREATE]
         :param logo: Path to logo image file [optional] NOT YET USED
@@ -132,6 +133,7 @@ class Project(Model):
         if not isinstance(ontologies, set) and ontologies is not None:
             raise BaseError("Ontologies must be a set of strings or None!")
         self._ontologies = ontologies
+        self._enabled_licenses = enabled_licenses or set()
         self._selfjoin = selfjoin
         self._status = status
         self._logo = logo
@@ -259,6 +261,7 @@ class Project(Model):
         ontologies = set(json_obj.get("ontologies"))
         if ontologies is None:
             raise BaseError("ontologies are missing")
+        enabled_licenses = json_obj.get("enabledLicenses", set())
         selfjoin = json_obj.get("selfjoin")
         if selfjoin is None:
             raise BaseError("Selfjoin is missing")
@@ -275,6 +278,7 @@ class Project(Model):
             description=description,
             keywords=keywords,
             ontologies=ontologies,
+            enabled_licenses=enabled_licenses,
             selfjoin=selfjoin,
             status=status,
             logo=logo,
@@ -287,6 +291,7 @@ class Project(Model):
             "longname": self._longname,
             "descriptions": self._description.createDefinitionFileObj(),
             "keywords": list(self._keywords),
+            "enabled_licenses": list(self._enabled_licenses),
         }
 
     def create(self) -> Project:
@@ -315,6 +320,8 @@ class Project(Model):
         tmp["description"] = self._description.toJsonObj()
         if self._keywords is not None and len(self._keywords) > 0:
             tmp["keywords"] = self._keywords
+        if self._enabled_licenses:
+            tmp["enabledLicenses"] = list(self._enabled_licenses)
         if self._selfjoin is None:
             raise BaseError("selfjoin must be defined (True or False!")
         tmp["selfjoin"] = self._selfjoin

dsp_tools/commands/{project/models → get/legacy_models}/propertyclass.py

@@ -1,21 +1,20 @@
 from __future__ import annotations
 
+from collections.abc import Sequence
 from typing import Any
 from typing import Optional
-from typing import Sequence
 from typing import Union
-from urllib.parse import quote_plus
 
 import regex
 
-from dsp_tools.commands.project.models.context import Context
-from dsp_tools.commands.project.models.helpers import WithId
-from dsp_tools.commands.project.models.listnode import ListNode
-from dsp_tools.commands.project.models.model import Model
-from dsp_tools.models.datetimestamp import DateTimeStamp
-from dsp_tools.models.exceptions import BaseError
-from dsp_tools.models.langstring import LangString
-from dsp_tools.utils.connection import Connection
+from dsp_tools.clients.connection import Connection
+from dsp_tools.commands.get.legacy_models.context import Context
+from dsp_tools.commands.get.legacy_models.helpers import WithId
+from dsp_tools.commands.get.legacy_models.listnode import ListNode
+from dsp_tools.commands.get.legacy_models.model import Model
+from dsp_tools.error.exceptions import BaseError
+from dsp_tools.legacy_models.datetimestamp import DateTimeStamp
+from dsp_tools.legacy_models.langstring import LangString
 
 
 class PropertyClass(Model):
@@ -352,12 +351,6 @@ class PropertyClass(Model):
                 tmp["@graph"][0]["rdfs:comment"] = self._comment.toJsonLdObj()
         return tmp
 
-    def delete(self, last_modification_date: DateTimeStamp) -> DateTimeStamp:
-        result = self._con.delete(
-            PropertyClass.ROUTE + "/" + quote_plus(self._iri) + "?lastModificationDate=" + str(last_modification_date)
-        )
-        return DateTimeStamp(result["knora-api:lastModificationDate"])
-
     def createDefinitionFileObj(self, context: Context, shortname: str) -> dict[str, Any]:
         """
         Create an object that can be used as input for `create_onto()` to create an ontology on a DSP server

dsp_tools/commands/{project/models → get/legacy_models}/resourceclass.py

@@ -7,22 +7,21 @@ This model implements the handling of resource classes. It contains two classes
 
 from __future__ import annotations
 
+from collections.abc import Sequence
 from enum import Enum
 from typing import Any
 from typing import Optional
-from typing import Sequence
 from typing import Union
-from urllib.parse import quote_plus
 
 import regex
 
-from dsp_tools.commands.project.models.context import Context
-from dsp_tools.commands.project.models.helpers import Cardinality
-from dsp_tools.commands.project.models.model import Model
-from dsp_tools.models.datetimestamp import DateTimeStamp
-from dsp_tools.models.exceptions import BaseError
-from dsp_tools.models.langstring import LangString
-from dsp_tools.utils.connection import Connection
+from dsp_tools.clients.connection import Connection
+from dsp_tools.commands.get.legacy_models.context import Context
+from dsp_tools.commands.get.legacy_models.helpers import Cardinality
+from dsp_tools.commands.get.legacy_models.model import Model
+from dsp_tools.error.exceptions import BaseError
+from dsp_tools.legacy_models.datetimestamp import DateTimeStamp
+from dsp_tools.legacy_models.langstring import LangString
 
 
 class HasProperty(Model):
@@ -478,37 +477,6 @@ class ResourceClass(Model):
     def has_properties(self) -> dict[str, HasProperty]:
         return self._has_properties
 
-    def getProperty(self, property_id: str) -> Optional[HasProperty]:
-        if self._has_properties is None:
-            return None
-        else:
-            return self._has_properties.get(self._context.get_prefixed_iri(property_id))
-
-    def addProperty(
-        self,
-        last_modification_date: DateTimeStamp,
-        property_id: str,
-        cardinality: Cardinality,
-        gui_order: Optional[int] = None,
-    ) -> DateTimeStamp:
-        if self._has_properties.get(property_id) is None:
-            latest_modification_date, resclass = HasProperty(
-                con=self._con,
-                context=self._context,
-                ontology_id=self._ontology_id,
-                property_id=property_id,
-                resclass_id=self.iri,
-                cardinality=cardinality,
-                gui_order=gui_order,
-            ).create(last_modification_date)
-            hp = resclass.getProperty(property_id)
-            hp.ontology_id = self._context.iri_from_prefix(self._ontology_id)
-            hp.resclass_id = self._iri
-            self._has_properties[hp.property_id] = hp
-            return latest_modification_date
-        else:
-            raise BaseError("Property already has cardinality in this class! " + property_id)
-
     @classmethod
     def fromJsonObj(cls, con: Connection, context: Context, json_obj: Any) -> ResourceClass:
         if isinstance(json_obj, list):
@@ -671,12 +639,6 @@ class ResourceClass(Model):
         else:
             return {"@id": "knora-api:" + resref}  # no ":", must be from knora-api!
 
-    def delete(self, last_modification_date: DateTimeStamp) -> DateTimeStamp:
-        result = self._con.delete(
-            ResourceClass.ROUTE + "/" + quote_plus(self._iri) + "?lastModificationDate=" + str(last_modification_date)
-        )
-        return DateTimeStamp(result["knora-api:lastModificationDate"])
-
     def createDefinitionFileObj(self, context: Context, shortname: str, skiplist: list[str]) -> dict[str, Any]:
         resource = {"name": self._name}
         if self._superclasses:

dsp_tools/commands/{project/models → get/legacy_models}/user.py

@@ -21,12 +21,11 @@ from typing import Optional
 from typing import Union
 from urllib.parse import quote_plus
 
-from dsp_tools.commands.project.models.group import Group
-from dsp_tools.commands.project.models.model import Model
-from dsp_tools.commands.project.models.project import Project
-from dsp_tools.models.exceptions import BaseError
-from dsp_tools.models.langstring import Languages
-from dsp_tools.utils.connection import Connection
+from dsp_tools.clients.connection import Connection
+from dsp_tools.commands.get.legacy_models.group import Group
+from dsp_tools.commands.get.legacy_models.model import Model
+from dsp_tools.error.exceptions import BaseError
+from dsp_tools.legacy_models.langstring import Languages
 
 
 class User(Model):
@@ -60,9 +59,6 @@ class User(Model):
     status : bool
         Status of the user, If active, is set to True, otherwise false [read/write]
 
-    sysadmin : bool
-        True, if user is system administrator [read/write]
-
     in_groups : set[str]
         Set of group IRI's the user is member of [readonly].
 
@@ -103,7 +99,6 @@ class User(Model):
     _password: str
     _lang: Languages
     _status: bool
-    _sysadmin: bool
     _in_groups: set[str]
     _in_projects: dict[str, bool]
     _add_to_project: dict[str, bool]
@@ -123,7 +118,6 @@ class User(Model):
         password: Optional[str] = None,
         lang: Optional[Union[str, Languages]] = None,
         status: Optional[bool] = None,
-        sysadmin: Optional[bool] = None,
         in_projects: Optional[dict[str, bool]] = None,
         in_groups: Optional[set[str]] = None,
     ):
@@ -141,7 +135,6 @@ class User(Model):
         :param password: Password [required for CREATE]
         :param lang: Preferred language of the user [optional]
         :param status: Status (active = True, inactive/deleted = False) [optional]
-        :param sysadmin: User has system administration privileges [optional]
         :param in_projects: Dict with project-IRI as key, boolean(True=project admin) as value [optional]
         :param in_groups: Set with group-IRI's the user should belong to [optional]
         """
@@ -174,8 +167,6 @@ class User(Model):
         else:
             raise BaseError("In_groups must be a set of strings or None!")
 
-        self._sysadmin = None if sysadmin is None else bool(sysadmin)
-
     @property
     def iri(self) -> Optional[str]:
         """IRI of this user"""
@@ -271,17 +262,6 @@ class User(Model):
         if value is not None:
             self._changed.add("status")
 
-    @property
-    def sysadmin(self) -> bool:
-        """True if the user is sysadmin"""
-        return self._sysadmin
-
-    @sysadmin.setter
-    def sysadmin(self, value: bool) -> None:
-        self._sysadmin = None if value is None else bool(value)
-        if value is not None:
-            self._changed.add("sysadmin")
-
     @property
     def in_groups(self) -> set[str]:
         """Set of group IRI's the user is member of"""
@@ -296,7 +276,7 @@ class User(Model):
     def _make_fromJsonObj(cls, con: Connection, json_obj: dict[str, Any]) -> User:
         User._check_if_jsonObj_has_required_info(json_obj)
 
-        sysadmin, in_groups, in_projects = cls._update_permissions_and_groups(json_obj)
+        in_groups, in_projects = cls._update_permissions_and_groups(json_obj)
 
         return cls(
             con=con,
@@ -307,7 +287,6 @@ class User(Model):
             familyName=json_obj.get("familyName"),
             lang=json_obj.get("lang"),
             status=json_obj["status"],
-            sysadmin=sysadmin,
             in_projects=in_projects,
             in_groups=in_groups,
         )
@@ -331,26 +310,21 @@ class User(Model):
             raise BaseError("\n".join(problems))
 
     @classmethod
-    def _update_permissions_and_groups(cls, json_obj: dict[str, Any]) -> tuple[bool | None, set[str], dict[str, bool]]:
+    def _update_permissions_and_groups(cls, json_obj: dict[str, Any]) -> tuple[set[str], dict[str, bool]]:
         in_projects: dict[str, bool] = {}
         in_groups: set[str] = set()
         if json_obj.get("permissions") is not None and json_obj["permissions"].get("groupsPerProject") is not None:
-            sysadmin = False
             for project_iri, group_memberships in json_obj["permissions"]["groupsPerProject"].items():
-                if project_iri == Project.SYSTEM_PROJECT:
-                    if Group.PROJECT_SYSTEMADMIN_GROUP in group_memberships:
-                        sysadmin = True
-                else:
-                    for group in group_memberships:
-                        if group == Group.PROJECT_MEMBER_GROUP:
-                            if in_projects.get(project_iri) is None:
-                                in_projects[project_iri] = False
-                        elif group == Group.PROJECT_ADMIN_GROUP:
-                            in_projects[project_iri] = True
-                        else:
-                            in_groups.add(group)
-            return sysadmin, in_groups, in_projects
-        return None, in_groups, in_projects
+                for group in group_memberships:
+                    if group == Group.PROJECT_MEMBER_GROUP:
+                        if in_projects.get(project_iri) is None:
+                            in_projects[project_iri] = False
+                    elif group == Group.PROJECT_ADMIN_GROUP:
+                        in_projects[project_iri] = True
+                    else:
+                        in_groups.add(group)
+            return in_groups, in_projects
+        return in_groups, in_projects
 
     def create(self) -> User:
         """
@@ -394,7 +368,8 @@ class User(Model):
             raise BaseError("'language' is mandatory!")
         tmp["lang"] = self._lang.value
         tmp["status"] = True if self._status is None else self._status
-        tmp["systemAdmin"] = False if self._sysadmin is None else self._sysadmin
+        # the API expects the key "systemAdmin" to be present. DSP-TOOLS doesn't support creating SystemAdmins any more.
+        tmp["systemAdmin"] = False
         return tmp
 
     def read(self) -> User:
@@ -413,20 +388,6 @@ class User(Model):
             raise BaseError("Either user-iri or email is required!")
         return User._make_fromJsonObj(self._con, result["user"])
 
-    @staticmethod
-    def getAllUsers(con: Connection) -> list[Any]:
-        """
-        Get a list of all users (static method)
-
-        :param con: Connection instance
-        :return: List of users
-        """
-
-        result = con.get(User.ROUTE)
-        if "users" not in result:
-            raise BaseError("Request got no users!")
-        return [User._make_fromJsonObj(con, a) for a in result["users"]]
-
     @staticmethod
     def getAllUsersForProject(con: Connection, proj_shortcode: str) -> Optional[list[User]]:
         """
@@ -465,8 +426,6 @@ class User(Model):
             if "group" in group_info and "name" in group_info["group"]:
                 groupname = group_info["group"]["name"]
                 groups.append(f"{proj_shortname}:{groupname}")
-        if self._sysadmin:
-            groups.append("SystemAdmin")
         user["groups"] = groups
         user["projects"] = list()
         for proj, is_admin in self._in_projects.items():

dsp_tools/commands/get/models/permissions_models.py

@@ -0,0 +1,10 @@
+from dataclasses import dataclass
+from typing import Any
+
+
+@dataclass
+class DoapCategories:
+    class_doaps: list[dict[str, Any]]
+    prop_doaps: list[dict[str, Any]]
+    has_img_all_classes_doaps: list[dict[str, Any]]
+    has_img_specific_class_doaps: list[dict[str, Any]]

dsp_tools/commands/id2iri.py

@@ -1,5 +1,6 @@
 import copy
 import json
+import warnings
 from collections.abc import Mapping
 from datetime import datetime
 from pathlib import Path
@@ -8,8 +9,9 @@ import regex
 from loguru import logger
 from lxml import etree
 
-from dsp_tools.models.exceptions import UserError
-from dsp_tools.utils.xml_utils import parse_and_clean_xml_file
+from dsp_tools.error.custom_warnings import DspToolsUserWarning
+from dsp_tools.error.exceptions import InputError
+from dsp_tools.utils.xml_parsing.parse_clean_validate_xml import parse_and_clean_xml_file
 
 
 def _check_input_parameters(
@@ -25,7 +27,7 @@ def _check_input_parameters(
         json_file: the JSON file with the mapping (dict) of internal IDs to IRIs
 
     Raises:
-        UserError: if one of the files could not be found
+        InputError: if one of the files could not be found
 
     Returns:
         path objects of the input parameters
@@ -33,12 +35,12 @@ def _check_input_parameters(
     xml_file_as_path = Path(xml_file)
     if not xml_file_as_path.is_file():
         logger.error(f"File {xml_file} could not be found.")
-        raise UserError(f"File {xml_file} could not be found.")
+        raise InputError(f"File {xml_file} could not be found.")
 
     json_file_as_path = Path(json_file)
     if not json_file_as_path.is_file():
         logger.error(f"File {json_file} could not be found.")
-        raise UserError(f"File {json_file} could not be found.")
+        raise InputError(f"File {json_file} could not be found.")
 
     return xml_file_as_path, json_file_as_path
 
@@ -75,7 +77,10 @@ def _replace_resptrs(
         a tuple of the modified copy of the XML tree, and the set of the IDs that have been replaced
     """
     modified_tree = copy.deepcopy(tree)
-    resptr_xpath = "|".join([f"/knora/{x}/resptr-prop/resptr" for x in ["resource", "annotation", "link", "region"]])
+    xpaths = [f"/knora/{x}/resptr-prop/resptr" for x in ["resource", "link", "region"]]
+    xpaths.extend([f"/knora/{x}-segment/isSegmentOf" for x in ["video", "audio"]])
+    xpaths.extend([f"/knora/{x}-segment/relatesTo" for x in ["video", "audio"]])
+    resptr_xpath = "|".join(xpaths)
     resptr_elems = modified_tree.xpath(resptr_xpath)
     resptr_elems_replaced = 0
     for resptr_elem in resptr_elems:
@@ -108,7 +113,10 @@ def _replace_salsah_links(
         a tuple of the modified copy of the XML tree, and the set of the IDs that have been replaced
     """
     modified_tree = copy.deepcopy(tree)
-    salsah_xpath = "|".join([f"/knora/{x}/text-prop/text//a" for x in ["resource", "annotation", "link", "region"]])
+    xpaths = [f"/knora/{x}/text-prop/text//a" for x in ["resource", "link", "region"]]
+    xpaths.extend([f"/knora/{x}-segment/hasComment//a" for x in ["video", "audio"]])
+    xpaths.extend([f"/knora/{x}-segment/hasDescription//a" for x in ["video", "audio"]])
+    salsah_xpath = "|".join(xpaths)
     salsah_links = [x for x in modified_tree.xpath(salsah_xpath) if x.attrib.get("class") == "salsah-link"]
     salsah_links_replaced = 0
     for salsah_link in salsah_links:
@@ -175,7 +183,9 @@ def _remove_resources_if_id_in_mapping(
         a modified copy of the XML tree
     """
     modified_tree = copy.deepcopy(tree)
-    resources = modified_tree.xpath("|".join([f"/knora/{x}" for x in ["resource", "annotation", "link", "region"]]))
+    resources = modified_tree.xpath(
+        "|".join([f"/knora/{x}" for x in ["resource", "link", "region", "video-segment", "audio-segment"]])
+    )
     resources_to_remove = [x for x in resources if x.attrib.get("id") in mapping]
     for resource in resources_to_remove:
         resource.getparent().remove(resource)
@@ -184,8 +194,8 @@ def _remove_resources_if_id_in_mapping(
         f"Removed {len(resources_to_remove)}/{len(resources)} resources from the XML file, "
         "because their ID was in the mapping"
     )
-    logger.info(msg)
-    print(msg)
+    logger.warning(msg)
+    warnings.warn(DspToolsUserWarning(msg))
 
     return modified_tree