astroid.objects.Property

class documentation

class Property(scoped_nodes.FunctionDef): (source)

View In Hierarchy

Class representing a Python property.

Method __init__ :param name: The name of the function. :type name: str or None
Method infer_call_result Infer what the function returns when called.
Method pytype Get the name of the type that this node represents.
Class Variable special_attributes The names of special attributes that this function has.
Class Variable type The function type for this node.
Instance Variable function Undocumented
Method _infer We don't know how to resolve a statement by default.
Instance Variable _doc The function docstring.

Inherited from FunctionDef:

Method block_range Get a range from the given line number to where this node ends.
Method bool_value Determine the boolean value of this node.
Method decoratornames Get the qualified names of each of the decorators on this function.
Method doc.setter Undocumented
Method frame The node's frame node.
Method get_children Get the child nodes below this node.
Method igetattr Inferred getattr, which returns an iterator of inferred statements.
Method implicit_parameters Undocumented
Method infer_yield_result Infer what the function yields when called
Method is_abstract Check if the method is abstract.
Method is_bound Check if the function is bound to an instance or class.
Method is_generator Check if this is a generator function.
Method is_method Check if this function node represents a method.
Method postinit Do some setup after initialisation.
Method scope_lookup Lookup where the given name is assigned.
Class Variable is_function Whether this node indicates a function.
Class Variable type_annotation If present, this will contain the type annotation passed by a type comment
Instance Variable args The arguments that the function takes.
Instance Variable body The contents of the function body.
Instance Variable decorators The decorators that are applied to this method or function.
Instance Variable doc_node The doc node associated with this node.
Instance Variable instance_attrs Undocumented
Instance Variable name The name of the function.
Instance Variable position Position of keyword(s) and name.
Instance Variable returns Undocumented
Instance Variable type_comment_args If present, this will contain the type annotation for arguments passed by a type comment
Instance Variable type_comment_returns If present, this will contain the return type annotation, passed by a type comment
Property blockstart_tolineno The line on which the beginning of this block ends.
Property doc The function docstring.
Property extra_decorators The extra decorators that this function can have.
Property fromlineno The first line that this node appears on in the source code.
Class Variable _astroid_fields Node attributes that contain child nodes.
Class Variable _multi_line_block_fields Undocumented
Class Variable _other_fields Node attributes that do not contain child nodes.
Class Variable _other_other_fields Attributes that contain AST-dependent fields.
Class Variable _type Undocumented

Inherited from Lambda (via FunctionDef):

Method argnames Get the names of each of the arguments, including that of the collections of variable-length arguments ("args", "kwargs", etc.), as well as positional-only and keyword-only arguments.
Method callable Whether this node defines something that is callable.
Method display_type A human readable type of this node.
Method getattr Undocumented
Class Variable is_lambda Undocumented
Instance Variable locals A map of the name of a local variable to the node defining it.

Inherited from LocalsDictNodeNG (via FunctionDef, Lambda):

Method __contains__ Check if a local is defined in this scope.
Method __getitem__ The first node the defines the given local.
Method __iter__ Iterate over the names of locals defined in this scoped node.
Method add_local_node Append a child that should alter the locals of this scope node.
Method items Get the names of the locals and the node that defines the local.
Method keys The names of locals defined in this scoped node.
Method qname Get the 'qualified' name of the node.
Method scope The first parent node defining a new scope.
Method set_local Define that the given name is declared in the given statement node.
Method values The nodes that define the locals in this scoped node.
Method _append_node append a child, linking it in the tree
Method _scope_lookup XXX method for interfacing the scope lookup

Inherited from LookupMixIn (via FunctionDef, Lambda, LocalsDictNodeNG):

Method ilookup Lookup the inferred values of the given variable.
Method lookup Lookup where the given variable is assigned.

Inherited from NodeNG (via FunctionDef, Lambda, LocalsDictNodeNG, LookupMixIn):

Method __repr__ Undocumented
Method __str__ Undocumented
Method accept Visit this node using the given visitor.
Method as_string Get the source code that this node represents.
Method child_sequence Search for the sequence that contains this child.
Method eq Undocumented
Method has_base Check if this node inherits from the given type.
Method infer Get a generator of the inferred values.
Method inferred Get a list of the inferred values.
Method instantiate_class Instantiate an instance of the defined class.
Method last_child An optimized version of list(get_children())[-1].
Method locate_child Find the field of this node that contains the given child.
Method next_sibling The next sibling statement node.
Method node_ancestors Yield parent, grandparent, etc until there are no more.
Method nodes_of_class Get the nodes (including this one or below) of the given types.
Method op_left_associative Undocumented
Method op_precedence Undocumented
Method parent_of Check if this node is the parent of the given node.
Method previous_sibling The previous sibling statement.
Method repr_tree Get a string representation of the AST from this node.
Method root Return the root node of the syntax tree.
Method statement The first parent node, including self, marked as statement node.
Class Variable is_statement Whether this node indicates a statement.
Class Variable optional_assign Whether this node optionally assigns a variable.
Instance Variable col_offset The column that this node appears on in the source code.
Instance Variable end_col_offset The end column this node appears on in the source code.
Instance Variable end_lineno The last line this node appears on in the source code.
Instance Variable lineno The line that this node appears on in the source code.
Instance Variable parent The parent node in the syntax tree.
Property tolineno The last line that this node appears on in the source code.
Method _fixed_source_line Attempt to find the line that this node appears on.
Method _get_assign_nodes Undocumented
Method _get_name_nodes Undocumented
Method _get_return_nodes_skip_functions Undocumented
Method _get_yield_nodes_skip_lambdas Undocumented
Method _infer_name Undocumented
Method _repr_name Get a name for nice representation.
Class Variable _explicit_inference Undocumented
@decorators.deprecate_arguments(doc='Use the postinit arg \'doc_node\' instead')
def __init__(self, function, name=None, doc=None, lineno=None, col_offset=None, parent=None): (source)
overrides astroid.nodes.scoped_nodes.FunctionDef.__init__

:param name: The name of the function. :type name: str or None :param doc: The function docstring. :param lineno: The line that this node appears on in the source code. :type lineno: int or None :param col_offset: The column that this node appears on in the source code. :type col_offset: int or None :param parent: The parent node in the syntax tree. :type parent: NodeNG or None :param end_lineno: The last line this node appears on in the source code. :type end_lineno: Optional[int] :param end_col_offset: The end column this node appears on in the source code. Note: This is after the last symbol. :type end_col_offset: Optional[int]

def infer_call_result(self, caller=None, context: InferenceContext|None = None): (source)
overrides astroid.nodes.scoped_nodes.FunctionDef.infer_call_result

Infer what the function returns when called. :returns: What the function returns. :rtype: iterable(NodeNG or Uninferable) or None

def pytype(self) -> Literal['builtins.property']: (source)
overrides astroid.nodes.scoped_nodes.Lambda.pytype

Get the name of the type that this node represents. :returns: The name of the type.

special_attributes = (source)
overrides astroid.nodes.scoped_nodes.Lambda.special_attributes

The names of special attributes that this function has.

type: str = (source)
overrides astroid.nodes.scoped_nodes.FunctionDef.type

The function type for this node. Possible values are: method, function, staticmethod, classmethod.

function = (source)

Undocumented

def _infer(self: _T, context: InferenceContext|None = None, **kwargs: Any) -> Generator[_T, None, None]: (source)
overrides astroid.nodes.NodeNG._infer

We don't know how to resolve a statement by default.

_doc = (source)
overrides astroid.nodes.scoped_nodes.FunctionDef._doc

The function docstring.