Files
jedi/jedi/plugins/django.py
2020-04-22 00:41:59 +02:00

111 lines
3.8 KiB
Python

"""
Module is used to infer Django model fields.
Bugs:
- Can't infer User model.
- Can't infer ManyToManyField.
"""
from jedi import debug
from jedi.inference.base_value import LazyValueWrapper
from jedi.inference.utils import safe_property
from jedi.inference.filters import ParserTreeFilter, DictFilter
from jedi.inference.names import ValueName
from jedi.inference.value.instance import TreeInstance
class DjangoModelField(LazyValueWrapper):
def __init__(self, cls, name):
self.inference_state = cls.inference_state
self._cls = cls
self._name = name
self.tree_node = self._name.tree_name
@safe_property
def name(self):
return ValueName(self, self._name.tree_name)
def _get_wrapped_value(self):
obj, = self._cls.execute_with_values()
return obj
mapping = {
'IntegerField': (None, 'int'),
'BigIntegerField': (None, 'int'),
'PositiveIntegerField': (None, 'int'),
'SmallIntegerField': (None, 'int'),
'CharField': (None, 'str'),
'TextField': (None, 'str'),
'EmailField': (None, 'str'),
'FloatField': (None, 'float'),
'BinaryField': (None, 'bytes'),
'BooleanField': (None, 'bool'),
'DecimalField': ('decimal', 'Decimal'),
'TimeField': ('datetime', 'time'),
'DurationField': ('datetime', 'timedelta'),
'DateField': ('datetime', 'date'),
'DateTimeField': ('datetime', 'datetime'),
}
def _infer_scalar_field(inference_state, field_name, field_tree_instance):
try:
module_name, attribute_name = mapping[field_tree_instance.py__name__()]
except KeyError:
return None
if module_name is None:
module = inference_state.builtins_module
else:
module = inference_state.import_module((module_name,))
attribute, = module.py__getattribute__(attribute_name)
return DjangoModelField(attribute, field_name)
def _infer_field(cls, field_name):
inference_state = cls.inference_state
field_tree_instance, = field_name.infer()
scalar_field = _infer_scalar_field(inference_state, field_name, field_tree_instance)
if scalar_field:
return scalar_field
if field_tree_instance.py__name__() == 'ForeignKey':
if isinstance(field_tree_instance, TreeInstance):
# TODO private access..
argument_iterator = field_tree_instance._arguments.unpack()
key, lazy_values = next(argument_iterator, (None, None))
if key is None and lazy_values is not None:
for value in lazy_values.infer():
if value.py__name__() == 'str':
foreign_key_class_name = value.get_safe_value()
for v in cls.get_root_context().py__getattribute__(foreign_key_class_name):
if v.is_class():
return DjangoModelField(v, field_name)
elif value.is_class():
return DjangoModelField(value, field_name)
debug.dbg('django plugin: fail to infer `%s` from class `%s`',
field_name.string_name, cls.py__name__())
return None
def _new_dict_filter(cls):
def iterate():
filter_ = ParserTreeFilter(parent_context=cls.as_context())
for name in filter_.values():
django_field = _infer_field(cls, name)
if django_field is not None:
yield name.string_name, django_field.name
return DictFilter(dict(iterate()))
def get_metaclass_filters(func):
def wrapper(cls, metaclasses):
for metaclass in metaclasses:
if metaclass.py__name__() == 'ModelBase' \
and metaclass.get_root_context().py__name__() == 'django.db.models.base':
return [_new_dict_filter(cls)]
return func(cls, metaclasses)
return wrapper