mirror of
https://github.com/status-im/PyGithub.git
synced 2026-08-31 10:51:14 +00:00
Co-authored-by: Aleksei Fedotov <aleksei@fedotov.email>
This commit is contained in:
Aleksei Fedotov
co-authored by
Aleksei Fedotov
Aleksei Fedotov
parent
17b44d8857
commit
437ff8452a
@@ -0,0 +1,178 @@
|
||||
############################ Copyrights and license ############################
|
||||
# #
|
||||
# Copyright 2022 Aleksei Fedotov <aleksei@fedotov.email> #
|
||||
# #
|
||||
# This file is part of PyGithub. #
|
||||
# http://pygithub.readthedocs.io/ #
|
||||
# #
|
||||
# PyGithub is free software: you can redistribute it and/or modify it under #
|
||||
# the terms of the GNU Lesser General Public License as published by the Free #
|
||||
# Software Foundation, either version 3 of the License, or (at your option) #
|
||||
# any later version. #
|
||||
# #
|
||||
# PyGithub is distributed in the hope that it will be useful, but WITHOUT ANY #
|
||||
# WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS #
|
||||
# FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more #
|
||||
# details. #
|
||||
# #
|
||||
# You should have received a copy of the GNU Lesser General Public License #
|
||||
# along with PyGithub. If not, see <http://www.gnu.org/licenses/>. #
|
||||
# #
|
||||
################################################################################
|
||||
|
||||
import github.GithubObject
|
||||
import github.WorkflowRun
|
||||
|
||||
|
||||
class Artifact(github.GithubObject.NonCompletableGithubObject):
|
||||
"""
|
||||
This class represents an Artifact of Github Run
|
||||
"""
|
||||
|
||||
def __repr__(self):
|
||||
return self.get__repr__({"name": self._name.value, "id": self._id.value})
|
||||
|
||||
@property
|
||||
def archive_download_url(self):
|
||||
"""
|
||||
:type: string
|
||||
"""
|
||||
return self._archive_download_url.value
|
||||
|
||||
@property
|
||||
def created_at(self):
|
||||
"""
|
||||
:type: datetime.datetime
|
||||
"""
|
||||
return self._created_at.value
|
||||
|
||||
@property
|
||||
def expired(self):
|
||||
"""
|
||||
:type: bool
|
||||
"""
|
||||
return self._expired.value
|
||||
|
||||
@property
|
||||
def expires_at(self):
|
||||
"""
|
||||
:type: datetime.datetime
|
||||
"""
|
||||
return self._expires_at.value
|
||||
|
||||
@property
|
||||
def head_sha(self):
|
||||
"""
|
||||
:type: string
|
||||
"""
|
||||
return self._head_sha.value
|
||||
|
||||
@property
|
||||
def id(self):
|
||||
"""
|
||||
:type: string
|
||||
"""
|
||||
return self._id.value
|
||||
|
||||
@property
|
||||
def name(self):
|
||||
"""
|
||||
:type: string
|
||||
"""
|
||||
return self._name.value
|
||||
|
||||
@property
|
||||
def node_id(self):
|
||||
"""
|
||||
:type: string
|
||||
"""
|
||||
return self._node_id.value
|
||||
|
||||
@property
|
||||
def size_in_bytes(self):
|
||||
"""
|
||||
:type: integer
|
||||
"""
|
||||
return self._size_in_bytes.value
|
||||
|
||||
@property
|
||||
def updated_at(self):
|
||||
"""
|
||||
:type: datetime.datetime
|
||||
"""
|
||||
return self._updated_at.value
|
||||
|
||||
@property
|
||||
def url(self):
|
||||
"""
|
||||
:type: string
|
||||
"""
|
||||
return self._url.value
|
||||
|
||||
@property
|
||||
def workflow_run(self):
|
||||
"""
|
||||
:type: :class:``
|
||||
"""
|
||||
return self._workflow_run.value
|
||||
|
||||
def delete(self) -> bool:
|
||||
"""
|
||||
:calls: `DELETE /repos/{owner}/{repo}/actions/artifacts/{artifact_id} <https://docs.github.com/en/rest/actions/artifacts#delete-an-artifact>`_
|
||||
:rtype: bool
|
||||
"""
|
||||
status, headers, data = self._requester.requestBlob("DELETE", self.url)
|
||||
return status == 204
|
||||
|
||||
def _initAttributes(self):
|
||||
self._archive_download_url = github.GithubObject.NotSet
|
||||
self._created_at = github.GithubObject.NotSet
|
||||
self._expired = github.GithubObject.NotSet
|
||||
self._expires_at = github.GithubObject.NotSet
|
||||
self._head_sha = github.GithubObject.NotSet
|
||||
self._id = github.GithubObject.NotSet
|
||||
self._name = github.GithubObject.NotSet
|
||||
self._node_id = github.GithubObject.NotSet
|
||||
self._size_in_bytes = github.GithubObject.NotSet
|
||||
self._updated_at = github.GithubObject.NotSet
|
||||
self._url = github.GithubObject.NotSet
|
||||
self._workflow_run = github.GithubObject.NotSet
|
||||
|
||||
def _useAttributes(self, attributes):
|
||||
if "archive_download_url" in attributes: # pragma no branch
|
||||
self._archive_download_url = self._makeStringAttribute(
|
||||
attributes["archive_download_url"]
|
||||
)
|
||||
if "created_at" in attributes: # pragma no branch
|
||||
assert attributes["created_at"] is None or isinstance(
|
||||
attributes["created_at"], (str,)
|
||||
), attributes["created_at"]
|
||||
self._created_at = self._makeDatetimeAttribute(attributes["created_at"])
|
||||
if "expired" in attributes: # pragma no branch
|
||||
self._expired = self._makeBoolAttribute(attributes["expired"])
|
||||
if "expires_at" in attributes: # pragma no branch
|
||||
assert attributes["expires_at"] is None or isinstance(
|
||||
attributes["expires_at"], (str,)
|
||||
), attributes["expires_at"]
|
||||
self._expires_at = self._makeDatetimeAttribute(attributes["expires_at"])
|
||||
if "head_sha" in attributes: # pragma no branch
|
||||
self._head_sha = self._makeStringAttribute(attributes["head_sha"])
|
||||
if "id" in attributes: # pragma no branch
|
||||
self._id = self._makeIntAttribute(attributes["id"])
|
||||
if "name" in attributes: # pragma no branch
|
||||
self._name = self._makeStringAttribute(attributes["name"])
|
||||
if "node_id" in attributes: # pragma no branch
|
||||
self._node_id = self._makeStringAttribute(attributes["node_id"])
|
||||
if "size_in_bytes" in attributes: # pragma no branch
|
||||
self._size_in_bytes = self._makeIntAttribute(attributes["size_in_bytes"])
|
||||
if "updated_at" in attributes: # pragma no branch
|
||||
assert attributes["updated_at"] is None or isinstance(
|
||||
attributes["updated_at"], (str,)
|
||||
), attributes["updated_at"]
|
||||
self._updated_at = self._makeDatetimeAttribute(attributes["updated_at"])
|
||||
if "url" in attributes: # pragma no branch
|
||||
self._url = self._makeStringAttribute(attributes["url"])
|
||||
if "workflow_run" in attributes: # pragma no branch
|
||||
self._workflow_run = self._makeClassAttribute(
|
||||
github.WorkflowRun.WorkflowRun, attributes["workflow_run"]
|
||||
)
|
||||
@@ -0,0 +1,30 @@
|
||||
from github.WorkflowRun import WorkflowRun
|
||||
from datetime import datetime
|
||||
from github.GithubObject import NonCompletableGithubObject as NonCompletableGithubObject
|
||||
|
||||
class Artifact(NonCompletableGithubObject):
|
||||
@property
|
||||
def archive_download_url(self) -> str: ...
|
||||
@property
|
||||
def created_at(self) -> datetime: ...
|
||||
def delete(self) -> bool: ...
|
||||
@property
|
||||
def expired(self) -> bool: ...
|
||||
@property
|
||||
def expires_at(self) -> datetime: ...
|
||||
@property
|
||||
def head_sha(self) -> str: ...
|
||||
@property
|
||||
def id(self) -> int: ...
|
||||
@property
|
||||
def name(self) -> str: ...
|
||||
@property
|
||||
def node_id(self) -> str: ...
|
||||
@property
|
||||
def size_in_bytes(self) -> int: ...
|
||||
@property
|
||||
def updated_at(self) -> datetime: ...
|
||||
@property
|
||||
def url(self) -> str: ...
|
||||
@property
|
||||
def workflow_run(self) -> WorkflowRun: ...
|
||||
@@ -65,6 +65,7 @@
|
||||
# Copyright 2018 Yves Zumbach <yzumbach@andrew.cmu.edu> #
|
||||
# Copyright 2018 Leying Chen <leyingc@andrew.cmu.edu> #
|
||||
# Copyright 2020 Pascal Hofmann <mail@pascalhofmann.de> #
|
||||
# Copyright 2022 Aleksei Fedotov <aleksei@fedotov.email> #
|
||||
# #
|
||||
# This file is part of PyGithub. #
|
||||
# http://pygithub.readthedocs.io/ #
|
||||
@@ -91,6 +92,7 @@ from base64 import b64encode
|
||||
|
||||
from deprecated import deprecated
|
||||
|
||||
import github.Artifact
|
||||
import github.Branch
|
||||
import github.CheckRun
|
||||
import github.CheckSuite
|
||||
@@ -3703,6 +3705,33 @@ class Repository(github.GithubObject.CompletableGithubObject):
|
||||
)
|
||||
return github.CheckRun.CheckRun(self._requester, headers, data, completed=True)
|
||||
|
||||
def get_artifacts(self):
|
||||
"""
|
||||
:calls: `GET /repos/{owner}/{repo}/actions/artifacts <https://docs.github.com/en/rest/actions/artifacts#list-artifacts-for-a-repository>`_
|
||||
:rtype: :class:`github.PaginatedList.PaginatedList` of :class:`github.Artifact.Artifact`
|
||||
"""
|
||||
|
||||
return github.PaginatedList.PaginatedList(
|
||||
github.Artifact.Artifact,
|
||||
self._requester,
|
||||
f"{self.url}/actions/artifacts",
|
||||
None,
|
||||
list_item="artifacts",
|
||||
)
|
||||
|
||||
def get_artifact(self, artifact_id):
|
||||
"""
|
||||
:calls: `GET /repos/{owner}/{repo}/actions/artifacts/{artifact_id} <https://docs.github.com/en/rest/actions/artifacts#get-an-artifact>`_
|
||||
:param artifact_id: int
|
||||
:rtype: :class:`github.Artifact.Artifact`
|
||||
"""
|
||||
assert isinstance(artifact_id, int), artifact_id
|
||||
headers, data = self._requester.requestJsonAndCheck(
|
||||
"GET", f"{self.url}/actions/artifacts/{artifact_id}"
|
||||
)
|
||||
|
||||
return github.Artifact.Artifact(self._requester, headers, data, completed=True)
|
||||
|
||||
def _initAttributes(self):
|
||||
self._allow_merge_commit = github.GithubObject.NotSet
|
||||
self._allow_rebase_merge = github.GithubObject.NotSet
|
||||
|
||||
@@ -1,6 +1,7 @@
|
||||
from datetime import date, datetime
|
||||
from typing import Any, Dict, List, Optional, Union, overload
|
||||
|
||||
from github.Artifact import Artifact
|
||||
from github.AuthenticatedUser import AuthenticatedUser
|
||||
from github.Branch import Branch
|
||||
from github.CheckRun import CheckRun
|
||||
@@ -305,6 +306,8 @@ class Repository(CompletableGithubObject):
|
||||
def get_archive_link(
|
||||
self, archive_format: str, ref: Union[str, _NotSetType] = ...
|
||||
) -> str: ...
|
||||
def get_artifact(self) -> Artifact: ...
|
||||
def get_artifacts(self) -> PaginatedList[Artifact]: ...
|
||||
def get_assignees(self) -> PaginatedList[NamedUser]: ...
|
||||
def get_branch(self, branch: str) -> Branch: ...
|
||||
def rename_branch(self, branch: Union[str, Branch], new_name: str) -> bool: ...
|
||||
|
||||
@@ -1,6 +1,7 @@
|
||||
############################ Copyrights and license ############################
|
||||
# #
|
||||
# Copyright 2020 Steve Kowalik <steven@wedontsleep.org> #
|
||||
# Copyright 2022 Aleksei Fedotov <aleksei@fedotov.email> #
|
||||
# #
|
||||
# This file is part of PyGithub. #
|
||||
# http://pygithub.readthedocs.io/ #
|
||||
@@ -22,6 +23,7 @@
|
||||
|
||||
from collections import namedtuple
|
||||
|
||||
import github.Artifact
|
||||
import github.GithubObject
|
||||
import github.PullRequest
|
||||
|
||||
@@ -170,6 +172,15 @@ class WorkflowRun(github.GithubObject.CompletableGithubObject):
|
||||
self._completeIfNotSet(self._artifacts_url)
|
||||
return self._artifacts_url.value
|
||||
|
||||
def get_artifacts(self):
|
||||
return github.PaginatedList.PaginatedList(
|
||||
github.Artifact.Artifact,
|
||||
self._requester,
|
||||
self._artifacts_url.value,
|
||||
None,
|
||||
list_item="artifacts",
|
||||
)
|
||||
|
||||
@property
|
||||
def cancel_url(self):
|
||||
"""
|
||||
|
||||
@@ -0,0 +1,60 @@
|
||||
#!/usr/bin/env python3
|
||||
|
||||
import github
|
||||
|
||||
from . import Framework
|
||||
|
||||
|
||||
class Artifact(Framework.TestCase):
|
||||
def setUp(self):
|
||||
super().setUp()
|
||||
self.repo = self.g.get_repo("github/vscode-codeql")
|
||||
|
||||
def testGetArtifactsFromWorkflow(self):
|
||||
artifact = self.repo.get_workflow_run(160995070).get_artifacts()[0]
|
||||
|
||||
self.assertEqual(artifact.name, "vscode-codeql-extension")
|
||||
self.assertTrue(artifact.expired)
|
||||
self.assertEqual(
|
||||
repr(artifact), 'Artifact(name="vscode-codeql-extension", id=10495898)'
|
||||
)
|
||||
|
||||
def testGetSingleArtifactFromRepo(self):
|
||||
artifact = self.repo.get_artifact(378970214)
|
||||
|
||||
self.assertEqual(artifact.name, "vscode-codeql-extension")
|
||||
self.assertFalse(artifact.expired)
|
||||
self.assertEqual(
|
||||
repr(artifact), 'Artifact(name="vscode-codeql-extension", id=378970214)'
|
||||
)
|
||||
|
||||
def testGetArtifactsFromRepo(self):
|
||||
artifact_id = 378970214
|
||||
artifacts = self.repo.get_artifacts()
|
||||
for item in artifacts:
|
||||
if item.id == artifact_id:
|
||||
artifact = item
|
||||
break
|
||||
else:
|
||||
assert False, f"No artifact {artifact_id} is found"
|
||||
|
||||
self.assertEqual(
|
||||
repr(artifact),
|
||||
f'Artifact(name="vscode-codeql-extension", id={artifact_id})',
|
||||
)
|
||||
|
||||
def testGetNonexistentArtifact(self):
|
||||
artifact_id = 396724437
|
||||
repo_name = "lexa/PyGithub"
|
||||
repo = self.g.get_repo(repo_name)
|
||||
with self.assertRaises(github.GithubException):
|
||||
repo.get_artifact(artifact_id)
|
||||
|
||||
def testDelete(self):
|
||||
artifact_id = 396724439
|
||||
repo_name = "lexa/PyGithub"
|
||||
repo = self.g.get_repo(repo_name)
|
||||
artifact = repo.get_artifact(artifact_id)
|
||||
self.assertTrue(artifact.delete())
|
||||
with self.assertRaises(github.GithubException):
|
||||
repo.get_artifact(artifact_id)
|
||||
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
@@ -0,0 +1,11 @@
|
||||
https
|
||||
GET
|
||||
api.github.com
|
||||
None
|
||||
/repos/github/vscode-codeql/actions/artifacts/378970214
|
||||
{'Authorization': 'Basic login_and_password_removed', 'User-Agent': 'PyGithub/Python'}
|
||||
None
|
||||
200
|
||||
[('Server', 'GitHub.com'), ('Date', 'Wed, 28 Sep 2022 11:31:34 GMT'), ('Content-Type', 'application/json; charset=utf-8'), ('Transfer-Encoding', 'chunked'), ('Cache-Control', 'public, max-age=60, s-maxage=60'), ('Vary', 'Accept, Accept-Encoding, Accept, X-Requested-With'), ('ETag', 'W/"1ce0fc2843af81fc42d4196f2c6f764261d3f2fb3ad2e8252e12328e3d172e83"'), ('X-GitHub-Media-Type', 'github.v3; format=json'), ('X-RateLimit-Limit', '60'), ('X-RateLimit-Remaining', '44'), ('X-RateLimit-Reset', '1664368108'), ('X-RateLimit-Used', '16'), ('X-RateLimit-Resource', 'core'), ('Access-Control-Expose-Headers', 'ETag, Link, Location, Retry-After, X-GitHub-OTP, X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Used, X-RateLimit-Resource, X-RateLimit-Reset, X-OAuth-Scopes, X-Accepted-OAuth-Scopes, X-Poll-Interval, X-GitHub-Media-Type, X-GitHub-SSO, X-GitHub-Request-Id, Deprecation, Sunset'), ('Access-Control-Allow-Origin', '*'), ('Strict-Transport-Security', 'max-age=31536000; includeSubdomains; preload'), ('X-Frame-Options', 'deny'), ('X-Content-Type-Options', 'nosniff'), ('X-XSS-Protection', '0'), ('Referrer-Policy', 'origin-when-cross-origin, strict-origin-when-cross-origin'), ('Content-Security-Policy', "default-src 'none'"), ('Content-Encoding', 'gzip'), ('X-GitHub-Request-Id', 'AB42:A24F:196DD8:19DBE1:63343096')]
|
||||
{"id":378970214,"node_id":"MDg6QXJ0aWZhY3QzNzg5NzAyMTQ=","name":"vscode-codeql-extension","size_in_bytes":16528288,"url":"https://api.github.com/repos/github/vscode-codeql/actions/artifacts/378970214","archive_download_url":"https://api.github.com/repos/github/vscode-codeql/actions/artifacts/378970214/zip","expired":false,"created_at":"2022-09-28T09:47:51Z","updated_at":"2022-09-28T09:47:52Z","expires_at":"2022-12-27T09:36:05Z","workflow_run":{"id":3142419796,"repository_id":211169016,"head_repository_id":211169016,"head_branch":"koesie10/refactor-raw-results-table","head_sha":"e3e2fcc3498ab7d945a9e58f7c1458171ab0a5a7"}}
|
||||
|
||||
Reference in New Issue
Block a user