]j6dZddlZddlZddlZddlZddlmZddlmZm Z m Z ddl m Z ejeZdZdeej$j'dd fZiZd ZGd d eZGd deZy)z .. include::../docs/client.md N)Optional) BaseModelconstrroot_validator) HTTPAdapterg$@TIMEOUTzhttp://localhost:8080cteZdZUdZeeed<dZeeed<dZee ed<e dddZ y)ClientCredentialsNemailpasswordapi_keyT)pre allow_reusecBd|vs d|vsJdd|vs d|vsJd|S)Nr rz3At least one of email or api_key should be includedrz.Provide both email and password for login auth)clsvaluess I/root/env/lib/python3.12/site-packages/label_studio_sdk/_legacy/client.pyeither_key_or_email_passwordz.ClientCredentials.either_key_or_email_passwordsK v f!4 A @ A 4 6 !Z6%9 < ; < 9 ) __name__ __module__ __qualname__r rstr__annotations__rrrrrrrrr r sHE8C="Hhsm""&GXfh &$/0rr c eZdZ ddedededefdZdZdefd Zd Z d Z d e fd Z dZ dZdZdZdZdZddZdZdZdZdZdZdZdZdZy)ClientNurlr extra_headerscookiesc |stjdt}|jd|_| |_|xs|j |_||_||tjd}| t|}| | td|jr |jn|j||_ dd|ji|_ |r |jjd d |i|r|jj||r|n|j|_d |j v|_y) aInitialize the client. Do this before using other Label Studio SDK classes and methods in your script. Parameters ---------- url: str Label Studio host address. Example: http://localhost:8080 api_key: str User token for the API. You can find this on your user account page in Label Studio. credentials: ClientCredentials User email and password or api_key. session: requests.Session() If None, a new one is created. extra_headers: dict Additional headers that will be passed to each http request cookies: dict Cookies that will be passed to each http request. oidc_token: str Bearer token for proxy authentication - in case the server is behind an authenticating proxy. versions: dict Versions of Label Studio components for the connected instance make_request_raise: bool If true, make_request will raise exceptions on request errors LABEL_STUDIO_URL/NLABEL_STUDIO_API_KEY)rzlIf neither 'api_key' nor 'credentials' are provided, 'LABEL_STUDIO_API_KEY' environment variable must be set AuthorizationzToken zProxy-AuthorizationzBearer zlabel-studio-enterprise-backend)osgetenvLABEL_STUDIO_DEFAULT_URLrstripr make_request_raise get_sessionsessionr"r RuntimeErrorr get_api_keyheadersupdate get_versionsversions is_enterprise) selfr r credentialsr.r!r" oidc_tokenr4r,s r__init__zClient.__init__'s8H)).0HIC::c?"44$"2"2"4   ?{2ii 67G  +G$--Orcd|jddj|_|jS)zCall /version api and get all Label Studio component versions Returns ------- dict with Label Studio component names and their versions GETz /api/version) make_requestjsonr4)r6s rr3zClient.get_versionsrs+))%@EEG }}rr7c|jd}|jj||jjjdd}t di|j d|i}|jj ||t |j |jj|jj|jdjjd}|S) Nz /user/login csrftokencsrfmiddlewaretoken)Referer)datar1r"z/api/current-user/tokentokenr) get_urlr.getr"dictpostr raise_for_statusr=)r6r7 login_url csrf_token login_datars rr0zClient.get_api_key}sLL/  #\\))--k4@ OK,,.OJO   *LL     LL  T\\*CD E TV S\  rcF|jdd}|jS)zCall Label Studio /health endpoint to check the connection to the server. Returns ------- dict Status string like "UP" r;z/healthr<r=)r6responses rcheck_connectionzClient.check_connections"$$UI6}}rc &|jdi|S)List all projects in Label Studio. Returns ------- list or `label_studio_sdk.project.Project` instances r) list_projects)r6 query_paramss r get_projectszClient.get_projectss"t!!1L11r project_idc2|jdd|d}|S)zrDelete a project in Label Studio. Returns ------- dict Status string DELETEz/api/projects/r%)r<)r6rUrNs rdelete_projectzClient.delete_projects$$$X |1/MNrcg}|jDcgc]}|jd}}|D]$}|j|}|j|&|Scc}w)zDeletes all projects in Label Studio. Returns ------- List List of (dict) status strings id)rR get_paramsrXappend)r6 responsesproject project_idsrUrNs rdelete_all_projectszClient.delete_all_projectssn AEASASAUVgw))+D1V V% 'J**:6H   X & ' WsAc ddlm}ddi}|j||jdd|}|jdk(rg}|j d D]m}|j ||d | }|j|tjd |jd |jjddo|Sy)rQProject page_sizeir;z /api/projects)paramsresultsrZ)clientrUrfzProject z "titlez" is retrievedN) r^rdr2r< status_coder=_create_from_idr\loggerdebugrZr[rE)r6rSrdrfrNprojectsrBr^s rrRzClient.list_projectss %x( l#$$UOF$K   3 &H  2 !11DJt2( wzzl"W-?-?-A-E-Eg-N,O~^  O 'rc &|jdi|S)Nr) start_project)r6kwargss rcreate_projectzClient.create_projects!t!!+F++rc ddlm}||j|j|j|j }|j di||S)zCreate a new project instance. Parameters ---------- kwargs: Parameters for `project.start_project(**kwargs)` Returns ------- `label_studio_sdk.project.Project` rbrc)r rr.r4r)r^rdr rr.r4rq)r6rrrdr^s rrqzClient.start_projectsG %LLLL]]   ''rc2ddlm}|j||S)aReturn project SDK object by ID existed in Label Studio Parameters ---------- id: int Project ID for the project you want to retrieve. Returns ------- `label_studio_sdk.project.Project` rbrc)r^rd get_from_id)r6rZrds r get_projectzClient.get_projects %""4,,rcddlm}|jdd}g}|jD]}||d<|j |di| |S)zReturn all users from the current organization account Parameters ---------- Returns ------- list of `label_studio_sdk.users.User` rbUserr; /api/usersrir)usersrzr<r=r\)r6rzrNr| user_datas r get_userszClient.get_userssX $$UL9! ,I"&Ih  LL* * + , rcddlm}t||rR|jr |jn |j|j|j |j |jdn|}|jdd|d}|j}||d<|jd kr|di|Sd |jvr|d ury tjd t|jzy )aCreate a new user Parameters ---------- user: User or dict User instance, you can initialize it this way: User(username='x', email='x@x.xx', first_name='X', last_name='Z') exist_ok: bool True by default, it won't print error if user exists and exist_ok=True Returns ------- `label_studio_sdk.users.User` Created user rbry)usernamer first_name last_namephonePOSTr{F)r=raise_exceptionsrizalready existsTNzCreate user error: r)r|rz isinstancerr rrrr<r=rktextrmerrorr)r6userexist_okrzpayloadrNr}s r create_userzClient.create_users" $% .2]]DMM "oo!^^   $$ Lw% MMO " (   # %$)$ $8==0X5E LL.X]]_1EE Frcddlm}|jsJd|jdd}g}|j D]}||d<|j |di| |S)zReturn all workspaces from the current organization account Parameters ---------- Returns ------- list of `label_studio_sdk.workspaces.Workspace` rb) WorkspacezEWorkspaces are available only for Enterprise instance of Label Studior;z/api/workspacesrir) workspacesrr5r<r=r\)r6rrNrworkspace_datas rget_workspaceszClient.get_workspacesEs{ *    S R S $$U,=> &mmo ;N'+N8 $   i9.9 : ;rcX|j}|D]}|j|k(s|cSy)zReturn workspace by title from the current organization account Parameters ---------- title: str Workspace title Returns ------- `label_studio_sdk.workspaces.Workspace` or None N)rrj)r6rjr workspaces rget_workspace_by_titlezClient.get_workspace_by_title^s8((* # !I%'   !rc|jddj}|d}|jdd|}|jS)zfReturn active organization for the current user Returns ------- dict r;z/api/current-user/whoamiactive_organizationz/api/organizations/rM)r6rNorganization_ids rget_organizationzClient.get_organizationqsT$$U,FGLLN"#89$$U.A/AR,ST}}rctj}|jjt|j dt t|j dt t|S)zkCreate a session with requests.Session() Returns ------- request.Session zhttp://) max_retrieszhttps://)requestsSessionr1r2HEADERSmountr MAX_RETRIES)r6r.s rr-zClient.get_sessionsO""$w' i!EF j++"FGrcB|jd|jdS)zmGet the URL of the Label Studio server Returns ------- String with the URL r%)r lstrip)r6suffixs rrDzClient.get_urls#((1V]]3/011rc d|vr t|d<|j}d|vr|jd}tj |d|d|d||j j ||j|g||j|jd|}|r0|jdk\r!|j||j|S)aMake a request with an API key to Label Studio instance Parameters ---------- method: str HTTP method like POST, PATCH, GET, DELETE. url: str URL of the API endpoint that you want to make a request to. args session.request(*args) kwargs session.request(*kwargs) Returns ------- Response object for the relevant endpoint. timeoutrz: z with args=z , kwargs=)r1r"r) r r,poprmrnr.requestrDr1r"rklog_response_errorrH)r6methodr argsrrrrNs rr<zClient.make_requests( F " 'F9 22  '%zz*<=  xr#k$yIJ'4<<''  LL    LLLL     ##s*''1))+rc  tjtj|jd}t j d|jd|jd|dy#|j}YDxYw)N)indentz; -------------------------------------------- Request URL: z Response status code: z Response content: z SDK error traceback:) r=dumpsloadscontentrrmrr rk)r6rNrs rrzClient.log_response_errorsw $jjH,<,*%%-%9%9$:;"")+# $  $mmGs 4A**A:c f|jdd|dt|d}|jS)z&See project.sync_storage for more inforz/api/storages/r%z/sync)r<rr=)r6 storage_type storage_idrNs r sync_storagezClient.sync_storages9$$ n\N!C O3DEJ }}r) NNNNNNNNT)T)rrrrrFr9r3r r0rOrTintrXr`rRrsrqrwr~rrrrr-rDr<rrrrrrr&s"IP IPIP  IPIPV '8& 2   2,0-"(+Z2&  2*X  rr)__doc__r=loggingr(rtypingrpydanticrrrrequests.adaptersr getLoggerrrmrrenvironrEr rr*r objectrrrrrs~  66)   8 $ RZZ^^Is34 5 2   qVqr