Feat: Migrate more methods to PyAnsys conventions (#266)

Author: jwinkle8

src/ansys/stk/core/internal/comevents.py

@@ -739,7 +739,7 @@ class _StkGraphicsSceneEventsUnkSink(Structure):
                  ("GetTypeInfoCount", c_void_p),
                  ("GetTypeInfo",      c_void_p),
                  ("GetIDsOfNames",    c_void_p),
-                 ("Invoke",           c_void_p),
+                 ("invoke",           c_void_p),
                  ("rendering",        c_void_p)]
 
 class ISceneEventCOMHandler(COMEventHandlerImpl):
@@ -818,7 +818,7 @@ class _StkGraphicsKmlGraphicsEventsUnkSink(Structure):
                  ("GetTypeInfoCount", c_void_p),
                  ("GetTypeInfo",      c_void_p),
                  ("GetIDsOfNames",    c_void_p),
-                 ("Invoke",           c_void_p),
+                 ("invoke",           c_void_p),
                  ("document_loaded",   c_void_p)]
 
 class IKmlGraphicsEventCOMHandler(COMEventHandlerImpl):
@@ -897,7 +897,7 @@ class _StkGraphicsImageCollectionEventsUnkSink(Structure):
                  ("GetTypeInfoCount", c_void_p),
                  ("GetTypeInfo",      c_void_p),
                  ("GetIDsOfNames",    c_void_p),
-                 ("Invoke",           c_void_p),
+                 ("invoke",           c_void_p),
                  ("add_complete",      c_void_p)]
 
 class IImageCollectionEventCOMHandler(COMEventHandlerImpl):
@@ -976,7 +976,7 @@ class _StkGraphicsTerrainCollectionEventsUnkSink(Structure):
                  ("GetTypeInfoCount", c_void_p),
                  ("GetTypeInfo",      c_void_p),
                  ("GetIDsOfNames",    c_void_p),
-                 ("Invoke",           c_void_p),
+                 ("invoke",           c_void_p),
                  ("add_complete",      c_void_p)]
 
 class ITerrainOverlayCollectionEventCOMHandler(COMEventHandlerImpl):

src/ansys/stk/core/internal/comutil.py

@@ -412,14 +412,14 @@ def __init__(self):
         self._applications = list()
 
     @staticmethod
-    def _ReleaseImpl(pUnk:"IUnknown"):
+    def _release_impl(pUnk:"IUnknown"):
         """Call Release in STK."""
-        _CreateAgObjectLifetimeManager._Release(pUnk._getVtblEntry(_CreateAgObjectLifetimeManager._ReleaseIndex))(pUnk.p)
+        _CreateAgObjectLifetimeManager._Release(pUnk._get_vtbl_entry(_CreateAgObjectLifetimeManager._ReleaseIndex))(pUnk.p)
 
     @staticmethod
-    def _AddRefImpl(pUnk:"IUnknown"):
+    def _add_ref_impl(pUnk:"IUnknown"):
         """Call AddRef in STK."""
-        _CreateAgObjectLifetimeManager._AddRef(pUnk._getVtblEntry(_CreateAgObjectLifetimeManager._AddRefIndex))(pUnk.p)
+        _CreateAgObjectLifetimeManager._AddRef(pUnk._get_vtbl_entry(_CreateAgObjectLifetimeManager._AddRefIndex))(pUnk.p)
 
     def create_ownership(self, pUnk:"IUnknown"):
         """
@@ -429,7 +429,7 @@ def create_ownership(self, pUnk:"IUnknown"):
         """
         ptraddress = pUnk.p.value
         if ptraddress is not None:
-            _CreateAgObjectLifetimeManager._AddRefImpl(pUnk)
+            _CreateAgObjectLifetimeManager._add_ref_impl(pUnk)
             self.take_ownership(pUnk, False)
 
     def take_ownership(self, pUnk:"IUnknown", isApplication=False):
@@ -444,19 +444,19 @@ def take_ownership(self, pUnk:"IUnknown", isApplication=False):
                 if isApplication:
                     self._applications.append(ptraddress)
                 if ptraddress in self._ref_counts:
-                    _CreateAgObjectLifetimeManager._ReleaseImpl(pUnk)
-                    self.InternalAddRef(pUnk)
+                    _CreateAgObjectLifetimeManager._release_impl(pUnk)
+                    self.internal_add_ref(pUnk)
                 else:
                     self._ref_counts[ptraddress] = 1
 
-    def InternalAddRef(self, pUnk:"IUnknown"):
+    def internal_add_ref(self, pUnk:"IUnknown"):
         """Increment the internal reference count of pUnk."""
         ptraddress = pUnk.p.value
         with _GCDisabler() as gc_lock:
             if ptraddress in self._ref_counts:
                 self._ref_counts[ptraddress] = self._ref_counts[ptraddress] + 1
 
-    def Release(self, pUnk:"IUnknown"):
+    def release(self, pUnk:"IUnknown"):
         """
         Decrements the internal reference count of pUnk.
         
@@ -467,12 +467,12 @@ def Release(self, pUnk:"IUnknown"):
             with _GCDisabler() as gc_lock:
                 if ptraddress in self._ref_counts:
                     if self._ref_counts[ptraddress] == 1:
-                        _CreateAgObjectLifetimeManager._ReleaseImpl(pUnk)
+                        _CreateAgObjectLifetimeManager._release_impl(pUnk)
                         del(self._ref_counts[ptraddress])
                     else:
                         self._ref_counts[ptraddress] = self._ref_counts[ptraddress] - 1
 
-    def ReleaseAll(self, releaseApplication=True):
+    def release_all(self, releaseApplication=True):
         with _GCDisabler() as gc_lock:
             preserved_app_ref_counts = dict()
             while len(self._ref_counts) > 0:
@@ -483,7 +483,7 @@ def ReleaseAll(self, releaseApplication=True):
                     continue
                 pUnk = IUnknown()
                 pUnk.p = c_void_p(ptraddress)
-                _CreateAgObjectLifetimeManager._ReleaseImpl(pUnk)
+                _CreateAgObjectLifetimeManager._release_impl(pUnk)
                 pUnk.p = c_void_p(0)
             self._ref_counts = preserved_app_ref_counts
 
@@ -528,26 +528,26 @@ class IUnknown(object):
     def __init__(self, pUnk=None):
         if pUnk is not None:
             self.p = pUnk.p
-            self.AddRef()
+            self.add_ref()
         else:
             self.p = c_void_p()
     def __del__(self):
         if self:
-            self.Release()
+            self.release()
     def __eq__(self, other):
         return self.p.value == other.p.value
     def __hash__(self):
         return self.p.value
     def __bool__(self):
         return self.p.value is not None and self.p.value > 0
-    def _getVtblEntry(self, index):
+    def _get_vtbl_entry(self, index):
         vptr = cast(self.p, POINTER(c_void_p))
         vtbl = cast(vptr.contents, POINTER(c_void_p))
         return vtbl[index]
     def query_interface(self, iid:GUID|str) -> "IUnknown":
         pIntf = IUnknown()
         if isinstance(iid, str): iid=GUID(iid)
-        hr = IUnknown._QueryInterface(self._getVtblEntry(IUnknown._QIIndex))(self.p, byref(iid), byref(pIntf.p))
+        hr = IUnknown._QueryInterface(self._get_vtbl_entry(IUnknown._QIIndex))(self.p, byref(iid), byref(pIntf.p))
         if not Succeeded(hr):
             return None
         pIntf.take_ownership()
@@ -558,18 +558,18 @@ def create_ownership(self):
     def take_ownership(self, isApplication=False):
         """Register the pointer to be Released when the ref count goes to zero but does not call AddRef."""
         ObjectLifetimeManager.take_ownership(self, isApplication) 
-    def AddRef(self):
+    def add_ref(self):
         """Increment the ref count if the pointer was registered.
         
         Pointer registration must be done by create_ownership or take_ownership.
         """
-        ObjectLifetimeManager.InternalAddRef(self)  
-    def Release(self):
+        ObjectLifetimeManager.internal_add_ref(self)  
+    def release(self):
         """Decrement the ref count if the pointer was registered. Calls Release if the ref count goes to zero.
         
         Pointer registration must be done by create_ownership or take_ownership.
         """
-        ObjectLifetimeManager.Release(self)   
+        ObjectLifetimeManager.release(self)   
 
     def invoke(self, intf_metatdata:dict, method_metadata:dict, *args):
         method_offset = intf_metatdata["method_offsets"][method_metadata["name"]]
@@ -601,9 +601,9 @@ def _invoke_impl(self, intf_metatdata:dict, method_metadata:dict, method_offset:
         call_args = []
         for marshaller, arg_type in zip(marshallers, arg_types):
             if type(arg_type) == type(POINTER(PVOID)): # type(POINTER(X)) == type(POINTER(Y)) for all X,Y. the choice of PVOID was arbitrary
-                call_args.append(byref(marshaller.COM_val))
+                call_args.append(byref(marshaller.com_val))
             else:
-                call_args.append(marshaller.COM_val)
+                call_args.append(marshaller.com_val)
         evaluate_hresult(method(*call_args))
         return_vals = []
         for arg, marshaller in zip(args, marshallers):
@@ -659,7 +659,7 @@ def __init__(self, pUnk, iid, method_index, *argtypes):
         self.index = method_index
         self.method = WINFUNCTYPE(HRESULT, LPVOID, *argtypes)
     def __call__(self, *args):
-        pIntf = self.pUnk.query_interface(self.iid)
-        ret = self.method(pIntf._getVtblEntry(self.index))(pIntf.p, *args)
+        pIntf: IUnknown = self.pUnk.query_interface(self.iid)
+        ret = self.method(pIntf._get_vtbl_entry(self.index))(pIntf.p, *args)
         del(pIntf)
         return ret

src/ansys/stk/core/internal/grpcevents.py

@@ -437,9 +437,9 @@ class IStkGraphicsSceneEventGrpcHandler(GrpcEventHandlerImpl):
 
     def __init__(self, interface:GrpcInterface, events:dict):
         GrpcEventHandlerImpl.__init__(self, interface, AgGrpcServices_pb2.EventHandler.eIAgStkGraphicsSceneEvents, events)
-        self._register_iadd_isub_callbacks("Rendering", self._Rendering)
+        self._register_iadd_isub_callbacks("Rendering", self._rendering)
 
-    def _Rendering(self, Sender:typing.Any, Args:"RenderingEventArgs") -> None:
+    def _rendering(self, Sender:typing.Any, Args:"RenderingEventArgs") -> None:
         for callback in self._events["Rendering"]._callbacks:
             try:
                 callback(Sender, Args)
@@ -455,9 +455,9 @@ class IStkGraphicsKmlGraphicsEventGrpcHandler(GrpcEventHandlerImpl):
 
     def __init__(self, interface:GrpcInterface, events:dict):
         GrpcEventHandlerImpl.__init__(self, interface, AgGrpcServices_pb2.EventHandler.eIAgStkGraphicsKmlGraphicsEvents, events)
-        self._register_iadd_isub_callbacks("DocumentLoaded", self._DocumentLoaded)
+        self._register_iadd_isub_callbacks("DocumentLoaded", self._document_loaded)
 
-    def _DocumentLoaded(self, Sender:typing.Any, Args:"KmlDocumentLoadedEventArgs") -> None:
+    def _document_loaded(self, Sender:typing.Any, Args:"KmlDocumentLoadedEventArgs") -> None:
         for callback in self._events["DocumentLoaded"]._callbacks:
             try:
                 callback(Sender, Args)
@@ -473,9 +473,9 @@ class IStkGraphicsImageCollectionEventGrpcHandler(GrpcEventHandlerImpl):
 
     def __init__(self, interface:GrpcInterface, events:dict):
         GrpcEventHandlerImpl.__init__(self, interface, AgGrpcServices_pb2.EventHandler.eIAgStkGraphicsImageCollectionEvents, events)
-        self._register_iadd_isub_callbacks("AddComplete", self._AddComplete)
+        self._register_iadd_isub_callbacks("AddComplete", self._add_complete)
 
-    def _AddComplete(self, Sender:typing.Any, Args:"GlobeImageOverlayAddCompleteEventArgs") -> None:
+    def _add_complete(self, Sender:typing.Any, Args:"GlobeImageOverlayAddCompleteEventArgs") -> None:
         for callback in self._events["AddComplete"]._callbacks:
             try:
                 callback(Sender, Args)
@@ -491,9 +491,9 @@ class IStkGraphicsTerrainCollectionEventGrpcHandler(GrpcEventHandlerImpl):
 
     def __init__(self, interface:GrpcInterface, events:dict):
         GrpcEventHandlerImpl.__init__(self, interface, AgGrpcServices_pb2.EventHandler.eIAgStkGraphicsTerrainCollectionEvents, events)
-        self._register_iadd_isub_callbacks("AddComplete", self._AddComplete)
+        self._register_iadd_isub_callbacks("AddComplete", self._add_complete)
 
-    def _AddComplete(self, Sender:typing.Any, Args:"TerrainOverlayAddCompleteEventArgs") -> None:
+    def _add_complete(self, Sender:typing.Any, Args:"TerrainOverlayAddCompleteEventArgs") -> None:
         for callback in self._events["AddComplete"]._callbacks:
             try:
                 callback(Sender, Args)