Salta para o conteúdo

Referência para hub_sdk/modules/users.py

Nota

Este ficheiro está disponível em https://github.com/ultralytics/ hub-sdk/blob/main/ hub_sdk/modules/users .py. Se detectares um problema, por favor ajuda a corrigi-lo contribuindo com um Pull Request 🛠️. Obrigado 🙏!



hub_sdk.modules.users.Users

Bases: CRUDClient

Uma classe que representa um cliente para interagir com utilizadores através de operações CRUD. Esta classe estende a classe CRUDClient e fornece métodos específicos para trabalhar com os Utilizadores.

Atributos:

Nome Tipo Descrição
id (str, None)

O identificador único do utilizador, se disponível.

data dict

Um dicionário para armazenar os dados do utilizador.

Nota

O atributo "id" é definido durante a inicialização e pode ser utilizado para identificar um utilizador de forma exclusiva. O atributo "data" é utilizado para armazenar os dados do utilizador obtidos a partir da API.

Código fonte em hub_sdk/modules/users.py
class Users(CRUDClient):
    """
    A class representing a client for interacting with Users through CRUD operations. This class extends the CRUDClient
    class and provides specific methods for working with Users.

    Attributes:
        id (str, None): The unique identifier of the user, if available.
        data (dict): A dictionary to store user data.

    Note:
        The 'id' attribute is set during initialization and can be used to uniquely identify a user.
        The 'data' attribute is used to store user data fetched from the API.
    """

    def __init__(self, user_id: Optional[str] = None, headers: Optional[Dict[str, Any]] = None) -> None:
        """
        Initialize a Users object for interacting with user data via CRUD operations.

        Args:
            user_id (str, optional): The unique identifier of the user.
            headers (dict, optional): A dictionary of HTTP headers to be included in API requests.
        """
        super().__init__("users", "user", headers)
        self.id = user_id
        self.data = {}
        if user_id:
            self.get_data()

    def get_data(self) -> None:
        """
        Retrieves data for the current user instance.

        If a valid user ID has been set, it sends a request to fetch the user data and stores it in the instance.
        If no user ID has been set, it logs an error message.

        Returns:
            (None): The method does not return a value.
        """
        if self.id:
            resp = super().read(self.id).json()
            self.data = resp.get("data", {})
            self.logger.debug("user id is %s", self.id)
        else:
            self.logger.error("No user id has been set. Update the user id or create a user.")

    def create_user(self, user_data: dict) -> None:
        """
        Creates a new user with the provided data and sets the user ID for the current instance.

        Args:
            user_data (dict): A dictionary containing the data for creating the user.

        Returns:
            (None): The method does not return a value.
        """
        resp = super().create(user_data).json()
        self.id = resp.get("data", {}).get("id")
        self.get_data()

    def delete(self, hard: bool = False) -> Optional[Response]:
        """
        Delete the user resource represented by this instance.

        Args:
            hard (bool, optional): If True, perform a hard delete.

        Note:
            The 'hard' parameter determines whether to perform a soft delete (default) or a hard delete.
            In a soft delete, the model might be marked as deleted but retained in the system.
            In a hard delete, the model is permanently removed from the system.

        Returns:
            (Optional[Response]): Response object from the delete request, or None if delete fails
        """
        return super().delete(self.id, hard)

    def update(self, data: dict) -> Optional[Response]:
        """
        Update the user resource represented by this instance.

        Args:
            data (dict): The updated data for the user resource.

        Returns:
            (Optional[Response]): Response object from the update request, or None if update fails
        """
        return super().update(self.id, data)

__init__(user_id=None, headers=None)

Inicializa um objeto Users para interagir com os dados do utilizador através de operações CRUD.

Parâmetros:

Nome Tipo Descrição Predefinição
user_id str

O identificador único do utilizador.

None
headers dict

Um dicionário de cabeçalhos HTTP a incluir nos pedidos de API.

None
Código fonte em hub_sdk/modules/users.py
def __init__(self, user_id: Optional[str] = None, headers: Optional[Dict[str, Any]] = None) -> None:
    """
    Initialize a Users object for interacting with user data via CRUD operations.

    Args:
        user_id (str, optional): The unique identifier of the user.
        headers (dict, optional): A dictionary of HTTP headers to be included in API requests.
    """
    super().__init__("users", "user", headers)
    self.id = user_id
    self.data = {}
    if user_id:
        self.get_data()

create_user(user_data)

Cria um novo utilizador com os dados fornecidos e define o ID de utilizador para a instância atual.

Parâmetros:

Nome Tipo Descrição Predefinição
user_data dict

Um dicionário que contém os dados para a criação do utilizador.

necessário

Devolve:

Tipo Descrição
None

O método não devolve um valor.

Código fonte em hub_sdk/modules/users.py
def create_user(self, user_data: dict) -> None:
    """
    Creates a new user with the provided data and sets the user ID for the current instance.

    Args:
        user_data (dict): A dictionary containing the data for creating the user.

    Returns:
        (None): The method does not return a value.
    """
    resp = super().create(user_data).json()
    self.id = resp.get("data", {}).get("id")
    self.get_data()

delete(hard=False)

Elimina o recurso do utilizador representado por esta instância.

Parâmetros:

Nome Tipo Descrição Predefinição
hard bool

Se for Verdadeiro, executa uma eliminação definitiva.

False
Nota

O parâmetro 'hard' determina se deve ser efectuada uma eliminação suave (predefinição) ou uma eliminação rígida. Numa eliminação suave, o modelo pode ser marcado como eliminado mas mantido no sistema. Num apagamento rígido, o modelo é removido permanentemente do sistema.

Devolve:

Tipo Descrição
Optional[Response]

Objeto de resposta do pedido de eliminação, ou Nenhum se a eliminação falhar

Código fonte em hub_sdk/modules/users.py
def delete(self, hard: bool = False) -> Optional[Response]:
    """
    Delete the user resource represented by this instance.

    Args:
        hard (bool, optional): If True, perform a hard delete.

    Note:
        The 'hard' parameter determines whether to perform a soft delete (default) or a hard delete.
        In a soft delete, the model might be marked as deleted but retained in the system.
        In a hard delete, the model is permanently removed from the system.

    Returns:
        (Optional[Response]): Response object from the delete request, or None if delete fails
    """
    return super().delete(self.id, hard)

get_data()

Recupera os dados da instância de utilizador atual.

Se tiver sido definido um ID de utilizador válido, envia um pedido para ir buscar os dados do utilizador e guarda-os na instância. Se não tiver sido definido um ID de utilizador, regista uma mensagem de erro.

Devolve:

Tipo Descrição
None

O método não devolve um valor.

Código fonte em hub_sdk/modules/users.py
def get_data(self) -> None:
    """
    Retrieves data for the current user instance.

    If a valid user ID has been set, it sends a request to fetch the user data and stores it in the instance.
    If no user ID has been set, it logs an error message.

    Returns:
        (None): The method does not return a value.
    """
    if self.id:
        resp = super().read(self.id).json()
        self.data = resp.get("data", {})
        self.logger.debug("user id is %s", self.id)
    else:
        self.logger.error("No user id has been set. Update the user id or create a user.")

update(data)

Actualiza o recurso do utilizador representado por esta instância.

Parâmetros:

Nome Tipo Descrição Predefinição
data dict

Os dados actualizados para o recurso do utilizador.

necessário

Devolve:

Tipo Descrição
Optional[Response]

Objeto de resposta do pedido de atualização, ou Nenhum se a atualização falhar

Código fonte em hub_sdk/modules/users.py
def update(self, data: dict) -> Optional[Response]:
    """
    Update the user resource represented by this instance.

    Args:
        data (dict): The updated data for the user resource.

    Returns:
        (Optional[Response]): Response object from the update request, or None if update fails
    """
    return super().update(self.id, data)