apitable 1.4.0__tar.gz → 2.0.0b4__tar.gz

{apitable-1.4.0 → apitable-2.0.0b4}/PKG-INFO

@@ -1,19 +1,25 @@
 Metadata-Version: 2.1
 Name: apitable
-Version: 1.4.0
-Summary: Apitable Python SDK
-Home-page: https://github.com/apitable/apitable-sdks
-Author: apitable
+Version: 2.0.0b4
+Summary: APITable OpenAPI Python SDK
+Author: APITable Ltd.
 Author-email: dev@apitable.com
+Requires-Python: >=3.8,<4.0
 Classifier: Programming Language :: Python :: 3
-Classifier: License :: OSI Approved :: MIT License
-Classifier: Operating System :: OS Independent
-Requires-Python: >=3.6
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Requires-Dist: certifi (>=2023.7.22,<2024.0.0)
+Requires-Dist: charset-normalizer (>=3.2.0,<4.0.0)
+Requires-Dist: environs (>=9.5.0,<10.0.0)
+Requires-Dist: idna (>=3.4,<4.0)
+Requires-Dist: marshmallow (>=3.20.1,<4.0.0)
+Requires-Dist: pydantic (==2.4.2)
+Requires-Dist: python-dotenv (>=1.0.0,<2.0.0)
+Requires-Dist: requests (>=2.31.0,<3.0.0)
+Requires-Dist: urllib3 (>=2.0.4,<3.0.0)
 Description-Content-Type: text/markdown
-License-File: LICENSE
-Requires-Dist: requests<=2.31.0
-Requires-Dist: pydantic==1.7
-Requires-Dist: environs<=9.5.0
 
 # APITable.py
 
@@ -308,3 +314,4 @@ pipenv install --pre
 pipenv shell
 python -m unittest test
 ```
+

{apitable-1.4.0 → apitable-2.0.0b4}/apitable/datasheet/datasheet.py

@@ -57,6 +57,11 @@ class Datasheet:
         return urljoin(self.apitable.api_base,
                        f"/fusion/v1/datasheets/{self.id}/records")
 
+    @property
+    def _record_api_endpoint_v3(self):
+        return urljoin(self.apitable.api_base,
+                       f"/fusion/v3/datasheets/{self.id}/records")
+
     @property
     @timed_lru_cache(seconds=300)
     def fields(self):
@@ -137,6 +142,12 @@ class Datasheet:
         """
         Paginate to get data
         """
+
+        is_v3 = bool(kwargs.get("isV3", False))
+        endpoint = self._record_api_endpoint
+        if is_v3:
+            endpoint = self._record_api_endpoint_v3
+
         params = {}
         for key in kwargs:
             if key in API_GET_DATASHEET_QS_SET:
@@ -147,7 +158,7 @@ class Datasheet:
                     else:
                         raise ErrorSortParams('The format of the sort parameter is incorrect')
                 params.update({key: params_value})
-        resp = self.apitable.request.get(self._record_api_endpoint, params=params)
+        resp = self.apitable.request.get(endpoint, params=params)
         return handle_response(resp, GETRecordResponse)
 
     def get_records_all(self, **kwargs) -> List[RawRecord]:

{apitable-1.4.0 → apitable-2.0.0b4}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "apitable"
-version = "1.4.0"
+version = "2.0.0-beta.4"
 description = "APITable OpenAPI Python SDK"
 authors = ["APITable Ltd. <dev@apitable.com>"]
 readme = "README.md"

apitable-1.4.0/apitable.egg-info/PKG-INFO

@@ -1,310 +0,0 @@
-Metadata-Version: 2.1
-Name: apitable
-Version: 1.4.0
-Summary: Apitable Python SDK
-Home-page: https://github.com/apitable/apitable-sdks
-Author: apitable
-Author-email: dev@apitable.com
-Classifier: Programming Language :: Python :: 3
-Classifier: License :: OSI Approved :: MIT License
-Classifier: Operating System :: OS Independent
-Requires-Python: >=3.6
-Description-Content-Type: text/markdown
-License-File: LICENSE
-Requires-Dist: requests<=2.31.0
-Requires-Dist: pydantic==1.7
-Requires-Dist: environs<=9.5.0
-
-# APITable.py
-
-[![Latest Version](https://shields.mitmproxy.org/pypi/v/apitable.svg)](https://pypi.python.org/pypi/apitable)
-
-It is the official package for the Fusion API of APITable, and provides an API similar to the Django ORM style.
-
-# Requirements
-
-python3.6 +
-
-If you want to call apitable rest api, you need get the API Token first: visit the workbench of APITable, click the avatar in the lower left corner, and go to User Center > Developer Configuration. Click to generate Token (you need to bind your email for the first time).
-
-# Installation
-
-```shell
-pip install --upgrade apitable
-```
-
-# Getting started
-
-## Example
-
-```python
-from apitable import Apitable
-
-apitable = Apitable("your api_token")
-
-dst = apitable.datasheet("your datasheet id")
-# When the URL is used as a parameter, the datasheet id is automatically resolved, ignoring the view id.
-# dst = apitable.datasheet("https://apitable.com/workbench/dstxxxxxxxx/viwxxxxxxxx")
-
-# Create a record
-record = dst.records.create({"title": "new record from Python SDK"})
-print(record.title)
-
-# Create records in bulk
-records = dst.records.bulk_create([
-    {"title": "new record from Python SDK"},
-    {"title": "new record from Python SDK2"}
-])
-
-# Update a single field
-record.title = "new title"
-print(record.title)
-# "new title"
-
-# Update multiple fields
-record.update({
-    "title": "new title",
-    "other_field": "new value",
-})
-
-# Batch update multiple records
-records = dst.records.bulk_update([
-    {"recordId": "recxxxxx1", "fields":{"title": "new record.title from Python SDK"}},
-    {"recordId": "recxxxxx2", "fields":{"title": "new record.title from Python SDK2"}},
-])
-
-# Attachment field update
-my_file = dst.upload_file( <local or network file path>)
-record.files = [my_file]
-
-# Filter record
-songs = dst_songs.records.filter(artist="faye wong")
-for song in songs:
-    print(song.title)
-
-# Batch update a batch of records
-dst_tasks.records.filter(title=None).update(status="Pending")
-
-# Get a single record
-book = dst_book.records.get(ISBN="9787506341271")
-print(book.title)
-
-# Convert the record object to json
-record.json()
-
-# Delete a batch of records that match the filter criteria
-dst.records.filter(title=None).delete()
-
-# Get fields
-for field in apitable.datasheet("dstId").fields.all():
-  print(field.name)
-
-# Get the fields of the specified view, hidden fields will not be returned
-for field in apitable.datasheet("dstId").fields.all(viewId="viewId"):
-  print(field.name)
-
-# Get views
-for view in apitable.datasheet("dstId").views.all():
-  print(view.name)
-
-```
-
-## Field mapping
-
-Using the field name of the datasheet directly as a variable may not conform to the variable specification. So you have to fall back to using fieldId as the key, making the code less readable.
-
-In order to solve this problem, the Python SDK provides the function of field mapping.
-
-| Bug title\!                       | Bug status |
-| --------------------------------- | ---------- |
-| The page crashes after logging in | Waiting    |
-
-```python
-dst = apitable.datasheet("dstt3KGCKtp11fgK0t",field_key_map={
-  "title": "Bug title!",
-  "state": "Bug status",
-})
-
-record = dst.records.get()
-print(record.title)
-# "The page crashes after logging in"
-print(record.state)
-# "Waiting"
-record.state="Done"
-```
-
-Keep the use of field id as the key
-
-```python
-bug = apitable.datasheet("dstn2lEFltyGHe2j86", field_key="id")
-row = bug.records.get(flddpSLHEzDPQ="The page crashes after logging in")
-row.flddpSLHEzDPQ = "The page crashes after logging in"
-row.update({
-    "flddpSLHEzDPQ": "The page crashes after logging in",
-    "fldwvNDf9teD2": "Done"
-})
-```
-
-When specifying `field_key="id"`, specify the corresponding key value of `field_key_map` should be `fieldId`
-
-```python
-bug = apitable.datasheet("dstn2lEFltyGHe2j86", field_key="id", field_key_map={
-    "title": "flddpSLHEzDPQ",
-    "state": "fldwvNDf9teD2",
-})
-```
-
-# Documentation
-
-## records
-
-`dst.records` manage records in datasheets.
-
-| Method           | Parameter             | Type        | Description                                                                                                                                                                    | Example                                                                                                        |
-| ---------------- | --------------------- | ----------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------------------------------- |
-| create           | dict                  | Record      | Create a single record                                                                                                                                                         | `dst.records.create({"title":"new title"})`                                                                    |
-| bulk_create      | dict[]                | Record[]    | Create multiple records in batches                                                                                                                                             | `dst.records.bulk_create([{"title":"new record1"},{"title":"new record2"}])`                                   |
-| bulk_update      | dict[]                | Record[]    | Batch update multiple records                                                                                                                                                  | `dst.records.bulk_update([{"recordId": "recxxxxx1", "fields":{"title": "new record.title from Python SDK"}}])` |
-| all              | \*\*kwargs            | QuerySet    | Return the record collection, you can pass parameters to customize the return content                                                                                          | `dst.records.all()`                                                                                            |
-| get              | \*\*kwargs            | Record      | single record                                                                                                                                                                  | `dst.records.get(title="new title")`                                                                           |
-| get_or_create    | (defaults,\*\*kwargs) | Record,bool | Query the corresponding record through kwargs. If it does not exist, create a new record in combination with defaults. The returned bool indicates whether it is a new record. | `dst.records.get_or_create(title="new title",defaults={"status":"pending"})`                                   |
-| update_or_create | (defaults,\*\*kwargs) | Record,bool | Query the corresponding record through kwargs, and update the record with defaults. Create if it does not exist (same as get_or_create)                                        | `dst.records.update_or_create(title="new title",defaults={"status":"done"})`                                   |
-| filter           | \*\*kwargs            | QuerySet    | Filter a batch of records                                                                                                                                                      | `dst.records.filter(title="new title")`                                                                        |
-
-## QuerySet
-
-Chained calls are possible. For example, `qs = dst.records.all()` returns a batch of queried datasets.
-
-| Method | Parameter | Type     | Description                              | Example                                                  |
-| ------ | --------- | -------- | ---------------------------------------- | -------------------------------------------------------- |
-| filter | \*\*dict  | QuerySet | Filter out a batch of records            | `qs.filter(title="new title")`                           |
-| all    | /         | QuerySet | Returns a copy of the current record set | `qs.filter(title="new title").all()`                     |
-| get    | \*\*dict  | Record   | Single record                            | `qs.get(title="new title")`                              |
-| count  | /         | int      | Total number of records                  | `qs.filter(title="new title").count()`                   |
-| last   | /         | Record   | Last record                              | `qs.filter(title="new title").last()`                    |
-| first  | /         | Record   | First record                             | `qs.filter(title="new title").first()`                   |
-| update | \*\*dict  | Record   | Number of records successfully updated   | `qs.filter(title="new title").update(title="new title")` |
-| delete | /         | bool     | Whether the deletion is successful       | `qs.filter(title="new title").delete()`                  |
-
-## Record
-
-The QuerySet queried out is a collection of Records. A single Record can obtain the value of the specified field through `record.fieldname`.
-
-**Please try to avoid the same name of the field name and the method property reserved by Record, the field with the same name in the table will be obscured. If it does exist, use the field mapping configuration**
-
-| Method/Attribute | Parameter | Type | Description                                                              | Example         |
-| ---------------- | --------- | ---- | ------------------------------------------------------------------------ | --------------- |
-| json             | /         | dict | Returns all field values of the current record                           | `record.json()` |
-| \_id             | /         | str  | \_id is a reserved attribute, returns the recordId of the current record | `record._id`    |
-
-## Field
-
-The mapping relationship between Field and Python data structure. The data with empty cells in the datasheet is always null, and the records returned by the API will not contain fields with null values.
-
-| Field Type       | Data type           |
-| ---------------- | ------------------- |
-| SingleText       | str                 |
-| Text             | str                 |
-| SingleSelect     | str                 |
-| MultiSelect      | str[]               |
-| URL              | str                 |
-| Phone            | str                 |
-| Email            | str                 |
-| Number           | number              |
-| Currency         | number              |
-| Percent          | number              |
-| AutoNumber       | number              |
-| DateTime         | number              |
-| CreatedTime      | number              |
-| LastModifiedTime | number              |
-| Attachment       | attachment object[] |
-| Member           | unit object[]       |
-| Checkbox         | bool                |
-| Rating           | int                 |
-| CreatedBy        | unit object         |
-| LastModifiedBy   | unit object         |
-| MagicLink        | str[]               |
-| MagicLookUp      | any[]               |
-| Formula          | str / bool          |
-
-## all
-
-all method will automatically handle paging loading all resources
-
-_When the paging-related parameters (pageNum, pageSize) are passed in, the SDK will no longer automatically load all records, and only return the specified page data_。
-
-> Try to avoid using the dst.records.all method without parameters to get all the data.
-> The API can obtain a maximum of 1000 pieces of data per request. If your data volume is too large, it is close to the limit of 50000. In the case of no parameters, calling all will serially request the API 50 times. Not only is it very slow, but it consumes API request credit.
-
-_Return the records of the specified pagination_
-
-```python
-dst.records.all(pageNum=3)
-```
-
-_Use with views_
-
-Specifying the view id returns the same data as in the view.
-
-```python
-dst.records.all(viewId="viwxxxxxx")
-```
-
-_Filter data using formulas_
-
-```python
-dst.records.all(filterByFormula='{title}="hello"')
-```
-
-| Parameter       | Type               | Description                                                                                                 | Example                               |
-| --------------- | ------------------ | ----------------------------------------------------------------------------------------------------------- | ------------------------------------- |
-| viewId          | str                | View ID. The request will return the filtered/sorted results in the view                                    |                                       |
-| pageNum         | int                | Default 1                                                                                                   |                                       |
-| pageSize        | int                | Default 100, maximum 1000                                                                                   |                                       |
-| sort            | dict[]             | Specify the sorting field, which overrides the view sorting conditions                                      | `[{ field: 'field1', order: 'asc' }]` |
-| recordIds       | str[]              | Returns the recordset with the specified recordId                                                           | `['recordId1', 'recordId2']`          |
-| fields          | str[]              | Only the specified fields will be returned                                                                  |                                       |
-| filterByFormula | str                | Returns matching records using formulas as filter criteria                                                  |                                       |
-| maxRecords      | int                | Limit the number of records returned, the default is 5000                                                   |                                       |
-| cellFormat      | 'json' or 'string' | Defaults to 'json', when specified as 'string' all values will be automatically converted to string format. |                                       |
-| fieldKey        | 'name' or 'id'     | Specifies the field query and returned key. The column name 'name' is used by default.                      |                                       |
-
-See: [Tutorial getting started with formulas](https://help.apitable.com/docs/guide/tutorial-getting-started-with-formulas)
-
-## FAQ
-
-### Can I get the field type (meta) information of the datasheet?
-
-Can be get through the fields/views API.
-
-### Can option be created automatically?
-
-If you write to a non-existent option, the option will be created automatically
-
-### How many records can a single datasheet?
-
-5w records.
-
-### Can more records be processed per request?
-
-10 records. In the future, we will adjust the size of this limit according to the actual situation.
-
-### Can more records be fetched per request?
-
-The current maximum is 1000 records. In the future, we will adjust the size of this limit according to the actual situation.
-
-# Development and test
-
-Create a new `.env`, the content can refer to `.env.example`.
-
-```shell
-cp .env .env.example
-```
-
-Then modify the test code in the `test/` folder for testing.
-
-```shell
-pipenv install --pre
-pipenv shell
-python -m unittest test
-```

apitable-1.4.0/apitable.egg-info/SOURCES.txt

@@ -1,58 +0,0 @@
-LICENSE
-README.md
-pyproject.toml
-setup.py
-apitable/__init__.py
-apitable/apitable.py
-apitable/const.py
-apitable/exceptions.py
-apitable/request.py
-apitable/utils.py
-apitable.egg-info/PKG-INFO
-apitable.egg-info/SOURCES.txt
-apitable.egg-info/dependency_links.txt
-apitable.egg-info/requires.txt
-apitable.egg-info/top_level.txt
-apitable/datasheet/__init__.py
-apitable/datasheet/datasheet.py
-apitable/datasheet/datasheet_manager.py
-apitable/datasheet/field_manager.py
-apitable/datasheet/query_set.py
-apitable/datasheet/record.py
-apitable/datasheet/record_manager.py
-apitable/datasheet/view_manager.py
-apitable/node/__init__.py
-apitable/node/node_manager.py
-apitable/space/__init__.py
-apitable/space/space.py
-apitable/space/space_manager.py
-apitable/types/__init__.py
-apitable/types/embedlink.py
-apitable/types/field.py
-apitable/types/node.py
-apitable/types/record.py
-apitable/types/response.py
-apitable/types/space.py
-apitable/types/unit_model.py
-apitable/types/view.py
-apitable/unit/__init__.py
-apitable/unit/member.py
-apitable/unit/role.py
-apitable/unit/team.py
-apitable/unit/unit.py
-test/test_apitable.py
-test/test_create_datasheet.py
-test/test_create_embed_link.py
-test/test_create_field.py
-test/test_create_records.py
-test/test_delete_field.py
-test/test_delete_records.py
-test/test_get_fields.py
-test/test_get_nodes.py
-test/test_get_records.py
-test/test_get_spaces.py
-test/test_get_views.py
-test/test_unit.py
-test/test_update_records.py
-test/test_upload_file.py
-test/test_utils.py

apitable-1.4.0/apitable.egg-info/dependency_links.txt

@@ -1 +0,0 @@
-

apitable-1.4.0/apitable.egg-info/requires.txt

@@ -1,3 +0,0 @@
-requests<=2.31.0
-pydantic==1.7
-environs<=9.5.0

apitable-1.4.0/apitable.egg-info/top_level.txt

@@ -1 +0,0 @@
-apitable

apitable-1.4.0/setup.cfg

@@ -1,4 +0,0 @@
-[egg_info]
-tag_build = 
-tag_date = 0
-

apitable-1.4.0/setup.py

@@ -1,28 +0,0 @@
-import setuptools
-
-with open("README.md", "r") as fh:
-    long_description = fh.read()
-
-with open(".version", "r") as fh:
-    version_number = fh.read()
-
-setuptools.setup(
-    name="apitable",
-    version=version_number,
-    author="apitable",
-    author_email="dev@apitable.com",
-    description="Apitable Python SDK",
-    long_description=long_description,
-    long_description_content_type="text/markdown",
-    url="https://github.com/apitable/apitable-sdks",
-    packages=[
-        "apitable", "apitable.datasheet", "apitable.types", "apitable.node", "apitable.space", "apitable.unit"
-    ],
-    classifiers=[
-        "Programming Language :: Python :: 3",
-        "License :: OSI Approved :: MIT License",
-        "Operating System :: OS Independent",
-    ],
-    python_requires=">=3.6",
-    install_requires=["requests<=2.31.0", "pydantic==1.7", "environs<=9.5.0"],
-)

apitable-1.4.0/test/test_apitable.py

@@ -1,18 +0,0 @@
-import unittest
-from unittest.mock import patch
-
-from apitable.space import Space
-
-
-class TestApitable(unittest.TestCase):
-    """
-    base test class.
-    """
-
-    def setUp(self):
-        """
-        set up.
-        """
-        with patch('apitable.apitable') as mock_apitable:
-            self._apitable = mock_apitable
-            self._space = Space(self._apitable, 'test_space_id')

apitable-1.4.0/test/test_create_datasheet.py

@@ -1,30 +0,0 @@
-import unittest
-import warnings
-from apitable import Apitable
-from . import DOMAIN, TOKEN, SPACE_ID, FOLDER_ID
-
-
-class TestCreateDatasheet(unittest.TestCase):
-    """Apitable Python SDK create datasheet test class
-    - Datasheet Creation SDK Test
-    """
-
-    def setUp(self):
-        """Create a datasheet test class object initial hook:"""
-        warnings.simplefilter("ignore", ResourceWarning)
-        apitable = Apitable(TOKEN)
-        apitable.set_api_base(DOMAIN)
-        self.spc = apitable.space(SPACE_ID)
-
-    def test_datasheet_create(self):
-        """Datasheet Creation SDK Test"""
-        req_data = {"name": "python_test_datasheet_create", "folderId": FOLDER_ID}
-        self.datasheet = self.spc.datasheets.create(req_data)
-        self.assertIsNotNone(self.datasheet.id)
-
-    def tearDown(self):
-        """Create a Datasheet test class object destroy hook:"""
-
-
-if __name__ == "__main__":
-    unittest.main()

apitable-1.4.0/test/test_create_embed_link.py

@@ -1,58 +0,0 @@
-import time
-import unittest
-import warnings
-from apitable import Apitable
-from apitable.types import EmbedLinkThemeEnum,EmbedLinkPermissionType
-from . import DOMAIN, TOKEN, SPACE_ID, DATASHEET_ID
-
-
-class TestEmbedLinkCRD(unittest.TestCase):
-    def setUp(self):
-        warnings.simplefilter("ignore", ResourceWarning)
-        apitable = Apitable(TOKEN)
-        apitable.set_api_base(DOMAIN)
-        self.spc = apitable.space(SPACE_ID)
-
-    def test_embed_link_crd(self):
-        datasheet = self.spc.datasheet(DATASHEET_ID)
-        newEmbedLink = datasheet.create_embed_link(
-            {
-                "paylod": {
-                    "primarySideBar": {"collapsed": False},
-                    "viewControl": {
-                        "viewId": "viwBBc0PMN3WB",
-                        "tabBar": False,
-                        "toolBar": {
-                            "basicTools": False,
-                            "shareBtn": False,
-                            "widgetBtn": False,
-                            "apiBtn": False,
-                            "formBtn": False,
-                            "historyBtn": False,
-                            "robotBtn": False,
-                        },
-                        "collapsed": False,
-                    },
-                    "bannerLogo": True,
-                    "permissionType": EmbedLinkPermissionType.READ_ONLY,
-                },
-                "theme": EmbedLinkThemeEnum.Light,
-            }
-        )
-        self.assertIsNotNone(newEmbedLink.linkId)
-        time.sleep(0.5)
-        embedLinks = datasheet.get_embed_links()
-        self.assertEqual(len(embedLinks), 1)
-        time.sleep(0.5)
-        isDeleted = datasheet.delete_embed_link(newEmbedLink.linkId)
-        self.assertTrue(isDeleted)
-        time.sleep(0.5)
-        embedLinks = datasheet.get_embed_links()
-        self.assertEqual(len(embedLinks), 0)
-
-    def tearDown(self):
-        """Create an embed link test class object destroy hook:"""
-
-
-if __name__ == "__main__":
-    unittest.main()

apitable-1.4.0/test/test_create_field.py

@@ -1,43 +0,0 @@
-import unittest
-import warnings
-from apitable import Apitable
-from . import TOKEN, DOMAIN, SPACE_ID, DATASHEET_ID
-
-
-class TestCreateFields(unittest.TestCase):
-    """Apitable Python SDK create field test class
-    - Field Creation SDK Test
-    """
-
-    def setUp(self):
-        """Create a field test class object initial hook:
-        - Warnings related to resource usage are ignored
-        - Initialize the Apitable object
-        - Get action sheet
-        """
-        warnings.simplefilter("ignore", ResourceWarning)
-        apitable = Apitable(TOKEN)
-        apitable.set_api_base(DOMAIN)
-        self.dst = apitable.space(SPACE_ID).datasheet(DATASHEET_ID)
-        self.field = None
-
-    def test_field_create(self):
-        """Field Creation SDK Test"""
-        req_data = {
-            "type": "SingleText",
-            "name": "test_field_create",
-            "property": {"defaultValue": "hello apitable"},
-        }
-        self.field = self.dst.fields.create(req_data)
-        self.assertIsNotNone(self.field.id)
-        self.assertEqual(self.field.name, "test_field_create")
-
-    def tearDown(self):
-        """Create a field test class object to destroy the hook:
-        - Delete test created fields
-        """
-        self.dst.fields.delete(self.field.id)
-
-
-if __name__ == "__main__":
-    unittest.main()