U Zf݁@sdddgZdZddlZddlZddlZddlZddlZddlZddlZddl Z ddl m Z m Z ddl m Z mZddlmZdd lmZmZmZdd lmZdd lmZdd lmZmZmZmZmZmZm Z dd l!m"Z"m#Z#m$Z$m%Z%m&Z&m'Z'm(Z(m)Z)ddl*m+Z+dZ,dZ-dZ.dZ/dZ0dZ1dZ2dZ3dZ4Gddde5Z6Gddde5Z7d$ddZ8Gddde5Z9Gd dde9eZ:Gd!dde9eZ;Gd"d#d#e<Z=dS)%Dropbox DropboxTeamcreate_sessionz12.0.2N)datetime timedelta)AuthError_validatorRateLimitError_validator)files)PathRootPathRoot_validatorPathRootError_validator) DropboxBase)DropboxTeamBase)ApiError AuthError BadInputError HttpError PathRootErrorInternalServerErrorRateLimitError)API_HOSTAPI_CONTENT_HOSTAPI_NOTIFICATION_HOSTHOST_API HOST_CONTENT HOST_NOTIFYpinned_sessionDEFAULT_TIMEOUT)stone_serializerszDropbox-API-Path-Rootii,zDropbox-API-Select-AdminzDropbox-API-Select-UseruserZteamZappZnoauthc@seZdZdZdddZdS) RouteResultz+The successful result of a call to a route.NcCsRt|tjstdt||dk rBt|tjjsBtdt|||_||_ dS)a3 :param str obj_result: The result of a route not including the binary payload portion, if one exists. Must be serialized JSON. :param requests.models.Response http_resp: A raw HTTP response. It will be used to stream the binary-body payload of the response. z#obj_result: expected string, got %rNz4http_resp: expected requests.models.Response, got %r) isinstancesix string_typesAssertionErrortyperequestsmodelsResponse obj_result http_resp)selfr)r*r,:/tmp/pip-unpacked-wheel-qnjxxdf1/dropbox/dropbox_client.py__init__Gs zRouteResult.__init__)N__name__ __module__ __qualname____doc__r.r,r,r,r-r Dsr c@seZdZdZddZdS)RouteErrorResultz&The error result of a call to a route.cCs||_||_dS)a :param str request_id: A request_id can be shared with Dropbox Support to pinpoint the exact request that returns an error. :param str obj_result: The result of a route not including the binary payload portion, if one exists. N) request_idr))r+r5r)r,r,r-r.ZszRouteErrorResult.__init__Nr/r,r,r,r-r4Wsr4cCst||d}|r||_|S)ae Creates a session object that can be used by multiple :class:`Dropbox` and :class:`DropboxTeam` instances. This lets you share a connection pool amongst them, as well as proxy parameters. :param int max_connections: Maximum connection pool size. :param dict proxies: See the `requests module `_ for more details. :rtype: :class:`requests.sessions.Session`. `See the requests module `_ for more details. ) pool_maxsizeca_certs)rproxies)Zmax_connectionsr9r8sessionr,r,r-rds c @seZdZdZdZdZdZdZddddddeddddddf dd Z d'd d Z d(d d Z ddZ e dfddZd)ddZd*ddZd+ddZddZddZd,ddZdd Zd!d"Zd#d$Zd%d&ZdS)-_DropboxTransportzd Responsible for implementing the wire protocol for making requests to the Dropbox API. 2downloaduploadrpcNcCs.|s|s| r| std|dk r8t|ts8td||rH| sHtd| dk rnt| dksft| tsntd||_||_| |_| |_ | |_ | |_ ||_ ||_ |rt|tjjstd|||_n t| d|_||_d t}|r||_d |||_n d|_||_td |_tttttti|_ ||_!dS) a :param str oauth2_access_token: OAuth2 access token for making client requests. :param int max_retries_on_error: On 5xx errors, the number of times to retry. :param Optional[int] max_retries_on_rate_limit: On 429 errors, the number of times to retry. If `None`, always retries. :param str user_agent: The user agent to use when making requests. This helps us identify requests coming from your application. We recommend you use the format "AppName/Version". If set, we append "/OfficialDropboxPythonSDKv2/__version__" to the user_agent, :param session: If not provided, a new session (connection pool) is created. To share a session across multiple clients, use :func:`create_session`. :type session: :class:`requests.sessions.Session` :param dict headers: Additional headers to add to requests. :param Optional[float] timeout: Maximum duration in seconds that client will wait for any single packet from the server. After the timeout the client will give up on connection. If `None`, client will wait forever. Defaults to 100 seconds. :param str oauth2_refresh_token: OAuth2 refresh token for refreshing access token :param datetime oauth2_access_token_expiration: Expiration for oauth2_access_token :param str app_key: application key of requesting application; used for token refresh :param str app_secret: application secret of requesting application; used for token refresh Not required if PKCE was used to authorize the token :param list scope: list of scopes to request on refresh. If left blank, refresh will request all available scopes for application :param str ca_certs: a path to a file of concatenated CA certificates in PEM format. Has the same meaning as when using :func:`ssl.wrap_socket`. zBOAuth2 access token or refresh token or app key/secret must be setNzExpected dict, got {}z%app_key is required to refresh tokensrScope list must be of type listz*Expected requests.sessions.Session, got {})r8zOfficialDropboxPythonSDKv2/z{}/{}dropbox)"BadInputExceptionr!dictformatlenlist_oauth2_access_token_oauth2_refresh_token_oauth2_access_token_expiration_app_key _app_secret_scope_max_retries_on_error_max_retries_on_rate_limitr&sessionsSession_sessionr_headers __version___raw_user_agent _user_agentlogging getLogger_loggerrrrrrr _host_map_timeout)r+oauth2_access_tokenmax_retries_on_errormax_retries_on_rate_limit user_agentr:headerstimeoutoauth2_refresh_tokenoauth2_access_token_expirationapp_key app_secretscoper8Zbase_user_agentr,r,r-r.sP.  z_DropboxTransport.__init__c Csh||p |j|p|j|p|j|p$|j|p,|j|p4|j|p<|j|pD|j| pL|j | pT|j | p\|j | pd|j S)a Creates a new copy of the Dropbox client with the same defaults unless modified by arguments to clone() See constructor for original parameter descriptions. :return: New instance of Dropbox client :rtype: Dropbox ) __class__rHrNrOrVrRrSr[rIrJrKrLrM) r+r\r]r^r_r:r`rarbrcrdrerfr,r,r-clonesz_DropboxTransport.clonec CsV||jdpd}|jd}|d|j}|jdkrH|d|j7}|jdpTd} t|j|} |d kr|tj kr|j d }|j ||| | |||d } t | j} t| tr|j} | }nPt| tr|j} | d }| d }|o|d}|o|d}ntdt| tj| |dd}t| tr8t| j|||n| |jkrN|| jfS|Sd S)a Makes a request to the Dropbox API and in the process validates that the route argument and result are the expected data types. The request_arg is converted to JSON based on the arg_data_type. Likewise, the response is deserialized from JSON and converted to an object based on the {result,error}_data_type. :param host: The Dropbox API host to connect to. :param route: The route to make the request to. :type route: :class:`stone.backends.python_rsrc.stone_base.Route` :param request_arg: Argument for the route that conforms to the validator specified by route.arg_type. :param request_binary: String or file pointer representing the binary payload. Use None if there is no binary payload. :param Optional[float] timeout: Maximum duration in seconds that client will wait for any single packet from the server. After the timeout the client will give up on connection. If `None`, will use default timeout set on Dropbox object. Defaults to `None`. :return: The route's result. hostapiauth/z_v{}styler?NZraerror user_messagetextlocalez7Expected RouteResult or RouteErrorResult, but res is %sF)strict)check_and_refresh_access_tokenattrsnameversionrEr json_encodeZarg_typer Zlist_folder_longpollrarequest_json_string_with_retryjsonloadsr)r!r Z result_typer4Z error_typegetr$r%json_compat_obj_decoderr5_ROUTE_STYLE_DOWNLOADr*)r+Zroute namespace request_argrequest_binaryrari auth_type route_name route_styleserialized_argresZdecoded_obj_resultZreturned_data_typeobjrrZuser_message_textZuser_message_localedeserialized_resultr,r,r-requestsb          z_DropboxTransport.requestcCsX|jo |j}|jo0|j p0tttd|jk}|j }|sB|rT|rT|j|j ddS)zi Checks if access token needs to be refreshed and refreshes if possible :return: seconds)rfN) rIrKrJrutcnowrTOKEN_EXPIRATION_BUFFERrHrefresh_access_tokenrM)r+Z can_refreshZ needs_refreshZ needs_tokenr,r,r-rvhs  z0_DropboxTransport.check_and_refresh_access_tokencCs|dk r&t|dkst|ts&td|jr2|jsB|jddS|jdd |}d|j|jd}|j rx|j |d <|rd |}||d <t }|j r|j }|jj|||d }|||}|d |_ttt|dd|_dS)z Refreshes an access token via refresh token if available :param host: host to hit token endpoint with :param scope: list of permission scopes for access token :return: NrrAzPUnable to refresh access token without refresh token and app keyzRefreshing access token.zhttps://{}/oauth2/token refresh_token)Z grant_typerZ client_idZ client_secret rf)dataraZ access_tokenZ expires_inr)rFr!rGrCrIrKrYwarninginforErLjoinrr[rRpostraise_dropbox_error_for_respr|rHrrrintrJ)r+rirfurlbodyrarZ token_contentr,r,r-rvs4        z&_DropboxTransport.refresh_access_tokenc CsTt|}|j|||||||d} t| j} t| trL| jdk rL| | jfS| SdS)a Makes a request to the Dropbox API, taking a JSON-serializable Python object as an argument, and returning one as a response. :param host: The Dropbox API host to connect to. :param route_name: The name of the route to invoke. :param route_style: The style of the route. :param str request_arg: A JSON-serializable Python object representing the argument for the route. :param auth_type str :param Optional[bytes] request_binary: Bytes representing the binary payload. Use None if there is no binary payload. :param Optional[float] timeout: Maximum duration in seconds that client will wait for any single packet from the server. After the timeout the client will give up on connection. If `None`, will use default timeout set on Dropbox object. Defaults to `None`. :return: The route's result as a JSON-serializable Python object. rpN)r|dumpsr{r}r)r!r r*) r+rirrrrrrarrrr,r,r-request_json_objects   z%_DropboxTransport.request_json_objectc Csld}d} d} |jd|z|j|||||||dWStk r} z<| jr|| jr|| r^q~|jd| j|d} nW5d} ~ XYq tk r} zF|d7}||j krd |t } |jd | j| t | nW5d} ~ XYq t k rd} zV| d7} |jdks"|j| krR| jdk r4| jnd } |jd | t | nW5d} ~ XYq Xq dS) z See :meth:`request_json_object` for description of parameters. :param request_json_arg: A string representing the serialized JSON argument to the route. rFz Request to %srpz:ExpiredCredentials status_code=%s: Refreshing and RetryingTNrmz2HttpError status_code=%s: Retrying in %.1f secondsg@z$Ratelimit: Retrying in %.1f seconds.)rYrrequest_json_stringrrqZis_expired_access_token status_coderrrNrandomtimesleeprrObackoff) r+rirrrequest_json_argrrraattemptZrate_limit_errorsZ has_refreshederr,r,r-r{s^    z0_DropboxTransport.request_json_string_with_retrycCs^||jkrtd|t|tjtdfs:tdt||j|}|||} d|ji} | dd d} t | ks|t | kr|j rd|j | d <|jr| |jnt| kr|jdks|jdkrtd td |j|jd } d | d | d <|jr*| |jn|tkrntd|d} d}||jkrLd| d<|} nH||jkrf|| d<d}n.||jkrd| d<|| d<|} n td||dkr|j}|jj| | | ||d}| ||j!"d}|j#dkr|j$d }t%||S||jkr |j!d}n2|j!"ddks0t&d|j!"d|j$d }||jkrRt'||St'|SdS)zc See :meth:`request_json_string_with_retry` for description of parameters. zUnknown value for host: %rNz.expected request_binary as binary type, got %sz User-Agentr,z Bearer %s AuthorizationzAClient id and client secret are required for routes with app authz{}:{}zutf-8zBasic {}zUnhandled auth type: {}Fapplication/jsonz Content-TypezDropbox-API-ArgTzapplication/octet-streamzUnknown operation style: %r)r`rstreamrax-dropbox-request-idiiizdropbox-api-result content-type4Expected content-type to be application/json, got %r)(rZ ValueErrorr!r" binary_typer% TypeError_get_route_urlrVreplacesplit USER_AUTH TEAM_AUTHrHrSupdateAPP_AUTHrKrLrCbase64 b64encoderEencodedecodeNO_AUTH_ROUTE_STYLE_RPCr_ROUTE_STYLE_UPLOADr[rRrrr`r~rcontentr4r$r )r+ri func_namerrrrraZ fq_hostnamerr`Z auth_types auth_headerrrrr5Zraw_respr,r,r-rs                       z%_DropboxTransport.request_json_stringcCs|jd}|jdkr*t||j|jn|jdkrzD|ddkrj|jd}ttd}t ||n t ||jWn t k rt ||jYnXn&|jdkr|jdd kst d |jdtt|d}t ||n|jt krtt|d}t||n|jd krd }|jdd krVtt|d}|j}n$|jd }|d k rvt|}nd }t|||n<|jdkrd Sd|jkrdksnt||j|jd S)zpChecks for errors from a res and handles appropiately. :param res: Response of an api request. riirqZ invalid_grantZinvalid_access_tokenirrriNz retry-afterri+)r`r~rrrsr|rrrrrrr$HTTP_STATUS_INVALID_PATH_ROOTr rr retry_afterrrr)r+rr5errrZretry_after_strr,r,r-resb                  z._DropboxTransport.raise_dropbox_error_for_respcCsdj|tj|dS)zReturns the URL of the route. :param str hostname: Hostname to make the request to. :param str route_name: Name of the route. :rtype: str z)https://{hostname}/{version}/{route_name})hostnameryr)rEr _API_VERSION)r+rrr,r,r-rs z _DropboxTransport._get_route_urlc CsJt|d6}t| ||D]}||q"W5QRXW5QRXdS)a Saves the body of an HTTP response to a file. :param str download_path: Local path to save data to. :param http_resp: The HTTP response whose body will be saved. :type http_resp: :class:`requests.models.Response` :rtype: None wbN)open contextlibclosing iter_contentwrite)r+ download_pathr* chunksizefcr,r,r-_save_body_to_files  z$_DropboxTransport._save_body_to_filecCsBt|tstd|jr"|jni}tt||t<|j |dS)a Creates a clone of the Dropbox instance with the Dropbox-API-Path-Root header as the appropriate serialized instance of PathRoot. For more information, see https://www.dropbox.com/developers/reference/namespace-guide#pathrootmodes :param PathRoot path_root: instance of PathRoot to serialize into the headers field :return: A :class: `Dropbox` :rtype: Dropbox z)path_root must be an instance of PathRoot)r`) r!r rrScopyrrzr PATH_ROOT_HEADERrh)r+Z path_root new_headersr,r,r-with_path_roots z _DropboxTransport.with_path_rootcCs|jdS)zV Cleans up all resources like the request session/network connection. N)rRcloser+r,r,r-rsz_DropboxTransport.closecCs|SNr,rr,r,r- __enter__sz_DropboxTransport.__enter__cGs |dSr)r)r+argsr,r,r-__exit__sz_DropboxTransport.__exit__) NNNNNNNNNNNN)N)N)N)N)r)r0r1r2r3rrrrrr.rhrrvrrrr{rrrrrrrrr,r,r,r-r;xsb a , T. 2 E _1 r;c@seZdZdZdS)rz Use this class to make requests to the Dropbox API using a user's access token. Methods of this class are meant to act on the corresponding user's Dropbox. Nr0r1r2r3r,r,r,r-rsc@s(eZdZdZddZddZddZdS) rz Use this class to make requests to the Dropbox API using a team's access token. Methods of this class are meant to act on the team, but there is also an :meth:`as_user` method for assuming a team member's identity. cCs |t|S)a Allows a team credential to assume the identity of an administrator on the team and perform operations on any team-owned content. :param str team_member_id: team member id of administrator to perform actions with :return: A :class:`Dropbox` object that can be used to query on behalf of this admin of the team. :rtype: Dropbox )&_get_dropbox_client_with_select_headerSELECT_ADMIN_HEADERr+team_member_idr,r,r-as_admins zDropboxTeam.as_admincCs |t|S)aK Allows a team credential to assume the identity of a member of the team. :param str team_member_id: team member id of team member to perform actions with :return: A :class:`Dropbox` object that can be used to query on behalf of this member of the team. :rtype: Dropbox )rSELECT_USER_HEADERrr,r,r-as_users zDropboxTeam.as_usercCsR|jr|jni}|||<t|j|j|j|j|j|j|j |j ||j |j |j d S)ap Get Dropbox client with modified headers :param str select_header_name: Header name used to select users :param str team_member_id: team member id of team member to perform actions with :return: A :class:`Dropbox` object that can be used to query on behalf of a member or admin of the team :rtype: Dropbox ) r\rbrcr]r^rar_r:r`rdrerf)rSrrrHrIrJrNrOr[rUrRrKrLrM)r+Zselect_header_namerrr,r,r-rs z2DropboxTeam._get_dropbox_client_with_select_headerN)r0r1r2r3rrrr,r,r,r-rs  c@seZdZdZdS)rCz Thrown if incorrect types/values are used This should only ever be thrown during testing, app should have validation of input prior to reaching this point Nrr,r,r,r-rCsrC)r6NN)>__all__rTrrr|rWrrr&r"rrZ dropbox.authrrrBr Zdropbox.commonr r r Z dropbox.baser Zdropbox.base_teamrZdropbox.exceptionsrrrrrrrZdropbox.sessionrrrrrrrrZstone.backends.python_rsrcrrrrrrrrrrobjectr r4rr;rr ExceptionrCr,r,r,r-sR   $ (  a<