RS2Scripting 11.25.0__tar.gz → 11.26.0__tar.gz

{rs2scripting-11.25.0/src/RS2Scripting.egg-info → rs2scripting-11.26.0}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.2
 Name: RS2Scripting
-Version: 11.25.0
+Version: 11.26.0
 Summary: Client library for interacting with RS2 through python
 Author: Rocscience
 License: MIT License
@@ -107,7 +107,7 @@ The following steps can be taken to regenerate the RS2 Scripting Documentation:
 2. Rebuild the RS2 library in your virtual environment by following the [Build](#build) section.
 3. Install the documentation requirement packages.
 ```pip install -r docs/requirements.txt```
-4. Run docs/example_code/runAllExamples.bat file in the folder to update example results. This will run the examples using the version of RS2 you have installed on your machine.
+4. Run .\docs\example_code\runAllExamples.bat file in the folder to update example results. This will run the examples using the version of RS2 you have installed on your machine.
 5. To generate the documentation run the following:  
 ```python generateAndBuildDocumentation.py```  
 

{rs2scripting-11.25.0 → rs2scripting-11.26.0}/README.md

@@ -90,7 +90,7 @@ The following steps can be taken to regenerate the RS2 Scripting Documentation:
 2. Rebuild the RS2 library in your virtual environment by following the [Build](#build) section.
 3. Install the documentation requirement packages.
 ```pip install -r docs/requirements.txt```
-4. Run docs/example_code/runAllExamples.bat file in the folder to update example results. This will run the examples using the version of RS2 you have installed on your machine.
+4. Run .\docs\example_code\runAllExamples.bat file in the folder to update example results. This will run the examples using the version of RS2 you have installed on your machine.
 5. To generate the documentation run the following:  
 ```python generateAndBuildDocumentation.py```  
 

{rs2scripting-11.25.0 → rs2scripting-11.26.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "RS2Scripting"
-version = "11.25.0"
+version = "11.26.0"
 dependencies = [
   "rsmessages == 0.0.2"
 ]

{rs2scripting-11.25.0 → rs2scripting-11.26.0/src/RS2Scripting.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.2
 Name: RS2Scripting
-Version: 11.25.0
+Version: 11.26.0
 Summary: Client library for interacting with RS2 through python
 Author: Rocscience
 License: MIT License
@@ -107,7 +107,7 @@ The following steps can be taken to regenerate the RS2 Scripting Documentation:
 2. Rebuild the RS2 library in your virtual environment by following the [Build](#build) section.
 3. Install the documentation requirement packages.
 ```pip install -r docs/requirements.txt```
-4. Run docs/example_code/runAllExamples.bat file in the folder to update example results. This will run the examples using the version of RS2 you have installed on your machine.
+4. Run .\docs\example_code\runAllExamples.bat file in the folder to update example results. This will run the examples using the version of RS2 you have installed on your machine.
 5. To generate the documentation run the following:  
 ```python generateAndBuildDocumentation.py```  
 

{rs2scripting-11.25.0 → rs2scripting-11.26.0}/src/rs2/_common/Client.py

@@ -5,7 +5,7 @@ from multiprocessing.connection import Client as multiProcessingClient
 
 class Client:
 	def __init__(self, host, port):
-		self.compatibleProgramVersion = "11.025"
+		self.compatibleProgramVersion = "11.026"
 		self.connection = self.establishConnection(host, port)
 		if self.connection == None:
 			raise RuntimeError("Could not establish connection with the server. Make sure the server is started on the application.")

{rs2scripting-11.25.0 → rs2scripting-11.26.0}/src/rs2/interpreter/RS2Interpreter.py

@@ -1,76 +1,76 @@
-from rsmessages.requestFormat import functionRequest
-from rs2._common.Client import Client
-from rs2.utilities.ApplicationManager import ApplicationManager
-from rs2.interpreter.InterpreterModel import Model
-import winreg
-import time
-
-class RS2Interpreter:
-	def __init__(self, host = 'localhost', port=60055):
-		self.client = Client(host, port)
-
-	def openFile(self, fileName : str) -> Model:
-		'''
-		Takes in the absolute path to an rs2 file to be opened in the modeler.
-
-		Examples:
-			.. code-block:: python
-			
-				model = modeler.openFile('C:/simple_3_stage.fez')
-		'''
-		request = functionRequest('open_file', [fileName], keepReturnValueReference=True)
-		modelObjectId = self.client.callFunction(request)
-		model = Model(self.client, modelObjectId)
-		return model
-	
-	@classmethod
-	def startApplication(cls, port : int, overridePathToExecutable : str = None, timeout : float = 30) -> None:
-		"""Opens the most recently installed RS2 application. Starts the python server and binds it to the given port.
-
-		Args:
-			port (int): the port to bind the python server to. Use this same port when initializing RS2Modeler
-			overridePathToExecutable (str, optional): full path to the desired executable to be opened. If not provided, the latest installation of rs2 is used
-			timeout (float, optional): the maximum amount of time to wait for the application and server to start.
-		
-		Raises:
-			ValueError: Port range must be between ``49152`` and ``65535``, otherwise ValueError is raised
-			TimeoutError: if timeout is provided, raises TimeoutError if not able to connect to the server within that time.
-		"""
-		appManager = ApplicationManager()
-		executablePath = overridePathToExecutable if overridePathToExecutable else cls._getApplicationPath()
-		appManager.startApplication(executablePath, port, timeout)
-
-	@staticmethod
-	def _getApplicationPath() -> str:
-
-		registry = winreg.ConnectRegistry(None, winreg.HKEY_LOCAL_MACHINE)
-		key = winreg.OpenKey(registry, r'SOFTWARE\Rocscience\RS2 11.0')
-		installationLocation, type = winreg.QueryValueEx(key, "Install")
-
-		rs2ModelerInstallLocation =  rf"{installationLocation}\Interpret"
-
-		return rs2ModelerInstallLocation
-	
-	def closeProgram(self, saveModels=True, timeout=30):
-		'''
-		Closes the modeler program. All unsaved models are saved by default.
-
-		Examples:
-			.. code-block:: python
-			
-				#Saves all models before closing
-				modeler.closeProgram(True)
-
-				#Closes without saving any models
-				modeler.closeProgram(False)
-		'''
-		request = functionRequest('closeProgram', [saveModels])
-		portUsed = self.client.callFunction(request)
-		self.client.closeConnection()
-		appManager = ApplicationManager()
-		portIsAvailable = False
-		startTime = time.time()
-		while not portIsAvailable:
-			if (time.time() - startTime) > timeout:
-				raise TimeoutError("The application did not close within the given timeout time.")
+from rsmessages.requestFormat import functionRequest
+from rs2._common.Client import Client
+from rs2.utilities.ApplicationManager import ApplicationManager
+from rs2.interpreter.InterpreterModel import Model
+import winreg
+import time
+
+class RS2Interpreter:
+	def __init__(self, host = 'localhost', port=60055):
+		self.client = Client(host, port)
+
+	def openFile(self, fileName : str) -> Model:
+		'''
+		Takes in the absolute path to an rs2 file to be opened in the modeler.
+
+		Examples:
+			.. code-block:: python
+			
+				model = modeler.openFile('C:/simple_3_stage.fez')
+		'''
+		request = functionRequest('open_file', [fileName], keepReturnValueReference=True)
+		modelObjectId = self.client.callFunction(request)
+		model = Model(self.client, modelObjectId)
+		return model
+	
+	@classmethod
+	def startApplication(cls, port : int, overridePathToExecutable : str = None, timeout : float = 30) -> None:
+		"""Opens the most recently installed RS2 application. Starts the python server and binds it to the given port.
+
+		Args:
+			port (int): the port to bind the python server to. Use this same port when initializing RS2Modeler
+			overridePathToExecutable (str, optional): full path to the desired executable to be opened. If not provided, the latest installation of rs2 is used
+			timeout (float, optional): the maximum amount of time to wait for the application and server to start.
+		
+		Raises:
+			ValueError: Port range must be between ``49152`` and ``65535``, otherwise ValueError is raised
+			TimeoutError: if timeout is provided, raises TimeoutError if not able to connect to the server within that time.
+		"""
+		appManager = ApplicationManager()
+		executablePath = overridePathToExecutable if overridePathToExecutable else cls._getApplicationPath()
+		appManager.startApplication(executablePath, port, timeout)
+
+	@staticmethod
+	def _getApplicationPath() -> str:
+
+		registry = winreg.ConnectRegistry(None, winreg.HKEY_LOCAL_MACHINE)
+		key = winreg.OpenKey(registry, r'SOFTWARE\Rocscience\RS2 11.0')
+		installationLocation, type = winreg.QueryValueEx(key, "Install")
+
+		rs2ModelerInstallLocation =  rf"{installationLocation}\Interpret"
+
+		return rs2ModelerInstallLocation
+	
+	def closeProgram(self, saveModels=True, timeout=30):
+		'''
+		Closes the modeler program. All unsaved models are saved by default.
+
+		Examples:
+			.. code-block:: python
+			
+				#Saves all models before closing
+				modeler.closeProgram(True)
+
+				#Closes without saving any models
+				modeler.closeProgram(False)
+		'''
+		request = functionRequest('closeProgram', [saveModels])
+		portUsed = self.client.callFunction(request)
+		self.client.closeConnection()
+		appManager = ApplicationManager()
+		portIsAvailable = False
+		startTime = time.time()
+		while not portIsAvailable:
+			if (time.time() - startTime) > timeout:
+				raise TimeoutError("The application did not close within the given timeout time.")
 			portIsAvailable = appManager._isPortAvailable(portUsed)

{rs2scripting-11.25.0 → rs2scripting-11.26.0}/src/rs2/modeler/RS2Modeler.py

@@ -1,79 +1,79 @@
-from rsmessages.requestFormat import functionRequest
-from rs2._common.Client import Client
-from rs2.modeler.Model import Model
-from rs2.utilities.ApplicationManager import ApplicationManager
-import winreg
-import time
-
-class RS2Modeler:
-	"""
-	:ref:`Modeler Example`
-	"""
-	def __init__(self, host='localhost', port=60054):
-		self.client = Client(host, port)
-
-	def openFile(self, fileName : str) -> Model:
-		'''
-		Takes in the absolute path to an rs2 file to be opened in the modeler.
-
-		Examples:
-			.. code-block:: python
-
-				model = modeler.openFile('C:/simple_3_stage.fez')
-		'''
-		request = functionRequest('open_file', [fileName], keepReturnValueReference=True)
-		modelObjectId = self.client.callFunction(request)
-		model = Model(self.client, modelObjectId)
-		return model
-
-	@classmethod
-	def startApplication(cls, port : int, overridePathToExecutable : str = None, timeout : float = 30) -> None:
-		"""Opens the most recently installed RS2 application. Starts the python server and binds it to the given port.
-
-		Args:
-			port (int): the port to bind the python server to. Use this same port when initializing RS2Modeler
-			overridePathToExecutable (str, optional): full path to the desired executable to be opened. If not provided, the latest installation of rs2 is used
-			timeout (float, optional): the maximum amount of time to wait for the application and server to start.
-		
-		Raises:
-			ValueError: Port range must be between 49152 and 65535, otherwise ValueError is raised
-			TimeoutError: if timeout is provided, raises TimeoutError if not able to connect to the server within that time.
-		"""
-		appManager = ApplicationManager()
-		executablePath = overridePathToExecutable if overridePathToExecutable else cls._getApplicationPath()
-		appManager.startApplication(executablePath, port, timeout)
-
-	@staticmethod
-	def _getApplicationPath() -> str:
-
-		registry = winreg.ConnectRegistry(None, winreg.HKEY_LOCAL_MACHINE)
-		key = winreg.OpenKey(registry, r'SOFTWARE\Rocscience\RS2 11.0')
-		installationLocation, type = winreg.QueryValueEx(key, "Install")
-
-		rs2ModelerInstallLocation =  rf"{installationLocation}\RS2"
-
-		return rs2ModelerInstallLocation
-	
-	def closeProgram(self, saveModels=True, timeout=30):
-		'''
-		Closes the modeler program. All unsaved models are saved by default.
-
-		Examples:
-			.. code-block:: python
-
-				#saves all models before closing
-				modeler.closeProgram(True)
-
-				#closes the program without saving
-				modeler.closeProgram(False)
-		'''
-		request = functionRequest('closeProgram', [saveModels])
-		portUsed = self.client.callFunction(request)
-		self.client.closeConnection()
-		appManager = ApplicationManager()
-		portIsAvailable = False
-		startTime = time.time()
-		while not portIsAvailable:
-			if (time.time() - startTime) > timeout:
-				raise TimeoutError("The application did not close within the given timeout time.")
+from rsmessages.requestFormat import functionRequest
+from rs2._common.Client import Client
+from rs2.modeler.Model import Model
+from rs2.utilities.ApplicationManager import ApplicationManager
+import winreg
+import time
+
+class RS2Modeler:
+	"""
+	:ref:`Modeler Example`
+	"""
+	def __init__(self, host='localhost', port=60054):
+		self.client = Client(host, port)
+
+	def openFile(self, fileName : str) -> Model:
+		'''
+		Takes in the absolute path to an rs2 file to be opened in the modeler.
+
+		Examples:
+			.. code-block:: python
+
+				model = modeler.openFile('C:/simple_3_stage.fez')
+		'''
+		request = functionRequest('open_file', [fileName], keepReturnValueReference=True)
+		modelObjectId = self.client.callFunction(request)
+		model = Model(self.client, modelObjectId)
+		return model
+
+	@classmethod
+	def startApplication(cls, port : int, overridePathToExecutable : str = None, timeout : float = 30) -> None:
+		"""Opens the most recently installed RS2 application. Starts the python server and binds it to the given port.
+
+		Args:
+			port (int): the port to bind the python server to. Use this same port when initializing RS2Modeler
+			overridePathToExecutable (str, optional): full path to the desired executable to be opened. If not provided, the latest installation of rs2 is used
+			timeout (float, optional): the maximum amount of time to wait for the application and server to start.
+		
+		Raises:
+			ValueError: Port range must be between 49152 and 65535, otherwise ValueError is raised
+			TimeoutError: if timeout is provided, raises TimeoutError if not able to connect to the server within that time.
+		"""
+		appManager = ApplicationManager()
+		executablePath = overridePathToExecutable if overridePathToExecutable else cls._getApplicationPath()
+		appManager.startApplication(executablePath, port, timeout)
+
+	@staticmethod
+	def _getApplicationPath() -> str:
+
+		registry = winreg.ConnectRegistry(None, winreg.HKEY_LOCAL_MACHINE)
+		key = winreg.OpenKey(registry, r'SOFTWARE\Rocscience\RS2 11.0')
+		installationLocation, type = winreg.QueryValueEx(key, "Install")
+
+		rs2ModelerInstallLocation =  rf"{installationLocation}\RS2"
+
+		return rs2ModelerInstallLocation
+	
+	def closeProgram(self, saveModels=True, timeout=30):
+		'''
+		Closes the modeler program. All unsaved models are saved by default.
+
+		Examples:
+			.. code-block:: python
+
+				#saves all models before closing
+				modeler.closeProgram(True)
+
+				#closes the program without saving
+				modeler.closeProgram(False)
+		'''
+		request = functionRequest('closeProgram', [saveModels])
+		portUsed = self.client.callFunction(request)
+		self.client.closeConnection()
+		appManager = ApplicationManager()
+		portIsAvailable = False
+		startTime = time.time()
+		while not portIsAvailable:
+			if (time.time() - startTime) > timeout:
+				raise TimeoutError("The application did not close within the given timeout time.")
 			portIsAvailable = appManager._isPortAvailable(portUsed)