✨ Add `typer.set_rich_*()` to allow Rich formatting to be disabled #647

JacobKochems · 2023-08-02T23:07:04Z

Implements a feature similar to the one suggested by @anthonyraf in issue #622 to optionally disable Rich output.

Two simple test cases and a section of documentation has also been added.

It affects all instances of Typer globally.
The code from the test cases illustrates how to use it:

import typer

typer.set_rich_help(False)

app = typer.Typer()


@app.command()
def main(arg: str):  # pragma: no cover
    pass


if __name__ == "__main__":
    app()

import typer

typer.set_rich_traceback(False)

app = typer.Typer()


@app.command()
def raise_():
    raise ValueError  # raise some error to test traceback output


if __name__ == "__main__":
    app()

Resolves #578, resolves #622
Bonus: It is also a workaround for #646.

Implements a feature suggested by Anthony Rafidison (anthonyraf) in issue fastapi#622 to optionally disable Rich output. Fix fastapi#578, fix fastapi#622

Since the internal state of `_is_rich_enabled` in `typer/core.py` exhibits global behavior with respect to all `Typer` instances, it is more consistent to refactor `typer.Typer(rich_enable=<bool>)` to `typer.enable_rich(<bool>)`.

Also, add a paragraph to the documentation.

github-actions · 2023-08-02T23:09:30Z

📝 Docs preview for commit 67fad4b at: https://9fddef8a.typertiangolo.pages.dev

github-actions · 2023-08-03T14:42:36Z

📝 Docs preview for commit b0abe95 at: https://2e18d008.typertiangolo.pages.dev

Feature/enable rich

github-actions · 2023-08-03T14:57:16Z

📝 Docs preview for commit f265dc2 at: https://28e342bf.typertiangolo.pages.dev

Remove obsolete function

github-actions · 2023-08-03T15:34:45Z

📝 Docs preview for commit 87a9ce7 at: https://343d25f2.typertiangolo.pages.dev

Update docs to reflect latest Rich output changes

suvayu

typer.enable_rich(False)

I guess you mean typer.enable_rich_help(False) since that's what is in the code.

I ran the tests locally, and checked against my own example script. Everything works as advertised. The implementation is also straightforward.

That said, I think the functions should be called disable_rich_* since enable is already the default behaviour, so in the enable_rich_* form it will always be a double negative. Which is a bit weird.

JacobKochems · 2023-09-09T16:24:37Z

Thanks for the review. I'll rename it as you suggested. I was thinking the same way about my previous naming choice anyway shortly after I published the PR but wanted to wait for a response before touching the code again. I don't know why I even named it that way to begin with. ;-)

nickmuoh · 2023-09-18T21:34:32Z

Is there any plan on having this merged and released? It's a really valuable contribution as not scenarios where rich and typer are installed mean users want to use rich with typer.

github-actions · 2023-09-19T16:25:27Z

📝 Docs preview for commit 42cf404 at: https://f8030773.typertiangolo.pages.dev

JacobKochems · 2023-09-19T16:40:13Z

I renamed the two functions and the thereby affected variables to be more semantically precise and more specific to their purpose. For the exposed functions I settled on the form: set_rich_* which is semantically more appropriate than the previous enable_rich_* form but keeps the boolean parameter to be able to conditionally re-enable it.

* Rename symbols to be more specific * Alias function with its namespace of origin * Auto format after rename/refactor * Rename symbols for better semantic precision * Update docs to new nomenclature used in PR fastapi#647 --------- Co-authored-by: Jacob Kochems <[email protected]>

github-actions · 2023-09-19T23:20:52Z

📝 Docs preview for commit 2ade3dc at: https://18993260.typertiangolo.pages.dev

JacobKochems · 2023-10-26T19:20:09Z

@coreegor Since you already `@ed´ him I would assume that he already got an email notification but either didn't have time to respond yet or he time boxes his work on a given project at certain intervals.

If you need this feature rather sooner than later, I see two options:

Use my fork for the time being
In my pyproject.toml I use typer = {git = "https://github.com/JacobKochems/typer.git"} as a dependency
Write a nice email directly to tiangolo

I'd prefer option 1. We all have to navigate a world where seemingly each and everything is competing for our attention. There is probably a reason why the last commit is from July 30.

github-actions · 2023-11-16T18:33:00Z

📝 Docs preview for commit 6a7735e at: https://576f736d.typertiangolo.pages.dev

JacobKochems · 2023-11-16T19:07:46Z

@coreegor I just merged the latest changes from 'tiangolo:master'. Could you also do a review of this PR according to this? You can find this functionality under Files changed on the right hand side, named: Review changes.

JacobKochems · 2023-11-16T19:13:53Z

To all following this PR: The original motivation for this PR is the issue #646 for which this is a possible workaround. However, I'd rather like to see that original issue addressed as well. If some of you could review/replicate it, it would be much appreciated.

github-actions · 2023-12-13T00:31:56Z

📝 Docs preview for commit c408a39 at: https://ca1e8013.typertiangolo.pages.dev

melsabagh · 2023-12-23T03:34:00Z

@JacobKochems I can replicate #646 with the latest Rich (13.7.0). To disable Rich though, I am doing the following:

import typer.core

typer.core.rich = None

...

anthonyraf · 2023-12-23T10:53:21Z

@JacobKochems I can replicate #646 with the latest Rich (13.7.0). To disable Rich though, I am doing the following:
import typer.core

typer.core.rich = None

...

This is working well, thanks

JacobKochems · 2023-12-23T12:09:36Z

@JacobKochems I can replicate #646 with the latest Rich (13.7.0). To disable Rich though, I am doing the following:
import typer.core

typer.core.rich = None

...

Thank you for this very simple workaround. Recently, yet another effort related to issues #578 and #622 has been made: #726. This in combination with the kwarg pretty_exceptions_enable=False of typer.Typer() seems to accomplish the same with fewer changes.
Though, I'm not sure about the intended semantics regarding rich_markup_mode and if the proposed solution in #726 (or mine for that matter, I can't test it at the moment) addresses the printing of the rounded panel boxes and rich markup in general independently from each other. This seems to be a desired feature.

strangemonad · 2024-01-04T16:37:51Z

I'd also like to add a vote for and option that allows globally disabling rich. Just because rich is installed and available doesn't always mean it's appropriate to render rich output from the cli. I'd like to not have to revert to disabling features piecemeal e.g. prettr_exceptions_enabled=False + ...

github-actions · 2024-02-29T09:38:07Z

📝 Docs preview for commit fc18ef2 at: https://01e2c600.typertiangolo.pages.dev

github-actions · 2024-03-25T13:37:22Z

📝 Docs preview for commit 65ddbf0 at: https://667e652b.typertiangolo.pages.dev

github-actions · 2024-05-24T18:02:40Z

📝 Docs preview for commit 3f9bc07 at: https://15654bb2.typertiangolo.pages.dev

JacobKochems · 2024-05-24T18:30:54Z

After some updates from tiangolo's master branch I needed to resolve a merge conflict, which worked out. However, suddenly some checks are failing. I tried to rerun the test suite locally and ran into several issues:

Commands and scripts are missing:

bash scripts/format.sh
+ set -e
+ ruff check typer tests docs_src scripts --fix
scripts/format.sh: line 5: ruff: command not found

bash scripts/format-imports.sh
bash: scripts/format-imports.sh: No such file or directory

The test script provided by tiangolo does not work anymore:

bash scripts/test-cov-html.sh
+ bash scripts/test.sh --cov-report=html
+ export TERMINAL_WIDTH=3000
+ TERMINAL_WIDTH=3000
+ export _TYPER_FORCE_DISABLE_TERMINAL=1
+ _TYPER_FORCE_DISABLE_TERMINAL=1
+ pytest --cov --cov-report=term-missing -o console_output_style=progress --numprocesses=auto --cov-report=html
ERROR: usage: pytest [options] [file_or_dir] [file_or_dir] [...]
pytest: error: unrecognized arguments: --cov --cov-report=term-missing --numprocesses=auto --cov-report=html
  inifile: /home/jacob/repos/typer/pyproject.toml
  rootdir: /home/jacob/repos/typer

Maybe pytest was updated but not the script?

svlandeg · 2024-06-11T09:15:12Z

Hi @JacobKochems,

The format-imports.sh script has indeed been deleted in PR #797. format.sh works as before, but ruff is a test dependency of typer since #763 and should be installed.

I noticed an issue with the test-cov-html.sh earlier this week as well, but I can't reproduce it anymore and now it just works fine on my system when I run

bash scripts/test-cov-html.sh

If this issue persists on your system, I suggest you open a discussion thread for that specifically so we can follow up there.

With respect to this PR - I want to review it in more detail, but I've looked at the related PR #726 first.

JacobKochems · 2024-06-11T16:22:54Z

Ok, I did need to install pytest-cov and pytest-xdist. I don't remember this to be necessary when I set up the repo the first time around but now bash scripts/test-cov-html.sh runs. It produces a lot of test fails but so does the master branch of tiangolo.

svlandeg · 2024-06-12T10:18:09Z

@JacobKochems: I put up a related PR here: #859 - I think the same mechanism can probably be reused to implement the global switch you want. If you (or others) have time to review #859, I'd appreciate it!

JacobKochems · 2024-07-06T15:36:13Z

As mentioned in my post on #859 (comment) I will close this PR in favor of #859 and attempt to reimplement this PR on top of it once #859 has been merged.

JacobKochems added 3 commits August 2, 2023 21:20

Add named parameter 'rich_enable' to class Typer

c39d2ef

Implements a feature suggested by Anthony Rafidison (anthonyraf) in issue fastapi#622 to optionally disable Rich output. Fix fastapi#578, fix fastapi#622

Refactor Typer parameter to a global one

6a4ba06

Since the internal state of `_is_rich_enabled` in `typer/core.py` exhibits global behavior with respect to all `Typer` instances, it is more consistent to refactor `typer.Typer(rich_enable=<bool>)` to `typer.enable_rich(<bool>)`.

Add a test case for typer.enable_rich(<bool>)

67fad4b

Also, add a paragraph to the documentation.

JacobKochems added 3 commits August 3, 2023 16:20

Fix wrong test name

69a86d4

Make assertion more robust

98ea1c3

Add a separate switch for Rich traceback

b0abe95

JacobKochems added 2 commits August 3, 2023 16:45

Merge pull request #1 from JacobKochems/feature/enable-rich

6f28107

Feature/enable rich

Remove obsolete function

f265dc2

JacobKochems added 2 commits August 3, 2023 16:57

Merge pull request #2 from JacobKochems/feature/enable-rich

e29d295

Remove obsolete function

Update docs to reflect latest Rich output changes

87a9ce7

Merge pull request #3 from JacobKochems/feature/enable-rich

08bc2f1

Update docs to reflect latest Rich output changes

suvayu suggested changes Sep 9, 2023

View reviewed changes

Jacob Kochems added 5 commits September 19, 2023 17:20

Rename symbols to be more specific

f42778f

Alias function with its namespace of origin

6656674

Auto format after rename/refactor

6093088

Rename symbols for better semantic precision

596c5f0

Update docs to new nomenclature used in PR fastapi#647

42cf404

JacobKochems requested a review from suvayu September 19, 2023 22:10

JacobKochems and others added 3 commits September 20, 2023 00:27

Rename tests to new nomenclature of PR fastapi#647

6ff12c8

Rename tests to new nomenclature of PR fastapi#647

2ade3dc

ejm714 mentioned this pull request Nov 13, 2023

Disable rich formatting in terminal for github acitons drivendataorg/cyfi#129

Merged

Merge branch 'tiangolo:master' into feature/enable-rich

6a7735e

anthonyraf approved these changes Nov 17, 2023

View reviewed changes

coreegor approved these changes Nov 19, 2023

View reviewed changes

JacobKochems changed the title ~~Add typer.set_rich_*() to allow Rich formatting to be disabled~~ ✨ Add typer.set_rich_*() to allow Rich formatting to be disabled Dec 8, 2023

Merge branch 'tiangolo:master' into feature/enable-rich

c408a39

Merge branch 'tiangolo:master' into feature/enable-rich

fc18ef2

svlandeg added feature New feature, enhancement or request p3 labels Feb 29, 2024

Merge branch 'tiangolo:master' into feature/enable-rich

65ddbf0

Merge branch 'master' into feature/enable-rich

3f9bc07

svlandeg mentioned this pull request Jun 12, 2024

🐛 Ensure rich_markup_mode=None disables Rich formatting #859

Merged

JacobKochems closed this Jul 6, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

✨ Add `typer.set_rich_*()` to allow Rich formatting to be disabled #647

✨ Add `typer.set_rich_*()` to allow Rich formatting to be disabled #647

JacobKochems commented Aug 2, 2023 •

edited

Loading

github-actions bot commented Aug 2, 2023

github-actions bot commented Aug 3, 2023

github-actions bot commented Aug 3, 2023

github-actions bot commented Aug 3, 2023

suvayu left a comment

JacobKochems commented Sep 9, 2023

nickmuoh commented Sep 18, 2023

github-actions bot commented Sep 19, 2023

JacobKochems commented Sep 19, 2023

github-actions bot commented Sep 19, 2023

JacobKochems commented Oct 26, 2023 •

edited

Loading

github-actions bot commented Nov 16, 2023

JacobKochems commented Nov 16, 2023

JacobKochems commented Nov 16, 2023 •

edited

Loading

github-actions bot commented Dec 13, 2023

melsabagh commented Dec 23, 2023

anthonyraf commented Dec 23, 2023

JacobKochems commented Dec 23, 2023 •

edited

Loading

strangemonad commented Jan 4, 2024

github-actions bot commented Feb 29, 2024

github-actions bot commented Mar 25, 2024

github-actions bot commented May 24, 2024

JacobKochems commented May 24, 2024

svlandeg commented Jun 11, 2024 •

edited

Loading

JacobKochems commented Jun 11, 2024 •

edited

Loading

svlandeg commented Jun 12, 2024

JacobKochems commented Jul 6, 2024 •

edited

Loading

✨ Add typer.set_rich_*() to allow Rich formatting to be disabled #647

✨ Add typer.set_rich_*() to allow Rich formatting to be disabled #647

Conversation

JacobKochems commented Aug 2, 2023 • edited Loading

github-actions bot commented Aug 2, 2023

github-actions bot commented Aug 3, 2023

github-actions bot commented Aug 3, 2023

github-actions bot commented Aug 3, 2023

suvayu left a comment

Choose a reason for hiding this comment

JacobKochems commented Sep 9, 2023

nickmuoh commented Sep 18, 2023

github-actions bot commented Sep 19, 2023

JacobKochems commented Sep 19, 2023

github-actions bot commented Sep 19, 2023

JacobKochems commented Oct 26, 2023 • edited Loading

github-actions bot commented Nov 16, 2023

JacobKochems commented Nov 16, 2023

JacobKochems commented Nov 16, 2023 • edited Loading

github-actions bot commented Dec 13, 2023

melsabagh commented Dec 23, 2023

anthonyraf commented Dec 23, 2023

JacobKochems commented Dec 23, 2023 • edited Loading

strangemonad commented Jan 4, 2024

github-actions bot commented Feb 29, 2024

github-actions bot commented Mar 25, 2024

github-actions bot commented May 24, 2024

JacobKochems commented May 24, 2024

svlandeg commented Jun 11, 2024 • edited Loading

JacobKochems commented Jun 11, 2024 • edited Loading

svlandeg commented Jun 12, 2024

JacobKochems commented Jul 6, 2024 • edited Loading

✨ Add `typer.set_rich_*()` to allow Rich formatting to be disabled #647

✨ Add `typer.set_rich_*()` to allow Rich formatting to be disabled #647

JacobKochems commented Aug 2, 2023 •

edited

Loading

JacobKochems commented Oct 26, 2023 •

edited

Loading

JacobKochems commented Nov 16, 2023 •

edited

Loading

JacobKochems commented Dec 23, 2023 •

edited

Loading

svlandeg commented Jun 11, 2024 •

edited

Loading

JacobKochems commented Jun 11, 2024 •

edited

Loading

JacobKochems commented Jul 6, 2024 •

edited

Loading