K:g-8UddlmZddlmZmZmZmZmZmZm Z m Z m Z ddl Z ddl mZddlmZddlmZddlmZddlmZdd lmZmZdd lmZdd lmZmZdd lm Z dd l!m"Z"ddl#m$Z$m%Z%m&Z&m'Z'm(Z(e dZ)e e*e*fZ+ee,d<GddZ-y))cached_property) AnyDictIteratorListOptionalSequenceTupleTypeVarUnionN)Session) TypeAlias)retrying)Base Enterprise)options_to_json_and_paramsoptions_to_params)Table)UserAndScopesDictassert_typed_dict Workspace)Bases)Url UrlBuildercache_unless_forcedchunkedenterprise_onlyT TimeoutTupleceZdZUdZdZdZdZdZdZe e e dfe d<e e d <ee d <ee d <Gd d eZeeZdddddde de ede eeej.fd e d ef dZede fdZej6de ddfdZde fdZdefdZde defdZ dddde d ed!eddfd"Z!e"de#fd#Z$d$e#jJddfd%Z&dd&d!ede'dfd'Z(de d(e d)e)e e e*fddfd*Z+dddde d+e d ed!edd,f d-Z,d.e de fd/Z- dDd0e d1e d2e e.e e fd3e e e e*fd4e e e e*fd5e e e e*fde*fd6Z/d1e d7e*de*fd8Z0d1e d7e*de*fd9Z1d1e d7e*de*fd:Z2d1e d7e*de*fd;Z3de de7e*fd?Z8d@e)e9de7e)e9fdAZ:e;dBe de>> api = Api('auth_token') >>> table = api.table('base_id', 'table_name') >>> records = table.all() v0g? i>Nr_bases endpoint_urlsession use_field_idsc,eZdZedZedZy) Api._urlsz meta/whoamiz meta/basesN)__name__ __module__ __qualname__rwhoamibasesO/var/www/html/lionshead/venv/lib/python3.12/site-packages/pyairtable/api/api.py_urlsr+7s]#L!r2r4Tzhttps://api.airtable.comF)timeoutretry_strategyr'r)api_keyr5r6c|durtj}|st|_ntj||_t ||_||_||_||_ y)a Args: api_key: An Airtable API key or personal access token. timeout: A tuple indicating a connect and read timeout. e.g. ``timeout=(2,5)`` would configure a 2 second timeout for the connection to be established and 5 seconds for a server read timeout. Default is ``None`` (no timeout). retry_strategy: An instance of `urllib3.util.Retry `_. If ``None`` or ``False``, requests will not be retried. If ``True``, the default strategy will be applied (see :func:`~pyairtable.retry_strategy` for details). endpoint_url: The API endpoint to use. Override this if you are using a debugging or caching proxy. use_field_ids: If ``True``, all API requests will return responses with field IDs instead of field names. TN) rr6r r(_RetryingSessionrr'r5r7r))selfr7r5r6r'r)s r3__init__z Api.__init__=s[4 T !%446N"9DL#44^DDL -  *r2returnc|jS)zM Airtable API key or access token to use on all connections. )_api_keyr:s r3r7z Api.api_keycs }}r2valuec~|jjjddj|i||_y)N Authorizationz Bearer {})r(headersupdateformatr>)r:r@s r3r7z Api.api_keyjs1 ##_k6H6H6O$PQ r2cy)Nzr1r?s r3__repr__z Api.__repr__os!r2cn|jd|jj}tt|S)z Return the current user ID and (if connected via OAuth) the list of scopes. See `Get user ID & scopes `_ for more information. GET)requesturlsr/rr)r:datas r3r/z Api.whoamirs, ||E499#3#34 !2D99r2 workspace_idct||S)Nr)r:rMs r3 workspacez Api.workspacezs|,,r2validateforcebase_idrQrRc|r2|j|j|}|j|St||S)aL Return a new :class:`Base` instance that uses this instance of :class:`Api`. Args: base_id: |arg_base_id| validate: |kwarg_validate_metadata| force: |kwarg_force_metadata| Raises: KeyError: if ``validate=True`` and the given base ID does not exist. rR) _base_infobase_base_from_infor)r:rSrQrRinfos r3rWzApi.base}s@$ ???/44W=D''- -D'""r2c|jj}d|jd|Dcgc]}|dD]}|c}}i}tj||Scc}}w)zY Return a schema object that represents all bases available via the API. r0rI)rKr0iterate_requestsrfrom_api)r:urlpage base_inforLs r3rVzApi._base_infosl iioo  11%==D!%gI!.= ~~dD)) sAr_c\t||j|j|jS)N)namepermission_level)ridrarb)r:r_s r3rXzApi._base_from_infos)  LL&77   r2rUc~|j|jDcgc]}|j|c}Scc}w)aH Retrieve the base's schema and return a list of :class:`Base` instances. Args: force: |kwarg_force_metadata| Usage: >>> api.bases() [ , ] rU)rVr0rX)r:rRrYs r3r0z Api.basessB48???3O3U3U 3U4D  &3U   s:ratablescD|j|j||S)a Create a base in the given workspace. See https://airtable.com/developers/web/api/create-base Args: workspace_id: The ID of the workspace where the new base will live. name: The name to give to the new base. Does not need to be unique. tables: A list of ``dict`` objects that conform to Airtable's `Table model `__. )rO create_base)r:rMrares r3rgzApi.create_bases "~~l+77fEEr2 table_namercR|j|||}|j|||S)a# Build a new :class:`Table` instance that uses this instance of :class:`Api`. Args: base_id: |arg_base_id| table_name: The Airtable table's ID or name. validate: |kwarg_validate_metadata| force: |kwarg_force_metadata| rP)rWtable)r:rSrhrQrRrWs r3rjz Api.tables-"yy85yAzz*xuzEEr2 componentsc:|j|jz |zS)z Build a URL to the Airtable API endpoint with the given URL components, including the API version number. )r'VERSION)r:rks r3 build_urlz Api.build_urls   4<</:==r2methodr]fallbackoptionsparamsjsoncit|xsi|xsi}|jjtj||||}|rs|j dk(r`t t|j|jk\r5t|xsi\}} |j|d|di| |xsi|S|jj||||} |j| S)a Make a request to the Airtable API, optionally converting a GET to a POST if the URL exceeds the `maximum URL length `__. Args: method: HTTP method to use. url: The URL we're attempting to call. fallback: The method and URL to use if we have to convert a GET to a POST. options: Airtable-specific query params to use while fetching records. See :ref:`Parameters` for valid options. params: Additional query params to append to the URL as-is. json: The JSON payload for a POST/PUT/PATCH/DELETE request. )r]rrrsrIr)ror]rrrs) rr(prepare_requestrequestsRequestupperlenstrr]MAX_URL_LENGTHrrJ_process_response) r:ror]rprqrrrsrequest_paramsprepared spare_paramsresponses r3rJz Api.requests 2  2. |  <<//   %     %'C %&$*=*==!;GMr!J D,<<{QK9,96s t||Hc4V44r2rc: |j|jsy|j S#tjj$rN} |j }d|vr"g|j t |d|_|#t$rY|wxYwd}~wwxYw)Nerror) raise_for_statusrw exceptions HTTPErrorrsargsrepr ValueErrortext)r:rexc error_dicts r3r}zApi._process_responseEs   % % '}}}}"",,  F%]]_ j(EE4 70C+DECHI  I   s3/B B(B BBBBB offset_fieldc#K|xsi}|xsi}dtttfdttffd } |j |||||}|t |t sy||x} syi|| i}?w)a Make one or more requests and iterates through each result. If the response payload contains an 'offset' value, this method will perform another request with that offset value as a parameter (query params for GET, body payload for POST/PATCH/etc). If the response payload is not a 'dict', it will be yielded as normal and the method will return. Args: method: HTTP method to use. url: The URL we're attempting to call. fallback: The method and URL to use if we have to convert a GET to a POST. options: Airtable-specific query params to use while fetching records. See :ref:`Parameters` for valid options. params: Additional query params to append to the URL as-is. offset_field: The key to use in the API response to determine whether there are additional pages to retrieve. rr<c|jdxs|}jd}|r&|j|jdx}sy|r&t|S)N pagination.r)rsplitpopr{)rr@ field_namesrs r3_get_offset_fieldz/Api.iterate_requests.._get_offset_fieldxsZLL.:(E&,,S1K!&;??1+=!>>>u: r2)ror]rprqrrN)rr{rrrJ isinstancedict) r:ror]rprqrrrrroffsets ` r3r[zApi.iterate_requestsXs:-R2 S#X 8C= ||! $HNh-/99F977,7GsA3A6iterablec.t||jS)z Iterate through chunks of the given sequence that are equal in size to the maximum number of records per request allowed by the API. )rMAX_RECORDS_PER_REQUEST)r:rs r3rz Api.chunkeds x!=!=>>r2enterprise_account_idct||S)zE Build an object representing an enterprise account. r)r:rs r3 enterprisezApi.enterprises $ 566r2)NNNN)NNNr)>r,r-r.__doc__rm API_LIMITrr|r&rrr{__annotations__rr boolrr4rrKr!r rRetryr;propertyr7setterrGrr/rrOrWrrrVInforXrr0r rrgrjrnr rJrrrrrwResponser}rr[r rrrrr1r2r3r#r#sGI!N+/FHT#v+& '. " " 5 !D +/@D6#$+$+,' $+ !tX^^';!<= $+  $+$+L  ^^ST"#":):-c-i- ## #  #  #. *E * *   &+ d tF| $FFFc3h( F  F0 FFF  F  F F(>S>S>/3,0+/)-<0<0<05c?+ <0 $sCx.) <0 c3h( <0tCH~&<0 <0|2s2c2c233s3s344445#555(*;*;./3,0+/$5858585c?+ 58 $sCx.) 58 c3h( 5858 #58n? ?!0E?77 77r2r#). functoolsrtypingrrrrrr r r r rwrequests.sessionsr typing_extensionsrpyairtable.apirpyairtable.api.baserpyairtable.api.enterpriserpyairtable.api.paramsrrpyairtable.api.tablerpyairtable.api.typesrrpyairtable.api.workspacerpyairtable.models.schemarpyairtable.utilsrrrrrr intr!rr#r1r2r3rse%WWW%'#$0O&E.* CLS/ i)77r2