pythonnative 0.18.0__py3-none-any.whl → 0.19.0__py3-none-any.whl

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.
pythonnative/__init__.py CHANGED
@@ -51,7 +51,7 @@ Example:
51
51
  ```
52
52
  """
53
53
 
54
- __version__ = "0.18.0"
54
+ __version__ = "0.19.0"
55
55
 
56
56
  from . import runtime, sdk
57
57
  from .alerts import Alert
pythonnative/cli/pn.py CHANGED
@@ -1,9 +1,12 @@
1
1
  """`pn` CLI: scaffold, run, and clean PythonNative projects.
2
2
 
3
3
  The console script `pn` (declared in `pyproject.toml` under
4
- `[project.scripts]`) dispatches to one of three subcommands:
4
+ `[project.scripts]`) dispatches to one of four subcommands:
5
5
 
6
6
  - `pn init [name]`: scaffold a new project in the current directory.
7
+ - `pn preview [component]`: render the app in a desktop (Tkinter)
8
+ window with instant Fast Refresh — the fast inner dev loop, no
9
+ device or simulator required.
7
10
  - `pn run android|ios`: stage code into a native template, build it,
8
11
  install it, and stream logs back to the terminal.
9
12
  - `pn clean`: remove the local `build/` directory.
@@ -1119,6 +1122,90 @@ def _run_hot_reload(platform: str, project_dir: str, build_dir: str, show_logs:
1119
1122
  print("\n[hot-reload] Stopped.")
1120
1123
 
1121
1124
 
1125
+ def _entrypoint_to_module(entry_point: str) -> str:
1126
+ """Convert a config ``entryPoint`` path into an importable module path.
1127
+
1128
+ ``"app/main.py"`` → ``"app.main"``. Returns ``"app.main"`` for
1129
+ empty / unusable input so ``pn preview`` always has a sane default.
1130
+ """
1131
+ normalized = entry_point.strip().replace("\\", "/")
1132
+ if normalized.endswith(".py"):
1133
+ normalized = normalized[:-3]
1134
+ normalized = normalized.strip("/").replace("/", ".")
1135
+ return normalized or "app.main"
1136
+
1137
+
1138
+ def preview_project(args: argparse.Namespace) -> None:
1139
+ """Render the project in a desktop preview window (Tkinter).
1140
+
1141
+ Sets ``PN_PLATFORM=desktop`` (so PythonNative selects the Tkinter
1142
+ backend) and hands off to ``pythonnative.preview.run_preview``,
1143
+ which opens a window, mounts the app, and Fast Refreshes on every
1144
+ file save until the window is closed.
1145
+
1146
+ Args:
1147
+ args: Parsed argparse namespace. Recognized attributes:
1148
+
1149
+ - `component` (`str`, optional): Module path like
1150
+ ``"app.main"`` (its ``App`` is used) or a dotted
1151
+ ``module.Component`` path. Defaults to the project's
1152
+ configured ``entryPoint``.
1153
+ - `width` / `height` (`int`): Initial window size in points.
1154
+ - `title` (`str`): Window title.
1155
+ - `no_hot_reload` (`bool`): Disable file watching.
1156
+ """
1157
+ # The desktop backend is selected at *import time* from the
1158
+ # ``PN_PLATFORM`` environment variable (see ``pythonnative.utils`` and
1159
+ # the host selection in ``pythonnative.screen``). Because the ``pn``
1160
+ # console entry point lives inside the ``pythonnative`` package,
1161
+ # importing it already loaded the package under the default,
1162
+ # non-desktop platform before this handler ever runs. Re-exec a fresh
1163
+ # interpreter with the variable set so every module binds to the
1164
+ # Tkinter backend; the re-execed child sees ``PN_PLATFORM=desktop`` and
1165
+ # skips this branch, so there is no exec loop.
1166
+ if os.environ.get("PN_PLATFORM") != "desktop":
1167
+ try:
1168
+ completed = subprocess.run(
1169
+ [sys.executable, "-m", "pythonnative.cli.pn", *sys.argv[1:]],
1170
+ env={**os.environ, "PN_PLATFORM": "desktop"},
1171
+ )
1172
+ except KeyboardInterrupt:
1173
+ sys.exit(130)
1174
+ sys.exit(completed.returncode)
1175
+
1176
+ project_dir = os.getcwd()
1177
+ component: Optional[str] = getattr(args, "component", None)
1178
+ if not component:
1179
+ config = _read_project_config()
1180
+ component = _entrypoint_to_module(config.get("entryPoint", "app/main.py"))
1181
+
1182
+ try:
1183
+ from pythonnative.preview import run_preview
1184
+ except Exception as exc: # pragma: no cover - environment dependent
1185
+ print(f"Error: could not start the desktop preview: {exc}")
1186
+ print(
1187
+ "The desktop preview needs Tkinter (Python's standard GUI toolkit).\n"
1188
+ "On macOS: brew install python-tk\n"
1189
+ "On Debian/Ubuntu: sudo apt-get install python3-tk\n"
1190
+ "On Windows: reinstall Python with the 'tcl/tk' option checked."
1191
+ )
1192
+ sys.exit(1)
1193
+
1194
+ print(f"Starting PythonNative preview for {component} (Ctrl+C or close the window to stop).")
1195
+ try:
1196
+ run_preview(
1197
+ component,
1198
+ project_root=project_dir,
1199
+ width=getattr(args, "width", 390),
1200
+ height=getattr(args, "height", 844),
1201
+ title=getattr(args, "title", "PythonNative Preview"),
1202
+ hot_reload=not getattr(args, "no_hot_reload", False),
1203
+ )
1204
+ except RuntimeError as exc:
1205
+ print(f"Error: {exc}")
1206
+ sys.exit(1)
1207
+
1208
+
1122
1209
  def clean_project(args: argparse.Namespace) -> None:
1123
1210
  """Remove the local `build/` directory.
1124
1211
 
@@ -1152,6 +1239,25 @@ def main() -> None:
1152
1239
  parser_init.add_argument("--force", action="store_true", help="Overwrite existing files if present")
1153
1240
  parser_init.set_defaults(func=init_project)
1154
1241
 
1242
+ # Create a new command 'preview' that calls preview_project
1243
+ parser_preview = subparsers.add_parser("preview")
1244
+ parser_preview.add_argument(
1245
+ "component",
1246
+ nargs="?",
1247
+ help="Module path (e.g. app.main) or dotted component path; defaults to the project entry point",
1248
+ )
1249
+ parser_preview.add_argument("--width", type=int, default=390, help="Initial window width in points (default: 390)")
1250
+ parser_preview.add_argument(
1251
+ "--height", type=int, default=844, help="Initial window height in points (default: 844)"
1252
+ )
1253
+ parser_preview.add_argument("--title", default="PythonNative Preview", help="Preview window title")
1254
+ parser_preview.add_argument(
1255
+ "--no-hot-reload",
1256
+ action="store_true",
1257
+ help="Disable file watching / Fast Refresh",
1258
+ )
1259
+ parser_preview.set_defaults(func=preview_project)
1260
+
1155
1261
  # Create a new command 'run' that calls run_project
1156
1262
  parser_run = subparsers.add_parser("run")
1157
1263
  parser_run.add_argument("platform", choices=["android", "ios"])
@@ -238,18 +238,31 @@ _registry: Optional[NativeViewRegistry] = None
238
238
 
239
239
 
240
240
  def _active_platform_name() -> str:
241
- """Return ``"android"`` or ``"ios"`` for the active runtime."""
242
- from ..utils import IS_ANDROID
241
+ """Return ``"android"``, ``"desktop"``, or ``"ios"`` for the active runtime."""
242
+ from ..utils import IS_ANDROID, IS_DESKTOP
243
243
 
244
- return "android" if IS_ANDROID else "ios"
244
+ if IS_ANDROID:
245
+ return "android"
246
+ if IS_DESKTOP:
247
+ return "desktop"
248
+ return "ios"
245
249
 
246
250
 
247
251
  def _register_builtin_handlers(registry: NativeViewRegistry) -> None:
248
- """Register every built-in handler for the active platform."""
249
- from ..utils import IS_ANDROID
252
+ """Register every built-in handler for the active platform.
253
+
254
+ The desktop (Tkinter) backend is selected when ``pn preview`` sets
255
+ ``PN_PLATFORM=desktop``; otherwise this picks Android (on device) or
256
+ iOS (the default off-device path, exercised by the iOS templates and
257
+ by tests that install the ``[ios]`` extra). Off-device unit tests
258
+ typically inject a mock registry via ``set_registry`` instead.
259
+ """
260
+ from ..utils import IS_ANDROID, IS_DESKTOP
250
261
 
251
262
  if IS_ANDROID:
252
263
  from .android import register_handlers
264
+ elif IS_DESKTOP:
265
+ from .desktop import register_handlers
253
266
  else:
254
267
  from .ios import register_handlers
255
268
  register_handlers(registry)