shindan-cli 2.1.1__tar.gz → 2.2.1__tar.gz

{shindan_cli-2.1.1 → shindan_cli-2.2.1}/PKG-INFO

@@ -1,34 +1,34 @@
 Metadata-Version: 2.4
 Name: shindan-cli
-Version: 2.1.1
+Version: 2.2.1
 Summary: ShindanMaker (https://shindanmaker.com) CLI
 Project-URL: Repository, https://github.com/eggplants/shindan-cli
 Author-email: eggplants <w10776e8w@yahoo.co.jp>
-License: MIT
+License-Expression: MIT
 License-File: LICENSE
 Keywords: cli,shindanmaker
 Classifier: Development Status :: 3 - Alpha
 Classifier: License :: OSI Approved :: MIT License
 Classifier: Programming Language :: Python :: 3 :: Only
-Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
 Classifier: Typing :: Typed
-Requires-Python: <4,>=3.9
+Requires-Python: <4,>=3.10
 Requires-Dist: beautifulsoup4<5,>=4.12.3
 Requires-Dist: cloudscraper<2,>=1.2.71
-Requires-Dist: lxml<6,>=5.3
+Requires-Dist: lxml<7,>=5.3
 Requires-Dist: requests<3,>=2.32.3
 Description-Content-Type: text/markdown
 
 # shindan-cli
 
-[![Test](
-  <https://github.com/eggplants/shindan-cli/actions/workflows/test.yml/badge.svg>
+[![CI](
+  <https://github.com/eggplants/shindan-cli/actions/workflows/ci.yml/badge.svg>
 )](
-  <https://github.com/eggplants/shindan-cli/actions/workflows/test.yml>
+  <https://github.com/eggplants/shindan-cli/actions/workflows/ci.yml>
 ) [![Release Package](
   <https://github.com/eggplants/shindan-cli/actions/workflows/release.yml/badge.svg>
 )](
@@ -43,16 +43,6 @@ Description-Content-Type: text/markdown
   <https://pypi.org/project/shindan-cli>
 )
 
-[![Maintainability](
-  <https://qlty.sh/badges/9e2de2a6-51c0-4797-bc60-da4a2ff28737/maintainability.svg>
-  )](
-  <https://qlty.sh/gh/eggplants/projects/shindan-cli>
-) [![Code Coverage](
-  <https://qlty.sh/badges/9e2de2a6-51c0-4797-bc60-da4a2ff28737/test_coverage.svg>
-  )](
-  <https://qlty.sh/gh/eggplants/projects/shindan-cli>
-)
-
 ShindanMaker (診断メーカー, <https://shindanmaker.com>) CLI + Library
 
 ## Install

{shindan_cli-2.1.1 → shindan_cli-2.2.1}/README.md

@@ -1,9 +1,9 @@
 # shindan-cli
 
-[![Test](
-  <https://github.com/eggplants/shindan-cli/actions/workflows/test.yml/badge.svg>
+[![CI](
+  <https://github.com/eggplants/shindan-cli/actions/workflows/ci.yml/badge.svg>
 )](
-  <https://github.com/eggplants/shindan-cli/actions/workflows/test.yml>
+  <https://github.com/eggplants/shindan-cli/actions/workflows/ci.yml>
 ) [![Release Package](
   <https://github.com/eggplants/shindan-cli/actions/workflows/release.yml/badge.svg>
 )](
@@ -18,16 +18,6 @@
   <https://pypi.org/project/shindan-cli>
 )
 
-[![Maintainability](
-  <https://qlty.sh/badges/9e2de2a6-51c0-4797-bc60-da4a2ff28737/maintainability.svg>
-  )](
-  <https://qlty.sh/gh/eggplants/projects/shindan-cli>
-) [![Code Coverage](
-  <https://qlty.sh/badges/9e2de2a6-51c0-4797-bc60-da4a2ff28737/test_coverage.svg>
-  )](
-  <https://qlty.sh/gh/eggplants/projects/shindan-cli>
-)
-
 ShindanMaker (診断メーカー, <https://shindanmaker.com>) CLI + Library
 
 ## Install

{shindan_cli-2.1.1 → shindan_cli-2.2.1}/pyproject.toml

@@ -1,6 +1,5 @@
 [build-system]
 build-backend = "hatchling.build"
-
 requires = [ "hatchling", "uv-dynamic-versioning" ]
 
 [project]
@@ -11,91 +10,72 @@ keywords = [
   "cli",
   "shindanmaker",
 ]
-license = { text = "MIT" }
+license = "MIT"
 authors = [ { name = "eggplants", email = "w10776e8w@yahoo.co.jp" } ]
-requires-python = ">=3.9,<4"
+requires-python = ">=3.10,<4"
 classifiers = [
   "Development Status :: 3 - Alpha",
   "License :: OSI Approved :: MIT License",
   "Programming Language :: Python :: 3 :: Only",
-  "Programming Language :: Python :: 3.9",
   "Programming Language :: Python :: 3.10",
   "Programming Language :: Python :: 3.11",
   "Programming Language :: Python :: 3.12",
   "Programming Language :: Python :: 3.13",
+  "Programming Language :: Python :: 3.14",
   "Typing :: Typed",
 ]
 dynamic = [ "version" ]
 dependencies = [
   "beautifulsoup4>=4.12.3,<5",
   "cloudscraper>=1.2.71,<2",
-  "lxml>=5.3,<6",
+  "lxml>=5.3,<7",
   "requests>=2.32.3,<3",
 ]
-
 urls.Repository = "https://github.com/eggplants/shindan-cli"
 scripts.shindan = "shindan_cli.main:main"
 
 [dependency-groups]
 dev = [
-  "lxml-stubs>=0.4,<0.6",
-  "mypy>=1.13,<2",
-  "pre-commit>=4.0.1,<5",
-  "pytest>=7.2.2,<9",
-  "pytest-cov>=4,<7",
-  "taskipy>=1.10.3,<2",
-  "types-beautifulsoup4>=4.11.6.7,<5",
-  "types-requests>=2.28.11.14,<3",
+  "pymarkdownlnt>=0.9.33",
+  "pyproject-fmt>=2.11.1",
+  "pytest>=9.0.2",
+  "pytest-asyncio>=1.3",
+  "pytest-cov>=7",
+]
+docs = [
+  "pdoc>=16",
 ]
-docs = [ "pdoc" ]
-
-[tool.hatch.version]
-# tool.hatch.version.source is not listed in official schema.
-# https://github.com/ninoseki/uv-dynamic-versioning/issues/21
-source = "uv-dynamic-versioning"
 
-[tool.hatch.build.targets.sdist]
-include = [ "shindan_cli" ]
+[tool.hatch]
+build.targets.sdist.include = [ "shindan_cli" ]
+build.targets.wheel.include = [ "shindan_cli" ]
+version.source = "uv-dynamic-versioning"
 
-[tool.hatch.build.targets.wheel]
-include = [ "shindan_cli" ]
+[tool.uv]
+python-downloads = "never"
+default-groups = [
+  "dev",
+  "docs",
+]
+exclude-newer = "P7D"
+preview = true
 
 [tool.ruff]
 line-length = 120
 format.indent-style = "space"
 format.quote-style = "double"
-lint.select = [
-  "ALL",
-]
+lint.select = [ "ALL" ]
 lint.ignore = [
-  "D203", # 1 blank line required before class docstring
-  "D213", # Multi-line docstring summary should start at the second line
+  "COM812",
+  "D203",   # 1 blank line required before class docstring
+  "D213",   # Multi-line docstring summary should start at the second line
 ]
 lint.per-file-ignores."tests/*.py" = [
   "D",
   "S101", # Use of assert detected
 ]
 
-[tool.mypy]
-pretty = true
-python_version = "3.9"
-show_error_codes = true
-strict = true
-
-[tool.uv]
-default-groups = [
-  "dev",
-  "docs",
-]
-
 [tool.uv-dynamic-versioning]
 vcs = "git"
 style = "semver"
-
-[tool.taskipy.tasks]
-lint = "pre-commit run -a"
-profile = "python -m cProfile"
-setup = "poetry install && pre-commit install -t pre-commit -t pre-push"
-test = "pytest --cov=shindan_cli --cov-report=term"
-"test:ci" = "task test --cov-report=xml:cov.xml"
-gendoc = "pdoc shindan_cli -o ./docs --docformat google"
+fallback-version = "0.0.0"

shindan_cli-2.2.1/shindan_cli/constants.py

@@ -0,0 +1,58 @@
+"""Constants for the shindan CLI."""
+
+from typing import Literal, TypedDict
+
+
+class AIParams(TypedDict):
+    _token: str
+    randname: str
+    type: Literal["ai"]
+    encrypted_exec_key: str
+
+
+class BranchParams(TypedDict):
+    _token: str
+    randname: str
+    type: Literal["branch"]
+    rbr: str
+
+
+class CheckParams(TypedDict):
+    _token: str
+    randname: str
+    type: Literal["check"]
+
+
+class NameParams(TypedDict):
+    _token: str
+    randname: str
+    type: Literal["name"]
+
+
+class TargetKeysByType(TypedDict):
+    ai: AIParams
+    branch: BranchParams
+    check: CheckParams
+    name: NameParams
+
+
+TARGET_KEYS_BY_TYPE = {
+    "ai": AIParams.__annotations__.keys(),
+    "branch": BranchParams.__annotations__.keys(),
+    "check": CheckParams.__annotations__.keys(),
+    "name": NameParams.__annotations__.keys(),
+}
+
+BASE_URL = "https://shindanmaker.com"
+
+HEADERS = {
+    "User-Agent": (
+        "Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36(KHTML, like Gecko) Chrome/123.0.0.0 Safari/537.36"
+    ),
+}
+
+__all__ = (
+    "BASE_URL",
+    "HEADERS",
+    "TARGET_KEYS_BY_TYPE",
+)

{shindan_cli-2.1.1 → shindan_cli-2.2.1}/shindan_cli/get_results.py

@@ -3,18 +3,22 @@
 from __future__ import annotations
 
 import re
-from typing import TYPE_CHECKING, Union
+import time
+from typing import TYPE_CHECKING, cast
 
 from bs4 import BeautifulSoup, Tag
 
-from .constants import BASE_URL, HEADERS
+from .constants import HEADERS, AIParams, BranchParams, CheckParams, NameParams
 
 if TYPE_CHECKING:
     from requests import Session
 
     from .models import ShindanResult, UserInputs
 
-Params = dict[str, Union[str, list[str], None]]
+Params = AIParams | BranchParams | CheckParams | NameParams
+
+_MAX_RETRIES = 3
+_RETRY_WAIT = 4.0
 
 
 def __get_result(
@@ -24,15 +28,23 @@ def __get_result(
     is_renewal: bool = False,
     shindan_url: str,
 ) -> ShindanResult:
-    result_page = session.post(
-        shindan_url + ("/r" if is_renewal else ""),
-        data=params,
-        headers=HEADERS,
-    )
-    soup = BeautifulSoup(result_page.text, features="lxml")
-    result_tag = soup.find(id="share-copytext-shindanresult-textarea")
+    result_tag: Tag | None = None
+
+    for attempt in range(_MAX_RETRIES):
+        if attempt > 0:
+            time.sleep(_RETRY_WAIT)
+        result_page = session.post(
+            shindan_url + ("/r" if is_renewal else ""),
+            data=params,
+            headers=HEADERS,
+        )
+        soup = BeautifulSoup(result_page.text, features="lxml")
+        found = soup.find(id="share-copytext-shindanresult-textarea")
+        if isinstance(found, Tag) and found.text:
+            result_tag = found
+            break
 
-    if not isinstance(result_tag, Tag) or not result_tag.text:
+    if result_tag is None:
         msg = f"Could not find a tag contains the result, returns: {result_tag}"
         raise TypeError(msg)
 
@@ -50,10 +62,11 @@ def __get_result(
 
 def get_result_by_ai(
     session: Session,
-    params: Params,
+    params: AIParams,
     *,
     user_inputs: UserInputs,
     hashtag: str | None,
+    csrf_token: str,
     shindan_url: str,
 ) -> ShindanResult:
     """Get result by AI type shindan.
@@ -63,34 +76,14 @@ def get_result_by_ai(
         params (Params): input parameters fetched from shindan page
         user_inputs (UserInputs): user inputs
         hashtag (str | None): hashtag
+        csrf_token (str): CSRF token extracted from the shindan page
         shindan_url (str): shindan url
 
     Returns:
         ShindanResult: the returned result from <https://shindanmaker.com>
 
     """
-    res = session.post(
-        shindan_url,
-        data=params,
-        headers=HEADERS,
-    )
-    meta = BeautifulSoup(
-        res.text,
-        features="lxml",
-    ).select_one('meta[name="csrf-token"]')
-    if not res.ok or not meta or not isinstance(csrf_token := meta.get("content"), str):
-        msg = f"Failed to get the csrf token. ({res.status_code})"
-        raise ValueError(msg)
-    HEADERS.update({"x-csrf-token": csrf_token})
-    if not res.ok:
-        res = session.post(
-            f"{BASE_URL}/ai_life_update",
-            data={"ai_life": 3},
-            headers=HEADERS,
-        )
-        if not res.ok:
-            msg = f"Failed to update AI life. ({res.status_code})"
-            raise ValueError(msg)
+    ai_headers = {**HEADERS, "x-csrf-token": csrf_token}
 
     result_sse = session.post(
         f"{shindan_url}/ai_result",
@@ -98,8 +91,9 @@ def get_result_by_ai(
             "form_values": user_inputs,
             "shindan_token": params["_token"],
             "ai_result_request_times": 0,
+            "encrypted_exec_key": params["encrypted_exec_key"],
         },
-        headers=HEADERS,
+        headers=ai_headers,
     )
     gpt_results = "".join(
         re.findall(r'"content":"([^"]+)', result_sse.text),
@@ -113,7 +107,7 @@ def get_result_by_ai(
 
 def get_result_by_branch(
     session: Session,
-    params: Params,
+    params: BranchParams,
     *,
     shindan_url: str,
 ) -> ShindanResult:
@@ -133,7 +127,7 @@ def get_result_by_branch(
 
 def get_result_by_check(
     session: Session,
-    params: Params,
+    params: CheckParams,
     *,
     user_choices: dict[int, str],
     shindan_url: str,
@@ -150,8 +144,9 @@ def get_result_by_check(
         ShindanResult: the returned result from <https://shindanmaker.com>
 
     """
+    check_params = cast("dict[str, str]", params)
     for choice_id, answer_id in user_choices.items():
-        params[f"input-check-choice[{choice_id}]"] = answer_id
+        check_params[f"input-check-choice[{choice_id}]"] = answer_id
 
     return __get_result(session, params, is_renewal=True, shindan_url=shindan_url)
 

{shindan_cli-2.1.1 → shindan_cli-2.2.1}/shindan_cli/interactive.py

@@ -4,10 +4,12 @@ from __future__ import annotations
 
 from typing import TYPE_CHECKING
 
+from shindan_cli.models import QuestionBranch, QuestionBranchChoice, QuestionChoice, QuestionChoiceChoice, UserInput
+
 if TYPE_CHECKING:
     from bs4 import BeautifulSoup
 
-    from .models import QuestionBranch, QuestionChoice, UserInput, UserInputs
+    from .models import UserInputs
 
 
 def get_user_inputs(
@@ -25,22 +27,19 @@ def get_user_inputs(
 
     """
     user_inputs: dict[str, UserInput] = {}
-    form_labels = source.select("form#shindanForm > div.px-3 > div > span")
+    form_labels = source.select("form#shindanForm label")
     for idx, question in enumerate([*form_labels, *range(10 - len(form_labels))]):
         if isinstance(question, int):
-            user_inputs[f"user_input_{idx + 1}"] = {"q": "", "a": None}
+            user_inputs[f"user_input_{idx + 1}"] = UserInput({"q": "", "a": None})
             continue
         question_text = question.text
         if question_text == "あなたの名前":
-            user_inputs[f"user_input_{idx + 1}"] = {
-                "q": question_text,
-                "a": shindan_name,
-            }
+            user_inputs[f"user_input_{idx + 1}"] = UserInput({"q": question_text, "a": shindan_name})
             continue
         answer_text = None
         while not answer_text:
             answer_text = input(f"[{question_text}]: ").strip()
-        user_inputs["user_input_{idx + 1}"] = {"q": question_text, "a": answer_text}
+        user_inputs[f"user_input_{idx + 1}"] = UserInput({"q": question_text, "a": answer_text})
     return user_inputs
 
 
@@ -60,17 +59,21 @@ def get_rbr(source: BeautifulSoup) -> str:
         question = branch.select_one("p.shindan_branch_question")
         if not isinstance(branch_id, str) or not question:
             continue
-        question_branches[branch_id.replace("shindan_branch_", "")] = {
-            "question": question.text.strip(),
-            "choices": [
-                {
-                    "label": choice.text,
-                    "next_branch_id": next_branch_id,
-                }
-                for choice in branch.select("button")
-                if isinstance(next_branch_id := choice.get("data-next_branch"), str)
-            ],
-        }
+        question_branches[branch_id.replace("shindan_branch_", "")] = QuestionBranch(
+            {
+                "question": question.text.strip(),
+                "choices": [
+                    QuestionBranchChoice(
+                        {
+                            "label": choice.text,
+                            "next_branch_id": next_branch_id,
+                        }
+                    )
+                    for choice in branch.select("button")
+                    if isinstance(next_branch_id := choice.get("data-next_branch"), str)
+                ],
+            }
+        )
 
     goal_branches: dict[str, str] = {}
     for branch in source.select("div[id^='shindan_branch_'][data-kind='1']"):
@@ -115,14 +118,16 @@ def get_choices(source: BeautifulSoup) -> dict[int, str]:
         question_text = question.select_one("div > p > span")
         if not isinstance(order_id, str) or not question_text:
             continue
-        question_choices[int(order_id)] = {
-            "question": question_text.text.strip(),
-            "choices": [
-                {"label": choice.text.strip(), "choice_id": choice_key}
-                for choice in question.select("button.list-group-item")
-                if isinstance(choice_key := choice.get("data-choice_key"), str)
-            ],
-        }
+        question_choices[int(order_id)] = QuestionChoice(
+            {
+                "question": question_text.text.strip(),
+                "choices": [
+                    QuestionChoiceChoice({"label": choice.text.strip(), "choice_id": choice_key})
+                    for choice in question.select("button.list-group-item")
+                    if isinstance(choice_key := choice.get("data-choice_key"), str)
+                ],
+            }
+        )
     current_question_id = 1
     total_questions = len(question_choices)
     answers: dict[int, str] = {}

{shindan_cli-2.1.1 → shindan_cli-2.2.1}/shindan_cli/shindan.py

@@ -4,13 +4,15 @@ from __future__ import annotations
 
 import random
 import time
+from typing import cast
 
 import cloudscraper  # type: ignore[unused-ignore,import-not-found,import-untyped]
 from bs4 import BeautifulSoup
-from requests import codes
+from requests.sessions import Session
 
 from .constants import BASE_URL, HEADERS, TARGET_KEYS_BY_TYPE
 from .get_results import (
+    Params,
     get_result_by_ai,
     get_result_by_branch,
     get_result_by_check,
@@ -53,9 +55,10 @@ def shindan(
     shindan_url = f"{BASE_URL}/{page_id}"
 
     session = cloudscraper.create_scraper()
+    assert isinstance(session, Session)  # noqa: S101
 
     shindan_page = session.get(shindan_url, headers=HEADERS)
-    if shindan_page.status_code != codes.ok:
+    if shindan_page.status_code != 200:  # noqa: PLR2004
         raise ShindanError(shindan_page.status_code)
 
     source = BeautifulSoup(shindan_page.text, features="lxml")
@@ -65,46 +68,54 @@ def shindan(
         msg = "Cannot detect shindan type!"
         raise ValueError(msg)
     shindan_type = str(shindan_type_input.get("value"))
-    params = {
-        key: key_input.get("value")
-        for key in TARGET_KEYS_BY_TYPE[shindan_type]
-        if (key_input := source.select_one(f'input[name="{key}"]'))
-    }
+    params = cast(
+        "Params",
+        {
+            key: key_input.get("value")
+            for key in TARGET_KEYS_BY_TYPE[shindan_type]
+            if (key_input := source.select_one(f'input[name="{key}"]'))
+        },
+    )
     # overwrite randname (old: shindanName)
     params["randname"] = shindan_name
 
     if wait:
         time.sleep(random.uniform(2, 5))  # noqa: S311
 
-    if shindan_type == "ai":
+    if params["type"] == "ai":
         hashtag_title = source.select_one("h1#shindanTitle")
         if not hashtag_title or not isinstance(
             hashtag := hashtag_title.get("data-shindan_hashtag"),
             str,
         ):
             hashtag = None
+        csrf_meta = source.select_one('meta[name="csrf-token"]')
+        if not csrf_meta or not isinstance(csrf_token := csrf_meta.get("content"), str):
+            msg = "Could not find CSRF token on the shindan page."
+            raise ShindanError(msg)
         return get_result_by_ai(
             session,
             params,
             user_inputs=get_user_inputs(source, shindan_name),
             hashtag=hashtag,
+            csrf_token=csrf_token,
             shindan_url=shindan_url,
         )
-    if shindan_type == "branch":
+    if params["type"] == "branch":
         params["rbr"] = get_rbr(source)
         return get_result_by_branch(
             session,
             params,
             shindan_url=shindan_url,
         )
-    if shindan_type == "check":
+    if params["type"] == "check":
         return get_result_by_check(
             session,
             params,
             user_choices=get_choices(source),
             shindan_url=shindan_url,
         )
-    if shindan_type == "name":
+    if params["type"] == "name":
         return get_result_by_name(
             session,
             params,

shindan_cli-2.1.1/shindan_cli/constants.py

@@ -1,23 +0,0 @@
-"""Constants for the shindan CLI."""
-
-TARGET_KEYS_BY_TYPE = {
-    "ai": ("_token", "randname", "type", "shindan_token"),
-    "branch": ("_token", "randname", "hiddenName", "type", "shindan_token", "rbr"),
-    "check": ("_token", "randname", "hiddenName", "type", "shindan_token"),
-    "name": ("_token", "randname", "hiddenName", "type", "shindan_token"),
-}
-
-BASE_URL = "https://shindanmaker.com"
-
-HEADERS = {
-    "User-Agent": (
-        "Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36"
-        "(KHTML, like Gecko) Chrome/123.0.0.0 Safari/537.36"
-    ),
-}
-
-__all__ = (
-    "BASE_URL",
-    "HEADERS",
-    "TARGET_KEYS_BY_TYPE",
-)