version 0.0.7

Author: eseunghwan

CHANGELOG.md

@@ -38,3 +38,10 @@
 - change python_shell app directory to '.python_shell.dart'
 - move 'test.py' file into 'test' directory and fix test.dart file
 - add logs.
+
+<br />
+
+## 0.0.7
+- change directionality of library.
+- add 'ShellManager', 'ShellInstance'.
+- update 'README.md'

README.md

@@ -47,11 +47,18 @@ dependencies:
 import "package:python_shell/python_shell.dart";
 
 var shell = PythonShell();
-await shell.initializeShell();
+await shell.initialize();
 
-shell.runString("{pythonCode}");
+await shell.runString("{pythonCode}");
 ```
+- use instance
+```dart
+import "package:python_shell/python_shell.dart";
 
+PythonShell().initialize();
+var instance = ShellManager.getInstance("default");
+await instance.runString("{pythonCode}");
+```
 <br />
 
 - onMessage, onError, onComplete
@@ -60,14 +67,14 @@ shell.runString("{pythonCode}");
 shell.runString(
     "{pythonCode}",
     listener: ShellListener(
-        messageCallback: (message) {
+        onMessage: (message) {
             // if `echo` is `true`, log to console automatically
             print("message!");
         },
-        errorCallback: (e, s) {
+        onError: (e, s) {
             print("error!");
         },
-        completeCallback: () {
+        onComplete: () {
             print("complete!");
         }
     )

example/python_shell_example.dart

@@ -1,21 +1,36 @@
 import "package:python_shell/python_shell.dart";
 
 void main() async {
-    var shell = PythonShell(shellConfig: PythonShellConfig(
-        pythonRequires: [ "PySide6" ],
-        defaultWorkingDirectory: "example"
-    ));
+    // 현재 스타일
+//     var shell = PythonShell(shellConfig: PythonShellConfig(
+//         pythonRequires: [ "PySide6" ],
+//         defaultWorkingDirectory: "example"
+//     ));
+//     await shell.initialize();
+
+//     await shell.runString("""
+// import os, PySide6
+
+// print("in python: ", os.getcwd())
+// print("in python: ", PySide6)
+// """, useInstance: true, instanceName: "testInstance1", listener: ShellListener(
+//         completeCallback: () {
+//             print(shell.resolved);
+//             // shell.clear();
+//         }
+//     ));
+
+    var shell = PythonShell(PythonShellConfig());
     await shell.initialize();
 
-    await shell.runString("""
+    var instance = ShellManager.getInstance("default");
+    instance.installRequires([ "PySide6" ]);
+    await instance.runString("""
 import os, PySide6
 
 print("in python: ", os.getcwd())
 print("in python: ", PySide6)
-""", useInstance: true, instanceName: "testInstance1", listener: ShellListener(
-        completeCallback: () {
-            print(shell.resolved);
-            // shell.clear();
-        }
-    ));
+""", echo: true);
+
+    print("finished");
 }

lib/python_shell.dart

@@ -1,4 +1,7 @@
 
 library python_shell;
 
-export "src/shell.dart";
+export "src/python_shell.dart";
+export "src/listener.dart";
+export "src/shell/manager.dart";
+export "src/shell/instance.dart";

lib/src/config.dart

@@ -0,0 +1,40 @@
+
+import "dart:io";
+import "package:path/path.dart" as path;
+
+
+String appDir = path.join(Platform.environment[Platform.isWindows ? "USERPROFILE" : "HOME"]!, ".python_shell.dart");
+String tempDir = path.join(appDir, "temp");
+String instanceDir = path.join(appDir, "instances");
+
+String defaultPythonVersion = "3.9.13";
+String defaultPythonPath = "python3";
+
+String checkPythonVersion(String rawPythonVersion) {
+    String realPythonVersion = "3.9.13";
+
+    var versions = rawPythonVersion.split(".");
+    if (versions.length == 3) {
+        if (rawPythonVersion.endsWith(".")) {
+            if (versions.last != "") {
+                versions.removeLast();
+                realPythonVersion = versions.join(".");
+            }
+        }
+        else {
+            realPythonVersion = rawPythonVersion;
+        }
+    }
+    else if (versions.length == 2) {
+        if (rawPythonVersion.endsWith(".")) {
+            if (versions.last != "") {
+                realPythonVersion = "${versions.join(".")}.0";
+            }
+        }
+        else {
+            realPythonVersion = "$rawPythonVersion.0";
+        }
+    }
+
+    return realPythonVersion;
+}

lib/src/shell_listener.dart lib/src/listener.callbacks.dartlib/src/shell_listener.dart renamed to lib/src/listener.callbacks.dart

@@ -0,0 +1,18 @@
+
+import "listener.callbacks.dart";
+
+
+/// PythonShell Listener Class
+/// parameters and properties:
+/// * [onMessage]: same as messageCallback
+/// * [onError]: same as errorCallback
+/// * [onComplete]: same as completeCallback
+class ShellListener {
+    Function(String) onMessage;
+    Function(Object, StackTrace) onError;
+    Function() onComplete;
+
+    ShellListener({
+        Function(String)? onMessage, Function(Object, StackTrace)? onError, Function()? onComplete
+    }): onMessage = onMessage ?? emptyMessageCallback, onError = onError ?? emptyErrorCallback, onComplete = onComplete ?? emptyCompleteCallback;
+}

lib/src/listener.dart

@@ -0,0 +1,98 @@
+
+import "dart:io";
+
+import "package:path/path.dart" as path;
+import "package:dio/dio.dart";
+import "package:archive/archive_io.dart";
+
+import "config.dart" as config;
+import "listener.dart";
+import "shell/manager.dart";
+import "shell/instance.dart";
+
+
+/// PythonShell Class
+class PythonShell {
+    PythonShell(PythonShellConfig shellConfig);
+
+    void clear() => ShellManager.clear();
+
+    Future<void> initialize() async {
+        print("Initializing shell...");
+        config.defaultPythonVersion = config.checkPythonVersion(config.defaultPythonVersion);
+        if (!Directory(config.appDir).existsSync()) Directory(config.appDir).createSync();
+        if (!Directory(config.instanceDir).existsSync()) Directory(config.instanceDir).createSync();
+        if (!Directory(config.tempDir).existsSync()) Directory(config.tempDir).createSync();
+
+        String pythonDir = "";
+        if (Platform.isWindows) {
+            print("Check default python binary files...");
+            pythonDir = path.join(config.appDir, "python");
+            if (!Directory(pythonDir).existsSync()) {
+                String pythonBinaryFile = path.join(config.tempDir, "python.zip");
+                await Dio().download("https://www.python.org/ftp/python/${config.defaultPythonVersion}/python-${config.defaultPythonVersion}-embed-amd64.zip", pythonBinaryFile);
+                await extractFileToDisk(pythonBinaryFile, pythonDir);
+                File(pythonBinaryFile).deleteSync();
+
+                String pythonPthFile = path.join(pythonDir, "python${config.defaultPythonVersion.replaceAll(".${config.defaultPythonVersion.split(".").last}", "").replaceAll(".", "")}._pth");
+                File(pythonPthFile).writeAsStringSync(File(pythonPthFile).readAsStringSync().replaceAll("#import site", "import site"));
+            }
+            print("Python check finished.");
+
+            config.defaultPythonPath = path.join(pythonDir, "python.exe");
+        }
+
+        if (File(config.defaultPythonPath).existsSync()) {
+            print("Default settings for virtualenv...");
+            var result = Process.runSync(config.defaultPythonPath, [ "-m", "pip", "install", "pip", "--upgrade" ]);
+            if (result.stderr.toString().trim() != "") {
+                String pipInstallFile = path.join(config.tempDir, "get-pip.py");
+                await Dio().download("https://bootstrap.pypa.io/pip/get-pip.py", pipInstallFile);
+                Process.runSync(config.defaultPythonPath, [ pipInstallFile ]);
+                File(pipInstallFile).deleteSync();
+            }
+
+            Process.runSync(config.defaultPythonPath, [ "-m", "pip", "install", "virtualenv", "--upgrade" ]);
+            print("Virtualenv settings finished.");
+        }
+
+        String defaultEnvDir = path.join(config.instanceDir, "default");
+        if (!Directory(defaultEnvDir).existsSync()) {
+            print("Creating default env...");
+            ShellManager.createInstance(instanceName: "default");
+            print("Default env created.");
+        }
+
+        print("Shell initialized.");
+    }
+
+    Future<void> runFile(String pythonFile, { ShellInstance? instance, String? workingDirectory, ShellListener? listener, bool echo = true }) async {
+        instance = instance ?? ShellManager.getInstance("default");
+        await instance.runFile(pythonFile, workingDirectory: workingDirectory, listener: listener, echo: echo);
+    }
+
+    Future<void> runString(String pythonCode, { ShellInstance? instance, String? workingDirectory, ShellListener? listener, bool echo = true }) async {
+        instance = instance ?? ShellManager.getInstance("default");
+        await instance.runString(pythonCode, workingDirectory: workingDirectory, listener: listener, echo: echo);
+    }
+}
+
+/// PythonShell Configuration Class
+/// * [defaultPythonPath]: Default python path to use
+/// * [defaultPythonVersion]: Default python version to use
+class PythonShellConfig {
+
+    PythonShellConfig({
+        defaultPythonPath = "python3",
+        defaultPythonVersion = "3.9.13",
+    }) {
+        if ((Platform.isLinux || Platform.isMacOS)) {
+            if (["python", "python2", "python3"].contains(defaultPythonPath)) {
+                config.defaultPythonPath = "/usr/bin/$defaultPythonPath";
+            }
+            else if (!File(defaultPythonPath).existsSync()) {
+                config.defaultPythonPath = "/usr/bin/python3";
+            }
+        }
+    }
+}