Skip to content

Add location to TestClass nodes for Test Explorer runnability (pytest and unittest) #29

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

Draft
wants to merge 7 commits into
base: supposed-spoonbill
Choose a base branch
from
Draft

Add location to TestClass nodes for Test Explorer runnability (pytest and unittest) #29

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
ea372d8
Initial plan
Copilot Nov 14, 2025
cf2e468
Add lineno to class nodes for pytest discovery
Copilot Nov 14, 2025
75ec7fd
Fix Python type checking errors and format code
Copilot Nov 14, 2025
e22f3c3
Add lineno to class nodes for unittest discovery
Copilot Nov 14, 2025
feeccf8
Return empty string instead of asterisk when class line cannot be det…
Copilot Nov 14, 2025
03ed7b2
opt for undefined as null value
eleanorjboyd Nov 14, 2025
cfce9b4
linting
eleanorjboyd Nov 14, 2025
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
46 changes: 45 additions & 1 deletion python_files/tests/pytestadapter/expected_discovery_test_output.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,11 @@
import os

from .helpers import TEST_DATA_PATH, find_test_line_number, get_absolute_test_id
from .helpers import (
TEST_DATA_PATH,
find_class_line_number,
find_test_line_number,
get_absolute_test_id,
)

# This file contains the expected output dictionaries for tests discovery and is used in test_discovery.py.

Expand Down Expand Up @@ -95,6 +100,7 @@
"unittest_pytest_same_file.py::TestExample",
unit_pytest_same_file_path,
),
"lineno": find_class_line_number("TestExample", unit_pytest_same_file_path),
},
{
"name": "test_true_pytest",
Expand Down Expand Up @@ -207,6 +213,7 @@
"unittest_folder/test_add.py::TestAddFunction",
test_add_path,
),
"lineno": find_class_line_number("TestAddFunction", test_add_path),
},
{
"name": "TestDuplicateFunction",
Expand Down Expand Up @@ -235,6 +242,9 @@
"unittest_folder/test_add.py::TestDuplicateFunction",
test_add_path,
),
"lineno": find_class_line_number(
"TestDuplicateFunction", test_add_path
),
},
],
},
Expand Down Expand Up @@ -288,6 +298,9 @@
"unittest_folder/test_subtract.py::TestSubtractFunction",
test_subtract_path,
),
"lineno": find_class_line_number(
"TestSubtractFunction", test_subtract_path
),
},
{
"name": "TestDuplicateFunction",
Expand Down Expand Up @@ -316,6 +329,9 @@
"unittest_folder/test_subtract.py::TestDuplicateFunction",
test_subtract_path,
),
"lineno": find_class_line_number(
"TestDuplicateFunction", test_subtract_path
),
},
],
},
Expand Down Expand Up @@ -553,6 +569,7 @@
"parametrize_tests.py::TestClass",
parameterize_tests_path,
),
"lineno": find_class_line_number("TestClass", parameterize_tests_path),
"children": [
{
"name": "test_adding",
Expand Down Expand Up @@ -929,6 +946,7 @@
"test_multi_class_nest.py::TestFirstClass",
TEST_MULTI_CLASS_NEST_PATH,
),
"lineno": find_class_line_number("TestFirstClass", TEST_MULTI_CLASS_NEST_PATH),
"children": [
{
"name": "TestSecondClass",
Expand All @@ -938,6 +956,9 @@
"test_multi_class_nest.py::TestFirstClass::TestSecondClass",
TEST_MULTI_CLASS_NEST_PATH,
),
"lineno": find_class_line_number(
"TestSecondClass", TEST_MULTI_CLASS_NEST_PATH
),
"children": [
{
"name": "test_second",
Expand Down Expand Up @@ -982,6 +1003,9 @@
"test_multi_class_nest.py::TestFirstClass::TestSecondClass2",
TEST_MULTI_CLASS_NEST_PATH,
),
"lineno": find_class_line_number(
"TestSecondClass2", TEST_MULTI_CLASS_NEST_PATH
),
"children": [
{
"name": "test_second2",
Expand Down Expand Up @@ -1227,6 +1251,9 @@
"same_function_new_class_param.py::TestNotEmpty",
TEST_DATA_PATH / "same_function_new_class_param.py",
),
"lineno": find_class_line_number(
"TestNotEmpty", TEST_DATA_PATH / "same_function_new_class_param.py"
),
},
{
"name": "TestEmpty",
Expand Down Expand Up @@ -1298,6 +1325,9 @@
"same_function_new_class_param.py::TestEmpty",
TEST_DATA_PATH / "same_function_new_class_param.py",
),
"lineno": find_class_line_number(
"TestEmpty", TEST_DATA_PATH / "same_function_new_class_param.py"
),
},
],
}
Expand Down Expand Up @@ -1371,6 +1401,9 @@
"test_param_span_class.py::TestClass1",
TEST_DATA_PATH / "test_param_span_class.py",
),
"lineno": find_class_line_number(
"TestClass1", TEST_DATA_PATH / "test_param_span_class.py"
),
},
{
"name": "TestClass2",
Expand Down Expand Up @@ -1427,6 +1460,9 @@
"test_param_span_class.py::TestClass2",
TEST_DATA_PATH / "test_param_span_class.py",
),
"lineno": find_class_line_number(
"TestClass2", TEST_DATA_PATH / "test_param_span_class.py"
),
},
],
}
Expand Down Expand Up @@ -1503,6 +1539,7 @@
"pytest_describe_plugin/describe_only.py::describe_A",
describe_only_path,
),
"lineno": find_class_line_number("describe_A", describe_only_path),
}
],
}
Expand Down Expand Up @@ -1586,6 +1623,9 @@
"pytest_describe_plugin/nested_describe.py::describe_list::describe_append",
nested_describe_path,
),
"lineno": find_class_line_number(
"describe_append", nested_describe_path
),
},
{
"name": "describe_remove",
Expand Down Expand Up @@ -1614,12 +1654,16 @@
"pytest_describe_plugin/nested_describe.py::describe_list::describe_remove",
nested_describe_path,
),
"lineno": find_class_line_number(
"describe_remove", nested_describe_path
),
},
],
"id_": get_absolute_test_id(
"pytest_describe_plugin/nested_describe.py::describe_list",
nested_describe_path,
),
"lineno": find_class_line_number("describe_list", nested_describe_path),
}
],
}
Expand Down
22 changes: 22 additions & 0 deletions python_files/tests/pytestadapter/helpers.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -370,6 +370,28 @@ def find_test_line_number(test_name: str, test_file_path) -> str:
raise ValueError(error_str)


def find_class_line_number(class_name: str, test_file_path) -> str:
"""Function which finds the correct line number for a class definition.

Args:
class_name: The name of the class to find the line number for.
test_file_path: The path to the test file where the class is located.
"""
# Look for the class definition line (or function for pytest-describe)
with open(test_file_path) as f: # noqa: PTH123
for i, line in enumerate(f):
# Match "class ClassName" or "class ClassName(" or "class ClassName:"
# Also match "def ClassName(" for pytest-describe blocks
if (
line.strip().startswith(f"class {class_name}")
or line.strip().startswith(f"class {class_name}(")
or line.strip().startswith(f"def {class_name}(")
):
return str(i + 1)
error_str: str = f"Class {class_name!r} not found on any line in {test_file_path}"
raise ValueError(error_str)


def get_absolute_test_id(test_id: str, test_path: pathlib.Path) -> str:
"""Get the absolute test id by joining the testPath with the test_id."""
split_id = test_id.split("::")[1:]
Expand Down
26 changes: 25 additions & 1 deletion python_files/vscode_pytest/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,17 @@
import pathlib
import sys
import traceback
from typing import TYPE_CHECKING, Any, Dict, Generator, Literal, Protocol, TypedDict, cast
from typing import (
TYPE_CHECKING,
Any,
Dict,
Generator,
Literal,
NotRequired,
Protocol,
TypedDict,
cast,
)

import pytest

Expand Down Expand Up @@ -52,6 +62,7 @@ class TestNode(TestData):
"""A general class that handles all test data which contains children."""

children: list[TestNode | TestItem | None]
lineno: NotRequired[str] # Optional field for class/function nodes


class VSCodePytestError(Exception):
Expand Down Expand Up @@ -830,12 +841,25 @@ def create_class_node(class_module: pytest.Class | DescribeBlock) -> TestNode:
Keyword arguments:
class_module -- the pytest object representing a class module.
"""
# Get line number for the class definition
class_line = ""
try:
if hasattr(class_module, "obj"):
import inspect

_, lineno = inspect.getsourcelines(class_module.obj)
class_line = str(lineno)
except (OSError, TypeError):
# If we can't get the source lines, leave lineno empty
pass

return {
"name": class_module.name,
"path": get_node_path(class_module),
"type_": "class",
"children": [],
"id_": get_absolute_test_id(class_module.nodeid, get_node_path(class_module)),
"lineno": class_line,
}


Expand Down
3 changes: 2 additions & 1 deletion src/client/testing/testController/common/types.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -177,7 +177,7 @@ export interface ITestExecutionAdapter {
}

// Same types as in python_files/unittestadapter/utils.py
export type DiscoveredTestType = 'folder' | 'file' | 'class' | 'test';
export type DiscoveredTestType = 'folder' | 'file' | 'class' | 'function' | 'test';

export type DiscoveredTestCommon = {
path: string;
Expand All @@ -194,6 +194,7 @@ export type DiscoveredTestItem = DiscoveredTestCommon & {

export type DiscoveredTestNode = DiscoveredTestCommon & {
children: (DiscoveredTestNode | DiscoveredTestItem)[];
lineno?: number | string;
};

export type DiscoveredTestPayload = {
Expand Down
15 changes: 15 additions & 0 deletions src/client/testing/testController/common/utils.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -257,6 +257,21 @@ export function populateTestTree(

node.canResolveChildren = true;
node.tags = [RunTestTag, DebugTestTag];

// Set range for class nodes (and other nodes) if lineno is available
let range: Range | undefined;
if ('lineno' in child && child.lineno) {
if (Number(child.lineno) === 0) {
range = new Range(new Position(0, 0), new Position(0, 0));
} else {
range = new Range(
new Position(Number(child.lineno) - 1, 0),
new Position(Number(child.lineno), 0),
);
}
node.range = range;
}

testRoot!.children.add(node);
}
populateTestTree(testController, child, node, resultResolver, token);
Expand Down