1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251
|
"""
Module to wrap dirty stuff of django core.
"""
import django
from django.apps import apps
from django.db import models # noqa
from django.db.models import *
from django.db.models.fields import NOT_PROVIDED, AutoField
from django.db.models.base import ModelBase
from django.db.models.query import QuerySet
try:
from django.db.models.fields import FieldDoesNotExist
except ImportError:
from django.core.exceptions import FieldDoesNotExist
def django_greater_than(major, minor=0):
return django.VERSION[:2] > (major, minor)
# Apps
def get_apps(application_labels=[], exclude_application_labels=[]):
"""
- if not @application_labels and not @exclude_application_labels, it returns all applications.
- if @application_labels is not None, it returns just these applications,
except applications with label in exclude_application_labels.
@Returns an array of application labels.
"""
if application_labels:
applications = []
for app_label in application_labels:
app_config = apps.get_app_config(app_label)
applications.append(app_config.label)
else:
applications = [
app_config.label
for app_config in apps.get_app_configs()
]
if exclude_application_labels:
for app_label in exclude_application_labels:
if app_label:
if app_label in applications:
applications.remove(app_label)
else:
raise ValueError(
f"Excluded application with label '{app_label}' "
"is not installed.")
return applications
def get_app_name(app_module):
"""
app is the object (python module) returned by get_apps method
"""
return app_module.__name__.split('.')[0]
def get_models_of_an_app(app_label):
"""
app_module is the object returned by get_apps method (python module)
"""
app_config = apps.get_app_config(app_label)
return list(app_config.get_models())
# Models
def get_app_name_of_model(model_class):
return model_class.__module__.split('.')[0]
def get_model_name(model_class):
"Example: ModelName"
return model_class.__name__
def get_unique_model_name(model_class):
"Example: app.packages.ModelName"
return model_class.__module__ + '.' + model_class.__name__
def get_fields_from_model(model_class):
"Returns all fields, including inherited fields but ignoring M2M fields."
return model_class._meta.fields
def get_local_fields(model):
"Returns all local fields!?"
return model._meta.local_fields
def get_many_to_many_fields_from_model(model_class):
"Return only M2M fields, including inherited ones?"
return model_class._meta.many_to_many
#_meta.local_many_to_many
def get_all_fields_of_model(model_class):
fields1 = get_fields_from_model(model_class)
fields2 = get_many_to_many_fields_from_model(model_class)
fields1.extend(fields2)
return fields1
def get_field_names_of_model(model_class):
"Get field names, including inherited fields, except M2M fields."
fields = get_fields_from_model(model_class)
return [field.name for field in fields]
def get_field_by_name_or_raise(model_class, field_name):
"Get field by name, including inherited fields and M2M fields."
return model_class._meta.get_field(field_name)
def is_model_class(instance_or_model_class):
"True if model_class is a Django Model."
return isinstance(instance_or_model_class, Model) or instance_or_model_class.__class__ == ModelBase
def is_model_abstract(model):
"True if abstract is True in Meta class"
return model._meta.abstract
def is_model_managed(model):
"True if managed is True in Meta class"
return model._meta.managed
def model_has_the_field(model_class, field_name):
""
try:
get_field_by_name_or_raise(model_class, field_name)
return True
except FieldDoesNotExist:
return False
# Fields
def get_unique_field_name(field):
if hasattr(field, 'model'):
return get_unique_model_name(field.model) + '.' + field.name
return field.name or ''
def get_related_model(field):
return field.remote_field.model if hasattr(field, 'remote_field') else field.rel.to
def field_is_a_parent_link(field):
# FIXME
#return hasattr(field, 'rel') and hasattr(field.rel, 'parent_link') and field.rel.parent_link
return hasattr(field, 'parent_link') and field.parent_link
def field_has_choices(field):
"""field.choices may be a tee, which we can't count without converting
it to a list, or it may be a large database queryset, in which case we
don't want to convert it to a list. We only care if the list is empty
or not, so just try to access the first element and return True if that
doesn't throw an exception."""
if not field.choices:
return False
for i in field.choices:
return True
return False
def field_has_default_value(field):
return field.default != NOT_PROVIDED
def field_is_unique(field):
return field.unique
def is_key_field(field):
return isinstance(field, AutoField)
def is_relationship_field(field):
return isinstance(field, (ForeignKey, OneToOneField))
def is_file_field(field):
return isinstance(field, FileField)
def print_field_values_of_a_model(model_instance):
"Print values from all fields of a model instance."
if model_instance == None:
print('\n:: Model Unknown: None')
else:
print('\n:: Model %s (%s)' % (get_unique_model_name(model_instance.__class__), model_instance.pk))
for field in get_fields_from_model(model_instance.__class__):
try:
value = getattr(model_instance, field.name)
except Exception as e:
value = repr(e)
print('%s: %s' % (field.name, value))
if model_instance.pk is not None:
for field in get_many_to_many_fields_from_model(model_instance.__class__):
print('%s: %s' % (field.name, getattr(model_instance, field.name).all()))
def print_field_values(model_instance_or_list_of_model_instances_or_queryset):
"Print values from all fields of a model instance or a list of model instances."
if isinstance(model_instance_or_list_of_model_instances_or_queryset, (list, tuple, QuerySet)):
for model_instance in model_instance_or_list_of_model_instances_or_queryset:
print_field_values_of_a_model(model_instance)
else:
model_instance = model_instance_or_list_of_model_instances_or_queryset
print_field_values_of_a_model(model_instance)
def enable_auto_now(field):
if hasattr(field, 'auto_now'):
field.auto_now = True
def disable_auto_now(field):
if hasattr(field, 'auto_now'):
field.auto_now = False
def enable_auto_now_add(field):
if hasattr(field, 'auto_now_add'):
field.auto_now_add = True
def disable_auto_now_add(field):
if hasattr(field, 'auto_now_add'):
field.auto_now_add = False
def is_boolean(field):
return isinstance(field, (BooleanField, NullBooleanField))
def is_string(field):
return isinstance(field, (CharField, EmailField, IPAddressField, SlugField, URLField))
def is_number(field):
return isinstance(field, (IntegerField, SmallIntegerField, PositiveIntegerField,
PositiveSmallIntegerField, BigIntegerField, CommaSeparatedIntegerField, DecimalField, FloatField))
def is_datetime(field):
return isinstance(field, (DateTimeField, DateField, TimeField))
def is_file(field):
return isinstance(field, (FileField, FilePathField))
def is_binary(field):
return isinstance(field, (BinaryField))
|