From 5fece9cafcc7459d798fb78a62dab1623bf50d3d Mon Sep 17 00:00:00 2001
From: Karel van Klink <karel.vanklink@geant.org>
Date: Thu, 2 May 2024 16:17:16 +0200
Subject: [PATCH] rename SPClient to SharePointClient
---
gso/services/sharepoint.py | 8 ++++----
gso/workflows/router/create_router.py | 4 ++--
2 files changed, 6 insertions(+), 6 deletions(-)
diff --git a/gso/services/sharepoint.py b/gso/services/sharepoint.py
index 0af9e20f..d0efff0b 100644
--- a/gso/services/sharepoint.py
+++ b/gso/services/sharepoint.py
@@ -13,7 +13,7 @@ from msgraph.generated.sites.item.lists.item.items.items_request_builder import
from gso.settings import load_oss_params
-class SPClient:
+class SharePointClient:
"""A client for interaction with SharePoint lists."""
def __init__(self) -> None:
@@ -32,7 +32,7 @@ class SPClient:
def get_site(self) -> Site | None:
"""Get the SharePoint site that this orchestrator connects to."""
- async def _get_site():
+ async def _get_site() -> Site | None:
return await self.client.sites.by_site_id(self.site_id).get()
return asyncio.run(_get_site())
@@ -43,7 +43,7 @@ class SPClient:
:param str list_name: The name of the list.
"""
- async def _get_list_items():
+ async def _get_list_items() -> ListItemCollectionResponse | None:
query_params = ItemsRequestBuilder.ItemsRequestBuilderGetQueryParameters(expand=["fields"])
request_configuration = ItemsRequestBuilder.ItemsRequestBuilderGetRequestConfiguration(
query_parameters=query_params
@@ -65,7 +65,7 @@ class SPClient:
:return str: The URL of the list in which a new item has been created.
"""
- async def _new_list_item():
+ async def _new_list_item() -> str:
request_body = ListItem(fields=FieldValueSet(additional_data=fields))
new_item = (
await self.client.sites.by_site_id(self.site_id)
diff --git a/gso/workflows/router/create_router.py b/gso/workflows/router/create_router.py
index 7e7f55bd..3173145c 100644
--- a/gso/workflows/router/create_router.py
+++ b/gso/workflows/router/create_router.py
@@ -20,7 +20,7 @@ from gso.services import infoblox, subscriptions
from gso.services.lso_client import lso_interaction
from gso.services.netbox_client import NetboxClient
from gso.services.partners import get_partner_by_name
-from gso.services.sharepoint import SPClient
+from gso.services.sharepoint import SharePointClient
from gso.utils.helpers import generate_fqdn, iso_from_ipv4
from gso.utils.shared_enums import PortNumber, Vendor
from gso.utils.workflow_steps import deploy_base_config_dry, deploy_base_config_real, run_checks_after_base_config
@@ -221,7 +221,7 @@ def prompt_insert_in_radius(subscription: RouterInactive) -> FormGenerator:
@step("Create a new SharePoint checklist")
def create_new_sharepoint_checklist(subscription: RouterProvisioning) -> State:
"""Create a new checklist in SharePoint for approving this router."""
- new_list_item_url = SPClient().add_list_item("p_router", {"Title": subscription.router.router_fqdn})
+ new_list_item_url = SharePointClient().add_list_item("p_router", {"Title": subscription.router.router_fqdn})
return {"checklist_url": new_list_item_url}
--
GitLab