K:g L U d Z ddlZddlZddlZddlZddlZddlmZ ddlm Z m
Z
ddl m Z ddl
mZmZmZmZmZmZmZmZmZmZmZ ddlmZ ddlZddl m Z m Z dd l m Z dd
l!m"Z"m#Z# dd l$m%Z% dd l&m'Z'm(Z(m)Z)m*Z*m+Z+m,Z,m-Z-m.Z.m/Z/m0Z0m1Z1m2Z2 dd
l3m4Z4m5Z5 de6fdZ7d.de6dede6fdZ8 d/de6de6de6dee# deee9e jt f de9de9de9de;fdZ< d0d ee, d ee6 d ede.fd Z=d1dede)fd Z>d2d!e6d"e6de(fd#Z?ee6e6f Z@e eAd$< G d% d& ZBd'ee'e,f de.fd(ZC d1d)ee d*ee6ef d+eee6 deed,f fd-ZDy)3a*
pyAirtable provides a number of helper functions for testing code that uses
the Airtable API. These functions are designed to be used with the standard
Python :mod:`unittest.mock` library, and can be used to create fake records,
users, and attachments, as well as to mock the Airtable API itself.
N) defaultdict) ExitStackcontextmanager)
partialmethod) AnyDictIterableIteratorListOptionalSequenceTupleUnioncastoverload)mock)Self TypeAlias)retrying)Api TimeoutTuple)Table)
AnyRecordDictAttachmentDictCollaboratorDictCreateRecordDict FieldNameFieldsRecordDeletedDict
RecordDictRecordIdUpdateRecordDictUpsertResultDictWritableFields) fieldgetteris_airtable_idreturnc ` t j j j dz S )NZ)datetimenow isoformat O/var/www/html/lionshead/venv/lib/python3.12/site-packages/pyairtable/testing.py_nowr0 6 s% " , , . 44r. typevaluec |Ddj t j t j t j
z d }| |ddd z S )a;
Generate a fake Airtable-style ID.
Args:
type: the object type prefix, defaults to "rec"
value: any value to use as the ID, defaults to random letters and digits
>>> fake_id()
'rec...'
>>> fake_id('tbl')
'tbl...'
>>> fake_id(value='12345')
'rec00000000012345'
N z0>14)joinrandomsamplestring
ascii_lettersdigits)r1 r2 s r/ fake_idr< : sG
}
f&:&:V]]&JBOP U4L#2& &&r. base_id
table_nameapi_keytimeoutretrytypecast
use_field_idsmemoizec f | xs t d |xs t d ||||||d}t dd| S )zJ
Generate a ``Meta`` class for inclusion in a ``Model`` subclass.
apptbl)r= r> r? r@ rA rB rC rD Metar- )r< r1 ) r= r> r? r@ rA rB rC rD attrss r/ fake_metarJ N sF ,gen 2GEN &
E E ""r. fieldsid other_fieldsc p t |d r t | n t | t i | xs i |dS )a
Generate a fake record dict with the given field values.
>>> fake_record({"Name": "Alice"})
{
'id': '...',
'createdTime': '...',
'fields': {'name': 'Alice'}
}
>>> fake_record(name="Alice", id="123")
{
'id': 'rec00000000000123',
'createdTime': '...',
'fields': {'name': 'Alice'}
}
>>> fake_record(name="Alice", id="recABC00000000123")
{
'id': 'recABC00000000123',
'createdTime': '...',
'fields': {'name': 'Alice'}
}
rec)r2 rL createdTimerK )r& strr< r0 )rK rL rM s r/ fake_recordrS h s; < (E2c"gb8Iv4fl4|4 r. c | t d| }|t | xs | j dt | xs d dS )z
Generate a fake user dict with the given value for an email prefix.
>>> fake_user("Alice")
{
'id': 'usr000000000Alice',
'email': 'alice@example.com'
'name': 'Alice'
}
usrz @example.comz Fake User)rL emailname)r< rR lower)r2 rL s r/ fake_userrY sG
B $**,-\:E([) r. urlfilenamec |sEt j j | j xs dj d d }|xs d}t d | xs d|dt
j | d xs d d
S ) a
Generate a fake attachment dict.
>>> fake_attachment()
{
'id': 'att...',
'url': 'https://example.com/',
'filename': 'foo.txt',
'size': 100,
'type': 'text/plain',
}
>>> fake_attachment('https://example.com/image.png', 'foo.png')
{
'id': 'att...',
'url': 'https://example.com/image.png',
'filename': 'foo.png',
'size': 100,
'type': 'text/plain',
}
r4 /zfoo.txtattzhttps://example.com/d r z
text/plain)rL rZ r[ sizer1 )urllib3util parse_urlpathsplitr< mimetypes
guess_type)rZ r[ s r/ fake_attachmentri sx , LL**3/44:AA#FrJ(yen,, $$X.q1A\ r. BaseAndTableIdc
e Zd ZU dZg dZeeeeef f e d< e
e e d< ee e
f e d< d1dedd fd
Zd2d Zdefd Zd
e
dd fdZededee fd Z eed Z eed Zedeee e
f de de de e fd Z edeee e
f de de e fd Z de
de
de e fdZ edeee e
f de de dd fd Z edeee e
f de dd fd Z de
de
dd fd Z d2d Z d e!d e d e de
de
f
d!Z"de d"e
de e e fd#Z#de d$e d"e
defd%Z$de d&e%de
defd'Z&de d$ed(e'de
def
d)Z(de d$ede)fd*Z*de dee% de
de e fd+Z+de dee, de
de e fd,Z-de d-ee de e) fd.Z.de dee/ d/ee0 de
de1f
d0Z2y )3 MockAirtablea
This class acts as a context manager which mocks several pyAirtable APIs,
so that your tests can operate against tables without making network requests.
.. code-block:: python
from pyairtable import Api
from pyairtable.testing import MockAirtable
table = Api.base("baseId").table("tableName")
with MockAirtable() as m:
m.add_records(table, [{"Name": "Alice"}])
records = table.all()
assert len(table.all()) == 1
If you use pytest, you might want to include this as a fixture.
.. code-block:: python
import pytest
from pyairtable.testing import MockAirtable
@pytest.fixture(autouse=True)
def mock_airtable():
with MockAirtable() as m:
yield m
def test_your_function():
...
Not all API methods are supported; if your test calls a method that would
make a network request, a RuntimeError will be raised instead.
>>> with MockAirtable() as m:
... table.schema()
...
Traceback (most recent call last): ...
RuntimeError: unhandled call to Api.request
You can allow unhandled requests by setting the ``passthrough`` argument to True,
either on the constructor or temporarily on the MockAirtable instance. This is
useful when using another library, like `requests-mock `_,
to prepare responses for complex cases (like code that retrieves the schema).
.. code-block:: python
def test_your_function(requests_mock, mock_airtable, monkeypatch):
base = Api.base("baseId")
# load and cache our mock schema
requests_mock.get(
base.meta_url("tables"),
json={"tables": [...]}
)
with mock_airtable.enable_passthrough():
base.schema()
# code below will fail if any more unhandled requests are made
...
)
Api.requestz
Table.iteratez Table.getz Table.createz Table.updatez Table.deletezTable.batch_createzTable.batch_updatezTable.batch_deletezTable.batch_upsertrecords_stack_mocksF passthroughr' Nc 2 || _ | j y)z
Args:
passthrough: if True, unmocked methods will still be allowed to
perform real network requests. If False, they will raise an error.
N)rq _reset)selfrq s r/ __init__zMockAirtable.__init__ s '
r. c H d | _ i | _ t t | _ y N)ro rp r dictrn rt s r/ rs zMockAirtable._reset! s "4( r. c | j r t d t t j d r t d | j t
| _ | j D ]w }|j dd j }t | d| d }t j d| |d x}| j |< | j j | y | S ) Nz MockAirtable is not reentrantr z MockAirtable cannot be nested._z pyairtable.T) side_effectautospec)ro RuntimeErrorhasattrr requestrs r mockedreplacerX getattrr patchrp
enter_context)rt rW side_effect_namer}
mocked_methods r/ __enter__zMockAirtable.__enter__& s ;; >? ? 3;; ' >? ?
k KKD #||C 5 ; ; = !$!,<+=(>EK04
dV$ ' 1
MDKK -
KK % %m 4 r. exc_infoc P | j r | j j | y y rw )ro __exit__)rt r s r/ r zMockAirtable.__exit__: s" ;; DKK ( + r. allowedc # b K | j }|| _ | || _ y# || _ w xY ww)a
Context manager that temporarily changes whether unmocked methods
are allowed to perform real network requests. For convenience, there are
also shortcuts ``enable_passthrough()`` and ``disable_passthrough()``.
Usage:
.. code-block:: python
with MockAirtable() as m:
with m.enable_passthrough():
schema = base.schema()
hooks = table.webhooks()
# no more network requests allowed
...
Args:
allowed: If ``True``, unmocked methods will be allowed to perform real
network requests within this context manager. If ``False``,
they will not be allowed.
N)rq )rt r originals r/ set_passthroughz MockAirtable.set_passthrough> s5 0 ##" (J 'D xD s /# / ,/Tr= table_id_or_namec y rw r- rt r= r rn s r/ add_recordszMockAirtable.add_records` s r. tablec y rw r- rt r rn s r/ r zMockAirtable.add_recordsi s r. argskwargsc t ||dg \ }}}|D cg c]
}t | }}| j ||f j |D ci c] }|d |
c} |S c c}w c c}w )ar
Add a list of records to the mock Airtable instance. These will be returned
from methods like :meth:`~pyairtable.Table.all` and :meth:`~pyairtable.Table.get`.
Can be called with either a base ID and table name,
or an instance of :class:`~pyairtable.Table`:
.. code-block::
m = MockAirtable()
m.add_records("baseId", "tableName", [{"Name": "Alice"}])
m.add_records(table, records=[{"id": "recFake", {"Name": "Alice"}}])
.. note::
The parameters to :meth:`~pyairtable.Table.all` are not supported by MockAirtable,
and constraints like ``formula=`` and ``limit=`` will be ignored. It is assumed
that you are adding records to specifically test a particular use case.
MockAirtable is not a full in-memory replacement for the Airtable API.
Args:
base_id: |arg_base_id|
*This must be the first positional argument.*
table_id_or_name: |arg_table_id_or_name|
This should be the same ID or name used in the code under test.
*This must be the second positional argument.*
table: An instance of :class:`~pyairtable.Table`.
*This is an alternative to providing base and table IDs,
and must be the first positional argument.*
records: A sequence of :class:`~pyairtable.api.types.RecordDict`,
:class:`~pyairtable.api.types.UpdateRecordDict`,
:class:`~pyairtable.api.types.CreateRecordDict`,
or :class:`~pyairtable.api.types.Fields`.
rn rL )
_extract_argscoerce_fake_recordrn update)rt r r r= r> rn recordcoerceds r/ r zMockAirtable.add_recordsq s} F (5T6I;'O$W rn s r/ r zMockAirtable.set_records sJ & (5T6I;'O$W gz*+113 *g>r. c 8 | j j y)zD
Clear all records from the mock Airtable instance.
N)rn r ry s r/ r zMockAirtable.clear s
r. apimethodrZ c x | j s t d | j d } |j |||fi |S )Nz unhandled call to Api.requestrm )rq r rp
temp_original)rt r r rZ r r s r/ _api_requestzMockAirtable._api_request sA >? ?]+#v##C???r. optionsc t | j |j j |j f j gS rw )listrn baserL rW values)rt r r s r/ _table_iteratezMockAirtable._table_iterate s3 T\\5::==%**"=>EEGHIIr. record_idc f | j |j j |j f | S rw )rn r rL rW )rt r r r s r/
_table_getzMockAirtable._table_get s' ||UZZ]]EJJ 78CCr. r c | j |j j |j f }t | }|d |v rt |d< |d |v r|||d < |S )NrL )rn r rL rW r r< )rt r r r rn s r/
_table_createzMockAirtable._table_create se ,,
uzz :;#F+Tlg%"9F4L Tlg% &t
r. rK c | j |j j |j f | }|d j | |S )NrK )rn r rL rW r )rt r r rK r existss r/
_table_updatezMockAirtable._table_update s@ uzz}}ejj 9:9Ex '
r. c | j |j j |j f j | |ddS )NT)rL deleted)rn r rL rW pop)rt r r s r/
_table_deletezMockAirtable._table_delete s5 ejjmmUZZ0155i@ D11r. c L |D cg c] }| j || c}S c c}w rw )r rt r rn r r s r/ _table_batch_createz MockAirtable._table_batch_create s+ AHHf""5&1HHH !c Z |D cg c] }| j ||d |d c}S c c}w )NrL rK )r r s r/ _table_batch_updatez MockAirtable._table_batch_update sA "
!
ufTlF84D E!
s (
record_idsc L |D cg c] }| j || c}S c c}w rw )r )rt r r r s r/ _table_batch_deletez MockAirtable._table_batch_delete s+
GQQj""5)4jQQQr
key_fieldsc t | }| j |j j |j f }|j D ci c] } || |
}}g g g d} |D ] }
d|
v r_t
|
j d } || } | d j |
d | d j | | d j | f|j ||
x} rC| d j |
d | d j | d | d j | | j ||
}
| d j |
d | d j |
| S c c}w )zW
Perform a batch upsert operation on the mocked records for the table.
)updatedRecordscreatedRecordsrn rL rK r rn r ) r% rn r rL rW r rR getr appendr )rt r rn r r keyexisting_by_idrexisting_by_keyresultr r existing_recordcreated_records r/ _table_batch_upsertz MockAirtable._table_batch_upsert
s| :& uzz}}ejj&AB.<.C.C.EF.E3q619.EF $
Fv~
4 0 1 "0"; )001AB'(// :y!(( 9$3$7$7F $DD D )001AB'(//0EFy!(( 9!%!3!3E6!B'(//t0DEy!(( 8 "
1 Gs
E()F)r' N)3__name__
__module__ __qualname____doc__r r rj r! r __annotations__r r rR r boolru rs r r r r r
r r enable_passthroughdisable_passthroughr r r r r r r r r r r r r r$ r r r r r" r r r r r# r r- r. r/ rl rl s =@ F .$x';"<<
== Y cND T )
4 (,# ,$ , (t ( ( (< '='?
$sCx.)
j
$sCx.)
j ( ( (Z8H (T
$sCx.)
$sCx.)
? ? ? ?. @ @S @s @c @c @ JE Jc Jd4
CS>T JD D# D# D* D !
25 2X 2BS 2II *+I I
j I
*+
j
RR X&R
R$$ -($ Y' $
$
$r. rl r c d| vrdt t | i} t | j d xs
t t | j d xs
t | d dS )a
Coerce a record dict or field mapping to the expected format for
an Airtable record, creating a fake ID and createdTime if necessary.
>>> coerce_fake_record({"Name": "Alice"})
{'id': 'rec000...', 'createdTime': '...', 'fields': {'Name': 'Alice'}}
rK rL rQ rP )r r rR r r< r0 )r s r/ r r 4 s_ v D 01&**T"/gi06::m4>?" r. r r extract.c |xs g }t }t j d j }t | d t
u r.| d j j | d j g| dd } t d | D }|dd t t fk7 r't | ddj d |D d |D ]. }||v s|j | g | |j | } 0 |r t | d
dj | t | t | dz k rDt | t | k r-t | |z
}t | d dj | t | S ) z
Convenience function for functions/methods which accept either
a Table or a (base_id, table_name) as their first posargs.
r Nc 3 2 K | ] }t | y wrw )r1 ).0args r/ z _extract_args..U s /$3T#Y$s z expected (str, str, ...), got (z, c 3 4 K | ] }|j y wrw )r )r ts r/ r z _extract_args..X s @^U]PQU]s )z# got unexpected keyword arguments: z missing keyword arguments: )setinspectstackfunctionr1 r r rL rW tuplerR TypeErrorr6 addr len)r r r extractedcallerargtypes extract_namemissings r/ r r E sw mGI
]]_Q
(
(F DG} Q a 9QR9/$//H|Sz!h6tyy@^U]@^7^6__` a
6 ! MM, '4T46::l34D
h9$))F:K9L M
4y3wtyy?Q>RSTT ;r. )rO N)r4 r4 patFakePersonalAccessTokenNNTFF)NNrw )r4 r4 )Er r* r rg r7 r9 collectionsr
contextlibr r functoolsr typingr r r r
r r r
r r r r unittestr rb typing_extensionsr r pyairtable.apir pyairtable.api.apir r pyairtable.api.tabler pyairtable.api.typesr r r r r r r r r! r" r# r$ pyairtable.utilsr% r& rR r0 r< r Retryr1 rJ rS rY ri rj r rl r r r- r. r/ r s
# 0 # - # 0 &
95c 5'# 'c 'S '* /&*37 #
## # l
# #
E$./ 0 #
# # #
#6 $ ! V !
! ! !HS $4 & S . D "#s(O +m m` u]F%: ;
( (,#
3-# cN# hsm
$# 38_ #r.