Remove helper entities on entry unload or options update

[raman325]

Breaking change

Given that these aren't removed today, this might be considered a breaking change, but I'm not sure.

Proposed change

When removing a keymaster entry, all helper entities will now be removed. This ensures that on restart, all entities created by keymaster have been cleaned up (previously, binary_sensors and sensors were removed on restart automatically but helper entities persisted).

There is also logic to remove extra helper entities on an options update (when the number of slots or start slot changes).

This PR follows #1 and should only be merged after the first is merged so that I can rebase on it.

Type of change

• Dependency upgrade
• Bugfix (non-breaking change which fixes an issue)
• New feature (which adds functionality)
• Breaking change (fix/feature causing existing functionality to break)
• Code quality improvements to existing code or addition of tests

Additional information

Here are the relevant changes, which are hard to see because this currently includes the diff from #1

keymaster/custom_components/keymaster/__init__.py

Lines 125 to 176 in 67f50bb

	def _get_entities_to_remove(
	lock_name: str,
	file_path: str,
	code_slots_to_remove: Union[List[int], range],
	remove_common_file: bool,
	) -> List[str]:
	"""Gets list of entities to remove."""
	output_path = os.path.join(file_path, lock_name)
	filenames = [f"{lock_name}_keymaster_{x}.yaml" for x in code_slots_to_remove]
	if remove_common_file:
	filenames.append(f"{lock_name}_keymaster_common.yaml")
	entities = []
	for filename in filenames:
	file_dict = load_yaml(os.path.join(output_path, filename))
	# get all entities from all helper domains that exist in package files
	for domain in (
	COUNTER_DOMAIN,
	IN_BOOL_DOMAIN,
	IN_DT_DOMAIN,
	IN_NUM_DOMAIN,
	IN_SELECT_DOMAIN,
	IN_TXT_DOMAIN,
	TIMER_DOMAIN,
	):
	entities.extend(
	[f"{domain}.{ent_id}" for ent_id in file_dict.get(domain, {})]
	)
	return entities
	async def _remove_entities(
	hass: HomeAssistant,
	config_entry: ConfigEntry,
	code_slots_to_remove: Union[List[int], range],
	remove_common_file: bool,
	) -> List[str]:
	"""Remove entities and return removed list."""
	ent_reg = await async_get_registry(hass)
	entities_to_remove = await hass.async_add_executor_job(
	_get_entities_to_remove,
	config_entry.data[CONF_LOCK_NAME],
	os.path.join(hass.config.path(), config_entry.data[CONF_PATH]),
	code_slots_to_remove,
	remove_common_file,
	)
	for entity_id in entities_to_remove:
	ent_reg.async_remove(entity_id)
	return entities_to_remove

keymaster/custom_components/keymaster/__init__.py

Lines 524 to 531 in 67f50bb

	curr_slots = range(config_entry.data[CONF_START], config_entry.data[CONF_SLOTS] + 1)
	new_slots = range(
	config_entry.options[CONF_START], config_entry.options[CONF_SLOTS] + 1
	)
	await _remove_entities(
	hass, config_entry, list(set(curr_slots) - set(new_slots)), False
	)

keymaster/custom_components/keymaster/__init__.py

Lines 502 to 507 in 67f50bb

	await _remove_entities(
	hass,
	config_entry,
	range(config_entry.data[CONF_START], config_entry.data[CONF_SLOTS] + 1),
	True,
	)

[firstof9]

Good stuff

[FutureTense]

Conflicts occurring. Probably due to the other PR being accepted. Try resolving on your end and resubmit. I dont like resolving conflicts on code that isn’t mine

[raman325]

Can you reopen this? I just resolved the conflicts.

[Copilot]

Pull request overview

This PR adds cleanup of YAML-package-generated helper entities (input_boolean, input_datetime, input_number, input_select, input_text, timer) when a keymaster config entry is unloaded or when its options change. Previously these helpers persisted on restart, so the integration left orphaned entities behind. The PR also tweaks update_listener so options updates compute slot diffs and remove only the helpers for slots that disappeared.

Changes:

• New _get_entities_to_remove / _remove_entities helpers that parse generated YAML and remove matching entries from the entity registry.
• async_unload_entry now removes all helpers (including common ones) before shutil.rmtree-ing the package directory.
• update_listener removes helpers for slots present before but absent after an options update, then regenerates packages and reloads.

Reviewed changes

Copilot reviewed 4 out of 4 changed files in this pull request and generated 5 comments.

File	Description
custom_components/keymaster/init.py	Adds helper-entity cleanup in unload and options-update paths and the supporting _get_entities_to_remove / _remove_entities helpers.
custom_components/keymaster/const.py	Edits ISSUE_URL (introduces a typo: keymaster → keypaster).
custom_components/keymaster/config_flow.py	Whitespace-only reordering of imports.
custom_components/keymaster/sensor.py	Whitespace-only import reordering.

---

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.