@neralabs/rerail-pack-python 0.1.1

package/rules/ruff-async100-cancel-scope-no-checkpoint.json

@@ -0,0 +1,357 @@
+{
+ "format": "rerail.policy/v1",
+ "id": "ruff-async100-cancel-scope-no-checkpoint",
+ "revision": 1,
+ "mode": "steer",
+ "description": "Port of Ruff's ASYNC100 (cancel-scope-no-checkpoint): a `with` statement whose last timeout-context item (`asyncio.timeout[_at]`, `anyio.move_on_after`/`fail_after`/`CancelScope`, `trio.move_on_after`/`move_on_at`/`fail_after`/`fail_at`/`CancelScope` calls) is the last item when the statement is `async with`, and whose body has no `yield` (nested scopes included) and no `await`, `async with`, `async for` or async comprehension outside nested functions and classes. Reported on the whole statement. Names resolve as in Ruff's resolve_qualified_name, through the engine's `resolves` (M7).",
+ "scope": {
+  "include": [
+   "**/*"
+  ],
+  "exclude": []
+ },
+ "clauses": [
+  {
+   "id": "cancel-scope-no-checkpoint",
+   "forbid": {
+    "ast": {
+     "language": "python",
+     "utils": {
+      "scope-body": {
+       "kind": "block",
+       "inside": {
+        "stopBy": "neighbor",
+        "any": [
+         {
+          "kind": "function_definition"
+         },
+         {
+          "kind": "class_definition"
+         }
+        ]
+       }
+      },
+      "lambda-body": {
+       "inside": {
+        "stopBy": "neighbor",
+        "kind": "lambda"
+       },
+       "follows": {
+        "stopBy": "end",
+        "regex": "^:$"
+       }
+      },
+      "callee-position": {
+       "any": [
+        {
+         "inside": {
+          "stopBy": "neighbor",
+          "kind": "call"
+         },
+         "precedes": {
+          "stopBy": "neighbor",
+          "any": [
+           {
+            "kind": "argument_list"
+           },
+           {
+            "kind": "generator_expression"
+           }
+          ]
+         }
+        },
+        {
+         "inside": {
+          "stopBy": "neighbor",
+          "kind": "parenthesized_expression",
+          "matches": "callee-position"
+         }
+        }
+       ]
+      },
+      "async-context": {
+       "inside": {
+        "stopBy": {
+         "any": [
+          {
+           "matches": "scope-body"
+          },
+          {
+           "matches": "lambda-body"
+          }
+         ]
+        },
+        "kind": "block",
+        "inside": {
+         "stopBy": "neighbor",
+         "kind": "function_definition",
+         "has": {
+          "stopBy": "neighbor",
+          "regex": "^async$"
+         }
+        }
+       }
+      },
+      "target": {
+       "any": [
+        {
+         "kind": "identifier"
+        },
+        {
+         "kind": "attribute"
+        }
+       ],
+       "resolves": {
+        "import": [
+         "asyncio.timeout",
+         "asyncio.timeout_at",
+         "anyio.move_on_after",
+         "anyio.fail_after",
+         "anyio.CancelScope",
+         "trio.move_on_after",
+         "trio.move_on_at",
+         "trio.fail_after",
+         "trio.fail_at",
+         "trio.CancelScope"
+        ]
+       }
+      },
+      "callee-of-target": {
+       "any": [
+        {
+         "matches": "target"
+        },
+        {
+         "kind": "parenthesized_expression",
+         "has": {
+          "stopBy": "neighbor",
+          "matches": "callee-of-target"
+         }
+        }
+       ]
+      },
+      "item-value": {
+       "any": [
+        {
+         "kind": "call",
+         "has": {
+          "stopBy": "neighbor",
+          "pattern": "$CALLEE",
+          "matches": "callee-of-target",
+          "precedes": {
+           "stopBy": "neighbor",
+           "any": [
+            {
+             "kind": "argument_list"
+            },
+            {
+             "kind": "generator_expression"
+            }
+           ]
+          }
+         }
+        },
+        {
+         "kind": "parenthesized_expression",
+         "has": {
+          "stopBy": "neighbor",
+          "matches": "item-value"
+         }
+        }
+       ]
+      },
+      "item-value-plain": {
+       "any": [
+        {
+         "kind": "call",
+         "has": {
+          "stopBy": "neighbor",
+          "matches": "callee-of-target",
+          "precedes": {
+           "stopBy": "neighbor",
+           "any": [
+            {
+             "kind": "argument_list"
+            },
+            {
+             "kind": "generator_expression"
+            }
+           ]
+          }
+         }
+        },
+        {
+         "kind": "parenthesized_expression",
+         "has": {
+          "stopBy": "neighbor",
+          "matches": "item-value-plain"
+         }
+        }
+       ]
+      },
+      "timeout-item": {
+       "kind": "with_item",
+       "has": {
+        "stopBy": "neighbor",
+        "any": [
+         {
+          "matches": "item-value"
+         },
+         {
+          "kind": "as_pattern",
+          "has": {
+           "stopBy": "neighbor",
+           "matches": "item-value",
+           "precedes": {
+            "stopBy": "end",
+            "regex": "^as$"
+           }
+          }
+         }
+        ]
+       }
+      },
+      "timeout-item-plain": {
+       "kind": "with_item",
+       "has": {
+        "stopBy": "neighbor",
+        "any": [
+         {
+          "matches": "item-value-plain"
+         },
+         {
+          "kind": "as_pattern",
+          "has": {
+           "stopBy": "neighbor",
+           "matches": "item-value-plain",
+           "precedes": {
+            "stopBy": "end",
+            "regex": "^as$"
+           }
+          }
+         }
+        ]
+       }
+      },
+      "is-async": {
+       "has": {
+        "stopBy": "neighbor",
+        "regex": "^async$"
+       }
+      },
+      "checkpoint": {
+       "any": [
+        {
+         "kind": "await"
+        },
+        {
+         "kind": "with_statement",
+         "matches": "is-async"
+        },
+        {
+         "kind": "for_statement",
+         "matches": "is-async"
+        },
+        {
+         "kind": "for_in_clause",
+         "matches": "is-async"
+        }
+       ]
+      }
+     },
+     "rule": {
+      "kind": "with_statement",
+      "all": [
+       {
+        "has": {
+         "stopBy": "neighbor",
+         "kind": "with_clause",
+         "has": {
+          "stopBy": "neighbor",
+          "matches": "timeout-item",
+          "not": {
+           "precedes": {
+            "stopBy": "end",
+            "matches": "timeout-item-plain"
+           }
+          },
+          "any": [
+           {
+            "not": {
+             "inside": {
+              "stopBy": "neighbor",
+              "inside": {
+               "stopBy": "neighbor",
+               "matches": "is-async"
+              }
+             }
+            }
+           },
+           {
+            "not": {
+             "precedes": {
+              "stopBy": "end",
+              "kind": "with_item"
+             }
+            }
+           }
+          ]
+         }
+        }
+       },
+       {
+        "has": {
+         "stopBy": "neighbor",
+         "kind": "block",
+         "not": {
+          "any": [
+           {
+            "has": {
+             "stopBy": "end",
+             "kind": "yield",
+             "not": {
+              "has": {
+               "stopBy": "neighbor",
+               "regex": "^from$"
+              }
+             }
+            }
+           },
+           {
+            "has": {
+             "stopBy": {
+              "any": [
+               {
+                "kind": "function_definition"
+               },
+               {
+                "kind": "class_definition"
+               }
+              ]
+             },
+             "matches": "checkpoint"
+            }
+           }
+          ]
+         }
+        }
+       }
+      ]
+     }
+    }
+   },
+   "violation": {
+    "anchor": "witness.span",
+    "code": "ASYNC100",
+    "message": "A `with $CALLEE(...):` context does not contain any `await` statements. This makes it pointless, as the timeout can only be triggered by a checkpoint.",
+    "suppress": {
+      "noqa": {
+        "codes": [
+          "ASYNC100"
+        ]
+      }
+    }
+   }
+  }
+ ]
+}

package/rules/ruff-async105-trio-sync-call.json

@@ -0,0 +1,199 @@
+{
+ "format": "rerail.policy/v1",
+ "id": "ruff-async105-trio-sync-call",
+ "revision": 1,
+ "mode": "steer",
+ "description": "Port of Ruff's ASYNC105 (trio-sync-call): a call to one of trio's async functions (Ruff's MethodName::is_async list) that is not the operand of an `await` (parentheses ignored), in any context. Reported on the call. Names resolve as in Ruff's resolve_qualified_name, through the engine's `resolves` (M7).",
+ "scope": {
+  "include": [
+   "**/*"
+  ],
+  "exclude": []
+ },
+ "clauses": [
+  {
+   "id": "trio-sync-call",
+   "forbid": {
+    "ast": {
+     "language": "python",
+     "utils": {
+      "scope-body": {
+       "kind": "block",
+       "inside": {
+        "stopBy": "neighbor",
+        "any": [
+         {
+          "kind": "function_definition"
+         },
+         {
+          "kind": "class_definition"
+         }
+        ]
+       }
+      },
+      "lambda-body": {
+       "inside": {
+        "stopBy": "neighbor",
+        "kind": "lambda"
+       },
+       "follows": {
+        "stopBy": "end",
+        "regex": "^:$"
+       }
+      },
+      "callee-position": {
+       "any": [
+        {
+         "inside": {
+          "stopBy": "neighbor",
+          "kind": "call"
+         },
+         "precedes": {
+          "stopBy": "neighbor",
+          "any": [
+           {
+            "kind": "argument_list"
+           },
+           {
+            "kind": "generator_expression"
+           }
+          ]
+         }
+        },
+        {
+         "inside": {
+          "stopBy": "neighbor",
+          "kind": "parenthesized_expression",
+          "matches": "callee-position"
+         }
+        }
+       ]
+      },
+      "async-context": {
+       "inside": {
+        "stopBy": {
+         "any": [
+          {
+           "matches": "scope-body"
+          },
+          {
+           "matches": "lambda-body"
+          }
+         ]
+        },
+        "kind": "block",
+        "inside": {
+         "stopBy": "neighbor",
+         "kind": "function_definition",
+         "has": {
+          "stopBy": "neighbor",
+          "regex": "^async$"
+         }
+        }
+       }
+      },
+      "target": {
+       "any": [
+        {
+         "kind": "identifier"
+        },
+        {
+         "kind": "attribute"
+        }
+       ],
+       "resolves": {
+        "import": [
+         "trio.aclose_forcefully",
+         "trio.open_file",
+         "trio.open_ssl_over_tcp_listeners",
+         "trio.open_ssl_over_tcp_stream",
+         "trio.open_tcp_listeners",
+         "trio.open_tcp_stream",
+         "trio.open_unix_socket",
+         "trio.run_process",
+         "trio.serve_listeners",
+         "trio.serve_ssl_over_tcp",
+         "trio.serve_tcp",
+         "trio.sleep",
+         "trio.sleep_forever",
+         "trio.lowlevel.cancel_shielded_checkpoint",
+         "trio.lowlevel.checkpoint",
+         "trio.lowlevel.checkpoint_if_cancelled",
+         "trio.lowlevel.open_process",
+         "trio.lowlevel.permanently_detach_coroutine_object",
+         "trio.lowlevel.reattach_detached_coroutine_object",
+         "trio.lowlevel.temporarily_detach_coroutine_object",
+         "trio.lowlevel.wait_readable",
+         "trio.lowlevel.wait_task_rescheduled",
+         "trio.lowlevel.wait_writable"
+        ]
+       }
+      },
+      "callee-of-target": {
+       "any": [
+        {
+         "matches": "target"
+        },
+        {
+         "kind": "parenthesized_expression",
+         "has": {
+          "stopBy": "neighbor",
+          "matches": "callee-of-target"
+         }
+        }
+       ]
+      },
+      "awaited": {
+       "inside": {
+        "stopBy": "neighbor",
+        "any": [
+         {
+          "kind": "await"
+         },
+         {
+          "kind": "parenthesized_expression",
+          "matches": "awaited"
+         }
+        ]
+       }
+      }
+     },
+     "rule": {
+      "kind": "call",
+      "has": {
+       "stopBy": "neighbor",
+       "pattern": "$CALLEE",
+       "matches": "callee-of-target",
+       "precedes": {
+        "stopBy": "neighbor",
+        "any": [
+         {
+          "kind": "argument_list"
+         },
+         {
+          "kind": "generator_expression"
+         }
+        ]
+       }
+      },
+      "not": {
+       "matches": "awaited"
+      }
+     }
+    }
+   },
+   "violation": {
+    "anchor": "witness.span",
+    "code": "ASYNC105",
+    "message": "Call to `$CALLEE` is not immediately awaited",
+    "suppress": {
+      "noqa": {
+        "codes": [
+          "ASYNC105"
+        ]
+      }
+    }
+   }
+  }
+ ]
+}