Class Project

python/project.py:313–679

Class representing a project

class Project:
	"""
	Class representing a project
	"""
	def __init__(self, handle: core.BNProjectHandle):
		self._handle = handle

	def __del__(self):
		if core is not None:
			core.BNFreeProject(self._handle)

	def __repr__(self) -> str:
		return f'<Project: {self.name}>'

	def __str__(self) -> str:
		return f'<Project: {self.name}>'

	@staticmethod
	def open_project(path: AsPath) -> 'Project':
		"""
		Open an existing project

		:param path: Path to the project directory (.bnpr) or project metadata file (.bnpm)
		:return: Opened project
		:raises ProjectException: If there was an error opening the project
		"""
		binaryninja._init_plugins()
		project_handle = core.BNOpenProject(str(path))
		if project_handle is None:
			raise ProjectException("Failed to open project")
		return Project(handle=project_handle)

	@staticmethod
	def create_project(path: AsPath, name: str) -> 'Project':
		"""
		Create a new project

		:param path: Path to the project directory (.bnpr)
		:param name: Name of the new project
		:return: Opened project
		:raises ProjectException: If there was an error creating the project
		"""
		binaryninja._init_plugins()
		project_handle = core.BNCreateProject(str(path), name)
		if project_handle is None:
			raise ProjectException("Failed to create project")
		return Project(handle=project_handle)

	def open(self) -> bool:
		"""
		Open a closed project

		:return: True if the project is now open, False otherwise
		"""
		return core.BNProjectOpen(self._handle)

	def close(self) -> bool:
		"""