コンテンツへスキップ

参考 hub_sdk/modules/teams.py

備考

このファイルはhttps://github.com/ultralytics/hub-sdk/blob/main/ hub_sdk/modules/teams .py にあります。もし問題を発見したら、Pull Request🛠️ を投稿して修正にご協力ください。ありがとうございます🙏!



hub_sdk.modules.teams.Teams

ベース: CRUDClient

CRUD 操作を通じて Teams と対話するためのクライアントを表すクラスです。このクラスは CRUDClient クラスを継承し、Teams を操作するための固有のメソッドを提供します。

属性:

名称 タイプ 説明
id (str, None)

もしあれば、チーム固有の識別子。

data dict

チームデータを格納する辞書。

備考

id'属性は初期化時に設定され、チームを一意に識別するために使用されます。 data' 属性はAPIから取得したチームデータを保存するために使用されます。

ソースコード 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)

Teamsインスタンスを初期化する。

パラメーター

名称 タイプ 説明 デフォルト
team_id str

チーム固有の識別子。

None
headers dict

APIリクエストに含まれるHTTPヘッダーの辞書。

None
ソースコード 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)

提供されたデータで新しいチームを作成し、現在のインスタンスのチームIDを設定します。

パラメーター

名称 タイプ 説明 デフォルト
team_data dict

チームを作成するためのデータを含む辞書。

必須

リターンズ

タイプ 説明
None

メソッドは値を返さない。

ソースコード 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)

このインスタンスが表すチームリソースを削除します。

パラメーター

名称 タイプ 説明 デフォルト
hard bool

Trueの場合、ハード(永久)削除を行う。

False
備考

hard」パラメータは、ソフト削除(デフォルト)とハード削除のどちらを実行するかを決定します。 ソフト削除では、チームは削除されたものとしてマークされますが、システムには保持されます。 ハード削除では、チームはシステムから永久に削除されます。

リターンズ

タイプ 説明
Optional[Response]

削除リクエストの応答。失敗した場合は None。

ソースコード 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()

現在のチームインスタンスのデータを取得します。

有効なチームIDが設定されている場合、チームデータを取得するリクエストを送信し、インスタンスに保存します。 チームIDが設定されていない場合は、エラーメッセージが記録される。

リターンズ

タイプ 説明
None

メソッドは値を返さない。

ソースコード 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)

このインスタンスが表すチームリソースを更新する。

パラメーター

名称 タイプ 説明 デフォルト
data dict

チームリソースの更新データ。

必須

リターンズ

タイプ 説明
Optional[Response]

更新リクエストからのレスポンス、失敗した場合はノー。

ソースコード 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

ベース: PaginatedList

ソースコード 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)

TeamList インスタンスを初期化します。

パラメーター

名称 タイプ 説明 デフォルト
page_size int

ページあたりのリクエスト項目数。

None
public bool

一般公開すべきかどうか。

None
headers dict

API リクエストに含めるヘッダー。

None
ソースコード 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)