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.

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

Exempt unittest context methods for SIM115 rule #16439

Merged
merged 1 commit into from
Feb 28, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -264,3 +264,22 @@ def func(filepath, encoding):
# OK
def func(filepath, encoding):
return f(open(filepath, mode="rt", encoding=encoding))


from unittest import IsolatedAsyncioTestCase, TestCase

# OK
class ExampleClassTests(TestCase):
@classmethod
def setUpClass(cls):
cls.enterClassContext(open("filename"))

# OK
class ExampleAsyncTests(IsolatedAsyncioTestCase):
async def test_something(self):
await self.enterAsyncContext(open("filename"))

# OK
class ExampleTests(TestCase):
def setUp(self):
self.enterContext(open("filename"))
Original file line number Diff line number Diff line change
Expand Up @@ -114,6 +114,28 @@ fn match_exit_stack(semantic: &SemanticModel) -> bool {
false
}

/// Return `true` if the current expression is nested in a call to one of the
/// unittest context manager methods: `cls.enterClassContext()`,
/// `self.enterContext()`, or `self.enterAsyncContext()`.
fn match_unittest_context_methods(semantic: &SemanticModel) -> bool {
let Some(expr) = semantic.current_expression_parent() else {
return false;
};
let Expr::Call(ast::ExprCall { func, .. }) = expr else {
return false;
};
let Expr::Attribute(ast::ExprAttribute { attr, value, .. }) = func.as_ref() else {
return false;
};
let Expr::Name(ast::ExprName { id, .. }) = value.as_ref() else {
return false;
};
matches!(
(id.as_str(), attr.as_str()),
("cls", "enterClassContext") | ("self", "enterContext" | "enterAsyncContext")
)
}

/// Return `true` if the expression is a call to `open()`,
/// or a call to some other standard-library function that opens a file.
fn is_open_call(semantic: &SemanticModel, call: &ast::ExprCall) -> bool {
Expand Down Expand Up @@ -229,6 +251,11 @@ pub(crate) fn open_file_with_context_handler(checker: &Checker, call: &ast::Expr
return;
}

// Ex) `self.enterContext(open("foo.txt"))`
if match_unittest_context_methods(semantic) {
return;
}

// Ex) `def __enter__(self): ...`
if let ScopeKind::Function(ast::StmtFunctionDef { name, .. }) =
&checker.semantic().current_scope().kind
Expand Down
Loading