انتقل إلى المحتوى

مرجع ل hub_sdk/base/auth.py

ملاحظه

هذا الملف متاح في https://github.com/ultralytics/hub-SDK / نقطة / الرئيسية /hub_sdk / قاعدة / مصادقة .py. إذا اكتشفت مشكلة ، فيرجى المساعدة في إصلاحها من خلال المساهمة في طلب 🛠️ سحب. شكرا لك 🙏!



hub_sdk.base.auth.Auth

يمثل مدير المصادقة.

سمات:

اسم نوع وصف
api_key (str, None)

مفتاح API المستخدم للمصادقة.

id_token (str, None)

الرمز المميز للمصادقة.

شفرة المصدر في hub_sdk/base/auth.py
12 13 14 15 16 17 18  19 20 21  22 23 24 25 26 27 28  29  30 31 32  33 34 35 36   37   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 75  76 77          78  79 80 81 82 83 84 85 86 87 88  89 90 91 92 93  94 95 96 97  98     99 100 101  102  103 104  105    106 107 108 109 110 111 112 113 114 115116
class Auth:
    """
    Represents an authentication manager.

    Attributes:
        api_key (str, None): The API key used for authentication.
        id_token (str, None): The authentication token.
    """

    def __init__(self):
        """Initializes the Auth class with default authentication settings."""
        self.api_key = None
        self.id_token = None

    def authenticate(self) -> bool:
        """
        Attempt to authenticate with the server using either id_token or API key.

        Returns:
            (bool): True if authentication is successful, False otherwise.

        Raises:
            (ConnectionError): If request response is hasn't success in json, raised connection error exception.
        """
        try:
            header = self.get_auth_header()
            if header:
                r = requests.post(f"{HUB_API_ROOT}/v1/auth", headers=header)
                if not r.json().get("success", False):
                    raise ConnectionError("Unable to authenticate.")
                return True
            raise ConnectionError("User has not authenticated locally.")
        except ConnectionError:
            logger.warning(f"{PREFIX} Invalid API key ⚠️")
        except requests.exceptions.RequestException as e:
            status_code = None
            if hasattr(e, "response"):
                status_code = e.response.status_code

            error_msg = ErrorHandler(status_code).handle()
            logger.warning(f"{PREFIX} {error_msg}")

        self.id_token = self.api_key = False  # reset invalid
        return False

    def get_auth_header(self) -> Optional[dict]:
        """
        Get the authentication header for making API requests.

        Returns:
            (Optional[dict]): The authentication header if id_token or API key is set, None otherwise.
        """
        if self.id_token:
            return {"authorization": f"Bearer {self.id_token}"}
        elif self.api_key:
            return {"x-api-key": self.api_key}
        else:
            return None

    def get_state(self) -> bool:
        """
        Get the authentication state.

        Returns:
            (bool): True if either id_token or API key is set, False otherwise.
        """
        return self.id_token or self.api_key

    def set_api_key(self, key: str):
        """
        Set the API key for authentication.

        Args:
            key (str): The API key string.
        """
        self.api_key = key

    def authorize(self, email: str, password: str) -> bool:
        """
        Authorize the user by obtaining an idToken through a POST request with email and password.

        Args:
            email (str): User's email.
            password (str): User's password.

        Returns:
            (bool): True if authorization is successful, False otherwise.
        """
        try:
            headers = {"origin": HUB_WEB_ROOT}
            response = requests.post(FIREBASE_AUTH_URL, json={"email": email, "password": password}, headers=headers)
            if response.status_code == 200:
                self.id_token = response.json().get("idToken")
                return True
            else:
                raise ConnectionError("Authorization failed.")
        except ConnectionError:
            logger.warning(f"{PREFIX} Invalid API key ⚠️")
        except requests.exceptions.RequestException as e:
            status_code = None
            if hasattr(e, "response"):
                status_code = e.response.status_code

            error_msg = ErrorHandler(status_code).handle()
            logger.warning(f"{PREFIX} {error_msg}")

__init__()

تهيئة فئة المصادقة باستخدام إعدادات المصادقة الافتراضية.

شفرة المصدر في hub_sdk/base/auth.py
def __init__(self):
    """Initializes the Auth class with default authentication settings."""
    self.api_key = None
    self.id_token = None

authenticate()

حاول المصادقة مع الخادم باستخدام مفتاح id_token أو API.

ارجاع:

نوع وصف
bool

صحيح إذا نجحت المصادقة ، خطأ خلاف ذلك.

يثير:

نوع وصف
ConnectionError

إذا لم تنجح استجابة الطلب في json ، فقد تم رفع استثناء خطأ الاتصال.

شفرة المصدر في hub_sdk/base/auth.py
26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 4142 43 44 45 46 474849 5051 525354 55
def authenticate(self) -> bool:
    """
    Attempt to authenticate with the server using either id_token or API key.

    Returns:
        (bool): True if authentication is successful, False otherwise.

    Raises:
        (ConnectionError): If request response is hasn't success in json, raised connection error exception.
    """
    try:
        header = self.get_auth_header()
        if header:
            r = requests.post(f"{HUB_API_ROOT}/v1/auth", headers=header)
            if not r.json().get("success", False):
                raise ConnectionError("Unable to authenticate.")
            return True
        raise ConnectionError("User has not authenticated locally.")
    except ConnectionError:
        logger.warning(f"{PREFIX} Invalid API key ⚠️")
    except requests.exceptions.RequestException as e:
        status_code = None
        if hasattr(e, "response"):
            status_code = e.response.status_code

        error_msg = ErrorHandler(status_code).handle()
        logger.warning(f"{PREFIX} {error_msg}")

    self.id_token = self.api_key = False  # reset invalid
    return False

authorize(email, password)

تخويل المستخدم عن طريق الحصول على idToken من خلال طلب POST مع البريد الإلكتروني وكلمة المرور.

البارامترات:

اسم نوع وصف افتراضي
email str

البريد الإلكتروني للمستخدم.

مطلوب
password str

كلمة مرور المستخدم.

مطلوب

ارجاع:

نوع وصف
bool

صحيح إذا كان التفويض ناجحا ، خطأ بخلاف ذلك.

شفرة المصدر في hub_sdk/base/auth.py
 89 90 91 92 93 94 95 96 97 98  99 100 101 102 103 104 105 106  107 108 109 110 111 112 113 114 115116 
def authorize(self, email: str, password: str) -> bool:
    """
    Authorize the user by obtaining an idToken through a POST request with email and password.

    Args:
        email (str): User's email.
        password (str): User's password.

    Returns:
        (bool): True if authorization is successful, False otherwise.
    """
    try:
        headers = {"origin": HUB_WEB_ROOT}
        response = requests.post(FIREBASE_AUTH_URL, json={"email": email, "password": password}, headers=headers)
        if response.status_code == 200:
            self.id_token = response.json().get("idToken")
            return True
        else:
            raise ConnectionError("Authorization failed.")
    except ConnectionError:
        logger.warning(f"{PREFIX} Invalid API key ⚠️")
    except requests.exceptions.RequestException as e:
        status_code = None
        if hasattr(e, "response"):
            status_code = e.response.status_code

        error_msg = ErrorHandler(status_code).handle()
        logger.warning(f"{PREFIX} {error_msg}")

get_auth_header()

احصل على رأس المصادقة لتقديم طلبات واجهة برمجة التطبيقات.

ارجاع:

نوع وصف
Optional[dict]

رأس المصادقة إذا تم تعيين مفتاح id_token أو API ، لا شيء بخلاف ذلك.

شفرة المصدر في hub_sdk/base/auth.py
57 58 59 60 61 62 63 64 65 66 676869
def get_auth_header(self) -> Optional[dict]:
    """
    Get the authentication header for making API requests.

    Returns:
        (Optional[dict]): The authentication header if id_token or API key is set, None otherwise.
    """
    if self.id_token:
        return {"authorization": f"Bearer {self.id_token}"}
    elif self.api_key:
        return {"x-api-key": self.api_key}
    else:
        return None

get_state()

احصل على حالة المصادقة.

ارجاع:

نوع وصف
bool

صحيح إذا تم تعيين مفتاح id_token أو API ، خطأ خلاف ذلك.

شفرة المصدر في hub_sdk/base/auth.py
71 72 73 74757677 78
def get_state(self) -> bool:
    """
    Get the authentication state.

    Returns:
        (bool): True if either id_token or API key is set, False otherwise.
    """
    return self.id_token or self.api_key

set_api_key(key)

قم بتعيين مفتاح API للمصادقة.

البارامترات:

اسم نوع وصف افتراضي
key str

سلسلة مفاتيح API.

مطلوب
شفرة المصدر في hub_sdk/base/auth.py
80 81 82 83848586 87
def set_api_key(self, key: str):
    """
    Set the API key for authentication.

    Args:
        key (str): The API key string.
    """
    self.api_key = key