@descryy/adapter-python 0.1.0

package/dist/pytest-config.js

@@ -0,0 +1,147 @@
+/**
+ * The project's own test-collection rules, read rather than assumed.
+ *
+ * ## Why this exists
+ *
+ * `test_*.py`, `Test*`, `test_*` are pytest's **defaults**, and a project can
+ * change all three. Hard-coding them is the same mistake as matching a class
+ * name to decide it is a test suite: approximating a framework's rule when the
+ * framework will state it. The standing rule is *if the framework will tell you,
+ * never infer it* — and here it will, in a file already sitting in the
+ * repository.
+ *
+ * Not hypothetical: `threeclouds-ai` declares `[tool.pytest.ini_options]` with
+ * `testpaths`, and nothing read it.
+ *
+ * ## What is read, and what is deliberately not
+ *
+ * Only the three keys that decide **what is a test**: `python_files`,
+ * `python_classes`, `python_functions`. `testpaths` is *not* read: it narrows
+ * where pytest looks, and narrowing what Descry analyses on the strength of a
+ * test-runner setting would silently shrink the graph for a reason that has
+ * nothing to do with the graph.
+ *
+ * ## Precedence
+ *
+ * pytest's own order for choosing its config file, and only the first one that
+ * carries a section counts — a `pytest.ini` wins outright even when empty of
+ * these keys, exactly as it does for pytest.
+ *
+ * ## The parsing, and its honest limit
+ *
+ * Zero runtime dependencies, so there is no TOML parser here. This reads one
+ * known section and three known keys whose values are a string or an array of
+ * strings, which is the whole of what these keys can be. A key it cannot parse
+ * leaves the default in place — the failure direction is "behaves as before",
+ * never "collects something strange".
+ */
+import { existsSync, readFileSync } from "node:fs";
+import { join } from "node:path";
+export const PYTEST_DEFAULTS = {
+    filePatterns: ["test_*.py", "*_test.py"],
+    classPrefixes: ["Test"],
+    functionPrefixes: ["test"],
+    source: "pytest defaults — no configuration file declares collection rules",
+};
+/** `test_*.py` -> a regex anchored at both ends. Only `*` and `?` are glob here. */
+export function globToRegExp(glob) {
+    const escaped = glob.replace(/[.+^${}()|[\]\\]/g, "\\$&").replace(/\*/g, ".*").replace(/\?/g, ".");
+    return new RegExp(`^${escaped}$`);
+}
+/** Values of `key` in an INI-style section body: whitespace or newline separated. */
+function iniValues(body, key) {
+    const match = new RegExp(`^[ \\t]*${key}[ \\t]*=([^\\n]*(?:\\n[ \\t]+[^\\n]*)*)`, "m").exec(body);
+    if (match === null)
+        return undefined;
+    const values = match[1].split(/\s+/).filter((value) => value !== "");
+    return values.length > 0 ? values : undefined;
+}
+/**
+ * Values of `key` in a TOML table body: a string, or an array of strings.
+ *
+ * **A bare string is a whitespace-separated list, not one pattern.** These three
+ * keys are pytest `args`-type options, and pytest splits their value on
+ * whitespace whichever file it came from. Sentry writes
+ *
+ *     python_files = "test_*.py sentry/testutils/*"
+ *
+ * and reading that as a single glob matches no file that can exist. Measured on
+ * the real repository: **7,955 files analysed, 2,593 files named `test_*.py`,
+ * and zero test cases emitted.** The INI reader has always split correctly; only
+ * this one did not, so the bug was invisible to every project that configures
+ * pytest anywhere but `pyproject.toml`.
+ *
+ * Splitting an *array's* elements too is deliberate — `["test_*.py *_test.py"]`
+ * is legal and means the same thing to pytest.
+ */
+function tomlValues(body, key) {
+    const match = new RegExp(`^[ \\t]*${key}[ \\t]*=[ \\t]*(\\[[^\\]]*\\]|"[^"]*"|'[^']*')`, "m").exec(body);
+    if (match === null)
+        return undefined;
+    const raw = match[1];
+    const literals = raw.startsWith("[")
+        ? [...raw.matchAll(/["']([^"']*)["']/g)].map((m) => m[1])
+        : [raw.slice(1, -1)];
+    const values = literals.flatMap((literal) => literal.split(/\s+/)).filter((value) => value !== "");
+    return values.length > 0 ? values : undefined;
+}
+/** The body of a section, from its header to the next one. */
+function sectionBody(text, header) {
+    const escaped = header.replace(/[.*+?^${}()|[\]\\]/g, "\\$&");
+    const start = new RegExp(`^\\[${escaped}\\][ \\t]*$`, "m").exec(text);
+    if (start === null)
+        return undefined;
+    const after = text.slice(start.index + start[0].length);
+    const next = /^\[/m.exec(after);
+    return next === null ? after : after.slice(0, next.index);
+}
+/**
+ * Read the collection rules a repository declares, or pytest's defaults.
+ *
+ * Order is pytest's: `pytest.ini`, then `pyproject.toml`, then `tox.ini`, then
+ * `setup.cfg`. The first file carrying the section wins outright, whether or not
+ * it sets any of the three keys — narrowing to "the first file that happens to
+ * set the key I want" would silently blend two projects' configurations.
+ */
+export function readPytestConfig(absoluteRoot) {
+    const candidates = [
+        { file: "pytest.ini", header: "pytest", toml: false },
+        { file: "pyproject.toml", header: "tool.pytest.ini_options", toml: true },
+        { file: "tox.ini", header: "pytest", toml: false },
+        { file: "setup.cfg", header: "tool:pytest", toml: false },
+    ];
+    for (const { file, header, toml } of candidates) {
+        const path = join(absoluteRoot, file);
+        if (!existsSync(path))
+            continue;
+        let text;
+        try {
+            text = readFileSync(path, "utf8");
+        }
+        catch {
+            continue;
+        }
+        const body = sectionBody(text, header);
+        if (body === undefined)
+            continue;
+        const read = toml ? tomlValues : iniValues;
+        const filePatterns = read(body, "python_files");
+        const classPrefixes = read(body, "python_classes");
+        const functionPrefixes = read(body, "python_functions");
+        const declared = [
+            filePatterns === undefined ? null : "python_files",
+            classPrefixes === undefined ? null : "python_classes",
+            functionPrefixes === undefined ? null : "python_functions",
+        ].filter((key) => key !== null);
+        return {
+            filePatterns: filePatterns ?? PYTEST_DEFAULTS.filePatterns,
+            classPrefixes: classPrefixes ?? PYTEST_DEFAULTS.classPrefixes,
+            functionPrefixes: functionPrefixes ?? PYTEST_DEFAULTS.functionPrefixes,
+            source: declared.length === 0
+                ? `${file} configures pytest but declares no collection rules, so the defaults apply`
+                : `${file} declares ${declared.join(", ")}`,
+        };
+    }
+    return PYTEST_DEFAULTS;
+}
+//# sourceMappingURL=pytest-config.js.map

package/dist/pytest-config.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"pytest-config.js","sourceRoot":"","sources":["../src/pytest-config.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAoCG;AAEH,OAAO,EAAE,UAAU,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;AACnD,OAAO,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AAajC,MAAM,CAAC,MAAM,eAAe,GAAiB;IAC3C,YAAY,EAAE,CAAC,WAAW,EAAE,WAAW,CAAC;IACxC,aAAa,EAAE,CAAC,MAAM,CAAC;IACvB,gBAAgB,EAAE,CAAC,MAAM,CAAC;IAC1B,MAAM,EAAE,mEAAmE;CAC5E,CAAC;AAEF,oFAAoF;AACpF,MAAM,UAAU,YAAY,CAAC,IAAY;IACvC,MAAM,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC,mBAAmB,EAAE,MAAM,CAAC,CAAC,OAAO,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC,OAAO,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC;IACnG,OAAO,IAAI,MAAM,CAAC,IAAI,OAAO,GAAG,CAAC,CAAC;AACpC,CAAC;AAED,qFAAqF;AACrF,SAAS,SAAS,CAAC,IAAY,EAAE,GAAW;IAC1C,MAAM,KAAK,GAAG,IAAI,MAAM,CAAC,WAAW,GAAG,yCAAyC,EAAE,GAAG,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAClG,IAAI,KAAK,KAAK,IAAI;QAAE,OAAO,SAAS,CAAC;IACrC,MAAM,MAAM,GAAG,KAAK,CAAC,CAAC,CAAE,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,KAAK,EAAE,CAAC,CAAC;IACtE,OAAO,MAAM,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,SAAS,CAAC;AAChD,CAAC;AAED;;;;;;;;;;;;;;;;;GAiBG;AACH,SAAS,UAAU,CAAC,IAAY,EAAE,GAAW;IAC3C,MAAM,KAAK,GAAG,IAAI,MAAM,CAAC,WAAW,GAAG,gDAAgD,EAAE,GAAG,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACzG,IAAI,KAAK,KAAK,IAAI;QAAE,OAAO,SAAS,CAAC;IACrC,MAAM,GAAG,GAAG,KAAK,CAAC,CAAC,CAAE,CAAC;IACtB,MAAM,QAAQ,GAAG,GAAG,CAAC,UAAU,CAAC,GAAG,CAAC;QAClC,CAAC,CAAC,CAAC,GAAG,GAAG,CAAC,QAAQ,CAAC,mBAAmB,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,CAAE,CAAC;QAC1D,CAAC,CAAC,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC;IACvB,MAAM,MAAM,GAAG,QAAQ,CAAC,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,KAAK,EAAE,CAAC,CAAC;IACnG,OAAO,MAAM,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,SAAS,CAAC;AAChD,CAAC;AAED,8DAA8D;AAC9D,SAAS,WAAW,CAAC,IAAY,EAAE,MAAc;IAC/C,MAAM,OAAO,GAAG,MAAM,CAAC,OAAO,CAAC,qBAAqB,EAAE,MAAM,CAAC,CAAC;IAC9D,MAAM,KAAK,GAAG,IAAI,MAAM,CAAC,OAAO,OAAO,aAAa,EAAE,GAAG,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACtE,IAAI,KAAK,KAAK,IAAI;QAAE,OAAO,SAAS,CAAC;IACrC,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,KAAK,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC;IACxD,MAAM,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IAChC,OAAO,IAAI,KAAK,IAAI,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,EAAE,IAAI,CAAC,KAAK,CAAC,CAAC;AAC5D,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,gBAAgB,CAAC,YAAoB;IACnD,MAAM,UAAU,GAAsD;QACpE,EAAE,IAAI,EAAE,YAAY,EAAE,MAAM,EAAE,QAAQ,EAAE,IAAI,EAAE,KAAK,EAAE;QACrD,EAAE,IAAI,EAAE,gBAAgB,EAAE,MAAM,EAAE,yBAAyB,EAAE,IAAI,EAAE,IAAI,EAAE;QACzE,EAAE,IAAI,EAAE,SAAS,EAAE,MAAM,EAAE,QAAQ,EAAE,IAAI,EAAE,KAAK,EAAE;QAClD,EAAE,IAAI,EAAE,WAAW,EAAE,MAAM,EAAE,aAAa,EAAE,IAAI,EAAE,KAAK,EAAE;KAC1D,CAAC;IAEF,KAAK,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,IAAI,UAAU,EAAE,CAAC;QAChD,MAAM,IAAI,GAAG,IAAI,CAAC,YAAY,EAAE,IAAI,CAAC,CAAC;QACtC,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC;YAAE,SAAS;QAChC,IAAI,IAAY,CAAC;QACjB,IAAI,CAAC;YACH,IAAI,GAAG,YAAY,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;QACpC,CAAC;QAAC,MAAM,CAAC;YACP,SAAS;QACX,CAAC;QACD,MAAM,IAAI,GAAG,WAAW,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;QACvC,IAAI,IAAI,KAAK,SAAS;YAAE,SAAS;QAEjC,MAAM,IAAI,GAAG,IAAI,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,SAAS,CAAC;QAC3C,MAAM,YAAY,GAAG,IAAI,CAAC,IAAI,EAAE,cAAc,CAAC,CAAC;QAChD,MAAM,aAAa,GAAG,IAAI,CAAC,IAAI,EAAE,gBAAgB,CAAC,CAAC;QACnD,MAAM,gBAAgB,GAAG,IAAI,CAAC,IAAI,EAAE,kBAAkB,CAAC,CAAC;QACxD,MAAM,QAAQ,GAAG;YACf,YAAY,KAAK,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,cAAc;YAClD,aAAa,KAAK,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,gBAAgB;YACrD,gBAAgB,KAAK,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,kBAAkB;SAC3D,CAAC,MAAM,CAAC,CAAC,GAAG,EAAiB,EAAE,CAAC,GAAG,KAAK,IAAI,CAAC,CAAC;QAE/C,OAAO;YACL,YAAY,EAAE,YAAY,IAAI,eAAe,CAAC,YAAY;YAC1D,aAAa,EAAE,aAAa,IAAI,eAAe,CAAC,aAAa;YAC7D,gBAAgB,EAAE,gBAAgB,IAAI,eAAe,CAAC,gBAAgB;YACtE,MAAM,EACJ,QAAQ,CAAC,MAAM,KAAK,CAAC;gBACnB,CAAC,CAAC,GAAG,IAAI,4EAA4E;gBACrF,CAAC,CAAC,GAAG,IAAI,aAAa,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE;SAChD,CAAC;IACJ,CAAC;IAED,OAAO,eAAe,CAAC;AACzB,CAAC"}

package/dist/routes.d.ts

@@ -0,0 +1,249 @@
+/**
+ * The HTTP-route framework extractor for Python — FastAPI, Flask and Django.
+ *
+ * **An `API_ROUTE` is a framework claim, and this file is where it is earned.**
+ * Until now the only producer of a route in this project was `adapter-openapi`,
+ * reading a published contract. That is the right first move — *if the framework
+ * will tell you, never infer it* — but a repository that publishes no contract
+ * has no route side of the join at all, and most repositories publish nothing.
+ * FastAPI, Flask and Django all *declare* their routes in source: a decorator
+ * carrying a method and a path template, or a `urlpatterns` list. Reading a
+ * declaration is not inference.
+ *
+ * ## The rule that does all the precision work
+ *
+ * **A route is admitted only when its receiver resolves to a router or
+ * application constructed from a web framework's own module.** Never because an
+ * attribute happens to be spelled like an HTTP verb.
+ *
+ * That is not a theoretical guard. Matching `@x.get`/`@x.post`/`@x.patch` by
+ * name alone, measured before this file was written:
+ *
+ * | repository | verb-named decorators | actually routes |
+ * | --- | --- | --- |
+ * | django | 171 `@mock.patch` | **0** |
+ * | saleor | 1,150 `@mock.patch` | **0** |
+ * | dispatch | 1 `@app.options` on a Slack Bolt app | **0** |
+ *
+ * `unittest.mock.patch` is spelled exactly like the HTTP verb, and on saleor a
+ * name rule would have invented 1,150 routes — every one of them a false claim
+ * about a URL that does not exist. Slack Bolt's `app.options()` registers an
+ * *action id*, not a path. This is golden pattern 12's lesson and §4 rule 3: a
+ * node type comes from provenance — an import, a decorator, a base class — or
+ * from nothing.
+ *
+ * ## Everything below the receiver check is arithmetic on written strings
+ *
+ * A served path is a router's mount prefix chain plus the path at the decorator.
+ * On dispatch that chain is four hops and crosses files under import aliases:
+ *
+ *     app.mount("/api/v1", app=api)                        # main.py
+ *     api.include_router(api_router)                       # main.py
+ *     api_router.include_router(auth_router, prefix=...)   # api.py, aliased
+ *     @auth_router.get("/me")                              # auth/views.py
+ *
+ * **Every hop of that chain must be followed or the answer is wrong in a way
+ * that reads as right.** Dropping the outermost hop yields `/{organization}/…`
+ * instead of `/api/v1/{organization}/…`: a plausible path, no error, no ledger
+ * row — and a caller that resolved its base URL to `/api/v1` (DEC-052 followed
+ * exactly that, three symbol hops on the consumer side) mints a different
+ * endpoint id and joins nothing. That is DEC-055's failure mode: everything
+ * normalises, everything resolves, and the join count is silently zero.
+ *
+ * ## Where the line is
+ *
+ * A prefix or path written as anything but a literal is **disclosed, never
+ * guessed**. Emitting a route for a path built at runtime attaches a caller to
+ * an endpoint that does not exist, and unlike a missing edge nothing downstream
+ * can tell that from a correct one.
+ *
+ * The split with `extract.py` is this adapter's standing one: the Python side
+ * records syntactic form and names no framework, and every decision about what
+ * a form *means* is taken here.
+ */
+import type { PyCall } from "./extract.ts";
+export type RouteFramework = "fastapi" | "flask" | "django";
+/**
+ * The constructors that make a receiver a router, and the modules they must
+ * come from. The module check is the precision control: a local class called
+ * `Blueprint` is not Flask's, and matching the bare name would admit it.
+ */
+export declare const ROUTER_CONSTRUCTORS: Readonly<Record<RouteFramework, Readonly<Record<string, ReadonlySet<string>>>>>;
+/** `django.urls.path`/`re_path`/`url`, and `include` for a nested urlconf. */
+export declare const DJANGO_URL_MODULES: ReadonlySet<string>;
+/** HTTP methods a decorator attribute may name. `trace` is included; `head` is. */
+export declare const HTTP_METHODS: ReadonlySet<string>;
+/**
+ * FastAPI and Flask both spell "any method, path given by argument" as
+ * `.route(...)`; FastAPI additionally spells it `.api_route(...)`.
+ */
+export declare const GENERIC_ROUTE_ATTRS: ReadonlySet<string>;
+/** Attributes that mount one router inside another. */
+export declare const MOUNT_ATTRS: ReadonlySet<string>;
+/** A router as the source declares it. */
+export interface RouterDecl {
+    readonly file: string;
+    readonly local: string;
+    readonly framework: RouteFramework;
+    /** The constructor that made it — `APIRouter`, `FastAPI`, `Blueprint`, `Flask`. */
+    readonly constructor: string;
+    /** `""` when none is written; `null` when one is written and unreadable. */
+    readonly prefix: string | null;
+    readonly line: number;
+}
+/**
+ * Is this the application itself rather than a router that must be mounted?
+ *
+ * The distinction decides whether "nothing mounts this" is a disclosure or a
+ * non-event. `FastAPI()` and `Flask()` are roots and serve their routes at the
+ * paths written on them. An `APIRouter` or a `Blueprint` that nothing mounts
+ * serves nothing at all, and the path it would serve is genuinely unknowable.
+ */
+export declare function isApplicationRouter(router: RouterDecl): boolean;
+/** One router mounted inside another. */
+export interface RouterMount {
+    readonly file: string;
+    /** The scope the mount call is written in — `[]` at module level. */
+    readonly scope: readonly string[];
+    readonly parentLocal: string;
+    readonly childLocal: string;
+    readonly prefix: string | null;
+    readonly line: number;
+}
+/** One route declaration, before its prefix chain is resolved. */
+export interface RouteDecl {
+    readonly file: string;
+    /** The scope the decorator is evaluated in — `[]` at module level. */
+    readonly scope: readonly string[];
+    readonly routerLocal: string;
+    readonly methods: readonly string[];
+    /** `null` when the path is written as anything but a literal. */
+    readonly path: string | null;
+    /** The source text of the path argument, for the ledger row. */
+    readonly rawPath: string;
+    readonly line: number;
+    /** The handler this decorator sits on, where there is one. */
+    readonly handler: readonly string[] | null;
+    /** `response_model=` as written, so `list[OrderRead]` is not lost. */
+    readonly responseModel: string | null;
+}
+/** Which framework, if any, a constructor call belongs to. */
+export declare function frameworkOfConstructor(callee: string, moduleOfImport: (name: string) => string | undefined): {
+    framework: RouteFramework;
+    constructor: string;
+} | null;
+/**
+ * Routers declared in one file, by the local name that holds them.
+ *
+ * `moduleOfImport` answers "which module did this name come from", which is the
+ * only thing separating Flask's `Blueprint` from a class of the same name.
+ */
+export declare function routersIn(file: string, calls: readonly PyCall[], assignedLocal: (call: PyCall) => string | undefined, moduleOfImport: (name: string) => string | undefined): RouterDecl[];
+/** Mounts declared in one file. */
+export declare function mountsIn(file: string, calls: readonly PyCall[]): RouterMount[];
+/**
+ * Route declarations from one decorator call.
+ *
+ * Returns `null` when the decorator is not a route at all. The receiver is
+ * *not* checked here — the caller does that against the resolved router table,
+ * because whether `app` is a Flask application or a Slack Bolt one cannot be
+ * decided from this file alone.
+ */
+export declare function routeFromDecorator(file: string, call: PyCall, handler: readonly string[] | null): RouteDecl | null;
+export interface OdooRouteEntry {
+    readonly file: string;
+    readonly scope: readonly string[];
+    /** `null` when the path is written as anything but a literal. */
+    readonly path: string | null;
+    readonly rawPath: string;
+    /** `null` when `methods=` is written but unreadable. Absent keyword defaults to GET, Odoo's own documented default. */
+    readonly methods: readonly string[] | null;
+    readonly line: number;
+    readonly handler: readonly string[] | null;
+}
+/** `@http.route(...)` / `@route(...)`, verified against `odoo.http`. */
+export declare function odooRouteFromDecorator(file: string, call: PyCall, handler: readonly string[] | null, moduleOfImport: (name: string) => string | undefined): OdooRouteEntry | null;
+/** DRF's own router constructors — `rest_framework.routers`. */
+export declare const DRF_ROUTER_CONSTRUCTORS: ReadonlySet<string>;
+/**
+ * DRF's fixed action table — what `DefaultRouter`/`SimpleRouter` always
+ * generate for a registered viewset, unconditionally. This is the router's
+ * own documented contract, not an inference about which actions a viewset
+ * implements: an unimplemented action still gets the URL, and 405s at
+ * request time. Reading the contract rather than the implementation is the
+ * same trade this file already makes for Flask's undecorated `.route()`
+ * default (`GENERIC_ROUTE_ATTRS`, above).
+ */
+export declare const DRF_ACTIONS: readonly {
+    readonly method: string;
+    readonly suffix: string;
+}[];
+export declare function djangoUrlFunctionOf(callee: string, moduleOfImport: (name: string) => string | undefined): string | null;
+/**
+ * `re_path`/`url` write a param as `(?P<name>...)`, not `<type:name>`.
+ *
+ * Translating an arbitrary regex into a path template is not attempted —
+ * that is the same guess `templateOfSource` in `client.ts` refuses to make
+ * for a call path, for the same reason. What is read: the anchors (`^`/`$`,
+ * which every Django regex route carries and which are not part of the
+ * served path), and a named group, which names its own placeholder and
+ * needs no interpretation. Anything else regex-shaped left afterwards —
+ * an unnamed group, a character class, a quantifier on a literal segment —
+ * means the pattern is refused rather than approximated.
+ */
+export declare function djangoRegexPathOf(raw: string): string | null;
+/** One `path()`/`re_path()`/`url()` call, read but not yet chain-resolved. */
+export interface DjangoRouteEntry {
+    readonly file: string;
+    readonly scope: readonly string[];
+    /** `null` when the path could not be read — a ledger row, not a guess. */
+    readonly path: string | null;
+    readonly rawPath: string;
+    readonly line: number;
+    /** The view argument's source text, for the handler-resolution pass. */
+    readonly viewText: string;
+    /** Set when the view is written `X.as_view()` — `X` is the CBV to inspect for verb methods. */
+    readonly viewClassLocal: string | null;
+}
+/** One `path(prefix, include("other.urls"))` — a mount, keyed by module string rather than by local. */
+export interface DjangoIncludeEntry {
+    readonly file: string;
+    readonly scope: readonly string[];
+    /** `""` when no prefix is written; `null` when one is written and unreadable. */
+    readonly prefix: string | null;
+    /** The dotted module `include(...)` names, or `null` when it names anything else. */
+    readonly targetModule: string | null;
+    readonly rawTarget: string;
+    readonly line: number;
+}
+/** Every `path()`/`re_path()`/`url()` call in one file, split into routes and includes. */
+export declare function djangoUrlEntriesIn(file: string, calls: readonly PyCall[], moduleOfImport: (name: string) => string | undefined): {
+    readonly routes: DjangoRouteEntry[];
+    readonly includes: DjangoIncludeEntry[];
+};
+/** `router = DefaultRouter()` / `SimpleRouter()`, verified against `rest_framework.routers`. */
+export declare function drfRouterConstructorOf(callee: string, moduleOfImport: (name: string) => string | undefined): boolean;
+/** One `router.register(prefix, ViewSetClass)` call. */
+export interface DrfRegisterEntry {
+    readonly file: string;
+    readonly routerLocal: string;
+    readonly scope: readonly string[];
+    /** `null` when the prefix is written but unreadable. */
+    readonly prefix: string | null;
+    readonly rawPrefix: string;
+    readonly viewSetText: string;
+    readonly line: number;
+}
+/** Locals bound to a DRF router construction — `router = DefaultRouter()`. */
+export declare function drfRouterLocalsIn(calls: readonly PyCall[], localOfCall: (call: PyCall) => string | undefined, moduleOfImport: (name: string) => string | undefined): ReadonlySet<string>;
+/** Every `.register(...)` call on a receiver, whether or not it is a DRF router — the caller filters. */
+export declare function drfRegisterCallsIn(file: string, calls: readonly PyCall[]): DrfRegisterEntry[];
+/**
+ * Join a mount prefix to a route path.
+ *
+ * Frameworks are lenient about the slash between the two and repositories write
+ * both forms; the served path is the same either way, and two spellings of one
+ * path must not become two endpoints.
+ */
+export declare function joinPath(prefix: string, path: string): string;
+//# sourceMappingURL=routes.d.ts.map

package/dist/routes.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"routes.d.ts","sourceRoot":"","sources":["../src/routes.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8DG;AAEH,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,cAAc,CAAC;AAE3C,MAAM,MAAM,cAAc,GAAG,SAAS,GAAG,OAAO,GAAG,QAAQ,CAAC;AAE5D;;;;GAIG;AACH,eAAO,MAAM,mBAAmB,EAAE,QAAQ,CACxC,MAAM,CAAC,cAAc,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,WAAW,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAWtE,CAAC;AAEF,8EAA8E;AAC9E,eAAO,MAAM,kBAAkB,EAAE,WAAW,CAAC,MAAM,CAIjD,CAAC;AAEH,mFAAmF;AACnF,eAAO,MAAM,YAAY,EAAE,WAAW,CAAC,MAAM,CAS3C,CAAC;AAEH;;;GAGG;AACH,eAAO,MAAM,mBAAmB,EAAE,WAAW,CAAC,MAAM,CAKlD,CAAC;AAEH,uDAAuD;AACvD,eAAO,MAAM,WAAW,EAAE,WAAW,CAAC,MAAM,CAI1C,CAAC;AAEH,0CAA0C;AAC1C,MAAM,WAAW,UAAU;IACzB,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IACvB,QAAQ,CAAC,SAAS,EAAE,cAAc,CAAC;IACnC,mFAAmF;IACnF,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAC;IAC7B,4EAA4E;IAC5E,QAAQ,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;IAC/B,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;CACvB;AAED;;;;;;;GAOG;AACH,wBAAgB,mBAAmB,CAAC,MAAM,EAAE,UAAU,GAAG,OAAO,CAE/D;AAED,yCAAyC;AACzC,MAAM,WAAW,WAAW;IAC1B,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,qEAAqE;IACrE,QAAQ,CAAC,KAAK,EAAE,SAAS,MAAM,EAAE,CAAC;IAClC,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAC;IAC7B,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAC;IAC5B,QAAQ,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;IAC/B,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;CACvB;AAED,kEAAkE;AAClE,MAAM,WAAW,SAAS;IACxB,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,sEAAsE;IACtE,QAAQ,CAAC,KAAK,EAAE,SAAS,MAAM,EAAE,CAAC;IAClC,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAC;IAC7B,QAAQ,CAAC,OAAO,EAAE,SAAS,MAAM,EAAE,CAAC;IACpC,iEAAiE;IACjE,QAAQ,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;IAC7B,gEAAgE;IAChE,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IACzB,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,8DAA8D;IAC9D,QAAQ,CAAC,OAAO,EAAE,SAAS,MAAM,EAAE,GAAG,IAAI,CAAC;IAC3C,sEAAsE;IACtE,QAAQ,CAAC,aAAa,EAAE,MAAM,GAAG,IAAI,CAAC;CACvC;AAED,8DAA8D;AAC9D,wBAAgB,sBAAsB,CACpC,MAAM,EAAE,MAAM,EACd,cAAc,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,MAAM,GAAG,SAAS,GACnD;IAAE,SAAS,EAAE,cAAc,CAAC;IAAC,WAAW,EAAE,MAAM,CAAA;CAAE,GAAG,IAAI,CAsB3D;AAYD;;;;;GAKG;AACH,wBAAgB,SAAS,CACvB,IAAI,EAAE,MAAM,EACZ,KAAK,EAAE,SAAS,MAAM,EAAE,EACxB,aAAa,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,MAAM,GAAG,SAAS,EACnD,cAAc,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,MAAM,GAAG,SAAS,GACnD,UAAU,EAAE,CAkBd;AAED,mCAAmC;AACnC,wBAAgB,QAAQ,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,SAAS,MAAM,EAAE,GAAG,WAAW,EAAE,CA0C9E;AAED;;;;;;;GAOG;AACH,wBAAgB,kBAAkB,CAChC,IAAI,EAAE,MAAM,EACZ,IAAI,EAAE,MAAM,EACZ,OAAO,EAAE,SAAS,MAAM,EAAE,GAAG,IAAI,GAChC,SAAS,GAAG,IAAI,CAuClB;AAeD,MAAM,WAAW,cAAc;IAC7B,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,KAAK,EAAE,SAAS,MAAM,EAAE,CAAC;IAClC,iEAAiE;IACjE,QAAQ,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;IAC7B,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IACzB,uHAAuH;IACvH,QAAQ,CAAC,OAAO,EAAE,SAAS,MAAM,EAAE,GAAG,IAAI,CAAC;IAC3C,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,OAAO,EAAE,SAAS,MAAM,EAAE,GAAG,IAAI,CAAC;CAC5C;AAED,wEAAwE;AACxE,wBAAgB,sBAAsB,CACpC,IAAI,EAAE,MAAM,EACZ,IAAI,EAAE,MAAM,EACZ,OAAO,EAAE,SAAS,MAAM,EAAE,GAAG,IAAI,EACjC,cAAc,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,MAAM,GAAG,SAAS,GACnD,cAAc,GAAG,IAAI,CAyBvB;AAsBD,gEAAgE;AAChE,eAAO,MAAM,uBAAuB,EAAE,WAAW,CAAC,MAAM,CAGtD,CAAC;AAEH;;;;;;;;GAQG;AACH,eAAO,MAAM,WAAW,EAAE,SAAS;IAAE,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IAAC,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAA;CAAE,EAOtF,CAAC;AAuBF,wBAAgB,mBAAmB,CACjC,MAAM,EAAE,MAAM,EACd,cAAc,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,MAAM,GAAG,SAAS,GACnD,MAAM,GAAG,IAAI,CAEf;AAED;;;;;;;;;;;GAWG;AACH,wBAAgB,iBAAiB,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,CAO5D;AAED,8EAA8E;AAC9E,MAAM,WAAW,gBAAgB;IAC/B,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,KAAK,EAAE,SAAS,MAAM,EAAE,CAAC;IAClC,0EAA0E;IAC1E,QAAQ,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;IAC7B,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IACzB,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,wEAAwE;IACxE,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;IAC1B,+FAA+F;IAC/F,QAAQ,CAAC,cAAc,EAAE,MAAM,GAAG,IAAI,CAAC;CACxC;AAED,wGAAwG;AACxG,MAAM,WAAW,kBAAkB;IACjC,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,KAAK,EAAE,SAAS,MAAM,EAAE,CAAC;IAClC,iFAAiF;IACjF,QAAQ,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;IAC/B,qFAAqF;IACrF,QAAQ,CAAC,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;IACrC,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;IAC3B,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;CACvB;AAED,2FAA2F;AAC3F,wBAAgB,kBAAkB,CAChC,IAAI,EAAE,MAAM,EACZ,KAAK,EAAE,SAAS,MAAM,EAAE,EACxB,cAAc,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,MAAM,GAAG,SAAS,GACnD;IAAE,QAAQ,CAAC,MAAM,EAAE,gBAAgB,EAAE,CAAC;IAAC,QAAQ,CAAC,QAAQ,EAAE,kBAAkB,EAAE,CAAA;CAAE,CAqDlF;AAED,gGAAgG;AAChG,wBAAgB,sBAAsB,CACpC,MAAM,EAAE,MAAM,EACd,cAAc,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,MAAM,GAAG,SAAS,GACnD,OAAO,CAOT;AAED,wDAAwD;AACxD,MAAM,WAAW,gBAAgB;IAC/B,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAC;IAC7B,QAAQ,CAAC,KAAK,EAAE,SAAS,MAAM,EAAE,CAAC;IAClC,wDAAwD;IACxD,QAAQ,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;IAC/B,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;IAC3B,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAC;IAC7B,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;CACvB;AAED,8EAA8E;AAC9E,wBAAgB,iBAAiB,CAC/B,KAAK,EAAE,SAAS,MAAM,EAAE,EACxB,WAAW,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,MAAM,GAAG,SAAS,EACjD,cAAc,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,MAAM,GAAG,SAAS,GACnD,WAAW,CAAC,MAAM,CAAC,CAQrB;AAED,yGAAyG;AACzG,wBAAgB,kBAAkB,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,SAAS,MAAM,EAAE,GAAG,gBAAgB,EAAE,CAmB7F;AAED;;;;;;GAMG;AACH,wBAAgB,QAAQ,CAAC,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,MAAM,CAM7D"}