Back to index

python3.2  3.2.2
Public Member Functions | Public Attributes | Static Public Attributes
lib2to3.fixes.fix_imports2.FixImports2 Class Reference
Inheritance diagram for lib2to3.fixes.fix_imports2.FixImports2:
Inheritance graph
[legend]
Collaboration diagram for lib2to3.fixes.fix_imports2.FixImports2:
Collaboration graph
[legend]

List of all members.

Public Member Functions

def build_pattern
def compile_pattern
def match
def start_tree
def transform
def set_filename
def new_name
def log_message
def cannot_convert
def warning
def finish_tree

Public Attributes

 PATTERN
 replace
 numbers
 used_names
 log
 first_log
_PyObject_HEAD_EXTRA Py_ssize_t ob_refcnt
struct _typeobjectob_type

Static Public Attributes

int run_order = 7
 mapping = MAPPING
 BM_compatible = True
 keep_line_order = True
 pattern = None
 pattern_tree = None
 options = None
 filename = None
 logger = None
tuple numbers = itertools.count(1)
tuple used_names = set()
string order = "post"
 explicit = False
 syms = pygram.python_symbols

Detailed Description

Definition at line 12 of file fix_imports2.py.


Member Function Documentation

Reimplemented in lib2to3.fixes.fix_urllib.FixUrllib.

Definition at line 96 of file fix_imports.py.

00096 
00097     def build_pattern(self):
00098         return "|".join(build_pattern(self.mapping))

def lib2to3.fixer_base.BaseFix.cannot_convert (   self,
  node,
  reason = None 
) [inherited]
Warn the user that a given chunk of code is not valid Python 3,
but that it cannot be converted automatically.

First argument is the top-level node for the code in question.
Optional second argument is why it can't be converted.

Definition at line 125 of file fixer_base.py.

00125 
00126     def cannot_convert(self, node, reason=None):
00127         """Warn the user that a given chunk of code is not valid Python 3,
00128         but that it cannot be converted automatically.
00129 
00130         First argument is the top-level node for the code in question.
00131         Optional second argument is why it can't be converted.
00132         """
00133         lineno = node.get_lineno()
00134         for_output = node.clone()
00135         for_output.prefix = ""
00136         msg = "Line %d: could not convert: %s"
00137         self.log_message(msg % (lineno, for_output))
00138         if reason:
00139             self.log_message(reason)

Here is the call graph for this function:

Here is the caller graph for this function:

Compiles self.PATTERN into self.pattern.

Subclass may override if it doesn't want to use
self.{pattern,PATTERN} in .match().

Reimplemented from lib2to3.fixer_base.BaseFix.

Definition at line 99 of file fix_imports.py.

00099 
00100     def compile_pattern(self):
00101         # We override this, so MAPPING can be pragmatically altered and the
00102         # changes will be reflected in PATTERN.
00103         self.PATTERN = self.build_pattern()
00104         super(FixImports, self).compile_pattern()

def lib2to3.fixer_base.BaseFix.finish_tree (   self,
  tree,
  filename 
) [inherited]
Some fixers need to maintain tree-wide state.
This method is called once, at the conclusion of tree fix-up.

tree - the root node of the tree to be processed.
filename - the name of the file the tree came from.

Reimplemented in lib2to3.fixes.fix_xrange.FixXrange.

Definition at line 162 of file fixer_base.py.

00162 
00163     def finish_tree(self, tree, filename):
00164         """Some fixers need to maintain tree-wide state.
00165         This method is called once, at the conclusion of tree fix-up.
00166 
00167         tree - the root node of the tree to be processed.
00168         filename - the name of the file the tree came from.
00169         """
00170         pass
00171 

def lib2to3.fixer_base.BaseFix.log_message (   self,
  message 
) [inherited]

Definition at line 119 of file fixer_base.py.

00119 
00120     def log_message(self, message):
00121         if self.first_log:
00122             self.first_log = False
00123             self.log.append("### In file %s ###" % self.filename)
00124         self.log.append(message)

Here is the caller graph for this function:

def lib2to3.fixes.fix_imports.FixImports.match (   self,
  node 
) [inherited]
Returns match for a given parse tree node.

Should return a true or false object (not necessarily a bool).
It may return a non-empty dict of matching sub-nodes as
returned by a matching pattern.

Subclass may override.

Reimplemented from lib2to3.fixer_base.BaseFix.

Definition at line 106 of file fix_imports.py.

00106 
00107     def match(self, node):
00108         match = super(FixImports, self).match
00109         results = match(node)
00110         if results:
00111             # Module usage could be in the trailer of an attribute lookup, so we
00112             # might have nested matches when "bare_with_attr" is present.
00113             if "bare_with_attr" not in results and \
00114                     any(match(obj) for obj in attr_chain(node, "parent")):
00115                 return False
00116             return results
00117         return False

Here is the call graph for this function:

Here is the caller graph for this function:

def lib2to3.fixer_base.BaseFix.new_name (   self,
  template = "xxx_todo_changeme" 
) [inherited]
Return a string suitable for use as an identifier

The new name is guaranteed not to conflict with other identifiers.

Definition at line 108 of file fixer_base.py.

00108 
00109     def new_name(self, template="xxx_todo_changeme"):
00110         """Return a string suitable for use as an identifier
00111 
00112         The new name is guaranteed not to conflict with other identifiers.
00113         """
00114         name = template
00115         while name in self.used_names:
00116             name = template + str(next(self.numbers))
00117         self.used_names.add(name)
00118         return name

Here is the caller graph for this function:

def lib2to3.fixer_base.BaseFix.set_filename (   self,
  filename 
) [inherited]
Set the filename, and a logger derived from it.

The main refactoring tool should call this.

Definition at line 72 of file fixer_base.py.

00072 
00073     def set_filename(self, filename):
00074         """Set the filename, and a logger derived from it.
00075 
00076         The main refactoring tool should call this.
00077         """
00078         self.filename = filename
00079         self.logger = logging.getLogger(filename)

def lib2to3.fixes.fix_imports.FixImports.start_tree (   self,
  tree,
  filename 
) [inherited]
Some fixers need to maintain tree-wide state.
This method is called once, at the start of tree fix-up.

tree - the root node of the tree to be processed.
filename - the name of the file the tree came from.

Reimplemented from lib2to3.fixer_base.BaseFix.

Definition at line 118 of file fix_imports.py.

00118 
00119     def start_tree(self, tree, filename):
00120         super(FixImports, self).start_tree(tree, filename)
00121         self.replace = {}

def lib2to3.fixes.fix_imports.FixImports.transform (   self,
  node,
  results 
) [inherited]
Returns the transformation for a given parse tree node.

Args:
  node: the root of the parse tree that matched the fixer.
  results: a dict mapping symbolic names to part of the match.

Returns:
  None, or a node that is a modified copy of the
  argument node.  The node argument may also be modified in-place to
  effect the same change.

Subclass *must* override.

Reimplemented from lib2to3.fixer_base.BaseFix.

Reimplemented in lib2to3.fixes.fix_urllib.FixUrllib.

Definition at line 122 of file fix_imports.py.

00122 
00123     def transform(self, node, results):
00124         import_mod = results.get("module_name")
00125         if import_mod:
00126             mod_name = import_mod.value
00127             new_name = self.mapping[mod_name]
00128             import_mod.replace(Name(new_name, prefix=import_mod.prefix))
00129             if "name_import" in results:
00130                 # If it's not a "from x import x, y" or "import x as y" import,
00131                 # marked its usage to be replaced.
00132                 self.replace[mod_name] = new_name
00133             if "multiple_imports" in results:
00134                 # This is a nasty hack to fix multiple imports on a line (e.g.,
00135                 # "import StringIO, urlparse"). The problem is that I can't
00136                 # figure out an easy way to make a pattern recognize the keys of
00137                 # MAPPING randomly sprinkled in an import statement.
00138                 results = self.match(node)
00139                 if results:
00140                     self.transform(node, results)
00141         else:
00142             # Replace usage of the module.
00143             bare_name = results["bare_with_attr"][0]
00144             new_name = self.replace.get(bare_name.value)
00145             if new_name:
00146                 bare_name.replace(Name(new_name, prefix=bare_name.prefix))

Here is the call graph for this function:

def lib2to3.fixer_base.BaseFix.warning (   self,
  node,
  reason 
) [inherited]
Used for warning the user about possible uncertainty in the
translation.

First argument is the top-level node for the code in question.
Optional second argument is why it can't be converted.

Definition at line 140 of file fixer_base.py.

00140 
00141     def warning(self, node, reason):
00142         """Used for warning the user about possible uncertainty in the
00143         translation.
00144 
00145         First argument is the top-level node for the code in question.
00146         Optional second argument is why it can't be converted.
00147         """
00148         lineno = node.get_lineno()
00149         self.log_message("Line %d: %s" % (lineno, reason))

Here is the call graph for this function:

Here is the caller graph for this function:


Member Data Documentation

Reimplemented from lib2to3.fixer_base.BaseFix.

Definition at line 87 of file fix_imports.py.

lib2to3.fixer_base.BaseFix.explicit = False [static, inherited]
lib2to3.fixer_base.BaseFix.filename = None [static, inherited]

Definition at line 29 of file fixer_base.py.

Definition at line 121 of file fixer_base.py.

Reimplemented from lib2to3.fixer_base.BaseFix.

Definition at line 88 of file fix_imports.py.

Definition at line 58 of file fixer_base.py.

lib2to3.fixer_base.BaseFix.logger = None [static, inherited]

Definition at line 30 of file fixer_base.py.

Reimplemented from lib2to3.fixes.fix_imports.FixImports.

Definition at line 16 of file fix_imports2.py.

tuple lib2to3.fixer_base.BaseFix.numbers = itertools.count(1) [static, inherited]

Definition at line 31 of file fixer_base.py.

Definition at line 159 of file fixer_base.py.

Definition at line 107 of file object.h.

struct _typeobject* _object::ob_type [inherited]

Definition at line 108 of file object.h.

lib2to3.fixer_base.BaseFix.options = None [static, inherited]

Definition at line 28 of file fixer_base.py.

string lib2to3.fixer_base.BaseFix.order = "post" [static, inherited]
lib2to3.fixer_base.BaseFix.pattern = None [static, inherited]

Definition at line 26 of file fixer_base.py.

Reimplemented from lib2to3.fixer_base.BaseFix.

Definition at line 102 of file fix_imports.py.

lib2to3.fixer_base.BaseFix.pattern_tree = None [static, inherited]

Definition at line 27 of file fixer_base.py.

Definition at line 120 of file fix_imports.py.

Reimplemented from lib2to3.fixes.fix_imports.FixImports.

Definition at line 14 of file fix_imports2.py.

Definition at line 47 of file fixer_base.py.

tuple lib2to3.fixer_base.BaseFix.used_names = set() [static, inherited]

Definition at line 32 of file fixer_base.py.

Definition at line 157 of file fixer_base.py.


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