Skip to content

feat(gazelle): Add include_pytest_conftest annotation#3080

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

Merged
aignas merged 8 commits into from
Jul 15, 2025
Merged

feat(gazelle): Add include_pytest_conftest annotation #3080

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
f5d8a7e
Add test cases
dougthor42 Jul 11, 2025
356a605
Add an annotations attribute to the targetBuilder struct
dougthor42 Jul 11, 2025
94a6ade
Update parser to handle gazelle_pytest_conftest annotation.
dougthor42 Jul 11, 2025
b1e98bf
Only add conftest dep when includePytestConftest is nil or true
dougthor42 Jul 11, 2025
e166653
Changelog and documentation
dougthor42 Jul 11, 2025
7969307
Add more tests
dougthor42 Jul 11, 2025
549ab0e
Merge branch 'main' into u/dthor/gazelle-conftest-annotation-gh3076
dougthor42 Jul 14, 2025
6025461
Merge branch 'main' into u/dthor/gazelle-conftest-annotation-gh3076
aignas Jul 15, 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
5 changes: 5 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -106,6 +106,11 @@ END_UNRELEASED_TEMPLATE
* 3.12.11
* 3.13.5
* 3.14.0b3
* (gazelle): New annotation `gazelle:include_pytest_conftest`. When not set (the
default) or `true`, gazelle will inject any `conftest.py` file found in the same
directory as a {obj}`py_test` target to that {obj}`py_test` target's `deps`.
This behavior is unchanged from previous versions. When `false`, the `:conftest`
dep is not added to the {obj}`py_test` target.
* (gazelle) New directive `gazelle:python_generate_proto`; when `true`,
Gazelle generates `py_proto_library` rules for `proto_library`. `false` by default.

Expand Down
85 changes: 85 additions & 0 deletions gazelle/README.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -550,6 +550,8 @@ The annotations are:
| Tells Gazelle to ignore import statements. `imports` is a comma-separated list of imports to ignore. | |
| [`# gazelle:include_dep targets`](#annotation-include_dep) | N/A |
| Tells Gazelle to include a set of dependencies, even if they are not imported in a Python module. `targets` is a comma-separated list of target names to include as dependencies. | |
| [`# gazelle:include_pytest_conftest bool`](#annotation-include_pytest_conftest) | N/A |
| Whether or not to include a sibling `:conftest` target in the deps of a `py_test` target. Default behaviour is to include `:conftest`. | |


#### Annotation: `ignore`
Expand DownExpand Up@@ -622,6 +624,89 @@ deps = [
]
```

#### Annotation: `include_pytest_conftest`

Added in [#3080][gh3080].

[gh3080]: https://github.com/bazel-contrib/rules_python/pull/3080

This annotation accepts any string that can be parsed by go's
[`strconv.ParseBool`][ParseBool]. If an unparsable string is passed, the
annotation is ignored.

[ParseBool]: https://pkg.go.dev/strconv#ParseBool

Starting with [`rules_python` 0.14.0][rules-python-0.14.0] (specifically [PR #879][gh879]),
Gazelle will include a `:conftest` dependency to an `py_test` target that is in
the same directory as `conftest.py`.

[rules-python-0.14.0]: https://github.com/bazel-contrib/rules_python/releases/tag/0.14.0
[gh879]: https://github.com/bazel-contrib/rules_python/pull/879

This annotation allows users to adjust that behavior. To disable the behavior, set
the annotation value to "false":

```
# some_file_test.py
# gazelle:include_pytest_conftest false
```

Example:

Given a directory tree like:

```
.
├── BUILD.bazel
├── conftest.py
└── some_file_test.py
```

The default Gazelle behavior would create:

```starlark
py_library(
name = "conftest",
testonly = True,
srcs = ["conftest.py"],
visibility = ["//:__subpackages__"],
)

py_test(
name = "some_file_test",
srcs = ["some_file_test.py"],
deps = [":conftest"],
)
```

When `# gazelle:include_pytest_conftest false` is found in `some_file_test.py`

```python
# some_file_test.py
# gazelle:include_pytest_conftest false
```

Gazelle will generate:

```starlark
py_library(
name = "conftest",
testonly = True,
srcs = ["conftest.py"],
visibility = ["//:__subpackages__"],
)

py_test(
name = "some_file_test",
srcs = ["some_file_test.py"],
)
```

See [Issue #3076][gh3076] for more information.

[gh3076]: https://github.com/bazel-contrib/rules_python/issues/3076


#### Directive: `experimental_allow_relative_imports`
Enables experimental support for resolving relative imports in
`python_generation_mode package`.
Expand Down
17 changes: 15 additions & 2 deletions gazelle/python/generate.go
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -264,7 +264,9 @@ func (py *Python) GenerateRules(args language.GenerateArgs) language.GenerateRes
addSrc(filename).
addModuleDependencies(mainModules[filename]).
addResolvedDependencies(annotations.includeDeps).
generateImportsAttribute().build()
generateImportsAttribute().
setAnnotations(*annotations).
build()
result.Gen = append(result.Gen, pyBinary)
result.Imports = append(result.Imports, pyBinary.PrivateAttr(config.GazelleImportsKey))
}
Expand DownExpand Up@@ -305,6 +307,7 @@ func (py *Python) GenerateRules(args language.GenerateArgs) language.GenerateRes
addModuleDependencies(allDeps).
addResolvedDependencies(annotations.includeDeps).
generateImportsAttribute().
setAnnotations(*annotations).
build()

if pyLibrary.IsEmpty(py.Kinds()[pyLibrary.Kind()]) {
Expand DownExpand Up@@ -357,6 +360,7 @@ func (py *Python) GenerateRules(args language.GenerateArgs) language.GenerateRes
addSrc(pyBinaryEntrypointFilename).
addModuleDependencies(deps).
addResolvedDependencies(annotations.includeDeps).
setAnnotations(*annotations).
generateImportsAttribute()

pyBinary := pyBinaryTarget.build()
Expand DownExpand Up@@ -387,6 +391,7 @@ func (py *Python) GenerateRules(args language.GenerateArgs) language.GenerateRes
addSrc(conftestFilename).
addModuleDependencies(deps).
addResolvedDependencies(annotations.includeDeps).
setAnnotations(*annotations).
addVisibility(visibility).
setTestonly().
generateImportsAttribute()
Expand DownExpand Up@@ -418,6 +423,7 @@ func (py *Python) GenerateRules(args language.GenerateArgs) language.GenerateRes
addSrcs(srcs).
addModuleDependencies(deps).
addResolvedDependencies(annotations.includeDeps).
setAnnotations(*annotations).
generateImportsAttribute()
}
if (!cfg.PerPackageGenerationRequireTestEntryPoint() || hasPyTestEntryPointFile || hasPyTestEntryPointTarget || cfg.CoarseGrainedGeneration()) && !cfg.PerFileGeneration() {
Expand DownExpand Up@@ -470,7 +476,14 @@ func (py *Python) GenerateRules(args language.GenerateArgs) language.GenerateRes

for _, pyTestTarget := range pyTestTargets {
if conftest != nil {
pyTestTarget.addModuleDependency(Module{Name: strings.TrimSuffix(conftestFilename, ".py")})
conftestModule := Module{Name: strings.TrimSuffix(conftestFilename, ".py")}
if pyTestTarget.annotations.includePytestConftest == nil {
// unset; default behavior
pyTestTarget.addModuleDependency(conftestModule)
} else if *pyTestTarget.annotations.includePytestConftest {
// set; add if true, do not add if false
pyTestTarget.addModuleDependency(conftestModule)
}
}
pyTest := pyTestTarget.build()

Expand Down
30 changes: 26 additions & 4 deletions gazelle/python/parser.go
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -18,6 +18,8 @@ import (
"context"
_ "embed"
"fmt"
"log"
"strconv"
"strings"

"github.com/emirpasic/gods/sets/treeset"
Expand DownExpand Up@@ -123,6 +125,7 @@ func (p *python3Parser) parse(pyFilenames *treeset.Set) (*treeset.Set, map[strin
allAnnotations.ignore[k] = v
}
allAnnotations.includeDeps = append(allAnnotations.includeDeps, annotations.includeDeps...)
allAnnotations.includePytestConftest = annotations.includePytestConftest
}

allAnnotations.includeDeps = removeDupesFromStringTreeSetSlice(allAnnotations.includeDeps)
Expand DownExpand Up@@ -183,8 +186,12 @@ const (
// The Gazelle annotation prefix.
annotationPrefix string = "gazelle:"
// The ignore annotation kind. E.g. '# gazelle:ignore <module_name>'.
annotationKindIgnore annotationKind = "ignore"
annotationKindIncludeDep annotationKind = "include_dep"
annotationKindIgnore annotationKind = "ignore"
// Force a particular target to be added to `deps`. Multiple invocations are
// accumulated and the value can be comma separated.
// Eg: '# gazelle:include_dep //foo/bar:baz,@repo//:target
annotationKindIncludeDep annotationKind = "include_dep"
annotationKindIncludePytestConftest annotationKind = "include_pytest_conftest"
)

// Comment represents a Python comment.
Expand DownExpand Up@@ -222,13 +229,18 @@ type annotations struct {
ignore map[string]struct{}
// Labels that Gazelle should include as deps of the generated target.
includeDeps []string
// Whether the conftest.py file, found in the same directory as the current
// python test file, should be added to the py_test target's `deps` attribute.
// A *bool is used so that we can handle the "not set" state.
includePytestConftest *bool
}

// annotationsFromComments returns all the annotations parsed out of the
// comments of a Python module.
func annotationsFromComments(comments []Comment) (*annotations, error) {
ignore := make(map[string]struct{})
includeDeps := []string{}
var includePytestConftest *bool
for _, comment := range comments {
annotation, err := comment.asAnnotation()
if err != nil {
Expand All@@ -255,11 +267,21 @@ func annotationsFromComments(comments []Comment) (*annotations, error) {
includeDeps = append(includeDeps, t)
}
}
if annotation.kind == annotationKindIncludePytestConftest {
val := annotation.value
parsedVal, err := strconv.ParseBool(val)
if err != nil {
log.Printf("WARNING: unable to cast %q to bool in %q. Ignoring annotation", val, comment)
continue
}
includePytestConftest = &parsedVal
}
}
}
return &annotations{
ignore: ignore,
includeDeps: includeDeps,
ignore: ignore,
includeDeps: includeDeps,
includePytestConftest: includePytestConftest,
}, nil
}

Expand Down
9 changes: 9 additions & 0 deletions gazelle/python/target.go
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -37,6 +37,7 @@ type targetBuilder struct {
main *string
imports []string
testonly bool
annotations *annotations
}

// newTargetBuilder constructs a new targetBuilder.
Expand All@@ -51,6 +52,7 @@ func newTargetBuilder(kind, name, pythonProjectRoot, bzlPackage string, siblingS
deps: treeset.NewWith(moduleComparator),
resolvedDeps: treeset.NewWith(godsutils.StringComparator),
visibility: treeset.NewWith(godsutils.StringComparator),
annotations: new(annotations),
}
}

Expand DownExpand Up@@ -130,6 +132,13 @@ func (t *targetBuilder) setTestonly() *targetBuilder {
return t
}

// setAnnotations sets the annotations attribute on the target.
func (t *targetBuilder) setAnnotations(val annotations) *targetBuilder {
t.annotations = &val
return t
}


// generateImportsAttribute generates the imports attribute.
// These are a list of import directories to be added to the PYTHONPATH. In our
// case, the value we add is on Bazel sub-packages to be able to perform imports
Expand Down
25 changes: 25 additions & 0 deletions gazelle/python/testdata/annotation_include_pytest_conftest/README.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
# Annotation: Include Pytest Conftest

Validate that the `# gazelle:include_pytest_conftest` annotation follows
this logic:

+ When a `conftest.py` file does not exist:
+ all values have no affect
+ When a `conftest.py` file does exist:
+ Truthy values add `:conftest` to `deps`.
+ Falsey values do not add `:conftest` to `deps`.
+ Unset (no annotation) performs the default action.

Additionally, we test that:

+ invalid values (eg `foo`) print a warning and then act as if
the annotation was not present.
+ last annotation (highest line number) wins.
+ the annotation has no effect on non-test files/targets.
+ the `include_dep` can still inject `:conftest` even when `include_pytest_conftest`
is false.
+ `import conftest` will still add the dep even when `include_pytest_conftest` is
false.

An annotation without a value is not tested, as that's part of the core
annotation framework and not specific to this annotation.
Empty file addedgazelle/python/testdata/annotation_include_pytest_conftest/WORKSPACE
View file
Open in desktop
Empty file.
5 changes: 5 additions & 0 deletions gazelle/python/testdata/annotation_include_pytest_conftest/test.yaml
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
expect:
stderr: |
gazelle: WARNING: unable to cast "foo" to bool in "# gazelle:include_pytest_conftest foo". Ignoring annotation
exit_code: 0
Empty file addedgazelle/python/testdata/annotation_include_pytest_conftest/with_conftest/BUILD.in
View file
Open in desktop
Empty file.
68 changes: 68 additions & 0 deletions gazelle/python/testdata/annotation_include_pytest_conftest/with_conftest/BUILD.out
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,68 @@
load("@rules_python//python:defs.bzl", "py_binary", "py_library", "py_test")

py_binary(
name = "binary",
srcs = ["binary.py"],
visibility = ["//:__subpackages__"],
)

py_library(
name = "with_conftest",
srcs = [
"binary.py",
"library.py",
],
visibility = ["//:__subpackages__"],
)

py_library(
name = "conftest",
testonly = True,
srcs = ["conftest.py"],
visibility = ["//:__subpackages__"],
)

py_test(
name = "bad_value_test",
srcs = ["bad_value_test.py"],
deps = [":conftest"],
)

py_test(
name = "conftest_imported_test",
srcs = ["conftest_imported_test.py"],
deps = [":conftest"],
)

py_test(
name = "conftest_included_test",
srcs = ["conftest_included_test.py"],
deps = [":conftest"],
)

py_test(
name = "false_test",
srcs = ["false_test.py"],
)

py_test(
name = "falsey_test",
srcs = ["falsey_test.py"],
)

py_test(
name = "last_value_wins_test",
srcs = ["last_value_wins_test.py"],
)

py_test(
name = "true_test",
srcs = ["true_test.py"],
deps = [":conftest"],
)

py_test(
name = "unset_test",
srcs = ["unset_test.py"],
deps = [":conftest"],
)
1 change: 1 addition & 0 deletions gazelle/python/testdata/annotation_include_pytest_conftest/with_conftest/bad_value_test.py
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
# gazelle:include_pytest_conftest foo
3 changes: 3 additions & 0 deletions gazelle/python/testdata/annotation_include_pytest_conftest/with_conftest/binary.py
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
# gazelle:include_pytest_conftest true
if __name__ == "__main__":
pass
Empty file addedgazelle/python/testdata/annotation_include_pytest_conftest/with_conftest/conftest.py
View file
Open in desktop
Empty file.
3 changes: 3 additions & 0 deletions ...ython/testdata/annotation_include_pytest_conftest/with_conftest/conftest_imported_test.py
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
import conftest

# gazelle:include_pytest_conftest false
2 changes: 2 additions & 0 deletions ...ython/testdata/annotation_include_pytest_conftest/with_conftest/conftest_included_test.py
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
# gazelle:include_dep :conftest
# gazelle:include_pytest_conftest false
1 change: 1 addition & 0 deletions gazelle/python/testdata/annotation_include_pytest_conftest/with_conftest/false_test.py
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
# gazelle:include_pytest_conftest false
1 change: 1 addition & 0 deletions gazelle/python/testdata/annotation_include_pytest_conftest/with_conftest/falsey_test.py
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
# gazelle:include_pytest_conftest 0
6 changes: 6 additions & 0 deletions .../python/testdata/annotation_include_pytest_conftest/with_conftest/last_value_wins_test.py
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
# gazelle:include_pytest_conftest true
# gazelle:include_pytest_conftest TRUE
# gazelle:include_pytest_conftest False
# gazelle:include_pytest_conftest 0
# gazelle:include_pytest_conftest 1
# gazelle:include_pytest_conftest F
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { // Add copy buttons to all 
 blocks
(function() {
function addCopyButtons() {
document.querySelectorAll('pre code').forEach(function(codeBlock) {
if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;
codeBlock.parentElement.setAttribute('data-copy-added', 'true');
var btn = document.createElement('button');
btn.textContent = 'Copy';
btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';
btn.onmouseover = function() { this.style.opacity = '1'; };
btn.onmouseout = function() { this.style.opacity = '0.7'; };
btn.onclick = function() {
navigator.clipboard.writeText(codeBlock.textContent).then(function() {
btn.textContent = 'Copied!';
setTimeout(function() { btn.textContent = 'Copy'; }, 1500);
});
};
codeBlock.parentElement.style.position = 'relative';
codeBlock.parentElement.appendChild(btn);
});
}
addCopyButtons();
// Re-run on dynamic content
var observer = new MutationObserver(addCopyButtons);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
feat(gazelle): Add `include_pytest_conftest` annotation by dougthor42 · Pull Request #3080 · bazel-contrib/rules_python · GitHub
Skip to content
feat(gazelle): Add include_pytest_conftest annotation#3080

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

 Merged

aignas
merged 8 commits into

from

Jul 15, 2025
 Merged


feat(gazelle): Add include_pytest_conftest annotation
#3080
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


8 commits


Select commit
Hold shift + click to select a range
f5d8a7e

Add test cases


dougthor42 Jul 11, 2025
356a605

Add an annotations attribute to the targetBuilder struct


dougthor42 Jul 11, 2025
94a6ade

Update parser to handle gazelle_pytest_conftest annotation.


dougthor42 Jul 11, 2025
b1e98bf

Only add conftest dep when includePytestConftest is nil or true


dougthor42 Jul 11, 2025
e166653

Changelog and documentation


dougthor42 Jul 11, 2025
7969307

Add more tests


dougthor42 Jul 11, 2025
549ab0e

Merge branch 'main' into u/dthor/gazelle-conftest-annotation-gh3076


dougthor42 Jul 14, 2025
6025461

Merge branch 'main' into u/dthor/gazelle-conftest-annotation-gh3076


aignas Jul 15, 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


5 changes: 5 additions & 0 deletions
CHANGELOG.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -106,6 +106,11 @@ END_UNRELEASED_TEMPLATE
 * 3.12.11
 * 3.13.5
 * 3.14.0b3
* (gazelle): New annotation `gazelle:include_pytest_conftest`. When not set (the
 default) or `true`, gazelle will inject any `conftest.py` file found in the same
 directory as a {obj}`py_test` target to that {obj}`py_test` target's `deps`.
 This behavior is unchanged from previous versions. When `false`, the `:conftest`
 dep is not added to the {obj}`py_test` target.
* (gazelle) New directive `gazelle:python_generate_proto`; when `true`,
 Gazelle generates `py_proto_library` rules for `proto_library`. `false` by default.

Expand Down

85 changes: 85 additions & 0 deletions
gazelle/README.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -550,6 +550,8 @@ The annotations are:
| Tells Gazelle to ignore import statements. `imports` is a comma-separated list of imports to ignore. | |
| [`# gazelle:include_dep targets`](#annotation-include_dep) | N/A |
| Tells Gazelle to include a set of dependencies, even if they are not imported in a Python module. `targets` is a comma-separated list of target names to include as dependencies. | |
| [`# gazelle:include_pytest_conftest bool`](#annotation-include_pytest_conftest) | N/A |
| Whether or not to include a sibling `:conftest` target in the deps of a `py_test` target. Default behaviour is to include `:conftest`. | |


#### Annotation: `ignore`
Expand DownExpand Up@@ -622,6 +624,89 @@ deps = [
]
```

#### Annotation: `include_pytest_conftest`

Added in [#3080][gh3080].

[gh3080]: https://github.com/bazel-contrib/rules_python/pull/3080

This annotation accepts any string that can be parsed by go's
[`strconv.ParseBool`][ParseBool]. If an unparsable string is passed, the
annotation is ignored.

[ParseBool]: https://pkg.go.dev/strconv#ParseBool

Starting with [`rules_python` 0.14.0][rules-python-0.14.0] (specifically [PR #879][gh879]),
Gazelle will include a `:conftest` dependency to an `py_test` target that is in
the same directory as `conftest.py`.

[rules-python-0.14.0]: https://github.com/bazel-contrib/rules_python/releases/tag/0.14.0
[gh879]: https://github.com/bazel-contrib/rules_python/pull/879

This annotation allows users to adjust that behavior. To disable the behavior, set
the annotation value to "false":

```
# some_file_test.py
# gazelle:include_pytest_conftest false
```

Example:

Given a directory tree like:

```
.
├── BUILD.bazel
├── conftest.py
└── some_file_test.py
```

The default Gazelle behavior would create:

```starlark
py_library(
 name = "conftest",
 testonly = True,
 srcs = ["conftest.py"],
 visibility = ["//:__subpackages__"],
)

py_test(
 name = "some_file_test",
 srcs = ["some_file_test.py"],
 deps = [":conftest"],
)
```

When `# gazelle:include_pytest_conftest false` is found in `some_file_test.py`

```python
# some_file_test.py
# gazelle:include_pytest_conftest false
```

Gazelle will generate:

```starlark
py_library(
 name = "conftest",
 testonly = True,
 srcs = ["conftest.py"],
 visibility = ["//:__subpackages__"],
)

py_test(
 name = "some_file_test",
 srcs = ["some_file_test.py"],
)
```

See [Issue #3076][gh3076] for more information.

[gh3076]: https://github.com/bazel-contrib/rules_python/issues/3076


#### Directive: `experimental_allow_relative_imports`
Enables experimental support for resolving relative imports in
`python_generation_mode package`.
Expand Down

17 changes: 15 additions & 2 deletions
gazelle/python/generate.go

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -264,7 +264,9 @@ func (py *Python) GenerateRules(args language.GenerateArgs) language.GenerateRes
 addSrc(filename).
 addModuleDependencies(mainModules[filename]).
 addResolvedDependencies(annotations.includeDeps).
 generateImportsAttribute().build()
 generateImportsAttribute().
 setAnnotations(*annotations).
 build()
 result.Gen = append(result.Gen, pyBinary)
 result.Imports = append(result.Imports, pyBinary.PrivateAttr(config.GazelleImportsKey))
 }
Expand DownExpand Up@@ -305,6 +307,7 @@ func (py *Python) GenerateRules(args language.GenerateArgs) language.GenerateRes
 addModuleDependencies(allDeps).
 addResolvedDependencies(annotations.includeDeps).
 generateImportsAttribute().
 setAnnotations(*annotations).
 build()

 if pyLibrary.IsEmpty(py.Kinds()[pyLibrary.Kind()]) {
Expand DownExpand Up@@ -357,6 +360,7 @@ func (py *Python) GenerateRules(args language.GenerateArgs) language.GenerateRes
 addSrc(pyBinaryEntrypointFilename).
 addModuleDependencies(deps).
 addResolvedDependencies(annotations.includeDeps).
 setAnnotations(*annotations).
 generateImportsAttribute()

 pyBinary := pyBinaryTarget.build()
Expand DownExpand Up@@ -387,6 +391,7 @@ func (py *Python) GenerateRules(args language.GenerateArgs) language.GenerateRes
 addSrc(conftestFilename).
 addModuleDependencies(deps).
 addResolvedDependencies(annotations.includeDeps).
 setAnnotations(*annotations).
 addVisibility(visibility).
 setTestonly().
 generateImportsAttribute()
Expand DownExpand Up@@ -418,6 +423,7 @@ func (py *Python) GenerateRules(args language.GenerateArgs) language.GenerateRes
 addSrcs(srcs).
 addModuleDependencies(deps).
 addResolvedDependencies(annotations.includeDeps).
 setAnnotations(*annotations).
 generateImportsAttribute()
	}
	if (!cfg.PerPackageGenerationRequireTestEntryPoint() || hasPyTestEntryPointFile || hasPyTestEntryPointTarget || cfg.CoarseGrainedGeneration()) && !cfg.PerFileGeneration() {
Expand DownExpand Up@@ -470,7 +476,14 @@ func (py *Python) GenerateRules(args language.GenerateArgs) language.GenerateRes

	for _, pyTestTarget := range pyTestTargets {
 if conftest != nil {
 pyTestTarget.addModuleDependency(Module{Name: strings.TrimSuffix(conftestFilename, ".py")})
 conftestModule := Module{Name: strings.TrimSuffix(conftestFilename, ".py")}
 if pyTestTarget.annotations.includePytestConftest == nil {
 // unset; default behavior
 pyTestTarget.addModuleDependency(conftestModule)
 } else if *pyTestTarget.annotations.includePytestConftest {
 // set; add if true, do not add if false
 pyTestTarget.addModuleDependency(conftestModule)
 }
 }
 pyTest := pyTestTarget.build()

Expand Down

30 changes: 26 additions & 4 deletions
gazelle/python/parser.go

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -18,6 +18,8 @@ import (
	"context"
	_ "embed"
	"fmt"
	"log"
	"strconv"
	"strings"

	"github.com/emirpasic/gods/sets/treeset"
Expand DownExpand Up@@ -123,6 +125,7 @@ func (p *python3Parser) parse(pyFilenames *treeset.Set) (*treeset.Set, map[strin
 allAnnotations.ignore[k] = v
 }
 allAnnotations.includeDeps = append(allAnnotations.includeDeps, annotations.includeDeps...)
 allAnnotations.includePytestConftest = annotations.includePytestConftest
	}

	allAnnotations.includeDeps = removeDupesFromStringTreeSetSlice(allAnnotations.includeDeps)
Expand DownExpand Up@@ -183,8 +186,12 @@ const (
	// The Gazelle annotation prefix.
	annotationPrefix string = "gazelle:"
	// The ignore annotation kind. E.g. '# gazelle:ignore <module_name>'.
	annotationKindIgnore annotationKind = "ignore"
	annotationKindIncludeDep annotationKind = "include_dep"
	annotationKindIgnore annotationKind = "ignore"
	// Force a particular target to be added to `deps`. Multiple invocations are
	// accumulated and the value can be comma separated.
	// Eg: '# gazelle:include_dep //foo/bar:baz,@repo//:target
	annotationKindIncludeDep annotationKind = "include_dep"
	annotationKindIncludePytestConftest annotationKind = "include_pytest_conftest"
)

// Comment represents a Python comment.
Expand DownExpand Up@@ -222,13 +229,18 @@ type annotations struct {
	ignore map[string]struct{}
	// Labels that Gazelle should include as deps of the generated target.
	includeDeps []string
	// Whether the conftest.py file, found in the same directory as the current
	// python test file, should be added to the py_test target's `deps` attribute.
	// A *bool is used so that we can handle the "not set" state.
	includePytestConftest *bool
}

// annotationsFromComments returns all the annotations parsed out of the
// comments of a Python module.
func annotationsFromComments(comments []Comment) (*annotations, error) {
	ignore := make(map[string]struct{})
	includeDeps := []string{}
	var includePytestConftest *bool
	for _, comment := range comments {
 annotation, err := comment.asAnnotation()
 if err != nil {
Expand All@@ -255,11 +267,21 @@ func annotationsFromComments(comments []Comment) (*annotations, error) {
 includeDeps = append(includeDeps, t)
 }
 }
 if annotation.kind == annotationKindIncludePytestConftest {
 val := annotation.value
 parsedVal, err := strconv.ParseBool(val)
 if err != nil {
 log.Printf("WARNING: unable to cast %q to bool in %q. Ignoring annotation", val, comment)
 continue
 }
 includePytestConftest = &parsedVal
 }
 }
	}
	return &annotations{
 ignore: ignore,
 includeDeps: includeDeps,
 ignore: ignore,
 includeDeps: includeDeps,
 includePytestConftest: includePytestConftest,
	}, nil
}

Expand Down

9 changes: 9 additions & 0 deletions
gazelle/python/target.go

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -37,6 +37,7 @@ type targetBuilder struct {
	main *string
	imports []string
	testonly bool
	annotations *annotations
}

// newTargetBuilder constructs a new targetBuilder.
Expand All@@ -51,6 +52,7 @@ func newTargetBuilder(kind, name, pythonProjectRoot, bzlPackage string, siblingS
 deps: treeset.NewWith(moduleComparator),
 resolvedDeps: treeset.NewWith(godsutils.StringComparator),
 visibility: treeset.NewWith(godsutils.StringComparator),
 annotations: new(annotations),
	}
}

Expand DownExpand Up@@ -130,6 +132,13 @@ func (t *targetBuilder) setTestonly() *targetBuilder {
	return t
}

// setAnnotations sets the annotations attribute on the target.
func (t *targetBuilder) setAnnotations(val annotations) *targetBuilder {
	t.annotations = &val
	return t
}


// generateImportsAttribute generates the imports attribute.
// These are a list of import directories to be added to the PYTHONPATH. In our
// case, the value we add is on Bazel sub-packages to be able to perform imports
Expand Down

25 changes: 25 additions & 0 deletions
gazelle/python/testdata/annotation_include_pytest_conftest/README.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
# Annotation: Include Pytest Conftest

Validate that the `# gazelle:include_pytest_conftest` annotation follows
this logic:

+ When a `conftest.py` file does not exist:
 + all values have no affect
+ When a `conftest.py` file does exist:
 + Truthy values add `:conftest` to `deps`.
 + Falsey values do not add `:conftest` to `deps`.
 + Unset (no annotation) performs the default action.

Additionally, we test that:

+ invalid values (eg `foo`) print a warning and then act as if
 the annotation was not present.
+ last annotation (highest line number) wins.
+ the annotation has no effect on non-test files/targets.
+ the `include_dep` can still inject `:conftest` even when `include_pytest_conftest`
 is false.
+ `import conftest` will still add the dep even when `include_pytest_conftest` is
 false.

An annotation without a value is not tested, as that's part of the core
annotation framework and not specific to this annotation.
Empty file addedgazelle/python/testdata/annotation_include_pytest_conftest/WORKSPACE

View file


Open in desktop


Empty file.


5 changes: 5 additions & 0 deletions
gazelle/python/testdata/annotation_include_pytest_conftest/test.yaml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
expect:
 stderr: |
 gazelle: WARNING: unable to cast "foo" to bool in "# gazelle:include_pytest_conftest foo". Ignoring annotation
 exit_code: 0
Empty file addedgazelle/python/testdata/annotation_include_pytest_conftest/with_conftest/BUILD.in

View file


Open in desktop


Empty file.


68 changes: 68 additions & 0 deletions
gazelle/python/testdata/annotation_include_pytest_conftest/with_conftest/BUILD.out

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,68 @@
load("@rules_python//python:defs.bzl", "py_binary", "py_library", "py_test")

py_binary(
 name = "binary",
 srcs = ["binary.py"],
 visibility = ["//:__subpackages__"],
)

py_library(
 name = "with_conftest",
 srcs = [
 "binary.py",
 "library.py",
 ],
 visibility = ["//:__subpackages__"],
)

py_library(
 name = "conftest",
 testonly = True,
 srcs = ["conftest.py"],
 visibility = ["//:__subpackages__"],
)

py_test(
 name = "bad_value_test",
 srcs = ["bad_value_test.py"],
 deps = [":conftest"],
)

py_test(
 name = "conftest_imported_test",
 srcs = ["conftest_imported_test.py"],
 deps = [":conftest"],
)

py_test(
 name = "conftest_included_test",
 srcs = ["conftest_included_test.py"],
 deps = [":conftest"],
)

py_test(
 name = "false_test",
 srcs = ["false_test.py"],
)

py_test(
 name = "falsey_test",
 srcs = ["falsey_test.py"],
)

py_test(
 name = "last_value_wins_test",
 srcs = ["last_value_wins_test.py"],
)

py_test(
 name = "true_test",
 srcs = ["true_test.py"],
 deps = [":conftest"],
)

py_test(
 name = "unset_test",
 srcs = ["unset_test.py"],
 deps = [":conftest"],
)

1 change: 1 addition & 0 deletions
gazelle/python/testdata/annotation_include_pytest_conftest/with_conftest/bad_value_test.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
# gazelle:include_pytest_conftest foo

3 changes: 3 additions & 0 deletions
gazelle/python/testdata/annotation_include_pytest_conftest/with_conftest/binary.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
# gazelle:include_pytest_conftest true
if __name__ == "__main__":
 pass
Empty file addedgazelle/python/testdata/annotation_include_pytest_conftest/with_conftest/conftest.py

View file


Open in desktop


Empty file.


3 changes: 3 additions & 0 deletions
...ython/testdata/annotation_include_pytest_conftest/with_conftest/conftest_imported_test.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
import conftest

# gazelle:include_pytest_conftest false

2 changes: 2 additions & 0 deletions
...ython/testdata/annotation_include_pytest_conftest/with_conftest/conftest_included_test.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
# gazelle:include_dep :conftest
# gazelle:include_pytest_conftest false

1 change: 1 addition & 0 deletions
gazelle/python/testdata/annotation_include_pytest_conftest/with_conftest/false_test.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
# gazelle:include_pytest_conftest false

1 change: 1 addition & 0 deletions
gazelle/python/testdata/annotation_include_pytest_conftest/with_conftest/falsey_test.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
# gazelle:include_pytest_conftest 0

6 changes: 6 additions & 0 deletions
.../python/testdata/annotation_include_pytest_conftest/with_conftest/last_value_wins_test.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
# gazelle:include_pytest_conftest true
# gazelle:include_pytest_conftest TRUE
# gazelle:include_pytest_conftest False
# gazelle:include_pytest_conftest 0
# gazelle:include_pytest_conftest 1
# gazelle:include_pytest_conftest F
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Force GitHub README to respect dark mode
(function() {
var style = document.createElement('style');
style.textContent = '
.markdown-body {
color-scheme: dark light;
}
.markdown-body pre { background: #161b22 !important; }
.markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }
.markdown-body table th, .markdown-body table td { border-color: #30363d !important; }
.markdown-body img { background: #0d1117; }
.markdown-body blockquote { border-left-color: #8b949e; }
.markdown-body hr { border-color: #30363d; }
';
document.head.appendChild(style);
})();
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
feat(gazelle): Add `include_pytest_conftest` annotation by dougthor42 · Pull Request #3080 · bazel-contrib/rules_python · GitHub
Skip to content
feat(gazelle): Add include_pytest_conftest annotation#3080

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

 Merged

aignas
merged 8 commits into

from

Jul 15, 2025
 Merged


feat(gazelle): Add include_pytest_conftest annotation
#3080
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


8 commits


Select commit
Hold shift + click to select a range
f5d8a7e

Add test cases


dougthor42 Jul 11, 2025
356a605

Add an annotations attribute to the targetBuilder struct


dougthor42 Jul 11, 2025
94a6ade

Update parser to handle gazelle_pytest_conftest annotation.


dougthor42 Jul 11, 2025
b1e98bf

Only add conftest dep when includePytestConftest is nil or true


dougthor42 Jul 11, 2025
e166653

Changelog and documentation


dougthor42 Jul 11, 2025
7969307

Add more tests


dougthor42 Jul 11, 2025
549ab0e

Merge branch 'main' into u/dthor/gazelle-conftest-annotation-gh3076


dougthor42 Jul 14, 2025
6025461

Merge branch 'main' into u/dthor/gazelle-conftest-annotation-gh3076


aignas Jul 15, 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


5 changes: 5 additions & 0 deletions
CHANGELOG.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -106,6 +106,11 @@ END_UNRELEASED_TEMPLATE
 * 3.12.11
 * 3.13.5
 * 3.14.0b3
* (gazelle): New annotation `gazelle:include_pytest_conftest`. When not set (the
 default) or `true`, gazelle will inject any `conftest.py` file found in the same
 directory as a {obj}`py_test` target to that {obj}`py_test` target's `deps`.
 This behavior is unchanged from previous versions. When `false`, the `:conftest`
 dep is not added to the {obj}`py_test` target.
* (gazelle) New directive `gazelle:python_generate_proto`; when `true`,
 Gazelle generates `py_proto_library` rules for `proto_library`. `false` by default.

Expand Down

85 changes: 85 additions & 0 deletions
gazelle/README.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -550,6 +550,8 @@ The annotations are:
| Tells Gazelle to ignore import statements. `imports` is a comma-separated list of imports to ignore. | |
| [`# gazelle:include_dep targets`](#annotation-include_dep) | N/A |
| Tells Gazelle to include a set of dependencies, even if they are not imported in a Python module. `targets` is a comma-separated list of target names to include as dependencies. | |
| [`# gazelle:include_pytest_conftest bool`](#annotation-include_pytest_conftest) | N/A |
| Whether or not to include a sibling `:conftest` target in the deps of a `py_test` target. Default behaviour is to include `:conftest`. | |


#### Annotation: `ignore`
Expand DownExpand Up@@ -622,6 +624,89 @@ deps = [
]
```

#### Annotation: `include_pytest_conftest`

Added in [#3080][gh3080].

[gh3080]: https://github.com/bazel-contrib/rules_python/pull/3080

This annotation accepts any string that can be parsed by go's
[`strconv.ParseBool`][ParseBool]. If an unparsable string is passed, the
annotation is ignored.

[ParseBool]: https://pkg.go.dev/strconv#ParseBool

Starting with [`rules_python` 0.14.0][rules-python-0.14.0] (specifically [PR #879][gh879]),
Gazelle will include a `:conftest` dependency to an `py_test` target that is in
the same directory as `conftest.py`.

[rules-python-0.14.0]: https://github.com/bazel-contrib/rules_python/releases/tag/0.14.0
[gh879]: https://github.com/bazel-contrib/rules_python/pull/879

This annotation allows users to adjust that behavior. To disable the behavior, set
the annotation value to "false":

```
# some_file_test.py
# gazelle:include_pytest_conftest false
```

Example:

Given a directory tree like:

```
.
├── BUILD.bazel
├── conftest.py
└── some_file_test.py
```

The default Gazelle behavior would create:

```starlark
py_library(
 name = "conftest",
 testonly = True,
 srcs = ["conftest.py"],
 visibility = ["//:__subpackages__"],
)

py_test(
 name = "some_file_test",
 srcs = ["some_file_test.py"],
 deps = [":conftest"],
)
```

When `# gazelle:include_pytest_conftest false` is found in `some_file_test.py`

```python
# some_file_test.py
# gazelle:include_pytest_conftest false
```

Gazelle will generate:

```starlark
py_library(
 name = "conftest",
 testonly = True,
 srcs = ["conftest.py"],
 visibility = ["//:__subpackages__"],
)

py_test(
 name = "some_file_test",
 srcs = ["some_file_test.py"],
)
```

See [Issue #3076][gh3076] for more information.

[gh3076]: https://github.com/bazel-contrib/rules_python/issues/3076


#### Directive: `experimental_allow_relative_imports`
Enables experimental support for resolving relative imports in
`python_generation_mode package`.
Expand Down

17 changes: 15 additions & 2 deletions
gazelle/python/generate.go

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -264,7 +264,9 @@ func (py *Python) GenerateRules(args language.GenerateArgs) language.GenerateRes
 addSrc(filename).
 addModuleDependencies(mainModules[filename]).
 addResolvedDependencies(annotations.includeDeps).
 generateImportsAttribute().build()
 generateImportsAttribute().
 setAnnotations(*annotations).
 build()
 result.Gen = append(result.Gen, pyBinary)
 result.Imports = append(result.Imports, pyBinary.PrivateAttr(config.GazelleImportsKey))
 }
Expand DownExpand Up@@ -305,6 +307,7 @@ func (py *Python) GenerateRules(args language.GenerateArgs) language.GenerateRes
 addModuleDependencies(allDeps).
 addResolvedDependencies(annotations.includeDeps).
 generateImportsAttribute().
 setAnnotations(*annotations).
 build()

 if pyLibrary.IsEmpty(py.Kinds()[pyLibrary.Kind()]) {
Expand DownExpand Up@@ -357,6 +360,7 @@ func (py *Python) GenerateRules(args language.GenerateArgs) language.GenerateRes
 addSrc(pyBinaryEntrypointFilename).
 addModuleDependencies(deps).
 addResolvedDependencies(annotations.includeDeps).
 setAnnotations(*annotations).
 generateImportsAttribute()

 pyBinary := pyBinaryTarget.build()
Expand DownExpand Up@@ -387,6 +391,7 @@ func (py *Python) GenerateRules(args language.GenerateArgs) language.GenerateRes
 addSrc(conftestFilename).
 addModuleDependencies(deps).
 addResolvedDependencies(annotations.includeDeps).
 setAnnotations(*annotations).
 addVisibility(visibility).
 setTestonly().
 generateImportsAttribute()
Expand DownExpand Up@@ -418,6 +423,7 @@ func (py *Python) GenerateRules(args language.GenerateArgs) language.GenerateRes
 addSrcs(srcs).
 addModuleDependencies(deps).
 addResolvedDependencies(annotations.includeDeps).
 setAnnotations(*annotations).
 generateImportsAttribute()
	}
	if (!cfg.PerPackageGenerationRequireTestEntryPoint() || hasPyTestEntryPointFile || hasPyTestEntryPointTarget || cfg.CoarseGrainedGeneration()) && !cfg.PerFileGeneration() {
Expand DownExpand Up@@ -470,7 +476,14 @@ func (py *Python) GenerateRules(args language.GenerateArgs) language.GenerateRes

	for _, pyTestTarget := range pyTestTargets {
 if conftest != nil {
 pyTestTarget.addModuleDependency(Module{Name: strings.TrimSuffix(conftestFilename, ".py")})
 conftestModule := Module{Name: strings.TrimSuffix(conftestFilename, ".py")}
 if pyTestTarget.annotations.includePytestConftest == nil {
 // unset; default behavior
 pyTestTarget.addModuleDependency(conftestModule)
 } else if *pyTestTarget.annotations.includePytestConftest {
 // set; add if true, do not add if false
 pyTestTarget.addModuleDependency(conftestModule)
 }
 }
 pyTest := pyTestTarget.build()

Expand Down

30 changes: 26 additions & 4 deletions
gazelle/python/parser.go

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -18,6 +18,8 @@ import (
	"context"
	_ "embed"
	"fmt"
	"log"
	"strconv"
	"strings"

	"github.com/emirpasic/gods/sets/treeset"
Expand DownExpand Up@@ -123,6 +125,7 @@ func (p *python3Parser) parse(pyFilenames *treeset.Set) (*treeset.Set, map[strin
 allAnnotations.ignore[k] = v
 }
 allAnnotations.includeDeps = append(allAnnotations.includeDeps, annotations.includeDeps...)
 allAnnotations.includePytestConftest = annotations.includePytestConftest
	}

	allAnnotations.includeDeps = removeDupesFromStringTreeSetSlice(allAnnotations.includeDeps)
Expand DownExpand Up@@ -183,8 +186,12 @@ const (
	// The Gazelle annotation prefix.
	annotationPrefix string = "gazelle:"
	// The ignore annotation kind. E.g. '# gazelle:ignore <module_name>'.
	annotationKindIgnore annotationKind = "ignore"
	annotationKindIncludeDep annotationKind = "include_dep"
	annotationKindIgnore annotationKind = "ignore"
	// Force a particular target to be added to `deps`. Multiple invocations are
	// accumulated and the value can be comma separated.
	// Eg: '# gazelle:include_dep //foo/bar:baz,@repo//:target
	annotationKindIncludeDep annotationKind = "include_dep"
	annotationKindIncludePytestConftest annotationKind = "include_pytest_conftest"
)

// Comment represents a Python comment.
Expand DownExpand Up@@ -222,13 +229,18 @@ type annotations struct {
	ignore map[string]struct{}
	// Labels that Gazelle should include as deps of the generated target.
	includeDeps []string
	// Whether the conftest.py file, found in the same directory as the current
	// python test file, should be added to the py_test target's `deps` attribute.
	// A *bool is used so that we can handle the "not set" state.
	includePytestConftest *bool
}

// annotationsFromComments returns all the annotations parsed out of the
// comments of a Python module.
func annotationsFromComments(comments []Comment) (*annotations, error) {
	ignore := make(map[string]struct{})
	includeDeps := []string{}
	var includePytestConftest *bool
	for _, comment := range comments {
 annotation, err := comment.asAnnotation()
 if err != nil {
Expand All@@ -255,11 +267,21 @@ func annotationsFromComments(comments []Comment) (*annotations, error) {
 includeDeps = append(includeDeps, t)
 }
 }
 if annotation.kind == annotationKindIncludePytestConftest {
 val := annotation.value
 parsedVal, err := strconv.ParseBool(val)
 if err != nil {
 log.Printf("WARNING: unable to cast %q to bool in %q. Ignoring annotation", val, comment)
 continue
 }
 includePytestConftest = &parsedVal
 }
 }
	}
	return &annotations{
 ignore: ignore,
 includeDeps: includeDeps,
 ignore: ignore,
 includeDeps: includeDeps,
 includePytestConftest: includePytestConftest,
	}, nil
}

Expand Down

9 changes: 9 additions & 0 deletions
gazelle/python/target.go

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -37,6 +37,7 @@ type targetBuilder struct {
	main *string
	imports []string
	testonly bool
	annotations *annotations
}

// newTargetBuilder constructs a new targetBuilder.
Expand All@@ -51,6 +52,7 @@ func newTargetBuilder(kind, name, pythonProjectRoot, bzlPackage string, siblingS
 deps: treeset.NewWith(moduleComparator),
 resolvedDeps: treeset.NewWith(godsutils.StringComparator),
 visibility: treeset.NewWith(godsutils.StringComparator),
 annotations: new(annotations),
	}
}

Expand DownExpand Up@@ -130,6 +132,13 @@ func (t *targetBuilder) setTestonly() *targetBuilder {
	return t
}

// setAnnotations sets the annotations attribute on the target.
func (t *targetBuilder) setAnnotations(val annotations) *targetBuilder {
	t.annotations = &val
	return t
}


// generateImportsAttribute generates the imports attribute.
// These are a list of import directories to be added to the PYTHONPATH. In our
// case, the value we add is on Bazel sub-packages to be able to perform imports
Expand Down

25 changes: 25 additions & 0 deletions
gazelle/python/testdata/annotation_include_pytest_conftest/README.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
# Annotation: Include Pytest Conftest

Validate that the `# gazelle:include_pytest_conftest` annotation follows
this logic:

+ When a `conftest.py` file does not exist:
 + all values have no affect
+ When a `conftest.py` file does exist:
 + Truthy values add `:conftest` to `deps`.
 + Falsey values do not add `:conftest` to `deps`.
 + Unset (no annotation) performs the default action.

Additionally, we test that:

+ invalid values (eg `foo`) print a warning and then act as if
 the annotation was not present.
+ last annotation (highest line number) wins.
+ the annotation has no effect on non-test files/targets.
+ the `include_dep` can still inject `:conftest` even when `include_pytest_conftest`
 is false.
+ `import conftest` will still add the dep even when `include_pytest_conftest` is
 false.

An annotation without a value is not tested, as that's part of the core
annotation framework and not specific to this annotation.
Empty file addedgazelle/python/testdata/annotation_include_pytest_conftest/WORKSPACE

View file


Open in desktop


Empty file.


5 changes: 5 additions & 0 deletions
gazelle/python/testdata/annotation_include_pytest_conftest/test.yaml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
expect:
 stderr: |
 gazelle: WARNING: unable to cast "foo" to bool in "# gazelle:include_pytest_conftest foo". Ignoring annotation
 exit_code: 0
Empty file addedgazelle/python/testdata/annotation_include_pytest_conftest/with_conftest/BUILD.in

View file


Open in desktop


Empty file.


68 changes: 68 additions & 0 deletions
gazelle/python/testdata/annotation_include_pytest_conftest/with_conftest/BUILD.out

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,68 @@
load("@rules_python//python:defs.bzl", "py_binary", "py_library", "py_test")

py_binary(
 name = "binary",
 srcs = ["binary.py"],
 visibility = ["//:__subpackages__"],
)

py_library(
 name = "with_conftest",
 srcs = [
 "binary.py",
 "library.py",
 ],
 visibility = ["//:__subpackages__"],
)

py_library(
 name = "conftest",
 testonly = True,
 srcs = ["conftest.py"],
 visibility = ["//:__subpackages__"],
)

py_test(
 name = "bad_value_test",
 srcs = ["bad_value_test.py"],
 deps = [":conftest"],
)

py_test(
 name = "conftest_imported_test",
 srcs = ["conftest_imported_test.py"],
 deps = [":conftest"],
)

py_test(
 name = "conftest_included_test",
 srcs = ["conftest_included_test.py"],
 deps = [":conftest"],
)

py_test(
 name = "false_test",
 srcs = ["false_test.py"],
)

py_test(
 name = "falsey_test",
 srcs = ["falsey_test.py"],
)

py_test(
 name = "last_value_wins_test",
 srcs = ["last_value_wins_test.py"],
)

py_test(
 name = "true_test",
 srcs = ["true_test.py"],
 deps = [":conftest"],
)

py_test(
 name = "unset_test",
 srcs = ["unset_test.py"],
 deps = [":conftest"],
)

1 change: 1 addition & 0 deletions
gazelle/python/testdata/annotation_include_pytest_conftest/with_conftest/bad_value_test.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
# gazelle:include_pytest_conftest foo

3 changes: 3 additions & 0 deletions
gazelle/python/testdata/annotation_include_pytest_conftest/with_conftest/binary.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
# gazelle:include_pytest_conftest true
if __name__ == "__main__":
 pass
Empty file addedgazelle/python/testdata/annotation_include_pytest_conftest/with_conftest/conftest.py

View file


Open in desktop


Empty file.


3 changes: 3 additions & 0 deletions
...ython/testdata/annotation_include_pytest_conftest/with_conftest/conftest_imported_test.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
import conftest

# gazelle:include_pytest_conftest false

2 changes: 2 additions & 0 deletions
...ython/testdata/annotation_include_pytest_conftest/with_conftest/conftest_included_test.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
# gazelle:include_dep :conftest
# gazelle:include_pytest_conftest false

1 change: 1 addition & 0 deletions
gazelle/python/testdata/annotation_include_pytest_conftest/with_conftest/false_test.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
# gazelle:include_pytest_conftest false

1 change: 1 addition & 0 deletions
gazelle/python/testdata/annotation_include_pytest_conftest/with_conftest/falsey_test.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
# gazelle:include_pytest_conftest 0

6 changes: 6 additions & 0 deletions
.../python/testdata/annotation_include_pytest_conftest/with_conftest/last_value_wins_test.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
# gazelle:include_pytest_conftest true
# gazelle:include_pytest_conftest TRUE
# gazelle:include_pytest_conftest False
# gazelle:include_pytest_conftest 0
# gazelle:include_pytest_conftest 1
# gazelle:include_pytest_conftest F
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Highlight search terms from Google/DuckDuckGo/Bing referrer
(function() {
var ref = document.referrer;
var terms = [];
if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {
var url = new URL(ref);
var q = url.searchParams.get('q') || url.searchParams.get('p');
if (q) {
terms = q.split(/\s+/).filter(function(t) { return t.length > 2; });
}
}
if (terms.length === 0) return;
var style = document.createElement('style');
style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';
document.head.appendChild(style);
function highlight(node) {
if (node.nodeType === 3) { // text node
var text = node.textContent;
var found = false;
terms.forEach(function(term) {
var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\]\\]/g, '\\') + ')', 'gi');
if (regex.test(text)) {
found = true;
var frag = document.createDocumentFragment();
var parts = text.split(regex);
parts.forEach(function(part, i) {
if (i % 2 === 0) {
frag.appendChild(document.createTextNode(part));
} else {
var span = document.createElement('span');
span.className = 'userscript-highlight';
span.textContent = part;
frag.appendChild(span);
}
});
node.parentNode.replaceChild(frag, node);
}
});
} else if (node.nodeType === 1 && node.childNodes) { // element
var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];
if (!skipTags.includes(node.tagName)) {
Array.from(node.childNodes).forEach(highlight);
}
}
}
highlight(document.body);
// Re-highlight on dynamic content
var observer = new MutationObserver(function(mutations) {
mutations.forEach(function(m) {
m.addedNodes.forEach(function(node) {
if (node.nodeType === 1 || node.nodeType === 3) highlight(node);
});
});
});
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
feat(gazelle): Add `include_pytest_conftest` annotation by dougthor42 · Pull Request #3080 · bazel-contrib/rules_python · GitHub
Skip to content
feat(gazelle): Add include_pytest_conftest annotation#3080

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

 Merged

aignas
merged 8 commits into

from

Jul 15, 2025
 Merged


feat(gazelle): Add include_pytest_conftest annotation
#3080
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


8 commits


Select commit
Hold shift + click to select a range
f5d8a7e

Add test cases


dougthor42 Jul 11, 2025
356a605

Add an annotations attribute to the targetBuilder struct


dougthor42 Jul 11, 2025
94a6ade

Update parser to handle gazelle_pytest_conftest annotation.


dougthor42 Jul 11, 2025
b1e98bf

Only add conftest dep when includePytestConftest is nil or true


dougthor42 Jul 11, 2025
e166653

Changelog and documentation


dougthor42 Jul 11, 2025
7969307

Add more tests


dougthor42 Jul 11, 2025
549ab0e

Merge branch 'main' into u/dthor/gazelle-conftest-annotation-gh3076


dougthor42 Jul 14, 2025
6025461

Merge branch 'main' into u/dthor/gazelle-conftest-annotation-gh3076


aignas Jul 15, 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


5 changes: 5 additions & 0 deletions
CHANGELOG.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -106,6 +106,11 @@ END_UNRELEASED_TEMPLATE
 * 3.12.11
 * 3.13.5
 * 3.14.0b3
* (gazelle): New annotation `gazelle:include_pytest_conftest`. When not set (the
 default) or `true`, gazelle will inject any `conftest.py` file found in the same
 directory as a {obj}`py_test` target to that {obj}`py_test` target's `deps`.
 This behavior is unchanged from previous versions. When `false`, the `:conftest`
 dep is not added to the {obj}`py_test` target.
* (gazelle) New directive `gazelle:python_generate_proto`; when `true`,
 Gazelle generates `py_proto_library` rules for `proto_library`. `false` by default.

Expand Down

85 changes: 85 additions & 0 deletions
gazelle/README.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -550,6 +550,8 @@ The annotations are:
| Tells Gazelle to ignore import statements. `imports` is a comma-separated list of imports to ignore. | |
| [`# gazelle:include_dep targets`](#annotation-include_dep) | N/A |
| Tells Gazelle to include a set of dependencies, even if they are not imported in a Python module. `targets` is a comma-separated list of target names to include as dependencies. | |
| [`# gazelle:include_pytest_conftest bool`](#annotation-include_pytest_conftest) | N/A |
| Whether or not to include a sibling `:conftest` target in the deps of a `py_test` target. Default behaviour is to include `:conftest`. | |


#### Annotation: `ignore`
Expand DownExpand Up@@ -622,6 +624,89 @@ deps = [
]
```

#### Annotation: `include_pytest_conftest`

Added in [#3080][gh3080].

[gh3080]: https://github.com/bazel-contrib/rules_python/pull/3080

This annotation accepts any string that can be parsed by go's
[`strconv.ParseBool`][ParseBool]. If an unparsable string is passed, the
annotation is ignored.

[ParseBool]: https://pkg.go.dev/strconv#ParseBool

Starting with [`rules_python` 0.14.0][rules-python-0.14.0] (specifically [PR #879][gh879]),
Gazelle will include a `:conftest` dependency to an `py_test` target that is in
the same directory as `conftest.py`.

[rules-python-0.14.0]: https://github.com/bazel-contrib/rules_python/releases/tag/0.14.0
[gh879]: https://github.com/bazel-contrib/rules_python/pull/879

This annotation allows users to adjust that behavior. To disable the behavior, set
the annotation value to "false":

```
# some_file_test.py
# gazelle:include_pytest_conftest false
```

Example:

Given a directory tree like:

```
.
├── BUILD.bazel
├── conftest.py
└── some_file_test.py
```

The default Gazelle behavior would create:

```starlark
py_library(
 name = "conftest",
 testonly = True,
 srcs = ["conftest.py"],
 visibility = ["//:__subpackages__"],
)

py_test(
 name = "some_file_test",
 srcs = ["some_file_test.py"],
 deps = [":conftest"],
)
```

When `# gazelle:include_pytest_conftest false` is found in `some_file_test.py`

```python
# some_file_test.py
# gazelle:include_pytest_conftest false
```

Gazelle will generate:

```starlark
py_library(
 name = "conftest",
 testonly = True,
 srcs = ["conftest.py"],
 visibility = ["//:__subpackages__"],
)

py_test(
 name = "some_file_test",
 srcs = ["some_file_test.py"],
)
```

See [Issue #3076][gh3076] for more information.

[gh3076]: https://github.com/bazel-contrib/rules_python/issues/3076


#### Directive: `experimental_allow_relative_imports`
Enables experimental support for resolving relative imports in
`python_generation_mode package`.
Expand Down

17 changes: 15 additions & 2 deletions
gazelle/python/generate.go

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -264,7 +264,9 @@ func (py *Python) GenerateRules(args language.GenerateArgs) language.GenerateRes
 addSrc(filename).
 addModuleDependencies(mainModules[filename]).
 addResolvedDependencies(annotations.includeDeps).
 generateImportsAttribute().build()
 generateImportsAttribute().
 setAnnotations(*annotations).
 build()
 result.Gen = append(result.Gen, pyBinary)
 result.Imports = append(result.Imports, pyBinary.PrivateAttr(config.GazelleImportsKey))
 }
Expand DownExpand Up@@ -305,6 +307,7 @@ func (py *Python) GenerateRules(args language.GenerateArgs) language.GenerateRes
 addModuleDependencies(allDeps).
 addResolvedDependencies(annotations.includeDeps).
 generateImportsAttribute().
 setAnnotations(*annotations).
 build()

 if pyLibrary.IsEmpty(py.Kinds()[pyLibrary.Kind()]) {
Expand DownExpand Up@@ -357,6 +360,7 @@ func (py *Python) GenerateRules(args language.GenerateArgs) language.GenerateRes
 addSrc(pyBinaryEntrypointFilename).
 addModuleDependencies(deps).
 addResolvedDependencies(annotations.includeDeps).
 setAnnotations(*annotations).
 generateImportsAttribute()

 pyBinary := pyBinaryTarget.build()
Expand DownExpand Up@@ -387,6 +391,7 @@ func (py *Python) GenerateRules(args language.GenerateArgs) language.GenerateRes
 addSrc(conftestFilename).
 addModuleDependencies(deps).
 addResolvedDependencies(annotations.includeDeps).
 setAnnotations(*annotations).
 addVisibility(visibility).
 setTestonly().
 generateImportsAttribute()
Expand DownExpand Up@@ -418,6 +423,7 @@ func (py *Python) GenerateRules(args language.GenerateArgs) language.GenerateRes
 addSrcs(srcs).
 addModuleDependencies(deps).
 addResolvedDependencies(annotations.includeDeps).
 setAnnotations(*annotations).
 generateImportsAttribute()
	}
	if (!cfg.PerPackageGenerationRequireTestEntryPoint() || hasPyTestEntryPointFile || hasPyTestEntryPointTarget || cfg.CoarseGrainedGeneration()) && !cfg.PerFileGeneration() {
Expand DownExpand Up@@ -470,7 +476,14 @@ func (py *Python) GenerateRules(args language.GenerateArgs) language.GenerateRes

	for _, pyTestTarget := range pyTestTargets {
 if conftest != nil {
 pyTestTarget.addModuleDependency(Module{Name: strings.TrimSuffix(conftestFilename, ".py")})
 conftestModule := Module{Name: strings.TrimSuffix(conftestFilename, ".py")}
 if pyTestTarget.annotations.includePytestConftest == nil {
 // unset; default behavior
 pyTestTarget.addModuleDependency(conftestModule)
 } else if *pyTestTarget.annotations.includePytestConftest {
 // set; add if true, do not add if false
 pyTestTarget.addModuleDependency(conftestModule)
 }
 }
 pyTest := pyTestTarget.build()

Expand Down

30 changes: 26 additions & 4 deletions
gazelle/python/parser.go

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -18,6 +18,8 @@ import (
	"context"
	_ "embed"
	"fmt"
	"log"
	"strconv"
	"strings"

	"github.com/emirpasic/gods/sets/treeset"
Expand DownExpand Up@@ -123,6 +125,7 @@ func (p *python3Parser) parse(pyFilenames *treeset.Set) (*treeset.Set, map[strin
 allAnnotations.ignore[k] = v
 }
 allAnnotations.includeDeps = append(allAnnotations.includeDeps, annotations.includeDeps...)
 allAnnotations.includePytestConftest = annotations.includePytestConftest
	}

	allAnnotations.includeDeps = removeDupesFromStringTreeSetSlice(allAnnotations.includeDeps)
Expand DownExpand Up@@ -183,8 +186,12 @@ const (
	// The Gazelle annotation prefix.
	annotationPrefix string = "gazelle:"
	// The ignore annotation kind. E.g. '# gazelle:ignore <module_name>'.
	annotationKindIgnore annotationKind = "ignore"
	annotationKindIncludeDep annotationKind = "include_dep"
	annotationKindIgnore annotationKind = "ignore"
	// Force a particular target to be added to `deps`. Multiple invocations are
	// accumulated and the value can be comma separated.
	// Eg: '# gazelle:include_dep //foo/bar:baz,@repo//:target
	annotationKindIncludeDep annotationKind = "include_dep"
	annotationKindIncludePytestConftest annotationKind = "include_pytest_conftest"
)

// Comment represents a Python comment.
Expand DownExpand Up@@ -222,13 +229,18 @@ type annotations struct {
	ignore map[string]struct{}
	// Labels that Gazelle should include as deps of the generated target.
	includeDeps []string
	// Whether the conftest.py file, found in the same directory as the current
	// python test file, should be added to the py_test target's `deps` attribute.
	// A *bool is used so that we can handle the "not set" state.
	includePytestConftest *bool
}

// annotationsFromComments returns all the annotations parsed out of the
// comments of a Python module.
func annotationsFromComments(comments []Comment) (*annotations, error) {
	ignore := make(map[string]struct{})
	includeDeps := []string{}
	var includePytestConftest *bool
	for _, comment := range comments {
 annotation, err := comment.asAnnotation()
 if err != nil {
Expand All@@ -255,11 +267,21 @@ func annotationsFromComments(comments []Comment) (*annotations, error) {
 includeDeps = append(includeDeps, t)
 }
 }
 if annotation.kind == annotationKindIncludePytestConftest {
 val := annotation.value
 parsedVal, err := strconv.ParseBool(val)
 if err != nil {
 log.Printf("WARNING: unable to cast %q to bool in %q. Ignoring annotation", val, comment)
 continue
 }
 includePytestConftest = &parsedVal
 }
 }
	}
	return &annotations{
 ignore: ignore,
 includeDeps: includeDeps,
 ignore: ignore,
 includeDeps: includeDeps,
 includePytestConftest: includePytestConftest,
	}, nil
}

Expand Down

9 changes: 9 additions & 0 deletions
gazelle/python/target.go

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -37,6 +37,7 @@ type targetBuilder struct {
	main *string
	imports []string
	testonly bool
	annotations *annotations
}

// newTargetBuilder constructs a new targetBuilder.
Expand All@@ -51,6 +52,7 @@ func newTargetBuilder(kind, name, pythonProjectRoot, bzlPackage string, siblingS
 deps: treeset.NewWith(moduleComparator),
 resolvedDeps: treeset.NewWith(godsutils.StringComparator),
 visibility: treeset.NewWith(godsutils.StringComparator),
 annotations: new(annotations),
	}
}

Expand DownExpand Up@@ -130,6 +132,13 @@ func (t *targetBuilder) setTestonly() *targetBuilder {
	return t
}

// setAnnotations sets the annotations attribute on the target.
func (t *targetBuilder) setAnnotations(val annotations) *targetBuilder {
	t.annotations = &val
	return t
}


// generateImportsAttribute generates the imports attribute.
// These are a list of import directories to be added to the PYTHONPATH. In our
// case, the value we add is on Bazel sub-packages to be able to perform imports
Expand Down

25 changes: 25 additions & 0 deletions
gazelle/python/testdata/annotation_include_pytest_conftest/README.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
# Annotation: Include Pytest Conftest

Validate that the `# gazelle:include_pytest_conftest` annotation follows
this logic:

+ When a `conftest.py` file does not exist:
 + all values have no affect
+ When a `conftest.py` file does exist:
 + Truthy values add `:conftest` to `deps`.
 + Falsey values do not add `:conftest` to `deps`.
 + Unset (no annotation) performs the default action.

Additionally, we test that:

+ invalid values (eg `foo`) print a warning and then act as if
 the annotation was not present.
+ last annotation (highest line number) wins.
+ the annotation has no effect on non-test files/targets.
+ the `include_dep` can still inject `:conftest` even when `include_pytest_conftest`
 is false.
+ `import conftest` will still add the dep even when `include_pytest_conftest` is
 false.

An annotation without a value is not tested, as that's part of the core
annotation framework and not specific to this annotation.
Empty file addedgazelle/python/testdata/annotation_include_pytest_conftest/WORKSPACE

View file


Open in desktop


Empty file.


5 changes: 5 additions & 0 deletions
gazelle/python/testdata/annotation_include_pytest_conftest/test.yaml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
expect:
 stderr: |
 gazelle: WARNING: unable to cast "foo" to bool in "# gazelle:include_pytest_conftest foo". Ignoring annotation
 exit_code: 0
Empty file addedgazelle/python/testdata/annotation_include_pytest_conftest/with_conftest/BUILD.in

View file


Open in desktop


Empty file.


68 changes: 68 additions & 0 deletions
gazelle/python/testdata/annotation_include_pytest_conftest/with_conftest/BUILD.out

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,68 @@
load("@rules_python//python:defs.bzl", "py_binary", "py_library", "py_test")

py_binary(
 name = "binary",
 srcs = ["binary.py"],
 visibility = ["//:__subpackages__"],
)

py_library(
 name = "with_conftest",
 srcs = [
 "binary.py",
 "library.py",
 ],
 visibility = ["//:__subpackages__"],
)

py_library(
 name = "conftest",
 testonly = True,
 srcs = ["conftest.py"],
 visibility = ["//:__subpackages__"],
)

py_test(
 name = "bad_value_test",
 srcs = ["bad_value_test.py"],
 deps = [":conftest"],
)

py_test(
 name = "conftest_imported_test",
 srcs = ["conftest_imported_test.py"],
 deps = [":conftest"],
)

py_test(
 name = "conftest_included_test",
 srcs = ["conftest_included_test.py"],
 deps = [":conftest"],
)

py_test(
 name = "false_test",
 srcs = ["false_test.py"],
)

py_test(
 name = "falsey_test",
 srcs = ["falsey_test.py"],
)

py_test(
 name = "last_value_wins_test",
 srcs = ["last_value_wins_test.py"],
)

py_test(
 name = "true_test",
 srcs = ["true_test.py"],
 deps = [":conftest"],
)

py_test(
 name = "unset_test",
 srcs = ["unset_test.py"],
 deps = [":conftest"],
)

1 change: 1 addition & 0 deletions
gazelle/python/testdata/annotation_include_pytest_conftest/with_conftest/bad_value_test.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
# gazelle:include_pytest_conftest foo

3 changes: 3 additions & 0 deletions
gazelle/python/testdata/annotation_include_pytest_conftest/with_conftest/binary.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
# gazelle:include_pytest_conftest true
if __name__ == "__main__":
 pass
Empty file addedgazelle/python/testdata/annotation_include_pytest_conftest/with_conftest/conftest.py

View file


Open in desktop


Empty file.


3 changes: 3 additions & 0 deletions
...ython/testdata/annotation_include_pytest_conftest/with_conftest/conftest_imported_test.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
import conftest

# gazelle:include_pytest_conftest false

2 changes: 2 additions & 0 deletions
...ython/testdata/annotation_include_pytest_conftest/with_conftest/conftest_included_test.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
# gazelle:include_dep :conftest
# gazelle:include_pytest_conftest false

1 change: 1 addition & 0 deletions
gazelle/python/testdata/annotation_include_pytest_conftest/with_conftest/false_test.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
# gazelle:include_pytest_conftest false

1 change: 1 addition & 0 deletions
gazelle/python/testdata/annotation_include_pytest_conftest/with_conftest/falsey_test.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
# gazelle:include_pytest_conftest 0

6 changes: 6 additions & 0 deletions
.../python/testdata/annotation_include_pytest_conftest/with_conftest/last_value_wins_test.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
# gazelle:include_pytest_conftest true
# gazelle:include_pytest_conftest TRUE
# gazelle:include_pytest_conftest False
# gazelle:include_pytest_conftest 0
# gazelle:include_pytest_conftest 1
# gazelle:include_pytest_conftest F
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Strip utm_, fbclid, gclid, etc. from all links on page
(function() {
var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',
'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',
'ref', 'ref_src', 'source', 'medium', 'campaign'];
function cleanUrl(url) {
try {
var u = new URL(url, window.location.origin);
var changed = false;
trackingParams.forEach(function(p) {
if (u.searchParams.has(p)) {
u.searchParams.delete(p);
changed = true;
}
});
return changed ? u.toString() : url;
} catch (e) {
return url;
}
}
function cleanLinks() {
document.querySelectorAll('a[href]').forEach(function(a) {
var clean = cleanUrl(a.href);
if (clean !== a.href) a.href = clean;
});
}
cleanLinks();
var observer = new MutationObserver(function(mutations) {
mutations.forEach(function(m) {
m.addedNodes.forEach(function(node) {
if (node.nodeType === 1) {
if (node.tagName === 'A') cleanLinks();
node.querySelectorAll('a[href]').forEach(function(a) {
var clean = cleanUrl(a.href);
if (clean !== a.href) a.href = clean;
});
}
});
});
});
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '
feat(gazelle): Add `include_pytest_conftest` annotation by dougthor42 · Pull Request #3080 · bazel-contrib/rules_python · GitHub
Skip to content
feat(gazelle): Add include_pytest_conftest annotation#3080

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

 Merged

aignas
merged 8 commits into

from

Jul 15, 2025
 Merged


feat(gazelle): Add include_pytest_conftest annotation
#3080
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


8 commits


Select commit
Hold shift + click to select a range
f5d8a7e

Add test cases


dougthor42 Jul 11, 2025
356a605

Add an annotations attribute to the targetBuilder struct


dougthor42 Jul 11, 2025
94a6ade

Update parser to handle gazelle_pytest_conftest annotation.


dougthor42 Jul 11, 2025
b1e98bf

Only add conftest dep when includePytestConftest is nil or true


dougthor42 Jul 11, 2025
e166653

Changelog and documentation


dougthor42 Jul 11, 2025
7969307

Add more tests


dougthor42 Jul 11, 2025
549ab0e

Merge branch 'main' into u/dthor/gazelle-conftest-annotation-gh3076


dougthor42 Jul 14, 2025
6025461

Merge branch 'main' into u/dthor/gazelle-conftest-annotation-gh3076


aignas Jul 15, 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


5 changes: 5 additions & 0 deletions
CHANGELOG.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -106,6 +106,11 @@ END_UNRELEASED_TEMPLATE
 * 3.12.11
 * 3.13.5
 * 3.14.0b3
* (gazelle): New annotation `gazelle:include_pytest_conftest`. When not set (the
 default) or `true`, gazelle will inject any `conftest.py` file found in the same
 directory as a {obj}`py_test` target to that {obj}`py_test` target's `deps`.
 This behavior is unchanged from previous versions. When `false`, the `:conftest`
 dep is not added to the {obj}`py_test` target.
* (gazelle) New directive `gazelle:python_generate_proto`; when `true`,
 Gazelle generates `py_proto_library` rules for `proto_library`. `false` by default.

Expand Down

85 changes: 85 additions & 0 deletions
gazelle/README.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -550,6 +550,8 @@ The annotations are:
| Tells Gazelle to ignore import statements. `imports` is a comma-separated list of imports to ignore. | |
| [`# gazelle:include_dep targets`](#annotation-include_dep) | N/A |
| Tells Gazelle to include a set of dependencies, even if they are not imported in a Python module. `targets` is a comma-separated list of target names to include as dependencies. | |
| [`# gazelle:include_pytest_conftest bool`](#annotation-include_pytest_conftest) | N/A |
| Whether or not to include a sibling `:conftest` target in the deps of a `py_test` target. Default behaviour is to include `:conftest`. | |


#### Annotation: `ignore`
Expand DownExpand Up@@ -622,6 +624,89 @@ deps = [
]
```

#### Annotation: `include_pytest_conftest`

Added in [#3080][gh3080].

[gh3080]: https://github.com/bazel-contrib/rules_python/pull/3080

This annotation accepts any string that can be parsed by go's
[`strconv.ParseBool`][ParseBool]. If an unparsable string is passed, the
annotation is ignored.

[ParseBool]: https://pkg.go.dev/strconv#ParseBool

Starting with [`rules_python` 0.14.0][rules-python-0.14.0] (specifically [PR #879][gh879]),
Gazelle will include a `:conftest` dependency to an `py_test` target that is in
the same directory as `conftest.py`.

[rules-python-0.14.0]: https://github.com/bazel-contrib/rules_python/releases/tag/0.14.0
[gh879]: https://github.com/bazel-contrib/rules_python/pull/879

This annotation allows users to adjust that behavior. To disable the behavior, set
the annotation value to "false":

```
# some_file_test.py
# gazelle:include_pytest_conftest false
```

Example:

Given a directory tree like:

```
.
├── BUILD.bazel
├── conftest.py
└── some_file_test.py
```

The default Gazelle behavior would create:

```starlark
py_library(
 name = "conftest",
 testonly = True,
 srcs = ["conftest.py"],
 visibility = ["//:__subpackages__"],
)

py_test(
 name = "some_file_test",
 srcs = ["some_file_test.py"],
 deps = [":conftest"],
)
```

When `# gazelle:include_pytest_conftest false` is found in `some_file_test.py`

```python
# some_file_test.py
# gazelle:include_pytest_conftest false
```

Gazelle will generate:

```starlark
py_library(
 name = "conftest",
 testonly = True,
 srcs = ["conftest.py"],
 visibility = ["//:__subpackages__"],
)

py_test(
 name = "some_file_test",
 srcs = ["some_file_test.py"],
)
```

See [Issue #3076][gh3076] for more information.

[gh3076]: https://github.com/bazel-contrib/rules_python/issues/3076


#### Directive: `experimental_allow_relative_imports`
Enables experimental support for resolving relative imports in
`python_generation_mode package`.
Expand Down

17 changes: 15 additions & 2 deletions
gazelle/python/generate.go

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -264,7 +264,9 @@ func (py *Python) GenerateRules(args language.GenerateArgs) language.GenerateRes
 addSrc(filename).
 addModuleDependencies(mainModules[filename]).
 addResolvedDependencies(annotations.includeDeps).
 generateImportsAttribute().build()
 generateImportsAttribute().
 setAnnotations(*annotations).
 build()
 result.Gen = append(result.Gen, pyBinary)
 result.Imports = append(result.Imports, pyBinary.PrivateAttr(config.GazelleImportsKey))
 }
Expand DownExpand Up@@ -305,6 +307,7 @@ func (py *Python) GenerateRules(args language.GenerateArgs) language.GenerateRes
 addModuleDependencies(allDeps).
 addResolvedDependencies(annotations.includeDeps).
 generateImportsAttribute().
 setAnnotations(*annotations).
 build()

 if pyLibrary.IsEmpty(py.Kinds()[pyLibrary.Kind()]) {
Expand DownExpand Up@@ -357,6 +360,7 @@ func (py *Python) GenerateRules(args language.GenerateArgs) language.GenerateRes
 addSrc(pyBinaryEntrypointFilename).
 addModuleDependencies(deps).
 addResolvedDependencies(annotations.includeDeps).
 setAnnotations(*annotations).
 generateImportsAttribute()

 pyBinary := pyBinaryTarget.build()
Expand DownExpand Up@@ -387,6 +391,7 @@ func (py *Python) GenerateRules(args language.GenerateArgs) language.GenerateRes
 addSrc(conftestFilename).
 addModuleDependencies(deps).
 addResolvedDependencies(annotations.includeDeps).
 setAnnotations(*annotations).
 addVisibility(visibility).
 setTestonly().
 generateImportsAttribute()
Expand DownExpand Up@@ -418,6 +423,7 @@ func (py *Python) GenerateRules(args language.GenerateArgs) language.GenerateRes
 addSrcs(srcs).
 addModuleDependencies(deps).
 addResolvedDependencies(annotations.includeDeps).
 setAnnotations(*annotations).
 generateImportsAttribute()
	}
	if (!cfg.PerPackageGenerationRequireTestEntryPoint() || hasPyTestEntryPointFile || hasPyTestEntryPointTarget || cfg.CoarseGrainedGeneration()) && !cfg.PerFileGeneration() {
Expand DownExpand Up@@ -470,7 +476,14 @@ func (py *Python) GenerateRules(args language.GenerateArgs) language.GenerateRes

	for _, pyTestTarget := range pyTestTargets {
 if conftest != nil {
 pyTestTarget.addModuleDependency(Module{Name: strings.TrimSuffix(conftestFilename, ".py")})
 conftestModule := Module{Name: strings.TrimSuffix(conftestFilename, ".py")}
 if pyTestTarget.annotations.includePytestConftest == nil {
 // unset; default behavior
 pyTestTarget.addModuleDependency(conftestModule)
 } else if *pyTestTarget.annotations.includePytestConftest {
 // set; add if true, do not add if false
 pyTestTarget.addModuleDependency(conftestModule)
 }
 }
 pyTest := pyTestTarget.build()

Expand Down

30 changes: 26 additions & 4 deletions
gazelle/python/parser.go

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -18,6 +18,8 @@ import (
	"context"
	_ "embed"
	"fmt"
	"log"
	"strconv"
	"strings"

	"github.com/emirpasic/gods/sets/treeset"
Expand DownExpand Up@@ -123,6 +125,7 @@ func (p *python3Parser) parse(pyFilenames *treeset.Set) (*treeset.Set, map[strin
 allAnnotations.ignore[k] = v
 }
 allAnnotations.includeDeps = append(allAnnotations.includeDeps, annotations.includeDeps...)
 allAnnotations.includePytestConftest = annotations.includePytestConftest
	}

	allAnnotations.includeDeps = removeDupesFromStringTreeSetSlice(allAnnotations.includeDeps)
Expand DownExpand Up@@ -183,8 +186,12 @@ const (
	// The Gazelle annotation prefix.
	annotationPrefix string = "gazelle:"
	// The ignore annotation kind. E.g. '# gazelle:ignore <module_name>'.
	annotationKindIgnore annotationKind = "ignore"
	annotationKindIncludeDep annotationKind = "include_dep"
	annotationKindIgnore annotationKind = "ignore"
	// Force a particular target to be added to `deps`. Multiple invocations are
	// accumulated and the value can be comma separated.
	// Eg: '# gazelle:include_dep //foo/bar:baz,@repo//:target
	annotationKindIncludeDep annotationKind = "include_dep"
	annotationKindIncludePytestConftest annotationKind = "include_pytest_conftest"
)

// Comment represents a Python comment.
Expand DownExpand Up@@ -222,13 +229,18 @@ type annotations struct {
	ignore map[string]struct{}
	// Labels that Gazelle should include as deps of the generated target.
	includeDeps []string
	// Whether the conftest.py file, found in the same directory as the current
	// python test file, should be added to the py_test target's `deps` attribute.
	// A *bool is used so that we can handle the "not set" state.
	includePytestConftest *bool
}

// annotationsFromComments returns all the annotations parsed out of the
// comments of a Python module.
func annotationsFromComments(comments []Comment) (*annotations, error) {
	ignore := make(map[string]struct{})
	includeDeps := []string{}
	var includePytestConftest *bool
	for _, comment := range comments {
 annotation, err := comment.asAnnotation()
 if err != nil {
Expand All@@ -255,11 +267,21 @@ func annotationsFromComments(comments []Comment) (*annotations, error) {
 includeDeps = append(includeDeps, t)
 }
 }
 if annotation.kind == annotationKindIncludePytestConftest {
 val := annotation.value
 parsedVal, err := strconv.ParseBool(val)
 if err != nil {
 log.Printf("WARNING: unable to cast %q to bool in %q. Ignoring annotation", val, comment)
 continue
 }
 includePytestConftest = &parsedVal
 }
 }
	}
	return &annotations{
 ignore: ignore,
 includeDeps: includeDeps,
 ignore: ignore,
 includeDeps: includeDeps,
 includePytestConftest: includePytestConftest,
	}, nil
}

Expand Down

9 changes: 9 additions & 0 deletions
gazelle/python/target.go

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -37,6 +37,7 @@ type targetBuilder struct {
	main *string
	imports []string
	testonly bool
	annotations *annotations
}

// newTargetBuilder constructs a new targetBuilder.
Expand All@@ -51,6 +52,7 @@ func newTargetBuilder(kind, name, pythonProjectRoot, bzlPackage string, siblingS
 deps: treeset.NewWith(moduleComparator),
 resolvedDeps: treeset.NewWith(godsutils.StringComparator),
 visibility: treeset.NewWith(godsutils.StringComparator),
 annotations: new(annotations),
	}
}

Expand DownExpand Up@@ -130,6 +132,13 @@ func (t *targetBuilder) setTestonly() *targetBuilder {
	return t
}

// setAnnotations sets the annotations attribute on the target.
func (t *targetBuilder) setAnnotations(val annotations) *targetBuilder {
	t.annotations = &val
	return t
}


// generateImportsAttribute generates the imports attribute.
// These are a list of import directories to be added to the PYTHONPATH. In our
// case, the value we add is on Bazel sub-packages to be able to perform imports
Expand Down

25 changes: 25 additions & 0 deletions
gazelle/python/testdata/annotation_include_pytest_conftest/README.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
# Annotation: Include Pytest Conftest

Validate that the `# gazelle:include_pytest_conftest` annotation follows
this logic:

+ When a `conftest.py` file does not exist:
 + all values have no affect
+ When a `conftest.py` file does exist:
 + Truthy values add `:conftest` to `deps`.
 + Falsey values do not add `:conftest` to `deps`.
 + Unset (no annotation) performs the default action.

Additionally, we test that:

+ invalid values (eg `foo`) print a warning and then act as if
 the annotation was not present.
+ last annotation (highest line number) wins.
+ the annotation has no effect on non-test files/targets.
+ the `include_dep` can still inject `:conftest` even when `include_pytest_conftest`
 is false.
+ `import conftest` will still add the dep even when `include_pytest_conftest` is
 false.

An annotation without a value is not tested, as that's part of the core
annotation framework and not specific to this annotation.
Empty file addedgazelle/python/testdata/annotation_include_pytest_conftest/WORKSPACE

View file


Open in desktop


Empty file.


5 changes: 5 additions & 0 deletions
gazelle/python/testdata/annotation_include_pytest_conftest/test.yaml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
expect:
 stderr: |
 gazelle: WARNING: unable to cast "foo" to bool in "# gazelle:include_pytest_conftest foo". Ignoring annotation
 exit_code: 0
Empty file addedgazelle/python/testdata/annotation_include_pytest_conftest/with_conftest/BUILD.in

View file


Open in desktop


Empty file.


68 changes: 68 additions & 0 deletions
gazelle/python/testdata/annotation_include_pytest_conftest/with_conftest/BUILD.out

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,68 @@
load("@rules_python//python:defs.bzl", "py_binary", "py_library", "py_test")

py_binary(
 name = "binary",
 srcs = ["binary.py"],
 visibility = ["//:__subpackages__"],
)

py_library(
 name = "with_conftest",
 srcs = [
 "binary.py",
 "library.py",
 ],
 visibility = ["//:__subpackages__"],
)

py_library(
 name = "conftest",
 testonly = True,
 srcs = ["conftest.py"],
 visibility = ["//:__subpackages__"],
)

py_test(
 name = "bad_value_test",
 srcs = ["bad_value_test.py"],
 deps = [":conftest"],
)

py_test(
 name = "conftest_imported_test",
 srcs = ["conftest_imported_test.py"],
 deps = [":conftest"],
)

py_test(
 name = "conftest_included_test",
 srcs = ["conftest_included_test.py"],
 deps = [":conftest"],
)

py_test(
 name = "false_test",
 srcs = ["false_test.py"],
)

py_test(
 name = "falsey_test",
 srcs = ["falsey_test.py"],
)

py_test(
 name = "last_value_wins_test",
 srcs = ["last_value_wins_test.py"],
)

py_test(
 name = "true_test",
 srcs = ["true_test.py"],
 deps = [":conftest"],
)

py_test(
 name = "unset_test",
 srcs = ["unset_test.py"],
 deps = [":conftest"],
)

1 change: 1 addition & 0 deletions
gazelle/python/testdata/annotation_include_pytest_conftest/with_conftest/bad_value_test.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
# gazelle:include_pytest_conftest foo

3 changes: 3 additions & 0 deletions
gazelle/python/testdata/annotation_include_pytest_conftest/with_conftest/binary.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
# gazelle:include_pytest_conftest true
if __name__ == "__main__":
 pass
Empty file addedgazelle/python/testdata/annotation_include_pytest_conftest/with_conftest/conftest.py

View file


Open in desktop


Empty file.


3 changes: 3 additions & 0 deletions
...ython/testdata/annotation_include_pytest_conftest/with_conftest/conftest_imported_test.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
import conftest

# gazelle:include_pytest_conftest false

2 changes: 2 additions & 0 deletions
...ython/testdata/annotation_include_pytest_conftest/with_conftest/conftest_included_test.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
# gazelle:include_dep :conftest
# gazelle:include_pytest_conftest false

1 change: 1 addition & 0 deletions
gazelle/python/testdata/annotation_include_pytest_conftest/with_conftest/false_test.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
# gazelle:include_pytest_conftest false

1 change: 1 addition & 0 deletions
gazelle/python/testdata/annotation_include_pytest_conftest/with_conftest/falsey_test.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
# gazelle:include_pytest_conftest 0

6 changes: 6 additions & 0 deletions
.../python/testdata/annotation_include_pytest_conftest/with_conftest/last_value_wins_test.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
# gazelle:include_pytest_conftest true
# gazelle:include_pytest_conftest TRUE
# gazelle:include_pytest_conftest False
# gazelle:include_pytest_conftest 0
# gazelle:include_pytest_conftest 1
# gazelle:include_pytest_conftest F
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Auto-enable theater mode on YouTube
(function() {
function tryTheater() {
var btn = document.querySelector('button[aria-label="Theater mode"], ytd-player #player button[title="Theater mode"]');
if (btn && !btn.classList.contains('activated')) {
btn.click();
}
}
// Try immediately
tryTheater();
// Try after navigation (SPA)
var lastUrl = location.href;
setInterval(function() {
if (location.href !== lastUrl) {
lastUrl = location.href;
setTimeout(tryTheater, 500);
}
}, 1000);
// Also try on player load
var observer = new MutationObserver(tryTheater);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
feat(gazelle): Add `include_pytest_conftest` annotation by dougthor42 · Pull Request #3080 · bazel-contrib/rules_python · GitHub
Skip to content
feat(gazelle): Add include_pytest_conftest annotation#3080

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

 Merged

aignas
merged 8 commits into

from

Jul 15, 2025
 Merged


feat(gazelle): Add include_pytest_conftest annotation
#3080
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


8 commits


Select commit
Hold shift + click to select a range
f5d8a7e

Add test cases


dougthor42 Jul 11, 2025
356a605

Add an annotations attribute to the targetBuilder struct


dougthor42 Jul 11, 2025
94a6ade

Update parser to handle gazelle_pytest_conftest annotation.


dougthor42 Jul 11, 2025
b1e98bf

Only add conftest dep when includePytestConftest is nil or true


dougthor42 Jul 11, 2025
e166653

Changelog and documentation


dougthor42 Jul 11, 2025
7969307

Add more tests


dougthor42 Jul 11, 2025
549ab0e

Merge branch 'main' into u/dthor/gazelle-conftest-annotation-gh3076


dougthor42 Jul 14, 2025
6025461

Merge branch 'main' into u/dthor/gazelle-conftest-annotation-gh3076


aignas Jul 15, 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


5 changes: 5 additions & 0 deletions
CHANGELOG.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -106,6 +106,11 @@ END_UNRELEASED_TEMPLATE
 * 3.12.11
 * 3.13.5
 * 3.14.0b3
* (gazelle): New annotation `gazelle:include_pytest_conftest`. When not set (the
 default) or `true`, gazelle will inject any `conftest.py` file found in the same
 directory as a {obj}`py_test` target to that {obj}`py_test` target's `deps`.
 This behavior is unchanged from previous versions. When `false`, the `:conftest`
 dep is not added to the {obj}`py_test` target.
* (gazelle) New directive `gazelle:python_generate_proto`; when `true`,
 Gazelle generates `py_proto_library` rules for `proto_library`. `false` by default.

Expand Down

85 changes: 85 additions & 0 deletions
gazelle/README.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -550,6 +550,8 @@ The annotations are:
| Tells Gazelle to ignore import statements. `imports` is a comma-separated list of imports to ignore. | |
| [`# gazelle:include_dep targets`](#annotation-include_dep) | N/A |
| Tells Gazelle to include a set of dependencies, even if they are not imported in a Python module. `targets` is a comma-separated list of target names to include as dependencies. | |
| [`# gazelle:include_pytest_conftest bool`](#annotation-include_pytest_conftest) | N/A |
| Whether or not to include a sibling `:conftest` target in the deps of a `py_test` target. Default behaviour is to include `:conftest`. | |


#### Annotation: `ignore`
Expand DownExpand Up@@ -622,6 +624,89 @@ deps = [
]
```

#### Annotation: `include_pytest_conftest`

Added in [#3080][gh3080].

[gh3080]: https://github.com/bazel-contrib/rules_python/pull/3080

This annotation accepts any string that can be parsed by go's
[`strconv.ParseBool`][ParseBool]. If an unparsable string is passed, the
annotation is ignored.

[ParseBool]: https://pkg.go.dev/strconv#ParseBool

Starting with [`rules_python` 0.14.0][rules-python-0.14.0] (specifically [PR #879][gh879]),
Gazelle will include a `:conftest` dependency to an `py_test` target that is in
the same directory as `conftest.py`.

[rules-python-0.14.0]: https://github.com/bazel-contrib/rules_python/releases/tag/0.14.0
[gh879]: https://github.com/bazel-contrib/rules_python/pull/879

This annotation allows users to adjust that behavior. To disable the behavior, set
the annotation value to "false":

```
# some_file_test.py
# gazelle:include_pytest_conftest false
```

Example:

Given a directory tree like:

```
.
├── BUILD.bazel
├── conftest.py
└── some_file_test.py
```

The default Gazelle behavior would create:

```starlark
py_library(
 name = "conftest",
 testonly = True,
 srcs = ["conftest.py"],
 visibility = ["//:__subpackages__"],
)

py_test(
 name = "some_file_test",
 srcs = ["some_file_test.py"],
 deps = [":conftest"],
)
```

When `# gazelle:include_pytest_conftest false` is found in `some_file_test.py`

```python
# some_file_test.py
# gazelle:include_pytest_conftest false
```

Gazelle will generate:

```starlark
py_library(
 name = "conftest",
 testonly = True,
 srcs = ["conftest.py"],
 visibility = ["//:__subpackages__"],
)

py_test(
 name = "some_file_test",
 srcs = ["some_file_test.py"],
)
```

See [Issue #3076][gh3076] for more information.

[gh3076]: https://github.com/bazel-contrib/rules_python/issues/3076


#### Directive: `experimental_allow_relative_imports`
Enables experimental support for resolving relative imports in
`python_generation_mode package`.
Expand Down

17 changes: 15 additions & 2 deletions
gazelle/python/generate.go

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -264,7 +264,9 @@ func (py *Python) GenerateRules(args language.GenerateArgs) language.GenerateRes
 addSrc(filename).
 addModuleDependencies(mainModules[filename]).
 addResolvedDependencies(annotations.includeDeps).
 generateImportsAttribute().build()
 generateImportsAttribute().
 setAnnotations(*annotations).
 build()
 result.Gen = append(result.Gen, pyBinary)
 result.Imports = append(result.Imports, pyBinary.PrivateAttr(config.GazelleImportsKey))
 }
Expand DownExpand Up@@ -305,6 +307,7 @@ func (py *Python) GenerateRules(args language.GenerateArgs) language.GenerateRes
 addModuleDependencies(allDeps).
 addResolvedDependencies(annotations.includeDeps).
 generateImportsAttribute().
 setAnnotations(*annotations).
 build()

 if pyLibrary.IsEmpty(py.Kinds()[pyLibrary.Kind()]) {
Expand DownExpand Up@@ -357,6 +360,7 @@ func (py *Python) GenerateRules(args language.GenerateArgs) language.GenerateRes
 addSrc(pyBinaryEntrypointFilename).
 addModuleDependencies(deps).
 addResolvedDependencies(annotations.includeDeps).
 setAnnotations(*annotations).
 generateImportsAttribute()

 pyBinary := pyBinaryTarget.build()
Expand DownExpand Up@@ -387,6 +391,7 @@ func (py *Python) GenerateRules(args language.GenerateArgs) language.GenerateRes
 addSrc(conftestFilename).
 addModuleDependencies(deps).
 addResolvedDependencies(annotations.includeDeps).
 setAnnotations(*annotations).
 addVisibility(visibility).
 setTestonly().
 generateImportsAttribute()
Expand DownExpand Up@@ -418,6 +423,7 @@ func (py *Python) GenerateRules(args language.GenerateArgs) language.GenerateRes
 addSrcs(srcs).
 addModuleDependencies(deps).
 addResolvedDependencies(annotations.includeDeps).
 setAnnotations(*annotations).
 generateImportsAttribute()
	}
	if (!cfg.PerPackageGenerationRequireTestEntryPoint() || hasPyTestEntryPointFile || hasPyTestEntryPointTarget || cfg.CoarseGrainedGeneration()) && !cfg.PerFileGeneration() {
Expand DownExpand Up@@ -470,7 +476,14 @@ func (py *Python) GenerateRules(args language.GenerateArgs) language.GenerateRes

	for _, pyTestTarget := range pyTestTargets {
 if conftest != nil {
 pyTestTarget.addModuleDependency(Module{Name: strings.TrimSuffix(conftestFilename, ".py")})
 conftestModule := Module{Name: strings.TrimSuffix(conftestFilename, ".py")}
 if pyTestTarget.annotations.includePytestConftest == nil {
 // unset; default behavior
 pyTestTarget.addModuleDependency(conftestModule)
 } else if *pyTestTarget.annotations.includePytestConftest {
 // set; add if true, do not add if false
 pyTestTarget.addModuleDependency(conftestModule)
 }
 }
 pyTest := pyTestTarget.build()

Expand Down

30 changes: 26 additions & 4 deletions
gazelle/python/parser.go

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -18,6 +18,8 @@ import (
	"context"
	_ "embed"
	"fmt"
	"log"
	"strconv"
	"strings"

	"github.com/emirpasic/gods/sets/treeset"
Expand DownExpand Up@@ -123,6 +125,7 @@ func (p *python3Parser) parse(pyFilenames *treeset.Set) (*treeset.Set, map[strin
 allAnnotations.ignore[k] = v
 }
 allAnnotations.includeDeps = append(allAnnotations.includeDeps, annotations.includeDeps...)
 allAnnotations.includePytestConftest = annotations.includePytestConftest
	}

	allAnnotations.includeDeps = removeDupesFromStringTreeSetSlice(allAnnotations.includeDeps)
Expand DownExpand Up@@ -183,8 +186,12 @@ const (
	// The Gazelle annotation prefix.
	annotationPrefix string = "gazelle:"
	// The ignore annotation kind. E.g. '# gazelle:ignore <module_name>'.
	annotationKindIgnore annotationKind = "ignore"
	annotationKindIncludeDep annotationKind = "include_dep"
	annotationKindIgnore annotationKind = "ignore"
	// Force a particular target to be added to `deps`. Multiple invocations are
	// accumulated and the value can be comma separated.
	// Eg: '# gazelle:include_dep //foo/bar:baz,@repo//:target
	annotationKindIncludeDep annotationKind = "include_dep"
	annotationKindIncludePytestConftest annotationKind = "include_pytest_conftest"
)

// Comment represents a Python comment.
Expand DownExpand Up@@ -222,13 +229,18 @@ type annotations struct {
	ignore map[string]struct{}
	// Labels that Gazelle should include as deps of the generated target.
	includeDeps []string
	// Whether the conftest.py file, found in the same directory as the current
	// python test file, should be added to the py_test target's `deps` attribute.
	// A *bool is used so that we can handle the "not set" state.
	includePytestConftest *bool
}

// annotationsFromComments returns all the annotations parsed out of the
// comments of a Python module.
func annotationsFromComments(comments []Comment) (*annotations, error) {
	ignore := make(map[string]struct{})
	includeDeps := []string{}
	var includePytestConftest *bool
	for _, comment := range comments {
 annotation, err := comment.asAnnotation()
 if err != nil {
Expand All@@ -255,11 +267,21 @@ func annotationsFromComments(comments []Comment) (*annotations, error) {
 includeDeps = append(includeDeps, t)
 }
 }
 if annotation.kind == annotationKindIncludePytestConftest {
 val := annotation.value
 parsedVal, err := strconv.ParseBool(val)
 if err != nil {
 log.Printf("WARNING: unable to cast %q to bool in %q. Ignoring annotation", val, comment)
 continue
 }
 includePytestConftest = &parsedVal
 }
 }
	}
	return &annotations{
 ignore: ignore,
 includeDeps: includeDeps,
 ignore: ignore,
 includeDeps: includeDeps,
 includePytestConftest: includePytestConftest,
	}, nil
}

Expand Down

9 changes: 9 additions & 0 deletions
gazelle/python/target.go

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -37,6 +37,7 @@ type targetBuilder struct {
	main *string
	imports []string
	testonly bool
	annotations *annotations
}

// newTargetBuilder constructs a new targetBuilder.
Expand All@@ -51,6 +52,7 @@ func newTargetBuilder(kind, name, pythonProjectRoot, bzlPackage string, siblingS
 deps: treeset.NewWith(moduleComparator),
 resolvedDeps: treeset.NewWith(godsutils.StringComparator),
 visibility: treeset.NewWith(godsutils.StringComparator),
 annotations: new(annotations),
	}
}

Expand DownExpand Up@@ -130,6 +132,13 @@ func (t *targetBuilder) setTestonly() *targetBuilder {
	return t
}

// setAnnotations sets the annotations attribute on the target.
func (t *targetBuilder) setAnnotations(val annotations) *targetBuilder {
	t.annotations = &val
	return t
}


// generateImportsAttribute generates the imports attribute.
// These are a list of import directories to be added to the PYTHONPATH. In our
// case, the value we add is on Bazel sub-packages to be able to perform imports
Expand Down

25 changes: 25 additions & 0 deletions
gazelle/python/testdata/annotation_include_pytest_conftest/README.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
# Annotation: Include Pytest Conftest

Validate that the `# gazelle:include_pytest_conftest` annotation follows
this logic:

+ When a `conftest.py` file does not exist:
 + all values have no affect
+ When a `conftest.py` file does exist:
 + Truthy values add `:conftest` to `deps`.
 + Falsey values do not add `:conftest` to `deps`.
 + Unset (no annotation) performs the default action.

Additionally, we test that:

+ invalid values (eg `foo`) print a warning and then act as if
 the annotation was not present.
+ last annotation (highest line number) wins.
+ the annotation has no effect on non-test files/targets.
+ the `include_dep` can still inject `:conftest` even when `include_pytest_conftest`
 is false.
+ `import conftest` will still add the dep even when `include_pytest_conftest` is
 false.

An annotation without a value is not tested, as that's part of the core
annotation framework and not specific to this annotation.
Empty file addedgazelle/python/testdata/annotation_include_pytest_conftest/WORKSPACE

View file


Open in desktop


Empty file.


5 changes: 5 additions & 0 deletions
gazelle/python/testdata/annotation_include_pytest_conftest/test.yaml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
expect:
 stderr: |
 gazelle: WARNING: unable to cast "foo" to bool in "# gazelle:include_pytest_conftest foo". Ignoring annotation
 exit_code: 0
Empty file addedgazelle/python/testdata/annotation_include_pytest_conftest/with_conftest/BUILD.in

View file


Open in desktop


Empty file.


68 changes: 68 additions & 0 deletions
gazelle/python/testdata/annotation_include_pytest_conftest/with_conftest/BUILD.out

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,68 @@
load("@rules_python//python:defs.bzl", "py_binary", "py_library", "py_test")

py_binary(
 name = "binary",
 srcs = ["binary.py"],
 visibility = ["//:__subpackages__"],
)

py_library(
 name = "with_conftest",
 srcs = [
 "binary.py",
 "library.py",
 ],
 visibility = ["//:__subpackages__"],
)

py_library(
 name = "conftest",
 testonly = True,
 srcs = ["conftest.py"],
 visibility = ["//:__subpackages__"],
)

py_test(
 name = "bad_value_test",
 srcs = ["bad_value_test.py"],
 deps = [":conftest"],
)

py_test(
 name = "conftest_imported_test",
 srcs = ["conftest_imported_test.py"],
 deps = [":conftest"],
)

py_test(
 name = "conftest_included_test",
 srcs = ["conftest_included_test.py"],
 deps = [":conftest"],
)

py_test(
 name = "false_test",
 srcs = ["false_test.py"],
)

py_test(
 name = "falsey_test",
 srcs = ["falsey_test.py"],
)

py_test(
 name = "last_value_wins_test",
 srcs = ["last_value_wins_test.py"],
)

py_test(
 name = "true_test",
 srcs = ["true_test.py"],
 deps = [":conftest"],
)

py_test(
 name = "unset_test",
 srcs = ["unset_test.py"],
 deps = [":conftest"],
)

1 change: 1 addition & 0 deletions
gazelle/python/testdata/annotation_include_pytest_conftest/with_conftest/bad_value_test.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
# gazelle:include_pytest_conftest foo

3 changes: 3 additions & 0 deletions
gazelle/python/testdata/annotation_include_pytest_conftest/with_conftest/binary.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
# gazelle:include_pytest_conftest true
if __name__ == "__main__":
 pass
Empty file addedgazelle/python/testdata/annotation_include_pytest_conftest/with_conftest/conftest.py

View file


Open in desktop


Empty file.


3 changes: 3 additions & 0 deletions
...ython/testdata/annotation_include_pytest_conftest/with_conftest/conftest_imported_test.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
import conftest

# gazelle:include_pytest_conftest false

2 changes: 2 additions & 0 deletions
...ython/testdata/annotation_include_pytest_conftest/with_conftest/conftest_included_test.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
# gazelle:include_dep :conftest
# gazelle:include_pytest_conftest false

1 change: 1 addition & 0 deletions
gazelle/python/testdata/annotation_include_pytest_conftest/with_conftest/false_test.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
# gazelle:include_pytest_conftest false

1 change: 1 addition & 0 deletions
gazelle/python/testdata/annotation_include_pytest_conftest/with_conftest/falsey_test.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
# gazelle:include_pytest_conftest 0

6 changes: 6 additions & 0 deletions
.../python/testdata/annotation_include_pytest_conftest/with_conftest/last_value_wins_test.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
# gazelle:include_pytest_conftest true
# gazelle:include_pytest_conftest TRUE
# gazelle:include_pytest_conftest False
# gazelle:include_pytest_conftest 0
# gazelle:include_pytest_conftest 1
# gazelle:include_pytest_conftest F
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Remove or un-stick sticky/fixed headers that block content
(function() {
function unstick() {
document.querySelectorAll('header, nav, [role="banner"], .header, .navbar, .sticky, .fixed-top, [style*="position: fixed"], [style*="position:sticky"]').forEach(function(el) {
if (el.style.position === 'fixed' || el.style.position === 'sticky' || getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {
el.style.position = 'static';
el.style.top = 'auto';
el.style.zIndex = 'auto';
}
});
}
unstick();
var observer = new MutationObserver(unstick);
observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });
})();
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
feat(gazelle): Add `include_pytest_conftest` annotation by dougthor42 · Pull Request #3080 · bazel-contrib/rules_python · GitHub
Skip to content
feat(gazelle): Add include_pytest_conftest annotation#3080

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

 Merged

aignas
merged 8 commits into

from

Jul 15, 2025
 Merged


feat(gazelle): Add include_pytest_conftest annotation
#3080
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


8 commits


Select commit
Hold shift + click to select a range
f5d8a7e

Add test cases


dougthor42 Jul 11, 2025
356a605

Add an annotations attribute to the targetBuilder struct


dougthor42 Jul 11, 2025
94a6ade

Update parser to handle gazelle_pytest_conftest annotation.


dougthor42 Jul 11, 2025
b1e98bf

Only add conftest dep when includePytestConftest is nil or true


dougthor42 Jul 11, 2025
e166653

Changelog and documentation


dougthor42 Jul 11, 2025
7969307

Add more tests


dougthor42 Jul 11, 2025
549ab0e

Merge branch 'main' into u/dthor/gazelle-conftest-annotation-gh3076


dougthor42 Jul 14, 2025
6025461

Merge branch 'main' into u/dthor/gazelle-conftest-annotation-gh3076


aignas Jul 15, 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


5 changes: 5 additions & 0 deletions
CHANGELOG.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -106,6 +106,11 @@ END_UNRELEASED_TEMPLATE
 * 3.12.11
 * 3.13.5
 * 3.14.0b3
* (gazelle): New annotation `gazelle:include_pytest_conftest`. When not set (the
 default) or `true`, gazelle will inject any `conftest.py` file found in the same
 directory as a {obj}`py_test` target to that {obj}`py_test` target's `deps`.
 This behavior is unchanged from previous versions. When `false`, the `:conftest`
 dep is not added to the {obj}`py_test` target.
* (gazelle) New directive `gazelle:python_generate_proto`; when `true`,
 Gazelle generates `py_proto_library` rules for `proto_library`. `false` by default.

Expand Down

85 changes: 85 additions & 0 deletions
gazelle/README.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -550,6 +550,8 @@ The annotations are:
| Tells Gazelle to ignore import statements. `imports` is a comma-separated list of imports to ignore. | |
| [`# gazelle:include_dep targets`](#annotation-include_dep) | N/A |
| Tells Gazelle to include a set of dependencies, even if they are not imported in a Python module. `targets` is a comma-separated list of target names to include as dependencies. | |
| [`# gazelle:include_pytest_conftest bool`](#annotation-include_pytest_conftest) | N/A |
| Whether or not to include a sibling `:conftest` target in the deps of a `py_test` target. Default behaviour is to include `:conftest`. | |


#### Annotation: `ignore`
Expand DownExpand Up@@ -622,6 +624,89 @@ deps = [
]
```

#### Annotation: `include_pytest_conftest`

Added in [#3080][gh3080].

[gh3080]: https://github.com/bazel-contrib/rules_python/pull/3080

This annotation accepts any string that can be parsed by go's
[`strconv.ParseBool`][ParseBool]. If an unparsable string is passed, the
annotation is ignored.

[ParseBool]: https://pkg.go.dev/strconv#ParseBool

Starting with [`rules_python` 0.14.0][rules-python-0.14.0] (specifically [PR #879][gh879]),
Gazelle will include a `:conftest` dependency to an `py_test` target that is in
the same directory as `conftest.py`.

[rules-python-0.14.0]: https://github.com/bazel-contrib/rules_python/releases/tag/0.14.0
[gh879]: https://github.com/bazel-contrib/rules_python/pull/879

This annotation allows users to adjust that behavior. To disable the behavior, set
the annotation value to "false":

```
# some_file_test.py
# gazelle:include_pytest_conftest false
```

Example:

Given a directory tree like:

```
.
├── BUILD.bazel
├── conftest.py
└── some_file_test.py
```

The default Gazelle behavior would create:

```starlark
py_library(
 name = "conftest",
 testonly = True,
 srcs = ["conftest.py"],
 visibility = ["//:__subpackages__"],
)

py_test(
 name = "some_file_test",
 srcs = ["some_file_test.py"],
 deps = [":conftest"],
)
```

When `# gazelle:include_pytest_conftest false` is found in `some_file_test.py`

```python
# some_file_test.py
# gazelle:include_pytest_conftest false
```

Gazelle will generate:

```starlark
py_library(
 name = "conftest",
 testonly = True,
 srcs = ["conftest.py"],
 visibility = ["//:__subpackages__"],
)

py_test(
 name = "some_file_test",
 srcs = ["some_file_test.py"],
)
```

See [Issue #3076][gh3076] for more information.

[gh3076]: https://github.com/bazel-contrib/rules_python/issues/3076


#### Directive: `experimental_allow_relative_imports`
Enables experimental support for resolving relative imports in
`python_generation_mode package`.
Expand Down

17 changes: 15 additions & 2 deletions
gazelle/python/generate.go

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -264,7 +264,9 @@ func (py *Python) GenerateRules(args language.GenerateArgs) language.GenerateRes
 addSrc(filename).
 addModuleDependencies(mainModules[filename]).
 addResolvedDependencies(annotations.includeDeps).
 generateImportsAttribute().build()
 generateImportsAttribute().
 setAnnotations(*annotations).
 build()
 result.Gen = append(result.Gen, pyBinary)
 result.Imports = append(result.Imports, pyBinary.PrivateAttr(config.GazelleImportsKey))
 }
Expand DownExpand Up@@ -305,6 +307,7 @@ func (py *Python) GenerateRules(args language.GenerateArgs) language.GenerateRes
 addModuleDependencies(allDeps).
 addResolvedDependencies(annotations.includeDeps).
 generateImportsAttribute().
 setAnnotations(*annotations).
 build()

 if pyLibrary.IsEmpty(py.Kinds()[pyLibrary.Kind()]) {
Expand DownExpand Up@@ -357,6 +360,7 @@ func (py *Python) GenerateRules(args language.GenerateArgs) language.GenerateRes
 addSrc(pyBinaryEntrypointFilename).
 addModuleDependencies(deps).
 addResolvedDependencies(annotations.includeDeps).
 setAnnotations(*annotations).
 generateImportsAttribute()

 pyBinary := pyBinaryTarget.build()
Expand DownExpand Up@@ -387,6 +391,7 @@ func (py *Python) GenerateRules(args language.GenerateArgs) language.GenerateRes
 addSrc(conftestFilename).
 addModuleDependencies(deps).
 addResolvedDependencies(annotations.includeDeps).
 setAnnotations(*annotations).
 addVisibility(visibility).
 setTestonly().
 generateImportsAttribute()
Expand DownExpand Up@@ -418,6 +423,7 @@ func (py *Python) GenerateRules(args language.GenerateArgs) language.GenerateRes
 addSrcs(srcs).
 addModuleDependencies(deps).
 addResolvedDependencies(annotations.includeDeps).
 setAnnotations(*annotations).
 generateImportsAttribute()
	}
	if (!cfg.PerPackageGenerationRequireTestEntryPoint() || hasPyTestEntryPointFile || hasPyTestEntryPointTarget || cfg.CoarseGrainedGeneration()) && !cfg.PerFileGeneration() {
Expand DownExpand Up@@ -470,7 +476,14 @@ func (py *Python) GenerateRules(args language.GenerateArgs) language.GenerateRes

	for _, pyTestTarget := range pyTestTargets {
 if conftest != nil {
 pyTestTarget.addModuleDependency(Module{Name: strings.TrimSuffix(conftestFilename, ".py")})
 conftestModule := Module{Name: strings.TrimSuffix(conftestFilename, ".py")}
 if pyTestTarget.annotations.includePytestConftest == nil {
 // unset; default behavior
 pyTestTarget.addModuleDependency(conftestModule)
 } else if *pyTestTarget.annotations.includePytestConftest {
 // set; add if true, do not add if false
 pyTestTarget.addModuleDependency(conftestModule)
 }
 }
 pyTest := pyTestTarget.build()

Expand Down

30 changes: 26 additions & 4 deletions
gazelle/python/parser.go

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -18,6 +18,8 @@ import (
	"context"
	_ "embed"
	"fmt"
	"log"
	"strconv"
	"strings"

	"github.com/emirpasic/gods/sets/treeset"
Expand DownExpand Up@@ -123,6 +125,7 @@ func (p *python3Parser) parse(pyFilenames *treeset.Set) (*treeset.Set, map[strin
 allAnnotations.ignore[k] = v
 }
 allAnnotations.includeDeps = append(allAnnotations.includeDeps, annotations.includeDeps...)
 allAnnotations.includePytestConftest = annotations.includePytestConftest
	}

	allAnnotations.includeDeps = removeDupesFromStringTreeSetSlice(allAnnotations.includeDeps)
Expand DownExpand Up@@ -183,8 +186,12 @@ const (
	// The Gazelle annotation prefix.
	annotationPrefix string = "gazelle:"
	// The ignore annotation kind. E.g. '# gazelle:ignore <module_name>'.
	annotationKindIgnore annotationKind = "ignore"
	annotationKindIncludeDep annotationKind = "include_dep"
	annotationKindIgnore annotationKind = "ignore"
	// Force a particular target to be added to `deps`. Multiple invocations are
	// accumulated and the value can be comma separated.
	// Eg: '# gazelle:include_dep //foo/bar:baz,@repo//:target
	annotationKindIncludeDep annotationKind = "include_dep"
	annotationKindIncludePytestConftest annotationKind = "include_pytest_conftest"
)

// Comment represents a Python comment.
Expand DownExpand Up@@ -222,13 +229,18 @@ type annotations struct {
	ignore map[string]struct{}
	// Labels that Gazelle should include as deps of the generated target.
	includeDeps []string
	// Whether the conftest.py file, found in the same directory as the current
	// python test file, should be added to the py_test target's `deps` attribute.
	// A *bool is used so that we can handle the "not set" state.
	includePytestConftest *bool
}

// annotationsFromComments returns all the annotations parsed out of the
// comments of a Python module.
func annotationsFromComments(comments []Comment) (*annotations, error) {
	ignore := make(map[string]struct{})
	includeDeps := []string{}
	var includePytestConftest *bool
	for _, comment := range comments {
 annotation, err := comment.asAnnotation()
 if err != nil {
Expand All@@ -255,11 +267,21 @@ func annotationsFromComments(comments []Comment) (*annotations, error) {
 includeDeps = append(includeDeps, t)
 }
 }
 if annotation.kind == annotationKindIncludePytestConftest {
 val := annotation.value
 parsedVal, err := strconv.ParseBool(val)
 if err != nil {
 log.Printf("WARNING: unable to cast %q to bool in %q. Ignoring annotation", val, comment)
 continue
 }
 includePytestConftest = &parsedVal
 }
 }
	}
	return &annotations{
 ignore: ignore,
 includeDeps: includeDeps,
 ignore: ignore,
 includeDeps: includeDeps,
 includePytestConftest: includePytestConftest,
	}, nil
}

Expand Down

9 changes: 9 additions & 0 deletions
gazelle/python/target.go

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -37,6 +37,7 @@ type targetBuilder struct {
	main *string
	imports []string
	testonly bool
	annotations *annotations
}

// newTargetBuilder constructs a new targetBuilder.
Expand All@@ -51,6 +52,7 @@ func newTargetBuilder(kind, name, pythonProjectRoot, bzlPackage string, siblingS
 deps: treeset.NewWith(moduleComparator),
 resolvedDeps: treeset.NewWith(godsutils.StringComparator),
 visibility: treeset.NewWith(godsutils.StringComparator),
 annotations: new(annotations),
	}
}

Expand DownExpand Up@@ -130,6 +132,13 @@ func (t *targetBuilder) setTestonly() *targetBuilder {
	return t
}

// setAnnotations sets the annotations attribute on the target.
func (t *targetBuilder) setAnnotations(val annotations) *targetBuilder {
	t.annotations = &val
	return t
}


// generateImportsAttribute generates the imports attribute.
// These are a list of import directories to be added to the PYTHONPATH. In our
// case, the value we add is on Bazel sub-packages to be able to perform imports
Expand Down

25 changes: 25 additions & 0 deletions
gazelle/python/testdata/annotation_include_pytest_conftest/README.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
# Annotation: Include Pytest Conftest

Validate that the `# gazelle:include_pytest_conftest` annotation follows
this logic:

+ When a `conftest.py` file does not exist:
 + all values have no affect
+ When a `conftest.py` file does exist:
 + Truthy values add `:conftest` to `deps`.
 + Falsey values do not add `:conftest` to `deps`.
 + Unset (no annotation) performs the default action.

Additionally, we test that:

+ invalid values (eg `foo`) print a warning and then act as if
 the annotation was not present.
+ last annotation (highest line number) wins.
+ the annotation has no effect on non-test files/targets.
+ the `include_dep` can still inject `:conftest` even when `include_pytest_conftest`
 is false.
+ `import conftest` will still add the dep even when `include_pytest_conftest` is
 false.

An annotation without a value is not tested, as that's part of the core
annotation framework and not specific to this annotation.
Empty file addedgazelle/python/testdata/annotation_include_pytest_conftest/WORKSPACE

View file


Open in desktop


Empty file.


5 changes: 5 additions & 0 deletions
gazelle/python/testdata/annotation_include_pytest_conftest/test.yaml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
expect:
 stderr: |
 gazelle: WARNING: unable to cast "foo" to bool in "# gazelle:include_pytest_conftest foo". Ignoring annotation
 exit_code: 0
Empty file addedgazelle/python/testdata/annotation_include_pytest_conftest/with_conftest/BUILD.in

View file


Open in desktop


Empty file.


68 changes: 68 additions & 0 deletions
gazelle/python/testdata/annotation_include_pytest_conftest/with_conftest/BUILD.out

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,68 @@
load("@rules_python//python:defs.bzl", "py_binary", "py_library", "py_test")

py_binary(
 name = "binary",
 srcs = ["binary.py"],
 visibility = ["//:__subpackages__"],
)

py_library(
 name = "with_conftest",
 srcs = [
 "binary.py",
 "library.py",
 ],
 visibility = ["//:__subpackages__"],
)

py_library(
 name = "conftest",
 testonly = True,
 srcs = ["conftest.py"],
 visibility = ["//:__subpackages__"],
)

py_test(
 name = "bad_value_test",
 srcs = ["bad_value_test.py"],
 deps = [":conftest"],
)

py_test(
 name = "conftest_imported_test",
 srcs = ["conftest_imported_test.py"],
 deps = [":conftest"],
)

py_test(
 name = "conftest_included_test",
 srcs = ["conftest_included_test.py"],
 deps = [":conftest"],
)

py_test(
 name = "false_test",
 srcs = ["false_test.py"],
)

py_test(
 name = "falsey_test",
 srcs = ["falsey_test.py"],
)

py_test(
 name = "last_value_wins_test",
 srcs = ["last_value_wins_test.py"],
)

py_test(
 name = "true_test",
 srcs = ["true_test.py"],
 deps = [":conftest"],
)

py_test(
 name = "unset_test",
 srcs = ["unset_test.py"],
 deps = [":conftest"],
)

1 change: 1 addition & 0 deletions
gazelle/python/testdata/annotation_include_pytest_conftest/with_conftest/bad_value_test.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
# gazelle:include_pytest_conftest foo

3 changes: 3 additions & 0 deletions
gazelle/python/testdata/annotation_include_pytest_conftest/with_conftest/binary.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
# gazelle:include_pytest_conftest true
if __name__ == "__main__":
 pass
Empty file addedgazelle/python/testdata/annotation_include_pytest_conftest/with_conftest/conftest.py

View file


Open in desktop


Empty file.


3 changes: 3 additions & 0 deletions
...ython/testdata/annotation_include_pytest_conftest/with_conftest/conftest_imported_test.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
import conftest

# gazelle:include_pytest_conftest false

2 changes: 2 additions & 0 deletions
...ython/testdata/annotation_include_pytest_conftest/with_conftest/conftest_included_test.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
# gazelle:include_dep :conftest
# gazelle:include_pytest_conftest false

1 change: 1 addition & 0 deletions
gazelle/python/testdata/annotation_include_pytest_conftest/with_conftest/false_test.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
# gazelle:include_pytest_conftest false

1 change: 1 addition & 0 deletions
gazelle/python/testdata/annotation_include_pytest_conftest/with_conftest/falsey_test.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
# gazelle:include_pytest_conftest 0

6 changes: 6 additions & 0 deletions
.../python/testdata/annotation_include_pytest_conftest/with_conftest/last_value_wins_test.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
# gazelle:include_pytest_conftest true
# gazelle:include_pytest_conftest TRUE
# gazelle:include_pytest_conftest False
# gazelle:include_pytest_conftest 0
# gazelle:include_pytest_conftest 1
# gazelle:include_pytest_conftest F
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Universal Dark Mode - works on any site
(function() {
var enabled = true;
function applyDarkMode() {
if (!enabled) return;
// Create style element if it doesn't exist
var style = document.getElementById('universal-dark-mode-style');
if (!style) {
style = document.createElement('style');
style.id = 'universal-dark-mode-style';
document.head.appendChild(style);
}
// Dark mode CSS - inverts colors but preserves images/video
style.textContent = '
/* Invert everything except media */
html {
filter: invert(1) hue-rotate(180deg) !important;
background: #1a1a2e !important;
}
/* Restore images, videos, iframes, canvas */
img, video, iframe, canvas, svg, picture, [style*="background-image"] {
filter: invert(1) hue-rotate(180deg) !important;
}
/* Preserve specific elements that should not be inverted */
.no-dark-mode, .no-dark-mode *,
[data-theme="light"], [data-theme="light"],
.ace_editor, .ace_editor *,
.CodeMirror, .CodeMirror *,
.monaco-editor, .monaco-editor *,
.markdown-body pre, .markdown-body pre *,
.highlight, .highlight *,
pre code, pre code * {
filter: none !important;
}
/* Fix common UI elements */
.modal, .popup, .dropdown-menu, .tooltip, .popover {
filter: invert(1) hue-rotate(180deg) !important;
background: #2d2d44 !important;
border-color: #444 !important;
}
/* Scrollbars */
::-webkit-scrollbar { background: #1a1a2e !important; }
::-webkit-scrollbar-thumb { background: #444 !important; }
::-webkit-scrollbar-thumb:hover { background: #555 !important; }
/* Selection */
::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }
::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }
';
}
function removeDarkMode() {
var style = document.getElementById('universal-dark-mode-style');
if (style) style.remove();
}
// Toggle with Alt+Shift+D
document.addEventListener('keydown', function(e) {
if (e.altKey && e.shiftKey && e.key === 'D') {
e.preventDefault();
enabled = !enabled;
if (enabled) {
applyDarkMode();
console.log('[Universal Dark Mode] Enabled');
} else {
removeDarkMode();
console.log('[Universal Dark Mode] Disabled');
}
}
});
// Apply on load
applyDarkMode();
// Re-apply on dynamic content
var observer = new MutationObserver(function(mutations) {
if (enabled && !document.getElementById('universal-dark-mode-style')) {
applyDarkMode();
}
});
observer.observe(document.head, { childList: true });
console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');
})();
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();
feat(gazelle): Add `include_pytest_conftest` annotation by dougthor42 · Pull Request #3080 · bazel-contrib/rules_python · GitHub
Skip to content
feat(gazelle): Add include_pytest_conftest annotation#3080

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

 Merged

aignas
merged 8 commits into

from

Jul 15, 2025
 Merged


feat(gazelle): Add include_pytest_conftest annotation
#3080
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


8 commits


Select commit
Hold shift + click to select a range
f5d8a7e

Add test cases


dougthor42 Jul 11, 2025
356a605

Add an annotations attribute to the targetBuilder struct


dougthor42 Jul 11, 2025
94a6ade

Update parser to handle gazelle_pytest_conftest annotation.


dougthor42 Jul 11, 2025
b1e98bf

Only add conftest dep when includePytestConftest is nil or true


dougthor42 Jul 11, 2025
e166653

Changelog and documentation


dougthor42 Jul 11, 2025
7969307

Add more tests


dougthor42 Jul 11, 2025
549ab0e

Merge branch 'main' into u/dthor/gazelle-conftest-annotation-gh3076


dougthor42 Jul 14, 2025
6025461

Merge branch 'main' into u/dthor/gazelle-conftest-annotation-gh3076


aignas Jul 15, 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


5 changes: 5 additions & 0 deletions
CHANGELOG.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -106,6 +106,11 @@ END_UNRELEASED_TEMPLATE
 * 3.12.11
 * 3.13.5
 * 3.14.0b3
* (gazelle): New annotation `gazelle:include_pytest_conftest`. When not set (the
 default) or `true`, gazelle will inject any `conftest.py` file found in the same
 directory as a {obj}`py_test` target to that {obj}`py_test` target's `deps`.
 This behavior is unchanged from previous versions. When `false`, the `:conftest`
 dep is not added to the {obj}`py_test` target.
* (gazelle) New directive `gazelle:python_generate_proto`; when `true`,
 Gazelle generates `py_proto_library` rules for `proto_library`. `false` by default.

Expand Down

85 changes: 85 additions & 0 deletions
gazelle/README.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -550,6 +550,8 @@ The annotations are:
| Tells Gazelle to ignore import statements. `imports` is a comma-separated list of imports to ignore. | |
| [`# gazelle:include_dep targets`](#annotation-include_dep) | N/A |
| Tells Gazelle to include a set of dependencies, even if they are not imported in a Python module. `targets` is a comma-separated list of target names to include as dependencies. | |
| [`# gazelle:include_pytest_conftest bool`](#annotation-include_pytest_conftest) | N/A |
| Whether or not to include a sibling `:conftest` target in the deps of a `py_test` target. Default behaviour is to include `:conftest`. | |


#### Annotation: `ignore`
Expand DownExpand Up@@ -622,6 +624,89 @@ deps = [
]
```

#### Annotation: `include_pytest_conftest`

Added in [#3080][gh3080].

[gh3080]: https://github.com/bazel-contrib/rules_python/pull/3080

This annotation accepts any string that can be parsed by go's
[`strconv.ParseBool`][ParseBool]. If an unparsable string is passed, the
annotation is ignored.

[ParseBool]: https://pkg.go.dev/strconv#ParseBool

Starting with [`rules_python` 0.14.0][rules-python-0.14.0] (specifically [PR #879][gh879]),
Gazelle will include a `:conftest` dependency to an `py_test` target that is in
the same directory as `conftest.py`.

[rules-python-0.14.0]: https://github.com/bazel-contrib/rules_python/releases/tag/0.14.0
[gh879]: https://github.com/bazel-contrib/rules_python/pull/879

This annotation allows users to adjust that behavior. To disable the behavior, set
the annotation value to "false":

```
# some_file_test.py
# gazelle:include_pytest_conftest false
```

Example:

Given a directory tree like:

```
.
├── BUILD.bazel
├── conftest.py
└── some_file_test.py
```

The default Gazelle behavior would create:

```starlark
py_library(
 name = "conftest",
 testonly = True,
 srcs = ["conftest.py"],
 visibility = ["//:__subpackages__"],
)

py_test(
 name = "some_file_test",
 srcs = ["some_file_test.py"],
 deps = [":conftest"],
)
```

When `# gazelle:include_pytest_conftest false` is found in `some_file_test.py`

```python
# some_file_test.py
# gazelle:include_pytest_conftest false
```

Gazelle will generate:

```starlark
py_library(
 name = "conftest",
 testonly = True,
 srcs = ["conftest.py"],
 visibility = ["//:__subpackages__"],
)

py_test(
 name = "some_file_test",
 srcs = ["some_file_test.py"],
)
```

See [Issue #3076][gh3076] for more information.

[gh3076]: https://github.com/bazel-contrib/rules_python/issues/3076


#### Directive: `experimental_allow_relative_imports`
Enables experimental support for resolving relative imports in
`python_generation_mode package`.
Expand Down

17 changes: 15 additions & 2 deletions
gazelle/python/generate.go

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -264,7 +264,9 @@ func (py *Python) GenerateRules(args language.GenerateArgs) language.GenerateRes
 addSrc(filename).
 addModuleDependencies(mainModules[filename]).
 addResolvedDependencies(annotations.includeDeps).
 generateImportsAttribute().build()
 generateImportsAttribute().
 setAnnotations(*annotations).
 build()
 result.Gen = append(result.Gen, pyBinary)
 result.Imports = append(result.Imports, pyBinary.PrivateAttr(config.GazelleImportsKey))
 }
Expand DownExpand Up@@ -305,6 +307,7 @@ func (py *Python) GenerateRules(args language.GenerateArgs) language.GenerateRes
 addModuleDependencies(allDeps).
 addResolvedDependencies(annotations.includeDeps).
 generateImportsAttribute().
 setAnnotations(*annotations).
 build()

 if pyLibrary.IsEmpty(py.Kinds()[pyLibrary.Kind()]) {
Expand DownExpand Up@@ -357,6 +360,7 @@ func (py *Python) GenerateRules(args language.GenerateArgs) language.GenerateRes
 addSrc(pyBinaryEntrypointFilename).
 addModuleDependencies(deps).
 addResolvedDependencies(annotations.includeDeps).
 setAnnotations(*annotations).
 generateImportsAttribute()

 pyBinary := pyBinaryTarget.build()
Expand DownExpand Up@@ -387,6 +391,7 @@ func (py *Python) GenerateRules(args language.GenerateArgs) language.GenerateRes
 addSrc(conftestFilename).
 addModuleDependencies(deps).
 addResolvedDependencies(annotations.includeDeps).
 setAnnotations(*annotations).
 addVisibility(visibility).
 setTestonly().
 generateImportsAttribute()
Expand DownExpand Up@@ -418,6 +423,7 @@ func (py *Python) GenerateRules(args language.GenerateArgs) language.GenerateRes
 addSrcs(srcs).
 addModuleDependencies(deps).
 addResolvedDependencies(annotations.includeDeps).
 setAnnotations(*annotations).
 generateImportsAttribute()
	}
	if (!cfg.PerPackageGenerationRequireTestEntryPoint() || hasPyTestEntryPointFile || hasPyTestEntryPointTarget || cfg.CoarseGrainedGeneration()) && !cfg.PerFileGeneration() {
Expand DownExpand Up@@ -470,7 +476,14 @@ func (py *Python) GenerateRules(args language.GenerateArgs) language.GenerateRes

	for _, pyTestTarget := range pyTestTargets {
 if conftest != nil {
 pyTestTarget.addModuleDependency(Module{Name: strings.TrimSuffix(conftestFilename, ".py")})
 conftestModule := Module{Name: strings.TrimSuffix(conftestFilename, ".py")}
 if pyTestTarget.annotations.includePytestConftest == nil {
 // unset; default behavior
 pyTestTarget.addModuleDependency(conftestModule)
 } else if *pyTestTarget.annotations.includePytestConftest {
 // set; add if true, do not add if false
 pyTestTarget.addModuleDependency(conftestModule)
 }
 }
 pyTest := pyTestTarget.build()

Expand Down

30 changes: 26 additions & 4 deletions
gazelle/python/parser.go

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -18,6 +18,8 @@ import (
	"context"
	_ "embed"
	"fmt"
	"log"
	"strconv"
	"strings"

	"github.com/emirpasic/gods/sets/treeset"
Expand DownExpand Up@@ -123,6 +125,7 @@ func (p *python3Parser) parse(pyFilenames *treeset.Set) (*treeset.Set, map[strin
 allAnnotations.ignore[k] = v
 }
 allAnnotations.includeDeps = append(allAnnotations.includeDeps, annotations.includeDeps...)
 allAnnotations.includePytestConftest = annotations.includePytestConftest
	}

	allAnnotations.includeDeps = removeDupesFromStringTreeSetSlice(allAnnotations.includeDeps)
Expand DownExpand Up@@ -183,8 +186,12 @@ const (
	// The Gazelle annotation prefix.
	annotationPrefix string = "gazelle:"
	// The ignore annotation kind. E.g. '# gazelle:ignore <module_name>'.
	annotationKindIgnore annotationKind = "ignore"
	annotationKindIncludeDep annotationKind = "include_dep"
	annotationKindIgnore annotationKind = "ignore"
	// Force a particular target to be added to `deps`. Multiple invocations are
	// accumulated and the value can be comma separated.
	// Eg: '# gazelle:include_dep //foo/bar:baz,@repo//:target
	annotationKindIncludeDep annotationKind = "include_dep"
	annotationKindIncludePytestConftest annotationKind = "include_pytest_conftest"
)

// Comment represents a Python comment.
Expand DownExpand Up@@ -222,13 +229,18 @@ type annotations struct {
	ignore map[string]struct{}
	// Labels that Gazelle should include as deps of the generated target.
	includeDeps []string
	// Whether the conftest.py file, found in the same directory as the current
	// python test file, should be added to the py_test target's `deps` attribute.
	// A *bool is used so that we can handle the "not set" state.
	includePytestConftest *bool
}

// annotationsFromComments returns all the annotations parsed out of the
// comments of a Python module.
func annotationsFromComments(comments []Comment) (*annotations, error) {
	ignore := make(map[string]struct{})
	includeDeps := []string{}
	var includePytestConftest *bool
	for _, comment := range comments {
 annotation, err := comment.asAnnotation()
 if err != nil {
Expand All@@ -255,11 +267,21 @@ func annotationsFromComments(comments []Comment) (*annotations, error) {
 includeDeps = append(includeDeps, t)
 }
 }
 if annotation.kind == annotationKindIncludePytestConftest {
 val := annotation.value
 parsedVal, err := strconv.ParseBool(val)
 if err != nil {
 log.Printf("WARNING: unable to cast %q to bool in %q. Ignoring annotation", val, comment)
 continue
 }
 includePytestConftest = &parsedVal
 }
 }
	}
	return &annotations{
 ignore: ignore,
 includeDeps: includeDeps,
 ignore: ignore,
 includeDeps: includeDeps,
 includePytestConftest: includePytestConftest,
	}, nil
}

Expand Down

9 changes: 9 additions & 0 deletions
gazelle/python/target.go

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -37,6 +37,7 @@ type targetBuilder struct {
	main *string
	imports []string
	testonly bool
	annotations *annotations
}

// newTargetBuilder constructs a new targetBuilder.
Expand All@@ -51,6 +52,7 @@ func newTargetBuilder(kind, name, pythonProjectRoot, bzlPackage string, siblingS
 deps: treeset.NewWith(moduleComparator),
 resolvedDeps: treeset.NewWith(godsutils.StringComparator),
 visibility: treeset.NewWith(godsutils.StringComparator),
 annotations: new(annotations),
	}
}

Expand DownExpand Up@@ -130,6 +132,13 @@ func (t *targetBuilder) setTestonly() *targetBuilder {
	return t
}

// setAnnotations sets the annotations attribute on the target.
func (t *targetBuilder) setAnnotations(val annotations) *targetBuilder {
	t.annotations = &val
	return t
}


// generateImportsAttribute generates the imports attribute.
// These are a list of import directories to be added to the PYTHONPATH. In our
// case, the value we add is on Bazel sub-packages to be able to perform imports
Expand Down

25 changes: 25 additions & 0 deletions
gazelle/python/testdata/annotation_include_pytest_conftest/README.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
# Annotation: Include Pytest Conftest

Validate that the `# gazelle:include_pytest_conftest` annotation follows
this logic:

+ When a `conftest.py` file does not exist:
 + all values have no affect
+ When a `conftest.py` file does exist:
 + Truthy values add `:conftest` to `deps`.
 + Falsey values do not add `:conftest` to `deps`.
 + Unset (no annotation) performs the default action.

Additionally, we test that:

+ invalid values (eg `foo`) print a warning and then act as if
 the annotation was not present.
+ last annotation (highest line number) wins.
+ the annotation has no effect on non-test files/targets.
+ the `include_dep` can still inject `:conftest` even when `include_pytest_conftest`
 is false.
+ `import conftest` will still add the dep even when `include_pytest_conftest` is
 false.

An annotation without a value is not tested, as that's part of the core
annotation framework and not specific to this annotation.
Empty file addedgazelle/python/testdata/annotation_include_pytest_conftest/WORKSPACE

View file


Open in desktop


Empty file.


5 changes: 5 additions & 0 deletions
gazelle/python/testdata/annotation_include_pytest_conftest/test.yaml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
expect:
 stderr: |
 gazelle: WARNING: unable to cast "foo" to bool in "# gazelle:include_pytest_conftest foo". Ignoring annotation
 exit_code: 0
Empty file addedgazelle/python/testdata/annotation_include_pytest_conftest/with_conftest/BUILD.in

View file


Open in desktop


Empty file.


68 changes: 68 additions & 0 deletions
gazelle/python/testdata/annotation_include_pytest_conftest/with_conftest/BUILD.out

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,68 @@
load("@rules_python//python:defs.bzl", "py_binary", "py_library", "py_test")

py_binary(
 name = "binary",
 srcs = ["binary.py"],
 visibility = ["//:__subpackages__"],
)

py_library(
 name = "with_conftest",
 srcs = [
 "binary.py",
 "library.py",
 ],
 visibility = ["//:__subpackages__"],
)

py_library(
 name = "conftest",
 testonly = True,
 srcs = ["conftest.py"],
 visibility = ["//:__subpackages__"],
)

py_test(
 name = "bad_value_test",
 srcs = ["bad_value_test.py"],
 deps = [":conftest"],
)

py_test(
 name = "conftest_imported_test",
 srcs = ["conftest_imported_test.py"],
 deps = [":conftest"],
)

py_test(
 name = "conftest_included_test",
 srcs = ["conftest_included_test.py"],
 deps = [":conftest"],
)

py_test(
 name = "false_test",
 srcs = ["false_test.py"],
)

py_test(
 name = "falsey_test",
 srcs = ["falsey_test.py"],
)

py_test(
 name = "last_value_wins_test",
 srcs = ["last_value_wins_test.py"],
)

py_test(
 name = "true_test",
 srcs = ["true_test.py"],
 deps = [":conftest"],
)

py_test(
 name = "unset_test",
 srcs = ["unset_test.py"],
 deps = [":conftest"],
)

1 change: 1 addition & 0 deletions
gazelle/python/testdata/annotation_include_pytest_conftest/with_conftest/bad_value_test.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
# gazelle:include_pytest_conftest foo

3 changes: 3 additions & 0 deletions
gazelle/python/testdata/annotation_include_pytest_conftest/with_conftest/binary.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
# gazelle:include_pytest_conftest true
if __name__ == "__main__":
 pass
Empty file addedgazelle/python/testdata/annotation_include_pytest_conftest/with_conftest/conftest.py

View file


Open in desktop


Empty file.


3 changes: 3 additions & 0 deletions
...ython/testdata/annotation_include_pytest_conftest/with_conftest/conftest_imported_test.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
import conftest

# gazelle:include_pytest_conftest false

2 changes: 2 additions & 0 deletions
...ython/testdata/annotation_include_pytest_conftest/with_conftest/conftest_included_test.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
# gazelle:include_dep :conftest
# gazelle:include_pytest_conftest false

1 change: 1 addition & 0 deletions
gazelle/python/testdata/annotation_include_pytest_conftest/with_conftest/false_test.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
# gazelle:include_pytest_conftest false

1 change: 1 addition & 0 deletions
gazelle/python/testdata/annotation_include_pytest_conftest/with_conftest/falsey_test.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
# gazelle:include_pytest_conftest 0

6 changes: 6 additions & 0 deletions
.../python/testdata/annotation_include_pytest_conftest/with_conftest/last_value_wins_test.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
# gazelle:include_pytest_conftest true
# gazelle:include_pytest_conftest TRUE
# gazelle:include_pytest_conftest False
# gazelle:include_pytest_conftest 0
# gazelle:include_pytest_conftest 1
# gazelle:include_pytest_conftest F
Loading