a |f}X@s~dZddlZddlmZddlmZmZmZmZm 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 d Z/Gddde/Z0e e/Z1dS)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 @seZdZdZdAeeeddddZddddZee e e e e ffdd d d Z dBe e eeeeeee efeeee e fed d dZe eee efedddZdCe e eeeee efedddZe e eeee efedddZe e edddZdDe eeeee efedddZdEe e eeedddZdFe ee eeed d!d"ZdGe eee efedd#d$ZdHe eeed%d&d'Ze e e ed(d)d*Z!dIe eeee efd%d+d,Z"e ed-d.d/Z#e$j%fe e ed0d1d2Z&dJe ee ee ee e'ee e'ed5d6d7Z(e ee)e e e e'ffd8d9d:Z*e e dd;dd?d@Z,dS)K 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. N)authsessionreturncCs0|dur||_nt||_t|j|_d|_dS)N)r$r r#rtimeout)selfr#r$r(MD:\Projects\storyit_web\backend\venv\Lib\site-packages\gspread/http_client.py__init__Ms   zHTTPClient.__init__)r%cCs<ddlm}|j||j|jjdd|jjidS)Nr)Request Authorizationz Bearer %s)google.auth.transport.requestsr+r#refreshr$headersupdatetoken)r'r+r(r(r)loginVs zHTTPClient.login)r&r%cCs ||_dS)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&r(r(r) set_timeout]s zHTTPClient.set_timeout)methodendpointparamsdatajsonfilesr/r%c Cs4|jj||||||||jd}|jr(|St|dS)N)r4urlr8r6r7r9r/r&)r$requestr&okr) r'r4r5r6r7r8r9r/responser(r(r)r;hs  zHTTPClient.request)idbodyr%cCs|jdt||d}|S)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 postr8)r;rr8)r'r>r?rr(r(r) batch_updates zHTTPClient.batch_update)r>ranger6r?r%cCs*t|t|f}|jd|||d}|S)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 putr6r8rr!r;r8r'r>rDr6r?r:rBr(r(r) values_updateszHTTPClient.values_updatecCs*t|t|f}|jd|||d}|S)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 r@rF)rr!r;r8rHr(r(r) values_appendszHTTPClient.values_append)r>rDr%cCs$t|t|f}|d|}|S)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 r@)rr!r;r8)r'r>rDr:rBr(r(r) values_clears  zHTTPClient.values_clear)r>r6r?r%cCs"t|}|jd|||d}|S)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 r@rF)rr;r8)r'r>r6r?r:rBr(r(r)values_batch_clears zHTTPClient.values_batch_clear)r>rDr6r%cCs(t|t|f}|jd||d}|S)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 getr6rG)r'r>rDr6r:rBr(r(r) values_gets zHTTPClient.values_get)r>rangesr6r%cCs4|dur i}||d<t|}|jd||d}|S)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 NrPrMrN)rr;r8)r'r>rPr6r:rBr(r(r)values_batch_gets zHTTPClient.values_batch_getcCs t|}|jd||d}|S)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 r@rA)rr;r8)r'r>r?r:rBr(r(r)values_batch_updates zHTTPClient.values_batch_update)r>r6r%cCs t|}|jd||d}|S)zA method stub that directly calls `spreadsheets.get `_.rMrNrr;r8r'r>r6r:rBr(r(r)spreadsheets_getszHTTPClient.spreadsheets_get)r>sheet_iddestination_spreadsheet_idr%cCs,t||f}d|i}|jd||d}|S)zLower-level method that directly calls `spreadsheets.sheets.copyTo `_.ZdestinationSpreadsheetIdr@rA)rr;r8)r'r>rVrWr:r?rBr(r(r)spreadsheets_sheets_copy_tos z&HTTPClient.spreadsheets_sheets_copy_tocCs0|durddi}t|}|jd||d}|S)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 NZincludeGridDatafalserMrNrSrTr(r(r)fetch_sheet_metadatas zHTTPClient.fetch_sheet_metadata)r>r%cCs2td|}dddd}|jd||d}|S)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)supportsAllDrivesZincludeItemsFromAllDrivesfieldsrMrN)rformatr;r8)r'r>r:r6resr(r(r)get_file_drive_metadata5sz"HTTPClient.get_file_drive_metadata)file_idr]r%cCs6|tvr tdt|}d|i}|jd||d}|jS)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 {}/{}/exportZmimeTyperMrN)rrr]rr;content)r'r`r]r:r6rBr(r(r)exportGs  zHTTPClient.exportTF)r` email_address perm_typerolenotify email_message with_linkr%c Cs~dt|}|||d} ddi} |dkr2|| d<n:|dvrT|| d<|| d<|| d <n|d kr^ntd ||jd || | d 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)typereZwithLinkr[truedomain>groupuserZ emailAddressZsendNotificationEmailZ emailMessageZanyonezInvalid permission type: {}r@)r8r6)r]r ValueErrorr;) r'r`rcrdrerfrgrhr:payloadr6r(r(r)insert_permissionis"2   zHTTPClient.insert_permission)r`r%cCsfdt|}ddd}d}g}|durb|r2||d<|jd||d }||d |d d}q|S) zpRetrieve a list of permissions for a file. :param str file_id: a spreadsheet ID (aka file ID). riTznextPageToken,permissions)r[r\NZ pageTokenrMrN permissionsZ nextPageToken)r]rr;r8extendrM)r'r`r:r6r1rsrBr(r(r)list_permissionss zHTTPClient.list_permissions)r` permission_idr%cCs*dt||}ddi}|jd||ddS)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/{}r[TdeleterNN)r]rr;)r'r`rvr:r6r(r(r)remove_permissions zHTTPClient.remove_permission)r`r7r%cCsLt|tr|d}ddi}dt|}|jd||dddd|d }|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{}/{}rEZmediaT)Z uploadTypeconvertr[)r7r6r/) isinstancestrencoder]rr;r8)r'r`r7r/r:r^r(r(r) import_csvs    zHTTPClient.import_csv)N)NNNNN)NN)NN)N)N)N)N)N)TNF)-__name__ __module__ __qualname____doc__r r rr*r2r floatr r3r{ ParamsTypebytesrrFileTyperrr;rCrIrJrKrLrOrrQrRrUintrXrZr_rZPDFrbboolrqrrurxr}r(r(r(r)r"9s $  "        ( I$ r"cs\eZdZUdZejejgZeee d<dZ e e d<dZ e e d<e e edfdd ZZS) BackOffHTTPClientafBackoffClient is a gspread 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 Client is not production ready yet. Use it at your own risk ! .. note:: To use with the `auth` module, make sure to pass this backoff client factory using the ``client_factory`` 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_BACKOFF)argskwargsr%c sttttfttdfdd }ztj|i|WSty}z||j}|j }j d7_ t dj j }||||durt |j|i|}d_ |WYd}~S|WYd}~n d}~00dS)N)codeerrorwaitr%csHd|vr*|tjkr*|ddddkr*dS|jvs>|tjkoF|jkS)NerrorsrrlZ usageLimitsT)r FORBIDDENrINTERNAL_SERVER_ERRORr)rrrr'r(r) _should_retry(s z0BackOffHTTPClient.request.._should_retryrTr)rrr{rrsuperr;rrrrminrtimesleep) r'rrrerrrrrr= __class__rr)r;&s$  zBackOffHTTPClient.request)r~rrrrREQUEST_TIMEOUTTOO_MANY_REQUESTSrr__annotations__rrrrrr; __classcell__r(r(rr)rs   r)2rrhttprtypingrrrrrrr r r r Zgoogle.auth.credentialsr r-rrequestsrr exceptionsrrurlsrrrrrrrrrrrutilsrr r!r{rrrrrr"rZHTTPClientTyper(r(r(r)s2  0  4 "" NV