mirror of https://github.com/hwchase17/langchain
You cannot select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
234 lines
8.5 KiB
Python
234 lines
8.5 KiB
Python
import base64
|
|
from abc import ABC
|
|
from datetime import datetime
|
|
from typing import Callable, Dict, Iterator, List, Literal, Optional, Union
|
|
|
|
import requests
|
|
from langchain_core.documents import Document
|
|
from langchain_core.pydantic_v1 import BaseModel, root_validator, validator
|
|
from langchain_core.utils import get_from_dict_or_env
|
|
|
|
from langchain_community.document_loaders.base import BaseLoader
|
|
|
|
|
|
class BaseGitHubLoader(BaseLoader, BaseModel, ABC):
|
|
"""Load `GitHub` repository Issues."""
|
|
|
|
repo: str
|
|
"""Name of repository"""
|
|
access_token: str
|
|
"""Personal access token - see https://github.com/settings/tokens?type=beta"""
|
|
github_api_url: str = "https://api.github.com"
|
|
"""URL of GitHub API"""
|
|
|
|
@root_validator(pre=True, allow_reuse=True)
|
|
def validate_environment(cls, values: Dict) -> Dict:
|
|
"""Validate that access token exists in environment."""
|
|
values["access_token"] = get_from_dict_or_env(
|
|
values, "access_token", "GITHUB_PERSONAL_ACCESS_TOKEN"
|
|
)
|
|
return values
|
|
|
|
@property
|
|
def headers(self) -> Dict[str, str]:
|
|
return {
|
|
"Accept": "application/vnd.github+json",
|
|
"Authorization": f"Bearer {self.access_token}",
|
|
}
|
|
|
|
|
|
class GitHubIssuesLoader(BaseGitHubLoader):
|
|
"""Load issues of a GitHub repository."""
|
|
|
|
include_prs: bool = True
|
|
"""If True include Pull Requests in results, otherwise ignore them."""
|
|
milestone: Union[int, Literal["*", "none"], None] = None
|
|
"""If integer is passed, it should be a milestone's number field.
|
|
If the string '*' is passed, issues with any milestone are accepted.
|
|
If the string 'none' is passed, issues without milestones are returned.
|
|
"""
|
|
state: Optional[Literal["open", "closed", "all"]] = None
|
|
"""Filter on issue state. Can be one of: 'open', 'closed', 'all'."""
|
|
assignee: Optional[str] = None
|
|
"""Filter on assigned user. Pass 'none' for no user and '*' for any user."""
|
|
creator: Optional[str] = None
|
|
"""Filter on the user that created the issue."""
|
|
mentioned: Optional[str] = None
|
|
"""Filter on a user that's mentioned in the issue."""
|
|
labels: Optional[List[str]] = None
|
|
"""Label names to filter one. Example: bug,ui,@high."""
|
|
sort: Optional[Literal["created", "updated", "comments"]] = None
|
|
"""What to sort results by. Can be one of: 'created', 'updated', 'comments'.
|
|
Default is 'created'."""
|
|
direction: Optional[Literal["asc", "desc"]] = None
|
|
"""The direction to sort the results by. Can be one of: 'asc', 'desc'."""
|
|
since: Optional[str] = None
|
|
"""Only show notifications updated after the given time.
|
|
This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ."""
|
|
page: Optional[int] = None
|
|
"""The page number for paginated results.
|
|
Defaults to 1 in the GitHub API."""
|
|
per_page: Optional[int] = None
|
|
"""Number of items per page.
|
|
Defaults to 30 in the GitHub API."""
|
|
|
|
@validator("since", allow_reuse=True)
|
|
def validate_since(cls, v: Optional[str]) -> Optional[str]:
|
|
if v:
|
|
try:
|
|
datetime.strptime(v, "%Y-%m-%dT%H:%M:%SZ")
|
|
except ValueError:
|
|
raise ValueError(
|
|
"Invalid value for 'since'. Expected a date string in "
|
|
f"YYYY-MM-DDTHH:MM:SSZ format. Received: {v}"
|
|
)
|
|
return v
|
|
|
|
def lazy_load(self) -> Iterator[Document]:
|
|
"""
|
|
Get issues of a GitHub repository.
|
|
|
|
Returns:
|
|
A list of Documents with attributes:
|
|
- page_content
|
|
- metadata
|
|
- url
|
|
- title
|
|
- creator
|
|
- created_at
|
|
- last_update_time
|
|
- closed_time
|
|
- number of comments
|
|
- state
|
|
- labels
|
|
- assignee
|
|
- assignees
|
|
- milestone
|
|
- locked
|
|
- number
|
|
- is_pull_request
|
|
"""
|
|
url: Optional[str] = self.url
|
|
while url:
|
|
response = requests.get(url, headers=self.headers)
|
|
response.raise_for_status()
|
|
issues = response.json()
|
|
for issue in issues:
|
|
doc = self.parse_issue(issue)
|
|
if not self.include_prs and doc.metadata["is_pull_request"]:
|
|
continue
|
|
yield doc
|
|
if (
|
|
response.links
|
|
and response.links.get("next")
|
|
and (not self.page and not self.per_page)
|
|
):
|
|
url = response.links["next"]["url"]
|
|
else:
|
|
url = None
|
|
|
|
def parse_issue(self, issue: dict) -> Document:
|
|
"""Create Document objects from a list of GitHub issues."""
|
|
metadata = {
|
|
"url": issue["html_url"],
|
|
"title": issue["title"],
|
|
"creator": issue["user"]["login"],
|
|
"created_at": issue["created_at"],
|
|
"comments": issue["comments"],
|
|
"state": issue["state"],
|
|
"labels": [label["name"] for label in issue["labels"]],
|
|
"assignee": issue["assignee"]["login"] if issue["assignee"] else None,
|
|
"milestone": issue["milestone"]["title"] if issue["milestone"] else None,
|
|
"locked": issue["locked"],
|
|
"number": issue["number"],
|
|
"is_pull_request": "pull_request" in issue,
|
|
}
|
|
content = issue["body"] if issue["body"] is not None else ""
|
|
return Document(page_content=content, metadata=metadata)
|
|
|
|
@property
|
|
def query_params(self) -> str:
|
|
"""Create query parameters for GitHub API."""
|
|
labels = ",".join(self.labels) if self.labels else self.labels
|
|
query_params_dict = {
|
|
"milestone": self.milestone,
|
|
"state": self.state,
|
|
"assignee": self.assignee,
|
|
"creator": self.creator,
|
|
"mentioned": self.mentioned,
|
|
"labels": labels,
|
|
"sort": self.sort,
|
|
"direction": self.direction,
|
|
"since": self.since,
|
|
"page": self.page,
|
|
"per_page": self.per_page,
|
|
}
|
|
query_params_list = [
|
|
f"{k}={v}" for k, v in query_params_dict.items() if v is not None
|
|
]
|
|
query_params = "&".join(query_params_list)
|
|
return query_params
|
|
|
|
@property
|
|
def url(self) -> str:
|
|
"""Create URL for GitHub API."""
|
|
return f"{self.github_api_url}/repos/{self.repo}/issues?{self.query_params}"
|
|
|
|
|
|
class GithubFileLoader(BaseGitHubLoader, ABC):
|
|
"""Load GitHub File"""
|
|
|
|
file_extension: str = ".md"
|
|
branch: str = "main"
|
|
|
|
file_filter: Optional[Callable[[str], bool]]
|
|
|
|
def get_file_paths(self) -> List[Dict]:
|
|
base_url = (
|
|
f"{self.github_api_url}/repos/{self.repo}/git/trees/"
|
|
f"{self.branch}?recursive=1"
|
|
)
|
|
response = requests.get(base_url, headers=self.headers)
|
|
response.raise_for_status()
|
|
all_files = response.json()["tree"]
|
|
""" one element in all_files
|
|
{
|
|
'path': '.github',
|
|
'mode': '040000',
|
|
'type': 'tree',
|
|
'sha': '5dc46e6b38b22707894ced126270b15e2f22f64e',
|
|
'url': 'https://api.github.com/repos/langchain-ai/langchain/git/blobs/5dc46e6b38b22707894ced126270b15e2f22f64e'
|
|
}
|
|
"""
|
|
return [
|
|
f
|
|
for f in all_files
|
|
if not (self.file_filter and not self.file_filter(f["path"]))
|
|
]
|
|
|
|
def get_file_content_by_path(self, path: str) -> str:
|
|
base_url = f"{self.github_api_url}/repos/{self.repo}/contents/{path}"
|
|
response = requests.get(base_url, headers=self.headers)
|
|
response.raise_for_status()
|
|
|
|
if isinstance(response.json(), dict):
|
|
content_encoded = response.json()["content"]
|
|
return base64.b64decode(content_encoded).decode("utf-8")
|
|
|
|
return ""
|
|
|
|
def lazy_load(self) -> Iterator[Document]:
|
|
files = self.get_file_paths()
|
|
for file in files:
|
|
content = self.get_file_content_by_path(file["path"])
|
|
if content == "":
|
|
continue
|
|
|
|
metadata = {
|
|
"path": file["path"],
|
|
"sha": file["sha"],
|
|
"source": f"{self.github_api_url}/{self.repo}/{file['type']}/"
|
|
f"{self.branch}/{file['path']}",
|
|
}
|
|
yield Document(page_content=content, metadata=metadata)
|