pygitcode 0.1.2a0__tar.gz → 0.1.4__tar.gz

pygitcode-0.1.4/PKG-INFO

@@ -0,0 +1,110 @@
+Metadata-Version: 2.4
+Name: pygitcode
+Version: 0.1.4
+Summary: A CLI tool for GitCode (api.gitcode.com), modeled after GitHub CLI.
+Author-email: codeasier <825770651@qq.com>
+License-Expression: MIT
+Project-URL: Homepage, https://github.com/codeasier/gitcode-cli
+Project-URL: Documentation, https://github.com/codeasier/gitcode-cli#readme
+Project-URL: Repository, https://github.com/codeasier/gitcode-cli.git
+Project-URL: Issues, https://github.com/codeasier/gitcode-cli/issues
+Keywords: gitcode,cli,git,api,vcs,developer-tools
+Classifier: Development Status :: 4 - Beta
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+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: Topic :: Software Development :: Version Control :: Git
+Classifier: Topic :: Utilities
+Classifier: Typing :: Typed
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: click>=8.0
+Requires-Dist: httpx>=0.24
+Provides-Extra: dev
+Requires-Dist: pytest>=8.0; extra == "dev"
+Requires-Dist: pytest-cov>=5.0; extra == "dev"
+Requires-Dist: pytest-mock>=3.14; extra == "dev"
+Requires-Dist: respx>=0.21; extra == "dev"
+Requires-Dist: ruff>=0.6; extra == "dev"
+Requires-Dist: black>=24.0; extra == "dev"
+Requires-Dist: basedpyright>=1.19; extra == "dev"
+Requires-Dist: pre-commit>=3.0; extra == "dev"
+Dynamic: license-file
+
+# pygitcode
+
+> A CLI tool for [GitCode](https://gitcode.com/) (`api.gitcode.com`), modeled after GitHub CLI (`gh`).
+
+[![PyPI](https://img.shields.io/pypi/v/pygitcode)](https://pypi.org/project/pygitcode/)
+[![Python](https://img.shields.io/pypi/pyversions/pygitcode)](https://pypi.org/project/pygitcode/)
+[![License](https://img.shields.io/pypi/l/pygitcode)](https://github.com/codeasier/gitcode-cli/blob/main/LICENSE)
+
+English | [中文](README.zh-CN.md)
+
+For agent-assisted setup, usage, upgrades, or troubleshooting, read [docs/en/USING_WITH_AGENT.md](docs/en/USING_WITH_AGENT.md) first.
+
+## Installation
+
+```bash
+pip install pygitcode
+```
+
+This exposes both `gc` and `gitcode` commands in your shell.
+
+## Quick Start
+
+If you already know GitHub CLI (`gh`), you can start with the same familiar flows:
+
+```bash
+gc auth login
+gc issue list
+gc issue view 42
+gc pr list
+gc pr create --fill
+gc pr merge 42 --squash
+```
+
+Use `gitcode` instead of `gc` on Windows PowerShell because `gc` is a built-in alias for `Get-Content`.
+
+## Documentation
+
+- [Documentation index](docs/en/index.md)
+- [Development guide](docs/en/development.md)
+- [Compatibility notes](docs/en/gh-compatibility.md)
+
+## Repository Selection
+
+Commands operate on the current Git repository by default. You can also select a repository explicitly:
+
+```bash
+gc issue list -R owner/repo
+gc pr list -R owner/repo
+```
+
+## Authentication
+
+`gc` resolves tokens in this order:
+
+1. `--token` option
+2. `GC_TOKEN` environment variable
+3. `~/.config/gc/config.json`, written by `gc auth login`
+
+Useful commands:
+
+```bash
+gc auth login
+gc auth status
+gc auth token
+gc auth logout
+```
+
+## License
+
+MIT

pygitcode-0.1.4/README.md

@@ -0,0 +1,70 @@
+# pygitcode
+
+> A CLI tool for [GitCode](https://gitcode.com/) (`api.gitcode.com`), modeled after GitHub CLI (`gh`).
+
+[![PyPI](https://img.shields.io/pypi/v/pygitcode)](https://pypi.org/project/pygitcode/)
+[![Python](https://img.shields.io/pypi/pyversions/pygitcode)](https://pypi.org/project/pygitcode/)
+[![License](https://img.shields.io/pypi/l/pygitcode)](https://github.com/codeasier/gitcode-cli/blob/main/LICENSE)
+
+English | [中文](README.zh-CN.md)
+
+For agent-assisted setup, usage, upgrades, or troubleshooting, read [docs/en/USING_WITH_AGENT.md](docs/en/USING_WITH_AGENT.md) first.
+
+## Installation
+
+```bash
+pip install pygitcode
+```
+
+This exposes both `gc` and `gitcode` commands in your shell.
+
+## Quick Start
+
+If you already know GitHub CLI (`gh`), you can start with the same familiar flows:
+
+```bash
+gc auth login
+gc issue list
+gc issue view 42
+gc pr list
+gc pr create --fill
+gc pr merge 42 --squash
+```
+
+Use `gitcode` instead of `gc` on Windows PowerShell because `gc` is a built-in alias for `Get-Content`.
+
+## Documentation
+
+- [Documentation index](docs/en/index.md)
+- [Development guide](docs/en/development.md)
+- [Compatibility notes](docs/en/gh-compatibility.md)
+
+## Repository Selection
+
+Commands operate on the current Git repository by default. You can also select a repository explicitly:
+
+```bash
+gc issue list -R owner/repo
+gc pr list -R owner/repo
+```
+
+## Authentication
+
+`gc` resolves tokens in this order:
+
+1. `--token` option
+2. `GC_TOKEN` environment variable
+3. `~/.config/gc/config.json`, written by `gc auth login`
+
+Useful commands:
+
+```bash
+gc auth login
+gc auth status
+gc auth token
+gc auth logout
+```
+
+## License
+
+MIT

{pygitcode-0.1.2a0 → pygitcode-0.1.4}/pyproject.toml

@@ -46,10 +46,10 @@ dev = [
 ]
 
 [project.urls]
-Homepage = "https://github.com/yourusername/pygitcode"
-Documentation = "https://github.com/yourusername/pygitcode#readme"
-Repository = "https://github.com/yourusername/pygitcode.git"
-Issues = "https://github.com/yourusername/pygitcode/issues"
+Homepage = "https://github.com/codeasier/gitcode-cli"
+Documentation = "https://github.com/codeasier/gitcode-cli#readme"
+Repository = "https://github.com/codeasier/gitcode-cli.git"
+Issues = "https://github.com/codeasier/gitcode-cli/issues"
 
 [project.scripts]
 gc = "gitcode_cli.cli:main"
@@ -95,6 +95,7 @@ select = [
 ignore = [
     "PLR2004", # Magic value used in comparison
     "PLR0913", # Too many arguments in function definition (common for Click commands and API methods)
+    "PLR0917", # Too many positional arguments (common for Click commands and API methods)
 ]
 
 [tool.ruff.lint.per-file-ignores]

{pygitcode-0.1.2a0 → pygitcode-0.1.4}/src/gitcode_cli/__init__.py

@@ -1,3 +1,3 @@
 __all__ = ["__version__"]
 
-__version__ = "0.1.2a0"
+__version__ = "0.1.4"

pygitcode-0.1.4/src/gitcode_cli/adapters/__init__.py

@@ -0,0 +1,7 @@
+from __future__ import annotations
+
+from .base import AdapterActionResult
+from .issues import IssueAdapter
+from .pulls import PullRequestAdapter
+
+__all__ = ["AdapterActionResult", "IssueAdapter", "PullRequestAdapter"]

pygitcode-0.1.4/src/gitcode_cli/adapters/base.py

@@ -0,0 +1,14 @@
+from __future__ import annotations
+
+from dataclasses import dataclass
+from typing import Any
+
+
+@dataclass
+class AdapterActionResult:
+    item: dict[str, Any] | None = None
+    items: list[dict[str, Any]] | None = None
+    message: str | None = None
+    warning: str | None = None
+    degraded: bool = False
+    approximated: bool = False

pygitcode-0.1.4/src/gitcode_cli/adapters/capabilities.py

@@ -0,0 +1,36 @@
+from __future__ import annotations
+
+import click
+
+CAPABILITY_MESSAGES = {
+    "ISSUE_COMMENT_LAST_NOT_FOUND": "No editable issue comment from the current user was found.",
+    "ISSUE_COMMENT_OWNERSHIP_UNVERIFIABLE": (
+        "Unable to verify the current user's issue comments on GitCode; refusing to edit or delete comments safely."
+    ),
+    "ISSUE_CREATE_IF_NONE_REQUIRES_EDIT_LAST": "--create-if-none can only be used together with --edit-last.",
+    "ISSUE_DEVELOP_BASE": "--base and --name are not supported by 'gc issue develop'",
+    "ISSUE_DEVELOP_NAME": "--base and --name are not supported by 'gc issue develop'",
+    "ISSUE_LIST_APP": "GitCode issue API does not support --app filtering.",
+    "ISSUE_STATUS_GH_SEMANTICS": (
+        "GitCode-limited approximation of gh issue status: assigned and opened issues use user-level "
+        "GitCode results; mentioned issues use repository mention filtering."
+    ),
+    "PR_MERGE_AUTHOR_EMAIL": "GitCode merge API does not support --author-email.",
+    "PR_MERGE_AUTO": "GitCode merge API does not support --auto.",
+    "PR_EDIT_BASE": (
+        "GitCode's pull request update API does not support changing the base branch; "
+        "-B/--base cannot be used with 'gc pr edit'."
+    ),
+    "PR_REVIEW_REQUEST_CHANGES": (
+        "GitCode review API does not support request-changes reviews; the pull request comment was posted instead."
+    ),
+    "PR_STATUS_GH_SEMANTICS": ("GitCode API approximation -- user-specific filtering is not available"),
+}
+
+
+def capability_message(feature: str) -> str:
+    return CAPABILITY_MESSAGES[feature]
+
+
+def unsupported(feature: str) -> click.ClickException:
+    return click.ClickException(capability_message(feature))

pygitcode-0.1.4/src/gitcode_cli/adapters/issues.py

@@ -0,0 +1,373 @@
+from __future__ import annotations
+
+from typing import Any
+
+import click
+
+from ..errors import APIError
+from ..services import IssueService, UserService
+from .base import AdapterActionResult
+from .capabilities import capability_message
+
+
+def _normalize_multi_values(values: tuple[str, ...] | None) -> str | None:
+    if not values:
+        return None
+    return ",".join(values)
+
+
+def _normalize_labels(labels: tuple[str, ...] | None) -> tuple[str, ...] | None:
+    if not labels:
+        return None
+    normalized = tuple(label.strip() for label in labels if label.strip())
+    return normalized or None
+
+
+def _extract_label_names(issue: dict[str, Any] | None) -> list[str]:
+    labels = issue.get("labels") if isinstance(issue, dict) else None
+    if not labels:
+        return []
+    if isinstance(labels, str):
+        return [part.strip() for part in labels.split(",") if part.strip()]
+
+    names: list[str] = []
+    if isinstance(labels, list):
+        for label in labels:
+            if isinstance(label, dict):
+                name = label.get("name") or label.get("title")
+                if name:
+                    names.append(str(name))
+            elif label:
+                names.append(str(label))
+    return names
+
+
+def _extract_assignee_names(issue: dict[str, Any] | None) -> list[str]:
+    assignees = issue.get("assignees") if isinstance(issue, dict) else None
+    if isinstance(assignees, str):
+        return [part.strip() for part in assignees.split(",") if part.strip()]
+    if isinstance(assignees, list):
+        names: list[str] = []
+        for assignee in assignees:
+            if isinstance(assignee, dict):
+                name = _extract_login(assignee)
+                if name:
+                    names.append(name)
+            elif assignee:
+                names.append(str(assignee))
+        return names
+
+    assignee = issue.get("assignee") if isinstance(issue, dict) else None
+    if isinstance(assignee, str):
+        return [part.strip() for part in assignee.split(",") if part.strip()]
+    if isinstance(assignee, dict):
+        name = _extract_login(assignee)
+        return [name] if name else []
+    return []
+
+
+def _matches_all_labels(issue: dict[str, Any], labels: tuple[str, ...] | None) -> bool:
+    if not labels or len(labels) < 2:
+        return True
+    actual = {label.lower() for label in _extract_label_names(issue)}
+    return all(label.lower() in actual for label in labels)
+
+
+def _extract_login(data: dict[str, Any] | None) -> str | None:
+    if not isinstance(data, dict):
+        return None
+    for key in ("login", "username", "name"):
+        value = data.get(key)
+        if isinstance(value, str) and value.strip():
+            return value.strip()
+    user = data.get("user")
+    if isinstance(user, dict):
+        return _extract_login(user)
+    author = data.get("author")
+    if isinstance(author, dict):
+        return _extract_login(author)
+    return None
+
+
+def _as_list(items: Any) -> list[Any]:
+    return items if isinstance(items, list) else []
+
+
+def _extract_label_options(items: list[Any]) -> set[str]:
+    names: set[str] = set()
+    for item in items:
+        if not isinstance(item, dict):
+            continue
+        name = item.get("name")
+        if isinstance(name, str) and name.strip():
+            names.add(name.strip())
+    return names
+
+
+def _resolve_milestone_number(items: list[Any], milestone: str | None) -> int | None:
+    if milestone is None:
+        return None
+    value = milestone.strip()
+    if not value:
+        return None
+    if value.isdigit():
+        return int(value)
+    matches: list[int] = []
+    for item in items:
+        if not isinstance(item, dict):
+            continue
+        title = item.get("title")
+        number = item.get("number")
+        if title != value:
+            continue
+        if isinstance(number, int):
+            matches.append(number)
+        elif isinstance(number, str) and number.isdigit():
+            matches.append(int(number))
+    if len(matches) == 1:
+        return matches[0]
+    if len(matches) > 1:
+        raise click.ClickException(f"could not resolve milestone: '{value}' matched multiple milestones")
+    raise click.ClickException(f"could not resolve milestone: '{value}' not found")
+
+
+class IssueAdapter:
+    def __init__(self, service: IssueService, user_service: UserService | None = None):
+        self.service = service
+        self.user_service = user_service
+
+    def _list_all_labels(self, owner: str, repo: str) -> list[Any]:
+        items: list[Any] = []
+        page = 1
+        while True:
+            page_items = _as_list(self.service.list_labels(owner, repo, page=page, per_page=100))
+            items.extend(page_items)
+            if len(page_items) < 100:
+                return items
+            page += 1
+
+    def _list_all_milestones(self, owner: str, repo: str) -> list[Any]:
+        items: list[Any] = []
+        page = 1
+        while True:
+            page_items = _as_list(self.service.list_milestones(owner, repo, state="all", page=page, per_page=100))
+            items.extend(page_items)
+            if len(page_items) < 100:
+                return items
+            page += 1
+
+    def list_issues(
+        self,
+        owner: str,
+        repo: str,
+        *,
+        state: str | None,
+        labels: tuple[str, ...] | None,
+        author: str | None,
+        assignee: str | None,
+        milestone: str | None,
+        mention: str | None,
+        search: str | None,
+        limit: int | None,
+    ) -> Any:
+        if author == "@me":
+            if self.user_service is None:
+                raise click.ClickException("failed to resolve @me: current user lookup is unavailable")
+            current_login = _extract_login(self.user_service.current())
+            if not current_login:
+                raise click.ClickException("failed to resolve @me: current user has no login")
+            author = current_login
+        items = self.service.list(
+            owner,
+            repo,
+            state=state,
+            labels=_normalize_multi_values(labels),
+            creator=author,
+            assignee=assignee,
+            milestone=milestone,
+            mention=mention,
+            search=search,
+        )
+        if isinstance(items, list) and labels and len(labels) > 1:
+            items = [item for item in items if _matches_all_labels(item, labels)]
+        if limit is not None:
+            return items[:limit]
+        return items
+
+    def create_issue(
+        self,
+        owner: str,
+        repo: str,
+        *,
+        title: str,
+        body: str | None,
+        assignee: str | None,
+        labels: tuple[str, ...] | None,
+        milestone: str | None,
+    ) -> dict[str, Any] | None:
+        normalized_labels = _normalize_labels(labels)
+        if normalized_labels:
+            available_labels = _extract_label_options(self._list_all_labels(owner, repo))
+            for label in normalized_labels:
+                if label not in available_labels:
+                    raise click.ClickException(f"could not add label: '{label}' not found")
+        milestone_number = None
+        if milestone is not None:
+            milestones = []
+            if not milestone.strip().isdigit():
+                milestones = self._list_all_milestones(owner, repo)
+            milestone_number = _resolve_milestone_number(milestones, milestone)
+        return self.service.create(
+            owner,
+            repo,
+            title=title,
+            body=body,
+            assignee=assignee,
+            labels=_normalize_multi_values(normalized_labels),
+            milestone=milestone_number,
+        )
+
+    def close_issue(
+        self,
+        owner: str,
+        repo: str,
+        number: str,
+        *,
+        comment: str | None,
+        reason: str | None,
+    ) -> AdapterActionResult:
+        current = self.service.get(owner, repo, number)
+        if current and current.get("state") == "closed":
+            if comment:
+                self.service.comment(owner, repo, number, comment)
+                return AdapterActionResult(item=current, message="already_closed_commented")
+            return AdapterActionResult(item=current, message="already_closed")
+        if comment:
+            self.service.comment(owner, repo, number, comment)
+        payload: dict[str, Any] = {"state": "close"}
+        if reason:
+            payload["state_reason"] = reason
+        item = self.service.update(owner, repo, number, **payload)
+        return AdapterActionResult(item=item, message="closed")
+
+    def comment_issue(self, owner: str, repo: str, number: str, *, body: str) -> dict[str, Any] | None:
+        return self.service.comment(owner, repo, number, body)
+
+    def manage_comment_history(
+        self,
+        owner: str,
+        repo: str,
+        number: str,
+        *,
+        body: str | None,
+        delete_last: bool,
+        create_if_none: bool,
+    ) -> AdapterActionResult:
+        comment = self._find_last_owned_comment(owner, repo, number)
+        if delete_last:
+            if comment is None:
+                raise click.ClickException(capability_message("ISSUE_COMMENT_LAST_NOT_FOUND"))
+            self.service.delete_comment(owner, repo, comment["id"])
+            return AdapterActionResult(item=comment, message="deleted")
+        if comment is None:
+            if create_if_none:
+                item = self.service.comment(owner, repo, number, body or "")
+                return AdapterActionResult(item=item, message="created")
+            raise click.ClickException(capability_message("ISSUE_COMMENT_LAST_NOT_FOUND"))
+        item = self.service.update_comment(owner, repo, comment["id"], body or "")
+        return AdapterActionResult(item=item, message="edited")
+
+    def _find_last_owned_comment(self, owner: str, repo: str, number: str) -> dict[str, Any] | None:
+        if self.user_service is None:
+            raise click.ClickException(capability_message("ISSUE_COMMENT_OWNERSHIP_UNVERIFIABLE"))
+        try:
+            current_user = self.user_service.current()
+        except APIError as exc:
+            raise click.ClickException(capability_message("ISSUE_COMMENT_OWNERSHIP_UNVERIFIABLE")) from exc
+        current_login = _extract_login(current_user)
+        if not current_login:
+            raise click.ClickException(capability_message("ISSUE_COMMENT_OWNERSHIP_UNVERIFIABLE"))
+        comments = self.service.list_comments(owner, repo, number) or []
+        for comment in reversed(comments):
+            if not isinstance(comment, dict):
+                continue
+            if _extract_login(comment) == current_login:
+                return comment
+        return None
+
+    def reopen_issue(self, owner: str, repo: str, number: str, *, comment: str | None = None) -> AdapterActionResult:
+        current = self.service.get(owner, repo, number)
+        if current and current.get("state") == "open":
+            return AdapterActionResult(item=current, message="already_open")
+        item = self.service.update(owner, repo, number, state="reopen")
+        if comment:
+            self.service.comment(owner, repo, number, comment)
+        return AdapterActionResult(item=item, message="reopened")
+
+    def delete_issue(self, owner: str, repo: str, number: str) -> AdapterActionResult:
+        item = self.service.delete(owner, repo, number)
+        return AdapterActionResult(item=item, message="deleted")
+
+    def edit_issue(
+        self,
+        owner: str,
+        repo: str,
+        number: str,
+        *,
+        title: str | None,
+        body: str | None,
+        add_assignee: str | None,
+        add_labels: tuple[str, ...] | None,
+        remove_assignee: str | None,
+        remove_labels: tuple[str, ...] | None,
+        milestone: int | None,
+        remove_milestone: bool,
+    ) -> dict[str, Any] | None:
+        data: dict[str, Any] = {k: v for k, v in {"title": title, "body": body}.items() if v is not None}
+
+        if add_assignee is not None:
+            data["assignee"] = add_assignee
+        if remove_assignee is not None:
+            current = self.service.get(owner, repo, number)
+            remaining = [name for name in _extract_assignee_names(current) if name != remove_assignee]
+            data["assignee"] = ",".join(remaining)
+
+        if add_labels or remove_labels:
+            current = self.service.get(owner, repo, number)
+            existing = _extract_label_names(current)
+            removed = {label.strip() for label in remove_labels or () if label.strip()}
+            merged: list[str] = []
+            seen: set[str] = set()
+            for label in [*existing, *list(add_labels or ())]:
+                normalized = label.strip()
+                if normalized and normalized not in removed and normalized not in seen:
+                    seen.add(normalized)
+                    merged.append(normalized)
+            data["labels"] = ",".join(merged)
+
+        if milestone is not None:
+            data["milestone"] = milestone
+        if remove_milestone:
+            data["milestone"] = 0
+        return self.service.update(owner, repo, number, **data)
+
+    def status(self, owner: str, repo: str) -> AdapterActionResult:
+        if self.user_service is None:
+            raise click.ClickException("failed to resolve current user: current user lookup is unavailable")
+        current_login = _extract_login(self.user_service.current())
+        if not current_login:
+            raise click.ClickException("failed to resolve current user: current user has no login")
+        assigned = self.service.list_user_issues(filter="assigned", state="open") or []
+        created = self.service.list_user_issues(filter="created", state="open") or []
+        mentioned = self.service.list(owner, repo, state="open", mention=current_login) or []
+        return AdapterActionResult(
+            item={"assigned": assigned, "mentioned": mentioned, "createdBy": created},
+            message=capability_message("ISSUE_STATUS_GH_SEMANTICS"),
+            approximated=True,
+        )
+
+    def develop(self, owner: str, repo: str, number: str, *, base: str | None, name: str | None) -> AdapterActionResult:  # noqa: ARG002
+        return AdapterActionResult(
+            message=f"Opening issue #{number} in the browser instead.",
+            warning="Note: 'issue develop' does not create a local branch on GitCode.",
+        )