pbxproj

4.3.3 verified Fri May 01 auth: no python

A Python library for reading, modifying, and writing Xcode project files (.pbxproj). Current version 4.3.3, with occasional updates.

pip install pbxproj

Common errors

error 'XcodeProject' object has no attribute 'add_file' ↓

cause Importing from wrong module or using outdated API.

fix

Ensure you import XcodeProject from pbxproj (not from submodules) and use version 4.x. If using older version, add_file may be in objects attribute.

error ModuleNotFoundError: No module named 'pbxproj' ↓

cause pbxproj is not installed.

fix

Run pip install pbxproj.

error 'str' object has no attribute 'get' ↓

cause Passing a file path string instead of a project object to `XcodeProject.load()`.

fix

Pass a string path: XcodeProject.load('path/to/project.pbxproj').

Warnings

gotcha The `add_file` method returns an optional object; ignoring the return value can lead to silent failures if the file is not added (e.g., duplicate). ↓

fix Check the return value: `result = project.add_file(...)` and handle None.

breaking Version 4.x dropped support for Python 3.9 and earlier. Projects using Python <3.10 must use version 3.2.3. ↓

fix Upgrade Python to 3.10+ or pin pbxproj==3.2.3.

deprecated The `pbxproj.XcodeProject()` constructor without arguments is deprecated; use `XcodeProject.load()` or create from a file path. ↓

fix Use `XcodeProject.load(path)` to load an existing project.

Imports

XcodeProject

wrong

from pbxproj.XcodeProject import XcodeProject

correct

from pbxproj import XcodeProject

Direct import of class instead of from module.

PBXGenericObject

wrong

from pbxproj import PBXGenericObject

correct

from pbxproj.PBXGenericObject import PBXGenericObject

PBXGenericObject is in a submodule, not top-level.

Quickstart

Load an Xcode project, add a file, and save.

from pbxproj import XcodeProject

project = XcodeProject.load('MyProject.xcodeproj/project.pbxproj')
# Add a file to the project (relative path from project root)
project.add_file('path/to/YourFile.swift')
project.save()
print('Project updated successfully.')