Merge branch 'jamalex-master'

Author: Mario Hayashi

README.md

@@ -201,22 +201,58 @@ result = cv.build_query(sort=sort_params).execute()
 print("Sorted results, showing most valuable first:", result)
 ```
 
-Note: You can combine `filter`, `aggregate`, and `sort`. See more examples of queries by setting up complex views in Notion, and then inspecting `cv.get("query")`
+Note: You can combine `filter`, `aggregate`, and `sort`. See more examples of queries by setting up complex views in Notion, and then inspecting the full query: `cv.get("query2")`.
 
 You can also see [more examples in action in the smoke test runner](https://github.com/jamalex/notion-py/blob/master/notion/smoke_test.py). Run it using:
 
 ```sh
 python run_smoke_test.py --page [YOUR_NOTION_PAGE_URL] --token [YOUR_NOTION_TOKEN_V2]
 ```
 
-# _Quick plug: Learning Equality is hiring!_
+## Example: Lock/Unlock A Page
+```Python
+from notion.client import NotionClient
+
+# Obtain the `token_v2` value by inspecting your browser cookies on a logged-in session on Notion.so
+client = NotionClient(token_v2="<token_v2>")
+
+# Replace this URL with the URL of the page or database you want to edit
+page = client.get_block("https://www.notion.so/myorg/Test-c0d20a71c0944985ae96e661ccc99821")
+
+# The "locked" property is available on PageBlock and CollectionViewBlock objects
+# Set it to True to lock the page/database
+page.locked = True
+# and False to unlock it again
+page.locked = False
+```
+
+## Example: Set the current user for multi-account user
+
+```python
+from notion.client import NotionClient
+client = NotionClient(token_v2="<token_v2>")
+
+# The initial current_user of a multi-account user may be an unwanted user
+print(client.current_user.email) # → [email protected]
+
+# Set current_user to the desired user
+client.set_user_by_email('[email protected]')
+print(client.current_user.email) # → [email protected]
+
+# You can also set the current_user by uid.
+client.set_user_by_uid('<uid>')
+print(client.current_user.email) # → [email protected]
+```
+
+# _Quick plug: Learning Equality needs your support!_
 
-We're a [small nonprofit](https://learningequality.org/) with [global impact](https://learningequality.org/ka-lite/map/), building [exciting tech](https://learningequality.org/kolibri/)! We're currently [hiring](https://grnh.se/6epyi21) -- come join us!
+If you'd like to support notion-py development, please consider [donating to my open-source nonprofit, Learning Equality](https://learningequality.org/donate/), since when I'm not working on notion-py, it probably means I'm heads-down fundraising for our global education work (bringing resources like Khan Academy to communities with no Internet). COVID has further amplified needs, with over a billion kids stuck at home, and over half of them without the connectivity they need for distance learning. You can now also [support our work via GitHub Sponsors](https://github.com/sponsors/learningequality)!
 
 # Related Projects
 
 - [md2notion](https://github.com/Cobertos/md2notion): import Markdown files to Notion
 - [notion-export-ics](https://github.com/evertheylen/notion-export-ics): Export Notion Databases to ICS calendar files
+- [notion-tqdm](https://github.com/shunyooo/notion-tqdm): Progress Bar displayed in Notion like tqdm
 
 # TODO
 

notion/block.py

@@ -540,6 +540,24 @@ class PageBlock(BasicBlock):
         python_to_api=remove_signed_prefix_as_needed,
     )
 
+    locked = field_map("format.block_locked")
+
+    def get_backlinks(self):
+        """
+        Returns a list of blocks that referencing the current PageBlock. Note that only PageBlocks support backlinks.
+        """
+        data = self._client.post("getBacklinksForBlock", {"blockId": self.id}).json()
+        backlinks = []
+        for block in data.get("backlinks") or []:
+            mention = block.get("mentioned_from")
+            if not mention:
+                continue
+            block_id = mention.get("block_id") or mention.get("parent_block_id")
+            if block_id:
+                backlinks.append(self._client.get_block(block_id))
+        return backlinks
+
+
 class BulletedListBlock(BasicBlock):
 
     _type = "bulleted_list"
@@ -731,6 +749,8 @@ def description(self):
     def description(self, val):
         self.collection.description = val
 
+    locked = field_map("format.block_locked")
+
     def _str_fields(self):
         return super()._str_fields() + ["title", "collection"]
 

notion/client.py

@@ -8,6 +8,7 @@
 from urllib.parse import urljoin
 from requests.adapters import HTTPAdapter
 from requests.packages.urllib3.util.retry import Retry
+from getpass import getpass
 
 from .block import Block, BLOCK_TYPES
 from .collection import (
@@ -27,18 +28,29 @@
 from .utils import extract_id, now
 
 
-def create_session():
+def create_session(client_specified_retry=None):
     """
     retry on 502
     """
     session = Session()
-    retry = Retry(
-        5,
-        backoff_factor=0.3,
-        status_forcelist=(502,),
-        # CAUTION: adding 'POST' to this list which is not technically idempotent
-        method_whitelist=("POST", "HEAD", "TRACE", "GET", "PUT", "OPTIONS", "DELETE"),
-    )
+    if client_specified_retry:
+        retry = client_specified_retry
+    else:
+        retry = Retry(
+            5,
+            backoff_factor=0.3,
+            status_forcelist=(502, 503, 504),
+            # CAUTION: adding 'POST' to this list which is not technically idempotent
+            method_whitelist=(
+                "POST",
+                "HEAD",
+                "TRACE",
+                "GET",
+                "PUT",
+                "OPTIONS",
+                "DELETE",
+            ),
+        )
     adapter = HTTPAdapter(max_retries=retry)
     session.mount("https://", adapter)
     return session
@@ -51,9 +63,23 @@ class NotionClient(object):
     for internal use -- the main one you'll likely want to use is `get_block`.
     """
 
-    def __init__(self, token_v2=None, monitor=False, start_monitoring=False, enable_caching=False, cache_key=None):
-        self.session = create_session()
-        self.session.cookies = cookiejar_from_dict({"token_v2": token_v2})
+    def __init__(
+        self,
+        token_v2=None,
+        monitor=False,
+        start_monitoring=False,
+        enable_caching=False,
+        cache_key=None,
+        email=None,
+        password=None,
+        client_specified_retry=None,
+    ):
+        self.session = create_session(client_specified_retry)
+        if token_v2:
+            self.session.cookies = cookiejar_from_dict({"token_v2": token_v2})
+        else:
+            self._set_token(email=email, password=password)
+
         if enable_caching:
             cache_key = cache_key or hashlib.sha256(token_v2.encode()).hexdigest()
             self._store = RecordStore(self, cache_key=cache_key)
@@ -65,19 +91,69 @@ def __init__(self, token_v2=None, monitor=False, start_monitoring=False, enable_
                 self.start_monitoring()
         else:
             self._monitor = None
-        if token_v2:
-            self._update_user_info()
+
+        self._update_user_info()
 
     def start_monitoring(self):
         self._monitor.poll_async()
+    
+    def _fetch_guest_space_data(self, records):
+        """
+        guest users have an empty `space` dict, so get the space_id from the `space_view` dict instead,
+        and fetch the space data from the getPublicSpaceData endpoint.
+
+        Note: This mutates the records dict
+        """
+        space_id = list(records["space_view"].values())[0]["value"]["space_id"]
+
+        space_data = self.post(
+            "getPublicSpaceData", {"type": "space-ids", "spaceIds": [space_id]}
+        ).json()
+
+        records["space"] = {
+            space["id"]: {"value": space} for space in space_data["results"]
+        }
+
+
+    def _set_token(self, email=None, password=None):
+        if not email:
+            email = input("Enter your Notion email address:\n")
+        if not password:
+            password = getpass("Enter your Notion password:\n")
+        self.post("loginWithEmail", {"email": email, "password": password}).json()
 
     def _update_user_info(self):
         records = self.post("loadUserContent", {}).json()["recordMap"]
+        if not records["space"]:
+            self._fetch_guest_space_data(records)
+
         self._store.store_recordmap(records)
         self.current_user = self.get_user(list(records["notion_user"].keys())[0])
         self.current_space = self.get_space(list(records["space"].keys())[0])
         return records
 
+    def get_email_uid(self):
+        response = self.post("getSpaces", {}).json()
+        return {
+            response[uid]["notion_user"][uid]["value"]["email"]: uid
+            for uid in response.keys()
+        }
+
+    def set_user_by_uid(self, user_id):
+        self.session.headers.update({"x-notion-active-user-header": user_id})
+        self._update_user_info()
+
+    def set_user_by_email(self, email):
+        email_uid_dict = self.get_email_uid()
+        uid = email_uid_dict.get(email)
+        if not uid:
+            raise Exception(
+                "Requested email address {email} not found; available addresses: {available}".format(
+                    email=email, available=list(email_uid_dict)
+                )
+            )
+        self.set_user_by_uid(uid)
+
     def get_top_level_pages(self):
         records = self._update_user_info()
         return [self.get_block(bid) for bid in records["block"].keys()]
@@ -242,15 +318,47 @@ def search_pages_with_parent(self, parent_id, search=""):
         return response["results"]
 
     def search_blocks(self, search, limit=25):
+        return self.search(query=search, limit=limit)
+
+    def search(
+        self,
+        query="",
+        search_type="BlocksInSpace",
+        limit=100,
+        sort="Relevance",
+        source="quick_find",
+        isDeletedOnly=False,
+        excludeTemplates=False,
+        isNavigableOnly=False,
+        requireEditPermissions=False,
+        ancestors=[],
+        createdBy=[],
+        editedBy=[],
+        lastEditedTime={},
+        createdTime={},
+    ):
         data = {
-            "query": search,
-            "table": "space",
-            "id": self.current_space.id,
+            "type": search_type,
+            "query": query,
+            "spaceId": self.current_space.id,
             "limit": limit,
+            "filters": {
+                "isDeletedOnly": isDeletedOnly,
+                "excludeTemplates": excludeTemplates,
+                "isNavigableOnly": isNavigableOnly,
+                "requireEditPermissions": requireEditPermissions,
+                "ancestors": ancestors,
+                "createdBy": createdBy,
+                "editedBy": editedBy,
+                "lastEditedTime": lastEditedTime,
+                "createdTime": createdTime,
+            },
+            "sort": sort,
+            "source": source,
         }
-        response = self.post("searchBlocks", data).json()
+        response = self.post("search", data).json()
         self._store.store_recordmap(response["recordMap"])
-        return [self.get_block(block_id) for block_id in response["results"]]
+        return [self.get_block(result["id"]) for result in response["results"]]
 
     def create_record(self, table, parent, **kwargs):
 
@@ -263,7 +371,8 @@ def create_record(self, table, parent, **kwargs):
             "id": record_id,
             "version": 1,
             "alive": True,
-            "created_by": self.current_user.id,
+            "created_by_id": self.current_user.id,
+            "created_by_table": "notion_user",
             "created_time": now(),
             "parent_id": parent.id,
             "parent_table": parent._table,