ai-cr 3.2.1__py3-none-any.whl → 3.3.0__py3-none-any.whl

gito/env.py

@@ -1,7 +1,8 @@
-from importlib.metadata import version
-
-
-class Env:
-    logging_level: int = 1
-    verbosity: int = 1
-    gito_version: str = version("gito.bot")
+from importlib.metadata import version
+
+
+class Env:
+    logging_level: int = 1
+    verbosity: int = 1
+    gito_version: str = version("gito.bot")
+    working_folder = "."

gito/gh_api.py

@@ -1,116 +1,116 @@
-import os
-import logging
-
-import requests
-import git
-from fastcore.basics import AttrDict  # objects returned by ghapi
-from ghapi.core import GhApi
-
-from .project_config import ProjectConfig
-from .utils import extract_gh_owner_repo
-
-
-def gh_api(
-    repo: git.Repo = None,  # used to resolve owner/repo
-    config: ProjectConfig | None = None,  # used to resolve owner/repo
-    token: str | None = None
-) -> GhApi:
-    if repo:
-        # resolve owner/repo from repo.remotes.origin.url
-        owner, repo_name = extract_gh_owner_repo(repo)
-    else:
-        if not config:
-            config = ProjectConfig.load()
-        # resolve owner/repo from github env vars (github actions)
-        gh_env = config.prompt_vars.get("github_env", {})
-        gh_repo = gh_env.get("github_repo")
-        if not gh_repo:
-            raise ValueError("GitHub repository not specified and not found in project config.")
-        parts = gh_repo.split('/')
-        if len(parts) != 2:
-            raise ValueError(f"Invalid GitHub repository format: {gh_repo}. Expected 'owner/repo'.")
-        owner, repo_name = parts
-
-    token = resolve_gh_token(token)
-    api = GhApi(owner, repo_name, token=token)
-    return api
-
-
-def resolve_gh_token(token_or_none: str | None = None) -> str | None:
-    return token_or_none or os.getenv("GITHUB_TOKEN", None) or os.getenv("GH_TOKEN", None)
-
-
-def post_gh_comment(
-    gh_repository: str,  # e.g. "owner/repo"
-    pr_or_issue_number: int,
-    gh_token: str,
-    text: str,
-) -> bool:
-    """
-    Post a comment to a GitHub pull request or issue.
-    Arguments:
-        gh_repository (str): The GitHub repository in the format "owner/repo".
-        pr_or_issue_number (int): The pull request or issue number.
-        gh_token (str): GitHub personal access token with permissions to post comments.
-        text (str): The comment text to post.
-    Returns:
-        True if the comment was posted successfully, False otherwise.
-    """
-    api_url = f"https://api.github.com/repos/{gh_repository}/issues/{pr_or_issue_number}/comments"
-    headers = {
-        "Authorization": f"token {gh_token}",
-        "Accept": "application/vnd.github+json",
-    }
-    data = {"body": text}
-
-    resp = requests.post(api_url, headers=headers, json=data)
-    if 200 <= resp.status_code < 300:
-        logging.info(f"Posted review comment to #{pr_or_issue_number} in {gh_repository}")
-        return True
-    else:
-        logging.error(f"Failed to post comment: {resp.status_code} {resp.reason}\n{resp.text}")
-        return False
-
-
-def hide_gh_comment(
-    comment: dict | str,
-    token: str = None,
-    reason: str = "OUTDATED"
-) -> bool:
-    """
-    Hide a GitHub comment using GraphQL API with specified reason.
-    Args:
-        comment (dict | str):
-            The comment to hide,
-            either as a object returned from ghapi or a string node ID.
-            note: comment.id is not the same as node_id.
-        token (str): GitHub personal access token with permissions to minimize comments.
-        reason (str): The reason for hiding the comment, e.g., "OUTDATED".
-    """
-    comment_node_id = comment.node_id if isinstance(comment, AttrDict) else comment
-    token = resolve_gh_token(token)
-    mutation = """
-    mutation($commentId: ID!, $reason: ReportedContentClassifiers!) {
-        minimizeComment(input: {subjectId: $commentId, classifier: $reason}) {
-            minimizedComment { isMinimized }
-        }
-    }"""
-
-    response = requests.post(
-        "https://api.github.com/graphql",
-        headers={"Authorization": f"Bearer {token}"},
-        json={
-            "query": mutation,
-            "variables": {"commentId": comment_node_id, "reason": reason}
-        }
-    )
-    success = (
-        response.status_code == 200
-        and response.json().get("data", {}).get("minimizeComment") is not None
-    )
-    if not success:
-        logging.error(
-            f"Failed to hide comment {comment_node_id}: "
-            f"{response.status_code} {response.reason}\n{response.text}"
-        )
-    return success
+import os
+import logging
+
+import requests
+import git
+from fastcore.basics import AttrDict  # objects returned by ghapi
+from ghapi.core import GhApi
+
+from .project_config import ProjectConfig
+from .utils import extract_gh_owner_repo
+
+
+def gh_api(
+    repo: git.Repo = None,  # used to resolve owner/repo
+    config: ProjectConfig | None = None,  # used to resolve owner/repo
+    token: str | None = None
+) -> GhApi:
+    if repo:
+        # resolve owner/repo from repo.remotes.origin.url
+        owner, repo_name = extract_gh_owner_repo(repo)
+    else:
+        if not config:
+            config = ProjectConfig.load()
+        # resolve owner/repo from github env vars (github actions)
+        gh_env = config.prompt_vars.get("github_env", {})
+        gh_repo = gh_env.get("github_repo")
+        if not gh_repo:
+            raise ValueError("GitHub repository not specified and not found in project config.")
+        parts = gh_repo.split('/')
+        if len(parts) != 2:
+            raise ValueError(f"Invalid GitHub repository format: {gh_repo}. Expected 'owner/repo'.")
+        owner, repo_name = parts
+
+    token = resolve_gh_token(token)
+    api = GhApi(owner, repo_name, token=token)
+    return api
+
+
+def resolve_gh_token(token_or_none: str | None = None) -> str | None:
+    return token_or_none or os.getenv("GITHUB_TOKEN", None) or os.getenv("GH_TOKEN", None)
+
+
+def post_gh_comment(
+    gh_repository: str,  # e.g. "owner/repo"
+    pr_or_issue_number: int,
+    gh_token: str,
+    text: str,
+) -> bool:
+    """
+    Post a comment to a GitHub pull request or issue.
+    Arguments:
+        gh_repository (str): The GitHub repository in the format "owner/repo".
+        pr_or_issue_number (int): The pull request or issue number.
+        gh_token (str): GitHub personal access token with permissions to post comments.
+        text (str): The comment text to post.
+    Returns:
+        True if the comment was posted successfully, False otherwise.
+    """
+    api_url = f"https://api.github.com/repos/{gh_repository}/issues/{pr_or_issue_number}/comments"
+    headers = {
+        "Authorization": f"token {gh_token}",
+        "Accept": "application/vnd.github+json",
+    }
+    data = {"body": text}
+
+    resp = requests.post(api_url, headers=headers, json=data)
+    if 200 <= resp.status_code < 300:
+        logging.info(f"Posted review comment to #{pr_or_issue_number} in {gh_repository}")
+        return True
+    else:
+        logging.error(f"Failed to post comment: {resp.status_code} {resp.reason}\n{resp.text}")
+        return False
+
+
+def hide_gh_comment(
+    comment: dict | str,
+    token: str = None,
+    reason: str = "OUTDATED"
+) -> bool:
+    """
+    Hide a GitHub comment using GraphQL API with specified reason.
+    Args:
+        comment (dict | str):
+            The comment to hide,
+            either as a object returned from ghapi or a string node ID.
+            note: comment.id is not the same as node_id.
+        token (str): GitHub personal access token with permissions to minimize comments.
+        reason (str): The reason for hiding the comment, e.g., "OUTDATED".
+    """
+    comment_node_id = comment.node_id if isinstance(comment, AttrDict) else comment
+    token = resolve_gh_token(token)
+    mutation = """
+    mutation($commentId: ID!, $reason: ReportedContentClassifiers!) {
+        minimizeComment(input: {subjectId: $commentId, classifier: $reason}) {
+            minimizedComment { isMinimized }
+        }
+    }"""
+
+    response = requests.post(
+        "https://api.github.com/graphql",
+        headers={"Authorization": f"Bearer {token}"},
+        json={
+            "query": mutation,
+            "variables": {"commentId": comment_node_id, "reason": reason}
+        }
+    )
+    success = (
+        response.status_code == 200
+        and response.json().get("data", {}).get("minimizeComment") is not None
+    )
+    if not success:
+        logging.error(
+            f"Failed to hide comment {comment_node_id}: "
+            f"{response.status_code} {response.reason}\n{response.text}"
+        )
+    return success

gito/issue_trackers.py

@@ -1,50 +1,50 @@
-import logging
-import os
-import re
-from dataclasses import dataclass, field
-
-import git
-from gito.utils import is_running_in_github_action
-
-
-@dataclass
-class IssueTrackerIssue:
-    title: str = field(default="")
-    description: str = field(default="")
-    url: str = field(default="")
-
-
-def extract_issue_key(branch_name: str, min_len=2, max_len=10) -> str | None:
-    boundary = r'\b|_|-|/|\\'
-    pattern = fr"(?:{boundary})([A-Z][A-Z0-9]{{{min_len - 1},{max_len - 1}}}-\d+)(?:{boundary})"
-    match = re.search(pattern, branch_name)
-    return match.group(1) if match else None
-
-
-def get_branch(repo: git.Repo):
-    if is_running_in_github_action():
-        branch_name = os.getenv('GITHUB_HEAD_REF')
-        if branch_name:
-            return branch_name
-
-        github_ref = os.getenv('GITHUB_REF', '')
-        if github_ref.startswith('refs/heads/'):
-            return github_ref.replace('refs/heads/', '')
-    try:
-        branch_name = repo.active_branch.name
-        return branch_name
-    except Exception as e:  # @todo: specify more precise exception
-        logging.error("Could not determine the active branch name: %s", e)
-        return None
-
-
-def resolve_issue_key(repo: git.Repo):
-    branch_name = get_branch(repo)
-    if not branch_name:
-        logging.error("No active branch found in the repository, cannot determine issue key.")
-        return None
-
-    if not (issue_key := extract_issue_key(branch_name)):
-        logging.error(f"No issue key found in branch name: {branch_name}")
-        return None
-    return issue_key
+import logging
+import os
+import re
+from dataclasses import dataclass, field
+
+import git
+from gito.utils import is_running_in_github_action
+
+
+@dataclass
+class IssueTrackerIssue:
+    title: str = field(default="")
+    description: str = field(default="")
+    url: str = field(default="")
+
+
+def extract_issue_key(branch_name: str, min_len=2, max_len=10) -> str | None:
+    boundary = r'\b|_|-|/|\\'
+    pattern = fr"(?:{boundary})([A-Z][A-Z0-9]{{{min_len - 1},{max_len - 1}}}-\d+)(?:{boundary})"
+    match = re.search(pattern, branch_name)
+    return match.group(1) if match else None
+
+
+def get_branch(repo: git.Repo):
+    if is_running_in_github_action():
+        branch_name = os.getenv('GITHUB_HEAD_REF')
+        if branch_name:
+            return branch_name
+
+        github_ref = os.getenv('GITHUB_REF', '')
+        if github_ref.startswith('refs/heads/'):
+            return github_ref.replace('refs/heads/', '')
+    try:
+        branch_name = repo.active_branch.name
+        return branch_name
+    except Exception as e:  # @todo: specify more precise exception
+        logging.error("Could not determine the active branch name: %s", e)
+        return None
+
+
+def resolve_issue_key(repo: git.Repo):
+    branch_name = get_branch(repo)
+    if not branch_name:
+        logging.error("No active branch found in the repository, cannot determine issue key.")
+        return None
+
+    if not (issue_key := extract_issue_key(branch_name)):
+        logging.error(f"No issue key found in branch name: {branch_name}")
+        return None
+    return issue_key

gito/pipeline.py

@@ -1,83 +1,83 @@
-import logging
-from enum import StrEnum
-from dataclasses import dataclass, field
-
-from microcore import ui
-from microcore.utils import resolve_callable
-
-from .context import Context
-from .utils import is_running_in_github_action
-
-
-class PipelineEnv(StrEnum):
-    LOCAL = "local"
-    GH_ACTION = "gh-action"
-
-    @staticmethod
-    def all():
-        return [PipelineEnv.LOCAL, PipelineEnv.GH_ACTION]
-
-    @staticmethod
-    def current():
-        return (
-            PipelineEnv.GH_ACTION
-            if is_running_in_github_action()
-            else PipelineEnv.LOCAL
-        )
-
-
-@dataclass
-class PipelineStep:
-    call: str
-    envs: list[PipelineEnv] = field(default_factory=PipelineEnv.all)
-    enabled: bool = field(default=True)
-
-    def get_callable(self):
-        """
-        Resolve the callable from the string representation.
-        """
-        return resolve_callable(self.call)
-
-    def run(self, *args, **kwargs):
-        return self.get_callable()(*args, **kwargs)
-
-
-@dataclass
-class Pipeline:
-    ctx: Context = field()
-    steps: dict[str, PipelineStep] = field(default_factory=dict)
-    verbose: bool = False
-
-    @property
-    def enabled_steps(self):
-        return {
-            k: v for k, v in self.steps.items() if v.enabled
-        }
-
-    def run(self, *args, **kwargs):
-        cur_env = PipelineEnv.current()
-        logging.info("Running pipeline... [env: %s]", ui.yellow(cur_env))
-        for step_name, step in self.enabled_steps.items():
-            if cur_env in step.envs:
-                logging.info(f"Running pipeline step: {step_name}")
-                try:
-                    step_output = step.run(*args, **kwargs, **vars(self.ctx))
-                    if isinstance(step_output, dict):
-                        self.ctx.pipeline_out.update(step_output)
-                    self.ctx.pipeline_out[step_name] = step_output
-                    if self.verbose and step_output:
-                        logging.info(
-                            f"Pipeline step {step_name} output: {repr(step_output)}"
-                        )
-                    if not step_output:
-                        logging.warning(
-                            f'Pipeline step "{step_name}" returned {repr(step_output)}.'
-                        )
-                except Exception as e:
-                    logging.error(f'Error in pipeline step "{step_name}": {e}')
-            else:
-                logging.info(
-                    f"Skipping pipeline step: {step_name}"
-                    f" [env: {ui.yellow(cur_env)} not in {step.envs}]"
-                )
-        return self.ctx.pipeline_out
+import logging
+from enum import StrEnum
+from dataclasses import dataclass, field
+
+from microcore import ui
+from microcore.utils import resolve_callable
+
+from .context import Context
+from .utils import is_running_in_github_action
+
+
+class PipelineEnv(StrEnum):
+    LOCAL = "local"
+    GH_ACTION = "gh-action"
+
+    @staticmethod
+    def all():
+        return [PipelineEnv.LOCAL, PipelineEnv.GH_ACTION]
+
+    @staticmethod
+    def current():
+        return (
+            PipelineEnv.GH_ACTION
+            if is_running_in_github_action()
+            else PipelineEnv.LOCAL
+        )
+
+
+@dataclass
+class PipelineStep:
+    call: str
+    envs: list[PipelineEnv] = field(default_factory=PipelineEnv.all)
+    enabled: bool = field(default=True)
+
+    def get_callable(self):
+        """
+        Resolve the callable from the string representation.
+        """
+        return resolve_callable(self.call)
+
+    def run(self, *args, **kwargs):
+        return self.get_callable()(*args, **kwargs)
+
+
+@dataclass
+class Pipeline:
+    ctx: Context = field()
+    steps: dict[str, PipelineStep] = field(default_factory=dict)
+    verbose: bool = False
+
+    @property
+    def enabled_steps(self):
+        return {
+            k: v for k, v in self.steps.items() if v.enabled
+        }
+
+    def run(self, *args, **kwargs):
+        cur_env = PipelineEnv.current()
+        logging.info("Running pipeline... [env: %s]", ui.yellow(cur_env))
+        for step_name, step in self.enabled_steps.items():
+            if cur_env in step.envs:
+                logging.info(f"Running pipeline step: {step_name}")
+                try:
+                    step_output = step.run(*args, **kwargs, **vars(self.ctx))
+                    if isinstance(step_output, dict):
+                        self.ctx.pipeline_out.update(step_output)
+                    self.ctx.pipeline_out[step_name] = step_output
+                    if self.verbose and step_output:
+                        logging.info(
+                            f"Pipeline step {step_name} output: {repr(step_output)}"
+                        )
+                    if not step_output:
+                        logging.warning(
+                            f'Pipeline step "{step_name}" returned {repr(step_output)}.'
+                        )
+                except Exception as e:
+                    logging.error(f'Error in pipeline step "{step_name}": {e}')
+            else:
+                logging.info(
+                    f"Skipping pipeline step: {step_name}"
+                    f" [env: {ui.yellow(cur_env)} not in {step.envs}]"
+                )
+        return self.ctx.pipeline_out

gito/pipeline_steps/jira.py

@@ -1,62 +1,62 @@
-import logging
-import os
-
-import git
-from jira import JIRA, JIRAError
-
-from gito.issue_trackers import IssueTrackerIssue, resolve_issue_key
-
-
-def fetch_issue(issue_key, jira_url, username, api_token) -> IssueTrackerIssue | None:
-    try:
-        jira = JIRA(jira_url, basic_auth=(username, api_token))
-        issue = jira.issue(issue_key)
-        return IssueTrackerIssue(
-            title=issue.fields.summary,
-            description=issue.fields.description or "",
-            url=f"{jira_url.rstrip('/')}/browse/{issue_key}"
-        )
-    except JIRAError as e:
-        logging.error(
-            f"Failed to fetch Jira issue {issue_key}: code {e.status_code} :: {e.text}"
-        )
-        return None
-    except Exception as e:
-        logging.error(f"Failed to fetch Jira issue {issue_key}: {e}")
-        return None
-
-
-def fetch_associated_issue(
-    repo: git.Repo,
-    jira_url=None,
-    jira_username=None,
-    jira_api_token=None,
-    **kwargs
-):
-    """
-    Pipeline step to fetch a Jira issue based on the current branch name.
-    """
-    jira_url = jira_url or os.getenv("JIRA_URL")
-    jira_username = (
-        jira_username
-        or os.getenv("JIRA_USERNAME")
-        or os.getenv("JIRA_USER")
-        or os.getenv("JIRA_EMAIL")
-    )
-    jira_token = (
-        jira_api_token
-        or os.getenv("JIRA_API_TOKEN")
-        or os.getenv("JIRA_API_KEY")
-        or os.getenv("JIRA_TOKEN")
-    )
-    try:
-        assert jira_url, "JIRA_URL is not set"
-        assert jira_username, "JIRA_USERNAME is not set"
-        assert jira_token, "JIRA_API_TOKEN is not set"
-    except AssertionError as e:
-        logging.error(f"Jira configuration error: {e}")
-        return None
-    issue_key = resolve_issue_key(repo)
-    return dict(
-        associated_issue=fetch_issue(issue_key, jira_url, jira_username, jira_token)
-    ) if issue_key else None
+import logging
+import os
+
+import git
+from jira import JIRA, JIRAError
+
+from gito.issue_trackers import IssueTrackerIssue, resolve_issue_key
+
+
+def fetch_issue(issue_key, jira_url, username, api_token) -> IssueTrackerIssue | None:
+    try:
+        jira = JIRA(jira_url, basic_auth=(username, api_token))
+        issue = jira.issue(issue_key)
+        return IssueTrackerIssue(
+            title=issue.fields.summary,
+            description=issue.fields.description or "",
+            url=f"{jira_url.rstrip('/')}/browse/{issue_key}"
+        )
+    except JIRAError as e:
+        logging.error(
+            f"Failed to fetch Jira issue {issue_key}: code {e.status_code} :: {e.text}"
+        )
+        return None
+    except Exception as e:
+        logging.error(f"Failed to fetch Jira issue {issue_key}: {e}")
+        return None
+
+
+def fetch_associated_issue(
+    repo: git.Repo,
+    jira_url=None,
+    jira_username=None,
+    jira_api_token=None,
+    **kwargs
+):
+    """
+    Pipeline step to fetch a Jira issue based on the current branch name.
+    """
+    jira_url = jira_url or os.getenv("JIRA_URL")
+    jira_username = (
+        jira_username
+        or os.getenv("JIRA_USERNAME")
+        or os.getenv("JIRA_USER")
+        or os.getenv("JIRA_EMAIL")
+    )
+    jira_token = (
+        jira_api_token
+        or os.getenv("JIRA_API_TOKEN")
+        or os.getenv("JIRA_API_KEY")
+        or os.getenv("JIRA_TOKEN")
+    )
+    try:
+        assert jira_url, "JIRA_URL is not set"
+        assert jira_username, "JIRA_USERNAME is not set"
+        assert jira_token, "JIRA_API_TOKEN is not set"
+    except AssertionError as e:
+        logging.error(f"Jira configuration error: {e}")
+        return None
+    issue_key = resolve_issue_key(repo)
+    return dict(
+        associated_issue=fetch_issue(issue_key, jira_url, jira_username, jira_token)
+    ) if issue_key else None