Перейти к содержимому

Ссылка для hub_sdk/base/crud_client.py

Примечание

Этот файл доступен по адресу https://github.com/ultralytics/hub-sdk/blob/main/hub_sdk/base/crud_client .py. Если ты обнаружишь проблему, пожалуйста, помоги исправить ее, создав Pull Request 🛠️. Спасибо 🙏!



hub_sdk.base.crud_client.CRUDClient

Базы: APIClient

Представляет собой CRUD-клиент (Create, Read, Update, Delete) для взаимодействия с определенным ресурсом.

Атрибуты:

Имя Тип Описание
name str

Имя, связанное с CRUD-операциями (например, "Пользователь").

logger Logger

Экземпляр логгера для ведения журнала.

Исходный код в hub_sdk/base/crud_client.py
class CRUDClient(APIClient):
    """
    Represents a CRUD (Create, Read, Update, Delete) client for interacting with a specific resource.

    Attributes:
        name (str): The name associated with the CRUD operations (e.g., "User").
        logger (logging.Logger): An instance of the logger for logging purposes.
    """

    def __init__(self, base_endpoint, name, headers):
        """
        Initialize a CRUDClient instance.

        Args:
            base_endpoint (str): The base endpoint URL for the API.
            name (str): The name associated with the CRUD operations (e.g., "User").
            headers (dict): Headers to be included in API requests.
        """
        super().__init__(f"{HUB_FUNCTIONS_ROOT}/v1/{base_endpoint}", headers)
        self.name = name
        self.logger = logger

    def create(self, data: dict) -> Optional[Response]:
        """
        Create a new entity using the API.

        Args:
            data (dict): The data to be sent as part of the creation request.

        Returns:
            (Optional[Response]): Response object from the create request, or None if upload fails.
        """
        try:
            return self.post("", json=data)
        except Exception as e:
            self.logger.error(f"Failed to create {self.name}: {e}")

    def read(self, id: str) -> Optional[Response]:
        """
        Retrieve details of a specific entity.

        Args:
            id (str): The unique identifier of the entity to retrieve.

        Returns:
            (Optional[Response]): Response object from the read request, or None if read fails.
        """
        try:
            return self.get(f"/{id}")
        except Exception as e:
            self.logger.error(f"Failed to read {self.name} with ID: {id}, {e}")

    def update(self, id: str, data: dict) -> Optional[Response]:
        """
        Update an existing entity using the API.

        Args:
            id (str): The unique identifier of the entity to update.
            data (dict): The updated data to be sent in the update request.

        Returns:
            (Optional[Response]): Response object from the update request, or None if update fails.
        """
        try:
            return self.patch(f"/{id}", json=data)
        except Exception as e:
            self.logger.error(f"Failed to update {self.name} with ID: {id}, {e}")

    def delete(self, id: str, hard: bool = False) -> Optional[Response]:
        """
        Delete an entity using the API.

        Args:
            id (str): The unique identifier of the entity to delete.
            hard (bool, optional): If True, perform a hard delete. If False, perform a soft delete.

        Returns:
            (Optional[Response]): Response object from the delete request, or None if delete fails.
        """
        try:
            return super().delete(f"/{id}", {"hard": hard})
        except Exception as e:
            self.logger.error(f"Failed to delete {self.name} with ID: {id}, {e}")

    def list(self, page: int = 0, limit: int = 10) -> Optional[Response]:
        """
        List entities using the API.

        Args:
            page (int, optional): The page number to retrieve.
            limit (int, optional): The maximum number of entities per page.

        Returns:
            (Optional[Response]): Response object from the list request, or None if it fails.
        """
        try:
            params = {"page": page, "limit": limit}
            return self.get("", params=params)
        except Exception as e:
            self.logger.error(f"Failed to list {self.name}: {e}")

__init__(base_endpoint, name, headers)

Инициализируй экземпляр CRUDClient.

Параметры:

Имя Тип Описание По умолчанию
base_endpoint str

Базовый URL конечной точки для API.

требуется
name str

Имя, связанное с CRUD-операциями (например, "Пользователь").

требуется
headers dict

Заголовки, которые нужно включать в запросы к API.

требуется
Исходный код в hub_sdk/base/crud_client.py
def __init__(self, base_endpoint, name, headers):
    """
    Initialize a CRUDClient instance.

    Args:
        base_endpoint (str): The base endpoint URL for the API.
        name (str): The name associated with the CRUD operations (e.g., "User").
        headers (dict): Headers to be included in API requests.
    """
    super().__init__(f"{HUB_FUNCTIONS_ROOT}/v1/{base_endpoint}", headers)
    self.name = name
    self.logger = logger

create(data)

Создай новую сущность с помощью API.

Параметры:

Имя Тип Описание По умолчанию
data dict

Данные, которые будут отправлены в рамках запроса на создание.

требуется

Возвращается:

Тип Описание
Optional[Response]

Объект ответа на запрос создания или None, если загрузка не удалась.

Исходный код в hub_sdk/base/crud_client.py
def create(self, data: dict) -> Optional[Response]:
    """
    Create a new entity using the API.

    Args:
        data (dict): The data to be sent as part of the creation request.

    Returns:
        (Optional[Response]): Response object from the create request, or None if upload fails.
    """
    try:
        return self.post("", json=data)
    except Exception as e:
        self.logger.error(f"Failed to create {self.name}: {e}")

delete(id, hard=False)

Удали сущность с помощью API.

Параметры:

Имя Тип Описание По умолчанию
id str

Уникальный идентификатор сущности, которую нужно удалить.

требуется
hard bool

Если True, выполни жесткое удаление. Если False, то выполни мягкое удаление.

False

Возвращается:

Тип Описание
Optional[Response]

Объект ответа на запрос удаления или None, если удаление не удалось.

Исходный код в hub_sdk/base/crud_client.py
def delete(self, id: str, hard: bool = False) -> Optional[Response]:
    """
    Delete an entity using the API.

    Args:
        id (str): The unique identifier of the entity to delete.
        hard (bool, optional): If True, perform a hard delete. If False, perform a soft delete.

    Returns:
        (Optional[Response]): Response object from the delete request, or None if delete fails.
    """
    try:
        return super().delete(f"/{id}", {"hard": hard})
    except Exception as e:
        self.logger.error(f"Failed to delete {self.name} with ID: {id}, {e}")

list(page=0, limit=10)

Перечисли сущности, использующие API.

Параметры:

Имя Тип Описание По умолчанию
page int

Номер страницы, которую нужно извлечь.

0
limit int

Максимальное количество сущностей на странице.

10

Возвращается:

Тип Описание
Optional[Response]

Объект ответа на запрос списка, или None, если он не сработал.

Исходный код в hub_sdk/base/crud_client.py
def list(self, page: int = 0, limit: int = 10) -> Optional[Response]:
    """
    List entities using the API.

    Args:
        page (int, optional): The page number to retrieve.
        limit (int, optional): The maximum number of entities per page.

    Returns:
        (Optional[Response]): Response object from the list request, or None if it fails.
    """
    try:
        params = {"page": page, "limit": limit}
        return self.get("", params=params)
    except Exception as e:
        self.logger.error(f"Failed to list {self.name}: {e}")

read(id)

Получи подробную информацию о конкретной сущности.

Параметры:

Имя Тип Описание По умолчанию
id str

Уникальный идентификатор сущности, которую нужно извлечь.

требуется

Возвращается:

Тип Описание
Optional[Response]

Объект ответа на запрос чтения, или None, если чтение не удалось.

Исходный код в hub_sdk/base/crud_client.py
def read(self, id: str) -> Optional[Response]:
    """
    Retrieve details of a specific entity.

    Args:
        id (str): The unique identifier of the entity to retrieve.

    Returns:
        (Optional[Response]): Response object from the read request, or None if read fails.
    """
    try:
        return self.get(f"/{id}")
    except Exception as e:
        self.logger.error(f"Failed to read {self.name} with ID: {id}, {e}")

update(id, data)

Обнови существующую сущность, используя API.

Параметры:

Имя Тип Описание По умолчанию
id str

Уникальный идентификатор сущности, которую нужно обновить.

требуется
data dict

Обновленные данные, которые будут отправлены в запросе на обновление.

требуется

Возвращается:

Тип Описание
Optional[Response]

Объект ответа на запрос обновления или None, если обновление не удалось.

Исходный код в hub_sdk/base/crud_client.py
def update(self, id: str, data: dict) -> Optional[Response]:
    """
    Update an existing entity using the API.

    Args:
        id (str): The unique identifier of the entity to update.
        data (dict): The updated data to be sent in the update request.

    Returns:
        (Optional[Response]): Response object from the update request, or None if update fails.
    """
    try:
        return self.patch(f"/{id}", json=data)
    except Exception as e:
        self.logger.error(f"Failed to update {self.name} with ID: {id}, {e}")