AttributeError with rich.markup

[kratsg]

First Check

• I added a very descriptive title here.
• I used the GitHub search to find a similar question and didn't find it.
• I searched the Typer documentation, with the integrated search.
• I already searched in Google "How to X in Typer" and didn't find any information.
• I already read and followed all the tutorials in the docs and didn't find an answer.
• I already checked if it is not related to Typer but to Click.

Commit to Help

• I commit to help with one of those options 👆

Example Code

import rich
rich.markup

Description

This is happening as an integration of various tools that triggers calling param.get_help_record(ctx):

• mkdocs
• click
• mkdocs_click
• typer::get_help_record

Operating System

Linux, macOS

Operating System Details

Reproducible across linux and mac (and github actions).

Typer Version

0.17.3

Python Version

3.12.7

Additional Context

It looks like it's triggered by this line:

typer/typer/core.py

Lines 373 to 375 in 9c5c543

	if rich is not None:
	# This is needed for when we want to export to HTML
	extra_str = rich.markup.escape(extra_str).strip()

GitHub actions with the failure: https://github.com/kratsg/itksn/actions/runs/17384314388/job/49419196292?pr=115 . It is a bit strange to me why I am seeing this now and not particularly any time before, but adding an import rich.markup in the core.py file should resolve this.

Log snippet

creating virtual environment...
installing hatch...
Creating environment: docs
Installing project in development mode
Checking dependencies
Syncing dependencies
cmd [1] | mkdocs build --config-file mkdocs.yml --clean  --no-directory-urls
INFO    -  Cleaning site directory
INFO    -  Building documentation to directory: /home/runner/work/itksn/itksn/site
ERROR   -  Error reading page 'cli/reference.md': module 'rich' has no attribute 'markup'
Traceback (most recent call last):
  File "/home/runner/.local/share/hatch/env/virtual/itksn/Lsk7BWWs/docs/bin/mkdocs", line 7, in <module>
    sys.exit(cli())
             ^^^^^
  File "/home/runner/.local/share/hatch/env/virtual/itksn/Lsk7BWWs/docs/lib/python3.12/site-packages/click/core.py", line 1442, in __call__
    return self.main(*args, **kwargs)
           ^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/home/runner/.local/share/hatch/env/virtual/itksn/Lsk7BWWs/docs/lib/python3.12/site-packages/click/core.py", line 1363, in main
    rv = self.invoke(ctx)
         ^^^^^^^^^^^^^^^^
  File "/home/runner/.local/share/hatch/env/virtual/itksn/Lsk7BWWs/docs/lib/python3.12/site-packages/click/core.py", line 1830, in invoke
    return _process_result(sub_ctx.command.invoke(sub_ctx))
                           ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/home/runner/.local/share/hatch/env/virtual/itksn/Lsk7BWWs/docs/lib/python3.12/site-packages/click/core.py", line 1226, in invoke
    return ctx.invoke(self.callback, **ctx.params)
           ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/home/runner/.local/share/hatch/env/virtual/itksn/Lsk7BWWs/docs/lib/python3.12/site-packages/click/core.py", line 794, in invoke
    return callback(*args, **kwargs)
           ^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/home/runner/.local/share/hatch/env/virtual/itksn/Lsk7BWWs/docs/lib/python3.12/site-packages/mkdocs/__main__.py", line 288, in build_command
    build.build(cfg, dirty=not clean)
  File "/home/runner/.local/share/hatch/env/virtual/itksn/Lsk7BWWs/docs/lib/python3.12/site-packages/mkdocs/commands/build.py", line 310, in build
    _populate_page(file.page, config, files, dirty)
  File "/home/runner/.local/share/hatch/env/virtual/itksn/Lsk7BWWs/docs/lib/python3.12/site-packages/mkdocs/commands/build.py", line 167, in _populate_page
    page.render(config, files)
  File "/home/runner/.local/share/hatch/env/virtual/itksn/Lsk7BWWs/docs/lib/python3.12/site-packages/mkdocs/structure/pages.py", line 285, in render
    self.content = md.convert(self.markdown)
                   ^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/home/runner/.local/share/hatch/env/virtual/itksn/Lsk7BWWs/docs/lib/python3.12/site-packages/markdown/core.py", line 354, in convert
    self.lines = prep.run(self.lines)
                 ^^^^^^^^^^^^^^^^^^^^
  File "/home/runner/.local/share/hatch/env/virtual/itksn/Lsk7BWWs/docs/lib/python3.12/site-packages/mkdocs_click/_extension.py", line 59, in run
    return list(
           ^^^^^
  File "/home/runner/.local/share/hatch/env/virtual/itksn/Lsk7BWWs/docs/lib/python3.12/site-packages/mkdocs_click/_processing.py", line 44, in replace_blocks
    yield from replace(**options)
  File "/home/runner/.local/share/hatch/env/virtual/itksn/Lsk7BWWs/docs/lib/python3.12/site-packages/mkdocs_click/_docs.py", line 30, in make_command_docs
    for line in _recursively_make_command_docs(
  File "/home/runner/.local/share/hatch/env/virtual/itksn/Lsk7BWWs/docs/lib/python3.12/site-packages/mkdocs_click/_docs.py", line 83, in _recursively_make_command_docs
    yield from _recursively_make_command_docs(
  File "/home/runner/.local/share/hatch/env/virtual/itksn/Lsk7BWWs/docs/lib/python3.12/site-packages/mkdocs_click/_docs.py", line 66, in _recursively_make_command_docs
    yield from _make_options(ctx, style, show_hidden=show_hidden)
  File "/home/runner/.local/share/hatch/env/virtual/itksn/Lsk7BWWs/docs/lib/python3.12/site-packages/mkdocs_click/_docs.py", line 251, in _make_plain_options
    click.Command.format_options(ctx.command, ctx, formatter)
  File "/home/runner/.local/share/hatch/env/virtual/itksn/Lsk7BWWs/docs/lib/python3.12/site-packages/click/core.py", line 1135, in format_options
    rv = param.get_help_record(ctx)
         ^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/home/runner/.local/share/hatch/env/virtual/itksn/Lsk7BWWs/docs/lib/python3.12/site-packages/typer/core.py", line 375, in get_help_record
    extra_str = rich.markup.escape(extra_str).strip()
                ^^^^^^^^^^^
AttributeError: module 'rich' has no attribute 'markup'

[svlandeg]

Thanks for the report!

This should be fixed by #1290 and has been released as Typer 0.17.4 🎉

[kratsg]

Thanks! This wasn't obvious at first glance to me what had changed to break it. :)