mir/libreoffice
2
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Access2Base - (Python) Explicit missing arguments

Browse Source 
Avoid confusion between Null, Empty and missing arguments
by creating a "missing" symbolic constants
and use it as argument when appropriate
Adapt Basic wrapper accordingly

Change-Id: Iede8a66ac348a041b984f124948cd65032946d7d
This commit is contained in:
Jean-Pierre Ledure
2019-08-23 16:58:39 +02:00
parent ee02218eb9
commit 4b0a01911b
2 changed files with 30 additions and 33 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
wizards/source/access2base/Python.xba
View File

@@ -101,7 +101,7 @@ Const cstApplication = -1, cstDoCmd = -2
Const cstScalar = 0, cstObject = 1, cstNull = 2, cstUNO = 3 Const cstScalar = 0, cstObject = 1, cstNull = 2, cstUNO = 3
'Conventional special values 'Conventional special values
Const cstNoArgs = "+++NOARGS+++", cstSymEmpty = "+++EMPTY+++", cstSymNull = "+++NULL+++" Const cstNoArgs = "+++NOARGS+++", cstSymEmpty = "+++EMPTY+++", cstSymNull = "+++NULL+++", cstSymMissing = "+++MISSING+++"
'https://support.office.com/en-us/article/CallByName-fonction-49ce9475-c315-4f13-8d35-e98cfe98729a 'https://support.office.com/en-us/article/CallByName-fonction-49ce9475-c315-4f13-8d35-e98cfe98729a
'Determines the pvCallType 'Determines the pvCallType
@@ -124,15 +124,15 @@ Const vbGet = 2, vbLet = 4, vbMethod = 1, vbSet = 8, vbUNO = 16
vArg = Empty vArg = Empty
ElseIf vArg = cstSymNull Then ElseIf vArg = cstSymNull Then
vArg = Null vArg = Null
ElseIf vArg = cstSymMissing Then
Exit For ' Next arguments must be missing also
Else Else
vArg = _CDate(vArg) vArg = _CDate(vArg)
End If End If
End If End If
If Not IsEmpty(vArg) Then iNbArgs = iNbArgs + 1
iNbArgs = iNbArgs + 1 ReDim Preserve vArgs(iNbArgs)
ReDim Preserve vArgs(iNbArgs) vArgs(iNbArgs) = vArg
vArgs(iNbArgs) = vArg
End If
Next i Next i
End If End If
@@ -222,10 +222,6 @@ Const vbGet = 2, vbLet = 4, vbMethod = 1, vbSet = 8, vbUNO = 16
If vObject._Type = "COLLECTION" And vObject._CollType = COLLTABLEDEFS Then vArgs = Array(_A2B_.PythonCache(vArgs(0))) If vObject._Type = "COLLECTION" And vObject._CollType = COLLTABLEDEFS Then vArgs = Array(_A2B_.PythonCache(vArgs(0)))
Case "Close" Case "Close"
sSCript = "mClose" sSCript = "mClose"
Case "Find"
For i = 0 To UBound(vArgs)
If IsNull(vArgs(i)) Then vArgs(i) = Empty
Next i
Case "Type" Case "Type"
sScript = "pType" sScript = "pType"
Case Else Case Else

47
wizards/source/access2base/access2base.py
View File

@@ -73,6 +73,7 @@ class acConstants(object, metaclass = _Singleton):
# ----------------------------------------------------------------- # -----------------------------------------------------------------
Empty = '+++EMPTY+++' Empty = '+++EMPTY+++'
Null = '+++NULL+++' Null = '+++NULL+++'
Missing = '+++MISSING+++'
FromIsoFormat = '%Y-%m-%d %H:%M:%S' # To be used with datetime.datetime.strptime() FromIsoFormat = '%Y-%m-%d %H:%M:%S' # To be used with datetime.datetime.strptime()
# AcCloseSave # AcCloseSave
@@ -684,19 +685,19 @@ class Application(object, metaclass = _Singleton):
basicmodule = -1 basicmodule = -1
@classmethod @classmethod
def AllDialogs(cls, dialog = None): def AllDialogs(cls, dialog = acConstants.Missing):
return cls.W(_vbMethod, cls.basicmodule, 'AllDialogs', dialog) return cls.W(_vbMethod, cls.basicmodule, 'AllDialogs', dialog)
@classmethod @classmethod
def AllForms(cls, form = None): def AllForms(cls, form = acConstants.Missing):
return cls.W(_vbMethod, cls.basicmodule, 'AllForms', form) return cls.W(_vbMethod, cls.basicmodule, 'AllForms', form)
@classmethod @classmethod
def AllModules(cls, module = None): def AllModules(cls, module = acConstants.Missing):
return cls.W(_vbMethod, cls.basicmodule, 'AllModules', module) return cls.W(_vbMethod, cls.basicmodule, 'AllModules', module)
@classmethod @classmethod
def CloseConnection(cls): def CloseConnection(cls):
return cls.W(_vbMethod, cls.basicmodule, 'CloseConnection') return cls.W(_vbMethod, cls.basicmodule, 'CloseConnection')
@classmethod @classmethod
def CommandBars(cls, bar = None): def CommandBars(cls, bar = acConstants.Missing):
return cls.W(_vbMethod, cls.basicmodule, 'CommandBars', bar) return cls.W(_vbMethod, cls.basicmodule, 'CommandBars', bar)
@classmethod @classmethod
def CurrentDb(cls): def CurrentDb(cls):
@@ -738,7 +739,7 @@ class Application(object, metaclass = _Singleton):
def Events(cls, event): def Events(cls, event):
return cls.W(_vbMethod, cls.basicmodule, 'Events', event) return cls.W(_vbMethod, cls.basicmodule, 'Events', event)
@classmethod @classmethod
def Forms(cls, form = None): def Forms(cls, form = acConstants.Missing):
return cls.W(_vbMethod, cls.basicmodule, 'Forms', form) return cls.W(_vbMethod, cls.basicmodule, 'Forms', form)
@classmethod @classmethod
def getObject(cls, shortcut): def getObject(cls, shortcut):
@@ -752,7 +753,7 @@ class Application(object, metaclass = _Singleton):
def HtmlEncode(cls, string, length = 0): def HtmlEncode(cls, string, length = 0):
return cls.W(_vbMethod, cls.basicmodule, 'HtmlEncode', string, length) return cls.W(_vbMethod, cls.basicmodule, 'HtmlEncode', string, length)
@classmethod @classmethod
def OpenConnection(cls, thisdatabasedocument = None): def OpenConnection(cls, thisdatabasedocument = acConstants.Missing):
global THISDATABASEDOCUMENT global THISDATABASEDOCUMENT
if COMPONENTCONTEXT == None: A2BConnect() # Connection from inside LibreOffice is done at first API invocation if COMPONENTCONTEXT == None: A2BConnect() # Connection from inside LibreOffice is done at first API invocation
if DESKTOP != None: if DESKTOP != None:
@@ -773,7 +774,7 @@ class Application(object, metaclass = _Singleton):
def SysCmd(cls, action, text = '', value = -1): def SysCmd(cls, action, text = '', value = -1):
return cls.W(_vbMethod, cls.basicmodule, 'SysCmd', action, text, value) return cls.W(_vbMethod, cls.basicmodule, 'SysCmd', action, text, value)
@classmethod @classmethod
def TempVars(cls, var = None): def TempVars(cls, var = acConstants.Missing):
return cls.W(_vbMethod, cls.basicmodule, 'TempVars', var) return cls.W(_vbMethod, cls.basicmodule, 'TempVars', var)
@classmethod @classmethod
def Version(cls): def Version(cls):
@@ -1049,15 +1050,15 @@ class _BasicObject(object):
def Dispose(self): def Dispose(self):
return self.W(_vbMethod, self.objectreference, 'Dispose') return self.W(_vbMethod, self.objectreference, 'Dispose')
def getProperty(self, propertyname, index = None): def getProperty(self, propertyname, index = acConstants.Missing):
return self.W(_vbMethod, self.objectreference, 'getProperty', propertyname, index) return self.W(_vbMethod, self.objectreference, 'getProperty', propertyname, index)
GetProperty = getProperty GetProperty = getProperty
def hasProperty(self, propertyname): def hasProperty(self, propertyname):
return propertyname in tuple(self.classProperties.keys()) return propertyname in tuple(self.classProperties.keys())
HasProperty = hasProperty HasProperty = hasProperty
def Properties(self, index = acConstants.Empty): def Properties(self, index = acConstants.Missing):
return self.W(_vbMethod, self.objectreference, 'Properties', index) return self.W(_vbMethod, self.objectreference, 'Properties', index)
def setProperty(self, propertyname, value, index = None): def setProperty(self, propertyname, value, index = acConstants.Missing):
if self.hasProperty(propertyname): if self.hasProperty(propertyname):
if self.W(_vbMethod, self.objectreference, 'setProperty', propertyname, value, index): if self.W(_vbMethod, self.objectreference, 'setProperty', propertyname, value, index):
return self.__setattr__(propertyname, value) return self.__setattr__(propertyname, value)
@@ -1085,7 +1086,7 @@ class _Collection(_BasicObject):
def __len__(self): def __len__(self):
return self.count return self.count
def Add(self, table, value = None): def Add(self, table, value = acConstants.Missing):
if isinstance(table, _BasicObject): # Add method applied to a TABLEDEFS collection if isinstance(table, _BasicObject): # Add method applied to a TABLEDEFS collection
return self.W(_vbMethod, self.objectreference, 'Add', table.objectreference) return self.W(_vbMethod, self.objectreference, 'Add', table.objectreference)
else: # Add method applied to a TEMPVARS collection else: # Add method applied to a TEMPVARS collection
@@ -1109,7 +1110,7 @@ class _Collection(_BasicObject):
class _CommandBar(_BasicObject): class _CommandBar(_BasicObject):
classProperties = dict(BuiltIn = False, Parent = False, Visible = True) classProperties = dict(BuiltIn = False, Parent = False, Visible = True)
def CommandBarControls(self, index = acConstants.Empty): def CommandBarControls(self, index = acConstants.Missing):
return self.W(_vbMethod, self.objectreference, 'CommandBarControls', index) return self.W(_vbMethod, self.objectreference, 'CommandBarControls', index)
def Reset(self): def Reset(self):
return self.W(_vbMethod, self.objectreference, 'Reset') return self.W(_vbMethod, self.objectreference, 'Reset')
@@ -1154,7 +1155,7 @@ class _Control(_BasicObject):
self._Reset('ItemData') self._Reset('ItemData')
self._Reset('ListCount') self._Reset('ListCount')
return basicreturn return basicreturn
def Controls(self, index = acConstants.Empty): def Controls(self, index = acConstants.Missing):
return self.W(_vbMethod, self.objectreference, 'Controls', index) return self.W(_vbMethod, self.objectreference, 'Controls', index)
# Overrides method in parent class: list of properties is strongly control type dependent # Overrides method in parent class: list of properties is strongly control type dependent
def hasProperty(self, propertyname): def hasProperty(self, propertyname):
@@ -1224,13 +1225,13 @@ class _Database(_BasicObject):
if objecttype == acConstants.acOutputForm: encoding = 0 if objecttype == acConstants.acOutputForm: encoding = 0
return self.W(_vbMethod, self.objectreference, 'OutputTo', objecttype, objectname, outputformat, outputfile return self.W(_vbMethod, self.objectreference, 'OutputTo', objecttype, objectname, outputformat, outputfile
, autostart, templatefile, encoding, quality) , autostart, templatefile, encoding, quality)
def QueryDefs(self, index = acConstants.Empty): def QueryDefs(self, index = acConstants.Missing):
return self.W(_vbMethod, self.objectreference, 'QueryDefs', index) return self.W(_vbMethod, self.objectreference, 'QueryDefs', index)
def Recordsets(self, index = acConstants.Empty): def Recordsets(self, index = acConstants.Missing):
return self.W(_vbMethod, self.objectreference, 'Recordsets', index) return self.W(_vbMethod, self.objectreference, 'Recordsets', index)
def RunSQL(self, SQL, option = -1): def RunSQL(self, SQL, option = -1):
return self.W(_vbMethod, self.objectreference, 'RunSQL', SQL, option) return self.W(_vbMethod, self.objectreference, 'RunSQL', SQL, option)
def TableDefs(self, index = acConstants.Empty): def TableDefs(self, index = acConstants.Missing):
return self.W(_vbMethod, self.objectreference, 'TableDefs', index) return self.W(_vbMethod, self.objectreference, 'TableDefs', index)
@@ -1309,7 +1310,7 @@ class _Form(_BasicObject):
def Close(self): def Close(self):
return self.W(_vbMethod, self.objectreference, 'Close') return self.W(_vbMethod, self.objectreference, 'Close')
def Controls(self, index = acConstants.Empty): def Controls(self, index = acConstants.Missing):
return self.W(_vbMethod, self.objectreference, 'Controls', index) return self.W(_vbMethod, self.objectreference, 'Controls', index)
def Move(self, left = -1, top = -1, width = -1, height = -1): def Move(self, left = -1, top = -1, width = -1, height = -1):
return self.W(_vbMethod, self.objectreference, 'Move', left, top, width, height) return self.W(_vbMethod, self.objectreference, 'Move', left, top, width, height)
@@ -1363,7 +1364,7 @@ class _Module(_BasicObject):
class _OptionGroup(_BasicObject): class _OptionGroup(_BasicObject):
classProperties = dict(Count = False, Value = True) classProperties = dict(Count = False, Value = True)
def Controls(self, index = acConstants.Empty): def Controls(self, index = acConstants.Missing):
return self.W(_vbMethod, self.objectreference, 'Controls', index) return self.W(_vbMethod, self.objectreference, 'Controls', index)
@@ -1377,9 +1378,9 @@ class _QueryDef(_BasicObject):
@property @property
def Query(self): return self.W(_vbUNO, self.objectreference, 'Query') def Query(self): return self.W(_vbUNO, self.objectreference, 'Query')
def Execute(self, options = acConstants.Empty): def Execute(self, options = acConstants.Missing):
return self.W(_vbMethod, self.objectreference, 'Execute', options) return self.W(_vbMethod, self.objectreference, 'Execute', options)
def Fields(self, index = acConstants.Empty): def Fields(self, index = acConstants.Missing):
return self.W(_vbMethod, self.objectreference, 'Fields', index) return self.W(_vbMethod, self.objectreference, 'Fields', index)
def OpenRecordset(self, type = -1, option = -1, lockedit = -1): def OpenRecordset(self, type = -1, option = -1, lockedit = -1):
return self.W(_vbMethod, self.objectreference, 'OpenRecordset', type, option, lockedit) return self.W(_vbMethod, self.objectreference, 'OpenRecordset', type, option, lockedit)
@@ -1405,11 +1406,11 @@ class _Recordset(_BasicObject):
return self._Reset('RecordCount',self.W(_vbMethod, self.objectreference, 'Delete')) return self._Reset('RecordCount',self.W(_vbMethod, self.objectreference, 'Delete'))
def Edit(self): def Edit(self):
return self.W(_vbMethod, self.objectreference, 'Edit') return self.W(_vbMethod, self.objectreference, 'Edit')
def Fields(self, index = acConstants.Empty): def Fields(self, index = acConstants.Missing):
return self.W(_vbMethod, self.objectreference, 'Fields', index) return self.W(_vbMethod, self.objectreference, 'Fields', index)
def GetRows(self, numrows): def GetRows(self, numrows):
return self.W(_vbMethod, self.objectreference, 'GetRows', numrows) return self.W(_vbMethod, self.objectreference, 'GetRows', numrows)
def Move(self, rows, startbookmark = acConstants.Empty): def Move(self, rows, startbookmark = acConstants.Missing):
return self._Reset('BOF', self.W(_vbMethod, self.objectreference, 'Move', rows, startbookmark)) return self._Reset('BOF', self.W(_vbMethod, self.objectreference, 'Move', rows, startbookmark))
def MoveFirst(self): def MoveFirst(self):
return self._Reset('BOF', self.W(_vbMethod, self.objectreference, 'MoveFirst')) return self._Reset('BOF', self.W(_vbMethod, self.objectreference, 'MoveFirst'))
@@ -1447,7 +1448,7 @@ class _TableDef(_BasicObject):
def CreateField(self, name, type, size = 0, attributes = 0): def CreateField(self, name, type, size = 0, attributes = 0):
return self.W(_vbMethod, self.objectreference, 'CreateField', name, type, size, attributes) return self.W(_vbMethod, self.objectreference, 'CreateField', name, type, size, attributes)
def Fields(self, index = acConstants.Empty): def Fields(self, index = acConstants.Missing):
return self.W(_vbMethod, self.objectreference, 'Fields', index) return self.W(_vbMethod, self.objectreference, 'Fields', index)
def OpenRecordset(self, type = -1, option = -1, lockedit = -1): def OpenRecordset(self, type = -1, option = -1, lockedit = -1):
return self.W(_vbMethod, self.objectreference, 'OpenRecordset', type, option, lockedit) return self.W(_vbMethod, self.objectreference, 'OpenRecordset', type, option, lockedit)