Repository navigation
- Breaking: Raise the Click floor to
8.5.1, dropping the shims for the spec of hidden options and theenvvarof error hints. - Breaking: Raise the myst-parser floor of the
sphinxextra to5.2.0, dropping the shim for thecontent_offsetthat older releases over-counted. - Breaking:
DependencyMatrixGroupgains a trailinglast_datefield, so it no longer unpacks into four values. - Deprecated: The
tabs-verticalclass of sphinx-design tab-sets now logs aclick_extra.tabs_verticalwarning and stops working in11.0.0. Set the:orientation: verticaloption of sphinx-design0.8.0instead. - Deprecated:
ERASE_IN_LINE,PARTIAL_CSI_RE,SELECT_GRAPHIC_RENDITIONandTerminalScreenofclick_extra.capture.recordingnow warn and stop resolving in11.0.0. ImportTerminalScreenfromclick_extra.capture.terminalinstead. - Add a
report_urlargument to@commandand@group: an error the CLI has no rule for then ends the run with a bug report to paste into an issue. - Add
log_report(), which logs a bug report of the same shape without ending the run, anddescribe_error(),compact_frames()andculprit_function()to fill one in. - Record full-screen programs with
screenshot --recordandrecord_command(): the screen now follows cursor addressing, scroll regions, line drawing and the alternate screen. - Keep a style per cell in
TerminalScreen, so a redraw over the start of a row keeps the rest of that row. - Run a recorded command with
TERM=xterm-256color, and note a screen only once its redraw settles, so no frame shows a half-drawn screen. - Draw each background and run of text that frames of an animated SVG capture share once, timed over those frames, which shrinks recordings up to three times.
- Add
--palettetoscreenshot, reading a Windows Terminal or iTerm2 color scheme, and--fonttoscreenshotandsnippet, naming the fonts a capture asks for. - Add the
:screenshot-palette:and:screenshot-font:directive options, which match--paletteand--font. - Add
--startand--endtoscreenshot --record, and:screenshot-start:and:screenshot-end:to the directives, to keep one slice of a recording. - Add
read_palette(),parse_font_stack(),start_at()andend_at()to the Python API, with matchingpalette,font_stack,startandendarguments ofrecord_and_render(). - Send
SIGTERMto arun_clichild that outlives its timeout, andSIGKILLonly after a grace period, sosudocan forward the first to the command it escalated. - In a dependency compatibility matrix, show
–instead of✅for a major that came out after the last release of a superseded range. - Let the
default_options_uncolored_helpanddefault_options_colored_helpregexes match the help screens of Click8.6.0, which no longer breaks a line after a hyphen. - Fix links to release anchors, like
changelog.md#v1-4-2, failing withmyst.xref_missingunder myst-parser5.2.0when headings take their slug frommake_id. - Fix
prep_path()opening-past a replacedsys.stdout, like Click'sCliRunner(capture="fd"), which kept its output out ofclick:runblocks. - Fix
--export-configwritingUNSETinstead ofnullfor a parameter without a default on a plain Click command. - Fix
format_cli_prompt()and therun_clilogs showing a variable to unset asNAME=None, which a pasted copy sets: the line now opens onenv -u NAME. - Fix unpickling the
NO_CONFIGandVCSsentinels, which raisedValueError: <object object> is not a valid Sentinel. - Fix a lone XML element naming a multi-value option, which failed with
Value must be an iterable.: it now reads as a one-item list. - Skip the process-tree tests where the process table does not list the test process, like in the MacPorts build sandbox.
- List
hjson,pyyamlandtomlrtin thetestdependency group: the test suite needs them, so a distribution build must install them.
Full changelog: v10.2.0...v10.3.0