Skip to content

Commit 4ee7e25

Browse files
authored
chore: rename the dev-only setup files to more clearly self-describe what they are (#2436)
The names `internal_deps` and `internal_setup` are a bit confusing and ambiguous: are they for setting up something internal so that rules_python works, or something else? Clarify by putting `dev` in their names. This helps match the naming used for bzlmod (python/private/internal_dev_deps.bzl).
1 parent 2abca35 commit 4ee7e25

File tree

4 files changed

+14
-8
lines changed

4 files changed

+14
-8
lines changed

BUILD.bazel

+2-2
Original file line numberDiff line numberDiff line change
@@ -40,8 +40,8 @@ filegroup(
4040
"MODULE.bazel",
4141
"WORKSPACE",
4242
"WORKSPACE.bzlmod",
43-
"internal_deps.bzl",
44-
"internal_setup.bzl",
43+
"internal_dev_deps.bzl",
44+
"internal_dev_setup.bzl",
4545
"version.bzl",
4646
"//python:distribution",
4747
"//tools:distribution",

WORKSPACE

+2-2
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ workspace(name = "rules_python")
1717
# Everything below this line is used only for developing rules_python. Users
1818
# should not copy it to their WORKSPACE.
1919

20-
load("//:internal_deps.bzl", "rules_python_internal_deps")
20+
load("//:internal_dev_deps.bzl", "rules_python_internal_deps")
2121

2222
rules_python_internal_deps()
2323

@@ -37,7 +37,7 @@ load("@stardoc_maven//:defs.bzl", stardoc_pinned_maven_install = "pinned_maven_i
3737

3838
stardoc_pinned_maven_install()
3939

40-
load("//:internal_setup.bzl", "rules_python_internal_setup")
40+
load("//:internal_dev_setup.bzl", "rules_python_internal_setup")
4141

4242
rules_python_internal_setup()
4343

internal_deps.bzl internal_dev_deps.bzl

+8-2
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212
# See the License for the specific language governing permissions and
1313
# limitations under the License.
1414

15-
"""Dependencies that are needed for rules_python tests and tools."""
15+
"""Dependencies that are needed for development and testing of rules_python itself."""
1616

1717
load("@bazel_tools//tools/build_defs/repo:http.bzl", _http_archive = "http_archive", _http_file = "http_file")
1818
load("@bazel_tools//tools/build_defs/repo:utils.bzl", "maybe")
@@ -32,7 +32,13 @@ def http_file(name, **kwargs):
3232
)
3333

3434
def rules_python_internal_deps():
35-
"""Fetches all required dependencies for rules_python tests and tools."""
35+
"""Fetches all required dependencies for developing/testing rules_python itself.
36+
37+
Setup of these dependencies is done by `internal_dev_setup.bzl`
38+
39+
For dependencies needed by *users* of rules_python, see
40+
python/private/py_repositories.bzl.
41+
"""
3642

3743
http_archive(
3844
name = "bazel_skylib",

internal_setup.bzl internal_dev_setup.bzl

+2-2
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212
# See the License for the specific language governing permissions and
1313
# limitations under the License.
1414

15-
"""Setup for rules_python tests and tools."""
15+
"""WORKSPACE setup for development and testing of rules_python itself."""
1616

1717
load("@bazel_features//:deps.bzl", "bazel_features_deps")
1818
load("@bazel_skylib//:workspace.bzl", "bazel_skylib_workspace")
@@ -30,7 +30,7 @@ load("//python/private:pythons_hub.bzl", "hub_repo") # buildifier: disable=bzl-
3030
load("//python/private/pypi:deps.bzl", "pypi_deps") # buildifier: disable=bzl-visibility
3131

3232
def rules_python_internal_setup():
33-
"""Setup for rules_python tests and tools."""
33+
"""Setup for development and testing of rules_python itself."""
3434

3535
internal_config_repo(name = "rules_python_internal")
3636
hub_repo(

0 commit comments

Comments
 (0)