Jul 31, 2021 · Dec 18, 2021
diff --git a/docs/gl_objects/projects.rst b/docs/gl_objects/projects.rst
    # 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.
diff --git a/gitlab/client.py b/gitlab/client.py
        prepped = self.session.prepare_request(req)
        if TYPE_CHECKING:
            assert prepped.url is not None
        prepped.url = utils.sanitized_url(prepped.url)
 #prepped.url = utils.sanitized_url(prepped.url)
        settings = self.session.merge_environment_settings(
            prepped.url, {}, streamed, verify, None
        )
diff --git a/gitlab/v4/objects/repositories.py b/gitlab/v4/objects/repositories.py
        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]:
        """Returna tarball of the repository.
        """Returnan archive of the repository.

        Args:
            sha: ID of the commit (default branch by default)
            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:
            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
diff --git a/tests/functional/api/test_repository.py b/tests/functional/api/test_repository.py
 import base64
 import tarfile
 import time
 import zipfile
 from io import BytesIO

 import pytest

    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):
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
Original file line number	Diff line number	Diff line change
Expand Up		@@ -603,7 +603,7 @@ def http_request(
		prepped = self.session.prepare_request(req)
		if TYPE_CHECKING:
		assert prepped.url is not None
		prepped.url = utils.sanitized_url(prepped.url)
		#prepped.url = utils.sanitized_url(prepped.url)
		settings = self.session.merge_environment_settings(
		prepped.url, {}, streamed, verify, None
		)
Expand Down
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]:
		"""Returna tarball of the repository.
		"""Returnan 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
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 DownExpand 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