Implement the markdown rendering API

Gauvain Pocentek · Gauvain Pocentek · commit 9be50be98468 · 2018-05-29T06:57:36.000+02:00
Testing will be enable when GitLab 11.0 is available.
diff --git a/gitlab/__init__.py b/gitlab/__init__.py
@@ -227,6 +227,33 @@ def version(self):
 
         return self._server_version, self._server_revision
 
+    def markdown(self, text, gfm=False, project=None, **kwargs):
+        """Render an arbitrary Markdown document.
+
+        Args:
+            text (str): The markdown text to render
+            gfm (bool): Render text using GitLab Flavored Markdown. Default is
+                False
+            project (str): Full path of a project used a context when `gfm` is
+                True
+            **kwargs: Extra options to send to the server (e.g. sudo)
+
+        Raises:
+            GitlabAuthenticationError: If authentication is not correct
+            GitlabMarkdownError: If the server cannot perform the request
+
+        Returns:
+            str: The HTML rendering of the markdown text.
+        """
+        post_data = {'text': text, 'gfm': gfm}
+        if project is not None:
+            post_data['project'] = project
+        try:
+            data = self.http_post('/markdown', post_data=post_data, **kwargs)
+        except Exception:
+            raise GitlabMarkdownError
+        return data['html']
+
     def _construct_url(self, id_, obj, parameters, action=None):
         if 'next_url' in parameters:
             return parameters['next_url']
diff --git a/gitlab/exceptions.py b/gitlab/exceptions.py
@@ -205,6 +205,10 @@ class GitlabStopError(GitlabOperationError):
     pass
 
 
+class GitlabMarkdownError(GitlabOperationError):
+    pass
+
+
 def on_http_error(error):
     """Manage GitlabHttpError exceptions.
 
diff --git a/gitlab/v4/objects.py b/gitlab/v4/objects.py
@@ -1981,8 +1981,8 @@ def delete(self, name, **kwargs):
             **kwargs: Extra options to send to the Gitlab server (e.g. sudo)
 
         Raises:
-            GitlabAuthenticationError: If authentication is not correct.
-            GitlabDeleteError: If the server cannot perform the request.
+            GitlabAuthenticationError: If authentication is not correct
+            GitlabDeleteError: If the server cannot perform the request
         """
         self.gitlab.http_delete(self.path, query_data={'name': name}, **kwargs)
 
diff --git a/tools/python_test_v4.py b/tools/python_test_v4.py
@@ -60,6 +60,10 @@
 gl.auth()
 assert(isinstance(gl.user, gitlab.v4.objects.CurrentUser))
 
+# markdown (need to wait for gitlab 11 to enable the test)
+# html = gl.markdown('foo')
+# assert('foo' in html)
+
 # sidekiq
 out = gl.sidekiq.queue_metrics()
 assert(isinstance(out, dict))
