PyObjC IntentsUI Framework

Warnings

• breaking PyObjC frequently drops support for older Python versions. PyObjC 12.0 dropped support for Python 3.9, and PyObjC 11.0 dropped Python 3.8. Ensure your Python version is compatible with the PyObjC version you are installing.
  Fix: Upgrade your Python environment to Python 3.10 or later for PyObjC 12.x. Always check `requires_python` on PyPI or the PyObjC changelog for specific version requirements.
• breaking PyObjC 11.1 changed how initializer methods (`init` family) are modeled, now correctly reflecting that they 'steal' a reference to `self` and return a new one, as per `clang`'s Automatic Reference Counting (ARC) documentation. This affects object lifecycle and reference counting.
  Fix: Review code that interacts with object initialization, especially custom subclasses or factory methods, to ensure correct reference handling. Explicit memory management is rarely needed in Python, but understanding the underlying Objective-C semantics is crucial for correct behavior.
• gotcha PyObjC is a macOS-specific library and will not install or run on other operating systems. The frameworks it wraps (like IntentsUI) are Apple-proprietary.
  Fix: Only use `pyobjc-framework-intentsui` in macOS environments. For cross-platform solutions, consider alternative libraries.
• gotcha Unlike Objective-C, where sending a message to `nil` (equivalent to Python `None`) is a no-op, attempting to call a method on a Python `None` object (which PyObjC translates from `nil`) will raise an `AttributeError`.
  Fix: Always check for `None` before calling methods on PyObjC-wrapped objects that might originate from Objective-C `nil` values. E.g., `if my_obj is not None: my_obj.doSomething_()`.
• gotcha PyObjC 10.3 introduced breaking changes in `__init__` and `__new__` handling for Objective-C classes, which was partially reverted in 10.3.1. While `__init__` can now be used when a user implements `__new__`, code relying on PyObjC's provided `__new__` still cannot use `__init__`. The recommended Pythonic instantiation is `MyClass(...)` (available since PyObjC 10.4) or the explicit `MyClass.alloc().init...()`.
  Fix: Favor `MyClass(...)` for new object creation when possible, or `MyClass.alloc().init...()`. If subclassing and overriding `__new__`, ensure `__init__` logic is compatible with the PyObjC bridging rules and refer to the PyObjC instantiation documentation.
• gotcha Although PyObjC 12.1 and later supports Python 3.13's experimental free-threading, the underlying Python feature itself is experimental. Earlier PyObjC versions (e.g., 10.3) did not support it.
  Fix: If using Python 3.13's free-threading, proceed with caution and thorough testing, as the feature is still experimental in Python. Ensure you are using PyObjC 12.1 or newer for free-threading support.

Install

• pip install pyobjc-framework-intentsui Install latest version

Imports

• INUIAddVoiceShortcutViewController

  from IntentsUI import INUIAddVoiceShortcutViewController

Quickstart

The IntentsUI framework classes, such as `INUIAddVoiceShortcutViewController`, are designed for building UI within SiriKit Intents UI extensions. A direct, standalone Python quickstart without a full macOS application and Xcode project setup is not practical for demonstrating functional UI. This snippet shows a basic import and explains the typical context of usage.

from IntentsUI import INUIAddVoiceShortcutViewController
from Foundation import NSObject

# IntentsUI classes like INUIAddVoiceShortcutViewController are typically used within
# a macOS application's Intents UI Extension, often involving XCode and Interface Builder.
# A simple standalone Python script usually cannot directly instantiate and display 
# these UI elements without a full application context.

# This example primarily shows the import and a placeholder for where you might use it.
# For actual usage, refer to Apple's SiriKit documentation and PyObjC examples
# involving py2app and application development.

def create_intents_ui_controller():
    # In a real application, you would instantiate and configure this controller.
    # For example, to add a voice shortcut:
    # controller = INUIAddVoiceShortcutViewController.alloc().initWithShortcut_(your_shortcut)
    # Or, using the Pythonic instantiation (PyObjC 10.4+):
    # controller = INUIAddVoiceShortcutViewController(shortcut=your_shortcut)
    print(f"Successfully imported {INUIAddVoiceShortcutViewController.__name__}.")
    print("IntentsUI classes require an application context, typically an Intents UI Extension.")
    return None

if __name__ == "__main__":
    create_intents_ui_controller()