#! /usr/bin/env python ''' Tool for sorting imports alphabetically, and automatically separated into sections. ''' from __future__ import absolute_import, division, print_function, unicode_literals import argparse import sys from pies.overrides import * from isort import __version__, SortImports, SECTION_NAMES parser = argparse.ArgumentParser(description='Sort Python import definitions alphabetically within logical sections.') parser.add_argument('files', nargs='+', help='One or more Python source files that need their imports sorted.') parser.add_argument('-l', '--lines', help='The max length of an import line (used for wrapping long imports).', dest='line_length', type=int) parser.add_argument('-s', '--skip', help='Files that sort imports should skip over.', dest='skip', action='append') parser.add_argument('-t', '--top', help='Force specific imports to the top of their appropriate section.', dest='force_to_top', action='append') parser.add_argument('-b', '--builtin', dest='known_standard_library', action='append', help='Force sortImports to recognize a module as part of the python standard library.') parser.add_argument('-o', '--thirdparty', dest='known_third_party', action='append', help='Force sortImports to recognize a module as being part of a third party library.') parser.add_argument('-p', '--project', dest='known_first_party', action='append', help='Force sortImports to recognize a module as being part of the current python project.') parser.add_argument('-m', '--multi_line', dest='multi_line_output', type=int, choices=[0, 1, 2, 3, 4, 5], help='Multi line output (0-grid, 1-vertical, 2-hanging, 3-vert-hanging, 4-vert-grid, ' '5-vert-grid-grouped).') parser.add_argument('-i', '--indent', help='String to place for indents defaults to " " (4 spaces).', dest='indent', type=str) parser.add_argument('-a', '--add_import', dest='add_imports', action='append', help='Adds the specified import line to all files, automatically determining correct placement.') parser.add_argument('-r', '--remove_import', dest='remove_imports', action='append', help='Removes the specified import from all files.') parser.add_argument('-ls', '--length_sort', help='Sort imports by their string length.', dest='length_sort', action='store_true', default=False) parser.add_argument('-d', '--stdout', help='Force resulting output to stdout, instead of in-place.', dest='write_to_stdout', action='store_true') parser.add_argument('-c', '--check-only', action='store_true', default=False, dest="check", help='Checks the file for unsorted imports and prints them to the command line without modifying ' 'the file.') parser.add_argument('-sl', '--force_single_line_imports', dest='force_single_line', action='store_true', help='Forces all from imports to appear on their own line') parser.add_argument('-sd', '--section-default', dest='default_section', help='Sets the default section for imports (by default FIRSTPARTY) options: ' + str(SECTION_NAMES)) parser.add_argument('-df', '--diff', dest='show_diff', default=False, action='store_true', help="Prints a diff of all the changes isort would make to a file, instead of changing it in place") parser.add_argument('-v', '--version', action='version', version='isort {0}'.format(__version__)) arguments = dict((key, value) for (key, value) in itemsview(vars(parser.parse_args())) if value) file_names = arguments.pop('files', []) if file_names == ['-']: SortImports(file_contents=sys.stdin.read(), write_to_stdout=True, **arguments) else: wrong_sorted_files = False for file_name in file_names: incorrectly_sorted = SortImports(file_name, **arguments).incorrectly_sorted if arguments.get('check', False) and incorrectly_sorted: wrong_sorted_files = True if wrong_sorted_files: exit(1)