메인 콘텐츠로 건너뛰기
GitHub 소스 코드

​
class User

인증 및 관리 기능을 갖춘 W&B 사용자를 나타내는 클래스입니다. 이 클래스는 W&B 사용자를 생성하고, API key를 관리하고, 팀 멤버십을 조회하는 등 사용자 관리를 위한 메서드를 제공합니다. 사용자 속성 처리를 위해 Attrs에서 상속받습니다.

​
method User.__init__

__init__(client: 'RetryingClient', attrs: 'MutableMapping[str, Any]')
Args:
  • client: (wandb.apis.internal.Api) 사용할 클라이언트 인스턴스입니다
  • attrs: (dict) 사용자 속성입니다
Note:
일부 작업에는 관리자 권한이 필요합니다

​
property User.api_keys

사용자와 연결된 API key 이름의 목록입니다. 반환값: 사용자와 연결된 API key 이름 목록입니다. 사용자가 API key를 보유하고 있지 않거나 API key 데이터가 아직 로드되지 않은 경우 빈 리스트를 반환합니다. 반환값:
  • list[str]: api_keys 프로퍼티의 값입니다.

​
property User.teams

사용자가 속한 팀 이름 목록입니다. Returns: 사용자가 속한 팀 이름 목록입니다. 사용자가 어떤 팀에도 속해 있지 않거나 teams 데이터가 로드되지 않은 경우 빈 리스트를 반환합니다. Returns:
  • list[str]: teams 속성 값입니다.

​
property User.user_api

해당 사용자의 자격 증명을 사용하는 API 인스턴스입니다. 반환값:
  • Api | None: user_api 프로퍼티 값입니다.

​
classmethod User.create

create(api: 'Api', email: 'str', admin: 'bool' = False) → Self
새 사용자를 생성합니다. 인자:
  • api (Api): 사용할 API 인스턴스
  • email (str): 팀의 이름
  • admin (bool): 이 사용자를 전역 인스턴스 관리자(global instance admin)로 설정할지 여부
반환값: User 객체를 반환합니다.

​
메서드 User.delete_api_key

delete_api_key(api_key: 'str') → bool
사용자의 API key를 삭제합니다. Args:
  • api_key (str): 삭제할 API key의 이름입니다. api_keys 속성이 반환하는 이름 중 하나여야 합니다.
Returns: 성공 여부를 나타내는 Boolean 값 Raises: api_key를 찾을 수 없을 경우 ValueError를 발생시킵니다.

​
method User.generate_api_key

generate_api_key(description: 'str | None' = None) → str | None
새 API key를 생성합니다. Args:
  • description (str, optional): 새 API key에 대한 설명입니다. API key의 용도를 식별하는 데 사용할 수 있습니다.
Returns: 새 API key 또는 실패 시 None.