Merge branch 'stable' into unset-in-default-map

Author: Rowlando13

.pre-commit-config.yaml

@@ -13,6 +13,7 @@ repos:
     hooks:
       - id: check-merge-conflict
       - id: debug-statements
+        exclude: ^(src/click/testing\.py|tests/test_testing\.py)$
       - id: fix-byte-order-marker
       - id: trailing-whitespace
       - id: end-of-file-fixer

CHANGES.rst

@@ -16,6 +16,30 @@ Unreleased
 -   Treat ``Sentinel.UNSET`` values in a ``default_map`` as absent, so they fall
     through to the next default source instead of being used as the value.
     :issue:`3224` :pr:`3240`
+-   Patch ``pdb.Pdb`` in ``CliRunner`` isolation so ``pdb.set_trace()``,
+    ``breakpoint()``, and debuggers subclassing ``pdb.Pdb`` (ipdb, pdbpp) can
+    interact with the real terminal instead of the captured I/O streams.
+    :issue:`654` :issue:`824` :issue:`843` :pr:`951` :pr:`3235`
+-   Add optional randomized parallel test execution using ``pytest-randomly`` and
+    ``pytest-xdist`` to detect test pollution and race conditions. :pr:`3151`
+-   Add contributor documentation for running stress tests, randomized
+    parallel tests, and Flask smoke tests. :pr:`3151` :pr:`3177`
+-   Show custom ``show_default`` string in prompts, matching the existing
+    help text behavior. :issue:`2836` :pr:`2837` :pr:`3165` :pr:`3262` :pr:`3280`
+    :pr:`3328``
+-   Fix ``default=True`` with boolean ``flag_value`` always returning the
+    ``flag_value`` instead of ``True``. The ``default=True`` to ``flag_value``
+    substitution now only applies to non-boolean flags, where ``True`` acts as a
+    sentinel meaning "activate this flag by default". For boolean flags,
+    ``default=True`` is returned as a literal value. :issue:`3111` :pr:`3239`
+-   Mark ``make_default_short_help`` as private API. :issue:`3189` :pr:`3250`
+-   ``CliRunner``'s redirected streams now expose the original file descriptor
+    via ``fileno()``, so that ``faulthandler``, ``subprocess``, and other
+    C-level consumers no longer crash with ``io.UnsupportedOperation``.
+    :issue:`2865`
+-   Change :class:`ParameterSource` to an :class:`~enum.IntEnum` and reorder
+    its members from most to least explicit, so values can be compared to
+    check whether a parameter was explicitly provided. :issue:`2879` :pr:`3248`
 
 Version 8.3.2
 -------------

docs/arguments.rst docs/arguments.mddocs/arguments.rst renamed to docs/arguments.md

@@ -1,28 +1,28 @@
-.. _arguments:
+(arguments)=
 
-Arguments
-=========
+# Arguments
 
-.. currentmodule:: click
+```{currentmodule} click
+```
 
 Arguments are:
 
-*   Are positional in nature.
-*   Similar to a limited version of :ref:`options <options>` that can take an arbitrary number of inputs
-*   :ref:`Documented manually <documenting-arguments>`.
+* Are positional in nature.
+* Similar to a limited version of {ref}`options <options>` that can take an arbitrary number of inputs
+* {ref}`Documented manually <documenting-arguments>`.
 
 Useful and often used kwargs are:
 
-*   ``default``: Passes a default.
-*   ``nargs``: Sets the number of arguments. Set to -1 to take an arbitrary number.
+* `default`: Passes a default.
+* `nargs`: Sets the number of arguments. Set to -1 to take an arbitrary number.
 
-Basic Arguments
----------------
+## Basic Arguments
 
-A minimal :class:`click.Argument` solely takes one string argument: the name of the argument. This will assume the argument is required, has no default, and is of the type ``str``.
+A minimal {class}`click.Argument` solely takes one string argument: the name of the argument. This will assume the argument is required, has no default, and is of the type `str`.
 
 Example:
 
+```{eval-rst}
 .. click:example::
 
     @click.command()
@@ -36,19 +36,21 @@ And from the command line:
 .. click:run::
 
     invoke(touch, args=['foo.txt'])
+```
 
+An argument may be assigned a {ref}`parameter type <parameter-types>`. If no type is provided, the type of the default value is used. If no default value is provided, the type is assumed to be {data}`STRING`.
 
-An argument may be assigned a :ref:`parameter type <parameter-types>`. If no type is provided, the type of the default value is used. If no default value is provided, the type is assumed to be :data:`STRING`.
+```{admonition} Note on Required Arguments
+:class: note
 
-.. admonition:: Note on Required Arguments
+   It is possible to make an argument required by setting `required=True`.  It is not recommended since we think command line tools should gracefully degrade into becoming no ops.  We think this because command line tools are often invoked with wildcard inputs and they should not error out if the wildcard is empty.
+```
 
-   It is possible to make an argument required by setting ``required=True``.  It is not recommended since we think command line tools should gracefully degrade into becoming no ops.  We think this because command line tools are often invoked with wildcard inputs and they should not error out if the wildcard is empty.
+## Multiple Arguments
 
-Multiple Arguments
------------------------------------
-
-To set the number of argument use the ``nargs`` kwarg. It can be set to any positive integer and -1. Setting it to -1, makes the number of arguments arbitrary (which is called variadic) and can only be used once. The arguments are then packed as a tuple and passed to the function.
+To set the number of argument use the `nargs` kwarg. It can be set to any positive integer and -1. Setting it to -1, makes the number of arguments arbitrary (which is called variadic) and can only be used once. The arguments are then packed as a tuple and passed to the function.
 
+```{eval-rst}
 .. click:example::
 
     @click.command()
@@ -64,18 +66,21 @@ And from the command line:
 .. click:run::
 
     invoke(copy, args=['foo.txt', 'usr/david/foo.txt', 'usr/mitsuko/foo.txt'])
+```
 
-.. admonition:: Note on Handling Files
+```{admonition} Note on Handling Files
+:class: note
 
-    This is not how you should handle files and files paths. This merely used as a simple example. See :ref:`handling-files` to learn more about how to handle files in parameters.
+   This is not how you should handle files and files paths. This merely used as a simple example. See {ref}`handling-files` to learn more about how to handle files in parameters.
+```
 
-Argument Escape Sequences
----------------------------
+## Argument Escape Sequences
 
-If you want to process arguments that look like options, like a file named ``-foo.txt`` or ``--foo.txt`` , you must pass the ``--`` separator first. After you pass the ``--``, you may only pass arguments. This is a common feature for POSIX command line tools.
+If you want to process arguments that look like options, like a file named `-foo.txt` or `--foo.txt` , you must pass the `--` separator first. After you pass the `--`, you may only pass arguments. This is a common feature for POSIX command line tools.
 
 Example usage:
 
+```{eval-rst}
 .. click:example::
 
     @click.command()
@@ -90,9 +95,11 @@ And from the command line:
 .. click:run::
 
     invoke(touch, ['--', '-foo.txt', 'bar.txt'])
+```
 
-If you don't like the ``--`` marker, you can set ignore_unknown_options to True to avoid checking unknown options:
+If you don't like the `--` marker, you can set ignore_unknown_options to True to avoid checking unknown options:
 
+```{eval-rst}
 .. click:example::
 
     @click.command(context_settings={"ignore_unknown_options": True})
@@ -107,17 +114,17 @@ And from the command line:
 .. click:run::
 
     invoke(touch, ['-foo.txt', 'bar.txt'])
+```
 
+(environment-variables)=
 
-.. _environment-variables:
-
-Environment Variables
----------------------
+## Environment Variables
 
-Arguments can use environment variables. To do so, pass the name(s) of the environment variable(s) via `envvar` in ``click.argument``.
+Arguments can use environment variables. To do so, pass the name(s) of the environment variable(s) via `envvar` in `click.argument`.
 
 Checking one environment variable:
 
+```{eval-rst}
 .. click:example::
 
     @click.command()
@@ -156,3 +163,4 @@ And from the command line:
         with open('hello.txt', 'w') as f:
             f.write('Hello World from second variable!')
         invoke(echo, env={'SRC_2': 'hello.txt'})
+```

docs/click-concepts.md

@@ -0,0 +1,68 @@
+# Click Concepts
+
+This section covers concepts about Click's design.
+
+```{contents}
+---
+depth: 1
+local: true
+---
+```
+
+(callback-evaluation-order)=
+
+## Callback Evaluation Order
+
+Click works a bit differently than some other command line parsers in that
+it attempts to reconcile the order of arguments as defined by the
+programmer with the order of arguments as defined by the user before
+invoking any callbacks.
+
+This is an important concept to understand when porting complex
+patterns to Click from optparse or other systems.  A parameter
+callback invocation in optparse happens as part of the parsing step,
+whereas a callback invocation in Click happens after the parsing.
+
+The main difference is that in optparse, callbacks are invoked with the raw
+value as it happens, whereas a callback in Click is invoked after the
+value has been fully converted.
+
+Generally, the order of invocation is driven by the order in which the user
+provides the arguments to the script; if there is an option called `--foo`
+and an option called `--bar` and the user calls it as `--bar --foo`, then
+the callback for `bar` will fire before the one for `foo`.
+
+There are three exceptions to this rule which are important to know:
+
+Eagerness:
+>    An option can be set to be "eager".  All eager parameters are
+>    evaluated before all non-eager parameters, but again in the order as
+>    they were provided on the command line by the user.
+
+>    This is important for parameters that execute and exit like `--help`
+>    and `--version`.  Both are eager parameters, but whatever parameter
+>    comes first on the command line will win and exit the program.
+
+Repeated parameters:
+>    If an option or argument is split up on the command line into multiple
+>    places because it is repeated -- for instance, `--exclude foo --include
+>    baz --exclude bar` -- the callback will fire based on the position of
+>    the first option.  In this case, the callback will fire for
+>    `exclude` and it will be passed both options (`foo` and
+>    `bar`), then the callback for `include` will fire with `baz`
+>    only.
+
+>    Note that even if a parameter does not allow multiple versions, Click
+>    will still accept the position of the first, but it will ignore every
+>    value except the last.  The reason for this is to allow composability
+>    through shell aliases that set defaults.
+
+Missing parameters:
+>    If a parameter is not defined on the command line, the callback will
+>    still fire.  This is different from how it works in optparse where
+>    undefined values do not fire the callback.  Missing parameters fire
+>    their callbacks at the very end which makes it possible for them to
+>    default to values from a parameter that came before.
+
+Most of the time you do not need to be concerned about any of this,
+but it is important to know how it works for some advanced cases.