xlOil Python

Contents

• xlOil Python Introduction
  • Introduction
  • Getting Started
    • My first xlOil module
    • My first workbook module
  • Using the Ribbon
  • Troubleshooting
  • Intellisense / Function Context Help
• xlOil Python Concepts
  • Workbook Modules
  • Array Functions
  • Events
    • Examples
  • Registering functions in other modules
  • Multiple addins and event loops
• xlOil Python Registering Functions
  • Local Functions
  • Async and RTD Functions
  • Commands, Macros & Subroutines
  • Multi-threaded functions
  • Dynamic Registration
    • More controlled registration
• xlOil Python Type Conversion
  • Argument Types
  • Return Types
  • Cached Objects
    • Cache Object Lifecycle
  • Dates
  • Dicts
  • Variable and Keyword Arguments
  • Range Arguments
  • Custom Type Conversion
  • Custom Return Conversion
  • Returning Images and Plots
• xlOil Python: The Excel.Application object
  • Introduction
  • Calling Worksheet Functions and Application.Run
  • xlOil’s Excel Object Model
  • Excel Automation
    • Creating an Application
  • Accessing Sheets and Ranges
    • Reading from a Range
    • Writing to a range
    • Using Worksheets and Workbooks
      • Writing to a worksheet
  • Pausing Excel Calculations
  • Troubleshooting
• xlOil Python GUI Customisation
  • Status Bar
  • Ribbon
    • Setting button images
  • Custom Task Panes
    • Thread-safety
    • Qt Custom Task Panes
      • Qt Thread-safety
    • Tkinter Custom Task Panes
      • Tkinter Thread-safety
    • wxPython Custom Task Panes
      • wxPython Thread-safety
    • Task Pane Events
    • Task Pane registry
  • Async GUI Calls
• xlOil Python Dynamic Runtime Interaction
  • Dynamic Import
  • Dynamic Registration
• xlOil Python Package Support
  • Pandas
  • Matplotlib
  • PIL / pillow
• xlOil Built-in Worksheet Functions
  • xloPyLoad: import and scan a python module (worksheet function)
    • xloImport()
    • xloAttr()
    • xloAttrObj()
    • xloPyDebug()
• xlOil Jupyter Interaction
  • Introduction
  • Registering an Excel function from Jupyter
  • Watching a variable in a Jupyter notebook
  • Running code in the kernel
  • Examples
  • Using COM Automation
  • Limitations
• xlOil Python Async/Rtd
  • Introduction
  • Improving RTD performance (specifying topics)
  • xlOil’s RTD Interface
• xlOil Python Debugging
  • Visual Studio
  • VS Code
  • Pdb
  • Selecting the debugger programmatically
• xlOil Python Distribution and Packaging
  • Creating an Addin
  • Packaging Python
    • Customising the packaging
• xlOil Python Examples
• xlOil Python GUI Examples
• xlOil Python RTD Examples
• xlOil Python Questions
  • ImportError: Typelib different than module
  • Intellisense / Function Context Help
  • Auto-reload doesn’t reload a module
  • Dynamically Resized Arrays
  • This application failed to start because it could not find or load the Qt platform plugin “windows”
  • win32com / pythoncom: <some CLSID> has no attribute ‘CLSIDToClassMap’
  • Could not connect COM: trying again in 1 second
• xlOil Python Module Reference
  • Declaring Worksheet Functions
    • Arg
      • Arg.KEYWORD_ARGS
      • Arg.POSITIONAL
      • Arg.VARIABLE_ARGS
      • Arg.from_signature()
      • Arg.full_argspec()
      • Arg.has_default
      • Arg.override_arglist()
    • Array
    • Cache
    • CannotConvert
    • CellError
      • CellError.DIV
      • CellError.GETTING_DATA
      • CellError.NA
      • CellError.NAME
      • CellError.NULL
      • CellError.NUM
      • CellError.REF
      • CellError.VALUE
      • CellError.name
      • CellError.value
    • ExcelArray
      • ExcelArray.dims
      • ExcelArray.ncols
      • ExcelArray.nrows
      • ExcelArray.shape
      • ExcelArray.slice()
      • ExcelArray.to_numpy()
    • FastArray
    • SingleValue
    • converter()
    • deregister_functions()
    • func()
    • import_functions()
    • register_functions()
    • returner()
    • scan_module()
    • AllowRange
  • Excel Object Model
    • workbooks
    • worksheets
    • app()
    • active_worksheet()
    • active_workbook()
    • Application
      • Application.__enter__()
      • Application.__exit__()
      • Application.calculate()
      • Application.enable_events
      • Application.open()
      • Application.quit()
      • Application.range()
      • Application.to_com()
      • Application.visible
      • Application.windows
      • Application.workbook_paths
      • Application.workbooks
    • Caller
      • Caller.address()
      • Caller.sheet
      • Caller.workbook
    • Range
      • Range.__getitem__()
      • Range.address()
      • Range.bounds
      • Range.cell()
      • Range.clear()
      • Range.formula
      • Range.ncols
      • Range.nrows
      • Range.offset()
      • Range.parent
      • Range.range()
      • Range.set()
      • Range.set_formula()
      • Range.shape
      • Range.to_com()
      • Range.trim()
      • Range.value
    • Workbook
      • Workbook.__getitem__()
      • Workbook.add()
      • Workbook.app
      • Workbook.close()
      • Workbook.name
      • Workbook.path
      • Workbook.range()
      • Workbook.save()
      • Workbook.to_com()
      • Workbook.windows
      • Workbook.worksheet()
      • Workbook.worksheets
    • Worksheet
      • Worksheet.__getitem__()
      • Worksheet.activate()
      • Worksheet.app
      • Worksheet.at()
      • Worksheet.calculate()
      • Worksheet.cell()
      • Worksheet.name
      • Worksheet.parent
      • Worksheet.range()
      • Worksheet.to_com()
      • Worksheet.used_range
    • ExcelWindow
      • ExcelWindow.app
      • ExcelWindow.hwnd
      • ExcelWindow.name
      • ExcelWindow.to_com()
      • ExcelWindow.workbook
    • ExcelWindows
      • ExcelWindows.active
      • ExcelWindows.get()
    • Workbooks
      • Workbooks.active
      • Workbooks.add()
      • Workbooks.get()
    • Worksheets
      • Worksheets.active
      • Worksheets.add()
      • Worksheets.get()
    • PauseExcel
  • RTD Functions
    • RtdPublisher
      • RtdPublisher.connect()
      • RtdPublisher.disconnect()
      • RtdPublisher.done()
      • RtdPublisher.stop()
      • RtdPublisher.topic
    • RtdServer
      • RtdServer.drop()
      • RtdServer.peek()
      • RtdServer.progid
      • RtdServer.publish()
      • RtdServer.start()
      • RtdServer.start_task()
      • RtdServer.subscribe()
    • RtdSimplePublisher
      • RtdSimplePublisher.connect()
      • RtdSimplePublisher.disconnect()
      • RtdSimplePublisher.done()
      • RtdSimplePublisher.stop()
      • RtdSimplePublisher.topic()
    • subscribe()
  • GUI Interaction
    • StatusBar
      • StatusBar.msg()
    • ExcelGUI
      • ExcelGUI.activate()
      • ExcelGUI.attach_pane()
      • ExcelGUI.attach_pane_async()
      • ExcelGUI.connect()
      • ExcelGUI.connected
      • ExcelGUI.create_task_pane()
      • ExcelGUI.disconnect()
      • ExcelGUI.invalidate()
      • ExcelGUI.name
    • TaskPaneFrame
      • TaskPaneFrame.attach()
      • TaskPaneFrame.com_control()
      • TaskPaneFrame.position
      • TaskPaneFrame.size
      • TaskPaneFrame.title
      • TaskPaneFrame.visible
      • TaskPaneFrame.window
    • RibbonControl
      • RibbonControl.id
      • RibbonControl.tag
    • CustomTaskPane
      • CustomTaskPane.on_destroy()
      • CustomTaskPane.pane
      • CustomTaskPane.position
      • CustomTaskPane.size
      • CustomTaskPane.visible
    • find_task_pane()
    • QtExecutor
      • QtExecutor.app
      • QtExecutor.map()
      • QtExecutor.shutdown()
      • QtExecutor.submit()
      • QtExecutor.submit_async()
    • QtThreadTaskPane
      • QtThreadTaskPane.on_destroy()
      • QtThreadTaskPane.pane
      • QtThreadTaskPane.position
      • QtThreadTaskPane.size
      • QtThreadTaskPane.visible
      • QtThreadTaskPane.widget
    • Qt_thread()
    • TkExecutor
      • TkExecutor.map()
      • TkExecutor.shutdown()
      • TkExecutor.submit()
      • TkExecutor.submit_async()
    • TkThreadTaskPane
      • TkThreadTaskPane.on_destroy()
      • TkThreadTaskPane.pane
      • TkThreadTaskPane.position
      • TkThreadTaskPane.size
      • TkThreadTaskPane.top_level
      • TkThreadTaskPane.visible
    • Tk_thread()
    • WxExecutor
      • WxExecutor.map()
      • WxExecutor.shutdown()
      • WxExecutor.submit()
      • WxExecutor.submit_async()
    • WxThreadTaskPane
      • WxThreadTaskPane.frame
      • WxThreadTaskPane.on_destroy()
      • WxThreadTaskPane.pane
      • WxThreadTaskPane.position
      • WxThreadTaskPane.size
      • WxThreadTaskPane.visible
    • wx_thread()
  • Events
    • Using the Event Class
    • Python-only Events
    • Examples
    • Event
      • Event.add()
      • Event.clear()
      • Event.handlers
      • Event.remove()
    • pause()
    • allow()
    • AfterCalculate
    • WorkbookOpen
    • NewWorkbook
    • SheetSelectionChange
    • SheetBeforeDoubleClick
    • SheetBeforeRightClick
    • SheetActivate
    • SheetDeactivate
    • SheetCalculate
    • SheetChange
    • WorkbookAfterClose
    • WorkbookRename
    • WorkbookActivate
    • WorkbookDeactivate
    • WorkbookBeforeClose
    • WorkbookBeforeSave
    • WorkbookAfterSave
    • WorkbookBeforePrint
    • WorkbookNewSheet
    • WorkbookAddinInstall
    • WorkbookAddinUninstall
    • XllAdd
    • XllRemove
    • ComAddinsUpdate
    • PyBye
    • UserException
  • Everything else
    • ObjectCache
      • ObjectCache.add()
      • ObjectCache.contains()
      • ObjectCache.get()
      • ObjectCache.keys()
      • ObjectCache.remove()
    • cache
    • call()
    • call_async()
    • core_addin()
    • excel_callback()
    • excel_state()
    • from_excel_date()
    • get_async_loop()
    • get_event_loop()
    • in_wizard()
    • linked_workbook()
    • run()
    • run_async()
    • source_addin()
    • source_addin()
    • date_formats
    • ExcelState
      • ExcelState.hinstance
      • ExcelState.hwnd
      • ExcelState.main_thread_id
      • ExcelState.version
    • Addin
      • Addin.async_slice
      • Addin.async_throttle
      • Addin.event_loop
      • Addin.functions()
      • Addin.pathname
      • Addin.settings
      • Addin.settings_file
    • xloil_addins
    • _AddinsDict
    • _DateFormatList
      • _DateFormatList.append()
      • _DateFormatList.clear()
      • _DateFormatList.count()
      • _DateFormatList.extend()
      • _DateFormatList.insert()
      • _DateFormatList.pop()
      • _DateFormatList.remove()
    • _LogWriter
      • _LogWriter.debug()
      • _LogWriter.error()
      • _LogWriter.flush()
      • _LogWriter.flush_on
      • _LogWriter.info()
      • _LogWriter.level
      • _LogWriter.level_int
      • _LogWriter.levels
      • _LogWriter.path
      • _LogWriter.trace()
      • _LogWriter.warn()
    • log
    • log_except()
    • use_debugger()
  • External libraries
    • insert_cell_image()
    • ReturnFigure