Use container mount for custom_components inside /config to avoid PYTHONPATH #205
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Allow integration to be found by HASS without polluting module search path
ludeeus
reviewed
Oct 31, 2024
| ## This let's us have the structure we want <root>/custom_components/integration_blueprint | ||
| ## while at the same time have Home Assistant configuration inside <root>/config | ||
| ## without resulting to symlinks. | ||
| export PYTHONPATH="${PYTHONPATH}:${PWD}/custom_components" |
There was a problem hiding this comment.
Removing this makes it only work in a devcontainer.
This repo exist as a starting point, not to catch every possible edge case out there.
If you want to showcase that, this repo is better.
https://github.com/home-assistant/example-custom-config
If you just want to share how you do things, there is this section on the forums:
https://community.home-assistant.io/c/community-guides/51
bj00rn
force-pushed
the
chore/use-mount-for-custom_components
branch
from
a794842
to
4fe9c06
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Use container mount instead of relying on PYTHONPATH for integration to be found by hass.
Allow integration to be found by hass without polluting module search path.
It's quite common (good practice or not) in the wild for integrations and their lib
requirementto share the same package name. Adding custom_components to PYTHONPATH does not support this scenario. Integrations that are currently based on this template will stop working if brought to sync with this repo. The error thrown is confusing since the requirement is installed by hass but will resolve to the integration package itself.fixes #130