Skip to main content

A flake8 plugin to help you write better list/set/dict comprehensions.

Project description

https://img.shields.io/github/actions/workflow/status/adamchainz/flake8-comprehensions/main.yml?branch=main&style=for-the-badge https://img.shields.io/pypi/v/flake8-comprehensions.svg?style=for-the-badge https://img.shields.io/badge/code%20style-black-000000.svg?style=for-the-badge pre-commit

A flake8 plugin that helps you write better list/set/dict comprehensions.

Requirements

Python 3.7 to 3.12 supported.

Installation

First, install with pip:

python -m pip install flake8-comprehensions

Second, if you define Flake8’s select setting, add the C4 prefix to it. Otherwise, the plugin should be active by default.


Linting a Django project? Check out my book Boost Your Django DX which covers Flake8 and many other code quality tools.


Rules

C400-402: Unnecessary generator - rewrite as a <list/set/dict> comprehension.

Rules:

  • C400 Unnecessary generator - rewrite as a list comprehension.

  • C401 Unnecessary generator - rewrite as a set comprehension.

  • C402 Unnecessary generator - rewrite as a dict comprehension.

It’s unnecessary to use list, set, or dict around a generator expression, since there are equivalent comprehensions for these types. For example:

  • Rewrite list(f(x) for x in foo) as [f(x) for x in foo]

  • Rewrite set(f(x) for x in foo) as {f(x) for x in foo}

  • Rewrite dict((x, f(x)) for x in foo) as {x: f(x) for x in foo}

C403-404: Unnecessary list comprehension - rewrite as a <set/dict> comprehension.

Rules:

  • C403 Unnecessary list comprehension - rewrite as a set comprehension.

  • C404 Unnecessary list comprehension - rewrite as a dict comprehension.

It’s unnecessary to use a list comprehension inside a call to set or dict, since there are equivalent comprehensions for these types. For example:

  • Rewrite set([f(x) for x in foo]) as {f(x) for x in foo}

  • Rewrite dict([(x, f(x)) for x in foo]) as {x: f(x) for x in foo}

C405-406: Unnecessary <list/tuple> literal - rewrite as a <set/dict> literal.

  • C405 Unnecessary <list/tuple> literal - rewrite as a set literal.

  • C406 Unnecessary <list/tuple> literal - rewrite as a dict literal.

It’s unnecessary to use a list or tuple literal within a call to set or dict. For example:

  • Rewrite set([1, 2]) as {1, 2}

  • Rewrite set((1, 2)) as {1, 2}

  • Rewrite set([]) as set()

  • Rewrite dict([(1, 2)]) as {1: 2}

  • Rewrite dict(((1, 2),)) as {1: 2}

  • Rewrite dict([]) as {}

C407: Unnecessary <dict/list> comprehension - <builtin> can take a generator

This rule was dropped in version 3.4.0, because it promoted an increase in laziness which could lead to bugs.

C408: Unnecessary <dict/list/tuple> call - rewrite as a literal.

It’s slower to call e.g. dict() than using the empty literal, because the name dict must be looked up in the global scope in case it has been rebound. Same for the other two basic types here. For example:

  • Rewrite dict() as {}

  • Rewrite dict(a=1, b=2) as {"a": 1, "b": 2}

  • Rewrite list() as []

  • Rewrite tuple() as ()

C409-410: Unnecessary <list/tuple> passed to <list/tuple>() - <advice>.

Rules:

  • C409 Unnecessary <list/tuple> passed to tuple() - <advice>.

  • C410 Unnecessary list passed to list() - <advice>.

Where <advice> is either:

  • remove the outer call to <list/tuple>()

  • rewrite as a <list/tuple> literal

It’s unnecessary to use a list or tuple literal within a call to list or tuple, since there is literal syntax for these types. For example:

  • Rewrite tuple([1, 2]) as (1, 2)

  • Rewrite tuple((1, 2)) as (1, 2)

  • Rewrite tuple([]) as ()

  • Rewrite list([1, 2]) as [1, 2]

  • Rewrite list((1, 2)) as [1, 2]

  • Rewrite list([]) as []

C411: Unnecessary list call - remove the outer call to list().

It’s unnecessary to use a list around a list comprehension, since it is equivalent without it. For example:

  • Rewrite list([f(x) for x in foo]) as [f(x) for x in foo]

C412: Unnecessary <dict/list/set> comprehension - ‘in’ can take a generator.

This rule was dropped in version 3.4.0, because it promoted an increase in laziness which could lead to bugs.

C413: Unnecessary <list/reversed> call around sorted().

It’s unnecessary to use list() around sorted() as it already returns a list. It is also unnecessary to use reversed() around sorted() as the latter has a reverse argument. For example:

  • Rewrite list(sorted([2, 3, 1])) as sorted([2, 3, 1])

  • Rewrite reversed(sorted([2, 3, 1])) as sorted([2, 3, 1], reverse=True)

  • Rewrite reversed(sorted([2, 3, 1], reverse=True)) as sorted([2, 3, 1])

C414: Unnecessary <list/reversed/set/sorted/tuple> call within <list/set/sorted/tuple>().

It’s unnecessary to double-cast or double-process iterables by wrapping the listed functions within list/set/sorted/tuple. For example:

  • Rewrite list(list(iterable)) as list(iterable)

  • Rewrite list(tuple(iterable)) as list(iterable)

  • Rewrite tuple(list(iterable)) as tuple(iterable)

  • Rewrite tuple(tuple(iterable)) as tuple(iterable)

  • Rewrite set(set(iterable)) as set(iterable)

  • Rewrite set(list(iterable)) as set(iterable)

  • Rewrite set(tuple(iterable)) as set(iterable)

  • Rewrite set(sorted(iterable)) as set(iterable)

  • Rewrite set(reversed(iterable)) as set(iterable)

  • Rewrite sorted(list(iterable)) as sorted(iterable)

  • Rewrite sorted(tuple(iterable)) as sorted(iterable)

  • Rewrite sorted(sorted(iterable)) as sorted(iterable)

  • Rewrite sorted(reversed(iterable)) as sorted(iterable)

C415: Unnecessary subscript reversal of iterable within <reversed/set/sorted>().

It’s unnecessary to reverse the order of an iterable when passing it into one of the listed functions will change the order again. For example:

  • Rewrite set(iterable[::-1]) as set(iterable)

  • Rewrite sorted(iterable)[::-1] as sorted(iterable, reverse=True)

  • Rewrite reversed(iterable[::-1]) as iterable

C416: Unnecessary <dict/list/set> comprehension - rewrite using <dict/list/set>().

It’s unnecessary to use a dict/list/set comprehension to build a data structure if the elements are unchanged. Wrap the iterable with dict(), list(), or set() instead. For example:

  • Rewrite {a: b for a, b in iterable} as dict(iterable)

  • Rewrite [x for x in iterable] as list(iterable)

  • Rewrite {x for x in iterable} as set(iterable)

C417: Unnecessary map usage - rewrite using a generator expression/<list/set/dict> comprehension.

map(func, iterable) has great performance when func is a built-in function, and it makes sense if your function already has a name. But if your func is a lambda, it’s faster to use a generator expression or a comprehension, as it avoids the function call overhead. For example:

  • Rewrite map(lambda x: x + 1, iterable) to (x + 1 for x in iterable)

  • Rewrite map(lambda item: get_id(item), items) to (get_id(item) for item in items)

  • Rewrite list(map(lambda num: num * 2, nums)) to [num * 2 for num in nums]

  • Rewrite set(map(lambda num: num % 2 == 0, nums)) to {num % 2 == 0 for num in nums}

  • Rewrite dict(map(lambda v: (v, v ** 2), values)) to {v : v ** 2 for v in values}

C418: Unnecessary <dict/dict comprehension> passed to dict() - remove the outer call to dict()

It’s unnecessary to use a dict around a dict literal or dict comprehension, since either syntax already constructs a dict. For example:

  • Rewrite dict({}) as {}

  • Rewrite dict({"a": 1}) as {"a": 1}

C419 Unnecessary list comprehension in <any/all>() prevents short-circuiting - rewrite as a generator.

Using a list comprehension inside a call to any()/all() prevents short-circuiting when a True / False value is found. The whole list will be constructed before calling any()/all(), potentially wasting work.part-way. Rewrite to use a generator expression, which can stop part way. For example:

  • Rewrite all([condition(x) for x in iterable]) as all(condition(x) for x in iterable)

  • Rewrite any([condition(x) for x in iterable]) as any(condition(x) for x in iterable)

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

flake8_comprehensions-3.13.0.tar.gz (15.6 kB view details)

Uploaded Source

Built Distribution

flake8_comprehensions-3.13.0-py3-none-any.whl (8.1 kB view details)

Uploaded Python 3

File details

Details for the file flake8_comprehensions-3.13.0.tar.gz.

File metadata

File hashes

Hashes for flake8_comprehensions-3.13.0.tar.gz
Algorithm Hash digest
SHA256 83cf98e816c9e23360f36aaf47de59a5b21437fdff8a056c46e2ad49f81861bf
MD5 a0085f647eac7596e955a2d6066fb37b
BLAKE2b-256 72cca5ce88a747365682908aa76d14991839d0dec6ac301899fbb8c18cd4cbbf

See more details on using hashes here.

File details

Details for the file flake8_comprehensions-3.13.0-py3-none-any.whl.

File metadata

File hashes

Hashes for flake8_comprehensions-3.13.0-py3-none-any.whl
Algorithm Hash digest
SHA256 cc0d6dbb336ff4e9cdf4eb605a3f719ea59261f2d6ba52034871a173c40e1f60
MD5 776676646225ed9922ea4058d415a1f6
BLAKE2b-256 896ec1a97a5cbdf111c9adb65aabacaf1a77eb7f57c275941665d8358272788d

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page