Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
- Notifications
You must be signed in to change notification settings - Fork 5
Expand file tree
/
Copy pathpython-tools-documentation.html
More file actions
Latest commit
316 lines (299 loc) · 13.3 KB
/
Copy pathpython-tools-documentation.html
File metadata and controls
316 lines (299 loc) · 13.3 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
<!DOCTYPE html>
<htmllang="en">
<head>
<metacharset="UTF-8">
<metaname="viewport" content="width=device-width, initial-scale=1.0">
<title>Python Tools Plugin Documentation</title>
<style>
:root {
--bg:#fdfdfd;
--fg:#1a1a1a;
--accent:#0f766e;
--accent-light:#e6f5f3;
--border:#d0d7de;
--code-bg:#f4f6f8;
--table-stripe:#f8fafb;
--shadow:rgba(0,0,0,0.06);
}
* { margin:0; padding:0; box-sizing: border-box; }
body {
font-family: -apple-system, BlinkMacSystemFont,"Segoe UI", Roboto, Helvetica, Arial, sans-serif;
color:var(--fg);
background:var(--bg);
line-height:1.6;
max-width:52rem;
margin:0 auto;
padding:2rem1.5rem4rem;
}
header { border-bottom:3px solid var(--accent); padding-bottom:1.2rem; margin-bottom:2rem; }
headerh1 { font-size:2rem; color:var(--accent); }
headerp.subtitle { color:#555; margin-top:0.3rem; }
header .meta { font-size:0.85rem; color:#777; margin-top:0.5rem; }
nav { background:var(--accent-light); border:1px solid var(--border); border-radius:6px; padding:1rem1.5rem; margin-bottom:2.5rem; }
navh2 { font-size:0.95rem; text-transform: uppercase; letter-spacing:0.05em; color:var(--accent); margin-bottom:0.5rem; }
navol { padding-left:1.3rem; }
navli { margin:0.25rem0; }
nava { color:var(--accent); text-decoration: none; }
nava:hover { text-decoration: underline; }
section { margin-bottom:2.5rem; }
h2 { font-size:1.4rem; color:var(--accent); border-bottom:1px solid var(--border); padding-bottom:0.3rem; margin-bottom:1rem; }
h3 { font-size:1.1rem; margin:1.2rem00.5rem; }
p,li { margin-bottom:0.5rem; }
ul,ol { padding-left:1.4rem; }
code {
font-family:"SFMono-Regular", Consolas,"Liberation Mono", Menlo, monospace;
background:var(--code-bg);
padding:0.15em0.35em;
border-radius:3px;
font-size:0.9em;
}
pre {
background:var(--code-bg);
border:1px solid var(--border);
border-radius:6px;
padding:1rem1.2rem;
overflow-x: auto;
font-size:0.88rem;
line-height:1.5;
margin:0.8rem01rem;
}
precode { background: none; padding:0; }
table { width:100%; border-collapse: collapse; margin:0.8rem01rem; font-size:0.95rem; }
th,td { text-align: left; padding:0.55rem0.8rem; border:1px solid var(--border); }
th { background:var(--accent-light); font-weight:600; }
tr:nth-child(even) td { background:var(--table-stripe); }
.diagram {
background:var(--code-bg);
border:1px solid var(--border);
border-radius:6px;
padding:1.2rem;
font-family:"SFMono-Regular", Consolas, monospace;
font-size:0.85rem;
line-height:1.55;
overflow-x: auto;
white-space: pre;
margin:0.8rem01rem;
}
.callout {
background:var(--accent-light);
border-left:4px solid var(--accent);
padding:0.8rem1rem;
border-radius:06px6px0;
margin:1rem0;
}
.file-tree { list-style: none; padding-left:0; font-family: monospace; font-size:0.9rem; }
.file-treeul { list-style: none; padding-left:1.5rem; }
footer { margin-top:3rem; padding-top:1rem; border-top:1px solid var(--border); font-size:0.85rem; color:#777; }
</style>
</head>
<body>
<header>
<h1>Python Tools</h1>
<pclass="subtitle">Python and Flask project templates with a native run experience for Code on the Go</p>
<divclass="meta">Version 1.0.0 · Author: App Dev For All · Package: <code>com.appdevforall.python.plugin</code></div>
</header>
<nav>
<h2>Contents</h2>
<ol>
<li><ahref="#overview">Executive Overview</a></li>
<li><ahref="#functionality">Core Functionality</a></li>
<li><ahref="#architecture">Technical Architecture</a></li>
<li><ahref="#integration">Integration Points</a></li>
<li><ahref="#deployment">Deployment & Usage</a></li>
<li><ahref="#benefits">Key Benefits</a></li>
</ol>
</nav>
<!-- ================================================================ -->
<sectionid="overview">
<h2>1. Executive Overview</h2>
<p>
Python Tools is a Code on the Go plugin that adds two new project types,
a <strong>Flask web app</strong> and a minimal <strong>Python starter</strong>,
and makes them runnable on the device. It is a reference example of how a
plugin adds a language and its project templates.
</p>
<p>
When the open project belongs to the Python domain, the plugin hides the
built-in Gradle build actions and contributes Python-native ones in their
place: <em>Run app</em>, <em>Run current file</em>,
<em>Install requirements</em>, and <em>Run tests</em>. Projects that are
not Python (anything carrying a Gradle build file) are left untouched.
</p>
<p>
On activation the plugin also ensures a Python interpreter is available.
If <code>python</code> is not on the path, it installs one, so a fresh
device can create and run a Python project with no manual setup.
</p>
<divclass="callout">
Only light testing has been done; use at your own risk. Customer support
cannot provide help with this plugin.
</div>
</section>
<!-- ================================================================ -->
<sectionid="functionality">
<h2>2. Core Functionality</h2>
<h3>Project templates</h3>
<p>
The plugin registers two templates with the host's template service.
Both render from <code>.peb</code> (Pebble) assets bundled in the
<code>.cgp</code>:
</p>
<ul>
<li><strong>Python Flask App:</strong> a Flask web app with routes, HTML
templates, static files, a configurable port, and basic error handling
(<code>app.py</code>, <code>config.py</code>, <code>templates/</code>,
<code>static/</code>, <code>requirements.txt</code>).</li>
<li><strong>Python Starter:</strong> a minimal project with a single
<code>main.py</code> entry point and a <code>requirements.txt</code>.</li>
</ul>
<h3>Python-native build actions</h3>
<p>
While a Python project is open, the plugin contributes the following
actions. The most-used action leads, so it takes the prime slot:
</p>
<table>
<thead><tr><th>Action</th><th>Runs</th><th>When</th></tr></thead>
<tbody>
<tr><td>Run app</td><td>The project entry point (<code>app.py</code> → <code>main.py</code> → <code>manage.py</code> → <code>__main__.py</code> → <code>wsgi.py</code>)</td><td>Always</td></tr>
<tr><td>Run current file</td><td><code>python <focused file></code></td><td>When a <code>.py</code> file is focused</td></tr>
<tr><td>Install requirements</td><td><code>pip install -r requirements.txt</code></td><td>Always</td></tr>
<tr><td>Run tests</td><td><code>pytest</code> (installed on demand)</td><td>Always</td></tr>
</tbody>
</table>
<h3>Quality-of-life behaviour</h3>
<ul>
<li><strong>Live output.</strong> Commands run with
<code>PYTHONUNBUFFERED=1</code>, so app output and pip progress stream
into the build panel instead of appearing only at exit.</li>
<li><strong>Auto-install on a missing import.</strong> If a run fails with
<code>ModuleNotFoundError</code> or <code>ImportError</code>, the plugin
notifies the user and runs <code>pip install -r requirements.txt</code>.</li>
<li><strong>Clean cancel.</strong> Cancelling a run stops the whole
process tree, including a Flask reloader child, so the server releases
its port.</li>
</ul>
</section>
<!-- ================================================================ -->
<sectionid="architecture">
<h2>3. Technical Architecture</h2>
<p>
The plugin is two Kotlin files plus its assets. It implements
<code>IPlugin</code> for lifecycle and <code>BuildActionExtension</code>
for the build actions, and reaches the host through services it looks up
at <code>initialize()</code>.
</p>
<ulclass="file-tree">
<li>python-tools/
<ul>
<li>src/main/kotlin/…/plugin/
<ul>
<li>PythonToolsPlugin.kt (templates, build actions, interpreter bootstrap)</li>
<li>PythonDomain.kt (Python-project detection)</li>
</ul>
</li>
<li>src/main/assets/templates/ (flask/ and starter/ <code>.peb</code> sources)</li>
<li>src/main/res/drawable/ (build-action icons)</li>
</ul>
</li>
</ul>
<h3>Domain gating</h3>
<p>
<code>PythonDomain</code> decides whether a directory is a Python project.
A Gradle marker disqualifies it, so a stray script inside a Java or Kotlin
project never steals the Gradle build actions:
</p>
<pre><code>private fun detect(root: File): Boolean {
if (GRADLE_MARKERS.any { File(root, it).exists() }) return false
if (File(root, "requirements.txt").exists()) return true
if (File(root, "pyproject.toml").exists()) return true
return root.listFiles { f -> f.isFile && f.name.endsWith(".py") }
?.isNotEmpty() == true
}</code></pre>
<p>
Both <code>toolbarActionsToHide()</code> and <code>getBuildActions()</code>
gate on this check, returning an empty set or list for non-Python projects.
</p>
<h3>Hiding the Gradle actions</h3>
<p>
The host allows only a fixed set of build actions to be hidden. The plugin
requests that set when a Python project is open:
</p>
<pre><code>override fun toolbarActionsToHide(): Set<String> =
if (isPythonProjectOpen()) ToolbarActionIds.BUILD_HIDEABLE else emptySet()</code></pre>
<h3>Process lifecycle</h3>
<p>
Commands are shell commands (<code>sh -c</code>) run through
<code>IdeCommandService</code>. The entry point is launched with
<code>exec</code>, so the Python process, not a wrapper shell, is the one
the host tracks. To make cancel tear down a Flask reloader's worker child,
the plugin ships a small <code>sitecustomize.py</code> on
<code>PYTHONPATH</code> that sets the kernel parent-death signal:
</p>
<pre><code># sitecustomize.py (installed into the plugin dir, added to PYTHONPATH)
import ctypes, signal
ctypes.CDLL("libc.so").prctl(1, signal.SIGKILL) # PR_SET_PDEATHSIG</code></pre>
<p>
When the host kills the tracked process, the kernel kills its children too,
freeing the server's port.
</p>
</section>
<!-- ================================================================ -->
<sectionid="integration">
<h2>4. Integration Points</h2>
<p>
Every host touch-point is an interface from <code>plugin-api.jar</code>.
The plugin declares the permissions
<code>filesystem.read</code>, <code>filesystem.write</code>,
<code>system.commands</code>, and <code>project.structure</code>.
</p>
<table>
<thead><tr><th>Extension / Service</th><th>Used for</th></tr></thead>
<tbody>
<tr><td><code>IPlugin</code></td><td>Lifecycle: <code>initialize</code>, <code>activate</code>, <code>deactivate</code>, <code>dispose</code>.</td></tr>
<tr><td><code>BuildActionExtension</code></td><td>Contribute build actions and hide the Gradle ones; receive start and complete callbacks.</td></tr>
<tr><td><code>IdeTemplateService</code></td><td>Build and register the Flask and Starter templates from assets.</td></tr>
<tr><td><code>IdeProjectService</code></td><td>Resolve the open project's root for domain detection.</td></tr>
<tr><td><code>IdeEditorService</code></td><td>Read the focused file for <em>Run current file</em>.</td></tr>
<tr><td><code>IdeCommandService</code></td><td>Run shell commands (run, pip, pytest, interpreter install).</td></tr>
<tr><td><code>IdeUIService</code></td><td>Surface notices (install prompts, run failures, stop notices).</td></tr>
</tbody>
</table>
</section>
<!-- ================================================================ -->
<sectionid="deployment">
<h2>5. Deployment & Usage</h2>
<p>Build the installable plugin from the plugin folder:</p>
<pre><code>cd python-tools
./gradlew assemblePlugin</code></pre>
<p>
The resulting <code>.cgp</code> lands under <code>build/plugin/</code>.
Install it from inside Code on the Go via the Plugin Manager. Then:
</p>
<ol>
<li>Create a project from <strong>Python Flask App</strong> or
<strong>Python Starter</strong> in the new-project picker.</li>
<li>Open it. The toolbar swaps to the Python build actions.</li>
<li>Tap <strong>Run app</strong>. On first run the plugin installs Python
if needed, then starts the app; output streams into the build panel.</li>
</ol>
</section>
<!-- ================================================================ -->
<sectionid="benefits">
<h2>6. Key Benefits</h2>
<ul>
<li><strong>Adds a language end to end.</strong> Covers the full path from
project templates, through a domain check, to a language-native set of
build actions.</li>
<li><strong>Domain-safe gating.</strong> A reusable pattern for acting only
on the plugin's own project type and leaving other projects untouched.</li>
<li><strong>On-device interpreter setup.</strong> Installs the runtime when
it is missing, so the feature works on a fresh device.</li>
<li><strong>Reliable process lifecycle.</strong> A self-contained technique
for making cancel stop a server that forks a child.</li>
</ul>
</section>
<footer>
Python Tools Plugin Documentation · Version 1.0.0 · com.appdevforall.python.plugin
</footer>
</body>
</html>