K:gp ddlZddlZddlZddlZddlZddlmZddlm Z ddl m Z m Z m Z mZmZmZmZmZmZddlZddlmZmZmZmZmZmZmZmZmZm Z ddl!m"Z"m#Z#ddl$m%Z%m&Z&m'Z'ddl(m)Z)m*Z*m+Z+e rdd l,m-Z-m.Z.dd l/m0Z0dd l1m2Z2Gd d Z3y)N)cached_property)Path) TYPE_CHECKINGAnyDictIterableIteratorListOptionalUnionoverload) FieldNameRecordDeletedDict RecordDictRecordIdUpdateRecordDictUploadAttachmentResultDictUpsertResultDictWritableFieldsassert_typed_dictassert_typed_dicts)Formulato_formula_str) FieldSchema TableSchemaparse_field_schema)Url UrlBuilder is_table_id)Api TimeoutTuple)Base)RetryceZdZUdZded<eed<dZeeed<Gdde Z e e Z e ddd d d ed ed ededdeddef dZe d dd dd efdZe d dd dd efdZd edefd edefd eeefdefdZdefdZedefdZedBdedefdZedCdZdededefd Zdedeeefd!Zdedeefd"Zdedeefd#Z dDd%ed&ed'eedefd(Z dDd)e!ed&ed'eedeefd*Z" dEded%ed+ed&ed'eedef d,Z# dEd)e!e$d+ed&ed'eedeef d-Z% dEd)e!e&eefd.ee'd+ed&ed'eede(f d/Z)dede*fd0Z+d1e!edee*fd2Z,deded3fd4Z-ded5edd3fd6Z.d$d7d8edefd9Z/ dFded:ed;eedee&eefde0f d<Z1 dFded=ed>eee2fd?eeee3fd@eede4f dAZ5y)GTablez Represents an Airtable table. Usage: >>> api = Api(access_token) >>> table = api.table("base_id", "table_name") >>> records = table.all() r"basenameN_schemacjeZdZedZedz ZedZdedefdZdedefdZ dede defd Z y ) Table._urlsz{base.id}/{self.id_or_name} listRecordsz4meta/bases/{base.id}/tables/{self.id_or_name}/fields record_idreturnc |j|z S)zA URL for a specific record in the table. )recordsselfr,s Q/var/www/html/lionshead/venv/lib/python3.12/site-packages/pyairtable/api/table.pyrecordzTable._urls.recordGs<<)+ +c*|j|dz S)zM URL for comments on a specific record in the table. comments)r3r0s r2record_commentszTable._urls.record_commentsMs;;y)J6 6r4fieldcV|jd|d|d}|jdS)zc URL for uploading an attachment to a specific field in a specific record. z {base.id}//z/uploadAttachmentzcontent.airtable.com)netloc) build_url replace_url)r1r,r8urls r2upload_attachmentzTable._urls.upload_attachmentSs4..< {!E7BS!TUC??*@?A Ar4N) __name__ __module__ __qualname__rr/ records_postfieldsrr3r7strr?r4r2_urlsr*>sh34. KL ,H , ,  7X 7# 7  Bx B B Br4rGzhttps://api.airtable.com)timeoutretry_strategy endpoint_urlapi_keybase_id table_namerHr!rIr#rJcyNrF)r1rKrLrMrHrIrJs r2__init__zTable.__init__\s r4cyrOrFr1rKrLrMs r2rPzTable.__init__h  r4cyrOrFrRs r2rPzTable.__init__prSr4kwargsc t|trmt|tr]tjdtdt j j j|fi|}|j||_nj|8t|x}t j jjr||_n0tdt|dt|dt|dt|tr||_ yt|x}tr||_|j|_ ytdt|dt|dt|d)a Old style constructor takes ``str`` arguments, and will create its own instance of :class:`Api`. This constructor can also be provided with keyword arguments to the :class:`Api` class. This approach is deprecated, and will likely be removed in the future. >>> Table("api_key", "base_id", "table_name", timeout=(1, 1)) New style constructor has an odd signature to preserve backwards-compatibility with the old style (above), requiring ``None`` as the first argument, followed by an instance of :class:`Base`, followed by the table name. >>> Table(None, base, "table_name") These signatures may change in the future. Developers using this library are encouraged to not construct Table instances directly, and instead fetch tables via :meth:`Api.table() `. zPassing API keys or base IDs to pyairtable.Table is deprecated; use Api.table() or Base.table() instead. See https://pyairtable.rtfd.org/en/latest/migrations.html for details.)category stacklevelNz6Table() expects (None, Base, str | TableSchema); got (z, )) isinstancerEwarningswarnDeprecationWarning pyairtableapir r&r" TypeErrortyper'rr()r1rKrLrMrUr`r&schemas r2rPzTable.__init__xs14 gs # 7C(@ MMZ,  ..$$((;F;C)DI _GODZ^^=P=P=U=U!VDIgr$w-4 ;K:LAO  j# &"DI *,k :!DL DIgr$w-4 ;K:LAO r4r-c|jrHd|jjd|jjd|jjdSd|jjd|jdS)Nz )r(r&idr'r1s r2__repr__zTable.__repr__sd <<!$)),,!1dlloo5Ht||O`O`Nccde ediill-VDII=BBr4cxt|jr |jS|jjS)aP Get the table's Airtable ID. If the instance was created with a name rather than an ID, this property will perform an API request to retrieve the base's schema. For example: .. code-block:: python # This will not create any network traffic >>> table = base.table('tbl00000000000123') >>> table.id 'tbl00000000000123' # This will fetch schema for the base when `table.id` is called >>> table = base.table('Table Name') >>> table.id 'tbl00000000000123' )rr'rcrfrgs r2rfzTable.ids,( tyy !99 {{}r4quotedc|jr|jjn |j}|s|}|Stjj |d}|S)a Return the table ID if it is known, otherwise the table name used for the constructor. This is the URL component used to identify the table in Airtable's API. Args: quoted: Whether to return a URL-encoded value. Usage: >>> table = base.table("Apartments") >>> table.id_or_name 'Apartments' >>> table.schema() >>> table.id_or_name 'tblXXXXXXXXXXXXXX' )safe)r(rfr'urllibparsequote)r1rjvalues r2 id_or_namezTable.id_or_namesI$$(<< TYY# *0););E);)K r4c.|jjS)zS The API connection used by the table's :class:`~pyairtable.Base`. )r&r`rgs r2r`z Table.apis yy}}r4r,optionsc |jjr&|jd|jj|jj|jj ||}t t|S)a Retrieve a record by its ID. >>> table.get('recwPQIfs4wKPyc9D') {'id': 'recwPQIfs4wKPyc9D', 'fields': {'First Name': 'John', 'Age': 21}} Args: record_id: |arg_record_id| Keyword Args: cell_format: |kwarg_cell_format| time_zone: |kwarg_time_zone| user_locale: |kwarg_user_locale| use_field_ids: |kwarg_use_field_ids| use_field_ids)rt)r`rv setdefaultgeturlsr3rr)r1r,rtr3s r2rxz Table.gets] 88 ! !   0F0F Gdii..y97K V44r4c+Kt|jdx}trt||d<|jj r&|j d|jj |jjd|jjd|jjf|D]$}tt|jdg&yw)a Iterate through each page of results from `List records `_. To get all records at once, use :meth:`all`. >>> it = table.iterate() >>> next(it) [{"id": ...}, {"id": ...}, {"id": ...}, ...] >>> next(it) [{"id": ...}, {"id": ...}, {"id": ...}, ...] >>> next(it) [{"id": ...}] >>> next(it) Traceback (most recent call last): StopIteration Keyword Args: view: |kwarg_view| page_size: |kwarg_page_size| max_records: |kwarg_max_records| fields: |kwarg_fields| sort: |kwarg_sort| formula: |kwarg_formula| cell_format: |kwarg_cell_format| user_locale: |kwarg_user_locale| time_zone: |kwarg_time_zone| use_field_ids: |kwarg_use_field_ids| formularvrxpost)methodr>fallbackrtr/N) r[rxrrr`rvrwiterate_requestsryr/rCrr)r1rtr{pages r2iteratez Table.iterates8 Y!77g A!/!8GI  88 ! !   0F0F GHH-- !!dii445 . D %Z)R1HI I  sCCc `|jdi|Dcgc] }|D]}| c}}Scc}}w)a Retrieve all matching records in a single list. >>> table = api.table('base_id', 'table_name') >>> table.all(view='MyView', fields=['ColA', '-ColB']) [{'fields': ...}, ...] >>> table.all(max_records=50) [{'fields': ...}, ...] Keyword Args: view: |kwarg_view| page_size: |kwarg_page_size| max_records: |kwarg_max_records| fields: |kwarg_fields| sort: |kwarg_sort| formula: |kwarg_formula| cell_format: |kwarg_cell_format| user_locale: |kwarg_user_locale| time_zone: |kwarg_time_zone| use_field_ids: |kwarg_use_field_ids| rF)rr1rtrr3s r2allz Table.all&s4,$04<<#:'#:N#:4v#:NNNs*c |jtdd|jdi|D]}|D]}|ccSy)a9 Retrieve the first matching record. Returns ``None`` if no records are returned. This is similar to :meth:`~pyairtable.Table.all`, except it sets ``page_size`` and ``max_records`` to ``1``. Keyword Args: view: |kwarg_view| fields: |kwarg_fields| sort: |kwarg_sort| formula: |kwarg_formula| cell_format: |kwarg_cell_format| user_locale: |kwarg_user_locale| time_zone: |kwarg_time_zone| use_field_ids: |kwarg_use_field_ids| ) page_size max_recordsNrF)updatedictrrs r2firstz Table.first>sC$ taQ78 DLL+7+D ,r4FrDtypecastrvc||jj}|jj|jj|||d}t t |S)aa Create a new record >>> record = {'Name': 'John'} >>> table = api.table('base_id', 'table_name') >>> table.create(record) Args: fields: Fields to insert. Must be a dict with field names or IDs as keys. typecast: |kwarg_typecast| use_field_ids: |kwarg_use_field_ids| rDrreturnFieldsByFieldIdr>json)r`rvr|ryr/rr)r1rDrrvcreateds r2createz Table.createVsZ$   HH22M((-- !! $)6  !W55r4r/cRg}||jj}t|}|jj|D]^}|Dcgc]}d|i}}|jj |j j |||d}|tt|dz }`|Scc}w)a Create a number of new records in batches. >>> table.batch_create([{'Name': 'John'}, {'Name': 'Marc'}]) [ { 'id': 'recW9e0c9w0er9gug', 'createdTime': '2017-03-14T22:04:31.000Z', 'fields': {'Name': 'John'} }, { 'id': 'recW9e0c9w0er9guh', 'createdTime': '2017-03-14T22:04:31.000Z', 'fields': {'Name': 'Marc'} } ] Args: records: Iterable of dicts representing records to be created. typecast: |kwarg_typecast| use_field_ids: |kwarg_use_field_ids| rDr/rrrr/) r`rvlistchunkedr|ryr/rr) r1r/rrvinserted_recordschunkrD new_recordsresponses r2 batch_createzTable.batch_createts8   HH22Mw-XX%%g.E>> table.update('recwPQIfs4wKPyc9D', {"Age": 21}) {'id': 'recwPQIfs4wKPyc9D', 'fields': {'First Name': 'John', 'Age': 21}} >>> table.update('recwPQIfs4wKPyc9D', {"Age": 22}, replace=True) {'id': 'recwPQIfs4wKPyc9D', 'fields': {'Age': 22}} Args: record_id: |arg_record_id| fields: Fields to update. Must be a dict with column names or IDs as keys. replace: |kwarg_replace| typecast: |kwarg_typecast| use_field_ids: |kwarg_use_field_ids| putpatchrr}r>r)r`rvrequestryr3rr)r1r,rDrrrvr}updateds r2rz Table.updatesm.   HH22M!w((""   + $)6# !W55r4c ng}|rdnd}||jj}t|}|jj|D]f}|Dcgc] }|d|dd} }|jj ||j j | ||d} |tt| dz }h|Scc}w) a# Update several records in batches. Args: records: Records to update. replace: |kwarg_replace| typecast: |kwarg_typecast| use_field_ids: |kwarg_use_field_ids| Returns: The list of updated records. rrrfrDrfrDrrr/) r`rvrrrryr/rr) r1r/rrrvupdated_recordsr}rx chunk_recordsrs r2 batch_updatezTable.batch_updates&!w   HH22Mw-XX%%g.EMRSUAdGq{CUMSxx''II%%, (-:(H 1*hy>QR RO/TsB2 key_fieldsc ||jj}t|}|D]R}d|vrt|t|j dgz }|s2t d|d|dj |rdnd}gggd} |jj|D]} | D cgc]+}|jD cic] \} } | dvs | | c} } -} } }} |jj||jj| ||d |id  }| d j|d | d j|d | djtt|d| Scc} } wcc} } }w)a_ Update or create records in batches, either using ``id`` (if given) or using a set of fields (``key_fields``) to look for matches. For more information on how this operation behaves, see Airtable's API documentation for `Update multiple records `__. .. versionadded:: 1.5.0 Args: records: Records to update. key_fields: List of field names that Airtable should use to match records in the input with existing records on the server. replace: |kwarg_replace| typecast: |kwarg_typecast| use_field_ids: |kwarg_use_field_ids| Returns: Lists of created/updated record IDs, along with the list of all records affected. rfrDzmissing z in rr)updatedRecordscreatedRecordsr/rfieldsToMergeOn)r/rr performUpsertrrrr/)r`rvrsetrx ValueErrorkeysritemsrryr/extendrr)r1r/rrrrvr3missingr}resultrkvformatted_recordsrs r2 batch_upsertzTable.batch_upserts4   HH22Mw- Fv~*oFJJx,D(EEG 8G;d6(;K;P;P;R:U!VWW "w  $  XX%%g.E$!#F%+LLNLN&1aa;K6KANL# !xx''II%%0 (-:&7%D ( H # $ + +H5E,F G # $ + +H5E,F G 9  $ $":x /BC #/* 'M!s+E5  E/E/E5 /E5 ctt|jj|jj |S)a  Delete the given record. >>> table.delete('recwPQIfs4wKPyc9D') {'id': 'recwPQIfs4wKPyc9D', 'deleted': True} Args: record_id: |arg_record_id| Returns: Confirmation that the record was deleted. )rrr`deleteryr3r0s r2rz Table.delete=s3!  HHOODII,,Y7 8  r4 record_idscg}t|}|jj|D]K}|jj|jj d|i}|t t|dz }M|S)a Delete the given records, operating in batches. >>> table.batch_delete(['recwPQIfs4wKPyc9D', 'recwDxIfs3wDPyc3F']) [ {'id': 'recwPQIfs4wKPyc9D', 'deleted': True}, {'id': 'recwDxIfs3wDPyc3F', 'deleted': True} ] Args: record_ids: Record IDs to delete Returns: Confirmation that the records were deleted. z records[])paramsr/)rr`rrryr/rr)r1rdeleted_recordsrrs r2 batch_deletezTable.batch_deleteOss *% XX%%j1EXX__TYY%6%6 U?S_TF 12CVIEVW WO2r4zpyairtable.models.Commentc R|jj|}d|jj|i}|jj d|Dcgc]B}|dD]8}t j jj||j|:Dc}}Scc}}w)aD Retrieve all comments on the given record. Usage: >>> table = Api.table("appNxslc6jG0XedVM", "tblslc6jG0XedVMNx") >>> table.comments("recMNxslc6jG0XedV") [ Comment( id='comdVMNxslc6jG0Xe', text='Hello, @[usrVMNxslc6jG0Xed]!', created_time=datetime.datetime(...), last_updated_time=None, mentioned={ 'usrVMNxslc6jG0Xed': Mentioned( display_name='Alice', email='alice@example.com', id='usrVMNxslc6jG0Xed', type='user' ) }, author=Collaborator( id='usr0000pyairtable', email='pyairtable@example.com', name='Your pyairtable access token' ) ) ] Args: record_id: |arg_record_id| record_urlGETr6context) ryr7r3r`rr_modelsCommentfrom_api)r1r,r>ctxrcomments r2r6zTable.commentsjs@ii'' 2TYY--i8911%= = +    % % . .w# . N+ O=   sAB#textc|jj|}|jj|d|i}tj j j||jd|jj|iS)aI Create a comment on a record. See `Create comment `_ for details. Usage: >>> table = Api.table("appNxslc6jG0XedVM", "tblslc6jG0XedVMNx") >>> comment = table.add_comment("recMNxslc6jG0XedV", "Hello, @[usrVMNxslc6jG0Xed]!") >>> comment.text = "Never mind!" >>> comment.save() >>> comment.delete() Args: record_id: |arg_record_id| text: The text of the comment. Use ``@[usrIdentifier]`` to mention users. rrrr) ryr7r`r|r_rrrr3)r1r,rr>rs r2 add_commentzTable.add_commentsu(ii'' 288==FD>=:  ((11 dhhtyy7G7G 7R(S2  r4forcerc|s |js:|jj|j|j|_|jS)a Retrieve the schema of the current table. Usage: >>> table.schema() TableSchema( id='tblslc6jG0XedVMNx', name='My Table', primary_field_id='fld6jG0XedVMNxFQW', fields=[...], views=[...] ) Args: force: |kwarg_force_metadata| r)r(r&rctabler')r1rs r2rcz Table.schemas?"  99++%+8>>tyyIDL||r4 field_type descriptioncv||d}|r||d<|r||d<|jj|jj|}t |}|j |j|j |jxs|d|jr%|jjj||S)aF Create a field on the table. Usage: >>> table.create_field("Attachments", "multipleAttachment") FieldSchema( id='fldslc6jG0XedVMNx', name='Attachments', type='multipleAttachment', description=None, options=MultipleAttachmentsFieldOptions(is_reversed=False) ) Args: name: The unique name of the field. field_type: One of the `Airtable field types `__. description: A long form description of the table. options: Only available for some field types. For more information, read about the `Airtable field model `__. )r'rbrrtr)r& table_schemar) r`r|ryrDr_set_apir&r(append)r1r'rrrtrr field_schemas r2 create_fieldzTable.create_fields6,0"D %0GM " !(GI 88==!1!1=@*(3  HH $ 4   << LL   & &| 4r4r8filenamecontent content_typecd|:t|d5}|j}ddd|j|||||Stjj |}|4t j|dx}stjd|d}|jj||}t|tr|jn|}||tj|j!dd}|j"j%||} t't(| S#1swYxYw) a* Upload an attachment to the Airtable API, either by supplying the path to the file or by providing the content directly as a variable. See `Upload attachment `__. Usage: >>> table.upload_attachment("recAdw9EjV90xbZ", "Attachments", "/tmp/example.jpg") { 'id': 'recAdw9EjV90xbZ', 'createdTime': '2023-05-22T21:24:15.333134Z', 'fields': { 'Attachments': [ { 'id': 'attW8eG2x0ew1Af', 'url': 'https://content.airtable.com/...', 'filename': 'example.jpg' } ] } } Args: record_id: |arg_record_id| field: The ID or name of the ``multipleAttachments`` type field. filename: The path to the file to upload. If ``content`` is provided, this argument is still used to tell Airtable what name to give the file. content: The content of the file as a string or bytes object. If no value is provided, pyAirtable will attempt to read the contents of ``filename``. content_type: The MIME type of the file. If not provided, the library will attempt to guess the content type based on ``filename``. Returns: A full list of attachments in the given field, including the new attachment. Nrbrz!Could not guess content-type for zapplication/octet-streamutf8) contentTyperfiler)openreadr?ospathbasename mimetypes guess_typer\r]ryr[rEencodebase64 encodebytesdecoder`r|rr) r1r,r8rrrfpr>payloadrs r2r?zTable.upload_attachmentsV ?h%'')&))5(G\ 77##H-  $-$8$8$B1$EELE A(NO9 ii)))U;&0#&>'.."G' &&w/66v>  88==7=3 !;XFF+&%s D%%D/)T)r-r )FN)FFN)NN)6r@rArB__doc____annotations__rEr(r rrrGrryr rPr rrhpropertyrfboolrrr`rrrxr r rrrrrrrrrrrrrrrrrr6rrcrrrbytesrr?rFr4r2r%r%+s L I&*GXk ")B B8 5 !D -1,06        .)  !)                  5tSy!5vs{#5#{*+ 5  5nC#C  C  .* 5X5#5*5*&J&J$z2B)C&JPOSOT*%5O0sx ';6(, 666 ~ 6  6B(, / .)/ /  ~ / j  / j(, #6#6#6 #6  #6  ~ #6 #6P(, (*+(( (  ~ ( j  (\(, G$sCx.)GOG G  G  ~ G GR  -> $x'9dCT>U6& (& t4O/P& P    %  4',t 2&*,0 ---c] - $sCx.) -  -h04&* AGAGAGT " AG %U +, AG sm AG $AGr4r%)4rrr urllib.parsernr\ functoolsrpathlibrtypingrrrrr r r r r pyairtable.modelsr_pyairtable.api.typesrrrrrrrrrrpyairtable.formulasrrpyairtable.models.schemarrrpyairtable.utilsrrrpyairtable.api.apir r!pyairtable.api.baser"pyairtable.api.retryingr#r%rFr4r2rsh  %      8QQ994(-F GF Gr4