Spaces:
Runtime error
Runtime error
File size: 11,686 Bytes
35b22df |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 |
"""
Github API client for the GPT-Index library.
This module contains the Github API client for the GPT-Index library.
It is used by the Github readers to retrieve the data from Github.
"""
import os
from dataclasses import dataclass
from typing import Any, Dict, List, Optional
from dataclasses_json import DataClassJsonMixin
@dataclass
class GitTreeResponseModel(DataClassJsonMixin):
"""
Dataclass for the response from the Github API's getTree endpoint.
Attributes:
- sha (str): SHA1 checksum ID of the tree.
- url (str): URL for the tree.
- tree (List[GitTreeObject]): List of objects in the tree.
- truncated (bool): Whether the tree is truncated.
Examples:
>>> tree = client.get_tree("owner", "repo", "branch")
>>> tree.sha
"""
@dataclass
class GitTreeObject(DataClassJsonMixin):
"""
Dataclass for the objects in the tree.
Attributes:
- path (str): Path to the object.
- mode (str): Mode of the object.
- type (str): Type of the object.
- sha (str): SHA1 checksum ID of the object.
- url (str): URL for the object.
- size (Optional[int]): Size of the object (only for blobs).
"""
path: str
mode: str
type: str
sha: str
url: str
size: Optional[int] = None
sha: str
url: str
tree: List[GitTreeObject]
truncated: bool
@dataclass
class GitBlobResponseModel(DataClassJsonMixin):
"""
Dataclass for the response from the Github API's getBlob endpoint.
Attributes:
- content (str): Content of the blob.
- encoding (str): Encoding of the blob.
- url (str): URL for the blob.
- sha (str): SHA1 checksum ID of the blob.
- size (int): Size of the blob.
- node_id (str): Node ID of the blob.
"""
content: str
encoding: str
url: str
sha: str
size: int
node_id: str
@dataclass
class GitCommitResponseModel(DataClassJsonMixin):
"""
Dataclass for the response from the Github API's getCommit endpoint.
Attributes:
- tree (Tree): Tree object for the commit.
"""
@dataclass
class Commit(DataClassJsonMixin):
"""Dataclass for the commit object in the commit. (commit.commit)."""
@dataclass
class Tree(DataClassJsonMixin):
"""
Dataclass for the tree object in the commit.
Attributes:
- sha (str): SHA for the commit
"""
sha: str
tree: Tree
commit: Commit
@dataclass
class GitBranchResponseModel(DataClassJsonMixin):
"""
Dataclass for the response from the Github API's getBranch endpoint.
Attributes:
- commit (Commit): Commit object for the branch.
"""
@dataclass
class Commit(DataClassJsonMixin):
"""Dataclass for the commit object in the branch. (commit.commit)."""
@dataclass
class Commit(DataClassJsonMixin):
"""Dataclass for the commit object in the commit. (commit.commit.tree)."""
@dataclass
class Tree(DataClassJsonMixin):
"""
Dataclass for the tree object in the commit.
Usage: commit.commit.tree.sha
"""
sha: str
tree: Tree
commit: Commit
commit: Commit
class GithubClient:
"""
An asynchronous client for interacting with the Github API.
This client is used for making API requests to Github.
It provides methods for accessing the Github API endpoints.
The client requires a Github token for authentication,
which can be passed as an argument or set as an environment variable.
If no Github token is provided, the client will raise a ValueError.
Examples:
>>> client = GithubClient("my_github_token")
>>> branch_info = client.get_branch("owner", "repo", "branch")
"""
DEFAULT_BASE_URL = "https://api.github.com"
DEFAULT_API_VERSION = "2022-11-28"
def __init__(
self,
github_token: Optional[str] = None,
base_url: str = DEFAULT_BASE_URL,
api_version: str = DEFAULT_API_VERSION,
verbose: bool = False,
) -> None:
"""
Initialize the GithubClient.
Args:
- github_token (str): Github token for authentication.
If not provided, the client will try to get it from
the GITHUB_TOKEN environment variable.
- base_url (str): Base URL for the Github API
(defaults to "https://api.github.com").
- api_version (str): Github API version (defaults to "2022-11-28").
Raises:
ValueError: If no Github token is provided.
"""
if github_token is None:
github_token = os.getenv("GITHUB_TOKEN")
if github_token is None:
raise ValueError(
"Please provide a Github token. "
+ "You can do so by passing it as an argument to the GithubReader,"
+ "or by setting the GITHUB_TOKEN environment variable."
)
self._base_url = base_url
self._api_version = api_version
self._verbose = verbose
self._endpoints = {
"getTree": "/repos/{owner}/{repo}/git/trees/{tree_sha}",
"getBranch": "/repos/{owner}/{repo}/branches/{branch}",
"getBlob": "/repos/{owner}/{repo}/git/blobs/{file_sha}",
"getCommit": "/repos/{owner}/{repo}/commits/{commit_sha}",
}
self._headers = {
"Accept": "application/vnd.github+json",
"Authorization": f"Bearer {github_token}",
"X-GitHub-Api-Version": f"{self._api_version}",
}
def get_all_endpoints(self) -> Dict[str, str]:
"""Get all available endpoints."""
return {**self._endpoints}
async def request(
self,
endpoint: str,
method: str,
headers: Dict[str, Any] = {},
**kwargs: Any,
) -> Any:
"""
Make an API request to the Github API.
This method is used for making API requests to the Github API.
It is used internally by the other methods in the client.
Args:
- `endpoint (str)`: Name of the endpoint to make the request to.
- `method (str)`: HTTP method to use for the request.
- `headers (dict)`: HTTP headers to include in the request.
- `**kwargs`: Keyword arguments to pass to the endpoint URL.
Returns:
- `response (httpx.Response)`: Response from the API request.
Raises:
- ImportError: If the `httpx` library is not installed.
- httpx.HTTPError: If the API request fails.
Examples:
>>> response = client.request("getTree", "GET",
owner="owner", repo="repo",
tree_sha="tree_sha")
"""
try:
import httpx
except ImportError:
raise ImportError(
"Please install httpx to use the GithubRepositoryReader. "
"You can do so by running `pip install httpx`."
)
_headers = {**self._headers, **headers}
_client: httpx.AsyncClient
async with httpx.AsyncClient(
headers=_headers, base_url=self._base_url
) as _client:
try:
response = await _client.request(
method, url=self._endpoints[endpoint].format(**kwargs)
)
except httpx.HTTPError as excp:
print(f"HTTP Exception for {excp.request.url} - {excp}")
raise excp
return response
async def get_branch(
self, owner: str, repo: str, branch: str
) -> GitBranchResponseModel:
"""
Get information about a branch. (Github API endpoint: getBranch).
Args:
- `owner (str)`: Owner of the repository.
- `repo (str)`: Name of the repository.
- `branch (str)`: Name of the branch.
Returns:
- `branch_info (GitBranchResponseModel)`: Information about the branch.
Examples:
>>> branch_info = client.get_branch("owner", "repo", "branch")
"""
return GitBranchResponseModel.from_json(
(
await self.request(
"getBranch", "GET", owner=owner, repo=repo, branch=branch
)
).text
)
async def get_tree(
self, owner: str, repo: str, tree_sha: str
) -> GitTreeResponseModel:
"""
Get information about a tree. (Github API endpoint: getTree).
Args:
- `owner (str)`: Owner of the repository.
- `repo (str)`: Name of the repository.
- `tree_sha (str)`: SHA of the tree.
Returns:
- `tree_info (GitTreeResponseModel)`: Information about the tree.
Examples:
>>> tree_info = client.get_tree("owner", "repo", "tree_sha")
"""
return GitTreeResponseModel.from_json(
(
await self.request(
"getTree", "GET", owner=owner, repo=repo, tree_sha=tree_sha
)
).text
)
async def get_blob(
self, owner: str, repo: str, file_sha: str
) -> GitBlobResponseModel:
"""
Get information about a blob. (Github API endpoint: getBlob).
Args:
- `owner (str)`: Owner of the repository.
- `repo (str)`: Name of the repository.
- `file_sha (str)`: SHA of the file.
Returns:
- `blob_info (GitBlobResponseModel)`: Information about the blob.
Examples:
>>> blob_info = client.get_blob("owner", "repo", "file_sha")
"""
return GitBlobResponseModel.from_json(
(
await self.request(
"getBlob", "GET", owner=owner, repo=repo, file_sha=file_sha
)
).text
)
async def get_commit(
self, owner: str, repo: str, commit_sha: str
) -> GitCommitResponseModel:
"""
Get information about a commit. (Github API endpoint: getCommit).
Args:
- `owner (str)`: Owner of the repository.
- `repo (str)`: Name of the repository.
- `commit_sha (str)`: SHA of the commit.
Returns:
- `commit_info (GitCommitResponseModel)`: Information about the commit.
Examples:
>>> commit_info = client.get_commit("owner", "repo", "commit_sha")
"""
return GitCommitResponseModel.from_json(
(
await self.request(
"getCommit", "GET", owner=owner, repo=repo, commit_sha=commit_sha
)
).text
)
if __name__ == "__main__":
import asyncio
async def main() -> None:
"""Test the GithubClient."""
client = GithubClient()
response = await client.get_tree(
owner="ahmetkca", repo="CommitAI", tree_sha="with-body"
)
for obj in response.tree:
if obj.type == "blob":
print(obj.path)
print(obj.sha)
blob_response = await client.get_blob(
owner="ahmetkca", repo="CommitAI", file_sha=obj.sha
)
print(blob_response.content)
asyncio.run(main())
|