PyObjC Framework: PHASE

Warnings

• breaking PyObjC 12.0, which includes `pyobjc-framework-phase`, dropped support for Python 3.9. Projects targeting Python 3.9 must use `pyobjc` versions prior to 12.0.
  Fix: Upgrade to Python 3.10 or later, or pin `pyobjc-framework-phase` to a version less than 12.0 (e.g., `pip install 'pyobjc-framework-phase<12.0'`).
• breaking PyObjC 11.0, which includes `pyobjc-framework-phase`, dropped support for Python 3.8. Projects targeting Python 3.8 must use `pyobjc` versions prior to 11.0.
  Fix: Upgrade to Python 3.9 or later, or pin `pyobjc-framework-phase` to a version less than 11.0 (e.g., `pip install 'pyobjc-framework-phase<11.0'`).
• gotcha From PyObjC 11.1, the core bridge aligns with `clang`'s documentation for Automatic Reference Counting (ARC) in Objective-C initializer methods. Methods in the 'init' family now correctly model stealing a reference to `self` and returning a new one. This might subtly affect custom Objective-C classes exposed to Python or complex memory management if your code relied on older PyObjC reference counting behavior for initializers.
  Fix: Review any custom Objective-C classes wrapped with PyObjC, especially `init` methods, to ensure they correctly handle reference counting under the new ARC alignment. Most pure Python usage should be unaffected.
• gotcha Changes in PyObjC 10.3 and 10.3.1 affect how Python's `__init__` and `__new__` methods interact with bridged Objective-C classes. While 10.3.1 partially reverted 10.3's stricter behavior, if a class or its superclass defines a custom `__new__` in Python, its `__init__` can be called. However, `__init__` cannot be used if relying on the `__new__` provided by PyObjC directly for class instantiation.
  Fix: If bridging Python classes with custom `__new__` implementations, thoroughly test initialization. Avoid using `__init__` when instantiating through PyObjC's default class factory for new Objective-C objects if `__new__` isn't explicitly overridden in Python.

Install

• pip install pyobjc-framework-phase Install latest version

Imports

• PHASEEngine

  from PHASE import PHASEEngine

  Specific classes from the PHASE framework are imported directly from the 'PHASE' package.
• objc

  import objc

  The core PyObjC bridge is often needed for low-level interactions or type conversions.

Quickstart

This quickstart demonstrates how to import a class from the `PHASE` framework and attempt to instantiate a `PHASEEngine`. While a complete audio application using PHASE is complex, this example verifies that the framework bindings are correctly installed and accessible from Python. Output will appear in the macOS system log (viewable via Console.app) due to `NSLog` usage.

import objc
from Foundation import NSObject, NSLog
from PHASE import PHASEEngine, PHASE_ENGINE_SOUND_EVENT_TYPE_NONE

def quick_phase_check():
    NSLog("Attempting to create a PHASEEngine instance...")
    try:
        # PHASEEngine requires an identifier for instantiation
        engine = PHASEEngine.alloc().initWithIdentifier_("MyPythonPHASEEngine")
        if engine:
            NSLog("Successfully created PHASEEngine instance: %@", engine)
            # A real PHASE application would continue with configuration and playback.
            # This example only verifies the binding's accessibility.
        else:
            NSLog("Failed to create PHASEEngine instance.")
    except Exception as e:
        NSLog("Error creating PHASEEngine: %@", str(e))

if __name__ == "__main__":
    quick_phase_check()