flake8-async 24.3.6__tar.gz → 24.4.2__tar.gz

{flake8-async-24.3.6 → flake8_async-24.4.2}/CHANGELOG.md

@@ -1,6 +1,12 @@
 # Changelog
 *[CalVer, YY.month.patch](https://calver.org/)*
 
+## 24.4.2
+- Add ASYNC119: yield in contextmanager in async generator.
+
+## 24.4.1
+- ASYNC91X fix internal error caused by multiple `try/except` incorrectly sharing state.
+
 ## 24.3.6
 - ASYNC100 no longer triggers if a context manager contains a `yield`.
 

{flake8-async-24.3.6 → flake8_async-24.4.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: flake8-async
-Version: 24.3.6
+Version: 24.4.2
 Summary: A highly opinionated flake8 plugin for Trio-related problems.
 Home-page: https://github.com/python-trio/flake8-async
 Author: Zac Hatfield-Dodds, John Litborn, and Contributors
@@ -66,6 +66,7 @@ pip install flake8-async
 - **ASYNC115**: Replace `[trio/anyio].sleep(0)` with the more suggestive `[trio/anyio].lowlevel.checkpoint()`.
 - **ASYNC116**: `[trio/anyio].sleep()` with >24 hour interval should usually be `[trio/anyio].sleep_forever()`.
 - **ASYNC118**: Don't assign the value of `anyio.get_cancelled_exc_class()` to a variable, since that breaks linter checks and multi-backend programs.
+- **ASYNC119**: `yield` in context manager in async generator is unsafe, the cleanup may be delayed until `await` is no longer allowed. We strongly encourage you to read PEP-533 and use `async with aclosing(...)`, or better yet avoid async generators entirely (see ASYNC900) in favor of context managers which return an iterable channel/queue.
 
 ### Warnings for blocking sync calls in async functions
 Note: 22X, 23X and 24X has not had asyncio-specific suggestions written.
@@ -109,7 +110,7 @@ adding the following to your `.pre-commit-config.yaml`:
 minimum_pre_commit_version: '2.9.0'
 repos:
 - repo: https://github.com/python-trio/flake8-async
-  rev: 24.3.6
+  rev: 24.4.2
   hooks:
     - id: flake8-async
       # args: [--enable=ASYNC, --disable=ASYNC9, --autofix=ASYNC]
@@ -148,6 +149,9 @@ flake8-async **/*.py
 but we prefer using a config file. The file needs to start with a section marker `[flake8]` and the following options are then parsed using flake8's config parser, and can be used just like any other flake8 options.
 Note that it's not currently possible to use a configuration file when running `flake8-async` standalone.
 
+### `ValueError` when trying to `ignore` error codes in config file
+Error codes with more than three letters are not possible to `ignore` in config files since flake8>=6, as flake8 tries to validate correct configuration with a regex. We have decided not to conform to this, as it would be a breaking change for end-users requiring them to update `noqa`s and configurations, we think the `ASYNC` code is much more readable than e.g. `ASYxxx`, and ruff does not enforce such a limit. The easiest option for users hitting this error is to instead use the `--disable` option as documented [below](#--disable). See further discussion and other workarounds in https://github.com/python-trio/flake8-async/issues/230
+
 ### `--enable`
 Comma-separated list of error codes to enable, similar to flake8 --select but is additionally more performant as it will disable non-enabled visitors from running instead of just silencing their errors.
 
@@ -221,6 +225,12 @@ async def my_function():
 # Changelog
 *[CalVer, YY.month.patch](https://calver.org/)*
 
+## 24.4.2
+- Add ASYNC119: yield in contextmanager in async generator.
+
+## 24.4.1
+- ASYNC91X fix internal error caused by multiple `try/except` incorrectly sharing state.
+
 ## 24.3.6
 - ASYNC100 no longer triggers if a context manager contains a `yield`.
 

{flake8-async-24.3.6 → flake8_async-24.4.2}/README.md

@@ -41,6 +41,7 @@ pip install flake8-async
 - **ASYNC115**: Replace `[trio/anyio].sleep(0)` with the more suggestive `[trio/anyio].lowlevel.checkpoint()`.
 - **ASYNC116**: `[trio/anyio].sleep()` with >24 hour interval should usually be `[trio/anyio].sleep_forever()`.
 - **ASYNC118**: Don't assign the value of `anyio.get_cancelled_exc_class()` to a variable, since that breaks linter checks and multi-backend programs.
+- **ASYNC119**: `yield` in context manager in async generator is unsafe, the cleanup may be delayed until `await` is no longer allowed. We strongly encourage you to read PEP-533 and use `async with aclosing(...)`, or better yet avoid async generators entirely (see ASYNC900) in favor of context managers which return an iterable channel/queue.
 
 ### Warnings for blocking sync calls in async functions
 Note: 22X, 23X and 24X has not had asyncio-specific suggestions written.
@@ -84,7 +85,7 @@ adding the following to your `.pre-commit-config.yaml`:
 minimum_pre_commit_version: '2.9.0'
 repos:
 - repo: https://github.com/python-trio/flake8-async
-  rev: 24.3.6
+  rev: 24.4.2
   hooks:
     - id: flake8-async
       # args: [--enable=ASYNC, --disable=ASYNC9, --autofix=ASYNC]
@@ -123,6 +124,9 @@ flake8-async **/*.py
 but we prefer using a config file. The file needs to start with a section marker `[flake8]` and the following options are then parsed using flake8's config parser, and can be used just like any other flake8 options.
 Note that it's not currently possible to use a configuration file when running `flake8-async` standalone.
 
+### `ValueError` when trying to `ignore` error codes in config file
+Error codes with more than three letters are not possible to `ignore` in config files since flake8>=6, as flake8 tries to validate correct configuration with a regex. We have decided not to conform to this, as it would be a breaking change for end-users requiring them to update `noqa`s and configurations, we think the `ASYNC` code is much more readable than e.g. `ASYxxx`, and ruff does not enforce such a limit. The easiest option for users hitting this error is to instead use the `--disable` option as documented [below](#--disable). See further discussion and other workarounds in https://github.com/python-trio/flake8-async/issues/230
+
 ### `--enable`
 Comma-separated list of error codes to enable, similar to flake8 --select but is additionally more performant as it will disable non-enabled visitors from running instead of just silencing their errors.
 

{flake8-async-24.3.6 → flake8_async-24.4.2}/flake8_async/__init__.py

@@ -37,7 +37,7 @@ if TYPE_CHECKING:
 
 
 # CalVer: YY.month.patch, e.g. first release of July 2022 == "22.7.1"
-__version__ = "24.3.6"
+__version__ = "24.4.2"
 
 
 # taken from https://github.com/Zac-HD/shed

{flake8-async-24.3.6 → flake8_async-24.4.2}/flake8_async/visitors/visitor91x.py

@@ -454,7 +454,7 @@ class Visitor91X(Flake8AsyncVisitor_cst, CommonVisitors):
     def visit_Try(self, node: cst.Try):
         if not self.async_function:
             return
-        self.save_state(node, "try_state")
+        self.save_state(node, "try_state", copy=True)
         # except & finally guaranteed to enter with checkpoint if checkpointed
         # before try and no yield in try body.
         self.try_state.body_uncheckpointed_statements = (
@@ -596,6 +596,8 @@ class Visitor91X(Flake8AsyncVisitor_cst, CommonVisitors):
         self.save_state(
             node,
             "uncheckpointed_statements",
+            # reference is overwritten below so don't need to copy
+            copy=False,
         )
 
         # inject an artificial uncheckpointed statement that won't raise an error,

{flake8-async-24.3.6 → flake8_async-24.4.2}/flake8_async/visitors/visitors.py

@@ -281,6 +281,45 @@ class Visitor116(Flake8AsyncVisitor):
                 self.error(node, m[2])
 
 
+@error_class
+class Visitor119(Flake8AsyncVisitor):
+    error_codes: Mapping[str, str] = {
+        "ASYNC119": "Yield in contextmanager in async generator might not trigger"
+        " cleanup. Use `@asynccontextmanager` or refactor."
+    }
+
+    def __init__(self, *args: Any, **kwargs: Any):
+        super().__init__(*args, **kwargs)
+        self.unsafe_function: bool = False
+        self.contextmanager: bool = False
+
+    def visit_AsyncFunctionDef(
+        self, node: ast.AsyncFunctionDef | ast.FunctionDef | ast.Lambda
+    ):
+        self.save_state(node, "unsafe_function", "contextmanager")
+        self.contextmanager = False
+        if isinstance(node, ast.AsyncFunctionDef) and not has_decorator(
+            node, "asynccontextmanager"
+        ):
+            self.unsafe_function = True
+        else:
+            self.unsafe_function = False
+
+    def visit_With(self, node: ast.With | ast.AsyncWith):
+        self.save_state(node, "contextmanager")
+        self.contextmanager = True
+
+    def visit_Yield(self, node: ast.Yield):
+        if self.unsafe_function and self.contextmanager:
+            self.error(node)
+
+    visit_AsyncWith = visit_With
+    visit_FunctionDef = visit_AsyncFunctionDef
+    # it's not possible to yield or open context managers in lambda's, so this
+    # one isn't strictly needed afaik.
+    visit_Lambda = visit_AsyncFunctionDef
+
+
 @error_class
 @disabled_by_default
 class Visitor900(Flake8AsyncVisitor):

{flake8-async-24.3.6 → flake8_async-24.4.2}/flake8_async.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: flake8-async
-Version: 24.3.6
+Version: 24.4.2
 Summary: A highly opinionated flake8 plugin for Trio-related problems.
 Home-page: https://github.com/python-trio/flake8-async
 Author: Zac Hatfield-Dodds, John Litborn, and Contributors
@@ -66,6 +66,7 @@ pip install flake8-async
 - **ASYNC115**: Replace `[trio/anyio].sleep(0)` with the more suggestive `[trio/anyio].lowlevel.checkpoint()`.
 - **ASYNC116**: `[trio/anyio].sleep()` with >24 hour interval should usually be `[trio/anyio].sleep_forever()`.
 - **ASYNC118**: Don't assign the value of `anyio.get_cancelled_exc_class()` to a variable, since that breaks linter checks and multi-backend programs.
+- **ASYNC119**: `yield` in context manager in async generator is unsafe, the cleanup may be delayed until `await` is no longer allowed. We strongly encourage you to read PEP-533 and use `async with aclosing(...)`, or better yet avoid async generators entirely (see ASYNC900) in favor of context managers which return an iterable channel/queue.
 
 ### Warnings for blocking sync calls in async functions
 Note: 22X, 23X and 24X has not had asyncio-specific suggestions written.
@@ -109,7 +110,7 @@ adding the following to your `.pre-commit-config.yaml`:
 minimum_pre_commit_version: '2.9.0'
 repos:
 - repo: https://github.com/python-trio/flake8-async
-  rev: 24.3.6
+  rev: 24.4.2
   hooks:
     - id: flake8-async
       # args: [--enable=ASYNC, --disable=ASYNC9, --autofix=ASYNC]
@@ -148,6 +149,9 @@ flake8-async **/*.py
 but we prefer using a config file. The file needs to start with a section marker `[flake8]` and the following options are then parsed using flake8's config parser, and can be used just like any other flake8 options.
 Note that it's not currently possible to use a configuration file when running `flake8-async` standalone.
 
+### `ValueError` when trying to `ignore` error codes in config file
+Error codes with more than three letters are not possible to `ignore` in config files since flake8>=6, as flake8 tries to validate correct configuration with a regex. We have decided not to conform to this, as it would be a breaking change for end-users requiring them to update `noqa`s and configurations, we think the `ASYNC` code is much more readable than e.g. `ASYxxx`, and ruff does not enforce such a limit. The easiest option for users hitting this error is to instead use the `--disable` option as documented [below](#--disable). See further discussion and other workarounds in https://github.com/python-trio/flake8-async/issues/230
+
 ### `--enable`
 Comma-separated list of error codes to enable, similar to flake8 --select but is additionally more performant as it will disable non-enabled visitors from running instead of just silencing their errors.
 
@@ -221,6 +225,12 @@ async def my_function():
 # Changelog
 *[CalVer, YY.month.patch](https://calver.org/)*
 
+## 24.4.2
+- Add ASYNC119: yield in contextmanager in async generator.
+
+## 24.4.1
+- ASYNC91X fix internal error caused by multiple `try/except` incorrectly sharing state.
+
 ## 24.3.6
 - ASYNC100 no longer triggers if a context manager contains a `yield`.
 

{flake8-async-24.3.6 → flake8_async-24.4.2}/flake8_async.egg-info/SOURCES.txt

@@ -83,6 +83,7 @@ tests/eval_files/async114.py
 tests/eval_files/async115.py
 tests/eval_files/async116.py
 tests/eval_files/async118.py
+tests/eval_files/async119.py
 tests/eval_files/async200.py
 tests/eval_files/async210.py
 tests/eval_files/async211.py

{flake8-async-24.3.6 → flake8_async-24.4.2}/tests/autofix_files/async910.py

@@ -601,3 +601,16 @@ async def await_in_gen_target():
 async def await_everywhere_except_gen_target():  # error: 0, "exit", Statement("function definition", lineno)
     (await x async for x in bar())
     await trio.lowlevel.checkpoint()
+
+
+# Issue #226
+async def fn_226():  # error: 0, "exit", Statement("function definition", lineno)
+    try:
+        while foo():
+            try:
+                await trio.sleep(1)
+            except Exception:
+                pass
+    except Exception:
+        pass
+    await trio.lowlevel.checkpoint()

flake8_async-24.4.2/tests/eval_files/async119.py

@@ -0,0 +1,64 @@
+import contextlib
+
+from contextlib import asynccontextmanager
+
+
+async def unsafe_yield():
+    with open(""):
+        yield  # error: 8
+
+
+async def async_with():
+    async with unsafe_yield():
+        yield  # error: 8
+
+
+async def warn_on_yeach_yield():
+    with open(""):
+        yield  # error: 8
+        yield  # error: 8
+    with open(""):
+        yield  # error: 8
+        yield  # error: 8
+
+
+async def yield_not_in_contextmanager():
+    yield
+    with open(""):
+        ...
+    yield
+
+
+async def yield_in_nested_function():
+    with open(""):
+
+        def foo():
+            yield
+
+
+async def yield_in_nested_async_function():
+    with open(""):
+
+        async def foo():
+            yield
+
+
+async def yield_after_nested_async_function():
+    with open(""):
+
+        async def foo():
+            yield
+
+        yield  # error: 8
+
+
+@asynccontextmanager
+async def safe_in_contextmanager():
+    with open(""):
+        yield
+
+
+@contextlib.asynccontextmanager
+async def safe_in_contextmanager2():
+    with open(""):
+        yield

{flake8-async-24.3.6 → flake8_async-24.4.2}/tests/eval_files/async910.py

@@ -572,3 +572,15 @@ async def await_in_gen_target():
 
 async def await_everywhere_except_gen_target():  # error: 0, "exit", Statement("function definition", lineno)
     (await x async for x in bar())
+
+
+# Issue #226
+async def fn_226():  # error: 0, "exit", Statement("function definition", lineno)
+    try:
+        while foo():
+            try:
+                await trio.sleep(1)
+            except Exception:
+                pass
+    except Exception:
+        pass

{flake8-async-24.3.6 → flake8_async-24.4.2}/tests/test_config_and_args.py

@@ -210,6 +210,7 @@ trio200-blocking-calls =
   other -> async,
   sync_fns.* -> the_async_equivalent,
 select = ASYNC200
+extend-ignore = E
 """
     )
     assert tmp_path.joinpath("example.py").write_text(
@@ -403,3 +404,33 @@ def test_disable_noqa_ast(
         == "./example.py:1:1: ASYNC106 trio must be imported with `import trio` for the"
         " linter to work.\n"
     )
+
+
+@pytest.mark.xfail(reason="flake8>=6 enforces three-letter error codes in config")
+def test_config_ignore_error_code(tmp_path: Path) -> None:
+    assert tmp_path.joinpath(".flake8").write_text(
+        """
+[flake8]
+ignore = ASYNC100
+"""
+    )
+    res = subprocess.run(
+        ["flake8", "--help"], cwd=tmp_path, capture_output=True, check=False
+    )
+    assert not res.stderr
+    assert res.returncode == 0
+
+
+# but make sure we can disable selected codes
+def test_config_disable_error_code(tmp_path: Path) -> None:
+    # select ASYNC200 and create file that induces ASYNC200
+    _test_trio200_from_config_common(tmp_path)
+    # disable ASYNC200
+    with open(tmp_path.joinpath(".flake8"), "a", encoding="utf-8") as file:
+        file.write("disable = ASYNC200")
+
+    # it now returns no errors
+    res = subprocess.run(["flake8"], cwd=tmp_path, capture_output=True, check=True)
+    assert not res.stdout
+    assert not res.stderr
+    assert res.returncode == 0

{flake8-async-24.3.6 → flake8_async-24.4.2}/tests/test_flake8_async.py

@@ -416,6 +416,7 @@ def _parse_eval_file(
                 msg = f"Line {lineno}: Failed to format\n {message!r}\nwith\n{args}"
                 raise ParseError(msg) from e
 
+    assert enabled_codes, "no codes enabled. Fix file name or add `# ARGS --enable=...`"
     enabled_codes_list = enabled_codes.split(",")
     for code in enabled_codes_list:
         assert re.fullmatch(

{flake8-async-24.3.6 → flake8_async-24.4.2}/tox.ini

@@ -20,6 +20,18 @@ deps =
 commands =
     pytest {posargs:-n auto}
 
+[testenv:docs]
+description = Generate docs locally
+deps =
+    sphinx
+    readthedocs-sphinx-ext
+    -r docs/requirements.txt
+allowlist_externals = make
+changedir = docs
+skip_install = True
+commands =
+    make html
+
 # Settings for other tools
 [pytest]
 addopts =