a |f7 @sdZddlZddlZddlmZddlmZmZmZm Z m Z m Z m Z m Z ddlmZzddlmZdZWney~dZYn0ddlmZddlmZddlmZdd lmZd d lmZd d lmZm Z d dgZ!ddgZ"dej#dkfe$e%edddZ&e&Z'e'dZ(e'dZ)e'dZ*edfee e eedddZ+Gddde Z,d7e e$efee$e-eddd Z.e)fee ed!d"d#Z/e)d$feee$dd%d&d'Z0e!e.e(e)efee$e,e e$efe e$efe ed(d)d*Z1dde!e.efe e e$efe e e$efee$e,e e eee$effd+d,d-Z2e*e!efe ee$fee$e ed.d/d0Z3e!efe e$efee$e ed1d2d3Z4efe$e ed4d5d6Z5dS)8z? gspread.auth ~~~~~~~~~~~~ Simple authentication with OAuth. N)Path)AnyDictIterableMappingOptionalProtocolTupleUnion) CredentialsTF)InstalledAppFlow)SessionClient) HTTPClientHTTPClientTypez,https://www.googleapis.com/auth/spreadsheetsz%https://www.googleapis.com/auth/drivez5https://www.googleapis.com/auth/spreadsheets.readonlyz.https://www.googleapis.com/auth/drive.readonlyZgspreadnt)config_dir_name os_is_windowsreturncCs(|rttjd|Sttd|SdS)zConstruct a config dir path. By default: * `%APPDATA%\gspread` on Windows * `~/.config/gspread` everywhere else APPDATAz.configN)rosenvironhome)rrrFD:\Projects\storyit_web\backend\venv\Lib\site-packages\gspread/auth.pyget_config_dir)s rzcredentials.jsonzauthorized_user.jsonzservice_account.json) credentials http_clientsessionrcCst|||dS)adLogin to Google API using OAuth2 credentials. This is a shortcut/helper function which instantiates a client using `http_client`. By default :class:`gspread.HTTPClient` is used (but could also use :class:`gspread.BackOffHTTPClient` to avoid rate limiting). It can take an additional `requests.Session` object in order to provide you own session object. .. note:: When providing your own `requests.Session` object, use the value `None` as `credentials`. :returns: An instance of the class produced by `http_client`. :rtype: :class:`gspread.client.Client` )authr rr)rrr rrr authorize@sr"c@s2eZdZdZdeeefeeee dddZ dS) FlowCallablez"Protocol for OAuth flow callables.r client_configscopesportrcCsdSNr)selfr%r&r'rrr__call__]szFlowCallable.__call__N)r) __name__ __module__ __qualname____doc__rstrrrintr r*rrrrr#Zs r#r$cCst||}|j|dS)aRun an OAuth flow using a local server strategy. Creates an OAuth flow and runs `google_auth_oauthlib.flow.InstalledAppFlow.run_local_server `_. This will start a local web server and open the authorization URL in the user's browser. Pass this function to ``flow`` parameter of :meth:`~gspread.oauth` to run a local server flow. )r')r Zfrom_client_configZrun_local_server)r%r&r'flowrrrlocal_server_flowbs r2)filenamercCs|rt|SdSr()existsOAuthCredentialsZfrom_authorized_user_filer3rrrload_credentialsrs r7token)credsr3striprcCsN|jjddd|d }|||Wdn1s@0YdS)NT)parentsexist_okw)parentmkdiropenwriteto_json)r9r3r:frrrstore_credentials{s rD)r&r1credentials_filenameauthorized_user_filenamerrcCsrt|}t|d}t|tsft|}t|}Wdn1sD0Y|||d}t||dt||dS)a9 Authenticate with OAuth Client ID. By default this function will use the local server strategy and open the authorization URL in the user's browser:: gc = gspread.oauth() Another option is to run a console strategy. This way, the user is instructed to open the authorization URL in their browser. Once the authorization is complete, the user must then copy & paste the authorization code into the application:: gc = gspread.oauth(flow=gspread.auth.console_flow) ``scopes`` parameter defaults to read/write scope available in ``gspread.auth.DEFAULT_SCOPES``. It's read/write for Sheets and Drive API:: DEFAULT_SCOPES =[ 'https://www.googleapis.com/auth/spreadsheets', 'https://www.googleapis.com/auth/drive' ] You can also use ``gspread.auth.READONLY_SCOPES`` for read only access. Obviously any method of ``gspread`` that updates a spreadsheet **will not work** in this case:: gc = gspread.oauth(scopes=gspread.auth.READONLY_SCOPES) sh = gc.open("A spreadsheet") sh.sheet1.update_acell('A1', '42') # <-- this will not work If you're storing your user credentials in a place other than the default, you may provide a path to that file like so:: gc = gspread.oauth( credentials_filename='/alternative/path/credentials.json', authorized_user_filename='/alternative/path/authorized_user.json', ) :param list scopes: The scopes used to obtain authorization. :param function flow: OAuth flow to use for authentication. Defaults to :meth:`~gspread.auth.local_server_flow` :param str credentials_filename: Filepath (including name) pointing to a credentials `.json` file. Defaults to DEFAULT_CREDENTIALS_FILENAME: * `%APPDATA%\gspread\credentials.json` on Windows * `~/.config/gspread/credentials.json` everywhere else :param str authorized_user_filename: Filepath (including name) pointing to an authorized user `.json` file. Defaults to DEFAULT_AUTHORIZED_USER_FILENAME: * `%APPDATA%\gspread\authorized_user.json` on Windows * `~/.config/gspread/authorized_user.json` everywhere else :type http_client: :class:`gspread.http_client.HTTPClient` :param http_client: A factory function that returns a client class. Defaults to :class:`gspread.http_client.HTTPClient` (but could also use :class:`gspread.http_client.BackOffHTTPClient` to avoid rate limiting) :rtype: :class:`gspread.client.Client` r6Nr%r&r!r) rr7 isinstancer r@jsonloadrDr)r&r1rErFrr9Z json_filer%rrroauthsG   (  rL)rauthorized_user_infor&r1rrcCsJd}|durt||}|s0|dur0|||d}t||d}||dfS)ai Authenticate with OAuth Client ID. By default this function will use the local server strategy and open the authorization URL in the user's browser:: gc = gspread.oauth_from_dict() Another option is to run a console strategy. This way, the user is instructed to open the authorization URL in their browser. Once the authorization is complete, the user must then copy & paste the authorization code into the application:: gc = gspread.oauth_from_dict(flow=gspread.auth.console_flow) ``scopes`` parameter defaults to read/write scope available in ``gspread.auth.DEFAULT_SCOPES``. It's read/write for Sheets and Drive API:: DEFAULT_SCOPES =[ 'https://www.googleapis.com/auth/spreadsheets', 'https://www.googleapis.com/auth/drive' ] You can also use ``gspread.auth.READONLY_SCOPES`` for read only access. Obviously any method of ``gspread`` that updates a spreadsheet **will not work** in this case:: gc = gspread.oauth_from_dict(scopes=gspread.auth.READONLY_SCOPES) sh = gc.open("A spreadsheet") sh.sheet1.update_acell('A1', '42') # <-- this will not work This function requires you to pass the credentials directly as a python dict. After the first authentication the function returns the authenticated user info, this can be passed again to authenticate the user without the need to run the flow again. .. code block below must be explicitly announced using code-block .. code-block:: python gc = gspread.oauth_from_dict( credentials=my_creds, authorized_user_info=my_auth_user ) :param dict credentials: The credentials from google cloud platform :param dict authorized_user_info: The authenticated user if already authenticated. :param list scopes: The scopes used to obtain authorization. :param function flow: OAuth flow to use for authentication. Defaults to :meth:`~gspread.auth.local_server_flow` :type http_client: :class:`gspread.http_client.HTTPClient` :param http_client: A factory function that returns a client class. Defaults to :class:`gspread.http_client.HTTPClient` (but could also use :class:`gspread.http_client.BackOffHTTPClient` to avoid rate limiting) :rtype: (:class:`gspread.client.Client`, str) NrGrHr8)r5Zfrom_authorized_user_inforrB)rrMr&r1rr9clientrrroauth_from_dictsE    rO)r3r&rrcCstj||d}t||dS)aAuthenticate using a service account. ``scopes`` parameter defaults to read/write scope available in ``gspread.auth.DEFAULT_SCOPES``. It's read/write for Sheets and Drive API:: DEFAULT_SCOPES =[ 'https://www.googleapis.com/auth/spreadsheets', 'https://www.googleapis.com/auth/drive' ] You can also use ``gspread.auth.READONLY_SCOPES`` for read only access. Obviously any method of ``gspread`` that updates a spreadsheet **will not work** in this case. :param str filename: The path to the service account json file. :param list scopes: The scopes used to obtain authorization. :type http_client: :class:`gspread.http_client.HTTPClient` :param http_client: A factory function that returns a client class. Defaults to :class:`gspread.HTTPClient` (but could also use :class:`gspread.BackOffHTTPClient` to avoid rate limiting) :rtype: :class:`gspread.client.Client` )r&rH) SACredentialsZfrom_service_account_filer)r3r&rr9rrrservice_account,srQ)infor&rrcCstj||d}t||dS)aAuthenticate using a service account (json). ``scopes`` parameter defaults to read/write scope available in ``gspread.auth.DEFAULT_SCOPES``. It's read/write for Sheets and Drive API:: DEFAULT_SCOPES =[ 'https://www.googleapis.com/auth/spreadsheets', 'https://www.googleapis.com/auth/drive' ] You can also use ``gspread.auth.READONLY_SCOPES`` for read only access. Obviously any method of ``gspread`` that updates a spreadsheet **will not work** in this case. :param info (Mapping[str, str]): The service account info in Google format :param list scopes: The scopes used to obtain authorization. :type http_client: :class:`gspread.http_client.HTTPClient` :param http_client: A factory function that returns a client class. Defaults to :class:`gspread.http_client.HTTPClient` (but could also use :class:`gspread.http_client.BackOffHTTPClient` to avoid rate limiting) :rtype: :class:`gspread.client.Client` )rRr&rH)rPZfrom_service_account_infor)rRr&rr9rrrservice_account_from_dictMs rS)r8rrcCs$tdurtdt|}t||dS)ahAuthenticate using an API key. Allows you to open public spreadsheet files. .. warning:: This method only allows you to open public spreadsheet files. It does not work for private spreadsheet files. :param token str: The actual API key to use :type http_client: :class:`gspread.http_client.HTTPClient` :param http_client: A factory function that returns a client class. Defaults to :class:`gspread.http_client.HTTPClient` (but could also use :class:`gspread.http_client.BackOffHTTPClient` to avoid rate limiting) :rtype: :class:`gspread.client.Client` Fzkapi_key is only available with package google.auth>=2.4.0.Install it with "pip install google-auth>=2.4.0".rH)GOOGLE_AUTH_API_KEY_AVAILABLENotImplementedErrorAPIKeyCredentialsr)r8rr9rrrapi_keyqs rW)r)6r.rJrpathlibrtypingrrrrrrr r Zgoogle.auth.credentialsr Zgoogle.auth.api_keyrVrT ImportErrorZgoogle.oauth2.credentialsr5Zgoogle.oauth2.service_accountrPZgoogle_auth_oauthlib.flowr requestsr rNrrrrZDEFAULT_SCOPESZREADONLY_SCOPESnamer/boolrZDEFAULT_CONFIG_DIRZDEFAULT_CREDENTIALS_FILENAMEZ DEFAULT_AUTHORIZED_USER_FILENAMEZ DEFAULT_SERVICE_ACCOUNT_FILENAMEr"r#r0r2r7rDrLrOrQrSrWrrrrs (                   T U  #  $