def build_function(
name,
args: Optional[List[str]] = None,
posonlyargs: Optional[List[str]] = None,
defaults=None,
doc=None,
kwonlyargs: Optional[List[str]] = None,
) -> nodes.FunctionDef:
"""create and initialize an astroid FunctionDef node"""
# first argument is now a list of decorators
func = nodes.FunctionDef(name, doc)
func.args = argsnode = nodes.Arguments(parent=func)
argsnode.postinit(
args=[
nodes.AssignName(name=arg, parent=argsnode) for arg in args or ()
],
defaults=[],
kwonlyargs=[
nodes.AssignName(name=arg, parent=argsnode)
for arg in kwonlyargs or ()
],
kw_defaults=[],
annotations=[],
posonlyargs=[
nodes.AssignName(name=arg, parent=argsnode)
for arg in posonlyargs or ()
],
)
for default in defaults or ():
argsnode.defaults.append(nodes.const_factory(default))
argsnode.defaults[-1].parent = argsnode
if args:
register_arguments(func)
return func
def build_function(
name: str,
args: list[str] | None = None,
posonlyargs: list[str] | None = None,
defaults: list[Any] | None = None,
doc: str | None = None,
kwonlyargs: list[str] | None = None,
) -> nodes.FunctionDef:
"""create and initialize an astroid FunctionDef node"""
# first argument is now a list of decorators
func = nodes.FunctionDef(name)
argsnode = nodes.Arguments(parent=func)
# If args is None we don't have any information about the signature
# (in contrast to when there are no arguments and args == []). We pass
# this to the builder to indicate this.
if args is not None:
arguments = [
nodes.AssignName(name=arg, parent=argsnode) for arg in args
]
else:
arguments = None
argsnode.postinit(
args=arguments,
defaults=[],
kwonlyargs=[
nodes.AssignName(name=arg, parent=argsnode)
for arg in kwonlyargs or ()
],
kw_defaults=[],
annotations=[],
posonlyargs=[
nodes.AssignName(name=arg, parent=argsnode)
for arg in posonlyargs or ()
],
)
func.postinit(
args=argsnode,
body=[],
doc_node=nodes.Const(value=doc) if doc else None,
)
for default in defaults or ():
argsnode.defaults.append(nodes.const_factory(default))
argsnode.defaults[-1].parent = argsnode
if args:
register_arguments(func)
return func
def visit_name(self, node, parent):
"""visit a Name node by returning a fresh instance of it"""
context = self._get_context(node)
# True and False can be assigned to something in py2x, so we have to
# check first the context.
if context == astroid.Del:
newnode = nodes.DelName(node.id, node.lineno, node.col_offset,
parent)
elif context == astroid.Store:
newnode = nodes.AssignName(node.id, node.lineno, node.col_offset,
parent)
elif node.id in CONST_NAME_TRANSFORMS:
newnode = nodes.Const(
CONST_NAME_TRANSFORMS[node.id],
getattr(node, "lineno", None),
getattr(node, "col_offset", None),
parent,
)
return newnode
else:
newnode = nodes.Name(node.id, node.lineno, node.col_offset, parent)
# XXX REMOVE me :
if context in (astroid.Del, astroid.Store): # 'Aug' ??
self._save_assignment(newnode)
return newnode
def transform_function(node):
assign = nodes.Assign()
name = nodes.AssignName()
name.name = "value"
assign.targets = [name]
assign.value = nodes.const_factory(42)
node.body.append(assign)
def visit_assignname(self, node, parent, assign_ctx=None, node_name=None):
'''visit a node and return a AssName node'''
newnode = new.AssignName()
_set_infos(node, newnode, parent)
newnode.name = node_name
self._save_assignment(newnode)
return newnode
def visit_assignname(self, node, parent, node_name=None):
"""visit a node and return a AssignName node"""
newnode = nodes.AssignName(
node_name,
getattr(node, "lineno", None),
getattr(node, "col_offset", None),
parent,
)
self._save_assignment(newnode)
return newnode
def test_assname(node):
if node.name == "foo":
return nodes.AssignName("bar", node.lineno, node.col_offset,
node.parent)
return None
def visit_assignname(self, node, parent, node_name=None):
'''visit a node and return a AssignName node'''
newnode = nodes.AssignName(node_name, getattr(node, 'lineno', None),
getattr(node, 'col_offset', None), parent)
self._save_assignment(newnode)
return newnode
def transform_function(node):
name = nodes.AssignName()
name.name = "value"
node.args.args = [name]
return node
def transform_function(node: FunctionDef) -> None:
assign = nodes.Assign()
name = nodes.AssignName(name="value")
assign.targets = [name]
assign.value = nodes.const_factory(42)
node.body.append(assign)
def transform_function(node: FunctionDef) -> FunctionDef:
name = nodes.AssignName(name="value")
node.args.args = [name]
return node
def test_assname(node):
if node.name == 'foo':
return nodes.AssignName('bar', node.lineno, node.col_offset,
node.parent)
def test_assname(node):
if node.name == 'foo':
n = nodes.AssignName()
n.name = 'bar'
return n
def transform(cls: nodes.ClassDef):
"""
Astroid (used by pylint) calls this function on each class definition it discovers.
cls is an Astroid AST representation of that class.
Our purpose here is to extract the schema dict from API model classes
so that we can inform pylint about all of the attributes on those models.
We do this by injecting attributes on the class for each property in the schema.
"""
# This is a class which defines attributes in "schema" variable using json schema.
# Those attributes are then assigned during run time inside the constructor
# Get the value node for the "schema =" assignment
schema_dict_node = next(cls.igetattr("schema"))
extra_schema_properties = {}
# If the "schema =" assignment's value node is not a simple type (like a dictionary),
# then pylint cannot infer exactly what it does. Most of the time, this is actually
# a function call to copy the schema from another class. So, let's find the dictionary.
if schema_dict_node is astroid.Uninferable:
# the assignment probably looks like this:
# schema = copy.deepcopy(ActionAPI.schema)
# so far we only have the value, but we need the actual assignment
assigns = [
n for n in cls.get_children() if isinstance(n, nodes.Assign)
]
schema_assign_name_node = cls.local_attr("schema")[0]
schema_assign_node = next(
assign for assign in assigns
if assign.targets[0] == schema_assign_name_node)
assigns.remove(schema_assign_node)
# We only care about "schema = copy.deepcopy(...)"
schema_dict_node = infer_copy_deepcopy(schema_assign_node.value)
if not schema_dict_node:
# This is not an API model class, as it doesn't have
# something we can resolve to a dictionary.
return
# OK, now we need to look for any properties that dynamically modify
# the dictionary that was just copied from somewhere else.
# See the note below for why we only care about "properties" here.
for assign_node in assigns:
# we're looking for assignments like this:
# schema["properties"]["ttl"] = {...}
target = assign_node.targets[0]
try:
if (isinstance(target, nodes.Subscript)
and target.value.value.name == "schema"
and target.value.slice.value.value == "properties"):
property_name_node = target.slice.value
else:
# not schema["properties"]
continue
except AttributeError:
continue
# schema["properties"]["execution"] = copy.deepcopy(ActionExecutionAPI.schema)
inferred_value = infer_copy_deepcopy(assign_node.value)
extra_schema_properties[property_name_node] = (
inferred_value if inferred_value else assign_node.value)
if not isinstance(schema_dict_node, nodes.Dict):
# Not a class we are interested in (like BaseAPI)
return
# We only care about "properties" in the schema because that's the only part of the schema
# that gets translated into dynamic attributes on the model API class.
properties_dict_node = None
for key_node, value_node in schema_dict_node.items:
if key_node.value == "properties":
properties_dict_node = value_node
break
if not properties_dict_node and not extra_schema_properties:
# Not a class we can do anything with
return
# Hooray! We have the schema properties dict now, so we can start processing
# each property and add an attribute for each one to the API model class node.
for property_name_node, property_data_node in properties_dict_node.items + list(
extra_schema_properties.items()):
property_name = property_name_node.value.replace(
"-", "_") # Note: We do the same in Python code
# Despite the processing above to extract the schema properties dictionary
# each property in the dictionary might also reference other variables,
# so we still need to resolve these to figure out each property's type.
# an indirect reference to copy.deepcopy() as in:
# REQUIRED_ATTR_SCHEMAS = {"action": copy.deepcopy(ActionAPI.schema)}
# schema = {"properties": {"action": REQUIRED_ATTR_SCHEMAS["action"]}}
if isinstance(property_data_node, nodes.Subscript):
var_name = property_data_node.value.name
subscript = property_data_node.slice.value.value
# lookup var by name (assume its at module level)
var_node = next(cls.root().igetattr(var_name))
# assume it is a dict at this point
data_node = None
for key_node, value_node in var_node.items:
if key_node.value == subscript:
# infer will resolve a Dict
data_node = next(value_node.infer())
if data_node is astroid.Uninferable:
data_node = infer_copy_deepcopy(value_node)
break
if data_node:
property_data_node = data_node
if not isinstance(property_data_node, nodes.Dict):
# if infer_copy_deepcopy already ran, we may need to resolve the dict
data_node = next(property_data_node.infer())
if data_node is not astroid.Uninferable:
property_data_node = data_node
property_type_node = None
if isinstance(property_data_node, nodes.Dict):
# We have a property schema, but we only care about the property's type.
for property_key_node, property_value_node in property_data_node.items:
if property_key_node.value == "type":
property_type_node = next(property_value_node.infer())
break
if property_type_node is None and isinstance(property_data_node,
nodes.Attribute):
# reference schema from another file like this:
# from ... import TriggerAPI
# schema = {"properties": {"trigger": TriggerAPI.schema}}
# We only pull a schema from another file when it is an "object" (a dict).
# So, we do not need to do any difficult cross-file processing.
property_type = "object"
elif property_type_node is None:
property_type = None
elif isinstance(property_type_node, nodes.Const):
property_type = property_type_node.value
elif isinstance(property_type_node, (nodes.List, nodes.Tuple)):
# Hack for attributes with multiple types (e.g. string, null)
property_type = property_type_node.elts[
0].value # elts has "elements" in the list/tuple
else:
# We should only hit this if someone has used a different approach
# for dynamically constructing the property's schema.
# Expose the AST at this point to facilitate handling that approach.
raise Exception(property_type_node.repr_tree())
# Hooray! We've got a property's name at this point.
# And we have the property's type, if that type was defined in the schema.
# Now, we can construct the AST node that we'll add to the API model class.
if property_type == "object":
node = nodes.Dict()
elif property_type == "array":
node = nodes.List()
elif property_type == "integer":
node = scoped_nodes.builtin_lookup("int")[1][0]
elif property_type == "number":
node = scoped_nodes.builtin_lookup("float")[1][0]
elif property_type == "string":
node = scoped_nodes.builtin_lookup("str")[1][0]
elif property_type == "boolean":
node = scoped_nodes.builtin_lookup("bool")[1][0]
elif property_type == "null":
node = scoped_nodes.builtin_lookup("None")[1][0]
else:
# Unknown type
node = astroid.ClassDef(property_name, None)
# Create a "property = node" assign node
assign_node = nodes.Assign(parent=cls)
assign_name_node = nodes.AssignName(property_name, parent=assign_node)
assign_node.postinit(targets=[assign_name_node], value=node)
# Finally, add the property node as an attribute on the class.
cls.locals[property_name] = [assign_name_node]
