Saltar al contenido

Referencia para hub_sdk/base/crud_client.py

Nota

Este archivo est谩 disponible en https://github.com/ultralytics/hub-sdk/blob/main/hub_sdk/base/crud_client .py. Si detectas alg煤n problema, por favor, ayuda a solucionarlo contribuyendo con una Pull Request 馃洜锔. 隆Gracias 馃檹!



hub_sdk.base.crud_client.CRUDClient

Bases: APIClient

Representa un cliente CRUD (Crear, Leer, Actualizar, Eliminar) para interactuar con un recurso espec铆fico.

Atributos:

Nombre Tipo Descripci贸n
name str

El nombre asociado a las operaciones CRUD (por ejemplo, "Usuario").

logger Logger

Una instancia del registrador para fines de registro.

C贸digo fuente en 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)

Inicializa una instancia de CRUDClient.

Par谩metros:

Nombre Tipo Descripci贸n Por defecto
base_endpoint str

La URL del punto final base de la API.

necesario
name str

El nombre asociado a las operaciones CRUD (por ejemplo, "Usuario").

necesario
headers dict

Cabeceras que deben incluirse en las peticiones a la API.

necesario
C贸digo fuente en 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)

Crea una nueva entidad utilizando la API.

Par谩metros:

Nombre Tipo Descripci贸n Por defecto
data dict

Los datos que se enviar谩n como parte de la solicitud de creaci贸n.

necesario

Devuelve:

Tipo Descripci贸n
Optional[Response]

Objeto de respuesta de la solicitud de creaci贸n, o Ninguno si la carga falla.

C贸digo fuente en 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)

Elimina una entidad utilizando la API.

Par谩metros:

Nombre Tipo Descripci贸n Por defecto
id str

El identificador 煤nico de la entidad a eliminar.

necesario
hard bool

Si es Verdadero, realiza un borrado fuerte. Si es Falso, realiza un borrado suave.

False

Devuelve:

Tipo Descripci贸n
Optional[Response]

Objeto de respuesta de la petici贸n de borrado, o Ninguno si el borrado falla.

C贸digo fuente en 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)

Enumera las entidades que utilizan la API.

Par谩metros:

Nombre Tipo Descripci贸n Por defecto
page int

El n煤mero de p谩gina a recuperar.

0
limit int

El n煤mero m谩ximo de entidades por p谩gina.

10

Devuelve:

Tipo Descripci贸n
Optional[Response]

Objeto de respuesta de la solicitud de lista, o Ninguno si falla.

C贸digo fuente en 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)

Recupera los datos de una entidad concreta.

Par谩metros:

Nombre Tipo Descripci贸n Por defecto
id str

El identificador 煤nico de la entidad a recuperar.

necesario

Devuelve:

Tipo Descripci贸n
Optional[Response]

Objeto respuesta de la petici贸n de lectura, o Ninguno si la lectura falla.

C贸digo fuente en 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)

Actualiza una entidad existente utilizando la API.

Par谩metros:

Nombre Tipo Descripci贸n Por defecto
id str

El identificador 煤nico de la entidad a actualizar.

necesario
data dict

Los datos actualizados que se enviar谩n en la solicitud de actualizaci贸n.

necesario

Devuelve:

Tipo Descripci贸n
Optional[Response]

Objeto de respuesta de la solicitud de actualizaci贸n, o Ninguno si la actualizaci贸n falla.

C贸digo fuente en 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}")