Skip to content

Module isort.literal

View Source
import ast

from pprint import PrettyPrinter

from typing import Any, Callable, Dict, List, Set, Tuple

from isort.exceptions import (

    AssignmentsFormatMismatch,

    LiteralParsingFailure,

    LiteralSortTypeMismatch,

)

from isort.settings import DEFAULT_CONFIG, Config

class ISortPrettyPrinter(PrettyPrinter):

    """an isort customized pretty printer for sorted literals"""

    def __init__(self, config: Config):

        super().__init__(width=config.line_length, compact=True)

type_mapping: Dict[str, Tuple[type, Callable[[Any, ISortPrettyPrinter], str]]] = {}

def assignments(code: str) -> str:

    sort_assignments = {}

    for line in code.splitlines(keepends=True):

        if line:

            if " = " not in line:

                raise AssignmentsFormatMismatch(code)

            else:

                variable_name, value = line.split(" = ", 1)

                sort_assignments[variable_name] = value

    sorted_assignments = dict(sorted(sort_assignments.items(), key=lambda item: item[1]))

    return "".join(f"{key} = {value}" for key, value in sorted_assignments.items())

def assignment(code: str, sort_type: str, extension: str, config: Config = DEFAULT_CONFIG) -> str:

    """Sorts the literal present within the provided code against the provided sort type,

    returning the sorted representation of the source code.

    """

    if sort_type == "assignments":

        return assignments(code)

    elif sort_type not in type_mapping:

        raise ValueError(

            "Trying to sort using an undefined sort_type. "

            f"Defined sort types are {', '.join(type_mapping.keys())}."

        )

    variable_name, literal = code.split(" = ")

    variable_name = variable_name.lstrip()

    try:

        value = ast.literal_eval(literal)

    except Exception as error:

        raise LiteralParsingFailure(code, error)

    expected_type, sort_function = type_mapping[sort_type]

    if type(value) != expected_type:

        raise LiteralSortTypeMismatch(type(value), expected_type)

    printer = ISortPrettyPrinter(config)

    sorted_value_code = f"{variable_name} = {sort_function(value, printer)}"

    if config.formatting_function:

        sorted_value_code = config.formatting_function(

            sorted_value_code, extension, config

        ).rstrip()

    sorted_value_code += code[len(code.rstrip()) :]

    return sorted_value_code

def register_type(name: str, kind: type):

    """Registers a new literal sort type."""

    def wrap(function):

        type_mapping[name] = (kind, function)

        return function

    return wrap

@register_type("dict", dict)

def _dict(value: Dict[Any, Any], printer: ISortPrettyPrinter) -> str:

    return printer.pformat(dict(sorted(value.items(), key=lambda item: item[1])))

@register_type("list", list)

def _list(value: List[Any], printer: ISortPrettyPrinter) -> str:

    return printer.pformat(sorted(value))

@register_type("unique-list", list)

def _unique_list(value: List[Any], printer: ISortPrettyPrinter) -> str:

    return printer.pformat(list(sorted(set(value))))

@register_type("set", set)

def _set(value: Set[Any], printer: ISortPrettyPrinter) -> str:

    return "{" + printer.pformat(tuple(sorted(value)))[1:-1] + "}"

@register_type("tuple", tuple)

def _tuple(value: Tuple[Any, ...], printer: ISortPrettyPrinter) -> str:

    return printer.pformat(tuple(sorted(value)))

@register_type("unique-tuple", tuple)

def _unique_tuple(value: Tuple[Any, ...], printer: ISortPrettyPrinter) -> str:

    return printer.pformat(tuple(sorted(set(value))))

Variables

type_mapping

Functions

assignment

def assignment(
    code: str,
    sort_type: str,
    extension: str,
    config: isort.settings.Config = Config(py_version='py3', force_to_top=frozenset(), skip=frozenset({'venv', 'dist', '.bzr', 'build', 'buck-out', '.eggs', '.venv', '.direnv', '.git', '.nox', '.mypy_cache', '.pants.d', '.hg', '.svn', '_build', '.tox', 'node_modules'}), skip_glob=frozenset(), skip_gitignore=False, line_length=79, wrap_length=0, line_ending='', sections=('FUTURE', 'STDLIB', 'THIRDPARTY', 'FIRSTPARTY', 'LOCALFOLDER'), no_sections=False, known_future_library=frozenset({'__future__'}), known_third_party=frozenset(), known_first_party=frozenset(), known_local_folder=frozenset(), known_standard_library=frozenset({'errno', 'venv', 're', 'io', 'uu', 'contextlib', 'uuid', 'multiprocessing', 'numbers', 'nis', 'distutils', 'os', 'itertools', 'abc', 'email', 'socketserver', 'secrets', 'atexit', 'plistlib', 'tkinter', 'html', 'select', 'sre_compile', 'posix', 'xmlrpc', 'importlib', 'pipes', 'wave', 'audioop', 'difflib', 'zipimport', 'hashlib', 'sunau', 'trace', 'marshal', 'http', 'sndhdr', 'nntplib', 'textwrap', 'symbol', 'chunk', 'ctypes', 'tokenize', 'msilib', 'mailcap', 'codeop', 'sysconfig', 'posixpath', 'selectors', 'ossaudiodev', 'winsound', 'fcntl', 'hmac', 'syslog', 'macpath', 'enum', 'bz2', 'bisect', 'msvcrt', 'winreg', 'imp', 'reprlib', 'shutil', 'dummy_threading', 'dbm', 'readline', 'binascii', 'sre_constants', 'modulefinder', 'json', 'code', 'compileall', 'cmd', 'turtle', 'curses', '_dummy_thread', 'pyclbr', 'locale', 'random', 'inspect', 'types', 'imaplib', 'shelve', 'urllib', 'zipapp', 'argparse', 'test', 'pkgutil', 'cgitb', 'sys', 'functools', 'grp', 'profile', 'doctest', 'wsgiref', 'unicodedata', 'smtplib', 'site', 'pathlib', 'getpass', 'pydoc', 'optparse', 'stringprep', 'csv', 'smtpd', 'tarfile', 'codecs', 'xml', 'calendar', 'xdrlib', 'cProfile', 'ipaddress', 'copyreg', 'formatter', 'pty', 'cgi', 'zlib', 'resource', 'configparser', 'dis', 'statistics', 'warnings', 'turtledemo', 'sqlite3', 'ast', 'copy', 'spwd', 'mimetypes', 'tty', 'token', 'asyncore', 'bdb', 'py_compile', 'colorsys', 'faulthandler', 'tabnanny', 'tempfile', 'weakref', 'rlcompleter', 'pprint', 'asynchat', 'gc', 'socket', 'datetime', 'ftplib', 'crypt', 'contextvars', 'decimal', 'getopt', 'sre_parse', 'asyncio', 'subprocess', '_thread', 'sched', 'platform', 'quopri', 'operator', 'collections', 'sre', 'stat', 'threading', 'pstats', 'queue', 'symtable', 'ntpath', 'timeit', 'traceback', 'pickletools', 'binhex', 'ensurepip', 'pwd', 'heapq', 'ssl', 'linecache', 'termios', 'tracemalloc', 'fnmatch', 'struct', 'dataclasses', 'time', 'pdb', 'shlex', 'webbrowser', 'builtins', 'glob', 'math', 'typing', 'gettext', 'aifc', 'fractions', 'parser', 'string', 'lib2to3', 'mailbox', 'zipfile', 'netrc', 'lzma', 'keyword', 'imghdr', 'unittest', 'fileinput', 'concurrent', 'fpectl', 'pickle', 'runpy', 'mmap', 'telnetlib', 'signal', 'poplib', 'filecmp', 'base64', 'gzip', 'encodings', 'cmath', 'logging', 'array'}), extra_standard_library=frozenset(), known_other={}, multi_line_output=<WrapModes.GRID: 0>, forced_separate=(), indent='    ', comment_prefix='  #', length_sort=False, length_sort_straight=False, length_sort_sections=frozenset(), add_imports=frozenset(), remove_imports=frozenset(), append_only=False, reverse_relative=False, force_single_line=False, single_line_exclusions=(), default_section='THIRDPARTY', import_headings={}, balanced_wrapping=False, use_parentheses=False, order_by_type=True, atomic=False, lines_after_imports=-1, lines_between_sections=1, lines_between_types=0, combine_as_imports=False, combine_star=False, include_trailing_comma=False, from_first=False, verbose=False, quiet=False, force_adds=False, force_alphabetical_sort_within_sections=False, force_alphabetical_sort=False, force_grid_wrap=0, force_sort_within_sections=False, lexicographical=False, ignore_whitespace=False, no_lines_before=frozenset(), no_inline_sort=False, ignore_comments=False, case_sensitive=False, sources=({'py_version': 'py3', 'force_to_top': frozenset(), 'skip': frozenset({'venv', 'dist', '.bzr', 'build', 'buck-out', '.eggs', '.venv', '.direnv', '.git', '.nox', '.mypy_cache', '.pants.d', '.hg', '.svn', '_build', '.tox', 'node_modules'}), 'skip_glob': frozenset(), 'skip_gitignore': False, 'line_length': 79, 'wrap_length': 0, 'line_ending': '', 'sections': ('FUTURE', 'STDLIB', 'THIRDPARTY', 'FIRSTPARTY', 'LOCALFOLDER'), 'no_sections': False, 'known_future_library': frozenset({'__future__'}), 'known_third_party': frozenset(), 'known_first_party': frozenset(), 'known_local_folder': frozenset(), 'known_standard_library': frozenset({'errno', 'venv', 're', 'io', 'uu', 'contextlib', 'uuid', 'multiprocessing', 'numbers', 'nis', 'distutils', 'os', 'itertools', 'abc', 'email', 'socketserver', 'secrets', 'atexit', 'plistlib', 'tkinter', 'html', 'select', 'sre_compile', 'posix', 'xmlrpc', 'importlib', 'pipes', 'wave', 'audioop', 'difflib', 'zipimport', 'hashlib', 'sunau', 'trace', 'marshal', 'http', 'sndhdr', 'nntplib', 'textwrap', 'symbol', 'chunk', 'ctypes', 'tokenize', 'msilib', 'mailcap', 'codeop', 'sysconfig', 'posixpath', 'selectors', 'ossaudiodev', 'winsound', 'fcntl', 'hmac', 'syslog', 'macpath', 'enum', 'bz2', 'bisect', 'msvcrt', 'winreg', 'imp', 'reprlib', 'shutil', 'dummy_threading', 'dbm', 'readline', 'binascii', 'sre_constants', 'modulefinder', 'json', 'code', 'compileall', 'cmd', 'turtle', 'curses', '_dummy_thread', 'pyclbr', 'locale', 'random', 'inspect', 'types', 'imaplib', 'shelve', 'urllib', 'zipapp', 'argparse', 'test', 'pkgutil', 'cgitb', 'sys', 'functools', 'grp', 'profile', 'doctest', 'wsgiref', 'unicodedata', 'smtplib', 'site', 'pathlib', 'getpass', 'pydoc', 'optparse', 'stringprep', 'csv', 'smtpd', 'tarfile', 'codecs', 'xml', 'calendar', 'xdrlib', 'cProfile', 'ipaddress', 'copyreg', 'formatter', 'pty', 'cgi', 'zlib', 'resource', 'configparser', 'dis', 'statistics', 'warnings', 'turtledemo', 'sqlite3', 'ast', 'copy', 'spwd', 'mimetypes', 'tty', 'token', 'asyncore', 'bdb', 'py_compile', 'colorsys', 'faulthandler', 'tabnanny', 'tempfile', 'weakref', 'rlcompleter', 'pprint', 'asynchat', 'gc', 'socket', 'datetime', 'ftplib', 'crypt', 'contextvars', 'decimal', 'getopt', 'sre_parse', 'asyncio', 'subprocess', '_thread', 'sched', 'platform', 'quopri', 'operator', 'collections', 'sre', 'stat', 'threading', 'pstats', 'queue', 'symtable', 'ntpath', 'timeit', 'traceback', 'pickletools', 'binhex', 'ensurepip', 'pwd', 'heapq', 'ssl', 'linecache', 'termios', 'tracemalloc', 'fnmatch', 'struct', 'dataclasses', 'time', 'pdb', 'shlex', 'webbrowser', 'builtins', 'glob', 'math', 'typing', 'gettext', 'aifc', 'fractions', 'parser', 'string', 'lib2to3', 'mailbox', 'zipfile', 'netrc', 'lzma', 'keyword', 'imghdr', 'unittest', 'fileinput', 'concurrent', 'fpectl', 'pickle', 'runpy', 'mmap', 'telnetlib', 'signal', 'poplib', 'filecmp', 'base64', 'gzip', 'encodings', 'cmath', 'logging', 'array'}), 'extra_standard_library': frozenset(), 'known_other': {}, 'multi_line_output': <WrapModes.GRID: 0>, 'forced_separate': (), 'indent': '    ', 'comment_prefix': '  #', 'length_sort': False, 'length_sort_straight': False, 'length_sort_sections': frozenset(), 'add_imports': frozenset(), 'remove_imports': frozenset(), 'append_only': False, 'reverse_relative': False, 'force_single_line': False, 'single_line_exclusions': (), 'default_section': 'THIRDPARTY', 'import_headings': {}, 'balanced_wrapping': False, 'use_parentheses': False, 'order_by_type': True, 'atomic': False, 'lines_after_imports': -1, 'lines_between_sections': 1, 'lines_between_types': 0, 'combine_as_imports': False, 'combine_star': False, 'include_trailing_comma': False, 'from_first': False, 'verbose': False, 'quiet': False, 'force_adds': False, 'force_alphabetical_sort_within_sections': False, 'force_alphabetical_sort': False, 'force_grid_wrap': 0, 'force_sort_within_sections': False, 'lexicographical': False, 'ignore_whitespace': False, 'no_lines_before': frozenset(), 'no_inline_sort': False, 'ignore_comments': False, 'case_sensitive': False, 'sources': (), 'virtual_env': '', 'conda_env': '', 'ensure_newline_before_comments': False, 'directory': '', 'profile': '', 'honor_noqa': False, 'src_paths': frozenset(), 'old_finders': False, 'remove_redundant_aliases': False, 'float_to_top': False, 'filter_files': False, 'formatter': '', 'formatting_function': None, 'color_output': False, 'treat_comments_as_code': frozenset(), 'treat_all_comments_as_code': False, 'supported_extensions': frozenset({'py', 'pyx', 'pxd', 'pyi'}), 'blocked_extensions': frozenset({'pex'}), 'constants': frozenset(), 'classes': frozenset(), 'variables': frozenset(), 'dedup_headings': False, 'only_sections': False, 'source': 'defaults'},), virtual_env='', conda_env='', ensure_newline_before_comments=False, directory='/home/timothy/Projects/isort', profile='', honor_noqa=False, src_paths=frozenset({PosixPath('/home/timothy/Projects/isort'), PosixPath('/home/timothy/Projects/isort/src')}), old_finders=False, remove_redundant_aliases=False, float_to_top=False, filter_files=False, formatter='', formatting_function=None, color_output=False, treat_comments_as_code=frozenset(), treat_all_comments_as_code=False, supported_extensions=frozenset({'py', 'pyx', 'pxd', 'pyi'}), blocked_extensions=frozenset({'pex'}), constants=frozenset(), classes=frozenset(), variables=frozenset(), dedup_headings=False, only_sections=False)
) -> str

Sorts the literal present within the provided code against the provided sort type, returning the sorted representation of the source code.

View Source
def assignment(code: str, sort_type: str, extension: str, config: Config = DEFAULT_CONFIG) -> str:

    """Sorts the literal present within the provided code against the provided sort type,

    returning the sorted representation of the source code.

    """

    if sort_type == "assignments":

        return assignments(code)

    elif sort_type not in type_mapping:

        raise ValueError(

            "Trying to sort using an undefined sort_type. "

            f"Defined sort types are {', '.join(type_mapping.keys())}."

        )

    variable_name, literal = code.split(" = ")

    variable_name = variable_name.lstrip()

    try:

        value = ast.literal_eval(literal)

    except Exception as error:

        raise LiteralParsingFailure(code, error)

    expected_type, sort_function = type_mapping[sort_type]

    if type(value) != expected_type:

        raise LiteralSortTypeMismatch(type(value), expected_type)

    printer = ISortPrettyPrinter(config)

    sorted_value_code = f"{variable_name} = {sort_function(value, printer)}"

    if config.formatting_function:

        sorted_value_code = config.formatting_function(

            sorted_value_code, extension, config

        ).rstrip()

    sorted_value_code += code[len(code.rstrip()) :]

    return sorted_value_code

assignments

def assignments(
    code: str
) -> str
View Source
def assignments(code: str) -> str:

    sort_assignments = {}

    for line in code.splitlines(keepends=True):

        if line:

            if " = " not in line:

                raise AssignmentsFormatMismatch(code)

            else:

                variable_name, value = line.split(" = ", 1)

                sort_assignments[variable_name] = value

    sorted_assignments = dict(sorted(sort_assignments.items(), key=lambda item: item[1]))

    return "".join(f"{key} = {value}" for key, value in sorted_assignments.items())

register_type

def register_type(
    name: str,
    kind: type
)

Registers a new literal sort type.

View Source
def register_type(name: str, kind: type):

    """Registers a new literal sort type."""

    def wrap(function):

        type_mapping[name] = (kind, function)

        return function

    return wrap

Classes

ISortPrettyPrinter

class ISortPrettyPrinter(
    config: isort.settings.Config
)

an isort customized pretty printer for sorted literals

View Source
class ISortPrettyPrinter(PrettyPrinter):

    """an isort customized pretty printer for sorted literals"""

    def __init__(self, config: Config):

        super().__init__(width=config.line_length, compact=True)

Ancestors (in MRO)

  • pprint.PrettyPrinter

Methods

format
def format(
    self,
    object,
    context,
    maxlevels,
    level
)

Format object for a specific context, returning a string and flags indicating whether the representation is 'readable' and whether the object represents a recursive construct.

View Source
    def format(self, object, context, maxlevels, level):

        """Format object for a specific context, returning a string

        and flags indicating whether the representation is 'readable'

        and whether the object represents a recursive construct.

        """

        return _safe_repr(object, context, maxlevels, level, self._sort_dicts)
isreadable
def isreadable(
    self,
    object
)
View Source
    def isreadable(self, object):

        s, readable, recursive = self.format(object, {}, 0, 0)

        return readable and not recursive
isrecursive
def isrecursive(
    self,
    object
)
View Source
    def isrecursive(self, object):

        return self.format(object, {}, 0, 0)[2]
pformat
def pformat(
    self,
    object
)
View Source
    def pformat(self, object):

        sio = _StringIO()

        self._format(object, sio, 0, 0, {}, 0)

        return sio.getvalue()
pprint
def pprint(
    self,
    object
)
View Source
    def pprint(self, object):

        self._format(object, self._stream, 0, 0, {}, 0)

        self._stream.write("\n")