Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

add test for #48 #49

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

add test for #48 #49

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f30bec9
add test for #48
graingert Apr 18, 2019
2730b15
use ast to remove unused assignments Fixes #48
graingert Apr 18, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
97 changes: 69 additions & 28 deletions autoflake.py
View file
Open in desktop
Expand Up @@ -28,6 +28,7 @@

import ast
import difflib
import functools
import collections
import distutils.sysconfig
import fnmatch
Expand Down Expand Up @@ -140,10 +141,11 @@ def star_import_usage_undefined_name(messages):


def unused_variable_line_numbers(messages):
"""Yield line numbers of unused variables."""
for message in messages:
if isinstance(message, pyflakes.messages.UnusedVariable):
yield message.lineno
"""Dict of line numbers to unused variables."""
return {
m.lineno: frozenset(m.message_args)
for m in messages
}


def duplicate_key_line_numbers(messages, source):
Expand Down Expand Up @@ -372,10 +374,11 @@ def filter_code(source, additional_imports=None,
marked_star_import_line_numbers = frozenset()

if remove_unused_variables:
marked_variable_line_numbers = frozenset(
unused_variable_line_numbers(messages))
marked_variable_line_numbers = (
unused_variable_line_numbers(messages)
)
else:
marked_variable_line_numbers = frozenset()
marked_variable_line_numbers = {}

if remove_duplicate_keys:
marked_key_line_numbers = frozenset(
Expand All @@ -388,6 +391,7 @@ def filter_code(source, additional_imports=None,
sio = io.StringIO(source)
previous_line = ''
for line_number, line in enumerate(sio.readlines(), start=1):
unused_vars = marked_variable_line_numbers.get(line_number)
if '#' in line:
yield line
elif line_number in marked_import_line_numbers:
Expand All @@ -397,8 +401,8 @@ def filter_code(source, additional_imports=None,
remove_all_unused_imports=remove_all_unused_imports,
imports=imports,
previous_line=previous_line)
elif line_number in marked_variable_line_numbers:
yield filter_unused_variable(line)
elif unused_vars:
yield filter_unused_variable(line, unused_vars)
elif line_number in marked_key_line_numbers:
yield filter_duplicate_key(line, line_messages[line_number],
line_number, marked_key_line_numbers,
Expand Down Expand Up @@ -453,28 +457,65 @@ def filter_unused_import(line, unused_module, remove_all_unused_imports,
get_line_ending(line))


def filter_unused_variable(line, previous_line=''):
"""Return line if used, otherwise return None."""
if re.match(EXCEPT_REGEX, line):
return re.sub(r' as \w+:$', ':', line, count=1)
elif multiline_statement(line, previous_line):
def _remove_one_assignment_target(unused_vars, line):
try:
parsed = ast.parse(line)
except SyntaxError:
return line
elif line.count('=') == 1:
split_line = line.split('=')
assert len(split_line) == 2
value = split_line[1].lstrip()
if ',' in split_line[0]:
return line

if is_literal_or_name(value):
# Rather than removing the line, replace with it "pass" to avoid
# a possible hanging block with no body.
value = 'pass' + get_line_ending(line)

return get_indentation(line) + value
else:

assignment = parsed.body[0]
if not isinstance(assignment, ast.Assign):
return line

targets = assignment.targets
for target in assignment.targets:
if not isinstance(target, ast.Name):
continue
name = target.id
if name not in unused_vars:
continue
offset = target.col_offset
return line[:offset] + re.sub(
r'\A\s*' + re.escape(name) + r'\s*=\s*',
'', line[offset:],
count=1,
)
return line


def _fix(fn, value):
"""
Apply fn to its output until it coverges
"""
while True:
new_value = fn(value)
if new_value == value:
return new_value
value = new_value


def filter_unused_variable(line, unused_vars):
"""Return line if used, otherwise return None."""
if re.match(EXCEPT_REGEX, line):
assert len(unused_vars) == 1
unused_e, = unused_vars
return line.replace(
' as {}:'.format(unused_e),
':',
1,
)

indentation = get_indentation(line)
line = line[len(indentation):]
remove = functools.partial(_remove_one_assignment_target, unused_vars)
line = _fix(remove, line)

if is_literal_or_name(line):
# Rather than removing the line, replace with it "pass" to avoid
# a possible hanging block with no body.
return indentation + 'pass' + get_line_ending(line)
return indentation + line


def filter_duplicate_key(line, message, line_number, marked_line_numbers,
source, previous_line=''):
Expand Down
42 changes: 28 additions & 14 deletions test_autoflake.py
View file
Open in desktop
Expand Up @@ -109,48 +109,62 @@ def test_filter_star_import(self):

def test_filter_unused_variable(self):
self.assertEqual('foo()',
autoflake.filter_unused_variable('x = foo()'))
autoflake.filter_unused_variable('x = foo()', 'x'))

self.assertEqual(' foo()',
autoflake.filter_unused_variable(' x = foo()'))
autoflake.filter_unused_variable(' x = foo()', 'x'))

def test_filter_unused_variable_kwarg(self):
self.assertEqual('foo(k=None)',
autoflake.filter_unused_variable('x = foo(k=None)', 'x'))

def test_filter_unused_variable_with_literal_or_name(self):
self.assertEqual('pass',
autoflake.filter_unused_variable('x = 1'))
autoflake.filter_unused_variable('x = 1', 'x'))

self.assertEqual('pass',
autoflake.filter_unused_variable('x = y'))
autoflake.filter_unused_variable('x = y', 'x'))

self.assertEqual('pass',
autoflake.filter_unused_variable('x = {}'))
autoflake.filter_unused_variable('x = {}', 'x'))

def test_filter_unused_variable_with_basic_data_structures(self):
self.assertEqual('pass',
autoflake.filter_unused_variable('x = dict()'))
autoflake.filter_unused_variable('x = dict()', 'x'))

self.assertEqual('pass',
autoflake.filter_unused_variable('x = list()'))
autoflake.filter_unused_variable('x = list()', 'x'))

self.assertEqual('pass',
autoflake.filter_unused_variable('x = set()'))
autoflake.filter_unused_variable('x = set()', 'x'))

def test_filter_unused_variable_should_ignore_multiline(self):
self.assertEqual('x = foo()\\',
autoflake.filter_unused_variable('x = foo()\\'))
self.assertEqual('foo()\\',
autoflake.filter_unused_variable('x = foo()\\', 'x'))
self.assertEqual('x = foo(\\',
autoflake.filter_unused_variable('x = foo(\\', 'x'))
self.assertEqual('x = foo(',
autoflake.filter_unused_variable('x = foo(', 'x'))


def test_filter_unused_variable_should_multiple_assignments(self):
self.assertEqual('x = y = foo()',
autoflake.filter_unused_variable('x = y = foo()'))
self.assertEqual('y = foo()',
autoflake.filter_unused_variable('x = y = foo()', 'x'))
self.assertEqual('x = foo()',
autoflake.filter_unused_variable('x = y = foo()', 'y'))
self.assertEqual('foo()',
autoflake.filter_unused_variable('x = y = foo()', 'xy'))


def test_filter_unused_variable_with_exception(self):
self.assertEqual(
'except Exception:',
autoflake.filter_unused_variable('except Exception as exception:'))
autoflake.filter_unused_variable('except Exception as exception:', {'exception'}))

self.assertEqual(
'except (ImportError, ValueError):',
autoflake.filter_unused_variable(
'except (ImportError, ValueError) as foo:'))
'except (ImportError, ValueError) as foo:', {'foo'}))

def test_filter_code(self):
self.assertEqual(
Expand Down