python-gerrit-api 2.1.8__tar.gz → 2.2.0__tar.gz

{python-gerrit-api-2.1.8/python_gerrit_api.egg-info → python_gerrit_api-2.2.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: python-gerrit-api
-Version: 2.1.8
+Version: 2.2.0
 Summary: Python wrapper for the Gerrit REST API.
 Home-page: https://github.com/shijl0925/python-gerrit-api
 Author: Jialiang Shi
@@ -18,8 +18,10 @@ Classifier: Programming Language :: Python :: 3.8
 Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
 Classifier: Topic :: Software Development
 License-File: LICENSE
+Requires-Dist: requests
 
 Project description
 ===================
@@ -28,7 +30,7 @@ Project description
     :target: https://pypi.python.org/pypi/python-gerrit-api
 .. image:: https://img.shields.io/pypi/v/python-gerrit-api.svg
     :target: https://pypi.python.org/pypi/python-gerrit-api
-.. image:: https://pepy.tech/badge/python-gerrit-api
+.. image:: https://static.pepy.tech/badge/python-gerrit-api
     :target: https://pepy.tech/project/python-gerrit-api
 .. image:: https://sonarcloud.io/api/project_badges/measure?project=shijl0925_python-gerrit-api&metric=alert_status
     :target: https://sonarcloud.io/dashboard?id=shijl0925_python-gerrit-api

{python-gerrit-api-2.1.8 → python_gerrit_api-2.2.0}/README.rst

@@ -5,7 +5,7 @@ Project description
     :target: https://pypi.python.org/pypi/python-gerrit-api
 .. image:: https://img.shields.io/pypi/v/python-gerrit-api.svg
     :target: https://pypi.python.org/pypi/python-gerrit-api
-.. image:: https://pepy.tech/badge/python-gerrit-api
+.. image:: https://static.pepy.tech/badge/python-gerrit-api
     :target: https://pepy.tech/project/python-gerrit-api
 .. image:: https://sonarcloud.io/api/project_badges/measure?project=shijl0925_python-gerrit-api&metric=alert_status
     :target: https://sonarcloud.io/dashboard?id=shijl0925_python-gerrit-api

{python-gerrit-api-2.1.8 → python_gerrit_api-2.2.0}/gerrit/__init__.py

@@ -1,11 +1,13 @@
 #!/usr/bin/env python
 # -*- coding:utf-8 -*-
 # @Author: Jialiang Shi
-__version__ = "2.1.8"
+__version__ = "2.2.0"
 
-import json
 import netrc
+import requests
+from requests.adapters import HTTPAdapter
 from gerrit.utils.requester import Requester
+from gerrit.utils.common import decode_response, strip_trailing_slash
 from gerrit.config.config import GerritConfig
 from gerrit.projects.projects import GerritProjects
 from gerrit.accounts.accounts import GerritAccounts
@@ -33,21 +35,35 @@ class GerritClient(object):
         cert=None,
         timeout=60,
         max_retries=None,
-        auth_suffix="/a"
+        auth_suffix="/a",
     ):
-        self._base_url = self.strip_trailing_slash(base_url)
+        self._base_url = strip_trailing_slash(base_url)
 
         if use_netrc:
             password = self.get_password_from_netrc_file()
 
+        # make request session
+        _session = requests.Session()
+        if username and password:
+            _session.auth = (username, password)
+
+        if ssl_verify:
+            _session.verify = ssl_verify
+
+        if cert is not None:
+            _session.cert = cert
+
+        if max_retries is not None:
+            retry_adapter = HTTPAdapter(max_retries=max_retries)
+            _session.mount("http://", retry_adapter)
+            _session.mount("https://", retry_adapter)
+
+        self.session = _session
+
         self.requester = Requester(
             base_url=base_url,
-            username=username,
-            password=password,
-            ssl_verify=ssl_verify,
-            cert=cert,
+            session=self.session,
             timeout=timeout,
-            max_retries=max_retries,
         )
         if username and password:
             self.auth_suffix = auth_suffix
@@ -63,20 +79,11 @@ class GerritClient(object):
         netrc_client = netrc.netrc()
         auth_tokens = netrc_client.authenticators(self._base_url)
         if not auth_tokens:
-            raise ValueError(f"The '{self._base_url}' host name is not found in netrc file.")
+            raise ValueError(
+                f"The '{self._base_url}' host name is not found in netrc file."
+            )
         return auth_tokens[2]
 
-    @classmethod
-    def strip_trailing_slash(cls, url):
-        """
-        remove url's trailing slash
-        :param url: url
-        :return:
-        """
-        while url.endswith("/"):
-            url = url[:-1]
-        return url
-
     def get_endpoint_url(self, endpoint):
         """
         Return the complete url including host and port for a given endpoint.
@@ -85,33 +92,6 @@ class GerritClient(object):
         """
         return f"{self._base_url}{self.auth_suffix}{endpoint}"
 
-    @staticmethod
-    def decode_response(response):
-        """Strip off Gerrit's magic prefix and decode a response.
-        :returns:
-            Decoded JSON content as a dict, or raw text if content could not be
-            decoded as JSON.
-        :raises:
-            requests.HTTPError if the response contains an HTTP error status code.
-        """
-        magic_json_prefix = ")]}'\n"
-        content_type = response.headers.get("content-type", "")
-
-        content = response.content.strip()
-        if response.encoding:
-            content = content.decode(response.encoding)
-        if not content:
-            return content
-        if content_type.split(";")[0] != "application/json":
-            return content
-        if content.startswith(magic_json_prefix):
-            index = len(magic_json_prefix)
-            content = content[index:]
-        try:
-            return json.loads(content)
-        except ValueError:
-            raise ValueError(f"Invalid json content: {content}")
-
     @property
     def config(self):
         """
@@ -196,7 +176,7 @@ class GerritClient(object):
         :return:
         """
         response = self.requester.get(self.get_endpoint_url(endpoint), **kwargs)
-        result = self.decode_response(response)
+        result = decode_response(response)
         return result
 
     def post(self, endpoint, **kwargs):
@@ -207,7 +187,7 @@ class GerritClient(object):
         :return:
         """
         response = self.requester.post(self.get_endpoint_url(endpoint), **kwargs)
-        result = self.decode_response(response)
+        result = decode_response(response)
         return result
 
     def put(self, endpoint, **kwargs):
@@ -218,7 +198,7 @@ class GerritClient(object):
         :return:
         """
         response = self.requester.put(self.get_endpoint_url(endpoint), **kwargs)
-        result = self.decode_response(response)
+        result = decode_response(response)
         return result
 
     def delete(self, endpoint):
@@ -228,4 +208,4 @@ class GerritClient(object):
         :param endpoint: The endpoint to send to.
         :return:
         """
-        self.requester.delete(self.get_endpoint_url(endpoint))
+        self.requester.delete(self.get_endpoint_url(endpoint))

{python-gerrit-api-2.1.8 → python_gerrit_api-2.2.0}/gerrit/accounts/account.py

@@ -11,7 +11,7 @@ class GerritAccount(BaseModel):
     def __init__(self, **kwargs):
         super().__init__(**kwargs)
         self.entity_name = "username"
-        self.endpoint = f"/accounts/{self.username}"
+        self.endpoint = f"/accounts/{self.account_id}"
 
     def get_name(self):
         """
@@ -41,8 +41,9 @@ class GerritAccount(BaseModel):
           https://gerrit-review.googlesource.com/Documentation/rest-api-accounts.html#account-name-input
         :return:
         """
-        return self.gerrit.put(self.endpoint + "/name",
-                               json=input_, headers=self.gerrit.default_headers)
+        return self.gerrit.put(
+            self.endpoint + "/name", json=input_, headers=self.gerrit.default_headers
+        )
 
     def delete_name(self):
         """
@@ -74,8 +75,9 @@ class GerritAccount(BaseModel):
         :return:
         """
         input_ = {"status": status}
-        return self.gerrit.put(self.endpoint + "/status",
-                               json=input_, headers=self.gerrit.default_headers)
+        return self.gerrit.put(
+            self.endpoint + "/status", json=input_, headers=self.gerrit.default_headers
+        )
 
     def set_username(self, input_):
         """
@@ -96,8 +98,11 @@ class GerritAccount(BaseModel):
           https://gerrit-review.googlesource.com/Documentation/rest-api-accounts.html#username-input
         :return:
         """
-        return self.gerrit.put(self.endpoint + "/username",
-                               json=input_, headers=self.gerrit.default_headers)
+        return self.gerrit.put(
+            self.endpoint + "/username",
+            json=input_,
+            headers=self.gerrit.default_headers,
+        )
 
     def set_displayname(self, input_):
         """
@@ -117,8 +122,11 @@ class GerritAccount(BaseModel):
           https://gerrit-review.googlesource.com/Documentation/rest-api-accounts.html#display-name-input
         :return:
         """
-        return self.gerrit.put(self.endpoint + "/displayname",
-                               json=input_, headers=self.gerrit.default_headers)
+        return self.gerrit.put(
+            self.endpoint + "/displayname",
+            json=input_,
+            headers=self.gerrit.default_headers,
+        )
 
     def get_active(self):
         """
@@ -163,8 +171,11 @@ class GerritAccount(BaseModel):
           https://gerrit-review.googlesource.com/Documentation/rest-api-accounts.html#http-password-input
         :return:
         """
-        return self.gerrit.put(self.endpoint + "/password.http",
-                               json=input_, headers=self.gerrit.default_headers)
+        return self.gerrit.put(
+            self.endpoint + "/password.http",
+            json=input_,
+            headers=self.gerrit.default_headers,
+        )
 
     def delete_http_password(self):
         """
@@ -187,15 +198,15 @@ class GerritAccount(BaseModel):
 
     @property
     def emails(self):
-        return GerritAccountEmails(username=self.username, gerrit=self.gerrit)
+        return GerritAccountEmails(account_id=self.account_id, gerrit=self.gerrit)
 
     @property
     def ssh_keys(self):
-        return GerritAccountSSHKeys(username=self.username, gerrit=self.gerrit)
+        return GerritAccountSSHKeys(account_id=self.account_id, gerrit=self.gerrit)
 
     @property
     def gpg_keys(self):
-        return GerritAccountGPGKeys(username=self.username, gerrit=self.gerrit)
+        return GerritAccountGPGKeys(account_id=self.account_id, gerrit=self.gerrit)
 
     def list_capabilities(self):
         """
@@ -275,8 +286,11 @@ class GerritAccount(BaseModel):
           https://gerrit-review.googlesource.com/Documentation/rest-api-accounts.html#preferences-input
         :return:
         """
-        return self.gerrit.put(self.endpoint + "/preferences",
-                               json=input_, headers=self.gerrit.default_headers)
+        return self.gerrit.put(
+            self.endpoint + "/preferences",
+            json=input_,
+            headers=self.gerrit.default_headers,
+        )
 
     def get_diff_preferences(self):
         """
@@ -314,8 +328,11 @@ class GerritAccount(BaseModel):
           https://gerrit-review.googlesource.com/Documentation/rest-api-accounts.html#diff-preferences-input
         :return:
         """
-        return self.gerrit.put(self.endpoint + "/preferences.diff",
-                               json=input_, headers=self.gerrit.default_headers)
+        return self.gerrit.put(
+            self.endpoint + "/preferences.diff",
+            json=input_,
+            headers=self.gerrit.default_headers,
+        )
 
     def get_edit_preferences(self):
         """
@@ -355,8 +372,11 @@ class GerritAccount(BaseModel):
           https://gerrit-review.googlesource.com/Documentation/rest-api-accounts.html#edit-preferences-info
         :return:
         """
-        return self.gerrit.put(self.endpoint + "/preferences.edit",
-                               json=input_, headers=self.gerrit.default_headers)
+        return self.gerrit.put(
+            self.endpoint + "/preferences.edit",
+            json=input_,
+            headers=self.gerrit.default_headers,
+        )
 
     def get_watched_projects(self):
         """
@@ -388,8 +408,11 @@ class GerritAccount(BaseModel):
         :param input_: the ProjectWatchInfo entities as list
         :return:
         """
-        return self.gerrit.post(self.endpoint + "/watched.projects",
-                                json=input_, headers=self.gerrit.default_headers)
+        return self.gerrit.post(
+            self.endpoint + "/watched.projects",
+            json=input_,
+            headers=self.gerrit.default_headers,
+        )
 
     def delete_watched_projects(self, input_):
         """
@@ -410,8 +433,11 @@ class GerritAccount(BaseModel):
         :param input_: the watched projects as list
         :return:
         """
-        self.gerrit.post(self.endpoint + "/watched.projects:delete",
-                         json=input_, headers=self.gerrit.default_headers)
+        self.gerrit.post(
+            self.endpoint + "/watched.projects:delete",
+            json=input_,
+            headers=self.gerrit.default_headers,
+        )
 
     def get_external_ids(self):
         """
@@ -442,8 +468,11 @@ class GerritAccount(BaseModel):
         :param input_: the external ids as list
         :return:
         """
-        self.gerrit.post(self.endpoint + "/external.ids:delete",
-                         json=input_, headers=self.gerrit.default_headers)
+        self.gerrit.post(
+            self.endpoint + "/external.ids:delete",
+            json=input_,
+            headers=self.gerrit.default_headers,
+        )
 
     def list_contributor_agreements(self):
         """
@@ -469,9 +498,11 @@ class GerritAccount(BaseModel):
           https://gerrit-review.googlesource.com/Documentation/rest-api-accounts.html#contributor-agreement-input
         :return:
         """
-        return self.gerrit.put(self.endpoint + "/agreements",
-                               json=input_, headers=self.gerrit.default_headers)
-
+        return self.gerrit.put(
+            self.endpoint + "/agreements",
+            json=input_,
+            headers=self.gerrit.default_headers,
+        )
 
     def delete_draft_comments(self, input_):
         """
@@ -489,8 +520,11 @@ class GerritAccount(BaseModel):
           https://gerrit-review.googlesource.com/Documentation/rest-api-accounts.html#delete-draft-comments-input
         :return:
         """
-        return self.gerrit.post(self.endpoint + "/drafts:delete",
-                                json=input_, headers=self.gerrit.default_headers)
+        return self.gerrit.post(
+            self.endpoint + "/drafts:delete",
+            json=input_,
+            headers=self.gerrit.default_headers,
+        )
 
     def index(self):
         """
@@ -566,5 +600,8 @@ class GerritAccount(BaseModel):
           https://gerrit-review.googlesource.com/Documentation/rest-api-accounts.html#stars-input
         :return:
         """
-        return self.gerrit.post(self.endpoint + f"/stars.changes/{id_}",
-                                json=input_, headers=self.gerrit.default_headers)
+        return self.gerrit.post(
+            self.endpoint + f"/stars.changes/{id_}",
+            json=input_,
+            headers=self.gerrit.default_headers,
+        )

{python-gerrit-api-2.1.8 → python_gerrit_api-2.2.0}/gerrit/accounts/accounts.py

@@ -12,8 +12,8 @@ class GerritAccounts(object):
     def search(
         self,
         query,
-        limit=None,
-        skip=None,
+        limit=25,
+        skip=0,
         detailed=False,
         suggested=False,
         all_emails=False,
@@ -52,16 +52,16 @@ class GerritAccounts(object):
 
         return self.gerrit.get(endpoint, params=params)
 
-    def get(self, username, detailed=False):
+    def get(self, account, detailed=False):
         """
         Returns an account
 
-        :param username: username or _account_id
+        :param account: username or email or _account_id or 'self'
         :param detailed: boolean type, If True then fetch info in more details, such as:
             registered_on
         :return:
         """
-        endpoint = self.endpoint + f"/{username}/"
+        endpoint = self.endpoint + f"/{account}/"
         if detailed:
             endpoint += "detail"
         result = self.gerrit.get(endpoint)
@@ -90,5 +90,8 @@ class GerritAccounts(object):
         :return:
         """
         result = self.gerrit.put(
-            self.endpoint + f"/{username}", json=input_, headers=self.gerrit.default_headers)
+            self.endpoint + f"/{username}",
+            json=input_,
+            headers=self.gerrit.default_headers,
+        )
         return GerritAccount(json=result, gerrit=self.gerrit)

{python-gerrit-api-2.1.8 → python_gerrit_api-2.2.0}/gerrit/accounts/emails.py

@@ -8,7 +8,7 @@ class GerritAccountEmail(BaseModel):
     def __init__(self, **kwargs):
         super().__init__(**kwargs)
         self.entity_name = "email"
-        self.endpoint = f"/accounts/{self.username}/emails/{self.email}"
+        self.endpoint = f"/accounts/{self.account_id}/emails/{self.email}"
 
     def delete(self):
         """
@@ -28,10 +28,10 @@ class GerritAccountEmail(BaseModel):
 
 
 class GerritAccountEmails(object):
-    def __init__(self, username, gerrit):
-        self.username = username
+    def __init__(self, account_id, gerrit):
+        self.account_id = account_id
         self.gerrit = gerrit
-        self.endpoint = f"/accounts/{self.username}/emails"
+        self.endpoint = f"/accounts/{self.account_id}/emails"
 
     def list(self):
         """
@@ -40,7 +40,9 @@ class GerritAccountEmails(object):
         :return:
         """
         result = self.gerrit.get(self.endpoint)
-        return GerritAccountEmail.parse_list(result, username=self.username, gerrit=self.gerrit)
+        return GerritAccountEmail.parse_list(
+            result, account_id=self.account_id, gerrit=self.gerrit
+        )
 
     def create(self, email):
         """
@@ -57,7 +59,9 @@ class GerritAccountEmails(object):
         :return:
         """
         result = self.gerrit.get(self.endpoint + f"/{email}")
-        return GerritAccountEmail(json=result, username=self.username, gerrit=self.gerrit)
+        return GerritAccountEmail(
+            json=result, account_id=self.account_id, gerrit=self.gerrit
+        )
 
     def set_preferred(self, email):
         """

{python-gerrit-api-2.1.8 → python_gerrit_api-2.2.0}/gerrit/accounts/gpg_keys.py

@@ -7,7 +7,7 @@ from gerrit.utils.models import BaseModel
 class GerritAccountGPGKey(BaseModel):
     def __init__(self, **kwargs):
         super().__init__(**kwargs)
-        self.endpoint = f"/accounts/{self.username}/gpgkeys"
+        self.endpoint = f"/accounts/{self.account_id}/gpgkeys"
 
     def delete(self):
         """
@@ -19,10 +19,10 @@ class GerritAccountGPGKey(BaseModel):
 
 
 class GerritAccountGPGKeys(object):
-    def __init__(self, username, gerrit):
-        self.username = username
+    def __init__(self, account_id, gerrit):
+        self.account_id = account_id
         self.gerrit = gerrit
-        self.endpoint = f"/accounts/{self.username}/gpgkeys"
+        self.endpoint = f"/accounts/{self.account_id}/gpgkeys"
 
     def list(self):
         """
@@ -38,7 +38,7 @@ class GerritAccountGPGKeys(object):
             keys.append(gpg_key)
 
         return GerritAccountGPGKey.parse_list(
-            keys, username=self.username, gerrit=self.gerrit
+            keys, account_id=self.account_id, gerrit=self.gerrit
         )
 
     def get(self, id_):
@@ -49,7 +49,9 @@ class GerritAccountGPGKeys(object):
         :return:
         """
         result = self.gerrit.get(self.endpoint + f"/{id_}")
-        return GerritAccountGPGKey(json=result, username=self.username, gerrit=self.gerrit)
+        return GerritAccountGPGKey(
+            json=result, account_id=self.account_id, gerrit=self.gerrit
+        )
 
     def modify(self, input_):
         """
@@ -100,7 +102,9 @@ class GerritAccountGPGKeys(object):
           https://gerrit-review.googlesource.com/Documentation/rest-api-accounts.html#gpg-keys-input
         :return:
         """
-        return self.gerrit.post(self.endpoint, json=input_, headers=self.gerrit.default_headers)
+        return self.gerrit.post(
+            self.endpoint, json=input_, headers=self.gerrit.default_headers
+        )
 
     def delete(self, id_):
         """

{python-gerrit-api-2.1.8 → python_gerrit_api-2.2.0}/gerrit/accounts/ssh_keys.py

@@ -8,7 +8,7 @@ class GerritAccountSSHKey(BaseModel):
     def __init__(self, **kwargs):
         super().__init__(**kwargs)
         self.entity_name = "seq"
-        self.endpoint = f"/accounts/{self.username}/sshkeys"
+        self.endpoint = f"/accounts/{self.account_id}/sshkeys"
 
     def delete(self):
         """
@@ -20,10 +20,10 @@ class GerritAccountSSHKey(BaseModel):
 
 
 class GerritAccountSSHKeys(object):
-    def __init__(self, username, gerrit):
-        self.username = username
+    def __init__(self, account_id, gerrit):
+        self.account_id = account_id
         self.gerrit = gerrit
-        self.endpoint = f"/accounts/{self.username}/sshkeys"
+        self.endpoint = f"/accounts/{self.account_id}/sshkeys"
 
     def list(self):
         """
@@ -32,7 +32,9 @@ class GerritAccountSSHKeys(object):
         :return:
         """
         result = self.gerrit.get(self.endpoint)
-        return GerritAccountSSHKey.parse_list(result, username=self.username, gerrit=self.gerrit)
+        return GerritAccountSSHKey.parse_list(
+            result, account_id=self.account_id, gerrit=self.gerrit
+        )
 
     def get(self, seq):
         """
@@ -42,7 +44,9 @@ class GerritAccountSSHKeys(object):
         :return:
         """
         result = self.gerrit.get(self.endpoint + f"/{str(seq)}")
-        return GerritAccountSSHKey(json=result, username=self.username, gerrit=self.gerrit)
+        return GerritAccountSSHKey(
+            json=result, account_id=self.account_id, gerrit=self.gerrit
+        )
 
     def add(self, ssh_key):
         """
@@ -52,9 +56,12 @@ class GerritAccountSSHKeys(object):
         :param ssh_key: SSH key raw content
         :return:
         """
-        result = self.gerrit.post(self.endpoint,
-                                  data=ssh_key, headers={"Content-Type": "plain/text"})
-        return GerritAccountSSHKey(json=result, username=self.username, gerrit=self.gerrit)
+        result = self.gerrit.post(
+            self.endpoint, data=ssh_key, headers={"Content-Type": "plain/text"}
+        )
+        return GerritAccountSSHKey(
+            json=result, account_id=self.account_id, gerrit=self.gerrit
+        )
 
     def delete(self, seq):
         """