vj|XdZddlZddlmZddlmZmZmZmZm Z m Z m Z m Z m Z mZddlmZddlmZddlmZmZdd lmZmZdd lmZmZmZmZmZmZm Z m!Z!m"Z"m#Z#m$Z$dd l%m&Z&m'Z'm(Z(e e)e ee)e*e+e,ee)ffZ-e ee e)eefe e)e e)eeffe e)e e)eee)ffe e)e e)eee)e e)e)ffffZ.Gd d Z/Gdde/Z0e e/Z1y)z{ gspread.http_client ~~~~~~~~~~~~~~ This module contains HTTPClient class responsible for communicating with Google API. N) HTTPStatus) IOAnyDictListMappingMutableMappingOptionalTupleTypeUnion) Credentials)AuthorizedSession)ResponseSession)APIErrorUnSupportedExportFormat) DRIVE_FILES_API_V3_URLDRIVE_FILES_UPLOAD_API_V2_URLSPREADSHEET_BATCH_UPDATE_URLSPREADSHEET_SHEETS_COPY_TO_URLSPREADSHEET_URLSPREADSHEET_VALUES_APPEND_URL"SPREADSHEET_VALUES_BATCH_CLEAR_URL#SPREADSHEET_VALUES_BATCH_UPDATE_URLSPREADSHEET_VALUES_BATCH_URLSPREADSHEET_VALUES_CLEAR_URLSPREADSHEET_VALUES_URL) ExportFormatconvert_credentialsquotec<eZdZdZd2dedeeddfdZd3dZdee e e e e ffddfd Z d4d e d e d eed eedeee efdedeee e fdefdZde deee efdefdZ d5de de d eedeee efdef dZde de d edeee efdef dZde de defdZ d5de d eedeee efdefdZ d2de de d eedefdZ d2de dee d eedefdZ d2de deee efdefdZd2de d eedefdZde de d e defd!Z! d2de d eedee effd"Z"de defd#Z#e$jJfd$e d%e defd&Z& d6d$e d'ee d(ee d)ee d*e'd+ee d,e'defd-Z(d$e dee)e e e e'fffd.Z*d$e d/e ddfd0Z+d$e d e e efdefd1Z,y)7 HTTPClientaAn instance of this class communicates with Google API. :param Credentials auth: An instance of google.auth.Credentials used to authenticate requests created by either: * gspread.auth.oauth() * gspread.auth.oauth_from_dict() * gspread.auth.service_account() * gspread.auth.service_account_from_dict() :param Session session: (Optional) An OAuth2 credential object. Credential objects created by `google-auth `_. You can pass you own Session object, simply pass ``auth=None`` and ``session=my_custom_session``. This class is not intended to be created manually. It will be created by the gspread.Client class. Nauthsessionreturnc|||_d|_yt||_t|j|_d|_yN)r&r!r%rtimeout)selfr%r&s F/var/www/html/venv/lib/python3.12/site-packages/gspread/http_client.py__init__zHTTPClient.__init__Ms?  "DL EI &9%>DI,TYY7DLDH cddlm}|jj||j|jj j dd|jjziy)Nr)Request Authorizationz Bearer %s)google.auth.transport.requestsr0r%refreshr&headersupdatetoken)r+r0s r,loginzHTTPClient.loginVsJ: '$,,/0 ##_kDIIOO6S$TUr.r*c||_y)zHow long to wait for the server to send data before giving up, as a float, or a ``(connect timeout, read timeout)`` tuple. Use value ``None`` to restore default timeout Value for ``timeout`` is in seconds (s). N)r*)r+r*s r, set_timeoutzHTTPClient.set_timeout]s  r.methodendpointparamsdatajsonfilesr4c |jj||||||||j}|jr|St |)N)r:urlr>r<r=r?r4r*)r&requestr*okr) r+r:r;r<r=r>r?r4responses r,rBzHTTPClient.requesthsR<<''LL(   ;;O8$ $r.idbodycX|jdt|z|}|jS)a Lower-level method that directly calls `spreadsheets/:batchUpdate `_. :param dict body: `Batch Update Request body `_. :returns: `Batch Update Response body `_. :rtype: dict .. versionadded:: 3.0 postr>)rBrr>)r+rErFrs r, batch_updatezHTTPClient.batch_updates) LL!=!BL Nvvxr.rangectt|t|fz}|jd|||}|jS)ayLower-level method that directly calls `PUT spreadsheets//values/ `_. :param str range: The `A1 notation `_ of the values to update. :param dict params: (optional) `Values Update Query parameters `_. :param dict body: (optional) `Values Update Request body `_. :returns: `Values Update Response body `_. :rtype: dict Example:: sh.values_update( 'Sheet1!A2', params={ 'valueInputOption': 'USER_ENTERED' }, body={ 'values': [[1, 2, 3]] } ) .. versionadded:: 3.0 putr<r>rr"rBr>r+rErLr<rFrArJs r, values_updatezHTTPClient.values_updates8:%E%L'99 LLFL >vvxr.ctt|t|fz}|jd|||}|jS)aLower-level method that directly calls `spreadsheets//values:append `_. :param str range: The `A1 notation `_ of a range to search for a logical table of data. Values will be appended after the last row of the table. :param dict params: `Values Append Query parameters `_. :param dict body: `Values Append Request body `_. :returns: `Values Append Response body `_. :rtype: dict .. versionadded:: 3.0 rHrO)rr"rBr>rQs r, values_appendzHTTPClient.values_appends8,r5<.@@ LLV$L ?vvxr.cnt|t|fz}|jd|}|jS)aLower-level method that directly calls `spreadsheets//values:clear `_. :param str range: The `A1 notation `_ of the values to clear. :returns: `Values Clear Response body `_. :rtype: dict .. versionadded:: 3.0 rH)rr"rBr>)r+rErLrArJs r, values_clearzHTTPClient.values_clears2+b%,-?? LL %vvxr.c^t|z}|jd|||}|jS)aLower-level method that directly calls `spreadsheets//values:batchClear` :param dict params: (optional) `Values Batch Clear Query parameters `_. :param dict body: (optional) `Values Batch Clear request body `_. :rtype: dict rHrO)rrBr>)r+rEr<rFrArJs r,values_batch_clearzHTTPClient.values_batch_clears/125 LLV$L ?vvxr.crt|t|fz}|jd||}|jS)aLower-level method that directly calls `GET spreadsheets//values/ `_. :param str range: The `A1 notation `_ of the values to retrieve. :param dict params: (optional) `Values Get Query parameters `_. :returns: `Values Get Response body `_. :rtype: dict .. versionadded:: 3.0 getr<rP)r+rErLr<rArJs r, values_getzHTTPClient.values_gets6%E%L'99 LLFL 3vvxr.rangescn|i}||d<t|z}|jd||}|jS)aLower-level method that directly calls `spreadsheets//values:batchGet `_. :param list ranges: List of ranges in the `A1 notation `_ of the values to retrieve. :param dict params: (optional) `Values Batch Get Query parameters `_. :returns: `Values Batch Get Response body `_. :rtype: dict r]rZr[)rrBr>)r+rEr]r<rArJs r,values_batch_getzHTTPClient.values_batch_getsA >F!x*R/ LLFL 3vvxr.c\t|z}|jd||}|jS)a"Lower-level method that directly calls `spreadsheets//values:batchUpdate `_. :param dict body: (optional) `Values Batch Update Request body `_. :returns: `Values Batch Update Response body `_. :rtype: dict rHrI)rrBr>)r+rErFrArJs r,values_batch_updatezHTTPClient.values_batch_updates-2B6 LL4L 0vvxr.c\t|z}|jd||}|jS)zA method stub that directly calls `spreadsheets.get `_.rZr[rrBr>r+rEr<rArJs r,spreadsheets_getzHTTPClient.spreadsheets_gets+" LLFL 3vvxr.sheet_iddestination_spreadsheet_idcht||fz}d|i}|jd||}|jS)zLower-level method that directly calls `spreadsheets.sheets.copyTo `_.destinationSpreadsheetIdrHrI)rrBr>)r+rErfrgrArFrJs r,spreadsheets_sheets_copy_toz&HTTPClient.spreadsheets_sheets_copy_tos<-H~=*,FG LL4L 0vvxr.ch|ddi}t|z}|jd||}|jS)aSimilar to :method spreadsheets_get:`gspread.http_client.spreadsheets_get`, get the spreadsheet form the API but by default **does not get the cells data**. It only retrieve the the metadata from the spreadsheet. :param str id: the spreadsheet ID key :param dict params: (optional) the HTTP params for the GET request. By default sets the parameter ``includeGridData`` to ``false``. :returns: The raw spreadsheet :rtype: dict includeGridDatafalserZr[rcrds r,fetch_sheet_metadatazHTTPClient.fetch_sheet_metadatas< >'1F" LLFL 3vvxr.ctdj|z}dddd}|jd||}|jS)zGet the metadata from the Drive API for a specific file This method is mainly here to retrieve the create/update time of a file (these metadata are only accessible from the Drive API). z/{}Tz id,name,createdTime,modifiedTime)supportsAllDrivesincludeItemsFromAllDrivesfieldsrZr[)rformatrBr>)r+rErAr<ress r,get_file_drive_metadataz"HTTPClient.get_file_drive_metadata5sK %u||B'77"&)-8  ll5#fl5xxzr.file_idrsc|tvrtdjt|}d|i}|j d||}|j S)aExport the spreadsheet in the given format. :param str file_id: The key of the spreadsheet to export :param str format: The format of the resulting file. Possible values are: * ``ExportFormat.PDF`` * ``ExportFormat.EXCEL`` * ``ExportFormat.CSV`` * ``ExportFormat.OPEN_OFFICE_SHEET`` * ``ExportFormat.TSV`` * ``ExportFormat.ZIPPED_HTML`` See `ExportFormat`_ in the Drive API. :type format: :class:`~gspread.utils.ExportFormat` :returns bytes: The content of the exported file. .. _ExportFormat: https://developers.google.com/drive/api/guides/ref-export-formats z {}/{}/exportmimeTyperZr[)r rrsrrBcontent)r+rvrsrAr<rJs r,exportzHTTPClient.exportGsM0  %) )##$:GD(&1 LLFL 3yyr. email_address perm_typerolenotify email_message with_linkcdjt|}|||d} ddi} |dk(r|| d<n4|dvr|| d<|| d<|| d <n |d k(rntd j||jd || | S)aCreates a new permission for a file. :param str file_id: a spreadsheet ID (aka file ID). :param email_address: user or group e-mail address, domain name or None for 'anyone' type. :type email_address: str, None :param str perm_type: (optional) The account type. Allowed values are: ``user``, ``group``, ``domain``, ``anyone`` :param str role: (optional) The primary role for this user. Allowed values are: ``owner``, ``writer``, ``reader`` :param bool notify: Whether to send an email to the target user/domain. Default ``True``. :param str email_message: (optional) An email message to be sent if ``notify=True``. :param bool with_link: Whether the link is required for this permission to be active. Default ``False``. :returns dict: the newly created permission Examples:: # Give write permissions to otto@example.com gc.insert_permission( '0BmgG6nO_6dprnRRUWl1UFE', 'otto@example.org', perm_type='user', role='writer' ) # Make the spreadsheet publicly readable gc.insert_permission( '0BmgG6nO_6dprnRRUWl1UFE', None, perm_type='anyone', role='reader' ) {}/{}/permissions)typer}withLinkrptruedomain>usergroup emailAddresssendNotificationEmail emailMessageanyonezInvalid permission type: {}rH)r>r<)rsr ValueErrorrB) r+rvr{r|r}r~rrrApayloadr<s r,insert_permissionzHTTPClient.insert_permissionisd"(()?I!     -GH  + +&3GN #.4F* +%2F> " ( " :AA)LM M||FCgf|EEr.cdjt|}ddd}d}g}|R|r||d<|jd|| j}|j |d |j d d}|R|S) zpRetrieve a list of permissions for a file. :param str file_id: a spreadsheet ID (aka file ID). rTznextPageToken,permissions)rprrN pageTokenrZr[ permissions nextPageToken)rsrrBr>extendrZ)r+rvrAr<r6rrJs r,list_permissionszHTTPClient.list_permissionss "(()?I"&1   &+{# UC 7<<>A   q/ 0EE/40Er. permission_idcbdjt||}ddi}|jd||y)zDeletes a permission from a file. :param str file_id: a spreadsheet ID (aka file ID.) :param str permission_id: an ID for the permission. z{}/{}/permissions/{}rpTdeleter[N)rsrrB)r+rvrrAr<s r,remove_permissionzHTTPClient.remove_permissions9 %++ "G] 248 Xs6 2r.c t|tr|jd}ddi}djt|}|j d||dddd| }|j S) aImports data into the first page of the spreadsheet. :param str data: A CSV string of data. Example: .. code:: # Read CSV file contents content = open('file_to_import.csv', 'r').read() gc.import_csv(spreadsheet.id, content) .. note:: This method removes all other worksheets and then entirely replaces the contents of the first worksheet. zutf-8z Content-Typeztext/csvz{}/{}rNmediaT) uploadTypeconvertrp)r=r<r4) isinstancestrencodersrrBr>)r+rvr=r4rArts r, import_csvzHTTPClient.import_csvst* dC ;;w'D!:.nn:GDll  %%)   xxzr.r))r'N)NNNNN)NN)TNF)-__name__ __module__ __qualname____doc__rr rr-r7r floatr r9r ParamsTypebytesrrFileTyper rrBrKrRrTrVrXr\rr_rareintrjrnrur PDFrzboolrrrrrr.r,r$r$9s)&I[I8G3DIPTIV 8E%ue|9L2L,M#N SW (, $,06:%%%$ % uo % wsCx() %%.c23% %4 s (7383D*E # "(,,0  $  wsCx()  B!+5=EgcSVhFW=X $ s 3 3  (,,0  $wsCx()  "CG!+3J+? "JN#Cy2::2F (<@  %gc3h&78   30DPS !$BE 7;' 3 c ,##$2>1A1A c 3 e P'+GFGF }GFC= GF sm GF  GF }GFGF GFRT#uS$Y?O:O5P0Q6 3 3S 3T 3'#'U3:->'3'r.r$ceZdZUdZej ej gZeee d<dZ e e d<dZ e e d<de de d effd ZxZS) BackOffHTTPClientaeBackOffHTTPClient is a http client with exponential backoff retries. In case a request fails due to some API rate limits, it will wait for some time, then retry the request. This can help by trying the request after some time and prevent the application from failing (by raising an APIError exception). .. Warning:: This HTTPClient is not production ready yet. Use it at your own risk ! .. note:: To use with the `auth` module, make sure to pass this backoff http client using the ``http_client`` parameter of the method used. .. note:: Currently known issues are: * will retry exponentially even when the error should raise instantly. Due to the Drive API that raises 403 (Forbidden) errors for forbidden access and for api rate limit exceeded._HTTP_ERROR_CODESr _NR_BACKOFF _MAX_BACKOFFargskwargsr'cdtdtttfdtdtffd } t |i|S#t$r}|j}|j}xjdz c_ tdjzj}||||dur5tj|j |i|}d _ |cYd}~S|d}~wwxYw) Ncodeerrorwaitr'cd|vr"|tjk(r|ddddk(ry|jvxs|tjk\xr|jkS)Nerrorsrr usageLimitsT)r FORBIDDENrINTERNAL_SERVER_ERRORr)rrrr+s r, _should_retryz0BackOffHTTPClient.request.._should_retry(ss 5 J000h*84 E...<:;;;,$+++ ,r.rTr)rrrrrsuperrBrrrrminrtimesleep) r+rrrerrrrrrD __class__s ` r,rBzBackOffHTTPClient.request&s , ,38$ , ,  ,2 7?D3F3 3 88DIIE    ! q$***D,=,=>DT5$/47 4 (4<<88$% I) s"> CB CCCC)rrrrrREQUEST_TIMEOUTTOO_MANY_REQUESTSrr__annotations__rrrrrrB __classcell__)rs@r,rrse*6 ""$$+tJ'KL#1S1C1H11r.r)2rrhttprtypingrrrrrr r r r r google.auth.credentialsrr2rrequestsrr exceptionsrrurlsrrrrrrrrrrrutilsr r!r"rrrrrrr$rHTTPClientTyperr.r,rs"    0<&9    <; C%S$tCy0P*Q!RR S  sBsG|$sE#r#w,//0sE#r#w"3445sE#r#w^CH5M"MNNO Q HHVS Slj!r.