python-gitlab 4.1.1__py3-none-any.whl → 4.2.0__py3-none-any.whl

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.1.1"
+__version__ = "4.2.0"

gitlab/const.py

@@ -72,6 +72,21 @@ class DetailedMergeStatus(GitlabEnum):
     POLICIES_DENIED: str = "policies_denied"
 
 
+# https://docs.gitlab.com/ee/api/pipelines.html
+class PipelineStatus(GitlabEnum):
+    CREATED: str = "created"
+    WAITING_FOR_RESOURCE: str = "waiting_for_resource"
+    PREPARING: str = "preparing"
+    PENDING: str = "pending"
+    RUNNING: str = "running"
+    SUCCESS: str = "success"
+    FAILED: str = "failed"
+    CANCELED: str = "canceled"
+    SKIPPED: str = "skipped"
+    MANUAL: str = "manual"
+    SCHEDULED: str = "scheduled"
+
+
 DEFAULT_URL: str = "https://gitlab.com"
 
 NO_ACCESS = AccessLevel.NO_ACCESS.value

gitlab/mixins.py

@@ -944,3 +944,73 @@ class PromoteMixin(_RestObjectBase):
         if TYPE_CHECKING:
             assert not isinstance(result, requests.Response)
         return result
+
+
+class UploadMixin(_RestObjectBase):
+    _id_attr: Optional[str]
+    _attrs: Dict[str, Any]
+    _module: ModuleType
+    _parent_attrs: Dict[str, Any]
+    _updated_attrs: Dict[str, Any]
+    _upload_path: str
+    manager: base.RESTManager
+
+    def _get_upload_path(self) -> str:
+        """Formats _upload_path with object attributes.
+
+        Returns:
+            The upload path
+        """
+        if TYPE_CHECKING:
+            assert isinstance(self._upload_path, str)
+        data = self.attributes
+        return self._upload_path.format(**data)
+
+    @cli.register_custom_action(("Project", "ProjectWiki"), ("filename", "filepath"))
+    @exc.on_http_error(exc.GitlabUploadError)
+    def upload(
+        self,
+        filename: str,
+        filedata: Optional[bytes] = None,
+        filepath: Optional[str] = None,
+        **kwargs: Any,
+    ) -> Dict[str, Any]:
+        """Upload the specified file.
+
+        .. note::
+
+            Either ``filedata`` or ``filepath`` *MUST* be specified.
+
+        Args:
+            filename: The name of the file being uploaded
+            filedata: The raw data of the file being uploaded
+            filepath: The path to a local file to upload (optional)
+
+        Raises:
+            GitlabAuthenticationError: If authentication is not correct
+            GitlabUploadError: If the file upload fails
+            GitlabUploadError: If ``filedata`` and ``filepath`` are not
+                specified
+            GitlabUploadError: If both ``filedata`` and ``filepath`` are
+                specified
+
+        Returns:
+            A ``dict`` with info on the uploaded file
+        """
+        if filepath is None and filedata is None:
+            raise exc.GitlabUploadError("No file contents or path specified")
+
+        if filedata is not None and filepath is not None:
+            raise exc.GitlabUploadError("File contents and file path specified")
+
+        if filepath is not None:
+            with open(filepath, "rb") as f:
+                filedata = f.read()
+
+        file_info = {"file": (filename, filedata)}
+        path = self._get_upload_path()
+        server_data = self.manager.gitlab.http_post(path, files=file_info, **kwargs)
+
+        if TYPE_CHECKING:
+            assert isinstance(server_data, dict)
+        return server_data

gitlab/v4/objects/projects.py

@@ -30,6 +30,7 @@ from gitlab.mixins import (
     RefreshMixin,
     SaveMixin,
     UpdateMixin,
+    UploadMixin,
 )
 from gitlab.types import RequiredOptional
 
@@ -158,8 +159,11 @@ class ProjectGroupManager(ListMixin, RESTManager):
     _types = {"skip_groups": types.ArrayAttribute}
 
 
-class Project(RefreshMixin, SaveMixin, ObjectDeleteMixin, RepositoryMixin, RESTObject):
+class Project(
+    RefreshMixin, SaveMixin, ObjectDeleteMixin, RepositoryMixin, UploadMixin, RESTObject
+):
     _repr_attr = "path_with_namespace"
+    _upload_path = "/projects/{id}/uploads"
 
     access_tokens: ProjectAccessTokenManager
     accessrequests: ProjectAccessRequestManager
@@ -437,59 +441,6 @@ class Project(RefreshMixin, SaveMixin, ObjectDeleteMixin, RepositoryMixin, RESTO
         path = f"/projects/{self.encoded_id}/housekeeping"
         self.manager.gitlab.http_post(path, **kwargs)
 
-    # see #56 - add file attachment features
-    @cli.register_custom_action("Project", ("filename", "filepath"))
-    @exc.on_http_error(exc.GitlabUploadError)
-    def upload(
-        self,
-        filename: str,
-        filedata: Optional[bytes] = None,
-        filepath: Optional[str] = None,
-        **kwargs: Any,
-    ) -> Dict[str, Any]:
-        """Upload the specified file into the project.
-
-        .. note::
-
-            Either ``filedata`` or ``filepath`` *MUST* be specified.
-
-        Args:
-            filename: The name of the file being uploaded
-            filedata: The raw data of the file being uploaded
-            filepath: The path to a local file to upload (optional)
-
-        Raises:
-            GitlabConnectionError: If the server cannot be reached
-            GitlabUploadError: If the file upload fails
-            GitlabUploadError: If ``filedata`` and ``filepath`` are not
-                specified
-            GitlabUploadError: If both ``filedata`` and ``filepath`` are
-                specified
-
-        Returns:
-            A ``dict`` with the keys:
-                * ``alt`` - The alternate text for the upload
-                * ``url`` - The direct url to the uploaded file
-                * ``markdown`` - Markdown for the uploaded file
-        """
-        if filepath is None and filedata is None:
-            raise exc.GitlabUploadError("No file contents or path specified")
-
-        if filedata is not None and filepath is not None:
-            raise exc.GitlabUploadError("File contents and file path specified")
-
-        if filepath is not None:
-            with open(filepath, "rb") as f:
-                filedata = f.read()
-
-        url = f"/projects/{self.encoded_id}/uploads"
-        file_info = {"file": (filename, filedata)}
-        data = self.manager.gitlab.http_post(url, files=file_info, **kwargs)
-
-        if TYPE_CHECKING:
-            assert isinstance(data, dict)
-        return {"alt": data["alt"], "url": data["url"], "markdown": data["markdown"]}
-
     @cli.register_custom_action("Project")
     @exc.on_http_error(exc.GitlabRestoreError)
     def restore(self, **kwargs: Any) -> None:

gitlab/v4/objects/wikis.py

@@ -1,7 +1,7 @@
 from typing import Any, cast, Union
 
 from gitlab.base import RESTManager, RESTObject
-from gitlab.mixins import CRUDMixin, ObjectDeleteMixin, SaveMixin
+from gitlab.mixins import CRUDMixin, ObjectDeleteMixin, SaveMixin, UploadMixin
 from gitlab.types import RequiredOptional
 
 __all__ = [
@@ -12,9 +12,10 @@ __all__ = [
 ]
 
 
-class ProjectWiki(SaveMixin, ObjectDeleteMixin, RESTObject):
+class ProjectWiki(SaveMixin, ObjectDeleteMixin, UploadMixin, RESTObject):
     _id_attr = "slug"
     _repr_attr = "slug"
+    _upload_path = "/projects/{project_id}/wikis/attachments"
 
 
 class ProjectWikiManager(CRUDMixin, RESTManager):
@@ -33,9 +34,10 @@ class ProjectWikiManager(CRUDMixin, RESTManager):
         return cast(ProjectWiki, super().get(id=id, lazy=lazy, **kwargs))
 
 
-class GroupWiki(SaveMixin, ObjectDeleteMixin, RESTObject):
+class GroupWiki(SaveMixin, ObjectDeleteMixin, UploadMixin, RESTObject):
     _id_attr = "slug"
     _repr_attr = "slug"
+    _upload_path = "/groups/{group_id}/wikis/attachments"
 
 
 class GroupWikiManager(CRUDMixin, RESTManager):

{python_gitlab-4.1.1.dist-info → python_gitlab-4.2.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: python-gitlab
-Version: 4.1.1
+Version: 4.2.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.1.1.dist-info → python_gitlab-4.2.0.dist-info}/RECORD

@@ -1,13 +1,13 @@
 gitlab/__init__.py,sha256=bd8BSLyUUjtHMKtzmf-T5855W6FUHcuhIwx2hNu0w2o,1382
 gitlab/__main__.py,sha256=HTesNl0UAU6mPb9EXWkTKMy6Q6pAUxGi3iPnDHTE2uE,68
-gitlab/_version.py,sha256=4ND-3y9PbF2cOmaGX2KFnS2n9JRfbml9ADPirr6z64k,249
+gitlab/_version.py,sha256=YV5YCBnPKqGQ0ofpOS-7sXEufkVPLeL9S2OI0Va7gjw,249
 gitlab/base.py,sha256=5cotawlHD01Vw88aN4o7wNIhDyk_bmcwubX4mbOpnVo,13780
 gitlab/cli.py,sha256=uSziJ47Ig7FAIjkWC_R6lRwtv_ZjRnbVruqkwh-DU2s,11911
 gitlab/client.py,sha256=uOjnB4Bvb2NFYGNLk66s_-4gRUQfZJT_QaHmUJQ1g00,48660
 gitlab/config.py,sha256=T1DgUXD0-MN2qNszrv-SO5d4uy0FITnNN0vWJgOt2yo,9088
-gitlab/const.py,sha256=nC-Q20y5JlUcRVnfQsd0fdhYxGswkUxtvgkqaBPLNjg,4917
+gitlab/const.py,sha256=rtPU-fxVSOvgpueoQVTvZGQp6iAZ-aa3nsY4RcSs_M4,5352
 gitlab/exceptions.py,sha256=4CC99arH58PGH8cd7eCiFEVjjcw8CRmc1VFmChjqM1k,8220
-gitlab/mixins.py,sha256=NbRFfWuBzZJSlyHC6J_SihJyINBBw2LF5MwUW4s8Aj8,32092
+gitlab/mixins.py,sha256=bCa_sI4wbdDrugoMy17ouLeNL5i19hJBsqbSz2QAiP8,34376
 gitlab/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 gitlab/types.py,sha256=lepiiI_YOr94B4koqIHuY70tszZC_X3YW4lDvbadbI8,3312
 gitlab/utils.py,sha256=Ppip4O1MsiNeddyWV4JZR9SNhgIag5MieN58ozoTAgo,6391
@@ -69,7 +69,7 @@ gitlab/v4/objects/pages.py,sha256=o6EHYJa-4qo8-IolppZk5Y5o64CAIlLceW2LPNR3nM4,11
 gitlab/v4/objects/personal_access_tokens.py,sha256=5ynVC-tdi3U4hZSMBJfJsQeEh5PbxVF6LxnW00H8Te8,1222
 gitlab/v4/objects/pipelines.py,sha256=wOSbwULKHVQuoRcoFw-hwkmoZz08LVs2IFNSef9sJhg,9723
 gitlab/v4/objects/project_access_tokens.py,sha256=I730Y14izzXLbcuhxHbxzASt00i-EUKqb7ynicTP99o,706
-gitlab/v4/objects/projects.py,sha256=ccl8kRMWbSqicb9s-yTJ-eTqYxGSKJ2ekdvQKLKSNl4,46051
+gitlab/v4/objects/projects.py,sha256=RFfIZQsM3DztpqHSjQpzgDaL1BMYiFZIBNbJlH0t_gE,44126
 gitlab/v4/objects/push_rules.py,sha256=0dKMWEzF5h1zATh0_j_SvjQ7HKx9_5M7J9hzDGB66Rc,3041
 gitlab/v4/objects/releases.py,sha256=j4_45oOj2yaA2XZ3fwBcKhFJ6li4vQy_zyr013LKfvY,1972
 gitlab/v4/objects/repositories.py,sha256=A4Dtr8fay_LBUImdtVEkp7c5P2mjgE8SYItKCEM6a8Y,11047
@@ -87,11 +87,11 @@ gitlab/v4/objects/topics.py,sha256=24QtZfMcTjFZacLF6GVhdvb267n_ScXQjYfa3Ru_sd4,2
 gitlab/v4/objects/triggers.py,sha256=UAERq_C-QdPBbBQPHLh5IfhpkdDeIxdnVGPHfu9Qy5Y,824
 gitlab/v4/objects/users.py,sha256=AavShuFgTH4cOHS1AWrv16_JPLvw2lESHYao_sxOnYc,21280
 gitlab/v4/objects/variables.py,sha256=BZ-DaASsguYKSp1wZ-vuuaUN8OUsMm9jMsAegl-URzc,2626
-gitlab/v4/objects/wikis.py,sha256=G3eHH-J9AeTUTlfd9GYsRNxsXpQZuy_SETPuIC1U0J8,1616
-python_gitlab-4.1.1.dist-info/AUTHORS,sha256=Z0P61GJSVnp7iFbRcMezhx3f4zMyPkVmG--TWaRo768,526
-python_gitlab-4.1.1.dist-info/COPYING,sha256=2n6rt7r999OuXp8iOqW9we7ORaxWncIbOwN1ILRGR2g,7651
-python_gitlab-4.1.1.dist-info/METADATA,sha256=UxKGK42Gyi5f4cw55ssgCHrYLK-B3ZF8k2dOYFZN7F8,7668
-python_gitlab-4.1.1.dist-info/WHEEL,sha256=Xo9-1PvkuimrydujYJAjF7pCkriuXBpUPEjma1nZyJ0,92
-python_gitlab-4.1.1.dist-info/entry_points.txt,sha256=nhpKLLP_uQPFByn8UtE9zsvQQwa402t52o_Cw9IFXMo,43
-python_gitlab-4.1.1.dist-info/top_level.txt,sha256=MvIaP8p_Oaf4gO_hXmHkX-5y2deHLp1pe6tJR3ukQ6o,7
-python_gitlab-4.1.1.dist-info/RECORD,,
+gitlab/v4/objects/wikis.py,sha256=JtI1cQqZV1_PRfKVlQRMh4LZjdxEfi9T2VuFYv6PrV8,1775
+python_gitlab-4.2.0.dist-info/AUTHORS,sha256=Z0P61GJSVnp7iFbRcMezhx3f4zMyPkVmG--TWaRo768,526
+python_gitlab-4.2.0.dist-info/COPYING,sha256=2n6rt7r999OuXp8iOqW9we7ORaxWncIbOwN1ILRGR2g,7651
+python_gitlab-4.2.0.dist-info/METADATA,sha256=zvNrZgbCrsVHewq4f7bhnF26ML3b5Z0SXGPnz6ubLJM,7668
+python_gitlab-4.2.0.dist-info/WHEEL,sha256=oiQVh_5PnQM0E3gPdiz09WCNmwiHDMaGer_elqB3coM,92
+python_gitlab-4.2.0.dist-info/entry_points.txt,sha256=nhpKLLP_uQPFByn8UtE9zsvQQwa402t52o_Cw9IFXMo,43
+python_gitlab-4.2.0.dist-info/top_level.txt,sha256=MvIaP8p_Oaf4gO_hXmHkX-5y2deHLp1pe6tJR3ukQ6o,7
+python_gitlab-4.2.0.dist-info/RECORD,,

{python_gitlab-4.1.1.dist-info → python_gitlab-4.2.0.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: bdist_wheel (0.41.3)
+Generator: bdist_wheel (0.42.0)
 Root-Is-Purelib: true
 Tag: py3-none-any