sharepoint-v1-api 0.2.2__tar.gz → 0.2.3__tar.gz

sharepoint_v1_api-0.2.3/CHANGELOG.md

@@ -0,0 +1,47 @@
+## 0.2.3 – 2025-12-02
+
+### Added
+
+- GUID validation for list identifiers with fallback to list title lookup via `GetByTitle`.
+- New helper method `_is_valid_guid` in `SharePointAPI`.
+- Centralized list resolution helper `_resolve_sp_list` for GUID, title, or `SharePointList` instances.
+- New method `get_list_metadata` to fetch only list metadata without items.
+- Type hint enhancements: added `Optional`, `Tuple` imports; updated method signatures (e.g., `get_item_versions` now uses `Optional[List[str]]`).
+- Updated `get_list` to return the resolved `SharePointList` object after appending items.
+- Refactored multiple methods (`get_item`, `create_item`, `update_item`, `attach_file`, `get_item_versions`, `get_case`) to use `_resolve_sp_list`, removing redundant GUID validation logic.
+
+### Changed
+
+- Cleaned up stray `else:` blocks and syntax errors.
+- Improved consistency of return objects across list-related methods.
+- Updated imports and docstrings accordingly.
+
+## 0.2.2 – 2025-11-28
+
+### Added
+
+- `SharePointList.fields` property to retrieve list field definitions
+
+## 0.2.1 – 2025‑11‑06
+
+### Added
+
+- Optional `select_fields` parameters to list retrieval methods for more efficient queries.
+- New public API methods:
+  - `SharePointAPI.get_group_users` – fetch users of a SharePoint group.
+- Improved error handling with explicit `TypeError` exceptions.
+- Detailed docstrings for core classes and methods (enhances IDE support).
+
+### Changed
+
+- HTTP header handling unified; corrected `X‑HTTP‑Method: PUT` for full updates.
+- Error handling improved: generic `sys.exit(1)` replaced with explicit `TypeError`/`ConnectionError` exceptions.
+
+### Fixed
+
+- Fixed incorrect PUT header that previously sent a MERGE header.
+- Minor docstring formatting issues.
+
+### Security
+
+- Enforced NTLM authentication across all request helpers.

{sharepoint_v1_api-0.2.2/sharepoint_v1_api.egg-info → sharepoint_v1_api-0.2.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: sharepoint_v1_api
-Version: 0.2.2
+Version: 0.2.3
 Author: Aske Bluhme Klok
 License: MIT
 Keywords: Sharepoint
@@ -156,6 +156,24 @@ for v in versions:
 ```
 
 
+## 0.2.3 – 2025-12-02
+
+### Added
+
+- GUID validation for list identifiers with fallback to list title lookup via `GetByTitle`.
+- New helper method `_is_valid_guid` in `SharePointAPI`.
+- Centralized list resolution helper `_resolve_sp_list` for GUID, title, or `SharePointList` instances.
+- New method `get_list_metadata` to fetch only list metadata without items.
+- Type hint enhancements: added `Optional`, `Tuple` imports; updated method signatures (e.g., `get_item_versions` now uses `Optional[List[str]]`).
+- Updated `get_list` to return the resolved `SharePointList` object after appending items.
+- Refactored multiple methods (`get_item`, `create_item`, `update_item`, `attach_file`, `get_item_versions`, `get_case`) to use `_resolve_sp_list`, removing redundant GUID validation logic.
+
+### Changed
+
+- Cleaned up stray `else:` blocks and syntax errors.
+- Improved consistency of return objects across list-related methods.
+- Updated imports and docstrings accordingly.
+
 ## 0.2.2 – 2025-11-28
 
 ### Added

{sharepoint_v1_api-0.2.2 → sharepoint_v1_api-0.2.3}/setup.py

@@ -1,6 +1,6 @@
 from setuptools import setup
 
-__version__ = "0.2.2"
+__version__ = "0.2.3"
 
 with open("README.md", "r") as readme_file, open("CHANGELOG.md", "r") as changelog_file:
     long_description = f"{readme_file.read()}\n\n{changelog_file.read()}"

{sharepoint_v1_api-0.2.2 → sharepoint_v1_api-0.2.3}/sharepoint_api/SharePointAPI.py

@@ -1,10 +1,10 @@
-import sys
 import os
-import getpass
 import json
+from datetime import timezone
 import requests
 from requests_ntlm import HttpNtlmAuth
-from typing import List
+from typing import List, Optional, Tuple
+import re
 
 from .SharePointUser import SharePointUser
 from .SharePointUserList import SharePointUserList
@@ -68,6 +68,43 @@ class SharePointAPI:
         self.password = password
         self.sharepoint_url = sharepoint_url
         self.proxies = proxies
+        self.timezone = timezone.utc
+
+    def _is_valid_guid(self, guid: str) -> bool:
+        """Validate that a string is a proper GUID."""
+        pattern = r'^[0-9a-fA-F]{8}(-[0-9a-fA-F]{4}){3}-[0-9a-fA-F]{12}$'
+        return bool(re.fullmatch(pattern, guid))
+
+    def _resolve_sp_list(self, sharepoint_site: str, sp_list, SPListType: SharePointList = SharePointList) -> Tuple[str, Optional[SharePointList]]:
+        """
+        Resolve ``sp_list`` (GUID, title or ``SharePointList`` instance) to a GUID
+        and, when possible, a ``SharePointList`` object.
+
+        Returns
+        -------
+        tuple
+            (guid: str, list_obj: SharePointList | None)
+        """
+        # Case 1: already a SharePointList instance
+        if isinstance(sp_list, SharePointList):
+            return sp_list.guid, sp_list
+
+        # Case 2: string – could be GUID or title
+        if isinstance(sp_list, str):
+            if self._is_valid_guid(sp_list):
+                guid = sp_list
+                # Fetch minimal list metadata to build a SharePointList object
+                r = self._api_get_call(
+                    f'{self.sharepoint_url}/cases/{sharepoint_site}/_api/Web/Lists(guid\'{guid}\')')
+                list_obj = SPListType(self, sharepoint_site, r.json()["d"])
+                return guid, list_obj
+            # Assume title – resolve via GetByTitle
+            list_obj = self.get_list_by_name(
+                sharepoint_site, sp_list, SPListType=SPListType)
+            return list_obj.guid, list_obj
+
+        raise TypeError(
+            'Invalid sp_list argument; expected SharePointList or str')
 
     def _handle_response(self, response: requests.Response, success_codes: List[int]) -> requests.Response:
         """
@@ -530,21 +567,9 @@ class SharePointAPI:
             returned for each list item via the ``$select`` OData query option.
         '''
 
-        # Uses either guid or SharePointList
-        if isinstance(sp_list, SharePointList):
-            guid = sp_list.guid
-            r = self._api_get_call(
-                f'{self.sharepoint_url}/cases/{sharepoint_site}/_api/Web/Lists(guid\'{guid}\')')
-            sp_list = SPListType(self, sharepoint_site, r.json()["d"])
-
-        elif isinstance(sp_list, str):
-            guid = sp_list
-            r = self._api_get_call(
-                f'{self.sharepoint_url}/cases/{sharepoint_site}/_api/Web/Lists(guid\'{guid}\')')
-            sp_list = SPListType(self, sharepoint_site, r.json()["d"])
-        else:
-            raise TypeError(
-                'Invalid sp_list argument; expected SharePointList or str')
+        # Resolve sp_list to GUID and (optionally) a SharePointList object
+        guid, sp_list_obj = self._resolve_sp_list(
+            sharepoint_site, sp_list, SPListType=SPListType)
 
         arguments = []
 
@@ -578,8 +603,8 @@ class SharePointAPI:
 
         items = [SPListType.SPItem(self, sharepoint_site, guid, item_settings)
                  for item_settings in r.json()["d"]["results"]]
-        sp_list.append_items(items)
-        return sp_list
+        sp_list_obj.append_items(items)
+        return sp_list_obj
 
     def get_list_by_name(self, sharepoint_site, sp_list_name: str, filters=None, top=1000, view_path=None, select_fields=None, SPListType: SharePointList = SharePointList) -> SharePointList:
         '''
@@ -668,6 +693,21 @@ class SharePointAPI:
 
     # SP Item
 
+    def get_list_metadata(self, sharepoint_site, sp_list, SPListType: SharePointList = SharePointList) -> SharePointList:
+        """
+        Retrieve only the metadata of a SharePoint list without fetching its items.
+        Useful when only list properties (e.g., title, guid) are needed.
+        """
+        guid, list_obj = self._resolve_sp_list(
+            sharepoint_site, sp_list, SPListType=SPListType)
+        # If the list object was already resolved (e.g., via title lookup), reuse it.
+        if list_obj is not None:
+            return list_obj
+        # Otherwise, fetch minimal metadata using the GUID.
+        r = self._api_get_call(
+            f'{self.sharepoint_url}/cases/{sharepoint_site}/_api/Web/Lists(guid\'{guid}\')')
+        return SPListType(self, sharepoint_site, r.json()["d"])
+
     def get_item(self, sharepoint_site, sp_list, item_id, select_fields=None) -> SharePointListItem:
         '''
             Returns a single list item from a given sharepoint_site.
@@ -675,14 +715,8 @@ class SharePointAPI:
             returned via the ``$select`` OData query option.
         '''
 
-        if isinstance(sp_list, SharePointList):
-            guid = sp_list.guid
-
-        elif isinstance(sp_list, str):
-            guid = sp_list
-        else:
-            raise TypeError(
-                'Invalid sp_list argument; expected SharePointList or str')
+        # Resolve sp_list to GUID (and list object if needed)
+        guid, _ = self._resolve_sp_list(sharepoint_site, sp_list)
 
         # Build the request URL, adding $select if needed.
         if select_fields is not None:
@@ -701,14 +735,8 @@ class SharePointAPI:
 
     def create_item(self, sharepoint_site, sp_list, data) -> SharePointListItem:
         # Uses either guid or SharePointList
-        if isinstance(sp_list, SharePointList):
-            guid = sp_list.guid
-        elif isinstance(sp_list, str):
-            guid = sp_list
-            r = self._api_get_call(
-                f'{self.sharepoint_url}/cases/{sharepoint_site}/_api/Web/Lists(guid\'{guid}\')')
-            sp_list = SharePointList(self,
-                                     sharepoint_site, r.json()["d"]["results"][0])
+        # Resolve sp_list to GUID (and list object if needed)
+        guid, _ = self._resolve_sp_list(sharepoint_site, sp_list)
 
         r = self._api_post_call(
             f'{self.sharepoint_url}/cases/{sharepoint_site}/_api/contextinfo', {})
@@ -731,13 +759,8 @@ class SharePointAPI:
             item_id: The id of the item
             data: Data to push to the item
         '''
-        if isinstance(sp_list, SharePointList):
-            guid = sp_list.guid
-        elif isinstance(sp_list, str):
-            guid = sp_list
-        else:
-            raise TypeError(
-                'Only "SharePointList" and "str" types are allowed')
+        # Resolve sp_list to GUID (and list object if needed)
+        guid, _ = self._resolve_sp_list(sharepoint_site, sp_list)
 
         r = self._api_post_call(
             f'{self.sharepoint_url}/cases/{sharepoint_site}/_api/contextinfo', {})
@@ -752,13 +775,8 @@ class SharePointAPI:
 
     def attach_file(self, sharepoint_site, sp_list, item, file_name, file_content) -> dict:
         # Uses either guid or SharePointList
-        if isinstance(sp_list, SharePointList):
-            guid = sp_list.guid
-        elif isinstance(sp_list, str):
-            guid = sp_list
-        else:
-            raise TypeError(
-                'Only "SharePointList" and "str" types are allowed')
+        # Resolve sp_list to GUID (and list object if needed)
+        guid, _ = self._resolve_sp_list(sharepoint_site, sp_list)
 
         r = self._api_post_call(
             f'{self.sharepoint_url}/cases/{sharepoint_site}/_api/contextinfo', {})
@@ -766,23 +784,17 @@ class SharePointAPI:
         )["d"]["GetContextWebInformation"]["FormDigestValue"]
 
         r = self._api_attachment_call(
-            f"{self.sharepoint_url}/cases/{sharepoint_site}/_api/Web/Lists(guid\'{guid}\')/items({item.Id})/AttachmentFiles/ add(FileName='{file_name}')", file_content, form_digest_value)
+            f"{self.sharepoint_url}/cases/{sharepoint_site}/_api/Web/Lists(guid\'{guid}\')/items({item.Id})/AttachmentFiles/add(FileName='{file_name}')", file_content, form_digest_value)
 
         return r.json()
 
-    def get_item_versions(self, sharepoint_site, sp_list, item_id, select_fields=[]) -> list:
+    def get_item_versions(self, sharepoint_site, sp_list, item_id, select_fields: Optional[List[str]] = None) -> list:
         '''
             Returns a list of users from a given sharepoint_site
         '''
 
-        if isinstance(sp_list, SharePointList):
-            guid = sp_list.guid
-
-        elif isinstance(sp_list, str):
-            guid = sp_list
-        else:
-            raise TypeError(
-                'Invalid sp_list argument; expected SharePointList or str')
+        # Resolve sp_list to GUID (and list object if needed)
+        guid, _ = self._resolve_sp_list(sharepoint_site, sp_list)
 
         if select_fields:
             r = self._api_get_call(
@@ -836,14 +848,8 @@ class SharePointAPI:
             Returns a list of users from a given sharepoint_site
         '''
 
-        if isinstance(sp_list, SharePointList):
-            guid = sp_list.guid
-
-        elif isinstance(sp_list, str):
-            guid = sp_list
-        else:
-            raise TypeError(
-                'Invalid sp_list argument; expected SharePointList or str')
+        # Resolve sp_list to GUID (and list object if needed)
+        guid, _ = self._resolve_sp_list(sharepoint_site, sp_list)
 
         r = self._api_get_call(
             f'{self.sharepoint_url}/cases/{sharepoint_site}/_api/Web/Lists(guid\'{guid}\')/items({item_id})')

{sharepoint_v1_api-0.2.2 → sharepoint_v1_api-0.2.3}/sharepoint_api/SharePointListItem.py

@@ -1,6 +1,7 @@
 from datetime import datetime
 # from .SharePointAPI import SharePointAPI as SP
 
+
 class SharePointListItem:
     """
     Represents a generic item in a SharePoint list.
@@ -34,12 +35,12 @@ class SharePointListItem:
     @property
     def versions(self) -> list:
         if not self._versions:
-            self._versions = self.sp.get_item_versions(self.sharepoint_site, self.list_guid, self.Id) 
+            self._versions = self.sp.get_item_versions(
+                self.sharepoint_site, self.list_guid, self.Id)
             if self._list is not None:
                 self._list.CHANGE_DETECTED = True
-        return self._versions    
-    
-    
+        return self._versions
+
     @property
     def Id(self) -> str:
         """Unique identifier of the list item."""
@@ -62,7 +63,7 @@ class SharePointListItem:
         elif self.settings['Created'] is None:
             return None
         else:
-            return datetime.strptime(self.settings['Created'], '%Y-%m-%dT%H:%M:%SZ')
+            return datetime.strptime(self.settings['Created'], '%Y-%m-%dT%H:%M:%SZ').replace(tzinfo=self.sp.timezone)
 
     @property
     def Modified(self) -> datetime:
@@ -76,39 +77,41 @@ class SharePointListItem:
         elif self.settings['Modified'] is None:
             return None
         else:
-            return datetime.strptime(self.settings['Modified'], '%Y-%m-%dT%H:%M:%SZ')
+            return datetime.strptime(self.settings['Modified'], '%Y-%m-%dT%H:%M:%SZ').replace(tzinfo=self.sp.timezone)
 
     def attach_item(self, file_name, file_path):
         """
         Attach a file to this list item.
-    
+
         Parameters
         ----------
         file_name : str
             The name of the file as it should appear in SharePoint.
         file_path : str
             Local path to the file to be uploaded.
-    
+
         The method reads the file content and uses :meth:`SharePointAPI.attach_file`
         to upload it to the corresponding SharePoint list item.
         """
         with open(file_path, 'r') as f:
             file_content = f.read()
 
-    
-        self.sp.attach_file(self.sharepoint_site, self.list, self, file_name, file_content)
+        self.sp.attach_file(self.sharepoint_site, self.list,
+                            self, file_name, file_content)
 
     def versions_select_fields(self, select_fields=[]) -> list:
         if not self._versions:
-            self._versions = self.sp.get_item_versions(self.sharepoint_site, self.list_guid, self.Id, select_fields) 
+            self._versions = self.sp.get_item_versions(
+                self.sharepoint_site, self.list_guid, self.Id, select_fields)
         return self._versions
 
     def update_fields(self, data):
         self.sp.update_item(self.sharepoint_site,
                             self.list_guid, self.Id, data)
 
+
 class SharepointSiteCase(SharePointListItem):
-    
+
     @property
     def AssignmentType(self) -> str:
         return self.settings['AssignmentType']
@@ -121,7 +124,7 @@ class SharepointSiteCase(SharePointListItem):
         elif self.settings['CaseClosed'] is None:
             return None
         else:
-            return datetime.strptime(self.settings['CaseClosed'], '%Y-%m-%dT%H:%M:%SZ')
+            return datetime.strptime(self.settings['CaseClosed'], '%Y-%m-%dT%H:%M:%SZ').replace(tzinfo=self.sp.timezone)
 
     @property
     def Due(self) -> datetime:
@@ -131,7 +134,7 @@ class SharepointSiteCase(SharePointListItem):
         elif self.settings['DueDate'] is None:
             return None
         else:
-            return datetime.strptime(self.settings['DueDate'], '%Y-%m-%dT%H:%M:%SZ')
+            return datetime.strptime(self.settings['DueDate'], '%Y-%m-%dT%H:%M:%SZ').replace(tzinfo=self.sp.timezone)
 
     @property
     def Priority(self) -> str:
@@ -156,7 +159,7 @@ class SharepointSiteCase(SharePointListItem):
                 solved_in_time = True
         else:
             solved_in_time = True
-        
+
         return solved_in_time
 
     @property
@@ -167,7 +170,7 @@ class SharepointSiteCase(SharePointListItem):
         elif self.settings['WorkBegun'] is None:
             return None
         else:
-            return datetime.strptime(self.settings['WorkBegun'], '%Y-%m-%dT%H:%M:%SZ')
+            return datetime.strptime(self.settings['WorkBegun'], '%Y-%m-%dT%H:%M:%SZ').replace(tzinfo=self.sp.timezone)
 
     @property
     def DeadlineWorkTimestamp(self) -> datetime:
@@ -177,7 +180,7 @@ class SharepointSiteCase(SharePointListItem):
         elif self.settings['DeadlineWork'] is None:
             return None
         else:
-            return datetime.strptime(self.settings['DeadlineWork'], '%Y-%m-%dT%H:%M:%SZ')
+            return datetime.strptime(self.settings['DeadlineWork'], '%Y-%m-%dT%H:%M:%SZ').replace(tzinfo=self.sp.timezone)
 
     @property
     def ReactedInTime(self) -> bool:
@@ -191,6 +194,3 @@ class SharepointSiteCase(SharePointListItem):
         else:
             reacted_in_time = True
         return reacted_in_time
-
-    
-        

{sharepoint_v1_api-0.2.2 → sharepoint_v1_api-0.2.3}/sharepoint_api/SharePointTimeRegistration.py

@@ -3,6 +3,7 @@ from datetime import datetime
 from sharepoint_api.SharePointListItem import SharePointListItem
 # from .SharePointAPI import SharePointAPI as SP
 
+
 class TimeRegistration(SharePointListItem):
     """
     Represents a time‑registration entry associated with a SharePoint list item.
@@ -22,8 +23,8 @@ class TimeRegistration(SharePointListItem):
         elif self.settings['DoneDate'] is None:
             return None
         else:
-            return datetime.strptime(self.settings['DoneDate'], '%Y-%m-%dT%H:%M:%SZ')
-    
+            return datetime.strptime(self.settings['DoneDate'], '%Y-%m-%dT%H:%M:%SZ').replace(tzinfo=self.sp.timezone)
+
     @property
     def Hours(self) -> str:
         return self.settings['Hours']
@@ -38,7 +39,7 @@ class TimeRegistration(SharePointListItem):
             user_list = self.sp.get_users(self.sharepoint_site)
             self._DoneBy = user_list.get_user_by_id(self.DoneById)
         return self._DoneBy
-    
+
     @property
     def DoneUsername(self) -> str:
         return self.DoneBy.UserName
@@ -46,8 +47,7 @@ class TimeRegistration(SharePointListItem):
     @property
     def CaseId(self) -> str:
         return self.settings['CaseId']
-    
+
     @property
     def WorkPackageId(self) -> str:
         return self.settings['WorkPackageId']
-    

{sharepoint_v1_api-0.2.2 → sharepoint_v1_api-0.2.3/sharepoint_v1_api.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: sharepoint_v1_api
-Version: 0.2.2
+Version: 0.2.3
 Author: Aske Bluhme Klok
 License: MIT
 Keywords: Sharepoint
@@ -156,6 +156,24 @@ for v in versions:
 ```
 
 
+## 0.2.3 – 2025-12-02
+
+### Added
+
+- GUID validation for list identifiers with fallback to list title lookup via `GetByTitle`.
+- New helper method `_is_valid_guid` in `SharePointAPI`.
+- Centralized list resolution helper `_resolve_sp_list` for GUID, title, or `SharePointList` instances.
+- New method `get_list_metadata` to fetch only list metadata without items.
+- Type hint enhancements: added `Optional`, `Tuple` imports; updated method signatures (e.g., `get_item_versions` now uses `Optional[List[str]]`).
+- Updated `get_list` to return the resolved `SharePointList` object after appending items.
+- Refactored multiple methods (`get_item`, `create_item`, `update_item`, `attach_file`, `get_item_versions`, `get_case`) to use `_resolve_sp_list`, removing redundant GUID validation logic.
+
+### Changed
+
+- Cleaned up stray `else:` blocks and syntax errors.
+- Improved consistency of return objects across list-related methods.
+- Updated imports and docstrings accordingly.
+
 ## 0.2.2 – 2025-11-28
 
 ### Added

sharepoint_v1_api-0.2.2/CHANGELOG.md

@@ -1,29 +0,0 @@
-## 0.2.2 – 2025-11-28
-
-### Added
-
-- `SharePointList.fields` property to retrieve list field definitions
-
-## 0.2.1 – 2025‑11‑06
-
-### Added
-
-- Optional `select_fields` parameters to list retrieval methods for more efficient queries.
-- New public API methods:
-  - `SharePointAPI.get_group_users` – fetch users of a SharePoint group.
-- Improved error handling with explicit `TypeError` exceptions.
-- Detailed docstrings for core classes and methods (enhances IDE support).
-
-### Changed
-
-- HTTP header handling unified; corrected `X‑HTTP‑Method: PUT` for full updates.
-- Error handling improved: generic `sys.exit(1)` replaced with explicit `TypeError`/`ConnectionError` exceptions.
-
-### Fixed
-
-- Fixed incorrect PUT header that previously sent a MERGE header.
-- Minor docstring formatting issues.
-
-### Security
-
-- Enforced NTLM authentication across all request helpers.