Fixed auto_properties.

This commit is contained in:
2025-11-07 21:21:49 +01:00
parent e4497791f3
commit 54361e6c18
4 changed files with 60 additions and 43 deletions

View File

@@ -3,6 +3,7 @@ import requests
import urllib.parse
from uuid import UUID
import logging
from sk.logger import log_entity_creation
DEVOPS_SCOPE = "https://app.vssps.visualstudio.com/.default"
DEVOPS_API_VERSION = "7.1"
@@ -27,6 +28,7 @@ def auto_properties(mapping: dict[str,str]):
pass
# Fetch repository details from the API if it is set to None or not existing
log.debug(f"Auto-fetching property '{name}' for {self.__class__.__name__}", extra={"property_name": name})
self.get_auto_properties()
return getattr(self, private_var)
@@ -34,15 +36,16 @@ def auto_properties(mapping: dict[str,str]):
def from_args(self, **kwargs):
for name in kwargs:
if name in self.__class__.__auto_properties__:
if name in self.__class__.__auto_properties__.values():
setattr(self, f"_{name}", kwargs.get(name, None))
def from_json(self, json_data: dict):
for name in self.__class__.__auto_properties__:
setattr(self, f"_{name}", json_data.get(self.__class__.__auto_properties__[name], None))
for json_name in self.__class__.__auto_properties_reversed__:
setattr(self, f"_{self.__class__.__auto_properties_reversed__[json_name]}", json_data.get(json_name, None))
def decorator(cls):
cls.__auto_properties__ = mapping # Make a copy of the mapping
cls.__auto_properties_reversed__ = {v: k for k, v in mapping.items()} # Store reversed mapping for JSON parsing
# Create properties dynamically
for name in mapping:
@@ -75,7 +78,7 @@ class Organization():
self._org_url = org_url.rstrip("/") + "/" # Ensure trailing slash
self._token = token
self._api_version = api_version
log.debug(f"Created new Organization object", extra={"entity_class": "Organization"})
log_entity_creation(log, Organization, self._org_url)
def get_path(self, path: str, params: dict = {}) -> dict:
return get_url(
@@ -120,7 +123,7 @@ class Project():
except ValueError:
raise ValueError(f"Invalid project ID: {self._id}")
log.debug(f"Created new Project object", extra={"entity_class": "Project"})
log_entity_creation(log, Project, self.id)
def get_auto_properties(self):
r = get_url(
@@ -179,7 +182,7 @@ class Repository():
# set other properties if provided
self.from_args(**kwargs)
log.debug(f"Created new {self.__class__.__name__} object", extra={"entity_class": self.__class__.__name__})
log_entity_creation(log, Repository, self.id)
def get_auto_properties(self):
id = self._id if hasattr(self, "_id") else self._name
@@ -202,16 +205,21 @@ class Repository():
@property
def items(self):
log.debug(f"Fetching items for repository '{self.name}'", extra={"repository_name": self.name})
if not hasattr(self, "_items"):
self._items = self._entities(
entity_class=Item,
key_name="path",
list_url=f"{self._project.id}/_apis/git/repositories/{self._id}/items",
objects = self._project.organization.get_path(
path=f"{self._project.id}/_apis/git/repositories/{self.id}/items",
params={
"scopePath": "/",
"recursionLevel": "oneLevel"
}
)
).get("value", [])
self._items = []
for obj in objects:
i = Item(repository=self, path=obj.get("path"))
i.from_json(obj)
self._items.append(i)
return self._items
def __getitem__(self, key: str) -> Item:
@@ -221,6 +229,7 @@ class Repository():
raise KeyError(f"Item with path '{key}' not found.")
@auto_properties({
"path": "path",
"object_id": "objectId",
"git_object_type": "gitObjectType",
"commit_id": "commitId",
@@ -228,43 +237,41 @@ class Repository():
"url": "url"
})
class Item():
def __init__(self, repository: Repository, path: str, **kwargs):
def __init__(self, repository: Repository, **kwargs):
self._repository = repository
self._path = path
self.set_auto_properties(**kwargs) # set properties defined in decorator
log.debug(f"Created new {self.__class__.__name__} object", extra={"entity_class": self.__class__.__name__})
self.from_args(**kwargs)
log_entity_creation(log, Item, self.path)
def _get(self):
pass
# self._get_entity(
# key_name="path",
# get_url=f"{self._repository._project.id}/_apis/git/repositories/{self._repository.id}/items",
# params={
# "path": self._path,
# "$format": "json",
# "recursionLevel": "none"
# }
# )
def get_auto_properties(self):
r = self._repository._project.organization.get_path(
path=f"{self._repository._project.id}/_apis/git/repositories/{self._repository.id}/items",
params={
"path": self.path,
"$format": "json",
"recursionLevel": "none"
}
)
self.from_json(r)
@property
def path(self):
return self._path
@property
def children(self):
"""List items under this item if it is a folder."""
if self.git_object_type == "tree":
return self._entities(
entity_class=Item,
key_name="path",
list_url=f"{self._repository._project.id}/_apis/git/repositories/{self._repository.id}/items",
params={
"scopePath": self._path,
"recursionLevel": "oneLevel"
}
)
else:
raise ValueError("Items can only be listed for folder items.")
# @property
# def children(self):
# """List items under this item if it is a folder."""
# if self.git_object_type == "tree":
# return self._entities(
# entity_class=Item,
# key_name="path",
# list_url=f"{self._repository._project.id}/_apis/git/repositories/{self._repository.id}/items",
# params={
# "scopePath": self._path,
# "recursionLevel": "oneLevel"
# }
# )
# else:
# raise ValueError("Items can only be listed for folder items.")
def __str__(self):
return f"Item(path=\"{self._path}\")"
return f"Item(path=\"{self._path}\" type={self.git_object_type} commit_id={self.commit_id})"

View File

@@ -35,3 +35,10 @@ def setup(name: str, handlers: int) -> logging.Logger:
logger.addHandler(custom_handler)
return logger
def log_entity_creation(logger: logging.Logger, entity_class: type, entity_key: str):
logger.debug(f'Created new "{entity_class.__name__}" object with key: "{entity_key}"',
extra={
"entity_class": entity_class.__name__,
"entity_key": entity_key
})