openstack/nova
Code Issues Proposed changes

Updated docstrings in /tools as per HACKING

Browse Source 
Change-Id: I06db6653784eb298ef7f78ebe99865b9c635aade
This commit is contained in:
Alex Meade
2012-03-28 19:21:11 +00:00
parent 930be36538
commit 998e57b296
1 changed files with 14 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files

26
tools/install_venv.py
View File

@@ -19,9 +19,7 @@
# License for the specific language governing permissions and limitations # License for the specific language governing permissions and limitations
# under the License. # under the License.
""" """Installation script for Nova's development virtualenv."""
Installation script for Nova's development virtualenv
"""
import optparse import optparse
import os import os
@@ -47,9 +45,9 @@ def check_python_version():
def run_command_with_code(cmd, redirect_output=True, check_exit_code=True): def run_command_with_code(cmd, redirect_output=True, check_exit_code=True):
""" """Runs a command in an out-of-process shell.
Runs a command in an out-of-process shell, returning the
output of that command. Working directory is ROOT. Returns the output of that command. Working directory is ROOT.
""" """
if redirect_output: if redirect_output:
stdout = subprocess.PIPE stdout = subprocess.PIPE
@@ -92,7 +90,8 @@ class Distro(object):
"""Any distribution-specific post-processing gets done here. """Any distribution-specific post-processing gets done here.
In particular, this is useful for applying patches to code inside In particular, this is useful for applying patches to code inside
the venv.""" the venv.
"""
pass pass
@@ -127,10 +126,11 @@ class Fedora(Distro):
This currently affects RHEL6.1, but the fix can safely be This currently affects RHEL6.1, but the fix can safely be
applied to all RHEL and Fedora distributions. applied to all RHEL and Fedora distributions.
This can be removed when the fix is applied upstream This can be removed when the fix is applied upstream.
Nova: https://bugs.launchpad.net/nova/+bug/884915 Nova: https://bugs.launchpad.net/nova/+bug/884915
Upstream: https://bitbucket.org/which_linden/eventlet/issue/89""" Upstream: https://bitbucket.org/which_linden/eventlet/issue/89
"""
# Install "patch" program if it's not there # Install "patch" program if it's not there
if not self.check_pkg('patch'): if not self.check_pkg('patch'):
@@ -155,8 +155,10 @@ def check_dependencies():
def create_virtualenv(venv=VENV, no_site_packages=True): def create_virtualenv(venv=VENV, no_site_packages=True):
"""Creates the virtual environment and installs PIP only into the """Creates the virtual environment and installs PIP.
virtual environment
Creates the virtual environment and installs PIP only into the
virtual environment.
""" """
print 'Creating venv...', print 'Creating venv...',
if no_site_packages: if no_site_packages:
@@ -225,7 +227,7 @@ def print_help():
def parse_args(): def parse_args():
"""Parse command-line arguments""" """Parses command-line arguments."""
parser = optparse.OptionParser() parser = optparse.OptionParser()
parser.add_option("-n", "--no-site-packages", dest="no_site_packages", parser.add_option("-n", "--no-site-packages", dest="no_site_packages",
default=False, action="store_true", default=False, action="store_true",