wikidot 3.1.0.dev2__tar.gz → 3.1.0.dev5__tar.gz

{wikidot-3.1.0.dev2/src/wikidot.egg-info → wikidot-3.1.0.dev5}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: wikidot
-Version: 3.1.0.dev2
+Version: 3.1.0.dev5
 Summary: Wikidot Utility Library
 Author-email: ukwhatn <ukwhatn@gmail.com>
 Project-URL: Homepage, https://github.com/ukwhatn/wikidot.py

{wikidot-3.1.0.dev2 → wikidot-3.1.0.dev5}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "wikidot"
-version = "3.1.0dev2"
+version = "3.1.0dev5"
 authors = [{ name = "ukwhatn", email = "ukwhatn@gmail.com" }]
 description = "Wikidot Utility Library"
 readme = "README.md"

{wikidot-3.1.0.dev2 → wikidot-3.1.0.dev5}/src/wikidot/common/exceptions.py

@@ -89,6 +89,13 @@ class NotFoundException(WikidotException):
         super().__init__(message)
 
 
+class TargetExistsException(WikidotException):
+    """対象が既に存在しているときの例外"""
+
+    def __init__(self, message):
+        super().__init__(message)
+
+
 class TargetErrorException(WikidotException):
     """メソッドの対象としたオブジェクトに操作が適用できないときの例外"""
 

{wikidot-3.1.0.dev2 → wikidot-3.1.0.dev5}/src/wikidot/module/page.py

@@ -629,3 +629,91 @@ class Page:
                 }
             ]
         )
+
+    @staticmethod
+    def create_or_edit(
+        site: "Site",
+        fullname: str,
+        page_id: int | None = None,
+        title: str = "",
+        source: str = "",
+        comment: str = "",
+        force_edit: bool = False,
+        raise_on_exists: bool = False,
+    ):
+        site.client.login_check()
+
+        # ページロックを取得しにいく
+        page_lock_request_body = {
+            "mode": "page",
+            "wiki_page": fullname,
+            "moduleName": "edit/PageEditModule",
+        }
+        if force_edit:
+            page_lock_request_body["force_lock"] = "yes"
+
+        page_lock_response = site.amc_request([page_lock_request_body])[0]
+        page_lock_response_data = page_lock_response.json()
+
+        if (
+            "locked" in page_lock_response_data
+            or "other_locks" in page_lock_response_data
+        ):
+            raise exceptions.TargetErrorException(
+                f"Page {fullname} is locked or other locks exist",
+            )
+
+        # ページが存在するか（page_revision_idがあるか）確認
+        is_exist = "page_revision_id" in page_lock_response_data
+
+        if raise_on_exists and is_exist:
+            raise exceptions.TargetExistsException(f"Page {fullname} already exists")
+
+        if is_exist and page_id is None:
+            raise ValueError("page_id must be specified when editing existing page")
+
+        # lock_idとlock_secret、page_revision_id（あれば）を取得
+        lock_id = page_lock_response_data["lock_id"]
+        lock_secret = page_lock_response_data["lock_secret"]
+        page_revision_id = page_lock_response_data.get("page_revision_id")
+
+        # ページの作成または編集
+        edit_request_body = {
+            "action": "WikiPageAction",
+            "event": "savePage",
+            "moduleName": "Empty",
+            "mode": "page",
+            "lock_id": lock_id,
+            "lock_secret": lock_secret,
+            "revision_id": page_revision_id if page_revision_id is not None else "",
+            "wiki_page": fullname,
+            "page_id": page_id if page_id is not None else "",
+            "title": title,
+            "source": source,
+            "comments": comment,
+        }
+        response = site.amc_request([edit_request_body])[0]
+
+        return response.json()
+
+    def edit(
+        self,
+        title: str = None,
+        source: str = None,
+        comment: str = None,
+        force_edit: bool = False,
+    ):
+        # Noneならそのままにする
+        title = title or self.title
+        source = source or self.source.wiki_text
+        comment = comment or ""
+
+        return Page.create_or_edit(
+            self.site,
+            self.fullname,
+            self.id,
+            title,
+            source,
+            comment,
+            force_edit,
+        )

{wikidot-3.1.0.dev2 → wikidot-3.1.0.dev5}/src/wikidot/module/site.py

@@ -7,12 +7,11 @@ import httpx
 from wikidot.common import exceptions
 from wikidot.common.decorators import login_required
 from wikidot.module.forum import Forum
-from wikidot.module.page import PageCollection, SearchPagesQuery
+from wikidot.module.page import Page, PageCollection, SearchPagesQuery
 from wikidot.module.site_application import SiteApplication
 
 if TYPE_CHECKING:
     from wikidot.module.client import Client
-    from wikidot.module.page import Page
     from wikidot.module.user import User
 
 
@@ -68,6 +67,39 @@ class SitePageMethods:
             return None
         return res[0]
 
+    def create(
+        self,
+        fullname: str,
+        title: str = "",
+        source: str = "",
+        comment: str = "",
+        force_edit: bool = False,
+    ) -> None:
+        """ページを作成する
+
+        Parameters
+        ----------
+        fullname: str
+            ページのフルネーム
+        title: str
+            ページのタイトル
+        source: str
+            ページのソース
+        comment: str
+            コメント
+        force_edit: bool
+            ページが存在する場合に上書きするかどうか
+        """
+        return Page.create_or_edit(
+            site=self.site,
+            fullname=fullname,
+            title=title,
+            source=source,
+            comment=comment,
+            force_edit=force_edit,
+            raise_on_exists=True,
+        )
+
 
 @dataclass
 class Site:

{wikidot-3.1.0.dev2 → wikidot-3.1.0.dev5/src/wikidot.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: wikidot
-Version: 3.1.0.dev2
+Version: 3.1.0.dev5
 Summary: Wikidot Utility Library
 Author-email: ukwhatn <ukwhatn@gmail.com>
 Project-URL: Homepage, https://github.com/ukwhatn/wikidot.py