python-gitlab 4.8.0__tar.gz → 4.9.0__tar.gz

{python_gitlab-4.8.0 → python_gitlab-4.9.0}/CHANGELOG.md

@@ -1,5 +1,34 @@
 # CHANGELOG
 
+## v4.9.0 (2024-08-06)
+
+### Chore
+
+* chore(deps): update pre-commit hook maxbrunet/pre-commit-renovate to v38 ([`f13968b`](https://github.com/python-gitlab/python-gitlab/commit/f13968be9e2bb532f3c1185c1fa4185c05335552))
+
+* chore(deps): update all non-major dependencies ([`f95ca26`](https://github.com/python-gitlab/python-gitlab/commit/f95ca26b411e5a8998eb4b81e41c061726271240))
+
+* chore(deps): update dependency types-setuptools to v71 ([`d6a7dba`](https://github.com/python-gitlab/python-gitlab/commit/d6a7dba600923e582064a77579dea82281871c25))
+
+* chore(deps): update python-semantic-release/upload-to-gh-release digest to 0dcddac ([`eb5c6f7`](https://github.com/python-gitlab/python-gitlab/commit/eb5c6f7fb6487da21c69582adbc69aaf36149143))
+
+* chore(deps): update gitlab/gitlab-ee docker tag to v17.2.1-ee.0 ([`d13a656`](https://github.com/python-gitlab/python-gitlab/commit/d13a656565898886cc6ba11028b3bcb719c21f0f))
+
+* chore(deps): update all non-major dependencies ([`7adc86b`](https://github.com/python-gitlab/python-gitlab/commit/7adc86b2e202cad42776991f0ed8c81517bb37ad))
+
+* chore(deps): update python-semantic-release/upload-to-gh-release digest to e2355e1 ([`eb18552`](https://github.com/python-gitlab/python-gitlab/commit/eb18552e423e270a27a2b205bfd2f22fcb2eb949))
+
+* chore(deps): update all non-major dependencies ([`e820db0`](https://github.com/python-gitlab/python-gitlab/commit/e820db0d9db42a826884b45a76267fee861453d4))
+
+* chore(ci): make pre-commit check happy
+
+pre-commit incorrectly wants double back-quotes inside the code
+section. Rather than fight it, just use single quotes. ([`67370d8`](https://github.com/python-gitlab/python-gitlab/commit/67370d8f083ddc34c0acf0c0b06742a194dfa735))
+
+### Feature
+
+* feat(snippets): add support for listing all instance snippets ([`64ae61e`](https://github.com/python-gitlab/python-gitlab/commit/64ae61ed9ba60169037703041c2a9a71017475b9))
+
 ## v4.8.0 (2024-07-16)
 
 ### Chore

{python_gitlab-4.8.0 → python_gitlab-4.9.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: python-gitlab
-Version: 4.8.0
+Version: 4.9.0
 Summary: A python wrapper for the GitLab API
 Author-email: Gauvain Pocentek <gauvain@pocentek.net>
 Maintainer-email: John Villalovos <john@sodarock.com>, Max Wittig <max.wittig@siemens.com>, Nejc Habjan <nejc.habjan@siemens.com>, Roger Meier <r.meier@siemens.com>

{python_gitlab-4.8.0 → python_gitlab-4.9.0}/docs/api-usage.rst

@@ -428,7 +428,7 @@ then ``save`` the object (using ``sudo``):
    group = gl.groups.get('example-group')
    notification_setting = group.notificationsettings.get(sudo='user1')
    notification_setting.level = gitlab.const.NOTIFICATION_LEVEL_GLOBAL
-   # Must use `sudo` again when doing the save.
+   # Must use 'sudo' again when doing the save.
    notification_setting.save(sudo='user1')
 
 

{python_gitlab-4.8.0 → python_gitlab-4.9.0}/docs/gl_objects/snippets.rst

@@ -22,7 +22,16 @@ List snippets owned by the current user::
 
 List the public snippets::
 
-    public_snippets = gl.snippets.public()
+    public_snippets = gl.snippets.list_public()
+
+List all snippets::
+
+    all_snippets = gl.snippets.list_all()
+
+.. warning::
+
+   Only users with the Administrator or Auditor access levels can see all snippets
+   (both personal and project). See the upstream API documentation for more details.
 
 Get a snippet::
 

{python_gitlab-4.8.0 → python_gitlab-4.9.0}/gitlab/_version.py

@@ -3,4 +3,4 @@ __copyright__ = "Copyright 2013-2019 Gauvain Pocentek, 2019-2023 python-gitlab t
 __email__ = "gauvainpocentek@gmail.com"
 __license__ = "LGPL3"
 __title__ = "python-gitlab"
-__version__ = "4.8.0"
+__version__ = "4.9.0"

{python_gitlab-4.8.0 → python_gitlab-4.9.0}/gitlab/v4/objects/snippets.py

@@ -90,11 +90,35 @@ class SnippetManager(CRUDMixin, RESTManager):
     )
 
     @cli.register_custom_action(cls_names="SnippetManager")
-    def public(self, **kwargs: Any) -> Union[RESTObjectList, List[RESTObject]]:
-        """List all the public snippets.
+    def list_public(self, **kwargs: Any) -> Union[RESTObjectList, List[RESTObject]]:
+        """List all public snippets.
+
+        Args:
+            get_all: If True, return all the items, without pagination
+            per_page: Number of items to retrieve per request
+            page: ID of the page to return (starts with page 1)
+            iterator: If set to True and no pagination option is
+                defined, return a generator instead of a list
+            **kwargs: Extra options to send to the server (e.g. sudo)
+
+        Raises:
+            GitlabListError: If the list could not be retrieved
+
+        Returns:
+            The list of snippets, or a generator if `iterator` is True
+        """
+        return self.list(path="/snippets/public", **kwargs)
+
+    @cli.register_custom_action(cls_names="SnippetManager")
+    def list_all(self, **kwargs: Any) -> Union[RESTObjectList, List[RESTObject]]:
+        """List all snippets.
 
         Args:
-            all: If True the returned object will be a list
+            get_all: If True, return all the items, without pagination
+            per_page: Number of items to retrieve per request
+            page: ID of the page to return (starts with page 1)
+            iterator: If set to True and no pagination option is
+                defined, return a generator instead of a list
             **kwargs: Extra options to send to the server (e.g. sudo)
 
         Raises:
@@ -103,6 +127,32 @@ class SnippetManager(CRUDMixin, RESTManager):
         Returns:
             A generator for the snippets list
         """
+        return self.list(path="/snippets/all", **kwargs)
+
+    def public(self, **kwargs: Any) -> Union[RESTObjectList, List[RESTObject]]:
+        """List all public snippets.
+
+        Args:
+            get_all: If True, return all the items, without pagination
+            per_page: Number of items to retrieve per request
+            page: ID of the page to return (starts with page 1)
+            iterator: If set to True and no pagination option is
+                defined, return a generator instead of a list
+            **kwargs: Extra options to send to the server (e.g. sudo)
+
+        Raises:
+            GitlabListError: If the list could not be retrieved
+
+        Returns:
+            The list of snippets, or a generator if `iterator` is True
+        """
+        utils.warn(
+            message=(
+                "Gitlab.snippets.public() is deprecated and will be removed in a"
+                "future major version. Use Gitlab.snippets.list_public() instead."
+            ),
+            category=DeprecationWarning,
+        )
         return self.list(path="/snippets/public", **kwargs)
 
     def get(self, id: Union[str, int], lazy: bool = False, **kwargs: Any) -> Snippet:

{python_gitlab-4.8.0 → python_gitlab-4.9.0}/python_gitlab.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: python-gitlab
-Version: 4.8.0
+Version: 4.9.0
 Summary: A python wrapper for the GitLab API
 Author-email: Gauvain Pocentek <gauvain@pocentek.net>
 Maintainer-email: John Villalovos <john@sodarock.com>, Max Wittig <max.wittig@siemens.com>, Nejc Habjan <nejc.habjan@siemens.com>, Roger Meier <r.meier@siemens.com>

{python_gitlab-4.8.0 → python_gitlab-4.9.0}/requirements-docs.txt

@@ -1,6 +1,6 @@
 -r requirements.txt
-furo==2024.5.6
+furo==2024.7.18
 jinja2==3.1.4
 myst-parser==3.0.1
-sphinx==7.3.7
+sphinx==7.4.7
 sphinxcontrib-autoprogram==0.1.9

python_gitlab-4.9.0/requirements-lint.txt

@@ -0,0 +1,13 @@
+-r requirements.txt
+argcomplete==2.0.0
+black==24.8.0
+commitizen==3.28.0
+flake8==7.1.1
+isort==5.13.2
+mypy==1.11.1
+pylint==3.2.6
+pytest==8.3.2
+responses==0.25.3
+types-PyYAML==6.0.12.20240724
+types-requests==2.32.0.20240712
+types-setuptools==71.1.0.20240726

python_gitlab-4.9.0/requirements-precommit.txt

@@ -0,0 +1 @@
+pre-commit==3.8.0

{python_gitlab-4.8.0 → python_gitlab-4.9.0}/requirements-test.txt

@@ -1,10 +1,10 @@
 -r requirements.txt
 build==1.2.1
-coverage==7.6.0
+coverage==7.6.1
 pytest-console-scripts==1.4.1
 pytest-cov==5.0.0
 pytest-github-actions-annotate-failures==0.2.0
-pytest==8.2.2
+pytest==8.3.2
 PyYaml==6.0.1
 responses==0.25.3
-wheel==0.43.0
+wheel==0.44.0

{python_gitlab-4.8.0 → python_gitlab-4.9.0}/tests/functional/api/test_snippets.py

@@ -23,6 +23,13 @@ def test_snippets(gl):
     content = snippet.content()
     assert content.decode() == "import gitlab"
 
+    all_snippets = gl.snippets.list_all(get_all=True)
+    public_snippets = gl.snippets.public(get_all=True)
+    list_public_snippets = gl.snippets.list_public(get_all=True)
+    assert isinstance(all_snippets, list)
+    assert isinstance(list_public_snippets, list)
+    assert public_snippets == list_public_snippets
+
     snippet.delete()
 
 

{python_gitlab-4.8.0 → python_gitlab-4.9.0}/tests/functional/fixtures/.env

@@ -1,2 +1,2 @@
 GITLAB_IMAGE=gitlab/gitlab-ee
-GITLAB_TAG=17.1.2-ee.0
+GITLAB_TAG=17.2.1-ee.0

python_gitlab-4.8.0/requirements-lint.txt

@@ -1,13 +0,0 @@
--r requirements.txt
-argcomplete==2.0.0
-black==24.4.2
-commitizen==3.27.0
-flake8==7.1.0
-isort==5.13.2
-mypy==1.10.1
-pylint==3.2.5
-pytest==8.2.2
-responses==0.25.3
-types-PyYAML==6.0.12.20240311
-types-requests==2.32.0.20240712
-types-setuptools==70.3.0.20240710

python_gitlab-4.8.0/requirements-precommit.txt

@@ -1 +0,0 @@
-pre-commit==3.7.1