Spaces:
Building
Building
File size: 1,569 Bytes
f5f3483 |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 |
# Copyright 2024 The etils Authors.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
"""Syntax highlighting utils."""
import html
from etils import epy
from etils.ecolab.inspects import resource_utils
def highlight_html(code: str) -> str:
"""Add Python syntax highlighting to a Python code string.
Usage:
Example:
```python
@dataclasses.dataclass
class A:
x: int
def _repr_html_(self) -> str:
from etils import ecolab # Lazy-import ecolab
return ecolab.highlight_html(repr(self))
```
Args:
code: The string to wrap
Returns:
The HTML string representation
"""
theme = resource_utils.resource_import(
'static/highlight.css', module='etils.ecolab'
)
# html
html_str = """
{theme}
<script src="//cdnjs.cloudflare.com/ajax/libs/highlight.js/11.7.0/highlight.min.js"></script>
<script>hljs.highlightAll();</script>
<pre><code class="language-python">{code}</code></pre>
"""
html_str = epy.dedent(html_str)
html_str = html_str.format(theme=theme, code=html.escape(code))
return html_str
|