Orbits  1
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Macros Pages
Public Member Functions | Public Attributes | List of all members
pip.baseparser.ConfigOptionParser Class Reference
Inheritance diagram for pip.baseparser.ConfigOptionParser:
pip.baseparser.CustomOptionParser

Public Member Functions

def __init__
 
def get_config_files
 
def check_default
 
def update_defaults
 
def normalize_keys
 
def get_config_section
 
def get_environ_vars
 
def get_default_values
 
def error
 
- Public Member Functions inherited from pip.baseparser.CustomOptionParser
def insert_option_group
 
def option_list_all
 

Public Attributes

 config
 
 name
 
 files
 

Detailed Description

Custom option parser which updates its defaults by checking the
configuration files and environmental variables

Constructor & Destructor Documentation

def pip.baseparser.ConfigOptionParser.__init__ (   self,
  args,
  kwargs 
)

Member Function Documentation

def pip.baseparser.ConfigOptionParser.check_default (   self,
  option,
  key,
  val 
)
def pip.baseparser.ConfigOptionParser.error (   self,
  msg 
)
def pip.baseparser.ConfigOptionParser.get_config_files (   self)
def pip.baseparser.ConfigOptionParser.get_config_section (   self,
  name 
)
Get a section of a configuration
def pip.baseparser.ConfigOptionParser.get_default_values (   self)
Overridding to make updating the defaults after instantiation of
the option parser possible, update_defaults() does the dirty work.
def pip.baseparser.ConfigOptionParser.get_environ_vars (   self,
  prefix = 'PIP_' 
)
Returns a generator with all environmental vars with prefix PIP_
def pip.baseparser.ConfigOptionParser.normalize_keys (   self,
  items 
)
Return a config dictionary with normalized keys regardless of
whether the keys were specified in environment variables or in config
files
def pip.baseparser.ConfigOptionParser.update_defaults (   self,
  defaults 
)
Updates the given defaults with values from the config files and
the environ. Does a little special handling for certain types of
options (lists).

Member Data Documentation

pip.baseparser.ConfigOptionParser.config
pip.baseparser.ConfigOptionParser.files
pip.baseparser.ConfigOptionParser.name

The documentation for this class was generated from the following file:

Copyright 2014 Google Inc. All rights reserved.