@ihelpee/prumo-plugin-python-fastapi 0.0.0-stage → 0.9.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +202 -0
- package/README.md +108 -2
- package/dist/ast.d.ts +84 -0
- package/dist/ast.d.ts.map +1 -0
- package/dist/ast.js +90 -0
- package/dist/index.d.ts +4 -0
- package/dist/index.d.ts.map +1 -0
- package/dist/index.js +3 -0
- package/dist/rules.d.ts +30 -0
- package/dist/rules.d.ts.map +1 -0
- package/dist/rules.js +426 -0
- package/package.json +35 -3
- package/python/ast_extractor.py +439 -0
package/LICENSE
ADDED
|
@@ -0,0 +1,202 @@
|
|
|
1
|
+
|
|
2
|
+
Apache License
|
|
3
|
+
Version 2.0, January 2004
|
|
4
|
+
http://www.apache.org/licenses/
|
|
5
|
+
|
|
6
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
7
|
+
|
|
8
|
+
1. Definitions.
|
|
9
|
+
|
|
10
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
11
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
12
|
+
|
|
13
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
14
|
+
the copyright owner that is granting the License.
|
|
15
|
+
|
|
16
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
17
|
+
other entities that control, are controlled by, or are under common
|
|
18
|
+
control with that entity. For the purposes of this definition,
|
|
19
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
20
|
+
direction or management of such entity, whether by contract or
|
|
21
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
22
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
23
|
+
|
|
24
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
25
|
+
exercising permissions granted by this License.
|
|
26
|
+
|
|
27
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
28
|
+
including but not limited to software source code, documentation
|
|
29
|
+
source, and configuration files.
|
|
30
|
+
|
|
31
|
+
"Object" form shall mean any form resulting from mechanical
|
|
32
|
+
transformation or translation of a Source form, including but
|
|
33
|
+
not limited to compiled object code, generated documentation,
|
|
34
|
+
and conversions to other media types.
|
|
35
|
+
|
|
36
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
37
|
+
Object form, made available under the License, as indicated by a
|
|
38
|
+
copyright notice that is included in or attached to the work
|
|
39
|
+
(an example is provided in the Appendix below).
|
|
40
|
+
|
|
41
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
42
|
+
form, that is based on (or derived from) the Work and for which the
|
|
43
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
44
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
45
|
+
of this License, Derivative Works shall not include works that remain
|
|
46
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
47
|
+
the Work and Derivative Works thereof.
|
|
48
|
+
|
|
49
|
+
"Contribution" shall mean any work of authorship, including
|
|
50
|
+
the original version of the Work and any modifications or additions
|
|
51
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
52
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
53
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
54
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
55
|
+
means any form of electronic, verbal, or written communication sent
|
|
56
|
+
to the Licensor or its representatives, including but not limited to
|
|
57
|
+
communication on electronic mailing lists, source code control systems,
|
|
58
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
59
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
60
|
+
excluding communication that is conspicuously marked or otherwise
|
|
61
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
62
|
+
|
|
63
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
64
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
65
|
+
subsequently incorporated within the Work.
|
|
66
|
+
|
|
67
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
68
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
69
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
70
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
71
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
72
|
+
Work and such Derivative Works in Source or Object form.
|
|
73
|
+
|
|
74
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
75
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
76
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
77
|
+
(except as stated in this section) patent license to make, have made,
|
|
78
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
79
|
+
where such license applies only to those patent claims licensable
|
|
80
|
+
by such Contributor that are necessarily infringed by their
|
|
81
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
82
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
83
|
+
institute patent litigation against any entity (including a
|
|
84
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
85
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
86
|
+
or contributory patent infringement, then any patent licenses
|
|
87
|
+
granted to You under this License for that Work shall terminate
|
|
88
|
+
as of the date such litigation is filed.
|
|
89
|
+
|
|
90
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
91
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
92
|
+
modifications, and in Source or Object form, provided that You
|
|
93
|
+
meet the following conditions:
|
|
94
|
+
|
|
95
|
+
(a) You must give any other recipients of the Work or
|
|
96
|
+
Derivative Works a copy of this License; and
|
|
97
|
+
|
|
98
|
+
(b) You must cause any modified files to carry prominent notices
|
|
99
|
+
stating that You changed the files; and
|
|
100
|
+
|
|
101
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
102
|
+
that You distribute, all copyright, patent, trademark, and
|
|
103
|
+
attribution notices from the Source form of the Work,
|
|
104
|
+
excluding those notices that do not pertain to any part of
|
|
105
|
+
the Derivative Works; and
|
|
106
|
+
|
|
107
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
108
|
+
distribution, then any Derivative Works that You distribute must
|
|
109
|
+
include a readable copy of the attribution notices contained
|
|
110
|
+
within such NOTICE file, excluding those notices that do not
|
|
111
|
+
pertain to any part of the Derivative Works, in at least one
|
|
112
|
+
of the following places: within a NOTICE text file distributed
|
|
113
|
+
as part of the Derivative Works; within the Source form or
|
|
114
|
+
documentation, if provided along with the Derivative Works; or,
|
|
115
|
+
within a display generated by the Derivative Works, if and
|
|
116
|
+
wherever such third-party notices normally appear. The contents
|
|
117
|
+
of the NOTICE file are for informational purposes only and
|
|
118
|
+
do not modify the License. You may add Your own attribution
|
|
119
|
+
notices within Derivative Works that You distribute, alongside
|
|
120
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
121
|
+
that such additional attribution notices cannot be construed
|
|
122
|
+
as modifying the License.
|
|
123
|
+
|
|
124
|
+
You may add Your own copyright statement to Your modifications and
|
|
125
|
+
may provide additional or different license terms and conditions
|
|
126
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
127
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
128
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
129
|
+
the conditions stated in this License.
|
|
130
|
+
|
|
131
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
132
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
133
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
134
|
+
this License, without any additional terms or conditions.
|
|
135
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
136
|
+
the terms of any separate license agreement you may have executed
|
|
137
|
+
with Licensor regarding such Contributions.
|
|
138
|
+
|
|
139
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
140
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
141
|
+
except as required for reasonable and customary use in describing the
|
|
142
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
143
|
+
|
|
144
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
145
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
146
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
147
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
148
|
+
implied, including, without limitation, any warranties or conditions
|
|
149
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
150
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
151
|
+
appropriateness of using or redistributing the Work and assume any
|
|
152
|
+
risks associated with Your exercise of permissions under this License.
|
|
153
|
+
|
|
154
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
155
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
156
|
+
unless required by applicable law (such as deliberate and grossly
|
|
157
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
158
|
+
liable to You for damages, including any direct, indirect, special,
|
|
159
|
+
incidental, or consequential damages of any character arising as a
|
|
160
|
+
result of this License or out of the use or inability to use the
|
|
161
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
162
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
163
|
+
other commercial damages or losses), even if such Contributor
|
|
164
|
+
has been advised of the possibility of such damages.
|
|
165
|
+
|
|
166
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
167
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
168
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
169
|
+
or other liability obligations and/or rights consistent with this
|
|
170
|
+
License. However, in accepting such obligations, You may act only
|
|
171
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
172
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
173
|
+
defend, and hold each Contributor harmless for any liability
|
|
174
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
175
|
+
of your accepting any such warranty or additional liability.
|
|
176
|
+
|
|
177
|
+
END OF TERMS AND CONDITIONS
|
|
178
|
+
|
|
179
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
180
|
+
|
|
181
|
+
To apply the Apache License to your work, attach the following
|
|
182
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
183
|
+
replaced with your own identifying information. (Don't include
|
|
184
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
185
|
+
comment syntax for the file format. We also recommend that a
|
|
186
|
+
file or class name and description of purpose be included on the
|
|
187
|
+
same "printed page" as the copyright notice for easier
|
|
188
|
+
identification within third-party archives.
|
|
189
|
+
|
|
190
|
+
Copyright [yyyy] [name of copyright owner]
|
|
191
|
+
|
|
192
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
193
|
+
you may not use this file except in compliance with the License.
|
|
194
|
+
You may obtain a copy of the License at
|
|
195
|
+
|
|
196
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
197
|
+
|
|
198
|
+
Unless required by applicable law or agreed to in writing, software
|
|
199
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
200
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
201
|
+
See the License for the specific language governing permissions and
|
|
202
|
+
limitations under the License.
|
package/README.md
CHANGED
|
@@ -1,3 +1,109 @@
|
|
|
1
|
-
#
|
|
1
|
+
# @ihelpee/prumo-plugin-python-fastapi
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
Python/FastAPI invariants for [Prumo](../../packages/prumo): auth guards on mutation routes, Pydantic v2 validation on request DTOs, and pytest oracle isolation — including against `importlib` bypass.
|
|
4
|
+
|
|
5
|
+
**The law lives in the Node core.** This package is an npm plugin (spec §4.2 — never a PyPI package): it embeds a single stdlib-only Python script (`python/ast_extractor.py`) that merely serializes the AST into canonical JSON v1 via an isolated subprocess. The parser decides nothing; "is this a violation?" is 100% the engine's job. The consumer app is never booted and none of the analyzed code is imported or executed.
|
|
6
|
+
|
|
7
|
+
## Installation
|
|
8
|
+
|
|
9
|
+
```bash
|
|
10
|
+
pnpm add -D @ihelpee/prumo-plugin-python-fastapi
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
Requires `python3 >= 3.9` on the gate host's PATH (not the deployment target). Without Python, the Python invariants become a no-op with an explicit reason in the report — never silent.
|
|
14
|
+
|
|
15
|
+
## Usage
|
|
16
|
+
|
|
17
|
+
```ts
|
|
18
|
+
// prumo.config.ts
|
|
19
|
+
import { defineConfig } from '@ihelpee/prumo';
|
|
20
|
+
import { pythonFastapi } from '@ihelpee/prumo-plugin-python-fastapi';
|
|
21
|
+
|
|
22
|
+
export default defineConfig({
|
|
23
|
+
layout: {
|
|
24
|
+
src: ['app'],
|
|
25
|
+
oracle: ['tests/oracle'],
|
|
26
|
+
contract: ['.prumo/contract'],
|
|
27
|
+
invariants: ['.prumo/invariants'],
|
|
28
|
+
intent: ['.prumo/intent'],
|
|
29
|
+
waivers: ['.prumo/waivers'],
|
|
30
|
+
},
|
|
31
|
+
testFilePatterns: ['tests/**/*.py'],
|
|
32
|
+
invariants: [pythonFastapi()],
|
|
33
|
+
});
|
|
34
|
+
```
|
|
35
|
+
|
|
36
|
+
> Register under `invariants:` — the `plugins:` field from the old docs is inert (spec §4.4).
|
|
37
|
+
|
|
38
|
+
Or via a rules file (where the waivers live):
|
|
39
|
+
|
|
40
|
+
```ts
|
|
41
|
+
// .prumo/invariants/rules.ts
|
|
42
|
+
import { pythonFastapiPreset } from '@ihelpee/prumo-plugin-python-fastapi';
|
|
43
|
+
export default pythonFastapiPreset;
|
|
44
|
+
```
|
|
45
|
+
|
|
46
|
+
## Options (`pythonFastapi(options?)`)
|
|
47
|
+
|
|
48
|
+
| Option | Default | Effect |
|
|
49
|
+
|---|---|---|
|
|
50
|
+
| `srcDirs` | `['app']` | Production directories (Python modules) |
|
|
51
|
+
| `oracleDirs` | `['tests/oracle']` | Directories where importing `app.*` is a mirror |
|
|
52
|
+
| `testRoots` | `['tests']` | Reverse boundary R2.7 (production must not import fixtures) |
|
|
53
|
+
| `packageRoot` | `'app'` | Root package used to resolve relative imports |
|
|
54
|
+
| `entrypoints` | `['app.main']` | Composition roots the oracle may use (black-box via ASGI) |
|
|
55
|
+
| `authSymbols` | `get_current_user`, `current_user`, `get_current_active_user`, `require_auth`, `auth_required` | Symbols recognized as an auth guard in `Depends(...)` |
|
|
56
|
+
| `publicSymbols` | `[]` | Convention for intentionally public routes (FastAPI has no native `@Public`) |
|
|
57
|
+
|
|
58
|
+
## Invariants
|
|
59
|
+
|
|
60
|
+
| Rule | Sev | Catches | Does not catch |
|
|
61
|
+
|---|---|---|---|
|
|
62
|
+
| `mutation-routes-guarded` | error | `POST/PUT/PATCH/DELETE` without an auth `Depends` on the handler, without `dependencies=` on the decorator, and without `APIRouter(dependencies=)`/`include_router(dependencies=)` (including cross-file) | read routes; routes marked via `publicSymbols` |
|
|
63
|
+
| `dto-has-validation` | error | a Pydantic model used as **body** with a field lacking `Field(...)`/`Annotated`/`con*`/`EmailStr`/validator | `response_model` (output does not validate input); `Optional` without default (legitimate optional); `pydantic.v1` files (handled by the sibling rule below) |
|
|
64
|
+
| `dto-has-validation-pydantic-v1` | warn | same predicate as `dto-has-validation` for files containing `import pydantic.v1` (R3.6: v1 is deprecated — downgraded to warn) | models in v2 files; fields with `@validator`/`Field(regex=...)` v1 (recognized constraint) |
|
|
65
|
+
| `route-has-response-model` | warn | mutation without `response_model` (risk of leaking raw ORM/dict) | read routes |
|
|
66
|
+
| `no-cross-feature-import` | warn | `app/<A>/` importing `app/<B>/` (absolute, relative, and dynamic) | entrypoint/composition root; shared modules (`common`, `core`, `auth`, …) |
|
|
67
|
+
| `monetary-is-integer` | warn | monetary field (`price`, `amount`, …) typed as `float` | `Decimal`, integer in cents |
|
|
68
|
+
| `oracle-no-src` | error | `tests/oracle/**` importing a unit from `app/` — **including** `importlib.import_module`/`__import__` (anti-bypass R2.4) | importing the entrypoint (`app.main`): a black-box oracle boots the app through the composition root |
|
|
69
|
+
| `src-no-oracle` | error | `app/**` importing `tests/**` (fixtures leaking into production) | — |
|
|
70
|
+
| `python-parse-error` | error | `SyntaxError` per file; parser timeout; missing `python3` (via `erroredRules`, the gate does not crash) | — |
|
|
71
|
+
|
|
72
|
+
## Example — FastAPI's invisible hole
|
|
73
|
+
|
|
74
|
+
```python
|
|
75
|
+
# app/orders/router.py — a rota FUNCIONA sem token; o teste com AsyncClient
|
|
76
|
+
# sem auth passa se o handler não usar `user`. O agente nunca vê o buraco.
|
|
77
|
+
@router.post("/orders")
|
|
78
|
+
async def create_order(payload: CreateOrderIn): # ← finding: sem Depends de auth
|
|
79
|
+
...
|
|
80
|
+
|
|
81
|
+
# Protegido nas três camadas aceitas:
|
|
82
|
+
@router.post("/orders", dependencies=[Depends(get_current_user)]) # decorator
|
|
83
|
+
async def a(...): ...
|
|
84
|
+
|
|
85
|
+
router = APIRouter(dependencies=[Depends(get_current_user)]) # router
|
|
86
|
+
app.include_router(billing_router, dependencies=[Depends(get_current_user)]) # montagem (cross-file)
|
|
87
|
+
```
|
|
88
|
+
|
|
89
|
+
```python
|
|
90
|
+
# DTO sem constraint: aceita user_id=-999 e o teste que só checa 200 é o espelho perfeito.
|
|
91
|
+
class CreateOrderIn(BaseModel):
|
|
92
|
+
user_id: int # ← finding
|
|
93
|
+
email: Annotated[str, Field(max_length=255)] # ok
|
|
94
|
+
```
|
|
95
|
+
|
|
96
|
+
## AST contract (canonical JSON v1)
|
|
97
|
+
|
|
98
|
+
`python/ast_extractor.py --files <...>` emits `{"version": 1, "files": [...]}` with per-file `imports`, `dynamic_imports`, `routes`, `models`, `routers`, `include_routers`, `pydantic_v1` (spec §1.4). The format is frozen and versioned; `SyntaxError` becomes `{"path", "error": "syntax"}` with exit 0.
|
|
99
|
+
|
|
100
|
+
---
|
|
101
|
+
|
|
102
|
+
## License & Brand
|
|
103
|
+
|
|
104
|
+
Copyright © 2026 **IHELPEE TECNOLOGIA LTDA** (<https://ihelpee.com>). All rights reserved.
|
|
105
|
+
Created and authored by [Alex Gotardi](https://github.com/alexgotardi).
|
|
106
|
+
|
|
107
|
+
Licensed under the [Apache License, Version 2.0](https://github.com/ihelpee/prumo/blob/main/LICENSE) (the "License"); you may not use this file except in compliance with the License. A copy is available at <http://www.apache.org/licenses/LICENSE-2.0>.
|
|
108
|
+
|
|
109
|
+
The **"Prumo"** name and logo are trademarks of IHELPEE TECNOLOGIA LTDA and are **not** licensed under the Apache 2.0 license.
|
package/dist/ast.d.ts
ADDED
|
@@ -0,0 +1,84 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* AST Extractor Python — ponte Node → subprocesso stdlib.
|
|
3
|
+
*
|
|
4
|
+
* Spec `docs/especificacao-prumo-python.md` §1: o motor Node NÃO parseia
|
|
5
|
+
* Python; um subprocesso isolado (`python3 python/ast_extractor.py`) faz
|
|
6
|
+
* `ast.parse` e emite o JSON canônico v1. O subprocesso é o isolador: recebe
|
|
7
|
+
* caminhos, nunca importa o código do usuário, o app nunca dá boot. A lei
|
|
8
|
+
* ("é violação?") fica 100% no core Node — o Python é só parser.
|
|
9
|
+
*/
|
|
10
|
+
export declare const EXTRACTOR_VERSION = 1;
|
|
11
|
+
/** R1.5 — parse patológico não trava o gate. */
|
|
12
|
+
export declare const DEFAULT_TIMEOUT_MS = 15000;
|
|
13
|
+
export interface PyImport {
|
|
14
|
+
module: string;
|
|
15
|
+
names: string[];
|
|
16
|
+
relative: boolean;
|
|
17
|
+
line: number;
|
|
18
|
+
}
|
|
19
|
+
export interface PyDynamicImport {
|
|
20
|
+
expr: string;
|
|
21
|
+
module: string;
|
|
22
|
+
line: number;
|
|
23
|
+
}
|
|
24
|
+
export interface PyRoute {
|
|
25
|
+
method: string;
|
|
26
|
+
path: string;
|
|
27
|
+
handler: string;
|
|
28
|
+
decorators: string[];
|
|
29
|
+
router_var: string;
|
|
30
|
+
router_dependencies: string[];
|
|
31
|
+
param_depends: string[];
|
|
32
|
+
body_model: string | null;
|
|
33
|
+
response_model: string | null;
|
|
34
|
+
line: number;
|
|
35
|
+
}
|
|
36
|
+
export interface PyField {
|
|
37
|
+
name: string;
|
|
38
|
+
annotation: string;
|
|
39
|
+
has_constraint: boolean;
|
|
40
|
+
has_validator: boolean;
|
|
41
|
+
}
|
|
42
|
+
export interface PyModel {
|
|
43
|
+
name: string;
|
|
44
|
+
bases: string[];
|
|
45
|
+
line: number;
|
|
46
|
+
fields: PyField[];
|
|
47
|
+
}
|
|
48
|
+
export interface PyRouterDef {
|
|
49
|
+
var: string;
|
|
50
|
+
dependencies: string[];
|
|
51
|
+
}
|
|
52
|
+
export interface PyIncludeRouter {
|
|
53
|
+
target: string;
|
|
54
|
+
dependencies: string[];
|
|
55
|
+
}
|
|
56
|
+
export interface PyFile {
|
|
57
|
+
path: string;
|
|
58
|
+
error?: 'syntax' | 'unreadable';
|
|
59
|
+
imports?: PyImport[];
|
|
60
|
+
dynamic_imports?: PyDynamicImport[];
|
|
61
|
+
routes?: PyRoute[];
|
|
62
|
+
models?: PyModel[];
|
|
63
|
+
routers?: PyRouterDef[];
|
|
64
|
+
include_routers?: PyIncludeRouter[];
|
|
65
|
+
pydantic_v1?: boolean;
|
|
66
|
+
}
|
|
67
|
+
export interface PythonModel {
|
|
68
|
+
version: number;
|
|
69
|
+
files: PyFile[];
|
|
70
|
+
/** R1.4 — python3 ausente: rules retornam vazio, gate não crasha. */
|
|
71
|
+
pythonAvailable: boolean;
|
|
72
|
+
/** R1.5 — subprocesso morto por timeout. */
|
|
73
|
+
timedOut: boolean;
|
|
74
|
+
/** Diagnóstico legível quando pythonAvailable === false. */
|
|
75
|
+
reason?: string;
|
|
76
|
+
}
|
|
77
|
+
export declare const EMPTY_MODEL: PythonModel;
|
|
78
|
+
/**
|
|
79
|
+
* Coleta os `.py` do projeto (determinístico, ordenado — walk do core) e
|
|
80
|
+
* roda o extrator em lotes. `python3` ausente → modelo vazio com motivo
|
|
81
|
+
* explícito (R1.4); timeout → `timedOut: true` (R1.5).
|
|
82
|
+
*/
|
|
83
|
+
export declare function extractPythonModel(root: string, timeoutMs?: number): Promise<PythonModel>;
|
|
84
|
+
//# sourceMappingURL=ast.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"ast.d.ts","sourceRoot":"","sources":["../src/ast.ts"],"names":[],"mappings":"AAIA;;;;;;;;GAQG;AAEH,eAAO,MAAM,iBAAiB,IAAI,CAAC;AAEnC,gDAAgD;AAChD,eAAO,MAAM,kBAAkB,QAAS,CAAC;AAKzC,MAAM,WAAW,QAAQ;IACvB,MAAM,EAAE,MAAM,CAAC;IACf,KAAK,EAAE,MAAM,EAAE,CAAC;IAChB,QAAQ,EAAE,OAAO,CAAC;IAClB,IAAI,EAAE,MAAM,CAAC;CACd;AAED,MAAM,WAAW,eAAe;IAC9B,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,MAAM,CAAC;CACd;AAED,MAAM,WAAW,OAAO;IACtB,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,MAAM,CAAC;IAChB,UAAU,EAAE,MAAM,EAAE,CAAC;IACrB,UAAU,EAAE,MAAM,CAAC;IACnB,mBAAmB,EAAE,MAAM,EAAE,CAAC;IAC9B,aAAa,EAAE,MAAM,EAAE,CAAC;IACxB,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAC1B,cAAc,EAAE,MAAM,GAAG,IAAI,CAAC;IAC9B,IAAI,EAAE,MAAM,CAAC;CACd;AAED,MAAM,WAAW,OAAO;IACtB,IAAI,EAAE,MAAM,CAAC;IACb,UAAU,EAAE,MAAM,CAAC;IACnB,cAAc,EAAE,OAAO,CAAC;IACxB,aAAa,EAAE,OAAO,CAAC;CACxB;AAED,MAAM,WAAW,OAAO;IACtB,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,EAAE,CAAC;IAChB,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,OAAO,EAAE,CAAC;CACnB;AAED,MAAM,WAAW,WAAW;IAC1B,GAAG,EAAE,MAAM,CAAC;IACZ,YAAY,EAAE,MAAM,EAAE,CAAC;CACxB;AAED,MAAM,WAAW,eAAe;IAC9B,MAAM,EAAE,MAAM,CAAC;IACf,YAAY,EAAE,MAAM,EAAE,CAAC;CACxB;AAED,MAAM,WAAW,MAAM;IACrB,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,CAAC,EAAE,QAAQ,GAAG,YAAY,CAAC;IAChC,OAAO,CAAC,EAAE,QAAQ,EAAE,CAAC;IACrB,eAAe,CAAC,EAAE,eAAe,EAAE,CAAC;IACpC,MAAM,CAAC,EAAE,OAAO,EAAE,CAAC;IACnB,MAAM,CAAC,EAAE,OAAO,EAAE,CAAC;IACnB,OAAO,CAAC,EAAE,WAAW,EAAE,CAAC;IACxB,eAAe,CAAC,EAAE,eAAe,EAAE,CAAC;IACpC,WAAW,CAAC,EAAE,OAAO,CAAC;CACvB;AAED,MAAM,WAAW,WAAW;IAC1B,OAAO,EAAE,MAAM,CAAC;IAChB,KAAK,EAAE,MAAM,EAAE,CAAC;IAChB,qEAAqE;IACrE,eAAe,EAAE,OAAO,CAAC;IACzB,4CAA4C;IAC5C,QAAQ,EAAE,OAAO,CAAC;IAClB,4DAA4D;IAC5D,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,eAAO,MAAM,WAAW,EAAE,WAKzB,CAAC;AAsCF;;;;GAIG;AACH,wBAAsB,kBAAkB,CAAC,IAAI,EAAE,MAAM,EAAE,SAAS,SAAqB,GAAG,OAAO,CAAC,WAAW,CAAC,CAiC3G"}
|
package/dist/ast.js
ADDED
|
@@ -0,0 +1,90 @@
|
|
|
1
|
+
import { spawnSync } from 'node:child_process';
|
|
2
|
+
import { fileURLToPath } from 'node:url';
|
|
3
|
+
import { walk } from '@ihelpee/prumo/core';
|
|
4
|
+
/**
|
|
5
|
+
* AST Extractor Python — ponte Node → subprocesso stdlib.
|
|
6
|
+
*
|
|
7
|
+
* Spec `docs/especificacao-prumo-python.md` §1: o motor Node NÃO parseia
|
|
8
|
+
* Python; um subprocesso isolado (`python3 python/ast_extractor.py`) faz
|
|
9
|
+
* `ast.parse` e emite o JSON canônico v1. O subprocesso é o isolador: recebe
|
|
10
|
+
* caminhos, nunca importa o código do usuário, o app nunca dá boot. A lei
|
|
11
|
+
* ("é violação?") fica 100% no core Node — o Python é só parser.
|
|
12
|
+
*/
|
|
13
|
+
export const EXTRACTOR_VERSION = 1;
|
|
14
|
+
/** R1.5 — parse patológico não trava o gate. */
|
|
15
|
+
export const DEFAULT_TIMEOUT_MS = 15_000;
|
|
16
|
+
/** Limite conservador de argv por lote (Windows ~32k; 200 arquivos é folgado). */
|
|
17
|
+
const BATCH_SIZE = 200;
|
|
18
|
+
export const EMPTY_MODEL = {
|
|
19
|
+
version: EXTRACTOR_VERSION,
|
|
20
|
+
files: [],
|
|
21
|
+
pythonAvailable: false,
|
|
22
|
+
timedOut: false,
|
|
23
|
+
};
|
|
24
|
+
function extractorScript() {
|
|
25
|
+
// dist/ast.js e src/ast.ts estão ambos a um nível do package; python/ é
|
|
26
|
+
// irmão de src/ e entra no `files` do package.json (requisito de release).
|
|
27
|
+
return fileURLToPath(new URL('../python/ast_extractor.py', import.meta.url));
|
|
28
|
+
}
|
|
29
|
+
function runBatch(root, files, timeoutMs) {
|
|
30
|
+
const script = extractorScript();
|
|
31
|
+
const res = spawnSync('python3', [script, '--files', ...files], {
|
|
32
|
+
cwd: root,
|
|
33
|
+
timeout: timeoutMs,
|
|
34
|
+
encoding: 'utf8',
|
|
35
|
+
maxBuffer: 64 * 1024 * 1024,
|
|
36
|
+
});
|
|
37
|
+
if (res.error) {
|
|
38
|
+
const code = res.error.code;
|
|
39
|
+
return { ok: false, timedOut: false, missing: code === 'ENOENT', result: null, stderr: String(res.error.message ?? res.error) };
|
|
40
|
+
}
|
|
41
|
+
if (res.signal === 'SIGTERM' || res.killed) {
|
|
42
|
+
return { ok: false, timedOut: true, missing: false, result: null, stderr: '' };
|
|
43
|
+
}
|
|
44
|
+
if (res.status !== 0) {
|
|
45
|
+
return { ok: false, timedOut: false, missing: false, result: null, stderr: (res.stderr ?? '').trim() };
|
|
46
|
+
}
|
|
47
|
+
try {
|
|
48
|
+
return { ok: true, timedOut: false, missing: false, result: JSON.parse(res.stdout), stderr: '' };
|
|
49
|
+
}
|
|
50
|
+
catch (err) {
|
|
51
|
+
return { ok: false, timedOut: false, missing: false, result: null, stderr: `stdout não é JSON: ${String(err)}` };
|
|
52
|
+
}
|
|
53
|
+
}
|
|
54
|
+
/**
|
|
55
|
+
* Coleta os `.py` do projeto (determinístico, ordenado — walk do core) e
|
|
56
|
+
* roda o extrator em lotes. `python3` ausente → modelo vazio com motivo
|
|
57
|
+
* explícito (R1.4); timeout → `timedOut: true` (R1.5).
|
|
58
|
+
*/
|
|
59
|
+
export async function extractPythonModel(root, timeoutMs = DEFAULT_TIMEOUT_MS) {
|
|
60
|
+
const pyFiles = await walk(root, '.', { extensions: ['.py'] });
|
|
61
|
+
if (pyFiles.length === 0) {
|
|
62
|
+
return { ...EMPTY_MODEL, pythonAvailable: true };
|
|
63
|
+
}
|
|
64
|
+
const files = [];
|
|
65
|
+
let timedOut = false;
|
|
66
|
+
for (let i = 0; i < pyFiles.length; i += BATCH_SIZE) {
|
|
67
|
+
const batch = pyFiles.slice(i, i + BATCH_SIZE);
|
|
68
|
+
const run = runBatch(root, batch, timeoutMs);
|
|
69
|
+
if (run.missing) {
|
|
70
|
+
return {
|
|
71
|
+
...EMPTY_MODEL,
|
|
72
|
+
pythonAvailable: false,
|
|
73
|
+
reason: 'python3 não encontrado no PATH — invariantes Python viram no-op (instale Python >= 3.9)',
|
|
74
|
+
};
|
|
75
|
+
}
|
|
76
|
+
if (run.timedOut) {
|
|
77
|
+
timedOut = true;
|
|
78
|
+
continue;
|
|
79
|
+
}
|
|
80
|
+
if (!run.ok || !run.result) {
|
|
81
|
+
return {
|
|
82
|
+
...EMPTY_MODEL,
|
|
83
|
+
pythonAvailable: false,
|
|
84
|
+
reason: `ast_extractor.py falhou: ${run.stderr || 'erro desconhecido'}`,
|
|
85
|
+
};
|
|
86
|
+
}
|
|
87
|
+
files.push(...(run.result.files ?? []));
|
|
88
|
+
}
|
|
89
|
+
return { version: EXTRACTOR_VERSION, files, pythonAvailable: true, timedOut };
|
|
90
|
+
}
|
package/dist/index.d.ts
ADDED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,UAAU,CAAC;AACzB,cAAc,YAAY,CAAC;AAC3B,OAAO,EAAE,aAAa,IAAI,OAAO,EAAE,MAAM,YAAY,CAAC"}
|
package/dist/index.js
ADDED
package/dist/rules.d.ts
ADDED
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
import { type PrumoPlugin, type RuleDef } from '@ihelpee/prumo/invariants';
|
|
2
|
+
export interface PythonPluginOptions {
|
|
3
|
+
/** Diretórios de produção (módulos Python). Default: ['app']. */
|
|
4
|
+
srcDirs?: string[];
|
|
5
|
+
/** Diretórios de oráculo (espelhos proibidos). Default: ['tests/oracle']. */
|
|
6
|
+
oracleDirs?: string[];
|
|
7
|
+
/** Prefixo de teste p/ fronteira reversa R2.7. Default: ['tests']. */
|
|
8
|
+
testRoots?: string[];
|
|
9
|
+
/** Pacote raiz p/ imports relativos (R2.3). Default: 'app'. */
|
|
10
|
+
packageRoot?: string;
|
|
11
|
+
/** Entrypoints públicos permitidos ao oráculo (composition root, §2 nota). Default: ['app.main']. */
|
|
12
|
+
entrypoints?: string[];
|
|
13
|
+
/** R3.1 — símbolos de auth reconhecidos em Depends(...). */
|
|
14
|
+
authSymbols?: string[];
|
|
15
|
+
/** R3.4 — convenção de rota intencionalmente pública. Default: []. */
|
|
16
|
+
publicSymbols?: string[];
|
|
17
|
+
}
|
|
18
|
+
/**
|
|
19
|
+
* O Plugin oficial Python/FastAPI para o Prumo (spec §4.2: plugin npm,
|
|
20
|
+
* NUNCA pacote PyPI — a lei mora no core Node; o `.py` embutido é parser).
|
|
21
|
+
*
|
|
22
|
+
* Uso (spec §4.4 — `invariants:`, não o campo inerte `plugins:`):
|
|
23
|
+
*
|
|
24
|
+
* import { pythonFastapi } from '@ihelpee/prumo-plugin-python-fastapi';
|
|
25
|
+
* export default defineConfig({ invariants: [ pythonFastapi() ], ... });
|
|
26
|
+
*/
|
|
27
|
+
export declare function pythonFastapi(options?: PythonPluginOptions): PrumoPlugin;
|
|
28
|
+
/** Preset com defaults FastAPI canônicos (`app/`, `tests/oracle/`, entrypoint `app.main`). */
|
|
29
|
+
export declare const pythonFastapiPreset: RuleDef[];
|
|
30
|
+
//# sourceMappingURL=rules.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"rules.d.ts","sourceRoot":"","sources":["../src/rules.ts"],"names":[],"mappings":"AACA,OAAO,EAGL,KAAK,WAAW,EAChB,KAAK,OAAO,EAGb,MAAM,2BAA2B,CAAC;AAanC,MAAM,WAAW,mBAAmB;IAClC,iEAAiE;IACjE,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;IACnB,6EAA6E;IAC7E,UAAU,CAAC,EAAE,MAAM,EAAE,CAAC;IACtB,sEAAsE;IACtE,SAAS,CAAC,EAAE,MAAM,EAAE,CAAC;IACrB,+DAA+D;IAC/D,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,qGAAqG;IACrG,WAAW,CAAC,EAAE,MAAM,EAAE,CAAC;IACvB,4DAA4D;IAC5D,WAAW,CAAC,EAAE,MAAM,EAAE,CAAC;IACvB,sEAAsE;IACtE,aAAa,CAAC,EAAE,MAAM,EAAE,CAAC;CAC1B;AAwXD;;;;;;;;GAQG;AACH,wBAAgB,aAAa,CAAC,OAAO,GAAE,mBAAwB,GAAG,WAAW,CA6B5E;AAED,8FAA8F;AAC9F,eAAO,MAAM,mBAAmB,EAAE,OAAO,EAA0B,CAAC"}
|