python-gerrit-api 3.0.8__tar.gz → 3.1.0__tar.gz

{python_gerrit_api-3.0.8/python_gerrit_api.egg-info → python_gerrit_api-3.1.0}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: python-gerrit-api
-Version: 3.0.8
+Version: 3.1.0
 Summary: Python wrapper for the Gerrit REST API.
 Home-page: https://github.com/shijl0925/python-gerrit-api
 Author: Jialiang Shi
@@ -20,12 +20,26 @@ Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Topic :: Software Development
+Description-Content-Type: text/x-rst
 License-File: LICENSE
 Requires-Dist: requests
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: keywords
+Dynamic: license
+Dynamic: license-file
+Dynamic: requires-dist
+Dynamic: summary
 
 Project description
 ===================
 
+.. image:: https://repobeats.axiom.co/api/embed/89080ed0f569186ab5d752a9585870f515e2f131.svg
+
 .. image:: https://img.shields.io/pypi/pyversions/python-gerrit-api.svg
     :target: https://pypi.python.org/pypi/python-gerrit-api
 .. image:: https://img.shields.io/pypi/v/python-gerrit-api.svg

{python_gerrit_api-3.0.8 → python_gerrit_api-3.1.0}/README.rst

@@ -1,6 +1,8 @@
 Project description
 ===================
 
+.. image:: https://repobeats.axiom.co/api/embed/89080ed0f569186ab5d752a9585870f515e2f131.svg
+
 .. image:: https://img.shields.io/pypi/pyversions/python-gerrit-api.svg
     :target: https://pypi.python.org/pypi/python-gerrit-api
 .. image:: https://img.shields.io/pypi/v/python-gerrit-api.svg

{python_gerrit_api-3.0.8 → python_gerrit_api-3.1.0}/gerrit/__init__.py

@@ -1,6 +1,8 @@
 #!/usr/bin/env python
 # -*- coding:utf-8 -*-
 # @Author: Jialiang Shi
-__version__ = "3.0.8"
+__version__ = "3.1.0"
 
 from gerrit.base import GerritClient
+
+__all__ = ["GerritClient"]

{python_gerrit_api-3.0.8 → python_gerrit_api-3.1.0}/gerrit/accounts/account.py

@@ -1,6 +1,7 @@
 #!/usr/bin/env python
 # -*- coding:utf-8 -*-
 # @Author: Jialiang Shi
+from gerrit import GerritClient
 from gerrit.utils.gerritbase import GerritBase
 from gerrit.accounts.emails import GerritAccountEmails
 from gerrit.accounts.ssh_keys import GerritAccountSSHKeys
@@ -8,11 +9,11 @@ from gerrit.accounts.gpg_keys import GerritAccountGPGKeys
 
 
 class GerritAccount(GerritBase):
-    def __init__(self, account, gerrit):
+    def __init__(self, account, gerrit: GerritClient):
         self.account = account
         self.gerrit = gerrit
         self.endpoint = f"/accounts/{self.account}"
-        super().__init__(self)
+        super().__init__()
 
     def __str__(self):
         return str(self.account)

{python_gerrit_api-3.0.8 → python_gerrit_api-3.1.0}/gerrit/accounts/accounts.py

@@ -3,7 +3,7 @@
 # @Author: Jialiang Shi
 import logging
 import requests
-from gerrit.accounts.account import GerritAccount
+from gerrit import GerritClient
 from gerrit.utils.exceptions import (
     AccountNotFoundError,
     AccountAlreadyExistsError,
@@ -15,7 +15,7 @@ logger = logging.getLogger(__name__)
 
 
 class GerritAccounts:
-    def __init__(self, gerrit):
+    def __init__(self, gerrit: GerritClient):
         self.gerrit = gerrit
         self.endpoint = "/accounts"
 
@@ -50,7 +50,6 @@ class GerritAccounts:
             None,
             ["DETAILS" if detailed else None, "ALL_EMAILS" if all_emails else None],
         )
-        # option = None if not option else option
         params = {
             k: v for k, v in (("n", limit), ("S", skip), ("o", option)) if v is not None
         }
@@ -69,11 +68,15 @@ class GerritAccounts:
         :param account: username or email or _account_id or 'self'
         :return:
         """
+        from gerrit.accounts.account import GerritAccount
+
         try:
             endpoint = self.endpoint + f"/{account}/"
             result = self.gerrit.get(endpoint)
 
             account_ = result.get("_account_id")
+            if account_ is None:
+                raise ValueError("Account ID not found")
             return GerritAccount(account=account_, gerrit=self.gerrit)
         except requests.exceptions.HTTPError as error:
             if error.response.status_code == 404:

{python_gerrit_api-3.0.8 → python_gerrit_api-3.1.0}/gerrit/accounts/emails.py

@@ -3,6 +3,7 @@
 # @Author: Jialiang Shi
 import logging
 import requests
+from gerrit import GerritClient
 from gerrit.utils.gerritbase import GerritBase
 from gerrit.utils.exceptions import (
     AccountEmailNotFoundError,
@@ -15,12 +16,12 @@ logger = logging.getLogger(__name__)
 
 
 class GerritAccountEmail(GerritBase):
-    def __init__(self, email, account, gerrit):
+    def __init__(self, email, account, gerrit: GerritClient):
         self.email = email
         self.account = account
         self.gerrit = gerrit
         self.endpoint = f"/accounts/{self.account}/emails/{self.email}"
-        super().__init__(self)
+        super().__init__()
 
     def __str__(self):
         return self.email
@@ -43,7 +44,7 @@ class GerritAccountEmail(GerritBase):
 
 
 class GerritAccountEmails:
-    def __init__(self, account, gerrit):
+    def __init__(self, account, gerrit: GerritClient):
         self.account = account
         self.gerrit = gerrit
         self.endpoint = f"/accounts/{self.account}/emails"

{python_gerrit_api-3.0.8 → python_gerrit_api-3.1.0}/gerrit/accounts/gpg_keys.py

@@ -3,6 +3,7 @@
 # @Author: Jialiang Shi
 import logging
 import requests
+from gerrit import GerritClient
 from gerrit.utils.gerritbase import GerritBase
 from gerrit.utils.exceptions import GPGKeyNotFoundError, GerritAPIException
 
@@ -10,12 +11,12 @@ logger = logging.getLogger(__name__)
 
 
 class GerritAccountGPGKey(GerritBase):
-    def __init__(self, id, account, gerrit):
+    def __init__(self, id, account, gerrit: GerritClient):
         self.id = id
         self.account = account
         self.gerrit = gerrit
         self.endpoint = f"/accounts/{self.account}/gpgkeys/{self.id}"
-        super().__init__(self)
+        super().__init__()
 
     def __str__(self):
         return self.id
@@ -30,7 +31,7 @@ class GerritAccountGPGKey(GerritBase):
 
 
 class GerritAccountGPGKeys:
-    def __init__(self, account, gerrit):
+    def __init__(self, account, gerrit: GerritClient):
         self.account = account
         self.gerrit = gerrit
         self.endpoint = f"/accounts/{self.account}/gpgkeys"

{python_gerrit_api-3.0.8 → python_gerrit_api-3.1.0}/gerrit/accounts/ssh_keys.py

@@ -3,6 +3,7 @@
 # @Author: Jialiang Shi
 import logging
 import requests
+from gerrit import GerritClient
 from gerrit.utils.gerritbase import GerritBase
 from gerrit.utils.exceptions import SSHKeyNotFoundError, GerritAPIException
 
@@ -10,12 +11,12 @@ logger = logging.getLogger(__name__)
 
 
 class GerritAccountSSHKey(GerritBase):
-    def __init__(self, seq, account, gerrit):
+    def __init__(self, seq, account, gerrit: GerritClient):
         self.seq = seq
         self.account = account
         self.gerrit = gerrit
         self.endpoint = f"/accounts/{self.account}/sshkeys"
-        super().__init__(self)
+        super().__init__()
 
     def __str__(self):
         return str(self.seq)
@@ -30,7 +31,7 @@ class GerritAccountSSHKey(GerritBase):
 
 
 class GerritAccountSSHKeys:
-    def __init__(self, account, gerrit):
+    def __init__(self, account, gerrit: GerritClient):
         self.account = account
         self.gerrit = gerrit
         self.endpoint = f"/accounts/{self.account}/sshkeys"

{python_gerrit_api-3.0.8 → python_gerrit_api-3.1.0}/gerrit/base.py

@@ -1,17 +1,14 @@
 #!/usr/bin/env python
 # -*- coding:utf-8 -*-
 # @Author: Jialiang Shi
+import logging
 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
-from gerrit.groups.groups import GerritGroups
-from gerrit.plugins.plugins import GerritPlugins
-from gerrit.changes.changes import GerritChanges
+
+logger = logging.getLogger(__name__)
 
 
 class GerritClient:
@@ -30,39 +27,50 @@ class GerritClient:
         use_netrc=False,
         ssl_verify=True,
         cert=None,
+        cookies=None,
+        cookie_jar=None,
         timeout=60,
         max_retries=None,
+        session=None,
         auth_suffix="/a",
     ):
         self._base_url = strip_trailing_slash(base_url)
 
+        # make request session if one isn't provided
+        if session is None:
+            session = requests.Session()
+
         if use_netrc:
             password = self.get_password_from_netrc_file()
 
-        # make request session
-        _session = requests.Session()
         if username and password:
-            _session.auth = (username, password)
+            session.auth = (username, password)
 
         if ssl_verify:
-            _session.verify = ssl_verify
+            session.verify = ssl_verify
 
         if cert is not None:
-            _session.cert = cert
+            session.cert = cert
+
+        if cookies is not None:
+            session.cookies.update(cookies)
+
+        if cookie_jar is not None:
+            session.cookies = cookie_jar
 
         if max_retries is not None:
             retry_adapter = HTTPAdapter(max_retries=max_retries)
-            _session.mount("http://", retry_adapter)
-            _session.mount("https://", retry_adapter)
+            session.mount("http://", retry_adapter)
+            session.mount("https://", retry_adapter)
 
-        self.session = _session
+        self.session = session
 
         self.requester = Requester(
             base_url=base_url,
             session=self.session,
             timeout=timeout,
         )
-        if username and password:
+        if self.session.auth is not None:
             self.auth_suffix = auth_suffix
         else:
             self.auth_suffix = ""
@@ -96,6 +104,7 @@ class GerritClient:
 
         :return:
         """
+        from gerrit.config.config import GerritConfig
         return GerritConfig(gerrit=self)
 
     @property
@@ -104,6 +113,7 @@ class GerritClient:
         Project related REST APIs
         :return:
         """
+        from gerrit.projects.projects import GerritProjects
         return GerritProjects(gerrit=self)
 
     @property
@@ -113,6 +123,7 @@ class GerritClient:
 
         :return:
         """
+        from gerrit.changes.changes import GerritChanges
         return GerritChanges(gerrit=self)
 
     @property
@@ -122,6 +133,7 @@ class GerritClient:
 
         :return:
         """
+        from gerrit.accounts.accounts import GerritAccounts
         return GerritAccounts(gerrit=self)
 
     @property
@@ -131,6 +143,7 @@ class GerritClient:
 
         :return:
         """
+        from gerrit.groups.groups import GerritGroups
         return GerritGroups(gerrit=self)
 
     @property
@@ -140,6 +153,7 @@ class GerritClient:
 
         :return:
         """
+        from gerrit.plugins.plugins import GerritPlugins
         return GerritPlugins(gerrit=self)
 
     @property
@@ -167,7 +181,9 @@ class GerritClient:
         :param endpoint: The endpoint to send to.
         :return:
         """
-        response = self.requester.get(self.get_endpoint_url(endpoint), **kwargs)
+        url = self.get_endpoint_url(endpoint)
+        logger.debug("Sending GET request to %s", url)
+        response = self.requester.get(url, **kwargs)
         result = decode_response(response)
         return result
 
@@ -178,7 +194,9 @@ class GerritClient:
         :param endpoint: The endpoint to send to.
         :return:
         """
-        response = self.requester.post(self.get_endpoint_url(endpoint), **kwargs)
+        url = self.get_endpoint_url(endpoint)
+        logger.debug("Sending POST request to %s", url)
+        response = self.requester.post(url, **kwargs)
         result = decode_response(response)
         return result
 
@@ -189,7 +207,9 @@ class GerritClient:
         :param endpoint: The endpoint to send to.
         :return:
         """
-        response = self.requester.put(self.get_endpoint_url(endpoint), **kwargs)
+        url = self.get_endpoint_url(endpoint)
+        logger.debug("Sending PUT request to %s", url)
+        response = self.requester.put(url, **kwargs)
         result = decode_response(response)
         return result
 
@@ -200,4 +220,6 @@ class GerritClient:
         :param endpoint: The endpoint to send to.
         :return:
         """
-        self.requester.delete(self.get_endpoint_url(endpoint))
+        url = self.get_endpoint_url(endpoint)
+        logger.debug("Sending DELETE request to %s", url)
+        self.requester.delete(url)

{python_gerrit_api-3.0.8 → python_gerrit_api-3.1.0}/gerrit/changes/change.py

@@ -2,6 +2,7 @@
 # -*- coding:utf-8 -*-
 # @Author: Jialiang Shi
 from typing import Dict
+from gerrit import GerritClient
 from gerrit.utils.gerritbase import GerritBase
 from gerrit.changes.reviewers import GerritChangeReviewers
 from gerrit.changes.revision import GerritChangeRevision
@@ -11,11 +12,11 @@ from gerrit.utils.exceptions import ChangeEditNotFoundError
 
 
 class GerritChange(GerritBase):
-    def __init__(self, id: str, gerrit):
+    def __init__(self, id: str, gerrit: GerritClient):
         self.id = id
         self.gerrit = gerrit
         self.endpoint = f"/changes/{self.id}"
-        super().__init__(self)
+        super().__init__()
 
         self.revisions: Dict[str, str] = {}
         self.current_revision_number = 0

{python_gerrit_api-3.0.8 → python_gerrit_api-3.1.0}/gerrit/changes/changes.py

@@ -3,6 +3,7 @@
 # @Author: Jialiang Shi
 import logging
 import requests
+from gerrit import GerritClient
 from gerrit.changes.change import GerritChange
 from gerrit.utils.exceptions import ChangeNotFoundError, GerritAPIException
 
@@ -11,7 +12,7 @@ logger = logging.getLogger(__name__)
 
 
 class GerritChanges:
-    def __init__(self, gerrit):
+    def __init__(self, gerrit: GerritClient):
         self.gerrit = gerrit
         self.endpoint = "/changes"
 

{python_gerrit_api-3.0.8 → python_gerrit_api-3.1.0}/gerrit/changes/comments.py

@@ -1,11 +1,12 @@
 #!/usr/bin/env python
 # -*- coding:utf-8 -*-
 # @Author: Jialiang Shi
+from gerrit import GerritClient
 from gerrit.utils.gerritbase import GerritBase
 
 
 class GerritChangeRevisionComment(GerritBase):
-    def __init__(self, id: str, change: str, revision: str, gerrit):
+    def __init__(self, id: str, change: str, revision: str, gerrit: GerritClient):
         self.id = id
         self.change = change
         self.revision = revision
@@ -13,7 +14,7 @@ class GerritChangeRevisionComment(GerritBase):
         self.endpoint = (
             f"/changes/{self.change}/revisions/{self.revision}/comments/{self.id}"
         )
-        super().__init__(self)
+        super().__init__()
 
     def __str__(self):
         return self.id
@@ -52,7 +53,7 @@ class GerritChangeRevisionComment(GerritBase):
 
 
 class GerritChangeRevisionComments:
-    def __init__(self, change, revision, gerrit):
+    def __init__(self, change, revision, gerrit: GerritClient):
         self.change = change
         self.revision = revision
         self.gerrit = gerrit

{python_gerrit_api-3.0.8 → python_gerrit_api-3.1.0}/gerrit/changes/drafts.py

@@ -1,11 +1,12 @@
 #!/usr/bin/env python
 # -*- coding:utf-8 -*-
 # @Author: Jialiang Shi
+from gerrit import GerritClient
 from gerrit.utils.gerritbase import GerritBase
 
 
 class GerritChangeRevisionDraft(GerritBase):
-    def __init__(self, id: str, change: str, revision: str, gerrit):
+    def __init__(self, id: str, change: str, revision: str, gerrit: GerritClient):
         self.id = id
         self.change = change
         self.revision = revision
@@ -13,7 +14,7 @@ class GerritChangeRevisionDraft(GerritBase):
         self.endpoint = (
             f"/changes/{self.change}/revisions/{self.revision}/drafts/{self.id}"
         )
-        super().__init__(self)
+        super().__init__()
 
     def __str__(self):
         return self.id
@@ -52,7 +53,7 @@ class GerritChangeRevisionDraft(GerritBase):
 
 
 class GerritChangeRevisionDrafts:
-    def __init__(self, change, revision, gerrit):
+    def __init__(self, change, revision, gerrit: GerritClient):
         self.change = change
         self.revision = revision
         self.gerrit = gerrit

{python_gerrit_api-3.0.8 → python_gerrit_api-3.1.0}/gerrit/changes/edit.py

@@ -2,16 +2,17 @@
 # -*- coding:utf-8 -*-
 # @Author: Jialiang Shi
 from urllib.parse import quote_plus
+from gerrit import GerritClient
 from gerrit.utils.gerritbase import GerritBase
 
 
 class GerritChangeEdit(GerritBase):
-    def __init__(self, change: str, gerrit):
+    def __init__(self, change: str, gerrit: GerritClient):
         self.change = change
         self.gerrit = gerrit
         self.endpoint = f"/changes/{self.change}/edit"
 
-        super().__init__(self)
+        super().__init__()
 
     def __str__(self):
         return f"change {self.change} edit"
@@ -46,7 +47,7 @@ class GerritChangeEdit(GerritBase):
         self.gerrit.put(
             self.endpoint + f"/{quote_plus(file)}",
             data=file_content,
-            headers={"Content-Type": "plain/text"},
+            headers={"Content-Type": "text/plain"},
         )
 
     def restore_file_content(self, file):

{python_gerrit_api-3.0.8 → python_gerrit_api-3.1.0}/gerrit/changes/files.py

@@ -6,6 +6,7 @@ from typing import Optional
 from base64 import b64decode
 from urllib.parse import quote_plus
 import requests
+from gerrit import GerritClient
 from gerrit.utils.exceptions import (
     UnknownFile,
     FileContentNotFoundError,
@@ -17,7 +18,7 @@ logger = logging.getLogger(__name__)
 
 
 class GerritChangeRevisionFile:
-    def __init__(self, path: str, json: dict, change: str, revision: str, gerrit):
+    def __init__(self, path: str, json: dict, change: str, revision: str, gerrit: GerritClient):
         self.path = path
         self.json = json
         self.change = change
@@ -81,7 +82,7 @@ class GerritChangeRevisionFile:
         """
         endpoint = self.endpoint + "/diff"
         if intraline:
-            endpoint += endpoint + "?intraline"
+            endpoint += "?intraline"
 
         return self.gerrit.get(endpoint)
 
@@ -111,7 +112,7 @@ class GerritChangeRevisionFile:
 
 
 class GerritChangeRevisionFiles:
-    def __init__(self, change, revision, gerrit):
+    def __init__(self, change, revision, gerrit: GerritClient):
         self.change = change
         self.revision = revision
         self.gerrit = gerrit

{python_gerrit_api-3.0.8 → python_gerrit_api-3.1.0}/gerrit/changes/messages.py

@@ -1,16 +1,17 @@
 #!/usr/bin/env python
 # -*- coding:utf-8 -*-
 # @Author: Jialiang Shi
+from gerrit import GerritClient
 from gerrit.utils.gerritbase import GerritBase
 
 
 class GerritChangeMessage(GerritBase):
-    def __init__(self, id: str, change: str, gerrit):
+    def __init__(self, id: str, change: str, gerrit: GerritClient):
         self.id = id
         self.change = change
         self.gerrit = gerrit
         self.endpoint = f"/changes/{self.change}/messages/{self.id}"
-        super().__init__(self)
+        super().__init__()
 
     def __str__(self):
         return self.id
@@ -47,7 +48,7 @@ class GerritChangeMessage(GerritBase):
 
 
 class GerritChangeMessages:
-    def __init__(self, change, gerrit):
+    def __init__(self, change, gerrit: GerritClient):
         self.change = change
         self.gerrit = gerrit
         self.endpoint = f"/changes/{self.change}/messages"

{python_gerrit_api-3.0.8 → python_gerrit_api-3.1.0}/gerrit/changes/reviewers.py

@@ -3,6 +3,7 @@
 # @Author: Jialiang Shi
 import logging
 import requests
+from gerrit import GerritClient
 from gerrit.utils.gerritbase import GerritBase
 from gerrit.utils.exceptions import (
     ReviewerNotFoundError,
@@ -14,12 +15,12 @@ logger = logging.getLogger(__name__)
 
 
 class GerritChangeReviewer(GerritBase):
-    def __init__(self, account: str, change: str, gerrit):
+    def __init__(self, account: str, change: str, gerrit: GerritClient):
         self.account = account
         self.change = change
         self.gerrit = gerrit
         self.endpoint = f"/changes/{self.change}/reviewers/{self.account}"
-        super().__init__(self)
+        super().__init__()
 
     def __str__(self):
         return str(self.account)
@@ -95,7 +96,7 @@ class GerritChangeReviewer(GerritBase):
 
 
 class GerritChangeReviewers:
-    def __init__(self, change, gerrit):
+    def __init__(self, change, gerrit: GerritClient):
         self.change = change
         self.gerrit = gerrit
         self.endpoint = f"/changes/{self.change}/reviewers"

{python_gerrit_api-3.0.8 → python_gerrit_api-3.1.0}/gerrit/changes/revision.py

@@ -3,13 +3,14 @@
 # @Author: Jialiang Shi
 from base64 import b64decode
 from urllib.parse import quote_plus
+from gerrit import GerritClient
 from gerrit.changes.drafts import GerritChangeRevisionDrafts
 from gerrit.changes.comments import GerritChangeRevisionComments
 from gerrit.changes.files import GerritChangeRevisionFiles
 
 
 class GerritChangeRevision:
-    def __init__(self, gerrit, change, revision="current"):
+    def __init__(self, gerrit: GerritClient, change: str, revision: str = "current"):
         self.change = change
         self.revision = revision
         self.gerrit = gerrit
@@ -207,14 +208,18 @@ class GerritChangeRevision:
         """
         endpoint = self.endpoint + "/patch"
 
+        query_params = []
         if zip_:
-            endpoint += endpoint + "?zip"
+            query_params.append("zip")
 
         if download:
-            endpoint += endpoint + "?download"
+            query_params.append("download")
 
         if path:
-            endpoint += endpoint + f"?path={quote_plus(path)}"
+            query_params.append(f"path={quote_plus(path)}")
+
+        if query_params:
+            endpoint += "?" + "&".join(query_params)
 
         result = self.gerrit.get(endpoint)
         if decode:
@@ -258,7 +263,7 @@ class GerritChangeRevision:
         return self.gerrit.post(
             self.endpoint + "/test.submit_type",
             data=input_,
-            headers={"Content-Type": "plain/text"},
+            headers={"Content-Type": "text/plain"},
         )
 
     def test_submit_rule(self, input_):
@@ -272,7 +277,7 @@ class GerritChangeRevision:
         return self.gerrit.post(
             self.endpoint + "/test.submit_rule",
             data=input_,
-            headers={"Content-Type": "plain/text"},
+            headers={"Content-Type": "text/plain"},
         )
 
     @property