Linter fix

Author: ghbm-itk

ITK_dev_shared_components/SAP/gridview_util.py

@@ -1,4 +1,4 @@
-"""This module provides static functions to peform common tasks with SAP GuiGridView COM objects."""
+"""This module provides static functions to perform common tasks with SAP GuiGridView COM objects."""
 
 def scroll_entire_table(grid_view, return_to_top=False) -> None:
     """This function scrolls through the entire table to load all cells.
@@ -9,13 +9,13 @@ def scroll_entire_table(grid_view, return_to_top=False) -> None:
 
     Returns:
         _type_: _description_
-    """    
+    """
     if grid_view.RowCount == 0 or grid_view.VisibleRowCount == 0:
         return
-    
+
     for i in range(0, grid_view.RowCount, grid_view.VisibleRowCount):
         grid_view.FirstVisibleRow = i
-    
+
     if return_to_top:
         grid_view.FirstVisibleRow = 0
 
@@ -30,7 +30,7 @@ def get_all_rows(grid_view, pre_load=True) -> tuple[tuple[str]]:
 
     Returns:
         tuple[tuple[str]]: A 2D tuple of all cell values in the gridview.
-    """    
+    """
 
     if pre_load:
         scroll_entire_table(grid_view, True)
@@ -45,9 +45,9 @@ def get_all_rows(grid_view, pre_load=True) -> tuple[tuple[str]]:
         for c in columns:
             v = grid_view.GetCellValue(r, c)
             row_data.append(v)
-        
+
         output.append(tuple(row_data))
-    
+
     return tuple(output)
 
 
@@ -62,7 +62,7 @@ def get_row(grid_view, row:int, scroll_to_row=False) -> tuple[str]:
 
     Returns:
         tuple[str]: A tuple of the row's data.
-    """    
+    """
 
     if scroll_to_row:
         grid_view.FirstVisibleRow = row
@@ -85,7 +85,7 @@ def iterate_rows(grid_view) -> tuple[str]:
 
     Yields:
         tuple[str]: A tuple of the next row's data.
-    """    
+    """
 
     row = 0
     while row < grid_view.RowCount:
@@ -106,7 +106,7 @@ def get_column_titles(grid_view) -> tuple[str]:
 
     Returns:
         tuple[str]: A tuple of the gridview's column titles.
-    """    
+    """
 
     return tuple(grid_view.GetColumnTitles(c)[0] for c in grid_view.ColumnOrder)
 
@@ -125,7 +125,7 @@ def find_row_index_by_value(grid_view, column:str, value:str) -> int:
 
     Returns:
         int: The index of the first row which column value matches the given value.
-    """    
+    """
 
     if column not in grid_view.ColumnOrder:
         raise ValueError(f"Column '{column}' not in grid_view")
@@ -134,14 +134,14 @@ def find_row_index_by_value(grid_view, column:str, value:str) -> int:
         # Only scroll when row isn't visible
         if not grid_view.FirstVisibleRow <= row <= grid_view.FirstVisibleRow + grid_view.VisibleRowCount-1:
             grid_view.FirstVisibleRow = row
-        
+
         if grid_view.GetCellValue(row, column) == value:
             return row
-    
+
     return -1
 
-def find_all_row_indecies_by_value(grid_view, column:str, value:str) -> list[int]:
-    """Find all indecies of the rows where the given column's value
+def find_all_row_indices_by_value(grid_view, column:str, value:str) -> list[int]:
+    """Find all indices of the rows where the given column's value
     match the given value. Returns an empty list if no row is found.
 
     Args:
@@ -153,8 +153,8 @@ def find_all_row_indecies_by_value(grid_view, column:str, value:str) -> list[int
         ValueError: If the column name doesn't exist in the grid view.
 
     Returns:
-        list[int]: A list of row indecies where the value matches.
-    """    
+        list[int]: A list of row indices where the value matches.
+    """
     if column not in grid_view.ColumnOrder:
         raise ValueError(f"Column '{column}' not in grid_view")
 
@@ -164,39 +164,8 @@ def find_all_row_indecies_by_value(grid_view, column:str, value:str) -> list[int
         # Only scroll when row isn't visible
         if not grid_view.FirstVisibleRow <= row <= grid_view.FirstVisibleRow + grid_view.VisibleRowCount-1:
             grid_view.FirstVisibleRow = row
-        
+
         if grid_view.GetCellValue(row, column) == value:
             rows.append(row)
-    
-    return rows
-    
-
-
-
-if __name__=='__main__':
-    import win32com.client
-
-    SAP = win32com.client.GetObject("SAPGUI")
-    app = SAP.GetScriptingEngine
-    connection = app.Connections(0)
-    session = connection.Sessions(0)
-
-    table = session.findById("wnd[0]/usr/cntlGRID1/shellcont/shell")
-    
-    rows = find_all_row_indecies_by_value(table, "ZZ_PARTNER", '15879880')
-    print(rows)
-    table.setCurrentCell(rows[0], "ZZ_PARTNER")
-
-    # print(get_row(table, 1, True))
-
-    # scroll_entire_table(table)
-
-    # data = get_all_rows(table)
-    # print(len(data), len(data[0]))
-
-    # for r in iterate_rows(table):
-    #     print(r)
-    
-    # print(get_column_titles(table))
-    
 
+    return rows

ITK_dev_shared_components/SAP/multi_session.py

@@ -6,29 +6,31 @@
 import threading
 import math
 from typing import Callable
+
 import pythoncom
 import win32com.client
 import win32gui
 
 def run_with_session(session_index:int, func:Callable, args:tuple) -> None:
-    """Run a function in a sepcific session based on the sessions index.
-    This function is meant to be run inside a seperate thread.
+    """Run a function in a specific session based on the sessions index.
+    This function is meant to be run inside a separate thread.
     The function must take a session object as its first argument.
     Note that this function will not spawn the sessions before running,
     use spawn_sessions to do that.
     """
 
     pythoncom.CoInitialize()
 
-    SAP = win32com.client.GetObject("SAPGUI")
-    app = SAP.GetScriptingEngine
+    sap = win32com.client.GetObject("SAPGUI")
+    app = sap.GetScriptingEngine
     connection = app.Connections(0)
     session = connection.Sessions(session_index)
 
     func(session, *args)
 
     pythoncom.CoUninitialize()
 
+
 def run_batch(func:Callable, args:tuple[tuple], num_sessions=6) -> None:
     """Run a function in parallel sessions.
     The function will be run {num_sessions} times with args[i] as input.
@@ -41,7 +43,7 @@ def run_batch(func:Callable, args:tuple[tuple], num_sessions=6) -> None:
     for i in range(num_sessions):
         t = ExThread(target=run_with_session, args=(i, func, args[i]))
         threads.append(t)
-    
+
     for t in threads:
         t.start()
     for t in threads:
@@ -50,6 +52,7 @@ def run_batch(func:Callable, args:tuple[tuple], num_sessions=6) -> None:
         if t.error:
             raise t.error
 
+
 def run_batches(func:Callable, args:tuple[tuple], num_sessions=6):
     """Run a function in parallel batches.
     This function runs the input function for each set of arguments in args.
@@ -63,6 +66,7 @@ def run_batches(func:Callable, args:tuple[tuple], num_sessions=6):
         batch = args[b:b+num_sessions]
         run_batch(func, args, len(batch))
 
+
 def spawn_sessions(num_sessions=6) -> tuple:
     """A function to spawn multiple sessions of SAP.
     This function will attempt to spawn the desired number of sessions.
@@ -78,10 +82,10 @@ def spawn_sessions(num_sessions=6) -> tuple:
 
     Returns:
         tuple: A tuple of all currently open sessions.
-    """    
+    """
 
-    SAP = win32com.client.GetObject("SAPGUI")
-    app = SAP.GetScriptingEngine
+    sap = win32com.client.GetObject("SAPGUI")
+    app = sap.GetScriptingEngine
     connection = app.Connections(0)
     session = connection.Sessions(0)
 
@@ -92,7 +96,7 @@ def spawn_sessions(num_sessions=6) -> tuple:
 
     for _ in range(num_sessions - connection.Sessions.count):
         session.CreateSession()
-    
+
     # Wait for the sessions to spawn
     while connection.Sessions.count < num_sessions:
         time.sleep(0.1)
@@ -113,20 +117,22 @@ def spawn_sessions(num_sessions=6) -> tuple:
         x = i % c * w
         y = i // c * h
         win32gui.MoveWindow(hwnd, x, y, w, h, True)
-    
+
     return sessions
 
-def get_all_SAP_sessions() -> tuple:
+
+def get_all_SAP_sessions() -> tuple: # pylint: disable=invalid-name
     """Returns a tuple of all open SAP sessions (on connection index 0).
 
     Returns:
         tuple: A tuple of SAP GuiSession objects.
     """
-    SAP = win32com.client.GetObject("SAPGUI")
-    app = SAP.GetScriptingEngine
+    sap = win32com.client.GetObject("SAPGUI")
+    app = sap.GetScriptingEngine
     connection = app.Connections(0)
     return tuple(connection.Sessions)
 
+
 class ExThread(threading.Thread):
     """A thread with a handle to get an exception raised inside the thread: ExThread.error"""
     def __init__(self, *args, **kwargs):
@@ -138,5 +144,3 @@ def run(self):
             self._target(*self._args, **self._kwargs)
         except Exception as e: # pylint: disable=broad-exception-caught
             self.error = e
-
-

ITK_dev_shared_components/SAP/opret_kundekontakt.py

@@ -1,12 +1,12 @@
-"""This module provides a single function to conviniently peform the action 'opret-kundekontaker' in SAP."""
+"""This module provides a single function to conveniently peform the action 'opret-kundekontaker' in SAP."""
 
 from typing import Literal
 import win32clipboard
 from ITK_dev_shared_components.SAP import tree_util
 
 
-def opret_kundekontakter(session, fp:str, aftaler:list[str] | None, 
-                         art:Literal[' ', 'Automatisk', 'Fakturagrundlag', 'Fuldmagt ifm. værge', 'Konverteret', 'Myndighedshenvend.', 'Orientering', 'Returpost', 'Ringeaktivitet', 'Skriftlig henvend.', 'Telefonisk henvend.'], 
+def opret_kundekontakter(session, fp:str, aftaler:list[str] | None,
+                         art:Literal[' ', 'Automatisk', 'Fakturagrundlag', 'Fuldmagt ifm. værge', 'Konverteret', 'Myndighedshenvend.', 'Orientering', 'Returpost', 'Ringeaktivitet', 'Skriftlig henvend.', 'Telefonisk henvend.'],
                          notat:str, lock=None) -> None:
     """Creates a kundekontakt on the given FP and aftaler.
 
@@ -41,33 +41,25 @@ def opret_kundekontakter(session, fp:str, aftaler:list[str] | None,
 
     # Go to editor and paste (lock if multithreaded)
     session.findById("wnd[0]/usr/subNOTICE:SAPLEENO:1002/btnEENO_TEXTE-EDITOR").press()
-    if lock: 
+    if lock:
         lock.acquire()
-    _setClipboard(notat)
+    _set_clipboard(notat)
     session.findById("wnd[0]/tbar[1]/btn[9]").press()
-    if lock: 
+    if lock:
         lock.release()
 
     # Back and save
     session.findById("wnd[0]/tbar[0]/btn[3]").press()
     session.findById("wnd[0]/tbar[0]/btn[11]").press()
 
 
-def _setClipboard(text:str) -> None:
+def _set_clipboard(text:str) -> None:
+    """Private function to set text to the clipboard.
+
+    Args:
+        text: Text to set to clipboard.
+    """
     win32clipboard.OpenClipboard()
     win32clipboard.EmptyClipboard()
     win32clipboard.SetClipboardText(text)
     win32clipboard.CloseClipboard()
-
-
-if __name__ == '__main__':
-    from ITK_dev_shared_components.SAP import multi_session
-    from datetime import datetime
-
-    session = multi_session.spawn_sessions(1)[0]
-    fp = '25564617'
-    aftaler = ['2291987', '2421562', '2311094']
-    art = 'Orientering'
-    notat = 'Test '+ str(datetime.now())
-
-    opret_kundekontakter(session, fp, aftaler, 'Automatisk', notat)