Reegineered entity reading logic.

This commit is contained in:
2025-11-02 23:34:13 +01:00
parent b7bb29224f
commit 17bd314a20
2 changed files with 45 additions and 40 deletions

View File

@@ -20,7 +20,7 @@ def auto_properties(mapping: dict[str,str] | None = None):
pass
# Fetch repository details from the API if it is set to None or not existing
self._get(getattr(self, "_id"))
self._get_attributes()
return getattr(self, private_var)
return property(fget=getter)
@@ -76,6 +76,23 @@ class DevOps():
r.raise_for_status() # Ensure we raise an error for bad responses
return r
def _get_entity_attributes(self, key_name: str, get_url: str, params: dict = {}) -> object:
"""
Each entity class can use this method to populate its attributes, by defining
its own _get_attributes method that calls this one with the key name,
and the URL.
"""
r = self._get_url_path(get_url, params=params) # Fetch the object data from the URL
setattr(self, f"_{key_name}", r.json().get(key_name, None)) # Set the key attribute
self.from_json(r.json()) # Populate other attributes from JSON
def _entity(self, entity_class: type, key_name: str, entity_data: dict) -> object:
"""A generic method to create an entity from JSON data."""
args = { key_name: entity_data.get(key_name) }
e = entity_class(self, **args)
e.from_json(entity_data)
return e
def _entities(self, entity_class: type, key_name: str, list_url: str, params: dict = {}) -> list[object]:
"""A generic method to retrieve a list of entities."""
r = self._get_url_path(list_url, params=params)
@@ -83,10 +100,7 @@ class DevOps():
entities_list = []
for entity in entities_data:
args = { key_name: entity.get(key_name) }
e = entity_class(self, **args)
e.from_json(entity)
entities_list.append(e)
entities_list.append(self._entity(entity_class, key_name, entity))
return entities_list
@@ -107,9 +121,11 @@ class Organization(DevOps):
"description": "description"
})
class Project(DevOps):
def _get(self, id: str):
r = self._get_url_path(f"_apis/projects/{id}")
self.from_json(r.json())
def _get_attributes(self):
self._get_entity_attributes(
key_name="id",
get_url=f"_apis/projects/{self._id}"
)
def __init__(self, org: Organization, id: str, **kwargs):
super().__init__(org._org_url, org._token, org._api_version)
@@ -124,9 +140,6 @@ class Project(DevOps):
def __str__(self):
return f"Project(name={self._name}, id={self._id})"
def get_path(self, path: str, params: dict = {}):
return self._get_url_path(f"{self._id}/{path.lstrip('/')}", params=params)
@property
def id(self):
return self._id
@@ -149,25 +162,22 @@ class Project(DevOps):
"web_url": "webUrl"
})
class Repository(DevOps):
def _get(self, repo_name: str):
r = self._project.get_path(f"_apis/git/repositories/{urllib.parse.quote(repo_name)}")
self._id = r.json().get("id", None)
self.from_json(r.json())
def _get_attributes(self):
self._get_entity_attributes(
key_name="id",
get_url=f"{self._project.id}/_apis/git/repositories/{self._id}"
)
def __init__(self, project: Project, id_or_name: str, **kwargs):
def __init__(self, project: Project, id: str, **kwargs):
super().__init__(project._org_url, project._token, project._api_version)
self._project = project
self._id = id
try:
self._id = str(UUID(id_or_name))
UUID(id) # Check if it's a valid UUID
except ValueError:
# Id not available, use API to get the repository object
r = self._get_url_path(f"{self._project.id}/_apis/git/repositories/{urllib.parse.quote(id_or_name)}")
self._id = r.json().get("id", None)
self.from_json(r.json())
# Successfully retrieved the repository by name,
# throw an error if automatic properties were set and
# id_or_name was not set to repository id
# Called with a repository name, fetch by name
self._get_attributes()
if kwargs:
raise ValueError("Automatic properties cannot be set when retrieving by name.")
return
@@ -175,16 +185,13 @@ class Repository(DevOps):
# set other properties if provided
self.set_auto_properties(**kwargs)
@property
def id(self):
return self._id
def __str__(self):
return f"Repository(name={self.name}, id={self._id})"
def get_path(self, path: str, params: dict = {}):
return self._project.get_path(f"_apis/git/repositories/{self._id}/{path.lstrip('/')}", params=params)
def _get_items(self, scope_path: str = "/", recursion_level: str = "oneLevel"):
r = self.get_path(f"items", params={"scopePath": scope_path, "recursionLevel": recursion_level})
return r.json()
@property
def items(self):
# GET https://dev.azure.com/{organization}/{project}/_apis/git/repositories/{repositoryId}/items?api-version=7.1
@@ -206,12 +213,6 @@ class Repository(DevOps):
"url": "url"
})
class Item(DevOps):
def _get(self, path):
r = self._repository.get_path(f"items/{urllib.parse.quote(path)}")
for name in self.__auto_properties__:
setattr(self, f"_{name}", r.json().get(name, None))
def __init__(self, repository: Repository, path: str, **kwargs):
super().__init__(repository._org_url, repository._token, repository._api_version)
self._repository = repository