Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Avoid keeping config dir in path #107760

Merged
merged 2 commits into from Jan 16, 2024

Conversation

elupus
Copy link
Contributor

@elupus elupus commented Jan 10, 2024

Breaking change

Previous versions of home assistant would load python modules/packages from directly in your config directory. This has the ugly issue that accidental python files in your configuration directory would override globally installed packages.

Move any custom python dependency you need to a deps subfolder to retain previous behaviour.

Proposed change

We add config dir temporarily to sys.path to add custom components module to global python cache, then remove it again.

Custom dependencies should be added to a deps/ subfolder of your config directory.

Type of change

  • Dependency upgrade
  • Bugfix (non-breaking change which fixes an issue)
  • New integration (thank you!)
  • New feature (which adds functionality to an existing integration)
  • Deprecation (breaking change to happen in the future)
  • Breaking change (fix/feature causing existing functionality to break)
  • Code quality improvements to existing code or addition of tests

Additional information

  • This PR fixes or closes issue: fixes #
  • This PR is related to issue:
  • Link to documentation pull request:

Checklist

  • The code change is tested and works locally.
  • Local tests pass. Your PR cannot be merged unless tests pass
  • There is no commented out code in this PR.
  • I have followed the development checklist
  • I have followed the perfect PR recommendations
  • The code has been formatted using Ruff (ruff format homeassistant tests)
  • Tests have been added to verify that the new code works.

If user exposed functionality or configuration variables are added/changed:

If the code communicates with devices, web services, or third-party tools:

  • The manifest file has all fields filled out correctly.
    Updated and included derived files by running: python3 -m script.hassfest.
  • New or updated dependencies have been added to requirements_all.txt.
    Updated by running python3 -m script.gen_requirements_all.
  • For the updated dependencies - a link to the changelog, or at minimum a diff between library versions is added to the PR description.
  • Untested files have been added to .coveragerc.

To help with the load of incoming pull requests:

We add it temporarily to add custom components module to
global python cache.
@home-assistant home-assistant bot added cla-signed core small-pr PRs with less than 30 lines. labels Jan 10, 2024
@elupus elupus marked this pull request as ready for review January 12, 2024 22:40
@elupus elupus requested a review from a team as a code owner January 12, 2024 22:40
Copy link
Member

@frenck frenck left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this will affect our Python scripts?

https://www.home-assistant.io/integrations/python_script/

@elupus
Copy link
Contributor Author

elupus commented Jan 14, 2024

I think this will affect our Python scripts?

https://www.home-assistant.io/integrations/python_script/

Sounds plausible. Will investigate that.

@elupus
Copy link
Contributor Author

elupus commented Jan 14, 2024

I think this will affect our Python scripts?

https://www.home-assistant.io/integrations/python_script/

Does not seem so. Python scripts are loaded from file manually and executed using a special executor. They don't require config to be in path. I've tested with an test script and the tests for these do pass.

Copy link
Member

@frenck frenck left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me, thanks @elupus 👍

../Frenck

@frenck frenck merged commit 523352c into home-assistant:dev Jan 16, 2024
53 checks passed
@github-actions github-actions bot locked and limited conversation to collaborators Jan 17, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants