officehelper.py memory cleanup
- main program must stop subprocesses it initiates before it throws exceptions
Change-Id: I6e87d79e2f21cd41f7cd8e470cc166f8d5282954
Reviewed-on: https://gerrit.libreoffice.org/c/core/+/164819
Reviewed-by: Noel Grandin <noel.grandin@collabora.co.uk>
Tested-by: Noel Grandin <noel.grandin@collabora.co.uk>
diff --git a/pyuno/source/officehelper.py b/pyuno/source/officehelper.py
index 5c89ef7..ccdd555 100644
--- a/pyuno/source/officehelper.py
+++ b/pyuno/source/officehelper.py
@@ -16,58 +16,42 @@
# except in compliance with the License. You may obtain a copy of
# the License at http://www.apache.org/licenses/LICENSE-2.0 .
#
""" Bootstrap OOo and PyUNO Runtime.
""" Bootstrap PyUNO Runtime.
The soffice process is started opening a named pipe of random name, then
the local context is used to access the pipe. This function directly
returns the remote component context, from whereon you can get the
ServiceManager by calling getServiceManager() on the returned object.
This module supports the following environments:
- Windows
- Windows
- GNU/Linux derivatives
- MacOS X
- Mac OS X
A configurable time-out allows to wait for LibO process to be completed.
Multiple attempts can be set in order to connect to LibO as a service.
Multiple attempts can be set in order to connect to LibO as a service.
Specific versions of the office suite can be started.
Instructions:
1. Include one of the below examples in your Python macro
2. Run your LibreOffice script from your preferred IDE
Imports:
os, random, subprocess, sys - `bootstrap`
itertools, time - `retry` decorator
Exceptions:
OSError - in `bootstrap`
BootstrapException - in `bootstrap`
NoConnectException - in `bootstrap`
Functions:
`bootstrap`
`retry` decorator
Acknowledgments:
- Kim Kulak for original officehelper.py Python translation from bootstrap.java
- ActiveState, for `retry` python decorator
warning:: Tested platforms are Linux, MacOS X & Windows
AppImage, Flatpak, Snap and the like have not be validated
warning:: Tested platforms are Linux, Mac OS X & Windows
AppImage, Flatpak, Snap and the like have not been validated
:References:
.. _ActiveState retry Python decorator: http://code.activestate.com/recipes/580745-retry-decorator-in-python/
"""
import os, random, subprocess # in bootstrap()
import os, random, signal, subprocess # in bootstrap()
from sys import platform # in bootstrap()
import itertools, time # in retry() decorator
import uno
from com.sun.star.connection import NoConnectException
from com.sun.star.uno import Exception as UnoException
@@ -94,7 +78,7 @@ def retry(delays=(0, 1, 5, 30, 180, 600, 3600),
problems.append(problem)
if delay is None:
report("retryable failed definitely:", problems)
# raise
raise
else:
report("retryable failed:", problem,
"-- delaying for %ds" % delay)
@@ -103,119 +87,83 @@ def retry(delays=(0, 1, 5, 30, 180, 600, 3600),
return wrapped
return wrapper
def bootstrap(soffice=None,delays=(1, 3, 5, 7), report=lambda *args: None):
def bootstrap(soffice=None, delays=(1, 3, 5, 7), report=lambda *args: None):
# 4 connection attempts; sleeping 1, 3, 5 and 7 seconds
# no report to console
"""Bootstrap OOo and PyUNO Runtime.
"""Bootstrap PyUNO Runtime.
The soffice process is started opening a named pipe of random name,
then the local context is used to access the pipe. This function
directly returns the remote component context, from whereon you can
get the ServiceManager by calling getServiceManager() on the
returned object.
Examples:
Examples:
i. Start LO as a service, get its remote component context
import officehelper
ctx = officehelper.bootstrap()
# your code goes here
ii. Wait longer for LO to start, request context multiples times
+ Report processing in console
import officehelper as oh
ctx = oh.bootstrap(delays=(5,10,15,20),report=print) # every 5 sec.
# your code goes here
iii. Use a specific LibreOffice copy
iii. Use a specific LibreOffice copy
from officehelper import bootstrap
ctx = bootstrap(soffice='USB:\PortableApps\libO-7.6\App\libreoffice\program\soffice.exe'))
ctx = bootstrap(soffice=r"USB:\PortableApps\libO-7.6\App\libreoffice\program\soffice.exe")
# your code goes here
"""
if soffice: # soffice fully qualified path as parm
sOffice = soffice
else: # soffice script used on *ix, Mac; soffice.exe used on Win
if "UNO_PATH" in os.environ:
sOffice = os.environ["UNO_PATH"]
else:
sOffice = "" # let's hope for the best
sOffice = os.path.join(sOffice, "soffice")
if platform.startswith("win"):
sOffice += ".exe"
sOffice = '"' + sOffice + '"' # accommodate ' ' spaces in filename
elif platform=="darwin": # any other un-hardcoded suggestion?
sOffice = "/Applications/LibreOffice.App/Contents/MacOS/soffice"
#print(sOffice)
# Generate a random pipe name.
random.seed()
sPipeName = "uno" + str(random.random())[2:]
# Start the office process
connect_string = ''.join(['pipe,name=', sPipeName, ';urp;'])
command = ' '.join([sOffice, '--nologo', '--nodefault', '--accept="' + connect_string + '"'])
#print(command)
subprocess.Popen(command, shell=True)
# Connect to a started office instance
xLocalContext = uno.getComponentContext()
resolver = xLocalContext.ServiceManager.createInstanceWithContext(
"com.sun.star.bridge.UnoUrlResolver", xLocalContext)
sConnect = "".join(['uno:', connect_string, 'StarOffice.ComponentContext'])
@retry(delays=delays,
exception=NoConnectException,
report=report)
def resolve():
return resolver.resolve(sConnect) # may raise NoConnectException
ctx = resolve()
if not ctx:
raise BootstrapException
return ctx
# ============
# Unit Testing
# ============
if __name__ == "__main__":
# ~ dir(__name__)
# ~ help(__name__)
# ~ help(bootstrap)
# ~ exit()
#from officehelper import bootstrap, BootstrapException
#from sys import platform
#import subprocess, time
try:
ctx = bootstrap()
# use delays=[0,] to raise BootstrapException
if soffice: # soffice fully qualified path as parm
sOffice = soffice
else: # soffice script used on *ix, Mac; soffice.exe used on Win
if "UNO_PATH" in os.environ:
sOffice = os.environ["UNO_PATH"]
else:
sOffice = "" # let's hope for the best
sOffice = os.path.join(sOffice, "soffice")
if platform.startswith("win"):
sOffice += ".exe"
sOffice = '"' + sOffice + '"' # accommodate ' ' spaces in filename
elif platform == "darwin": # any other un-hardcoded suggestion?
sOffice = "/Applications/LibreOffice.App/Contents/MacOS/soffice"
# Generate a random pipe name.
random.seed()
sPipeName = "uno" + str(random.random())[2:]
# Start the office process
connect_string = ''.join(['pipe,name=', sPipeName, ';urp;'])
command = ' '.join([sOffice, '--nologo', '--nodefault', '--accept="' + connect_string + '"'])
if platform.startswith("win") or platform == "darwin":
process = subprocess.Popen(command, shell=True)
elif platform == "linux": # Use a process group to enable proper termination
process = subprocess.Popen(command, shell=True, preexec_fn=os.setsid)
else:
raise OSError
# Connect to a started office instance
xLocalContext = uno.getComponentContext()
resolver = xLocalContext.ServiceManager.createInstanceWithContext(
"com.sun.star.bridge.UnoUrlResolver", xLocalContext)
sConnect = "".join(['uno:', connect_string, 'StarOffice.ComponentContext'])
@retry(delays=delays,
exception=NoConnectException,
report=report)
def resolve():
return resolver.resolve(sConnect) # may raise NoConnectException
ctx = resolve()
return ctx
except BootstrapException: # stop soffice as a service
if platform.startswith("win"):
subprocess.Popen(['taskkill', '/f', '/t', '/im', 'soffice.exe'])
elif platform == "linux":
time.sleep(5)
subprocess.Popen(['killall', "soffice.bin"])
elif platform == "darwin":
time.sleep(15)
subprocess.Popen(['pkill', '-f', 'LibreOffice'])
raise BootstrapException()
except Exception:
time.sleep(10)
if process: # clean memory from soffice running process
if platform.startswith("win") or platform == "darwin":
process.terminate() # Send termination signal
elif platform == "linux":
os.killpg(os.getpgid(process.pid), signal.SIGTERM) # Send termination signal to process group
raise BootstrapException
# your code goes here
time.sleep(10)
if ctx: # stop soffice as a service
smgr = ctx.getServiceManager()
desktop = smgr.createInstanceWithContext("com.sun.star.frame.Desktop", ctx)
desktop.terminate()
# vim: set shiftwidth=4 softtabstop=4 expandtab
\ No newline at end of file
# vim: set shiftwidth=4 softtabstop=4 expandtab
