Skip to content

Reference for hub_sdk/modules/users.py

Note

This file is available at https://github.com/ultralytics/hub-sdk/blob/main/hub_sdk/modules/users.py. If you spot a problem please help fix it by contributing a Pull Request 🛠️. Thank you 🙏!


hub_sdk.modules.users.Users 

Users(user_id: Optional[str] = None, headers: Optional[Dict[str, Any]] = None)

Bases: 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:

Name Type Description
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.

Parameters:

Name Type Description Default
user_id str

The unique identifier of the user.

 None
headers dict

A dictionary of HTTP headers to be included in API requests.

 None
Source code in hub_sdk/modules/users.py 
24
25
26
27
28
29
30
31
32
33
34
35
36
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 

create_user(user_data: dict) -> None

Creates a new user with the provided data and sets the user ID for the current instance.

Parameters:

Name Type Description Default
user_data dict

A dictionary containing the data for creating the user.

 required

Returns:

Type Description
None

The method does not return a value.
Source code in hub_sdk/modules/users.py 
76
77
78
79
80
81
82
83
84
85
86
87
88
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 

delete(hard: bool = False) -> Optional[Response]

Delete the user resource represented by this instance.

Parameters:

Name Type Description Default
hard bool

If True, perform a hard delete.

 False
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:

Type Description
Optional[Response]

Response object from the delete request, or None if delete fails
Source code in hub_sdk/modules/users.py 
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
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 

get_data() -> 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:

Type Description
None

The method does not return a value.
Source code in hub_sdk/modules/users.py 
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
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 not self.id:
        self.logger.error("No user id has been set. Update the user id or create a user.")
        return

    try:
        response = super().read(self.id)

        if response is None:
            self.logger.error(f"Received no response from the server for user ID: {self.id}")
            return

        # Check if the response has a .json() method (it should if it's a response object)
        if not hasattr(response, "json"):
            self.logger.error(f"Invalid response object received for user ID: {self.id}")
            return

        resp_data = response.json()
        if resp_data is None:
            self.logger.error(f"No data received in the response for user ID: {self.id}")
            return

        data = resp_data.get("data", {})
        self.data = self._reconstruct_data(data)
        self.logger.debug(f"User data retrieved for ID: {self.id}")

    except Exception as e:
        self.logger.error(f"An error occurred while retrieving data for user ID: {self.id}, {str(e)}")

update 

update(data: dict) -> Optional[Response]

Update the user resource represented by this instance.

Parameters:

Name Type Description Default
data dict

The updated data for the user resource.

 required

Returns:

Type Description
Optional[Response]

Response object from the update request, or None if update fails
Source code in hub_sdk/modules/users.py 
107
108
109
110
111
112
113
114
115
116
117
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)