How to use Application.LibraryPath in the xlwings API way

The LibraryPath property of the Application object in Excel is a read-only string that returns the complete path to the folder where the Microsoft Excel library (or add-ins) is installed on the user’s system. This path is typically where Excel stores its built-in add-in files (with .xlam, .xll extensions, etc.) and is part of the application’s installation directory structure. In xlwings, this property can be accessed via the api property, which provides direct access to the underlying Excel object model. It is useful for developers who need to programmatically locate Excel’s library directory, for instance, when loading specific add-ins, referencing template files stored with Excel, or ensuring file paths are correctly resolved in cross-platform scenarios.

Syntax in xlwings:
The property is accessed through the Application object. In xlwings, you typically start by instantiating an App or using the active app. The syntax is:

app.api.LibraryPath

• app: This is an xlwings App object representing the Excel application instance.
• api: This property exposes the native Excel object model (via COM or AppleScript).
• LibraryPath: The property name, which requires no parameters.

The return value is a string containing the full directory path (e.g., C:\Program Files\Microsoft Office\root\Office16\LIBRARY on Windows). Note that the exact path may vary based on the Office version, installation type, or operating system.

Example Usage:
Here are practical xlwings API code examples demonstrating how to retrieve and use the LibraryPath property:

1. Basic Retrieval:
   This example gets the library path from the active Excel application and prints it.

import xlwings as xw
# Connect to the active Excel instance
app = xw.apps.active
# Access the LibraryPath property
lib_path = app.api.LibraryPath
print(f"Excel Library Path: {lib_path}")

2. Using with New Instance:
   If you launch a new Excel application via xlwings, you can obtain its library path similarly.

import xlwings as xw
# Start a new Excel application
app = xw.App(visible=True)
# Get the library path
lib_path = app.api.LibraryPath
print(f"Library folder: {lib_path}")
# Optionally, you can list files in the library directory
import os
if os.path.exists(lib_path):
    files = os.listdir(lib_path)
    print(f"Files in library: {files[:5]}") # Show first 5 files
app.quit()

3. Practical Application – Loading an Add-in:
   You can use the LibraryPath to construct full paths to add-ins. This example checks for a specific add-in and loads it if available.

import xlwings as xw
import os
app = xw.apps.active
lib_path = app.api.LibraryPath
# Define a target add-in name (e.g., Analysis ToolPak)
addin_name = "ANALYS32.XLL"
addin_path = os.path.join(lib_path, addin_name)
# Check if the add-in exists and load it
if os.path.exists(addin_path):
    app.api.AddIns(addin_name).Installed = True
    print(f"Loaded add-in from: {addin_path}")
else:
    print(f"Add-in not found at {addin_path}")