kci-confluence-cli 0.2.0__tar.gz → 0.3.0__tar.gz

{kci_confluence_cli-0.2.0 → kci_confluence_cli-0.3.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: kci-confluence-cli
-Version: 0.2.0
+Version: 0.3.0
 Summary: 来栖川電算が利用しているConfluence v6.15.7を操作するためのCLIです。
 Home-page: https://github.com/kurusugawa-computer/confluence-cli
 License: MIT

{kci_confluence_cli-0.2.0 → kci_confluence_cli-0.3.0}/confluence/__version__.py

@@ -1 +1 @@
-__version__ = "0.2.0"  # `poetry-dynamic-versioning`を使ってGitHubのバージョンタグを取得している。変更不要
+__version__ = "0.3.0"  # `poetry-dynamic-versioning`を使ってGitHubのバージョンタグを取得している。変更不要

{kci_confluence_cli-0.2.0 → kci_confluence_cli-0.3.0}/confluence/attachment/create_attachment.py

@@ -93,7 +93,11 @@ def add_arguments_to_parser(parser: argparse.ArgumentParser):  # noqa: ANN201
 
     parser.add_argument("--mime_type", type=str, help="ファイル名からMIMEタイプが判別できないときに、この値を添付ファイルのMIMEタイプとします。")
 
-    parser.add_argument("--allow_duplicated", action="store_true", help="指定した場合は、アップロード先にすでに同じファイルが存在している場合に上書きます。指定しない場合は、400 Errorが発生します。")
+    parser.add_argument(
+        "--allow_duplicated",
+        action="store_true",
+        help="指定した場合は、アップロード先にすでに同じファイルが存在している場合に上書きます。指定しない場合は、400 Errorが発生します。",
+    )
 
     parser.add_argument("--filename_pattern", help="glob形式のパターンに一致するファイル名だけアップロードします。(ex) '*.png'")
     parser.set_defaults(subcommand_func=main)

{kci_confluence_cli-0.2.0 → kci_confluence_cli-0.3.0}/confluence/attachment/delete_attachment.py

@@ -40,6 +40,7 @@ def main(args: argparse.Namespace) -> None:
     success_count = 0
 
     all_yes = False
+    yes = False
     for index, attachment in enumerate(results):
         attachment_id = attachment["id"]
         attachment_title = attachment["title"]

{kci_confluence_cli-0.2.0 → kci_confluence_cli-0.3.0}/confluence/common/api.py

@@ -146,8 +146,7 @@ class Api:
 
         https://docs.atlassian.com/ConfluenceServer/rest/6.15.7/#api/content-update
         """
-        headers = {"Content-Type": "application/json", "X-Atlassian-Token": "nocheck"}
-        return self._request("put", f"content/{content_id}", headers=headers, params=query_params, data=request_body).json()
+        return self._request("put", f"content/{content_id}", params=query_params, json=request_body).json()
 
     def delete_content(self, content_id: str, *, query_params: Optional[QueryParams] = None) -> None:
         """

{kci_confluence_cli-0.2.0 → kci_confluence_cli-0.3.0}/confluence/common/cli.py

@@ -141,11 +141,11 @@ def prompt_yesno(msg: str) -> bool:
 
     """
     while True:
-        choice = input(f"{msg} [y/N] : ")
+        choice = input(f"{msg} [y/n] : ")
         if choice == "y":
             return True
 
-        elif choice == "N":
+        elif choice == "n":
             return False
 
 
@@ -160,14 +160,14 @@ def prompt_yesnoall(msg: str) -> tuple[bool, bool]:
 
     """
     while True:
-        choice = input(f"{msg} [y/N/ALL] : ")
+        choice = input(f"{msg} [y/n/all] : ")
         if choice == "y":
             return True, False
 
-        elif choice == "N":
+        elif choice == "n":
             return False, False
 
-        elif choice == "ALL":
+        elif choice == "all":
             return True, True
 
 

{kci_confluence_cli-0.2.0 → kci_confluence_cli-0.3.0}/confluence/local/convert_html_to_xml.py

@@ -18,16 +18,11 @@ def convert_img_elm(img_elm: HtmlElement) -> None:
     `<img src="foo.png">`を以下のXMLに変換する
 
     ```
-    <ac:image ac:alt="aaaa" ac:border="true" ac:height="207" ac:title="aaaa" ac:width="240">
-    <ri:attachment ri:filename="image2023-2-16_11-24-17.png"/>
+    <ac:image>
+    <ri:attachment ri:filename="foo.png"/>
     </ac:image>
     ```
 
-
-    ```
-    <ac:image><ri:url ri:value="http://confluence.atlassian.com/images/logo/confluence_48_trans.png" /></ac:image>
-    ```
-
     Args:
         trim_dirname_for_src_value: src属性値からディレクトリ名を削除する。Confluenceにアップロードしたファイル名にスラッシュは含められないため。
     """
@@ -39,6 +34,10 @@ def convert_img_elm(img_elm: HtmlElement) -> None:
         url_elm.tag = "ri:url"
         url_elm.attrib["ri:value"] = src_value
         img_elm.append(url_elm)
+    elif src_value.startswith("data:"):
+        # Data URIには対応していないので、スキップする
+        logger.warning(f"img要素のsrc属性値はData URIが含まれていました。Confluence用のXMLはData URIに対応していません。 :: {img_elm}'")
+        return
     else:
         attachment_elm = fromstring("<ri:attachment/>")
         # コロン付きのタグが生成できないので、改めて置換した
@@ -49,17 +48,21 @@ def convert_img_elm(img_elm: HtmlElement) -> None:
         attachment_elm.attrib["ri:filename"] = tmp[-1]
 
         img_elm.append(attachment_elm)
-
+    del img_elm.attrib["src"]
+
+    # img要素のいくつかの属性を、`ac:image`タグの属性に変換する。
+    # https://ja.confluence.atlassian.com/doc/confluence-storage-format-790796544.html
+    # bool値を指定する以下の属性は変換しない
+    # ac:border, ac:thumbnail
+    for html_attribute_name in ("align", "class", "title", "style", "alt", "height", "width", "vspace", "hspace"):
+        attribute_value = img_elm.attrib.get(html_attribute_name)
+        if attribute_value is not None and attribute_value != "":
+            img_elm.attrib[f"ac:{html_attribute_name}"] = attribute_value
+            del img_elm.attrib[html_attribute_name]
+
+    # サムネイル画像として設定する（画像をクリックすると拡大表示される）
     img_elm.attrib["ac:thumbnail"] = "true"
 
-    alt_value: str = img_elm.attrib.get("alt")
-    if alt_value != "":
-        img_elm.attrib["ac:alt"] = alt_value
-
-    title_value: str = img_elm.attrib.get("title")
-    if title_value != "":
-        img_elm.attrib["ac:title"] = title_value
-
 
 def convert(input_html_file: Path, output_xml_file: Path) -> None:
     with input_html_file.open(encoding="utf-8") as f:
@@ -73,9 +76,11 @@ def convert(input_html_file: Path, output_xml_file: Path) -> None:
 
     # body要素があればその中身、なければhtmlファイルの中身をアップロードする
     if len(pq_html("body")) > 0:
+        # body要素以下のHTMLを取得する
         html_data = pq_html("body").html()
     else:
-        html_data = pq_html.html()
+        # 要素自身のHTMLを取得する
+        html_data = str(pq_html)
 
     output_xml_file.parent.mkdir(exist_ok=True, parents=True)
     output_xml_file.write_text(html_data, encoding="utf-8")

{kci_confluence_cli-0.2.0 → kci_confluence_cli-0.3.0}/confluence/page/subcommand.py

@@ -8,18 +8,17 @@ import confluence.page.get_page_body
 import confluence.page.update_page
 
 
-def add_arguments_to_parser(parser: argparse.ArgumentParser):  # noqa: ANN201
+def add_arguments_to_parser(parser: argparse.ArgumentParser) -> None:
     subparsers = parser.add_subparsers(dest="subcommand_name")
 
     # サブコマンドの定義
     confluence.page.get_page_body.add_parser(subparsers)
-    # 動かないのでコメントアウトする
-    # confluence.page.update_page.add_parser(subparsers)
+    confluence.page.update_page.add_parser(subparsers)
 
 
 def add_parser(subparsers: Optional[argparse._SubParsersAction] = None) -> argparse.ArgumentParser:
     subcommand_name = "page"
-    subcommand_help = "ページに関するサブコマンド"
+    subcommand_help = "ページまたはブログに関するサブコマンド"
 
     parser = confluence.common.cli.add_parser(subparsers, subcommand_name, subcommand_help, description=subcommand_help, is_subcommand=False)
     add_arguments_to_parser(parser)

kci_confluence_cli-0.3.0/confluence/page/update_page.py

@@ -0,0 +1,61 @@
+from __future__ import annotations
+
+import argparse
+import logging
+from pathlib import Path
+
+import confluence
+from confluence.common.cli import create_api_instance, prompt_yesno
+
+logger = logging.getLogger(__name__)
+
+
+def main(args: argparse.Namespace) -> None:
+    api = create_api_instance(args)
+    content_id = args.content_id
+    xml_file: Path = args.xml_file
+    comment = args.comment if args.comment is not None else "Updated via confluence-cli"
+    xml_text = xml_file.read_text(encoding="utf-8")
+
+    old_content = api.get_content_by_id(content_id, query_params={"expand": "version,ancestors,space,body.storage"})
+
+    content_title = args.title if args.title is not None else old_content["title"]
+    space_key = old_content["space"]["key"]
+    if not args.yes:
+        if not prompt_yesno(f"次のコンテンツを更新しますか？ :: content_id='{content_id}', title='{content_title}', space.key='{space_key}'"):
+            logger.info(f"コンテンツの更新をキャンセルしました。 content_id='{content_id}', title='{content_title}', space.key='{space_key}'")
+            return
+
+    request_body = {
+        "version": {"number": old_content["version"]["number"] + 1, "message": comment},
+        "title": content_title,
+        "type": old_content["type"],
+        "body": {"storage": {"value": xml_text, "representation": "storage"}},
+    }
+    _ = api.update_content(content_id, request_body=request_body)
+    logger.info(f"次のコンテンツを'{xml_file}'の内容で更新しました。 :: content_id='{content_id}', title='{content_title}', space.key='{space_key}'")
+
+
+def add_arguments_to_parser(parser: argparse.ArgumentParser) -> None:
+    parser.add_argument("-c", "--content_id", required=True, help="更新対象のコンテンツのID")
+    parser.add_argument(
+        "--xml_file",
+        required=True,
+        type=Path,
+        help="storageフォーマットで記載されたXMLファイルのパス。このファイルの内容でページ（またはブログ）が更新されます。",
+    )
+    parser.add_argument("--title", help="ページまたはブログの新しいタイトル。指定しない場合は既存のタイトルが維持されます。")
+    parser.add_argument("--comment", help="ページまたはブログを更新したときに残すコメント。")
+    parser.add_argument("--yes", action="store_true", help="すべてのプロンプトに自動的に'yes'と答え、非対話的に実行します。")
+
+    parser.set_defaults(subcommand_func=main)
+
+
+def add_parser(subparsers: argparse._SubParsersAction | None = None) -> argparse.ArgumentParser:
+    subcommand_name = "update"
+    subcommand_help = "ページまたはブログを更新します。"
+
+    parser = confluence.common.cli.add_parser(subparsers, subcommand_name, subcommand_help)
+
+    add_arguments_to_parser(parser)
+    return parser

{kci_confluence_cli-0.2.0 → kci_confluence_cli-0.3.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "kci-confluence-cli"
-version = "0.2.0"  # `poetry-dynamic-versioning`を使ってGitHubのバージョンタグを取得している。変更不要
+version = "0.3.0"  # `poetry-dynamic-versioning`を使ってGitHubのバージョンタグを取得している。変更不要
 description = "来栖川電算が利用しているConfluence v6.15.7を操作するためのCLIです。"
 authors = ["Kurusugawa Computer Inc."]
 license = "MIT"

kci_confluence_cli-0.2.0/confluence/page/update_page.py

@@ -1,49 +0,0 @@
-from __future__ import annotations
-
-import argparse
-import logging
-from pathlib import Path
-
-import confluence
-from confluence.common.cli import create_api_instance
-from confluence.common.utils import print_json
-
-logger = logging.getLogger(__name__)
-
-
-def main(args: argparse.Namespace) -> None:
-    api = create_api_instance(args)
-    content_id = args.content_id
-    xml_file: Path = args.xml_file
-    xml_text = xml_file.read_text(encoding="utf-8")
-
-    old_page = api.get_content_by_id(content_id, query_params={"expand": "version,ancestors,space,body.storage"})
-    print_json(old_page, is_pretty=True, output=None)
-    request_body = {
-        "version": {"number": old_page["version"]["number"] + 1, "message": ""},
-        "title": old_page["title"],
-        "type": old_page["type"],
-        "space": {"key": old_page["space"]["key"]},
-        "body": {"storage": {"value": xml_text, "representation": "storage"}},
-    }
-    result = api.update_content(content_id, request_body=request_body)
-    print_json(result, is_pretty=True, output=None)
-
-
-def add_arguments_to_parser(parser: argparse.ArgumentParser):  # noqa: ANN201
-    parser.add_argument("-c", "--content_id", required=True, help="取得対象のコンテンツのID")
-    parser.add_argument(
-        "--xml_file", required=True, type=Path, help="storageフォーマットで記載されたXMLファイルのパス。このファイルの内容でページが更新されます。"
-    )
-
-    parser.set_defaults(subcommand_func=main)
-
-
-def add_parser(subparsers: argparse._SubParsersAction | None = None) -> argparse.ArgumentParser:
-    subcommand_name = "update"
-    subcommand_help = "ページを更新します。"
-
-    parser = confluence.common.cli.add_parser(subparsers, subcommand_name, subcommand_help)
-
-    add_arguments_to_parser(parser)
-    return parser