Merge pull request #65 from willmcgugan/hyperlinks

Add Hyperlinks

Author: willmcgugan

CHANGELOG.md

@@ -5,6 +5,13 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [1.1.0] - 2020-05-10
+
+### Added
+
+- Added hyperlinks to Style and markup
+- Added justify and code theme switches to markdown command
+
 ## [1.0.3] - 2020-05-08
 
 ### Added

docs/source/markup.rst

@@ -25,6 +25,16 @@ There is a shorthand for closing a style. If you omit the style name from the cl
     print("[bold red]Bold and red[/] not bold or red")
 
 
+Links
+~~~~~
+
+Console markup can output hyperlinks with the following syntax: ``[link=URL]text[/link]``. Here's an example::
+
+    print("Visit my [link=https://www.willmcgugan.com]blog[/link]!")
+
+If your terminal software supports hyperlinks, you will be able to click the word "blog" which will typically open a browser. If your terminal doesn't support hyperlinks, you will see the text but it won't be clickable.
+
+
 Escaping
 ~~~~~~~~
 
@@ -34,6 +44,7 @@ Occasionally you may want to print something that Rich would interpret as markup
     >>> print("foo[[bar]]")
     foo[bar]
 
+The function :func:`~rich.markup.escape` will handle escape of text for you.
 
 Rendering Markup
 ----------------

docs/source/reference.rst

@@ -11,6 +11,7 @@ Reference
    reference/highlighter.rst
    reference/logging.rst
    reference/markdown.rst
+   reference/markup.rst
    reference/measure.rst
    reference/padding.rst
    reference/panel.rst

docs/source/reference/markup.rst

@@ -0,0 +1,5 @@
+rich.markup
+===========
+
+.. automodule:: rich.markup
+    :members:

docs/source/style.rst

@@ -55,6 +55,16 @@ Styles may be negated by prefixing the attribute with the word "not". This can b
 
 This will print "foo" and "baz" in bold, but "bar" will be in normal text.
 
+Styles may also have a ``"link"`` attribute, which will turn any styled text in to a *hyperlink* (if supported by your terminal software).
+
+To add a link to a style, the definition should contain the word ``"link"`` followed by a URL. The following example will make a clickable link::
+
+    console.print("Google", style="link https://google.com")
+
+.. note::
+    If you are familiar with HTML you may find applying links in this way a little odd, but the terminal considers a link to be another attribute just like bold, italic etc. 
+    
+
 
 Style Class
 -----------

pyproject.toml

@@ -2,7 +2,7 @@
 name = "rich"
 homepage = "https://github.com/willmcgugan/rich"
 documentation = "https://rich.readthedocs.io/en/latest/"
-version = "1.0.3"
+version = "1.1.0"
 description = "Render rich text, tables, progress bars, syntax highlighting, markdown and more to the terminal"
 authors = ["Will McGugan <willmcgugan@gmail.com>"]
 license = "MIT"

rich/console.py

@@ -597,7 +597,8 @@ def get_style(
             return name
 
         try:
-            return self._styles.get(name) or Style.parse(name)
+            style = self._styles.get(name)
+            return style.copy() if style is not None else Style.parse(name)            
         except errors.StyleSyntaxError as error:
             if default is not None:
                 return self.get_style(default)

rich/containers.py

@@ -1,8 +1,9 @@
+from itertools import zip_longest
 from typing import Iterator, Iterable, List, overload, TypeVar, TYPE_CHECKING, Union
 from typing_extensions import Literal
 
 from .segment import Segment
-
+from .style import Style
 
 if TYPE_CHECKING:
     from .console import (
@@ -97,6 +98,7 @@ def extend(self, lines: Iterable["Text"]) -> None:
 
     def justify(
         self,
+        console: "Console",
         width: int,
         align: Literal["none", "left", "center", "right", "full"] = "left",
     ) -> None:
@@ -135,9 +137,17 @@ def justify(
                         index = (index + 1) % len(spaces)
                 tokens: List[Text] = []
                 index = 0
-                for index, word in enumerate(words):
+                for index, (word, next_word) in enumerate(
+                    zip_longest(words, words[1:])
+                ):
                     tokens.append(word)
                     if index < len(spaces):
-                        tokens.append(Text(" " * spaces[index]))
+                        if next_word is None:
+                            space_style = Style()
+                        else:
+                            style = word.get_style_at_offset(console, -1)
+                            next_style = next_word.get_style_at_offset(console, 0)
+                            space_style = style if style == next_style else line.style
+                        tokens.append(Text(" " * spaces[index], style=space_style))
                     index += 1
                 self[line_index] = Text("").join(tokens)

rich/default_styles.py

@@ -115,8 +115,8 @@
     "markdown.h5": Style(underline=True),
     "markdown.h6": Style(italic=True),
     "markdown.h7": Style(italic=True, dim=True),
-    "markdown.link": Style(bold=True),
-    "markdown.link_url": Style(underline=True),
+    "markdown.link": Style(color="bright_blue"),
+    "markdown.link_url": Style(color="blue"),
 }
 
 

rich/markdown.py

@@ -153,6 +153,8 @@ def __console__(self, console: Console, options: ConsoleOptions) -> RenderResult
             )
         else:
             # Styled text for h2 and beyond
+            if self.level:
+                yield Text("\n")
             yield text
 
 
@@ -173,8 +175,10 @@ def __init__(self, lexer_name: str, theme: str) -> None:
 
     def __console__(self, console: Console, options: ConsoleOptions) -> RenderResult:
         code = str(self.text).rstrip()
-        syntax = Syntax(code, self.lexer_name, theme=self.theme)
-        yield Panel(syntax, style="dim")
+        syntax = Panel(
+            Syntax(code, self.lexer_name, theme=self.theme), style="dim", box=box.SQUARE
+        )
+        yield syntax
 
 
 class BlockQuote(TextElement):
@@ -289,7 +293,7 @@ def render_number(
             yield new_line
 
 
-class ImageItem(MarkdownElement):
+class ImageItem(TextElement):
     """Renders a placeholder for an image."""
 
     new_line = False
@@ -305,17 +309,26 @@ def create(cls, markdown: "Markdown", node: Any) -> "MarkdownElement":
         Returns:
             MarkdownElement: A new markdown element
         """
-        return cls(node.title, node.destination)
+        return cls(node.destination, markdown.hyperlinks)
 
-    def __init__(self, title: Optional[str], destination: str) -> None:
-        self.title = title
+    def __init__(self, destination: str, hyperlinks: bool) -> None:
         self.destination = destination
+        self.hyperlinks = hyperlinks
+        self.link: Optional[str] = None
         super().__init__()
 
+    def on_enter(self, context: "MarkdownContext") -> None:
+        self.link = context.current_style.link
+        self.text = Text(justify="left")
+        super().on_enter(context)
+
     def __console__(self, console: Console, options: ConsoleOptions) -> RenderResult:
-        yield Text.assemble(
-            (self.title or "🌆", "italic"), " ", f"({self.destination}) ", end=""
-        )
+        link_style = Style(link=self.link or self.destination or None)
+        title = self.text or Text(self.destination.strip("/").rsplit("/", 1)[-1])
+
+        if self.hyperlinks:
+            title.stylize_all(link_style)
+        yield Text.assemble("🌆 ", title, " ", end="")
 
 
 class MarkdownContext:
@@ -356,6 +369,7 @@ class Markdown:
         code_theme (str, optional): Pygments theme for code blocks. Defaults to "monokai".
         justify (JustifyValues, optional): Justify value for paragraphs. Defaults to None.
         style (Union[str, Style], optional): Optional style to apply to markdown.
+        hyperlinks (bool, optional): Enable hyperlinks. Defaults to ``True``.
     """
 
     elements: ClassVar[Dict[str, Type[MarkdownElement]]] = {
@@ -368,21 +382,23 @@ class Markdown:
         "item": ListItem,
         "image": ImageItem,
     }
-    inlines = {"emph", "strong", "code", "link", "strike"}
+    inlines = {"emph", "strong", "code", "strike"}
 
     def __init__(
         self,
         markup: str,
         code_theme: str = "monokai",
         justify: JustifyValues = None,
         style: Union[str, Style] = "none",
+        hyperlinks: bool = True,
     ) -> None:
         self.markup = markup
         parser = Parser()
         self.parsed = parser.parse(markup)
         self.code_theme = code_theme
         self.justify = justify
         self.style = style
+        self.hyperlinks = hyperlinks
 
     def __console__(self, console: Console, options: ConsoleOptions) -> RenderResult:
         """Render markdown to the console."""
@@ -392,7 +408,6 @@ def __console__(self, console: Console, options: ConsoleOptions) -> RenderResult
         inlines = self.inlines
         new_line = False
         for current, entering in nodes:
-            # print(current, current.literal)
             node_type = current.t
             if node_type in ("html_inline", "html_block", "text"):
                 context.on_text(current.literal.replace("\n", " "))
@@ -402,6 +417,23 @@ def __console__(self, console: Console, options: ConsoleOptions) -> RenderResult
             elif node_type == "softbreak":
                 if entering:
                     context.on_text(" ")
+            elif node_type == "link":
+                if entering:
+                    link_style = console.get_style("markdown.link")
+                    if self.hyperlinks:
+                        link_style.link = current.destination
+                    context.enter_style(link_style)
+                else:
+                    context.leave_style()
+                    if not self.hyperlinks:
+                        context.on_text(" (")
+                        style = Style(underline=True) + console.get_style(
+                            "markdown.link_url"
+                        )
+                        context.enter_style(style)
+                        context.on_text(current.destination)
+                        context.leave_style()
+                        context.on_text(")")
             elif node_type in inlines:
                 if current.is_container():
                     if entering:
@@ -413,12 +445,6 @@ def __console__(self, console: Console, options: ConsoleOptions) -> RenderResult
                     if current.literal:
                         context.on_text(current.literal)
                     context.leave_style()
-                if current.destination and not entering:
-                    context.on_text(" (")
-                    context.enter_style("markdown.link_url")
-                    context.on_text(current.destination)
-                    context.leave_style()
-                    context.on_text(") ")
             else:
                 element_class = self.elements.get(node_type) or UnknownElement
                 if current.is_container():
@@ -470,6 +496,20 @@ def __console__(self, console: Console, options: ConsoleOptions) -> RenderResult
         action="store_true",
         help="force color for non-terminals",
     )
+    parser.add_argument(
+        "-t",
+        "--code-theme",
+        dest="code_theme",
+        default="monokai",
+        help="pygments code theme",
+    )
+    parser.add_argument(
+        "-y",
+        "--hyperlinks",
+        dest="hyperlinks",
+        action="store_true",
+        help="enable hyperlinks",
+    )
     parser.add_argument(
         "-w",
         "--width",
@@ -478,11 +518,23 @@ def __console__(self, console: Console, options: ConsoleOptions) -> RenderResult
         default=None,
         help="width of output (default will auto-detect)",
     )
+    parser.add_argument(
+        "-j",
+        "--justify",
+        dest="justify",
+        action="store_true",
+        help="enable full text justify",
+    )
     args = parser.parse_args()
 
     from rich.console import Console
 
     console = Console(force_terminal=args.force_color, width=args.width)
     with open(args.path, "rt") as markdown_file:
-        markdown = Markdown(markdown_file.read())
+        markdown = Markdown(
+            markdown_file.read(),
+            justify="full" if args.justify else "left",
+            code_theme=args.code_theme,
+            hyperlinks=args.hyperlinks,
+        )
     console.print(markdown)