FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

feat(api): support file format for repository archive by dAnjou · Pull Request #1561 · python-gitlab/python-gitlab · GitHub

  1. python-gitlab
  2. python-gitlab

Repository navigation

feat(api): support file format for repository archive #1561

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
JohnVillalovos merged 1 commit into from
Dec 21, 2021
Conversation 18 Commits 1 Checks 0 Files changed
Merged

feat(api): support file format for repository archive #1561

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension .py  (2) .rst  (1) All 2 file types selected
Viewed files
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Unified
Split
Hide whitespace
Diff view
Unified
Split
Hide whitespace
8 changes: 8 additions & 0 deletions docs/gl_objects/projects.rst
Show comments
View file
Open in desktop
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Show hidden characters
Original file line number Diff line number Diff line change
Expand Up @@ -180,6 +180,14 @@ Get the repository archive::
# get the archive for a branch/tag/commit
tgz = project.repository_archive(sha='4567abc')

# get the archive in a different format
zip = project.repository_archive(format='zip')

.. note::

For the formats available, refer to
https://docs.gitlab.com/ce/api/repositories.html#get-file-archive

.. warning::

Archives are entirely stored in memory unless you use the streaming feature.
Expand Down
8 changes: 6 additions & 2 deletions gitlab/v4/objects/repositories.py
Show comments
View file
Open in desktop
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Show hidden characters
Original file line number Diff line number Diff line change
Expand Up @@ -186,17 +186,18 @@ def repository_contributors(
path = f"/projects/{self.get_id()}/repository/contributors"
return self.manager.gitlab.http_list(path, **kwargs)

@cli.register_custom_action("Project", tuple(), ("sha",))
@cli.register_custom_action("Project", tuple(), ("sha", "format"))
@exc.on_http_error(exc.GitlabListError)
def repository_archive(
self,
sha: str = None,
streamed: bool = False,
action: Optional[Callable[..., Any]] = None,
chunk_size: int = 1024,
format: Optional[str] = None,
**kwargs: Any,
) -> Optional[bytes]:
"""Return a tarball of the repository.
"""Return an archive of the repository.

Args:
sha: ID of the commit (default branch by default)
Expand All @@ -206,6 +207,7 @@ def repository_archive(
action: Callable responsible of dealing with chunk of
data
chunk_size: Size of each chunk
format: file format (tar.gz by default)
**kwargs: Extra options to send to the server (e.g. sudo)

Raises:
Expand All @@ -216,6 +218,8 @@ def repository_archive(
The binary data of the archive
"""
path = f"/projects/{self.get_id()}/repository/archive"
if format:
path += "." + format
query_data = {}
if sha:
query_data["sha"] = sha
Expand Down
27 changes: 25 additions & 2 deletions tests/functional/api/test_repository.py
Show comments
View file
Open in desktop
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Show hidden characters
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
import base64
import tarfile
import time
import zipfile
from io import BytesIO

import pytest

Expand Down Expand Up @@ -48,14 +51,34 @@ def test_repository_tree(project):
blob = project.repository_raw_blob(blob_id)
assert blob.decode() == "Initial content"

snapshot = project.snapshot()
assert isinstance(snapshot, bytes)


def test_repository_archive(project):
archive = project.repository_archive()
assert isinstance(archive, bytes)

archive2 = project.repository_archive("main")
assert archive == archive2

snapshot = project.snapshot()
assert isinstance(snapshot, bytes)

@pytest.mark.parametrize(
"format,assertion",
[
("tbz", tarfile.is_tarfile),
("tbz2", tarfile.is_tarfile),
("tb2", tarfile.is_tarfile),
("bz2", tarfile.is_tarfile),
("tar", tarfile.is_tarfile),
("tar.gz", tarfile.is_tarfile),
("tar.bz2", tarfile.is_tarfile),
("zip", zipfile.is_zipfile),
],
)
def test_repository_archive_formats(project, format, assertion):
archive = project.repository_archive(format=format)
assert assertion(BytesIO(archive))


def test_create_commit(project):
Expand Down
Back | FazBrowse Home | New Git URL