PyObjC PassKit Framework

Warnings

• breaking PyObjC 12.0 dropped support for Python 3.9. Users on Python 3.9 or older must upgrade their Python version to use `pyobjc-framework-passkit` 12.0 or newer.
  Fix: Upgrade Python to 3.10 or newer.
• breaking PyObjC 11.0 dropped support for Python 3.8. Users on Python 3.8 must upgrade their Python version to use `pyobjc-framework-passkit` 11.0 or newer.
  Fix: Upgrade Python to 3.9 or newer (Python 3.10+ for PyObjC 12.0+).
• breaking PyObjC 11.1 changed the behavior of 'init' family methods and `NSObject.alloc()` to align with Objective-C's Automatic Reference Counting (ARC) specification. This change affects how references are handled for newly initialized objects and might require reviewing code that manually manages object lifecycle or uses `alloc()` followed by `init` methods.
  Fix: Review Python subclasses of Objective-C classes, especially those overriding `init` methods or manually calling `alloc()`, to ensure correct reference counting and object lifecycle management.
• gotcha After PyObjC 10.3, if a Python class subclasses an Objective-C class and relies on PyObjC's default `__new__` implementation (i.e., doesn't define its own `__new__`), it cannot implement `__init__`. While PyObjC 10.3.1 partially reverted this for classes with user-implemented `__new__`, the general rule for relying on PyObjC's `__new__` is to avoid Python `__init__` on those subclasses.
  Fix: If subclassing an Objective-C class and relying on PyObjC's default object creation, use Objective-C compatible `init` methods (e.g., `initWith...`) rather than a Python `__init__`.

Install

• pip install pyobjc-framework-passkit Install pyobjc-framework-passkit

Imports

• PassKit

  import PassKit

  The entire PassKit framework's symbols become available under the `PassKit` module.
• PKPassLibrary

  import PassKit
  pass_library = PassKit.PKPassLibrary.sharedPassLibrary()

  While Python allows `from PassKit import PKPassLibrary`, the standard PyObjC pattern is to import the framework module and access classes/functions via `FrameworkName.Symbol`.

Quickstart

This quickstart demonstrates how to import the `PassKit` framework and check if the PassKit library is available on the current macOS system. It also shows how to get the shared `PKPassLibrary` instance and check if the application has permission to add passes. Note that full interaction with Wallet passes typically requires the Python script to be run within a properly signed macOS application bundle with the necessary entitlements.

import PassKit
import objc

def check_passkit_availability():
    if PassKit.PKPassLibrary.isPassLibraryAvailable():
        print("PassKit library is available on this system.")
        pass_library = PassKit.PKPassLibrary.sharedPassLibrary()
        print(f"Shared Pass Library object: {pass_library}")
        # Note: Interacting with passes (e.g., listing, adding) often requires
        # your Python script to be bundled as a properly signed macOS application
        # with specific entitlements.
        # Attempting to fetch passes in a non-entitled script might result in empty lists or errors.
        
        # Example: Check if the current app is allowed to add passes
        if pass_library.canAddPasses():
            print("This application is authorized to add passes to Wallet.")
        else:
            print("This application is not authorized to add passes to Wallet.")

    else:
        print("PassKit library is not available on this system.")

if __name__ == "__main__":
    check_passkit_availability()