topic Re: How to display markdown output in databricks notebook from a python cell in Data Engineering

How to display markdown output in databricks notebook from a python cell

Dan-K — Wed, 31 Aug 2022 17:48:00 GMT

With IPython/Jupyter it's possible to output markdown using the IPython display module and its `MarkDown`class.

Question

How can I accomplish this with Azure Databricks?

What I tried

Databricks `display`

Tried using Databrick's display with the IPython Markdown class:

from IPython.display import Markdown
display(Markdown('*some markdown* test'))

but this results in the following error:

Exception: Cannot call display(<class 'IPython.core.display.Markdown'>)

IPython `display`

I then tried to use IPython's display:

from IPython.display import display, Markdown
display(Markdown('*some markdown* test'))

but this just displays the text:

<IPython.core.display.Markdown object>

IPython `display_markdown`

Tried using IPython's `display_markdown`:

from IPython.display import display_markdown
display_markdown('# Markdown is here!\n*some markdown*\n- and\n- some\n- more')

but this results in nothing showing up:

Looking up documentation

Also tried checking Azure Databricks documentation. At first I visited https://www.databricks.com/databricks-documentation which leads me to https://docs.microsoft.com/en-ca/azure/databricks/ but I wasn't able to find anything via searching or clicking the links and I usually find Microsoft documentation quite good. However, according to this page, Databricks is using IPython kernel so I guess it's unclear what portions of IPython can be used and which cannot.

Checking Databrick's `display` source

According to Databrick's source for the `display` function, it will readily render any object that implements `_repr_html()`.

However I'm having a hard time being able to get the raw html output that I'm assuming `IPython.display.Markdown` should be able to output. I can only find `_repr_markdown_()` and `_data_and_metadata()` where the former just calls the latter and the output, at least in Databricks, is just the original raw markdown string.

Re: How to display markdown output in databricks notebook from a python cell

Dan-K — Sat, 03 Sep 2022 00:55:11 GMT

Sorry but you misunderstood my question. I put so much detail into it too 😅

I want markdown in the output of a python cell. Not a markdown cell.

I found a workaround on stack overflow which works, but this requires importing the markdown library:

Is there a way to create a feature request for this sort of thing to be supported natively in databricks (like it is in jupyter)?

Re: How to display markdown output in databricks notebook from a python cell

Dan-K — Sun, 04 Sep 2022 05:09:36 GMT

Sweet! Thanks @Debayan Mukherjee, , I think I'll go ahead and do that 👍

Re: How to display markdown output in databricks notebook from a python cell

Dan-K — Sun, 04 Sep 2022 05:12:42 GMT

Hey @Debayan Mukherjee I tried accessing the link you provided but it redirects me to a page asking me to enter the workspace domain.

Which workspace domain do I use if I'm using Azure Databricks? I tried 'azure' but this didn't work.

Re: How to display markdown output in databricks notebook from a python cell

Debayan — Fri, 02 Sep 2022 22:01:34 GMT

Hi, Thanks for reaching out to community.databricks.com.

In a notebook cell, type "%md" and type some markdown and it will render.

Please refer: https://community.databricks.com/s/question/0D53f00001HKHhNCAX/markup-in-databricks-notebook

Re: How to display markdown output in databricks notebook from a python cell

Debayan — Sun, 04 Sep 2022 05:04:13 GMT

@Daniel Khodabakhsh I would request to file a feature request in our ideas portal https://ideas.databricks.com/ideas/, so that you can interact and receive the updates directly with PM team. The ideas portal allows the customers to submit enhancement ideas and other customers to vote on their submitted ideas, and also gives the customers a direct line of communication with PM. You can subscribe to status updates as well.

Re: How to display markdown output in databricks notebook from a python cell

Debayan — Sun, 04 Sep 2022 05:16:43 GMT

@Daniel Khodabakhsh If you are signing in to the ideas portal for the very first time, could you please refer this https://docs.databricks.com/delegated-auth.html#sign-in-to-the-ideas-portal-the-first-time.

Please let us know if you need further clarification on the same.