K:g3- d dl Z d dlmZ d dlmZmZmZmZmZm Z m
Z
d dl Z d dl
mZmZmZ d dlmZmZmZmZ d dlmZmZmZmZ erd dlm Z G d d Z y)
N)cached_property)
TYPE_CHECKINGAnyDictListOptionalSequenceUnion)BaseCollaborators
BaseSchema
BaseShares)
CreateWebhookCreateWebhookResponseWebhookWebhookSpecification)Url
UrlBuildercache_unless_forcedenterprise_onlyApic
F e Zd ZU dZded< eed< ee ed< dZee ed< dZ ee
ed< dZ ee e
j ed < G d
d e Z ee Zddd dedef d
edee dee fdZedee fd ZdefdZddddedededdfdZdddede d fdZ d)ded ee ee f d ee ddfd Z e de
fd Z de e! fd Z"d!ede!fd"Z#d#ed$ee$e e e f f de%fd%Z&e'e d*d& Z(e'e de e
j fd' Z)e'd+d( Z*y),Basez
Represents an Airtable base.
Usage:
>>> base = api.base("appNxslc6jG0XedVM")
>>> table = base.table("Table Name")
>>> records = table.all()
r apiidpermission_levelN_collaborators_schema_sharesc d e Zd Z ed Zedz Zedz Zedz Zedz Z ed Z de
defd Z y
)
Base._urlszmeta/bases/{id}
interfacessharestables
collaboratorszbases/{id}/webhooks interface_idreturnc | j |z S )z`
URL for retrieving information about a specific interface on the base.
)r" )selfr& s P/var/www/html/lionshead/venv/lib/python3.12/site-packages/pyairtable/api/base.py interfacezBase._urls.interface> s ??\1 1 N) __name__
__module__ __qualname__r metar" r# r$ r% webhooksstrr+ r, r* _urlsr! + s[ $% L(
.
,- 2# 2# 2r, r4 )namer base_idr5 c t |t r*t j dt d ddlm} || }|| _ || _ || _ || _
y)a
Old style constructor takes ``str`` arguments, and will create its own
instance of :class:`Api`.
This approach is deprecated, and will likely be removed in the future.
>>> Base("access_token", "base_id")
New style constructor takes an instance of :class:`Api`:
>>> Base(api, "table_name")
Args:
api: An instance of :class:`Api` or an Airtable access token.
base_id: An Airtable base ID.
name: The name of the Airtable base, if known.
permission_level: The permission level the current authenticated user
has upon the Airtable base, if known.
zPassing API keys to pyairtable.Base is deprecated; use Api.base() instead. See https://pyairtable.rtfd.org/en/latest/migrations.html for details. )category
stacklevelr r N)
isinstancer2 warningswarnDeprecationWarning
pyairtabler r r r _name)r) r r6 r5 r r s r* __init__z
Base.__init__F sQ 6 c3 MMZ+
'c(C 0
r, r' c ^ | j r| j j S | j S )zw
The name of the base, if provided to the constructor
or available in cached base information.
)r r5 r@ r) s r* r5 z Base.namer s) &&++ +zzr, c d| j }| j x}r|d|z
}| j x}r|d|z
}|dz S )Nz )r r5 r )r) reprr5 r s r* __repr__z
Base.__repr__| sa 477+&99 4 gwK D # 4 4 4 4 )(*+ +Dczr, Fvalidateforce
id_or_namerI rJ zpyairtable.api.table.Tablec |rL| j | j | }t j j j d| | S t j j j d| | S )ak
Build a new :class:`Table` instance using this instance of :class:`Base`.
Args:
id_or_name: |arg_table_id_or_name|
validate: |kwarg_validate_metadata|
force: |kwarg_force_metadata|
Usage:
>>> base.table('Apartments')
rJ N)schematabler? r Table)r) rK rI rJ rN s r* rO z
Base.table s` & [[u[-33J?F >>''--dD&A A~~##))$jAAr, rM c | j | j D cg c]- }t j j j d| | / c}S c c}w )a
Retrieve the base's schema and returns a list of :class:`Table` instances.
Args:
force: |kwarg_force_metadata|
Usage:
>>> base.tables()
[
,
]
rM N)rN r$ r? r rO rP )r) rJ table_schemas r* r$ z Base.tables sS !% % 8 ? ?
?
NN & &tT< @ ?
s 2Afields descriptionc | j j }||d}|r||d< | j j || }| j |d dd S )ae
Create a table in the given base.
Args:
name: The unique table name.
fields: A list of ``dict`` objects that conform to the
`Airtable field model `__.
description: The table description. Must be no longer than 20k characters.
)r5 rS rT jsonr TrH )urlsr$ r postrO )r) r5 rS rT urlpayloadresponses r* create_tablezBase.create_table sY ii 62 %0GM "88==7=3zz(4.4tzDDr, c | j j }ddgi}| j j || }t j
|| j | S )a
Retrieve the schema of all tables in the base and caches it.
Usage:
>>> base.schema().tables
[TableSchema(...), TableSchema(...), ...]
>>> base.schema().table("tblXXXXXXXXXXXXXX")
TableSchema(id="tblXXXXXXXXXXXXXX", ...)
>>> base.schema().table("My Table")
TableSchema(id="...", name="My Table", ...)
includevisibleFieldIdsparamscontext)rX r$ r getr from_api)r) rZ rb datas r* rN z Base.schema sP ii / 01xx||C|/""44@@r, c | j j | j j }|d D cg c]$ }t j
|| j | & c}S c c}w )a
Retrieve all the base's webhooks
(see: `List webhooks `_).
Usage:
>>> base.webhooks()
[
Webhook(
id='ach00000000000001',
are_notifications_enabled=True,
cursor_for_next_payload=1,
is_hook_enabled=True,
last_successful_notification_time=None,
notification_url="https://example.com",
last_notification_result=None,
expiration_time=datetime.datetime(...),
specification: WebhookSpecification(...)
)
]
r1 rc )r re rX r1 r rf )r) r\ rg s r* r1 z
Base.webhooks s_ * 88<< 2 23 !,
,
T488T :,
s )A#
webhook_idc n | j D ] }|j |k( s|c S t d| )z
Build a single webhook or raises ``KeyError`` if the given ID is invalid.
Airtable's API does not permit retrieving a single webhook, so this function
will call :meth:`~webhooks` and simply return one item from the list.
zwebhook not found: )r1 r KeyError)r) ri webhooks r* rl z Base.webhook s: }}GzzZ' ' ,ZN;<`_.
The return value will contain a unique secret that must be saved
in order to validate payloads as they are sent to your notification
endpoint. If you do not save this, you will have no way of confirming
that payloads you receive did, in fact, come from Airtable.
For more on how to validate notifications to your webhook, see
:meth:`WebhookNotification.from_request() `.
Usage:
>>> base.add_webhook(
... "https://example.com",
... {
... "options": {
... "filters": {
... "dataTypes": ["tableData"],
... }
... }
... }
... )
CreateWebhookResponse(
id='ach00000000000001',
mac_secret_base64='c3VwZXIgZHVwZXIgc2VjcmV0',
expiration_time=datetime.datetime(...)
)
Raises:
pydantic.ValidationError: If the dict provided is invalid.
Args:
notify_url: The URL where Airtable will POST all event notifications.
spec: The configuration for the webhook. It is easiest to pass a dict
that conforms to the `webhooks specification`_ but you
can also provide :class:`~pyairtable.models.webhook.WebhookSpecification`.
)notification_url
specificationT)by_alias
exclude_unsetrV ) r; dictr rf r r
model_dumprY rX r1 r )r) rm rn createrequestr\ s r* add_webhookzBase.add_webhook s} V dD !'00txx@D
$O##T#F88==!3!3'=B$--hAAr, c dg di}| j j | j j | }t j
|| j | S )zs
Retrieve `base collaborators `__.
r_ )r% inviteLinksr" ra rc )r re rX r0 r rf )r) rb rg s r* r% zBase.collaborators1 sF KLxx||DIINN6|: ))$$GGr, c | j j | j j }t j
|| j | }|j S )za
Retrieve `base shares `__.
rc )r re rX r# r
rf )r) rg
shares_objs r* r# z Base.shares; sD xx||DII , ,- ((txxF
r, c b | j j | j j y)z
Delete the base.
Usage:
>>> base = api.base("appMxESAta6clCCwF")
>>> base.delete()
N)r deleterX r0 rC s r* r~ z Base.deleteE s
'r, )N)r' r )r' N)+r- r. r/ __doc____annotations__r2 r r r r r r r r
Infor r4 r rX r
rA propertyr5 rG boolrO r$ r r r r] r rN r r1 rl r r rx r r% r# r~ r3 r, r* r r sV
J G sm# 37NH ./6$(GXj
!(/3GXd:??+
,32
22 5 !D #*.
*
5#:
* *
sm * #3-
*X hsm # BB B
B
&
B0 ',
t
5Q0R
. &* EE c3h (E c] E
& E, A
A A"
$w-
6
=#
='
=1B1B ($sCx.891B
1Bf H H !Z__- ! ! ( (r, r ) r< functoolsr typingr r r r r r r
pyairtable.api.tabler? pyairtable.models.schemar r r
pyairtable.models.webhookr r r r pyairtable.utilsr r r r pyairtable.api.apir r r3 r, r* r sB % L L L N N S R&{( {(r,