Merge branch 'main' into deb

Author: smurfix

.gitignore

@@ -1,18 +1,24 @@
-/.idea/
-/.vscode/
+src/*.egg-info/
+/.hypothesis/
+/build/
 /.pybuild/
 .cache/
+/.idea/
+/.vscode/
+/env/
+/venv/
 __pycache__/
 *.pyc
-*.egg-info/
+/docs/_build/
+/.eggs/
+/htmlcov/
+*.pyc
 /build/
 /dist/
 /.pytest_cache/
+/.tox/
 .coverage
 .coverage.*
-htmlcov/
-/docs/_build/
-/.eggs/
-.coverage*
-.tox/
+/htmlcov/
+dist/
 docs/_build/

CHANGES.rst

@@ -14,17 +14,48 @@ asyncclick 8
     ``@asyncclick.async_backend(NAME)`` decorator. The old method of setting
     ``asyncclick.anyio_backend=NAME`` still works.
 
+Version 8.3.0
+--------------
+
+Released 2025-09-15
+
+-   **Important: Breaking asyncclick change**: :func:`asyncclick.prompt` is now
+    async. It accepts a new `blocking` parameter to switch between keeping the
+    async loop running (`False`) and not going belly-up when the user interrupts
+    it using Control-C (`True`). `True` thus is the default (for now).
+
+-   **Improved flag option handling**: Reworked the relationship between ``flag_value``
+    and ``default`` parameters for better consistency:
+
+    * The ``default`` parameter value is now preserved as-is and passed directly
+      to CLI functions (no more unexpected transformations)
+    * Exception: flag options with ``default=True`` maintain backward compatibility
+      by defaulting to their ``flag_value``
+    * The ``default`` parameter can now be any type (``bool``, ``None``, etc.)
+    * Fixes inconsistencies reported in: :issue:`1992` :issue:`2514` :issue:`2610`
+      :issue:`3024` :pr:`3030`
+-   Allow ``default`` to be set on ``Argument`` for ``nargs = -1``. :issue:`2164`
+    :pr:`3030`
+-   Show correct auto complete value for ``nargs`` option in combination with flag
+    option :issue:`2813`
+-   Show correct auto complete value for nargs option in combination with flag option :issue:`2813`
+-   Fix handling of quoted and escaped parameters in Fish autocompletion. :issue:`2995` :pr:`3013`
+-   Lazily import ``shutil``. :pr:`3023`
+-   Properly forward exception information to resources registered with
+    ``click.core.Context.with_resource()``. :issue:`2447` :pr:`3058`
+-   Fix regression related to EOF handling in CliRunner. :issue:`2939`:pr:`2940`
+
 Version 8.2.2
 -------------
 
 Released 2025-07-31
 
--   Fix reconciliation of `default`, `flag_value` and `type` parameters for
+-   Fix reconciliation of ``default``, ``flag_value`` and ``type`` parameters for
     flag options, as well as parsing and normalization of environment variables.
     :issue:`2952` :pr:`2956`
 -   Fix typing issue in ``BadParameter`` and ``MissingParameter`` exceptions for the
     parameter ``param_hint`` that did not allow for a sequence of string where the
-    underlying functino ``_join_param_hints`` allows for it. :issue:`2777` :pr:`2990`
+    underlying function ``_join_param_hints`` allows for it. :issue:`2777` :pr:`2990`
 -   Use the value of ``Enum`` choices to render their default value in help
     screen. Refs :issue:`2911` :pr:`3004`
 -   Fix completion for the Z shell (``zsh``) for completion items containing

Makefile

@@ -0,0 +1,13 @@
+#!/usr/bin/make -f
+
+PACKAGE=asyncclick
+ifneq ($(wildcard /usr/share/sourcemgr/make/py),)
+include /usr/share/sourcemgr/make/py
+# available via http://github.com/smurfix/sourcemgr
+
+else
+%:
+	@echo "Please use 'python setup.py'."
+	@exit 1
+endif
+

README.md

@@ -1,13 +1,11 @@
-<div align="center"><img src="https://raw.githubusercontent.com/pallets/click/refs/heads/stable/docs/_static/click-name.svg" alt="" height="150"></div>
+# $ asyncclick_
+
+Asyncclick is a fork of Click (described below) that works with trio or asyncio.
 
-# AsyncClick
+AsyncClick allows you to seamlessly use async command and subcommand handlers.
 
-[AsyncClick][] is a fork of Click that works well with [anyio][], [Trio][], or [asyncio][].
 
-[anyio]: https://anyio.readthedocs.io/en/stable/
-[Trio]: https://trio.readthedocs.io/en/stable/
-[asyncio]: https://docs.python.org/3/library/asyncio.html
-[AsyncClick]: https://github.com/python-trio/asyncclick/
+<div align="center"><img src="https://raw.githubusercontent.com/pallets/click/refs/heads/stable/docs/_static/click-name.svg" alt="" height="150"></div>
 
 # Click
 
@@ -20,12 +18,11 @@ It aims to make the process of writing command line tools quick and fun
 while also preventing any frustration caused by the inability to
 implement an intended CLI API.
 
-AsyncClick in four points:
+Click in three points:
 
 -   Arbitrary nesting of commands
 -   Automatic help page generation
 -   Supports lazy loading of subcommands at runtime
--   Seamlessly use async-enabled command and subcommand handlers
 
 
 ## A Simple Example
@@ -39,13 +36,13 @@ import anyio
 @click.option("--name", prompt="Your name", help="The person to greet.")
 async def hello(count, name):
     """Simple program that greets NAME for a total of COUNT times."""
-    for x in range(count):
-        if x:
-            await anyio.sleep(0.1)
+    for _ in range(count):
         click.echo(f"Hello, {name}!")
+        await anyio.sleep(0.2)
 
 if __name__ == '__main__':
     hello()
+    # alternately: anyio.run(hello.main)
 ```
 
 ```
@@ -56,15 +53,28 @@ Hello, Click!
 Hello, Click!
 ```
 
-Compared to the original [Click][], you'll note that AsyncClick supports
-optional(!) sprinkling of `async`/`await` keywords wherever your code needs
-them.
+## Differences to Click
+
+This async-ized version of Click is mostly backwards compatible for "normal" use:
+you can freely mix sync and async versions of your command handlers and callbacks.
 
-In the interest of not diverging from Click more than absolutely necessary,
-many examples have not been touched.
+Several advanced methods, most notably :meth:`BaseCommand.main`, and
+:meth:`Context.invoke`, are now asynchronous.
 
+The :meth:`BaseCommand.__call__` alias now invokes the main entry point via
+`anyio.run`. If you already have an async main program, simply use
+``await cmd.main()`` instead of ``cmd()``.
+
+:func:`asyncclick.prompt` is asyncronous and accepts a ``blocking`` parameter
+that switches between "doesn't affect your event loop but has unwanted effects when
+interrupted" (bugfix pending) and "pauses your event loop but is safe to interrupt"
+with Control-C". The latter is the default until we fix that bug.
+
+You cannot use Click and AsyncClick in the same program. This is not a problem
+in practice, as replacing ``import click`` with ``import asyncclick as click``, and
+``from click import ...`` with ``from asyncclick import ...``, should be all that's
+required.
 
-[Click]: https://palletsprojects.com/p/click/
 
 ## Donate
 
@@ -76,13 +86,29 @@ donate today][].
 [please donate today]: https://palletsprojects.com/donate
 
 The AsyncClick fork is maintained by Matthias Urlichs <matthias@urlichs.de>.
-It's not a lot of work, so if you'd like to motivate me, donate to the
-charity of your choice and tell me that you've done so. ;-)
 
 ## Contributing
 
+### Click
+
 See our [detailed contributing documentation][contrib] for many ways to
 contribute, including reporting issues, requesting features, asking or answering
 questions, and making PRs.
 
 [contrib]: https://palletsprojects.com/contributing/
+
+### AsyncClick
+
+You can file async-specific issues, ideally including a corresponding fix,
+to the [MoaT/asyncclick][moat] repository on github.
+
+[moat]: https://github.com/M-o-a-T/asyncclick
+
+#### Testing
+
+If you find a bug, please add a testcase to prevent it from recurring.
+
+In tests, you might wonder why `runner.invoke` is not called asynchronously.
+The reason is that there are far too many of these calls to modify them all.
+Thus ``tests/conftest.py``  contains a monkeypatch that turns this call
+into a thread that runs this call using `anyio.run`.

asyncclick

@@ -1,9 +1,33 @@
+asyncclick (1:8.3.0.0-1) unstable; urgency=medium
+
+  * Merge
+
+ -- Matthias Urlichs <matthias@urlichs.de>  Thu, 02 Oct 2025 18:32:52 +0200
+
 asyncclick (1:8.2.2+anyio.1-1) unstable; urgency=medium
 
   * Merge
 
  -- Matthias Urlichs <matthias@urlichs.de>  Wed, 13 Aug 2025 17:26:28 +0200
 
+asyncclick (1:8.1.8-1) unstable; urgency=medium
+
+  * new Upstream
+
+ -- Matthias Urlichs <matthias@urlichs.de>  Mon, 06 Jan 2025 10:42:05 +0100
+
+asyncclick (1:8.1.7-2) unstable; urgency=medium
+
+  * Fixups
+
+ -- Matthias Urlichs <matthias@urlichs.de>  Sun, 10 Mar 2024 10:28:31 +0100
+
+asyncclick (1:8.1.3-2) unstable; urgency=medium
+
+  * new Upstream
+
+ -- Matthias Urlichs <matthias@urlichs.de>  Tue, 07 Jun 2022 18:53:38 +0200
+
 asyncclick (1:8.0.0a2+anyio.7-1) unstable; urgency=medium
 
   * Merge
@@ -34,6 +58,42 @@ asyncclick (1:8.0.0a2+anyio.1-1) unstable; urgency=medium
 
  -- Matthias Urlichs <matthias@urlichs.de>  Sun, 07 Feb 2021 16:03:11 +0100
 
+asyncclick (1:8.0.3-6) unstable; urgency=medium
+
+  * fix test
+
+ -- Matthias Urlichs <matthias@urlichs.de>  Sat, 15 Jan 2022 22:22:34 +0100
+
+asyncclick (1:8.0.3-5) unstable; urgency=medium
+
+  * enter_context => with_resource
+
+ -- Matthias Urlichs <matthias@urlichs.de>  Sat, 15 Jan 2022 22:21:09 +0100
+
+asyncclick (1:8.0.3-4) unstable; urgency=medium
+
+  * missed anyio markers
+
+ -- Matthias Urlichs <matthias@urlichs.de>  Wed, 05 Jan 2022 11:44:55 +0100
+
+asyncclick (1:8.0.3-3) unstable; urgency=medium
+
+  * missed a comflict marker
+
+ -- Matthias Urlichs <matthias@urlichs.de>  Wed, 05 Jan 2022 11:43:07 +0100
+
+asyncclick (1:8.0.3-2) unstable; urgency=medium
+
+  * Fixed PYTHONPATH for tests
+
+ -- Matthias Urlichs <matthias@urlichs.de>  Wed, 05 Jan 2022 11:42:14 +0100
+
+asyncclick (1:8.0.3-1) unstable; urgency=medium
+
+  * Merge 8.0.3
+
+ -- Matthias Urlichs <matthias@urlichs.de>  Wed, 05 Jan 2022 11:33:57 +0100
+
 asyncclick (1:7.0.90-1) unstable; urgency=medium
 
   * Merge current 7.1

debian/changelog

@@ -6,6 +6,3 @@ export PYBUILD_NAME=asyncclick
 %:
 	dh $@ --with python3 --buildsystem=pybuild
 
-override_dh_auto_test:
-	env PYTHONPATH=src python3 -mpytest -sxv tests/
-

debian/rules

@@ -1,7 +1,7 @@
 Advanced Patterns
 =================
 
-.. currentmodule:: asyncclick
+.. currentmodule:: click
 
 In addition to common functionality, Click offers some advanced features.
 
@@ -38,18 +38,21 @@ Here's an example for a ``--version`` flag:
 
 .. click:example::
 
-    def print_version(ctx, param, value):
+    async def print_version(ctx, param, value):
         if not value or ctx.resilient_parsing:
             return
         click.echo('Version 1.0')
-        ctx.exit()
+        ctx.aexit()
 
     @click.command()
     @click.option('--version', is_flag=True, callback=print_version,
                   expose_value=False, is_eager=True)
     def hello():
         click.echo('Hello World!')
 
+(Note that ``ctx.exit`` is asynchronous in asyncclick, and has thus been renamed.
+Alternately you can use ``sys.exit``.)
+
 The `expose_value` parameter prevents the pretty pointless ``version``
 parameter from being passed to the callback.  If that was not specified, a
 boolean would be passed to the `hello` script.  The `resilient_parsing`
@@ -222,7 +225,7 @@ Example:
     @cli.command()
     @click.option('--count', default=1)
     @click.pass_context
-    async def dist(ctx, count):
+    def dist(ctx, count):
         await ctx.forward(test)
         await ctx.invoke(test, count=42)
 
@@ -366,7 +369,7 @@ Ordinarily, it would be used with the ``with`` statement:
 However, a ``with`` block in a group would exit and close the database
 before it could be used by a subcommand.
 
-Instead, use the context's :meth:`~asyncclick.Context.with_resource` method
+Instead, use the context's :meth:`~click.Context.with_resource` method
 to enter the context manager and return the resource. When the group and
 any subcommands finish, the context's resources are cleaned up.
 
@@ -385,12 +388,9 @@ any subcommands finish, the context's resources are cleaned up.
         for entry in obj.db.query(...):
             click.echo(entry)
 
-There is also a :meth:`~asyncclick.Context.with_async_resource` method
-if the resource must be used asynchronously.
-
 If the resource isn't a context manager, usually it can be wrapped in
 one using something from :mod:`contextlib`. If that's not possible, use
-the context's :meth:`~asyncclick.Context.call_on_close` method to register a
+the context's :meth:`~click.Context.call_on_close` method to register a
 cleanup function.
 
 .. code-block:: python
@@ -407,7 +407,6 @@ cleanup function.
             db.save()
             db.close()
 
-This method also accepts async close procedures.
 
 .. versionchanged:: 8.2 ``Context.call_on_close`` and context managers registered
     via ``Context.with_resource`` will be closed when the CLI exits. These were

docs/advanced.rst

@@ -35,7 +35,7 @@ Decorators
 
 .. autofunction:: make_pass_decorator
 
-.. autofunction:: click.decorators.pass_meta_key
+.. autofunction:: asyncclick.decorators.pass_meta_key
 
 
 Utilities

docs/api.rst

@@ -3,7 +3,7 @@
 Arguments
 =========
 
-.. currentmodule:: asyncclick
+.. currentmodule:: click
 
 Arguments are: