Salta para o conteúdo

Referência para hub_sdk/modules/teams.py

Nota

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



hub_sdk.modules.teams.Teams

Bases: CRUDClient

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

Atributos:

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

O identificador único da equipa, se disponível.

data dict

Um dicionário para armazenar os dados da equipa.

Nota

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

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

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

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

    def __init__(self, team_id: Optional[str] = None, headers: Optional[Dict[str, Any]] = None):
        """
        Initialize a Teams instance.

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

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

        If a valid team ID has been set, it sends a request to fetch the team data and stores it in the instance.
        If no team 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("Team id is %s", self.id)
        else:
            self.logger.error("No team id has been set. Update the team id or create a team.")

    def create_team(self, team_data) -> None:
        """
        Creates a new team with the provided data and sets the team ID for the current instance.

        Args:
            team_data (dict): A dictionary containing the data for creating the team.

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

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

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

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

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

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

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

        Returns:
            (Optional[Response]): The response from the update request, or Noe if it fails.
        """
        return super().update(self.id, data)

__init__(team_id=None, headers=None)

Inicializa uma instância do Teams.

Parâmetros:

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

O identificador único da equipa.

None
headers dict

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

None
Código fonte em hub_sdk/modules/teams.py
def __init__(self, team_id: Optional[str] = None, headers: Optional[Dict[str, Any]] = None):
    """
    Initialize a Teams instance.

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

create_team(team_data)

Cria uma nova equipa com os dados fornecidos e define o ID da equipa para a instância atual.

Parâmetros:

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

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

necessário

Devolve:

Tipo Descrição
None

O método não devolve um valor.

Código fonte em hub_sdk/modules/teams.py
def create_team(self, team_data) -> None:
    """
    Creates a new team with the provided data and sets the team ID for the current instance.

    Args:
        team_data (dict): A dictionary containing the data for creating the team.

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

delete(hard=False)

Elimina o recurso de equipa representado por esta instância.

Parâmetros:

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

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

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, a equipa pode ser marcada como eliminada mas mantida no sistema. Numa eliminação definitiva, a equipa é permanentemente removida do sistema.

Devolve:

Tipo Descrição
Optional[Response]

A resposta do pedido de eliminação, ou None se falhar.

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

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

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

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

get_data()

Recupera dados para a instância atual da equipa.

Se tiver sido definido um ID de equipa válido, envia um pedido para ir buscar os dados da equipa e guarda-os na instância. Se não tiver sido definido um ID de equipa, 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/teams.py
def get_data(self) -> None:
    """
    Retrieves data for the current team instance.

    If a valid team ID has been set, it sends a request to fetch the team data and stores it in the instance.
    If no team 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("Team id is %s", self.id)
    else:
        self.logger.error("No team id has been set. Update the team id or create a team.")

update(data)

Actualiza o recurso da equipa representado por esta instância.

Parâmetros:

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

Os dados actualizados para o recurso equipa.

necessário

Devolve:

Tipo Descrição
Optional[Response]

A resposta do pedido de atualização, ou Noe se falhar.

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

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

    Returns:
        (Optional[Response]): The response from the update request, or Noe if it fails.
    """
    return super().update(self.id, data)



hub_sdk.modules.teams.TeamList

Bases: PaginatedList

Código fonte em hub_sdk/modules/teams.py
class TeamList(PaginatedList):
    def __init__(self, page_size=None, public=None, headers=None):
        """
        Initialize a TeamList instance.

        Args:
            page_size (int, optional): The number of items to request per page.
            public (bool, optional): Whether the items should be publicly accessible.
            headers (dict, optional): Headers to be included in API requests.
        """
        base_endpoint = "datasets"
        if public:
            base_endpoint = f"public/{base_endpoint}"
        super().__init__(base_endpoint, "team", page_size, headers)

__init__(page_size=None, public=None, headers=None)

Inicializa uma instância de TeamList.

Parâmetros:

Nome Tipo Descrição Predefinição
page_size int

O número de itens a pedir por página.

None
public bool

Se os elementos devem ser acessíveis ao público.

None
headers dict

Cabeçalhos a incluir nos pedidos de API.

None
Código fonte em hub_sdk/modules/teams.py
def __init__(self, page_size=None, public=None, headers=None):
    """
    Initialize a TeamList instance.

    Args:
        page_size (int, optional): The number of items to request per page.
        public (bool, optional): Whether the items should be publicly accessible.
        headers (dict, optional): Headers to be included in API requests.
    """
    base_endpoint = "datasets"
    if public:
        base_endpoint = f"public/{base_endpoint}"
    super().__init__(base_endpoint, "team", page_size, headers)