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鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Skip install on tox pylint #39260

Merged
merged 1 commit into from Aug 27, 2020
Merged

Skip install on tox pylint #39260

merged 1 commit into from Aug 27, 2020

Conversation

scop
Copy link
Member

@scop scop commented Aug 25, 2020

Proposed change

We're not operating on the installed package anyway, and necessary
dependencies are handled with tox deps.

As a nice bonus side effect, doing this sidesteps breakage caused by
pip's (up to 20.2.2 at least) behavior of prepending site-packages to
sys.path in certain cases, which in turn results in failures e.g. if a
version of typing that is incompatible with the (now overridden)
stdlib is installed there. And that combined with also pip's behavior
of installing a default build system consisting of setuptools and
wheel under the hood when it sees our pyproject.toml without a
build-system defined would provoke the breakage before we have a
chance to uninstall typing. (There are ways around this too, but
skipping the install makes the issue moot at least with our current
dependency set.)

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)
  • 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
  • The code has been formatted using Black (black --fast 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.
  • Untested files have been added to .coveragerc.

The integration reached or maintains the following Integration Quality Scale:

  • No score or internal
  • 馃 Silver
  • 馃 Gold
  • 馃弳 Platinum

To help with the load of incoming pull requests:

We're not operating on the installed package anyway, and necessary
dependencies are handled with tox deps.

As a nice bonus side effect, doing this sidesteps breakage caused by
pip's (up to 20.2.2 at least) behavior of prepending site-packages to
sys.path in certain cases, which in turn results in failures e.g. if a
version of typing that is incompatible with the (now overridden)
stdlib is installed there. And that combined with also pip's behavior
of installing a default build system consisting of setuptools and
wheel under the hood when it sees our pyproject.toml without a
build-system defined would provoke the breakage before we have a
chance to uninstall typing. (There are ways around this too, but
skipping the install makes the issue moot at least with our current
dependency set.)
@project-bot project-bot bot added this to Needs review in Dev Aug 25, 2020
@probot-home-assistant probot-home-assistant bot added code-quality small-pr PRs with less than 30 lines. labels Aug 25, 2020
@balloob
Copy link
Member

balloob commented Aug 26, 2020

We are operating on the installed deps, as pylint will look into the installed deps to make sure objects exist / method names are correct.

@scop
Copy link
Member Author

scop commented Aug 26, 2020

Sure, but the deps are installed through requirements files. HA itself does not need to be installed, nor dependencies through setup.py as as side effect of doing so.

@scop
Copy link
Member Author

scop commented Aug 26, 2020

Specifically here,

core/tox.ini

Line 23 in 34c2579

-r{toxinidir}/requirements_all.txt
(actually way more deps are installed than what would get installed as side effect of installing HA anyway, which is what the skip_install prevents, and this is fine)

Copy link
Member

@balloob balloob left a comment

Choose a reason for hiding this comment

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

I should know better than to doubt your changes 馃槈 馃憤

Dev automation moved this from Needs review to Reviewer approved Aug 27, 2020
@balloob balloob merged commit 27f3c0a into home-assistant:dev Aug 27, 2020
Dev automation moved this from Reviewer approved to Done Aug 27, 2020
@scop scop deleted the tox-skip-install-with-pylint branch August 27, 2020 19:13
@scop
Copy link
Member Author

scop commented Aug 27, 2020

Thanks, but nah, more than one pair of eyes is always welcome :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cla-signed code-quality small-pr PRs with less than 30 lines.
Projects
Dev
  
Done
Development

Successfully merging this pull request may close these issues.

None yet

3 participants