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 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432
|
# -*- coding: utf-8 -*-
import ast
import traceback
import warnings
import importlib
from typing import ( # NOQA
Dict,
List,
Tuple,
Union,
)
from django.apps.config import MODELS_MODULE_NAME
from django.utils.module_loading import import_string
from django_extensions.collision_resolvers import CollisionResolvingRunner
from django_extensions.import_subclasses import SubclassesFinder
from django_extensions.utils.deprecation import RemovedInNextVersionWarning
SHELL_PLUS_DJANGO_IMPORTS = [
"from django.core.cache import cache",
"from django.conf import settings",
"from django.contrib.auth import get_user_model",
"from django.db import transaction",
"from django.db.models import Avg, Case, Count, F, Max, Min, Prefetch, Q, Sum, When", # noqa: E501
"from django.utils import timezone",
"from django.urls import reverse",
"from django.db.models import Exists, OuterRef, Subquery",
]
class ObjectImportError(Exception):
pass
def get_app_name(mod_name):
"""
Retrieve application name from models.py module path
>>> get_app_name('testapp.models.foo')
'testapp'
'testapp' instead of 'some.testapp' for compatibility:
>>> get_app_name('some.testapp.models.foo')
'testapp'
>>> get_app_name('some.models.testapp.models.foo')
'testapp'
>>> get_app_name('testapp.foo')
'testapp'
>>> get_app_name('some.testapp.foo')
'testapp'
"""
rparts = list(reversed(mod_name.split(".")))
try:
try:
return rparts[rparts.index(MODELS_MODULE_NAME) + 1]
except ValueError:
# MODELS_MODULE_NAME ('models' string) is not found
return rparts[1]
except IndexError:
# Some weird model naming scheme like in Sentry.
return mod_name
def import_items(import_directives, style, quiet_load=False):
"""
Import the items in import_directives and return a list of the imported items
Each item in import_directives should be one of the following forms
* a tuple like ('module.submodule', ('classname1', 'classname2')), which indicates a 'from module.submodule import classname1, classname2'
* a tuple like ('module.submodule', 'classname1'), which indicates a 'from module.submodule import classname1'
* a tuple like ('module.submodule', '*'), which indicates a 'from module.submodule import *'
* a simple 'module.submodule' which indicates 'import module.submodule'.
Returns a dict mapping the names to the imported items
""" # noqa: E501
imported_objects = {}
for directive in import_directives:
if isinstance(directive, str):
directive = directive.strip()
try:
if isinstance(directive, str) and directive.startswith(
("from ", "import ")
):
try:
node = ast.parse(directive)
except Exception as exc:
if not quiet_load:
print(style.ERROR("Error parsing: %r %s" % (directive, exc)))
continue
if not all(
isinstance(body, (ast.Import, ast.ImportFrom)) for body in node.body
):
if not quiet_load:
print(
style.ERROR(
"Only specify import statements: %r" % directive
)
)
continue
if not quiet_load:
print(style.SQL_COLTYPE("%s" % directive))
for body in node.body:
if isinstance(body, ast.Import):
for name in body.names:
asname = name.asname or name.name
imported_objects[asname] = importlib.import_module(
name.name
)
if isinstance(body, ast.ImportFrom):
imported_object = importlib.__import__(
body.module, {}, {}, [name.name for name in body.names]
)
for name in body.names:
asname = name.asname or name.name
try:
if name.name == "*":
for k in dir(imported_object):
imported_objects[k] = getattr(
imported_object, k
)
else:
imported_objects[asname] = getattr(
imported_object, name.name
)
except AttributeError as exc:
print(
(
f"Couldn't find {name.name} in {body.module}. "
f"Only found: {dir(imported_object)}"
)
)
# raise
raise ImportError(exc)
else:
warnings.warn(
"Old style import definitions are deprecated. You should use the new style which is similar to normal Python imports. ", # noqa: E501
RemovedInNextVersionWarning,
stacklevel=2,
)
if isinstance(directive, str):
imported_object = __import__(directive)
imported_objects[directive.split(".")[0]] = imported_object
if not quiet_load:
print(style.SQL_COLTYPE("import %s" % directive))
continue
elif isinstance(directive, (list, tuple)) and len(directive) == 2:
if not isinstance(directive[0], str):
if not quiet_load:
print(
style.ERROR(
(
"Unable to import %r: module name must be of "
"type string"
)
% directive[0]
)
)
continue
if isinstance(directive[1], (list, tuple)) and all(
isinstance(e, str) for e in directive[1]
):
# Try the form of:
# ('module.submodule', ('classname1', 'classname2'))
imported_object = __import__(directive[0], {}, {}, directive[1])
imported_names = []
for name in directive[1]:
try:
imported_objects[name] = getattr(imported_object, name)
except AttributeError:
if not quiet_load:
print(
style.ERROR(
"Unable to import %r from %r: %r does not "
"exist" % (name, directive[0], name)
)
)
else:
imported_names.append(name)
if not quiet_load:
print(
style.SQL_COLTYPE(
"from %s import %s"
% (directive[0], ", ".join(imported_names))
)
)
elif isinstance(directive[1], str):
# If it is a tuple, but the second item isn't a list, so we have
# something like ('module.submodule', 'classname1')
# Check for the special '*' to import all
if directive[1] == "*":
imported_object = __import__(
directive[0], {}, {}, directive[1]
)
for k in dir(imported_object):
imported_objects[k] = getattr(imported_object, k)
if not quiet_load:
print(
style.SQL_COLTYPE("from %s import *" % directive[0])
)
else:
imported_object = getattr(
__import__(directive[0], {}, {}, [directive[1]]),
directive[1],
)
imported_objects[directive[1]] = imported_object
if not quiet_load:
print(
style.SQL_COLTYPE(
"from %s import %s"
% (directive[0], directive[1])
)
)
else:
if not quiet_load:
print(
style.ERROR(
"Unable to import %r from %r: names must be strings"
% (directive[1], directive[0])
)
)
else:
if not quiet_load:
print(
style.ERROR(
"Unable to import %r: names must be strings" % directive
)
)
except ImportError:
if not quiet_load:
print(style.ERROR("Unable to import %r" % directive))
return imported_objects
def import_objects(options, style):
from django.apps import apps
from django import setup
if not apps.ready:
setup()
from django.conf import settings
dont_load_cli = options.get("dont_load", [])
dont_load_conf = getattr(settings, "SHELL_PLUS_DONT_LOAD", [])
dont_load = dont_load_cli + dont_load_conf
dont_load_any_models = "*" in dont_load
quiet_load = options.get("quiet_load")
model_aliases = getattr(settings, "SHELL_PLUS_MODEL_ALIASES", {})
app_prefixes = getattr(settings, "SHELL_PLUS_APP_PREFIXES", {})
SHELL_PLUS_PRE_IMPORTS = getattr(settings, "SHELL_PLUS_PRE_IMPORTS", {})
imported_objects = {}
load_models = {}
def get_dict_from_names_to_possible_models(): # type: () -> Dict[str, List[str]]
"""
Collect dictionary from names to possible models. Model is represented as his full path.
Name of model can be alias if SHELL_PLUS_MODEL_ALIASES or SHELL_PLUS_APP_PREFIXES is specified for this model.
This dictionary is used by collision resolver.
At this phase we can't import any models, because collision resolver can change results.
:return: Dict[str, List[str]]. Key is name, value is list of full model's path's.
""" # noqa: E501
models_to_import = {} # type: Dict[str, List[str]]
for app_mod, models in sorted(load_models.items()):
app_name = get_app_name(app_mod)
app_aliases = model_aliases.get(app_name, {})
prefix = app_prefixes.get(app_name)
for model_name in sorted(models):
if "%s.%s" % (app_name, model_name) in dont_load:
continue
alias = app_aliases.get(model_name)
if not alias:
if prefix:
alias = "%s_%s" % (prefix, model_name)
else:
alias = model_name
models_to_import.setdefault(alias, [])
models_to_import[alias].append("%s.%s" % (app_mod, model_name))
return models_to_import
def import_subclasses():
base_classes_to_import = getattr(settings, "SHELL_PLUS_SUBCLASSES_IMPORT", []) # type: List[Union[str, type]]
if base_classes_to_import:
if not quiet_load:
print(style.SQL_TABLE("# Shell Plus Subclasses Imports"))
perform_automatic_imports(
SubclassesFinder(base_classes_to_import).collect_subclasses()
)
def import_models():
"""
Perform collision resolving and imports all models.
When collisions are resolved we can perform imports and print information's, because it is last phase.
This function updates imported_objects dictionary.
""" # noqa: E501
modules_to_models = CollisionResolvingRunner().run_collision_resolver(
get_dict_from_names_to_possible_models()
)
perform_automatic_imports(modules_to_models)
def perform_automatic_imports(modules_to_classes): # type: (Dict[str, List[Tuple[str, str]]]) -> ()
"""
Import elements from given dictionary.
:param modules_to_classes: dictionary from module name to tuple.
First element of tuple is model name, second is model alias.
If both elements are equal than element is imported without alias.
"""
for full_module_path, models in modules_to_classes.items():
model_labels = []
for model_name, alias in sorted(models):
try:
imported_objects[alias] = import_string(
"%s.%s" % (full_module_path, model_name)
)
if model_name == alias:
model_labels.append(model_name)
else:
model_labels.append("%s (as %s)" % (model_name, alias))
except ImportError as e:
if options.get("traceback"):
traceback.print_exc()
if not options.get("quiet_load"):
print(
style.ERROR(
"Failed to import '%s' from '%s' reason: %s"
% (model_name, full_module_path, str(e))
)
)
if not options.get("quiet_load"):
print(
style.SQL_COLTYPE(
"from %s import %s"
% (full_module_path, ", ".join(model_labels))
)
)
def get_apps_and_models():
for app in apps.get_app_configs():
if app.models_module:
yield app.models_module, app.get_models()
mongoengine = False
try:
from mongoengine.base import _document_registry
mongoengine = True
except ImportError:
pass
# Perform pre-imports before any other imports
if SHELL_PLUS_PRE_IMPORTS:
if not quiet_load:
print(style.SQL_TABLE("# Shell Plus User Pre Imports"))
imports = import_items(SHELL_PLUS_PRE_IMPORTS, style, quiet_load=quiet_load)
for k, v in imports.items():
imported_objects[k] = v
if mongoengine and not dont_load_any_models:
for name, mod in _document_registry.items():
name = name.split(".")[-1]
app_name = get_app_name(mod.__module__)
if app_name in dont_load or ("%s.%s" % (app_name, name)) in dont_load:
continue
load_models.setdefault(mod.__module__, [])
load_models[mod.__module__].append(name)
if not dont_load_any_models:
for app_mod, app_models in get_apps_and_models():
if not app_models:
continue
app_name = get_app_name(app_mod.__name__)
if app_name in dont_load:
continue
for mod in app_models:
if "%s.%s" % (app_name, mod.__name__) in dont_load:
continue
if mod.__module__:
# Only add the module to the dict if `__module__` is not empty.
load_models.setdefault(mod.__module__, [])
load_models[mod.__module__].append(mod.__name__)
import_subclasses()
if not quiet_load:
print(
style.SQL_TABLE("# Shell Plus Model Imports%s")
% (" SKIPPED" if dont_load_any_models else "")
)
import_models()
# Imports often used from Django
if getattr(settings, "SHELL_PLUS_DJANGO_IMPORTS", True):
if not quiet_load:
print(style.SQL_TABLE("# Shell Plus Django Imports"))
imports = import_items(SHELL_PLUS_DJANGO_IMPORTS, style, quiet_load=quiet_load)
for k, v in imports.items():
imported_objects[k] = v
SHELL_PLUS_IMPORTS = getattr(settings, "SHELL_PLUS_IMPORTS", {})
if SHELL_PLUS_IMPORTS:
if not quiet_load:
print(style.SQL_TABLE("# Shell Plus User Imports"))
imports = import_items(SHELL_PLUS_IMPORTS, style, quiet_load=quiet_load)
for k, v in imports.items():
imported_objects[k] = v
# Perform post-imports after any other imports
SHELL_PLUS_POST_IMPORTS = getattr(settings, "SHELL_PLUS_POST_IMPORTS", {})
if SHELL_PLUS_POST_IMPORTS:
if not quiet_load:
print(style.SQL_TABLE("# Shell Plus User Post Imports"))
imports = import_items(SHELL_PLUS_POST_IMPORTS, style, quiet_load=quiet_load)
for k, v in imports.items():
imported_objects[k] = v
return imported_objects
|