wizards/source/scriptforge/python/scriptforge.py | 25 ++++++++++++++--------
wizards/source/scriptforge/python/scriptforge.pyi | 4 ++-
2 files changed, 20 insertions(+), 9 deletions(-)
New commits:
commit 0419b8c8f9803e23cdd940107d1b78d641f7767c
Author: Jean-Pierre Ledure <j...@ledure.be>
AuthorDate: Thu Sep 12 10:58:31 2024 +0200
Commit: Jean-Pierre Ledure <j...@ledure.be>
CommitDate: Fri Sep 13 15:04:17 2024 +0200
scriptforge.py Connect via pipe
Python scripts using ScriptForge start like:
from scriptforge import CreateScriptService, \
ScriptForge
ScriptForge(...) (*)
sv = CreateScriptService(...)
The (*) statement has next syntaxes: either
(1) ScriptForge()
(2) ScriptForge(host: str = ..., port: int = ...)
(3) ScriptForge(pipe: str = ...)
Syntax (1) is implicit at the first invocation of
CreateScriptService() without a former call to
ScriptForge()
Syntax (2) exists in previous versions.
This commit implements syntax (3) to connect a Python
process to a LO process on the same system via a pipe
mechanism.
The change impacts only Python scripts.
The documentation should be upgraded to include
the new functionality.
Change-Id: I50457b6fffc8c9d6a9ad5c5289de1c363c6680e3
Reviewed-on: https://gerrit.libreoffice.org/c/core/+/173252
Tested-by: Jenkins
Reviewed-by: Jean-Pierre Ledure <j...@ledure.be>
diff --git a/wizards/source/scriptforge/python/scriptforge.py
b/wizards/source/scriptforge/python/scriptforge.py
index 7c42964a1f0e..d8ac07179100 100644
--- a/wizards/source/scriptforge/python/scriptforge.py
+++ b/wizards/source/scriptforge/python/scriptforge.py
@@ -105,6 +105,7 @@ class ScriptForge(object, metaclass = _Singleton):
# Inter-process parameters
hostname = ''
port = 0
+ pipe = ''
componentcontext = None # com.sun.star.uno.XComponentContext
scriptprovider = None # com.sun.star.script.provider.XScriptProvider
@@ -144,18 +145,21 @@ class ScriptForge(object, metaclass = _Singleton):
('ScriptForge.String', 7),
('ScriptForge.UI', 8)])
- def __init__(self, hostname = '', port = 0):
+ def __init__(self, hostname = '', port = 0, pipe = ''):
"""
Because singleton, constructor is executed only once while Python
active
Both arguments are mandatory when Python and LibreOffice run in
separate processes
Otherwise both arguments must be left out.
:param hostname: probably 'localhost'
:param port: port number
+ :param pipe: pipe name
"""
ScriptForge.hostname = hostname
ScriptForge.port = port
+ ScriptForge.pipe = pipe
# Determine main pyuno entry points
- ScriptForge.componentcontext = self.ConnectToLOProcess(hostname, port)
# com.sun.star.uno.XComponentContext
+ ScriptForge.componentcontext = self.ConnectToLOProcess(hostname, port,
pipe)
+ # com.sun.star.uno.XComponentContext
ScriptForge.scriptprovider =
self.ScriptProvider(ScriptForge.componentcontext) #
...script.provider.XScriptProvider
#
# Establish a list of the available services as a dictionary
(servicename, serviceclass)
@@ -169,7 +173,7 @@ class ScriptForge(object, metaclass = _Singleton):
ScriptForge.SCRIPTFORGEINITDONE = True
@classmethod
- def ConnectToLOProcess(cls, hostname = '', port = 0):
+ def ConnectToLOProcess(cls, hostname = '', port = 0, pipe = ''):
"""
Called by the ScriptForge class constructor to establish the
connection with
the requested LibreOffice instance
@@ -177,25 +181,30 @@ class ScriptForge(object, metaclass = _Singleton):
:param hostname: probably 'localhost' or ''
:param port: port number or 0
+ :param pipe: pipe name or ''
:return: the derived component context
"""
- if len(hostname) > 0 and port > 0: # Explicit connection request via
socket
+ if (len(hostname) > 0 and port > 0 and len(pipe) == 0) \
+ or (len(hostname) == 0 and port == 0 and len(pipe) > 0): #
Explicit connection via socket or pipe
ctx = uno.getComponentContext() #
com.sun.star.uno.XComponentContext
resolver = ctx.ServiceManager.createInstanceWithContext(
'com.sun.star.bridge.UnoUrlResolver', ctx) #
com.sun.star.comp.bridge.UnoUrlResolver
try:
- conn = 'socket,host=%s,port=%d' % (hostname, port)
+ if len(pipe) == 0:
+ conn = 'socket,host=%s,port=%d' % (hostname, port)
+ else:
+ conn = 'pipe,name=%s' % pipe
url = 'uno:%s;urp;StarOffice.ComponentContext' % conn
ctx = resolver.resolve(url)
except Exception: # thrown when LibreOffice specified instance
isn't started
raise SystemExit(
- 'Connection to LibreOffice failed (host = ' + hostname +
', port = ' + str(port) + ')')
+ "Connection to LibreOffice failed (%s)" % conn)
return ctx
- elif len(hostname) == 0 and port == 0: # Usual interactive mode
+ elif len(hostname) == 0 and port == 0 and len(pipe) == 0: # Usual
interactive mode
return uno.getComponentContext()
else:
raise SystemExit('The creation of the ScriptForge() instance got
invalid arguments: '
- + '(host = ' + hostname + ', port = ' + str(port)
+ ')')
+ + "(host = '" + hostname + "', port = " +
str(port) + ", pipe = '" + pipe + "')")
@classmethod
def ScriptProvider(cls, context = None):
diff --git a/wizards/source/scriptforge/python/scriptforge.pyi
b/wizards/source/scriptforge/python/scriptforge.pyi
index 0269744e47c2..366da7084a07 100644
--- a/wizards/source/scriptforge/python/scriptforge.pyi
+++ b/wizards/source/scriptforge/python/scriptforge.pyi
@@ -240,7 +240,7 @@ class ScriptForge(object, metaclass = ...):
The class may be instantiated several times. Only the first instance
will be retained ("Singleton").
"""
- def __init__(self, hostname: str = ..., port: int = ...):
+ def __init__(self, hostname: str = ..., port: int = ..., pipe: str = ...):
"""
The ScriptForge class encapsulates the core of the ScriptForge
run-time
- Bridge with the LibreOffice process
@@ -258,6 +258,8 @@ class ScriptForge(object, metaclass = ...):
``hostname``: probably 'localhost'
``port``: port number
+
+ ``pipe``: pipe name
"""
...
