Create virtual env hash based on lock file instead of parent directory

[matzhaugen]

• I have searched the issues of this repo and believe that this is not a duplicate.
• I have searched the documentation and believe that my question is not covered.

Feature Request

When building the same poetry package with the same lock file on a different machine, e.g. On different VMs in a jenkins PR build cluster, the virtual environment will hash to something different if the VM is not the same. This is because the folder parent directory is different, e.g. /home/PR123/pyproject.toml vs/ /home/PR124/pyproject.toml.

I think it would be nice to have the virtual env hash be the same in these to instances if and only if the lock file is identical.

[abn]

@matzhaugen I do not think this is feasible; since this would mean that everytinme the lock changes, poetry re-creates a venv. While that is okay and even preferred in a CI environment, not so much for development environments.

You should consider using poetry config virtualenvs.in-project true.

[matzhaugen]

Thanks for the quick response. Yes that is a good point. It probably isn't feasible for development environments, but maybe if it were an optional argument? With poetry config virtualenvs.in-project true you will not have a way to label your venv and share it, unless you hash based on the lock file. How about this: When you specify poetry config virtualenvs.in-project true Instead of calling it .venv call it .venv-{hash} where hash is based on the lock file? :) That way you could share it and people would know it by the lock file hash.

However, there still wouldn't be a trivial way to share it without some other project being able to import it, even if you had the venv copied to some global directory. So I recognize that maybe this is not the right way to go about it.

[abn]

Unfortunately, same issue. Also, I would not recommend sharing virtualenvironments unless the systems are identical in the first place. In cases like CI environments, typically you cache the venv based on <os>-<python-version>-<lock hash> if you are inclined to do so. Couldn't your ci environment do the same? As in, cache the .venv directory with the above key?

poetry/.github/workflows/main.yml

Lines 45 to 59 in dfa5c0f

	- name: Configure poetry
	shell: bash
	run: poetry config virtualenvs.in-project true
	- name: Set up cache
	uses: actions/cache@v2
	id: cache
	with:
	path: .venv
	key: venv-${{ runner.os }}-${{ steps.full-python-version.outputs.version }}-${{ hashFiles('**/poetry.lock') }}
	- name: Ensure cache is healthy
	if: steps.cache.outputs.cache-hit == 'true'
	shell: bash
	run: poetry run pip --version >/dev/null 2>&1 || rm -rf .venv

I am not sure if this is a large enough use case that cannot be solved elswhere. If it is, we could look at enabling some sort of option for this, virtualenvs.use-lock-hash. If we do implement something like this, this also will need to be handled by #2924 for in-project virtualenvs. Using any other name than .venv for the root directory in this scenario is something that I am not in favour for, as it is convention (eg: ignored by default gitignores etc).

[matzhaugen]

The code you give above is actually a nice way to solve this in a CI setting. I'll just do that.

More generally, I agree that changing the .venv name would not be ideal. Another option could be to add an poetry export venv option which hashes based on what you specify above, but given your proposed solution, this is not so important for me. I'm happy to close this issue.

[github-actions]

This issue has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs.