Expose diagnose.report as a function

[darrenburns]

Type of changes

• Bug fix
• New feature
• Documentation / docstrings
• Tests
• Other

Checklist

• I've run the latest black with default args on new code.
• I've updated CHANGELOG.md and CONTRIBUTORS.md where appropriate.
• I've added tests for new code.
• I accept that @willmcgugan may be pedantic in the code review.

Description

Adds diagnose.report function. Also adds some additional information from env vars if the user is using Jupyter, that might help convey what platform they're using if they don't specify in the bug report.

I've added the file as an omission to coverage reporting since it's only used for debug purposes.

╭──────────────────── <class 'rich.console.Console'> ─────────────────────╮
│ A high level console interface.                                         │
│                                                                         │
│ ╭─────────────────────────────────────────────────────────────────────╮ │
│ │ <console width=93 ColorSystem.TRUECOLOR>                            │ │
│ ╰─────────────────────────────────────────────────────────────────────╯ │
│                                                                         │
│     color_system = 'truecolor'                                          │
│         encoding = 'utf-8'                                              │
│             file = <ipykernel.iostream.OutStream object at 0x10535c730> │
│           height = 100                                                  │
│    is_alt_screen = False                                                │
│ is_dumb_terminal = False                                                │
│   is_interactive = False                                                │
│       is_jupyter = True                                                 │
│      is_terminal = False                                                │
│   legacy_windows = False                                                │
│         no_color = False                                                │
│          options = ConsoleOptions(                                      │
│                        size=ConsoleDimensions(width=93, height=100),    │
│                        legacy_windows=False,                            │
│                        min_width=1,                                     │
│                        max_width=93,                                    │
│                        is_terminal=False,                               │
│                        encoding='utf-8',                                │
│                        max_height=100,                                  │
│                        justify=None,                                    │
│                        overflow=None,                                   │
│                        no_wrap=False,                                   │
│                        highlight=None,                                  │
│                        markup=None,                                     │
│                        height=None                                      │
│                    )                                                    │
│            quiet = False                                                │
│           record = False                                                │
│         safe_box = True                                                 │
│             size = ConsoleDimensions(width=93, height=100)              │
│        soft_wrap = False                                                │
│           stderr = False                                                │
│            style = None                                                 │
│         tab_size = 8                                                    │
│            width = 93                                                   │
╰─────────────────────────────────────────────────────────────────────────╯
╭─── <class 'rich._windows.WindowsConsoleFeatures'> ────╮
│ Windows features available.                           │
│                                                       │
│ ╭───────────────────────────────────────────────────╮ │
│ │ WindowsConsoleFeatures(vt=False, truecolor=False) │ │
│ ╰───────────────────────────────────────────────────╯ │
│                                                       │
│ truecolor = False                                     │
│        vt = False                                     │
╰───────────────────────────────────────────────────────╯
╭──────────────────────────────── Jupyter Environment Hints ────────────────────────────────╮
│ JPY_PARENT_PID = 89228                                                                    │
│ VSCODE_VERBOSE_LOGGING = true                                                             │
│                                                                                           │
╰───────────────────────────────────────────────────────────────────────────────────────────╯
platform="Darwin"

[codecov-commenter]

Codecov Report

Merging #1917 (bcbaed2) into master (e839bfb) will decrease coverage by 0.02%.
The diff coverage is 98.99%.

@@            Coverage Diff             @@
##           master    #1917      +/-   ##
==========================================
- Coverage   99.82%   99.80%   -0.03%     
==========================================
  Files          71       71              
  Lines        6943     7035      +92     
==========================================
+ Hits         6931     7021      +90     
- Misses         12       14       +2     

Flag	Coverage Δ
unittests	99.80% <98.99%> (-0.03%)	⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files	Coverage Δ
rich/default_styles.py	100.00% <ø> (ø)
rich/markdown.py	100.00% <ø> (ø)
rich/syntax.py	99.27% <97.72%> (-0.34%)	⬇️
rich/pretty.py	99.71% <98.88%> (-0.29%)	⬇️
rich/__main__.py	100.00% <100.00%> (ø)
rich/_inspect.py	100.00% <100.00%> (ø)
rich/color.py	100.00% <100.00%> (ø)
rich/console.py	100.00% <100.00%> (ø)
rich/segment.py	99.34% <100.00%> (+0.05%)	⬆️
rich/table.py	100.00% <100.00%> (ø)
... and 2 more

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 94273ee...bcbaed2. Read the comment docs.

[willmcgugan]

Can I see an example of the report?

[darrenburns]

@willmcgugan Added the output to the original post

[willmcgugan]

I think it may be worth adding some additional env vars. Not quite everything, since users might have issues re privacy.

In addition to the Jupyter ones, I would add:

TERM
COLORTERM
CLICOLOR
NO_COLOR
TERM_PROGRAM
COLUMNS
LINES

Maybe extract those to a dict and pretty print them with

Panel(Pretty(env_vars))

[darrenburns]

Will do

[darrenburns]

╭────── Environment Variables ───────╮
│ {                                  │
│     'TERM': 'xterm-256color',      │
│     'COLORTERM': 'truecolor',      │
│     'CLICOLOR': None,              │
│     'NO_COLOR': None,              │
│     'TERM_PROGRAM': 'iTerm.app',   │
│     'COLUMNS': None,               │
│     'LINES': None,                 │
│     'JPY_PARENT_PID': None,        │
│     'VSCODE_VERBOSE_LOGGING': None │
│ }                                  │
╰────────────────────────────────────╯

[willmcgugan]

Great!