commit | 704dbb824410432fcd5902ed41509f40735e7fd8 | [log] [tgz] |
---|---|---|
author | xixuan <xixuan@chromium.org> | Fri Apr 28 09:10:11 2017 -0700 |
committer | chrome-bot <chrome-bot@chromium.org> | Fri Apr 28 22:25:43 2017 -0700 |
tree | a1877cefb3e59dba95b32dc5d26cfaee79f94592 | |
parent | 27d837f883175a1de37005bae4acf88b7b304838 [diff] |
Add Cherrypy dependency wheels First step to move apache_log_metrics to venv. BUG=chromium:708890 TEST=Recreate venv for chormeos-admin with the new requirements. Change-Id: I84c2f58952f2025865e4fd79e1373b0a741e3afd Reviewed-on: https://chromium-review.googlesource.com/490626 Commit-Ready: Xixuan Wu <xixuan@chromium.org> Tested-by: Xixuan Wu <xixuan@chromium.org> Reviewed-by: Paul Hobbs <phobbs@google.com> Reviewed-by: Allen Li <ayatane@chromium.org>
This repository provides a common Python virtualenv interface that infra code (such as chromite) can depend on.
Virtualenv users should mimic this repository, which itself uses virtualenv for running unit tests.
venv
directory. All packages and modules in this directory will be importable inside the virtualenv.requirements.txt
file inside venv
to list external packages to install.bin/find_virtualenv.sh
and bin/turtle
which serve as templates.To add packages to this repository, run:
$ pip wheel -w path/to/pip_packages -r path/to/requirements.txt
Commit the changes and make a CL.
The create_venv
script prepares a virtualenv using a requirements.txt
file.
$ create_venv requirements.txt
The script will print the path to the virtualenv to stdout. Note that the output ends with a newline; Bash handles this, but Python does not.
To run the virtualenv Python, call bin/python
under the virtualenv directory.
Together, this might look up:
$ venv=$(create_venv requirements.txt) $ ${venv}/bin/python
NOTE: it is not generally safe to run the other scripts in the virtualenv's bin
directory due to hard-coded paths. Instead of running bin/pip
for example, use bin/python -m pip
.
NOTE: Do not use this for third party dependencies (stuff not owned by ChromiumOS)! This should only be used to set up imports for stuff we own. For example, importing python-MySQL SHOULD NOT use this, but importing chromite from Autotest MAY use this.
This should be handled by the minimum amount of code in the package's __init__.py
file.
Example:
"""Autotest package.""" import sys # Use the minimum amount of logic to find the path to add _chromite_parent = 'site-packages' sys.path.append(_chromite_parent)
A solid understanding of the Python import system is recommended (the link is for Python 3, but it is informative).
In brief, __init__.py
is executed whenever a package is imported. A package is imported before any submodule or subpackage is imported. A package is only imported once per Python process; future imports are looked up in sys.modules
. Thus, __init__.py
will modify sys.path
exactly once and is guaranteed to be run before anything in that package is imported.