Class ProjectFolder

python/project.py:194–310

Class representing a folder in a project

class ProjectFolder:
	"""
	Class representing a folder in a project
	"""
	def __init__(self, handle: core.BNProjectFolderHandle):
		self._handle = handle

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

	def __repr__(self) -> str:
		path = self.name
		parent = self.parent
		while parent is not None:
			path = parent.name + '/' + path
			parent = parent.parent
		return f'<ProjectFolder: {self.project.name}/{path}>'

	def __str__(self) -> str:
		path = self.name
		parent = self.parent
		while parent is not None:
			path = parent.name + '/' + path
			parent = parent.parent
		return f'<ProjectFolder: {self.project.name}/{path}>'

	@property
	def project(self) -> 'Project':
		"""
		Get the project that owns this folder

		:return: Project that owns this folder
		"""
		proj_handle = core.BNProjectFolderGetProject(self._handle)

		if proj_handle is None:
			raise ProjectException("Failed to get project for folder")

		return Project(handle=proj_handle)

	@property
	def id(self) -> str:
		"""
		Get the unique id of this folder

		:return: Unique identifier of this folder
		"""
		return core.BNProjectFolderGetId(self._handle) # type: ignore

	@property
	def name(self) -> str:
		"""
		Get the name of this folder

		:return: Name of this folder
		"""
		return core.BNProjectFolderGetName(self._handle) # type: ignore