Development of an internal social media platform with personalised dashboards for students
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

imports.py 33KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807
  1. # -*- coding: utf-8 -*-
  2. # Copyright (c) 2006-2015 LOGILAB S.A. (Paris, FRANCE) <contact@logilab.fr>
  3. # Copyright (c) 2012-2014 Google, Inc.
  4. # Copyright (c) 2013 buck@yelp.com <buck@yelp.com>
  5. # Copyright (c) 2014-2017 Claudiu Popa <pcmanticore@gmail.com>
  6. # Copyright (c) 2014 Brett Cannon <brett@python.org>
  7. # Copyright (c) 2014 Arun Persaud <arun@nubati.net>
  8. # Copyright (c) 2015-2016 Moises Lopez <moylop260@vauxoo.com>
  9. # Copyright (c) 2015 Dmitry Pribysh <dmand@yandex.ru>
  10. # Copyright (c) 2015 Cezar <celnazli@bitdefender.com>
  11. # Copyright (c) 2015 Florian Bruhin <me@the-compiler.org>
  12. # Copyright (c) 2015 Noam Yorav-Raphael <noamraph@gmail.com>
  13. # Copyright (c) 2015 James Morgensen <james.morgensen@gmail.com>
  14. # Copyright (c) 2015 Ionel Cristian Maries <contact@ionelmc.ro>
  15. # Copyright (c) 2016 Jared Garst <cultofjared@gmail.com>
  16. # Copyright (c) 2016 Maik Röder <maikroeder@gmail.com>
  17. # Copyright (c) 2016 Glenn Matthews <glenn@e-dad.net>
  18. # Copyright (c) 2016 Ashley Whetter <ashley@awhetter.co.uk>
  19. # Copyright (c) 2017 hippo91 <guillaume.peillex@gmail.com>
  20. # Copyright (c) 2017 Michka Popoff <michkapopoff@gmail.com>
  21. # Copyright (c) 2017 Łukasz Rogalski <rogalski.91@gmail.com>
  22. # Copyright (c) 2017 Erik Wright <erik.wright@shopify.com>
  23. # Licensed under the GPL: https://www.gnu.org/licenses/old-licenses/gpl-2.0.html
  24. # For details: https://github.com/PyCQA/pylint/blob/master/COPYING
  25. """imports checkers for Python code"""
  26. import collections
  27. from distutils import sysconfig
  28. import os
  29. import sys
  30. import copy
  31. import six
  32. import astroid
  33. from astroid import are_exclusive
  34. from astroid.modutils import (get_module_part, is_standard_module)
  35. import isort
  36. from pylint.interfaces import IAstroidChecker
  37. from pylint.utils import get_global_option
  38. from pylint.exceptions import EmptyReportError
  39. from pylint.checkers import BaseChecker
  40. from pylint.checkers.utils import (
  41. check_messages,
  42. node_ignores_exception,
  43. is_from_fallback_block
  44. )
  45. from pylint.graph import get_cycles, DotBackend
  46. from pylint.reporters.ureports.nodes import VerbatimText, Paragraph
  47. def _qualified_names(modname):
  48. """Split the names of the given module into subparts
  49. For example,
  50. _qualified_names('pylint.checkers.ImportsChecker')
  51. returns
  52. ['pylint', 'pylint.checkers', 'pylint.checkers.ImportsChecker']
  53. """
  54. names = modname.split('.')
  55. return ['.'.join(names[0:i+1]) for i in range(len(names))]
  56. def _get_import_name(importnode, modname):
  57. """Get a prepared module name from the given import node
  58. In the case of relative imports, this will return the
  59. absolute qualified module name, which might be useful
  60. for debugging. Otherwise, the initial module name
  61. is returned unchanged.
  62. """
  63. if isinstance(importnode, astroid.ImportFrom):
  64. if importnode.level:
  65. root = importnode.root()
  66. if isinstance(root, astroid.Module):
  67. modname = root.relative_to_absolute_name(
  68. modname, level=importnode.level)
  69. return modname
  70. def _get_first_import(node, context, name, base, level, alias):
  71. """return the node where [base.]<name> is imported or None if not found
  72. """
  73. fullname = '%s.%s' % (base, name) if base else name
  74. first = None
  75. found = False
  76. for first in context.body:
  77. if first is node:
  78. continue
  79. if first.scope() is node.scope() and first.fromlineno > node.fromlineno:
  80. continue
  81. if isinstance(first, astroid.Import):
  82. if any(fullname == iname[0] for iname in first.names):
  83. found = True
  84. break
  85. elif isinstance(first, astroid.ImportFrom):
  86. if level == first.level:
  87. for imported_name, imported_alias in first.names:
  88. if fullname == '%s.%s' % (first.modname, imported_name):
  89. found = True
  90. break
  91. if name != '*' and name == imported_name and not (alias or imported_alias):
  92. found = True
  93. break
  94. if found:
  95. break
  96. if found and not are_exclusive(first, node):
  97. return first
  98. return None
  99. def _ignore_import_failure(node, modname, ignored_modules):
  100. for submodule in _qualified_names(modname):
  101. if submodule in ignored_modules:
  102. return True
  103. return node_ignores_exception(node, ImportError)
  104. # utilities to represents import dependencies as tree and dot graph ###########
  105. def _make_tree_defs(mod_files_list):
  106. """get a list of 2-uple (module, list_of_files_which_import_this_module),
  107. it will return a dictionary to represent this as a tree
  108. """
  109. tree_defs = {}
  110. for mod, files in mod_files_list:
  111. node = (tree_defs, ())
  112. for prefix in mod.split('.'):
  113. node = node[0].setdefault(prefix, [{}, []])
  114. node[1] += files
  115. return tree_defs
  116. def _repr_tree_defs(data, indent_str=None):
  117. """return a string which represents imports as a tree"""
  118. lines = []
  119. nodes = data.items()
  120. for i, (mod, (sub, files)) in enumerate(sorted(nodes, key=lambda x: x[0])):
  121. if not files:
  122. files = ''
  123. else:
  124. files = '(%s)' % ','.join(sorted(files))
  125. if indent_str is None:
  126. lines.append('%s %s' % (mod, files))
  127. sub_indent_str = ' '
  128. else:
  129. lines.append(r'%s\-%s %s' % (indent_str, mod, files))
  130. if i == len(nodes)-1:
  131. sub_indent_str = '%s ' % indent_str
  132. else:
  133. sub_indent_str = '%s| ' % indent_str
  134. if sub:
  135. lines.append(_repr_tree_defs(sub, sub_indent_str))
  136. return '\n'.join(lines)
  137. def _dependencies_graph(filename, dep_info):
  138. """write dependencies as a dot (graphviz) file
  139. """
  140. done = {}
  141. printer = DotBackend(filename[:-4], rankdir='LR')
  142. printer.emit('URL="." node[shape="box"]')
  143. for modname, dependencies in sorted(six.iteritems(dep_info)):
  144. done[modname] = 1
  145. printer.emit_node(modname)
  146. for depmodname in dependencies:
  147. if depmodname not in done:
  148. done[depmodname] = 1
  149. printer.emit_node(depmodname)
  150. for depmodname, dependencies in sorted(six.iteritems(dep_info)):
  151. for modname in dependencies:
  152. printer.emit_edge(modname, depmodname)
  153. printer.generate(filename)
  154. def _make_graph(filename, dep_info, sect, gtype):
  155. """generate a dependencies graph and add some information about it in the
  156. report's section
  157. """
  158. _dependencies_graph(filename, dep_info)
  159. sect.append(Paragraph('%simports graph has been written to %s'
  160. % (gtype, filename)))
  161. # the import checker itself ###################################################
  162. MSGS = {
  163. 'E0401': ('Unable to import %s',
  164. 'import-error',
  165. 'Used when pylint has been unable to import a module.',
  166. {'old_names': [('F0401', 'import-error')]}),
  167. 'E0402': ('Attempted relative import beyond top-level package',
  168. 'relative-beyond-top-level',
  169. 'Used when a relative import tries to access too many levels '
  170. 'in the current package.'),
  171. 'R0401': ('Cyclic import (%s)',
  172. 'cyclic-import',
  173. 'Used when a cyclic import between two or more modules is \
  174. detected.'),
  175. 'W0401': ('Wildcard import %s',
  176. 'wildcard-import',
  177. 'Used when `from module import *` is detected.'),
  178. 'W0402': ('Uses of a deprecated module %r',
  179. 'deprecated-module',
  180. 'Used a module marked as deprecated is imported.'),
  181. 'W0403': ('Relative import %r, should be %r',
  182. 'relative-import',
  183. 'Used when an import relative to the package directory is '
  184. 'detected.',
  185. {'maxversion': (3, 0)}),
  186. 'W0404': ('Reimport %r (imported line %s)',
  187. 'reimported',
  188. 'Used when a module is reimported multiple times.'),
  189. 'W0406': ('Module import itself',
  190. 'import-self',
  191. 'Used when a module is importing itself.'),
  192. 'W0410': ('__future__ import is not the first non docstring statement',
  193. 'misplaced-future',
  194. 'Python 2.5 and greater require __future__ import to be the \
  195. first non docstring statement in the module.'),
  196. 'C0410': ('Multiple imports on one line (%s)',
  197. 'multiple-imports',
  198. 'Used when import statement importing multiple modules is '
  199. 'detected.'),
  200. 'C0411': ('%s should be placed before %s',
  201. 'wrong-import-order',
  202. 'Used when PEP8 import order is not respected (standard imports '
  203. 'first, then third-party libraries, then local imports)'),
  204. 'C0412': ('Imports from package %s are not grouped',
  205. 'ungrouped-imports',
  206. 'Used when imports are not grouped by packages'),
  207. 'C0413': ('Import "%s" should be placed at the top of the '
  208. 'module',
  209. 'wrong-import-position',
  210. 'Used when code and imports are mixed'),
  211. }
  212. DEFAULT_STANDARD_LIBRARY = ()
  213. DEFAULT_KNOWN_THIRD_PARTY = ('enchant',)
  214. class ImportsChecker(BaseChecker):
  215. """checks for
  216. * external modules dependencies
  217. * relative / wildcard imports
  218. * cyclic imports
  219. * uses of deprecated modules
  220. """
  221. __implements__ = IAstroidChecker
  222. name = 'imports'
  223. msgs = MSGS
  224. priority = -2
  225. if six.PY2:
  226. deprecated_modules = ('regsub', 'TERMIOS', 'Bastion', 'rexec')
  227. elif sys.version_info < (3, 5):
  228. deprecated_modules = ('optparse', )
  229. else:
  230. deprecated_modules = ('optparse', 'tkinter.tix')
  231. options = (('deprecated-modules',
  232. {'default' : deprecated_modules,
  233. 'type' : 'csv',
  234. 'metavar' : '<modules>',
  235. 'help' : 'Deprecated modules which should not be used,'
  236. ' separated by a comma'}
  237. ),
  238. ('import-graph',
  239. {'default' : '',
  240. 'type' : 'string',
  241. 'metavar' : '<file.dot>',
  242. 'help' : 'Create a graph of every (i.e. internal and'
  243. ' external) dependencies in the given file'
  244. ' (report RP0402 must not be disabled)'}
  245. ),
  246. ('ext-import-graph',
  247. {'default' : '',
  248. 'type' : 'string',
  249. 'metavar' : '<file.dot>',
  250. 'help' : 'Create a graph of external dependencies in the'
  251. ' given file (report RP0402 must not be disabled)'}
  252. ),
  253. ('int-import-graph',
  254. {'default' : '',
  255. 'type' : 'string',
  256. 'metavar' : '<file.dot>',
  257. 'help' : 'Create a graph of internal dependencies in the'
  258. ' given file (report RP0402 must not be disabled)'}
  259. ),
  260. ('known-standard-library',
  261. {'default': DEFAULT_STANDARD_LIBRARY,
  262. 'type': 'csv',
  263. 'metavar': '<modules>',
  264. 'help': 'Force import order to recognize a module as part of'
  265. ' the standard compatibility libraries.'}
  266. ),
  267. ('known-third-party',
  268. {'default': DEFAULT_KNOWN_THIRD_PARTY,
  269. 'type': 'csv',
  270. 'metavar': '<modules>',
  271. 'help': 'Force import order to recognize a module as part of'
  272. ' a third party library.'}
  273. ),
  274. ('analyse-fallback-blocks',
  275. {'default': False,
  276. 'type': 'yn',
  277. 'metavar': '<y_or_n>',
  278. 'help': 'Analyse import fallback blocks. This can be used to '
  279. 'support both Python 2 and 3 compatible code, which means that '
  280. 'the block might have code that exists only in one or another '
  281. 'interpreter, leading to false positives when analysed.'},
  282. ),
  283. ('allow-wildcard-with-all',
  284. {'default': False,
  285. 'type': 'yn',
  286. 'metavar': '<y_or_n>',
  287. 'help': 'Allow wildcard imports from modules that define __all__.'}),
  288. )
  289. def __init__(self, linter=None):
  290. BaseChecker.__init__(self, linter)
  291. self.stats = None
  292. self.import_graph = None
  293. self._imports_stack = []
  294. self._first_non_import_node = None
  295. self.__int_dep_info = self.__ext_dep_info = None
  296. self.reports = (('RP0401', 'External dependencies',
  297. self._report_external_dependencies),
  298. ('RP0402', 'Modules dependencies graph',
  299. self._report_dependencies_graph),
  300. )
  301. self._site_packages = self._compute_site_packages()
  302. @staticmethod
  303. def _compute_site_packages():
  304. def _normalized_path(path):
  305. return os.path.normcase(os.path.abspath(path))
  306. paths = set()
  307. real_prefix = getattr(sys, 'real_prefix', None)
  308. for prefix in filter(None, (real_prefix, sys.prefix)):
  309. path = sysconfig.get_python_lib(prefix=prefix)
  310. path = _normalized_path(path)
  311. paths.add(path)
  312. # Handle Debian's derivatives /usr/local.
  313. if os.path.isfile("/etc/debian_version"):
  314. for prefix in filter(None, (real_prefix, sys.prefix)):
  315. libpython = os.path.join(prefix, "local", "lib",
  316. "python" + sysconfig.get_python_version(),
  317. "dist-packages")
  318. paths.add(libpython)
  319. return paths
  320. def open(self):
  321. """called before visiting project (i.e set of modules)"""
  322. self.linter.add_stats(dependencies={})
  323. self.linter.add_stats(cycles=[])
  324. self.stats = self.linter.stats
  325. self.import_graph = collections.defaultdict(set)
  326. self._excluded_edges = collections.defaultdict(set)
  327. self._ignored_modules = get_global_option(
  328. self, 'ignored-modules', default=[])
  329. def _import_graph_without_ignored_edges(self):
  330. filtered_graph = copy.deepcopy(self.import_graph)
  331. for node in filtered_graph:
  332. filtered_graph[node].difference_update(self._excluded_edges[node])
  333. return filtered_graph
  334. def close(self):
  335. """called before visiting project (i.e set of modules)"""
  336. if self.linter.is_message_enabled('cyclic-import'):
  337. graph = self._import_graph_without_ignored_edges()
  338. vertices = list(graph)
  339. for cycle in get_cycles(graph, vertices=vertices):
  340. self.add_message('cyclic-import', args=' -> '.join(cycle))
  341. @check_messages(*MSGS.keys())
  342. def visit_import(self, node):
  343. """triggered when an import statement is seen"""
  344. self._check_reimport(node)
  345. modnode = node.root()
  346. names = [name for name, _ in node.names]
  347. if len(names) >= 2:
  348. self.add_message('multiple-imports', args=', '.join(names), node=node)
  349. for name in names:
  350. self._check_deprecated_module(node, name)
  351. imported_module = self._get_imported_module(node, name)
  352. if isinstance(node.parent, astroid.Module):
  353. # Allow imports nested
  354. self._check_position(node)
  355. if isinstance(node.scope(), astroid.Module):
  356. self._record_import(node, imported_module)
  357. if imported_module is None:
  358. continue
  359. self._check_relative_import(modnode, node, imported_module, name)
  360. self._add_imported_module(node, imported_module.name)
  361. @check_messages(*(MSGS.keys()))
  362. def visit_importfrom(self, node):
  363. """triggered when a from statement is seen"""
  364. basename = node.modname
  365. imported_module = self._get_imported_module(node, basename)
  366. self._check_misplaced_future(node)
  367. self._check_deprecated_module(node, basename)
  368. self._check_wildcard_imports(node, imported_module)
  369. self._check_same_line_imports(node)
  370. self._check_reimport(node, basename=basename, level=node.level)
  371. if isinstance(node.parent, astroid.Module):
  372. # Allow imports nested
  373. self._check_position(node)
  374. if isinstance(node.scope(), astroid.Module):
  375. self._record_import(node, imported_module)
  376. if imported_module is None:
  377. return
  378. modnode = node.root()
  379. self._check_relative_import(modnode, node, imported_module, basename)
  380. for name, _ in node.names:
  381. if name != '*':
  382. self._add_imported_module(node, '%s.%s' % (imported_module.name, name))
  383. @check_messages(*(MSGS.keys()))
  384. def leave_module(self, node):
  385. # Check imports are grouped by category (standard, 3rd party, local)
  386. std_imports, ext_imports, loc_imports = self._check_imports_order(node)
  387. # Check imports are grouped by package within a given category
  388. met = set()
  389. current_package = None
  390. for import_node, import_name in std_imports + ext_imports + loc_imports:
  391. if not self.linter.is_message_enabled('ungrouped-imports', import_node.fromlineno):
  392. continue
  393. package, _, _ = import_name.partition('.')
  394. if current_package and current_package != package and package in met:
  395. self.add_message('ungrouped-imports', node=import_node,
  396. args=package)
  397. current_package = package
  398. met.add(package)
  399. self._imports_stack = []
  400. self._first_non_import_node = None
  401. def compute_first_non_import_node(self, node):
  402. if not self.linter.is_message_enabled('wrong-import-position', node.fromlineno):
  403. return
  404. # if the node does not contain an import instruction, and if it is the
  405. # first node of the module, keep a track of it (all the import positions
  406. # of the module will be compared to the position of this first
  407. # instruction)
  408. if self._first_non_import_node:
  409. return
  410. if not isinstance(node.parent, astroid.Module):
  411. return
  412. nested_allowed = [astroid.TryExcept, astroid.TryFinally]
  413. is_nested_allowed = [
  414. allowed for allowed in nested_allowed if isinstance(node, allowed)]
  415. if is_nested_allowed and \
  416. any(node.nodes_of_class((astroid.Import, astroid.ImportFrom))):
  417. return
  418. if isinstance(node, astroid.Assign):
  419. # Add compatibility for module level dunder names
  420. # https://www.python.org/dev/peps/pep-0008/#module-level-dunder-names
  421. valid_targets = [
  422. isinstance(target, astroid.AssignName) and
  423. target.name.startswith('__') and target.name.endswith('__')
  424. for target in node.targets]
  425. if all(valid_targets):
  426. return
  427. self._first_non_import_node = node
  428. visit_tryfinally = visit_tryexcept = visit_assignattr = visit_assign = \
  429. visit_ifexp = visit_comprehension = visit_expr = visit_if = \
  430. compute_first_non_import_node
  431. def visit_functiondef(self, node):
  432. if not self.linter.is_message_enabled('wrong-import-position', node.fromlineno):
  433. return
  434. # If it is the first non import instruction of the module, record it.
  435. if self._first_non_import_node:
  436. return
  437. # Check if the node belongs to an `If` or a `Try` block. If they
  438. # contain imports, skip recording this node.
  439. if not isinstance(node.parent.scope(), astroid.Module):
  440. return
  441. root = node
  442. while not isinstance(root.parent, astroid.Module):
  443. root = root.parent
  444. if isinstance(root, (astroid.If, astroid.TryFinally, astroid.TryExcept)):
  445. if any(root.nodes_of_class((astroid.Import, astroid.ImportFrom))):
  446. return
  447. self._first_non_import_node = node
  448. visit_classdef = visit_for = visit_while = visit_functiondef
  449. def _check_misplaced_future(self, node):
  450. basename = node.modname
  451. if basename == '__future__':
  452. # check if this is the first non-docstring statement in the module
  453. prev = node.previous_sibling()
  454. if prev:
  455. # consecutive future statements are possible
  456. if not (isinstance(prev, astroid.ImportFrom)
  457. and prev.modname == '__future__'):
  458. self.add_message('misplaced-future', node=node)
  459. return
  460. def _check_same_line_imports(self, node):
  461. # Detect duplicate imports on the same line.
  462. names = (name for name, _ in node.names)
  463. counter = collections.Counter(names)
  464. for name, count in counter.items():
  465. if count > 1:
  466. self.add_message('reimported', node=node,
  467. args=(name, node.fromlineno))
  468. def _check_position(self, node):
  469. """Check `node` import or importfrom node position is correct
  470. Send a message if `node` comes before another instruction
  471. """
  472. # if a first non-import instruction has already been encountered,
  473. # it means the import comes after it and therefore is not well placed
  474. if self._first_non_import_node:
  475. self.add_message('wrong-import-position', node=node,
  476. args=node.as_string())
  477. def _record_import(self, node, importedmodnode):
  478. """Record the package `node` imports from"""
  479. importedname = importedmodnode.name if importedmodnode else None
  480. if not importedname:
  481. if isinstance(node, astroid.ImportFrom):
  482. importedname = node.modname
  483. else:
  484. importedname = node.names[0][0].split('.')[0]
  485. if isinstance(node, astroid.ImportFrom) and (node.level or 0) >= 1:
  486. # We need the impotedname with first point to detect local package
  487. # Example of node:
  488. # 'from .my_package1 import MyClass1'
  489. # the output should be '.my_package1' instead of 'my_package1'
  490. # Example of node:
  491. # 'from . import my_package2'
  492. # the output should be '.my_package2' instead of '{pyfile}'
  493. importedname = '.' + importedname
  494. self._imports_stack.append((node, importedname))
  495. @staticmethod
  496. def _is_fallback_import(node, imports):
  497. imports = [import_node for (import_node, _) in imports]
  498. return any(astroid.are_exclusive(import_node, node)
  499. for import_node in imports)
  500. def _check_imports_order(self, _module_node):
  501. """Checks imports of module `node` are grouped by category
  502. Imports must follow this order: standard, 3rd party, local
  503. """
  504. std_imports = []
  505. third_party_imports = []
  506. first_party_imports = []
  507. # need of a list that holds third or first party ordered import
  508. external_imports = []
  509. local_imports = []
  510. third_party_not_ignored = []
  511. first_party_not_ignored = []
  512. local_not_ignored = []
  513. isort_obj = isort.SortImports(
  514. file_contents='', known_third_party=self.config.known_third_party,
  515. known_standard_library=self.config.known_standard_library,
  516. )
  517. for node, modname in self._imports_stack:
  518. if modname.startswith('.'):
  519. package = '.' + modname.split('.')[1]
  520. else:
  521. package = modname.split('.')[0]
  522. nested = not isinstance(node.parent, astroid.Module)
  523. ignore_for_import_order = not self.linter.is_message_enabled('wrong-import-order',
  524. node.fromlineno)
  525. import_category = isort_obj.place_module(package)
  526. node_and_package_import = (node, package)
  527. if import_category in ('FUTURE', 'STDLIB'):
  528. std_imports.append(node_and_package_import)
  529. wrong_import = (third_party_not_ignored or first_party_not_ignored
  530. or local_not_ignored)
  531. if self._is_fallback_import(node, wrong_import):
  532. continue
  533. if wrong_import and not nested:
  534. self.add_message('wrong-import-order', node=node,
  535. args=('standard import "%s"' % node.as_string(),
  536. '"%s"' % wrong_import[0][0].as_string()))
  537. elif import_category == 'THIRDPARTY':
  538. third_party_imports.append(node_and_package_import)
  539. external_imports.append(node_and_package_import)
  540. if not nested and not ignore_for_import_order:
  541. third_party_not_ignored.append(node_and_package_import)
  542. wrong_import = first_party_not_ignored or local_not_ignored
  543. if wrong_import and not nested:
  544. self.add_message('wrong-import-order', node=node,
  545. args=('third party import "%s"' % node.as_string(),
  546. '"%s"' % wrong_import[0][0].as_string()))
  547. elif import_category == 'FIRSTPARTY':
  548. first_party_imports.append(node_and_package_import)
  549. external_imports.append(node_and_package_import)
  550. if not nested and not ignore_for_import_order:
  551. first_party_not_ignored.append(node_and_package_import)
  552. wrong_import = local_not_ignored
  553. if wrong_import and not nested:
  554. self.add_message('wrong-import-order', node=node,
  555. args=('first party import "%s"' % node.as_string(),
  556. '"%s"' % wrong_import[0][0].as_string()))
  557. elif import_category == 'LOCALFOLDER':
  558. local_imports.append((node, package))
  559. if not nested and not ignore_for_import_order:
  560. local_not_ignored.append((node, package))
  561. return std_imports, external_imports, local_imports
  562. def _get_imported_module(self, importnode, modname):
  563. try:
  564. return importnode.do_import_module(modname)
  565. except astroid.TooManyLevelsError:
  566. if _ignore_import_failure(importnode, modname, self._ignored_modules):
  567. return None
  568. self.add_message('relative-beyond-top-level', node=importnode)
  569. except astroid.AstroidBuildingException:
  570. if _ignore_import_failure(importnode, modname, self._ignored_modules):
  571. return None
  572. if not self.config.analyse_fallback_blocks and is_from_fallback_block(importnode):
  573. return None
  574. dotted_modname = _get_import_name(importnode, modname)
  575. self.add_message('import-error', args=repr(dotted_modname),
  576. node=importnode)
  577. def _check_relative_import(self, modnode, importnode, importedmodnode,
  578. importedasname):
  579. """check relative import. node is either an Import or From node, modname
  580. the imported module name.
  581. """
  582. if not self.linter.is_message_enabled('relative-import'):
  583. return None
  584. if importedmodnode.file is None:
  585. return False # built-in module
  586. if modnode is importedmodnode:
  587. return False # module importing itself
  588. if modnode.absolute_import_activated() or getattr(importnode, 'level', None):
  589. return False
  590. if importedmodnode.name != importedasname:
  591. # this must be a relative import...
  592. self.add_message('relative-import',
  593. args=(importedasname, importedmodnode.name),
  594. node=importnode)
  595. return None
  596. return None
  597. def _add_imported_module(self, node, importedmodname):
  598. """notify an imported module, used to analyze dependencies"""
  599. module_file = node.root().file
  600. context_name = node.root().name
  601. base = os.path.splitext(os.path.basename(module_file))[0]
  602. # Determine if we have a `from .something import` in a package's
  603. # __init__. This means the module will never be able to import
  604. # itself using this condition (the level will be bigger or
  605. # if the same module is named as the package, it will be different
  606. # anyway).
  607. if isinstance(node, astroid.ImportFrom):
  608. if node.level and node.level > 0 and base == '__init__':
  609. return
  610. try:
  611. importedmodname = get_module_part(importedmodname,
  612. module_file)
  613. except ImportError:
  614. pass
  615. if context_name == importedmodname:
  616. self.add_message('import-self', node=node)
  617. elif not is_standard_module(importedmodname):
  618. # handle dependencies
  619. importedmodnames = self.stats['dependencies'].setdefault(
  620. importedmodname, set())
  621. if context_name not in importedmodnames:
  622. importedmodnames.add(context_name)
  623. # update import graph
  624. self.import_graph[context_name].add(importedmodname)
  625. if not self.linter.is_message_enabled('cyclic-import', line=node.lineno):
  626. self._excluded_edges[context_name].add(importedmodname)
  627. def _check_deprecated_module(self, node, mod_path):
  628. """check if the module is deprecated"""
  629. for mod_name in self.config.deprecated_modules:
  630. if mod_path == mod_name or mod_path.startswith(mod_name + '.'):
  631. self.add_message('deprecated-module', node=node, args=mod_path)
  632. def _check_reimport(self, node, basename=None, level=None):
  633. """check if the import is necessary (i.e. not already done)"""
  634. if not self.linter.is_message_enabled('reimported'):
  635. return
  636. frame = node.frame()
  637. root = node.root()
  638. contexts = [(frame, level)]
  639. if root is not frame:
  640. contexts.append((root, None))
  641. for known_context, known_level in contexts:
  642. for name, alias in node.names:
  643. first = _get_first_import(
  644. node, known_context,
  645. name, basename,
  646. known_level, alias)
  647. if first is not None:
  648. self.add_message('reimported', node=node,
  649. args=(name, first.fromlineno))
  650. def _report_external_dependencies(self, sect, _, _dummy):
  651. """return a verbatim layout for displaying dependencies"""
  652. dep_info = _make_tree_defs(six.iteritems(self._external_dependencies_info()))
  653. if not dep_info:
  654. raise EmptyReportError()
  655. tree_str = _repr_tree_defs(dep_info)
  656. sect.append(VerbatimText(tree_str))
  657. def _report_dependencies_graph(self, sect, _, _dummy):
  658. """write dependencies as a dot (graphviz) file"""
  659. dep_info = self.stats['dependencies']
  660. if not dep_info or not (self.config.import_graph
  661. or self.config.ext_import_graph
  662. or self.config.int_import_graph):
  663. raise EmptyReportError()
  664. filename = self.config.import_graph
  665. if filename:
  666. _make_graph(filename, dep_info, sect, '')
  667. filename = self.config.ext_import_graph
  668. if filename:
  669. _make_graph(filename, self._external_dependencies_info(),
  670. sect, 'external ')
  671. filename = self.config.int_import_graph
  672. if filename:
  673. _make_graph(filename, self._internal_dependencies_info(),
  674. sect, 'internal ')
  675. def _external_dependencies_info(self):
  676. """return cached external dependencies information or build and
  677. cache them
  678. """
  679. if self.__ext_dep_info is None:
  680. package = self.linter.current_name
  681. self.__ext_dep_info = result = {}
  682. for importee, importers in six.iteritems(self.stats['dependencies']):
  683. if not importee.startswith(package):
  684. result[importee] = importers
  685. return self.__ext_dep_info
  686. def _internal_dependencies_info(self):
  687. """return cached internal dependencies information or build and
  688. cache them
  689. """
  690. if self.__int_dep_info is None:
  691. package = self.linter.current_name
  692. self.__int_dep_info = result = {}
  693. for importee, importers in six.iteritems(self.stats['dependencies']):
  694. if importee.startswith(package):
  695. result[importee] = importers
  696. return self.__int_dep_info
  697. def _check_wildcard_imports(self, node, imported_module):
  698. wildcard_import_is_allowed = (
  699. self._wildcard_import_is_allowed(imported_module)
  700. )
  701. for name, _ in node.names:
  702. if name == '*' and not wildcard_import_is_allowed:
  703. self.add_message('wildcard-import', args=node.modname, node=node)
  704. def _wildcard_import_is_allowed(self, imported_module):
  705. return (self.config.allow_wildcard_with_all
  706. and imported_module is not None
  707. and '__all__' in imported_module.locals)
  708. def register(linter):
  709. """required method to auto register this checker """
  710. linter.register_checker(ImportsChecker(linter))