org.python.indexer.ast

Class NFunctionDef

java.lang.Object

org.python.indexer.ast.NNode

org.python.indexer.ast.NFunctionDef

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

NLambda

public class NFunctionDef
extends NNode

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
java.util.List<NNode>	args
NNode	body
java.util.List<NNode>	defaults
NName	kwargs
NName	name
NName	varargs

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

parent

Constructor Summary

Constructors

Constructor and Description
NFunctionDef(NName name, java.util.List<NNode> args, NBlock body, java.util.List<NNode> defaults, NName varargs, NName kwargs)
NFunctionDef(NName name, java.util.List<NNode> args, NBlock body, java.util.List<NNode> defaults, NName varargs, NName kwargs, int start, int end)

Method Summary

Modifier and Type	Method and Description
protected NBinding	addReadOnlyAttr(java.lang.String name, NType type, NBinding.Kind kind)
protected NBinding	addSpecialAttr(java.lang.String name, NType atype, NBinding.Kind kind)
protected void	bindFunctionDefaults(Scope s) Processes any name-binding constructs appearing as parameter defaults.
protected void	bindFunctionName(Scope owner)
protected void	bindFunctionParams(Scope funcTable)
protected void	bindMethodAttrs(Scope owner)
protected void	bindNames(Scope s) Called by resolver to bind names into the passed scope.
boolean	bindsName() Returns true if this is a name-binding node.
protected java.lang.String	getBindingName(Scope s) Returns the name of the function for indexing/qname purposes.
java.util.List<NNode>	getDecoratorList()
boolean	isFunctionDef()
NType	resolve(Scope outer) Node should set the resolved type in its NNode.type field and also return it.
void	setDecoratorList(java.util.List<NNode> decoratorList)
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, end, getAstRoot, getDeepestNodeAtOffset, getEnclosingNamespace, getFile, getParent, getTable, getType, isCall, isClassDef, 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 NName name

args

public java.util.List<NNode> args

defaults

public java.util.List<NNode> defaults

varargs

public NName varargs

kwargs

public NName kwargs

body

public NNode body

Constructor Detail

NFunctionDef

public NFunctionDef(NName name,
                    java.util.List<NNode> args,
                    NBlock body,
                    java.util.List<NNode> defaults,
                    NName varargs,
                    NName kwargs)

NFunctionDef

public NFunctionDef(NName name,
                    java.util.List<NNode> args,
                    NBlock body,
                    java.util.List<NNode> defaults,
                    NName varargs,
                    NName kwargs,
                    int start,
                    int end)

Method Detail

setDecoratorList

public void setDecoratorList(java.util.List<NNode> decoratorList)

getDecoratorList

public java.util.List<NNode> getDecoratorList()

isFunctionDef

public boolean isFunctionDef()

Overrides:

isFunctionDef in class NNode

bindsName

public boolean bindsName()

Description copied from class: NNode

Returns true if this is a name-binding node. Includes functions/lambdas, function/lambda params, classes, assignments, imports, and implicit assignment via for statements and except clauses.

Overrides:

bindsName in class NNode

See Also:

PEP 227

getBindingName

protected java.lang.String getBindingName(Scope s)

Returns the name of the function for indexing/qname purposes. Lambdas will return a generated name.

bindNames

protected void bindNames(Scope s)
                  throws java.lang.Exception

Description copied from class: NNode

Called by resolver to bind names into the passed scope.

Overrides:

bindNames in class NNode

Throws:

java.lang.Exception

bindFunctionName

protected void bindFunctionName(Scope owner)
                         throws java.lang.Exception

Throws:

java.lang.Exception

bindFunctionParams

protected void bindFunctionParams(Scope funcTable)
                           throws java.lang.Exception

Throws:

java.lang.Exception

bindFunctionDefaults

protected void bindFunctionDefaults(Scope s)
                             throws java.lang.Exception

Processes any name-binding constructs appearing as parameter defaults. For instance, in def foo(converter=lambda name: name.upper()): ... the lambda is a name-binding construct.

Throws:

java.lang.Exception

bindMethodAttrs

protected void bindMethodAttrs(Scope owner)
                        throws java.lang.Exception

Throws:

java.lang.Exception

addSpecialAttr

protected NBinding addSpecialAttr(java.lang.String name,
                                  NType atype,
                                  NBinding.Kind kind)

addReadOnlyAttr

protected NBinding addReadOnlyAttr(java.lang.String name,
                                   NType type,
                                   NBinding.Kind kind)

resolve

public NType resolve(Scope outer)
              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

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.