Changeset 1013

Timestamp:

07/16/20 14:37:45 (4 years ago)

Author:

Maciej Komosinski

Message:

Turned off echo for communication under Windows; implemented sendDirectCommand() for sending any commands and getting their output

File:

• framspy/FramsticksCLI.py (modified) (12 diffs)

framspy/FramsticksCLI.py

@@ -1 @@
-from math import sqrt
 from subprocess import Popen, PIPE, check_output
 from enum import Enum
@@ -29 +28 @@
         FILE_PREFIX = 'framspy_'
 
-        RANDOMIZE_CMD = "rnd" + "\n"
-        SETEXPEDEF_CMD = "expdef standard-eval" + "\n"
+        RANDOMIZE_CMD = "Math.randomize();"
+        SETEXPEDEF_CMD = "Simulator.expdef=\"standard-eval\";"
         GETSIMPLEST_CMD = "getsimplest"
         GETSIMPLEST_FILE = "simplest.gen"
@@ -46 +45 @@
         CLI_INPUT_FILE = "genotypes.gen"
 
-        _next_instance_id = count(0)  # "static" counter incremented when a new instance is created. Used for unique filenames
+        _next_instance_id = count(0)  # "static" counter incremented when a new instance is created. Used to ensure unique filenames for each instance.
 
 
@@ -87 +86 @@
                         import pexpect  # https://pexpect.readthedocs.io/en/stable/
                         self.child = pexpect.spawn(' '.join(args))
-                        self.child.setecho(False)  # linux only
+                self.child.setecho(False)  # ask the communication to not copy to stdout what we write to stdin
                 print('OK.')
 
@@ -101 +100 @@
                 print('OK.')
                 if not self.DETERMINISTIC:
-                        self.child.sendline(self.RANDOMIZE_CMD)
-                self.child.sendline(self.SETEXPEDEF_CMD)
+                        self.sendDirectCommand(self.RANDOMIZE_CMD)
+                self.sendDirectCommand(self.SETEXPEDEF_CMD)
 
 
         def closeFramsticksCLI(self):
                 # End gracefully by sending end-of-file character: ^Z or ^D
-                # Without -Q argument ("quiet mode"), Framsticks CLI would print "Shell closed." for goodbye.
+                # Without the -Q argument ("quiet mode"), Framsticks CLI would print "Shell closed." for goodbye.
                 self.child.sendline(chr(26 if os.name == "nt" else 4))
 
@@ -134 +133 @@
 
 
-        def __readFromFramsCLIUntil(self, until_marker: str):
+        def __readFromFramsCLIUntil(self, until_marker: str) -> str:
+                output = ""
                 while True:
-                        self.child.expect('\n')
+                        self.child.expect('\r\n' if os.name == "nt" else '\n')
                         msg = str(self.child.before)
                         if self.PRINT_FRAMSTICKS_OUTPUT or msg.startswith("[ERROR]"):
@@ -142 +142 @@
                         if until_marker in msg:
                                 break
+                        else:
+                                output += msg + '\n'
+                return output
 
 
@@ -163 +166 @@
                 result_file_name = self.__getPrefixedFilename(result_file_name)
                 cmd = command + " " + " ".join(filenames_rel) + " " + result_file_name
-                self.child.sendline(cmd + '\n')
+                self.child.sendline(cmd)
                 self.__readFromFramsCLIUntil(self.STDOUT_ENDOPER_MARKER)
                 filenames_abs.append(os.path.join(self.writing_path, self.OUTPUT_DIR, result_file_name))
@@ -173 +176 @@
                 for name in filenames:
                         os.remove(name)
+
+
+        sendDirectCommand_counter = count(0)  # an internal counter for the sendDirectCommand() method; should be static within that method but python does not allow
+
+
+        def sendDirectCommand(self, command: str) -> str:
+                """Sends any command to Framsticks CLI. Use when you know Framsticks and its scripting language, Framscript."""
+                self.child.sendline(command.strip())
+                next(FramsticksCLI.sendDirectCommand_counter)
+                STDOUT_ENDOPER_MARKER = "uniqe-marker-" + str(FramsticksCLI.sendDirectCommand_counter)
+                self.child.sendline("Simulator.print(\"%s\");" % STDOUT_ENDOPER_MARKER)
+                return self.__readFromFramsCLIUntil(STDOUT_ENDOPER_MARKER)
 
 
@@ -202 +217 @@
 
         def mutate(self, genotype: str) -> str:
+                """
+                Returns:
+                        The genotype of the mutated individual. Empty string if the mutation failed.
+                """
                 files = self.__runCommand(self.MUTATE_CMD, [genotype], self.MUTATE_FILE, self.GENO_SAVE_FILE_FORMAT["RAWGENO"])
                 with open(files[-1]) as f:
@@ -209 +228 @@
 
 
-        def crossOver(self, genotype1: str, genotype2: str) -> str:
-                files = self.__runCommand(self.CROSSOVER_CMD, [genotype1, genotype2], self.CROSSOVER_FILE, self.GENO_SAVE_FILE_FORMAT["RAWGENO"])
+        def crossOver(self, genotype_parent1: str, genotype_parent2: str) -> str:
+                """
+                Returns:
+                        The genotype of the offspring. Empty string if the crossing over failed.
+                """
+                files = self.__runCommand(self.CROSSOVER_CMD, [genotype_parent1, genotype_parent2], self.CROSSOVER_FILE, self.GENO_SAVE_FILE_FORMAT["RAWGENO"])
                 with open(files[-1]) as f:
                         child_genotype = "".join(f.readlines())
@@ -276 +299 @@
         parsed_args = parseArguments()
         framsCLI = FramsticksCLI(parsed_args.path, parsed_args.exe, parsed_args.pid)
+
+        print("Sending a direct command to Framsticks CLI that calculates \"4\"+2 yields", repr(framsCLI.sendDirectCommand("Simulator.print(\"4\"+2);")))
 
         simplest = framsCLI.getSimplest('1' if parsed_args.genformat is None else parsed_args.genformat)