NotificationsYou must be signed in to change notification settings
Fork674
Star2.4k

Support downloading archive subpaths#2199

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.

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

Already on GitHub?Sign in to your account

Jump to bottom

Merged

nejch merged 1 commit intopython-gitlab:mainfromorf:patch-1

Jul 29, 2022

Merged

Support downloading archive subpaths#2199

nejch merged 1 commit intopython-gitlab:mainfromorf:patch-1

Jul 29, 2022

Conversation

Copy link

orf commentedJul 28, 2022

https://docs.gitlab.com/ee/api/repositories.html#get-file-archive

The archive endpoint supports apath argument. This change adds support for it.

JohnVillalovos requested changes

Jul 28, 2022

View reviewed changes

gitlab/v4/objects/repositories.py OutdatedShow resolvedHide resolved

JohnVillalovos approved these changes

Jul 28, 2022

View reviewed changes

JohnVillalovosenabled auto-merge (rebase)

July 28, 2022 17:22

Copy link

Member

JohnVillalovos commentedJul 28, 2022

@orf Thanks for the contribution!

JohnVillalovos reviewed

Jul 28, 2022

View reviewed changes

gitlab/v4/objects/repositories.pyShow resolvedHide resolved

JohnVillalovosdisabled auto-merge

July 28, 2022 17:31

JohnVillalovos requested changes

Jul 28, 2022

View reviewed changes

Copy link

Member

JohnVillalovos left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

Looks like conflict with the pre-existingpath variable.

Copy link

Member

@JohnVillalovos for later: we could potentially also prefix these internal python-gitlab variables in the mixins and custom methods to always avoid clashes with GitLab API attributes. So this would be_path here for example. Not sure how ugly that would get.

@orf sometimes our variables happen to overlap with upstream API attributes hence the suggestion.

diff --git a/gitlab/v4/objects/repositories.py b/gitlab/v4/objects/repositories.pyindex 8f99e5d..b8dbdd8 100644--- a/gitlab/v4/objects/repositories.py+++ b/gitlab/v4/objects/repositories.py@@ -229,16 +229,16 @@ class RepositoryMixin(_RestObjectBase):         Returns:             The binary data of the archive         """-        path = f"/projects/{self.encoded_id}/repository/archive"+        url_path = f"/projects/{self.encoded_id}/repository/archive"         if format:-            path += "." + format+            url_path += "." + format         query_data = {}         if sha:             query_data["sha"] = sha         if path is not None:             query_data["path"] = path         result = self.manager.gitlab.http_get(-            path, query_data=query_data, raw=True, streamed=streamed, **kwargs+            url_path, query_data=query_data, raw=True, streamed=streamed, **kwargs         )         if TYPE_CHECKING:             assert isinstance(result, requests.Response)