org.python.indexer.ast

Class NModule

java.lang.Object

org.python.indexer.ast.NNode

org.python.indexer.ast.NModule

All Implemented Interfaces:

java.io.Serializable

public class NModule
extends NNode

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
NBody	body
java.lang.String	name

Fields inherited from class org.python.indexer.ast.NNode

parent

Constructor Summary

Constructors

Constructor and Description
NModule()
NModule(NBlock body, int start, int end)
NModule(java.lang.String name)

Method Summary

Modifier and Type	Method and Description
java.util.List<NStr>	getExportedNameNodes() If the module defines an __all__ variable, returns the string elements of the variable's list value.
java.util.List<java.lang.String>	getExportedNames() Attempt to determine the actual value of the "__all__" variable in the target module.
java.lang.String	getFile()
java.lang.String	getMD5()
NType	resolve(Scope s) Node should set the resolved type in its NNode.type field and also return it.
void	setFile(java.io.File path)
void	setFile(java.lang.String file)
void	setFileAndMD5(java.lang.String path, java.lang.String md5) Used when module is parsed from an in-memory string.
java.lang.String	toLongString()
java.lang.String	toString()
void	visit(NNodeVisitor v) Visits this node and optionally its children.

Methods inherited from class org.python.indexer.ast.NNode

addChildren, addChildren, addError, addError, addType, addWarning, addWarning, bindNames, bindsName, end, getAstRoot, getDeepestNodeAtOffset, getEnclosingNamespace, getParent, getTable, getType, isCall, isClassDef, isFunctionDef, isLambda, isModule, isName, length, resolveExpr, resolveList, resolveListAsUnion, setEnd, setParent, setStart, setType, start, visitNode, visitNodeList

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

name

public java.lang.String name

body

public NBody body

Constructor Detail

NModule

public NModule()

NModule

public NModule(java.lang.String name)

NModule

public NModule(NBlock body,
               int start,
               int end)

Method Detail

setFile

public void setFile(java.lang.String file)
             throws java.lang.Exception

Throws:

java.lang.Exception

setFile

public void setFile(java.io.File path)
             throws java.lang.Exception

Throws:

java.lang.Exception

setFileAndMD5

public void setFileAndMD5(java.lang.String path,
                          java.lang.String md5)
                   throws java.lang.Exception

Used when module is parsed from an in-memory string.

Parameters:

path - file path

md5 - md5 message digest for source contents

Throws:

java.lang.Exception

getFile

public java.lang.String getFile()

Overrides:

getFile in class NNode

Returns:

the path to the code that generated this AST

getMD5

public java.lang.String getMD5()

resolve

public NType resolve(Scope s)
              throws java.lang.Exception

Description copied from class: NNode

Node should set the resolved type in its NNode.type field and also return it.

Overrides:

resolve in class NNode

Throws:

java.lang.Exception

getExportedNames

public java.util.List<java.lang.String> getExportedNames()
                                                  throws java.lang.Exception

Attempt to determine the actual value of the "__all__" variable in the target module. If we can parse it, return the list of exported names.

Returns:

the list of exported names. Returns null if __all__ is missing, or if its initializer is not a simple list of strings. We don't generate a warning, since complex expressions such as __all__ = [name for name in dir() if name[0] == "e"] are valid provided the expr result is a string list.

Throws:

java.lang.Exception

getExportedNameNodes

public java.util.List<NStr> getExportedNameNodes()
                                          throws java.lang.Exception

If the module defines an __all__ variable, returns the string elements of the variable's list value.

Returns:

any exported name nodes found, or an empty list if none found

Throws:

java.lang.Exception

toLongString

public java.lang.String toLongString()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

visit

public void visit(NNodeVisitor v)

Description copied from class: NNode

Visits this node and optionally its children.

Specified by:

visit in class NNode

Parameters:

v - the object to call with this node. If the visitor returns true, the node also passes its children to the visitor.