diff options
| author | Emanuele Aina <emanuele.aina@collabora.com> | 2021-02-25 22:53:11 +0100 |
|---|---|---|
| committer | Emanuele Aina <emanuele.aina@collabora.com> | 2021-03-05 01:04:00 +0100 |
| commit | b4dac5ce33843cf52badeb9faf0f7f52f20a9a6a (patch) | |
| tree | f3cf0de32376a1ad2381cf0bd734a68e14c37cd5 /gitlab/utils.py | |
| parent | aa132149558e797332897ec8543a9ac9fb0da09b (diff) | |
| download | gitlab-b4dac5ce33843cf52badeb9faf0f7f52f20a9a6a.tar.gz | |
fix: handle tags like debian/2%2.6-21 as identifiers
Git refnames are relatively free-form and can contain all sort for
special characters, not just `/` and `#`, see
http://git-scm.com/docs/git-check-ref-format
In particular, Debian's DEP-14 standard for storing packaging in git
repositories mandates the use of the `%` character in tags in some
cases like `debian/2%2.6-21`.
Unfortunately python-gitlab currently only escapes `/` to `%2F` and in
some cases `#` to `%23`. This means that when using the commit API to
retrieve information about the `debian/2%2.6-21` tag only the slash is
escaped before being inserted in the URL path and the `%` is left
untouched, resulting in something like
`/api/v4/projects/123/repository/commits/debian%2F2%2.6-21`. When
urllib3 seees that it detects the invalid `%` escape and then urlencodes
the whole string, resulting in
`/api/v4/projects/123/repository/commits/debian%252F2%252.6-21`, where
the original `/` got escaped twice and produced `%252F`.
To avoid the issue, fully urlencode identifiers and parameters to avoid
the urllib3 auto-escaping in all cases.
Signed-off-by: Emanuele Aina <emanuele.aina@collabora.com>
Diffstat (limited to 'gitlab/utils.py')
| -rw-r--r-- | gitlab/utils.py | 6 |
1 files changed, 3 insertions, 3 deletions
diff --git a/gitlab/utils.py b/gitlab/utils.py index 987f1d3..45a4af8 100644 --- a/gitlab/utils.py +++ b/gitlab/utils.py @@ -16,7 +16,7 @@ # along with this program. If not, see <http://www.gnu.org/licenses/>. from typing import Any, Callable, Dict, Optional -from urllib.parse import urlparse +from urllib.parse import quote, urlparse import requests @@ -57,14 +57,14 @@ def copy_dict(dest: Dict[str, Any], src: Dict[str, Any]) -> None: def clean_str_id(id: str) -> str: - return id.replace("/", "%2F").replace("#", "%23") + return quote(id, safe="") def sanitize_parameters(value): if isinstance(value, dict): return dict((k, sanitize_parameters(v)) for k, v in value.items()) if isinstance(value, str): - return value.replace("/", "%2F") + return quote(value, safe="") return value |