flake8-async 24.3.2__tar.gz → 24.3.4__tar.gz

{flake8-async-24.3.2 → flake8-async-24.3.4}/CHANGELOG.md

@@ -1,6 +1,12 @@
 # Changelog
 *[CalVer, YY.month.patch](https://calver.org/)*
 
+## 24.3.4
+- ASYNC110 (don't loop sleep) now also warns if looping `[trio/anyio].lowlevel.checkpoint()`
+
+## 24.3.3
+- Add ASYNC251: `time.sleep()` in async method.
+
 ## 24.3.2
 - Add ASYNC250: blocking sync call `input()` in async method.
 

{flake8-async-24.3.2 → flake8-async-24.3.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: flake8-async
-Version: 24.3.2
+Version: 24.3.4
 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
@@ -80,7 +80,8 @@ Note: 22X, 23X and 24X has not had asyncio-specific suggestions written.
 - **ASYNC231**: Sync IO call in async function, use `[trio/anyio].wrap_file(...)`. `asyncio` users need to use a library such as [aiofiles](https://pypi.org/project/aiofiles/), or switch to [anyio](https://github.com/agronholm/anyio).
 - **ASYNC232**: Blocking sync call on file object, wrap the file object in `[trio/anyio].wrap_file()` to get an async file object.
 - **ASYNC240**: Avoid using `os.path` in async functions, prefer using `[trio/anyio].Path` objects. `asyncio` users should consider [aiopath](https://pypi.org/project/aiopath) or [anyio](https://github.com/agronholm/anyio).
-- **ASYNC250**: Builtin `input()` should not be called from async function.
+- **ASYNC250**: Builtin `input()` should not be called from async function. Wrap in `[trio/anyio].to_thread.run_sync()` or `asyncio.loop.run_in_executor()`.
+- **ASYNC251**: `time.sleep(...)` should not be called from async function. Use `[trio/anyio/asyncio].sleep(...)`.
 
 ### Warnings disabled by default
 - **ASYNC900**: Async generator without `@asynccontextmanager` not allowed. You might want to enable this on a codebase since async generators are inherently unsafe and cleanup logic might not be performed. See https://github.com/python-trio/flake8-async/issues/211 and https://discuss.python.org/t/using-exceptiongroup-at-anthropic-experience-report/20888/6 for discussion.
@@ -108,7 +109,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.2
+  rev: 24.3.4
   hooks:
     - id: flake8-async
       # args: [--enable=ASYNC, --disable=ASYNC9, --autofix=ASYNC]
@@ -220,6 +221,12 @@ async def my_function():
 # Changelog
 *[CalVer, YY.month.patch](https://calver.org/)*
 
+## 24.3.4
+- ASYNC110 (don't loop sleep) now also warns if looping `[trio/anyio].lowlevel.checkpoint()`
+
+## 24.3.3
+- Add ASYNC251: `time.sleep()` in async method.
+
 ## 24.3.2
 - Add ASYNC250: blocking sync call `input()` in async method.
 

{flake8-async-24.3.2 → flake8-async-24.3.4}/README.md

@@ -55,7 +55,8 @@ Note: 22X, 23X and 24X has not had asyncio-specific suggestions written.
 - **ASYNC231**: Sync IO call in async function, use `[trio/anyio].wrap_file(...)`. `asyncio` users need to use a library such as [aiofiles](https://pypi.org/project/aiofiles/), or switch to [anyio](https://github.com/agronholm/anyio).
 - **ASYNC232**: Blocking sync call on file object, wrap the file object in `[trio/anyio].wrap_file()` to get an async file object.
 - **ASYNC240**: Avoid using `os.path` in async functions, prefer using `[trio/anyio].Path` objects. `asyncio` users should consider [aiopath](https://pypi.org/project/aiopath) or [anyio](https://github.com/agronholm/anyio).
-- **ASYNC250**: Builtin `input()` should not be called from async function.
+- **ASYNC250**: Builtin `input()` should not be called from async function. Wrap in `[trio/anyio].to_thread.run_sync()` or `asyncio.loop.run_in_executor()`.
+- **ASYNC251**: `time.sleep(...)` should not be called from async function. Use `[trio/anyio/asyncio].sleep(...)`.
 
 ### Warnings disabled by default
 - **ASYNC900**: Async generator without `@asynccontextmanager` not allowed. You might want to enable this on a codebase since async generators are inherently unsafe and cleanup logic might not be performed. See https://github.com/python-trio/flake8-async/issues/211 and https://discuss.python.org/t/using-exceptiongroup-at-anthropic-experience-report/20888/6 for discussion.
@@ -83,7 +84,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.2
+  rev: 24.3.4
   hooks:
     - id: flake8-async
       # args: [--enable=ASYNC, --disable=ASYNC9, --autofix=ASYNC]

{flake8-async-24.3.2 → flake8-async-24.3.4}/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.2"
+__version__ = "24.3.4"
 
 
 # taken from https://github.com/Zac-HD/shed

{flake8-async-24.3.2 → flake8-async-24.3.4}/flake8_async/visitors/__init__.py

@@ -25,7 +25,7 @@ default_disabled_error_codes: list[str] = []
 utility_visitors: set[type[Flake8AsyncVisitor]] = set()
 utility_visitors_cst: set[type[Flake8AsyncVisitor_cst]] = set()
 
-# Import all visitors so their decorators run, filling the above containers
+# Import all files with visitors so their decorators run, filling the above containers
 # This has to be done at the end to avoid circular imports
 from . import (
     visitor2xx,

{flake8-async-24.3.2 → flake8-async-24.3.4}/flake8_async/visitors/visitor2xx.py

@@ -398,13 +398,25 @@ wrappers: Mapping[str, str] = {
 class Visitor25X(Visitor200):
     error_codes: Mapping[str, str] = {
         "ASYNC250": ("Blocking sync call `input()` in async function. Wrap in `{}`."),
+        "ASYNC251": (
+            "Blocking sync call `time.sleep(...)` in async function."
+            " Use `await {}.sleep(...)`."
+        ),
     }
 
     def visit_Call(self, node: ast.Call):
         if not self.async_function:
             return
-        if isinstance(node.func, ast.Name) and node.func.id == "input":
+        func_name = ast.unparse(node.func)
+        if func_name == "input":
+            error_code = "ASYNC250"
             if len(self.library) == 1:
-                self.error(node, wrappers[self.library_str])
+                msg_param = wrappers[self.library_str]
             else:
-                self.error(node, "/".join(wrappers[lib] for lib in self.library))
+                msg_param = "/".join(wrappers[lib] for lib in self.library)
+        elif func_name == "time.sleep":
+            error_code = "ASYNC251"
+            msg_param = self.library_str
+        else:
+            return
+        self.error(node, msg_param, error_code=error_code)

{flake8-async-24.3.2 → flake8-async-24.3.4}/flake8_async/visitors/visitors.py

@@ -65,7 +65,19 @@ class Visitor110(Flake8AsyncVisitor):
             len(node.body) == 1
             and isinstance(node.body[0], ast.Expr)
             and isinstance(node.body[0].value, ast.Await)
-            and get_matching_call(node.body[0].value.value, "sleep", "sleep_until")
+            and (
+                get_matching_call(node.body[0].value.value, "sleep", "sleep_until")
+                or (
+                    # get_matching_call doesn't (currently) support checking for trio.x.y
+                    isinstance(call := node.body[0].value.value, ast.Call)
+                    and isinstance(call.func, ast.Attribute)
+                    and call.func.attr == "checkpoint"
+                    and isinstance(call.func.value, ast.Attribute)
+                    and call.func.value.attr == "lowlevel"
+                    and isinstance(call.func.value.value, ast.Name)
+                    and call.func.value.value.id in ("trio", "anyio")
+                )
+            )
         ):
             self.error(node, self.library_str)
 

{flake8-async-24.3.2 → flake8-async-24.3.4}/flake8_async.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: flake8-async
-Version: 24.3.2
+Version: 24.3.4
 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
@@ -80,7 +80,8 @@ Note: 22X, 23X and 24X has not had asyncio-specific suggestions written.
 - **ASYNC231**: Sync IO call in async function, use `[trio/anyio].wrap_file(...)`. `asyncio` users need to use a library such as [aiofiles](https://pypi.org/project/aiofiles/), or switch to [anyio](https://github.com/agronholm/anyio).
 - **ASYNC232**: Blocking sync call on file object, wrap the file object in `[trio/anyio].wrap_file()` to get an async file object.
 - **ASYNC240**: Avoid using `os.path` in async functions, prefer using `[trio/anyio].Path` objects. `asyncio` users should consider [aiopath](https://pypi.org/project/aiopath) or [anyio](https://github.com/agronholm/anyio).
-- **ASYNC250**: Builtin `input()` should not be called from async function.
+- **ASYNC250**: Builtin `input()` should not be called from async function. Wrap in `[trio/anyio].to_thread.run_sync()` or `asyncio.loop.run_in_executor()`.
+- **ASYNC251**: `time.sleep(...)` should not be called from async function. Use `[trio/anyio/asyncio].sleep(...)`.
 
 ### Warnings disabled by default
 - **ASYNC900**: Async generator without `@asynccontextmanager` not allowed. You might want to enable this on a codebase since async generators are inherently unsafe and cleanup logic might not be performed. See https://github.com/python-trio/flake8-async/issues/211 and https://discuss.python.org/t/using-exceptiongroup-at-anthropic-experience-report/20888/6 for discussion.
@@ -108,7 +109,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.2
+  rev: 24.3.4
   hooks:
     - id: flake8-async
       # args: [--enable=ASYNC, --disable=ASYNC9, --autofix=ASYNC]
@@ -220,6 +221,12 @@ async def my_function():
 # Changelog
 *[CalVer, YY.month.patch](https://calver.org/)*
 
+## 24.3.4
+- ASYNC110 (don't loop sleep) now also warns if looping `[trio/anyio].lowlevel.checkpoint()`
+
+## 24.3.3
+- Add ASYNC251: `time.sleep()` in async method.
+
 ## 24.3.2
 - Add ASYNC250: blocking sync call `input()` in async method.
 

{flake8-async-24.3.2 → flake8-async-24.3.4}/flake8_async.egg-info/SOURCES.txt

@@ -94,6 +94,8 @@ tests/eval_files/async23x_asyncio.py
 tests/eval_files/async240.py
 tests/eval_files/async250.py
 tests/eval_files/async250_multi_library.py
+tests/eval_files/async251.py
+tests/eval_files/async251_multi_library.py
 tests/eval_files/async900.py
 tests/eval_files/async910.py
 tests/eval_files/async911.py

{flake8-async-24.3.2 → flake8-async-24.3.4}/tests/eval_files/async110.py

@@ -69,3 +69,8 @@ async def foo():
 
     while await trio.sleep():
         ...
+
+    # also error when looping .lowlevel.checkpoint, which is equivalent to .sleep(0)
+    # see https://github.com/python-trio/flake8-async/issues/201
+    while ...:  # ASYNC110: 4, "trio"
+        await trio.lowlevel.checkpoint()

flake8-async-24.3.4/tests/eval_files/async251.py

@@ -0,0 +1,13 @@
+# NOAUTOFIX
+
+import time
+from time import sleep
+
+
+async def foo():
+    time.sleep(5)  # ASYNC251: 4, "trio"
+    time.sleep(5) if 5 else time.sleep(5)  # ASYNC251: 4, "trio"  # ASYNC251: 28, "trio"
+
+    # Not handled due to difficulty tracking imports and not wanting to trigger
+    # false positives. But could definitely be handled by ruff et al.
+    sleep(5)

flake8-async-24.3.4/tests/eval_files/async251_multi_library.py

@@ -0,0 +1,9 @@
+# BASE_LIBRARY trio
+# NOASYNCIO # tests asyncio without replacing for it
+import trio
+import time
+import asyncio
+
+
+async def foo():
+    time.sleep(5)  # ASYNC251: 4, "[trio/asyncio]"

{flake8-async-24.3.2 → flake8-async-24.3.4}/tests/test_flake8_async.py

@@ -458,20 +458,24 @@ class SyncTransformer(ast.NodeTransformer):
     def visit_Await(self, node: ast.Await):
         return self.generic_visit(node.value)
 
-    def replace_async(self, node: ast.AST, target: type[ast.AST]) -> ast.AST:
+    def replace_async(
+        self, node: ast.AST, target: type[ast.AST], *args: object
+    ) -> ast.AST:
         node = self.generic_visit(node)
-        newnode = target()
+        # py313 gives DeprecationWarning if missing posargs, so we pass them even if we
+        # overwrite __dict__ directly afterwards
+        newnode = target(*args)
         newnode.__dict__ = node.__dict__
         return newnode
 
-    def visit_AsyncFunctionDef(self, node: ast.AST):
-        return self.replace_async(node, ast.FunctionDef)
+    def visit_AsyncFunctionDef(self, node: ast.AsyncFunctionDef):
+        return self.replace_async(node, ast.FunctionDef, node.name, node.args)
 
-    def visit_AsyncWith(self, node: ast.AST):
+    def visit_AsyncWith(self, node: ast.AsyncWith):
         return self.replace_async(node, ast.With)
 
-    def visit_AsyncFor(self, node: ast.AST):
-        return self.replace_async(node, ast.For)
+    def visit_AsyncFor(self, node: ast.AsyncFor):
+        return self.replace_async(node, ast.For, node.target, node.iter)
 
 
 @pytest.mark.parametrize(("test", "path"), test_files)