[components] Rename components dir to defs (#28108)

## Summary & Motivation

This renames the default component generation dir to `defs` from
`components`.

## How I Tested These Changes

Existing test suite.

examples/docs_beta_snippets/docs_beta_snippets/guides/components/existing-project/2-pyproject.toml

@@ -4,7 +4,7 @@ directory_type = "project"
 
 [tool.dg.project]
 root_module = "my_existing_project"
-components_module = "my_existing_project.components"
+components_module = "my_existing_project.defs"
 
 [tool.dagster]
 module_name = "my_existing_project.definitions"

examples/docs_beta_snippets/docs_beta_snippets/guides/components/index/10-tree-jaffle-platform.txt

@@ -2,11 +2,11 @@ tree jaffle_platform
 
 jaffle_platform
 ├── __init__.py
-├── components
+├── definitions.py
+├── defs
 │   └── ingest_files
 │       ├── component.yaml
 │       └── replication.yaml
-├── definitions.py
 └── lib
     └── __init__.py
 

examples/docs_beta_snippets/docs_beta_snippets/guides/components/index/19-dg-scaffold-jdbt.txt

@@ -1,4 +1,4 @@
 dg scaffold component dagster_components.lib.DbtProjectComponent jdbt --project-path dbt/jdbt
 
-Creating a Dagster component instance folder at /.../jaffle-platform/jaffle_platform/components/jdbt.
+Creating a Dagster component instance folder at /.../jaffle-platform/jaffle_platform/defs/jdbt.
 Using /.../jaffle-platform/.venv/bin/dagster-components

examples/docs_beta_snippets/docs_beta_snippets/guides/components/index/22-dg-component-check-error.txt

@@ -1,6 +1,6 @@
 dg check yaml
 
-/.../jaffle-platform/jaffle_platform/components/jdbt/component.yaml:7 -  Unable to parse YAML: while scanning a quoted scalar, found unexpected end of stream
+/.../jaffle-platform/jaffle_platform/defs/jdbt/component.yaml:7 -  Unable to parse YAML: while scanning a quoted scalar, found unexpected end of stream
      | 
    6 |   asset_attributes:
    7 |     key: "target/main/{{ node.name }}

examples/docs_beta_snippets/docs_beta_snippets/guides/components/index/3-tree.txt

@@ -3,8 +3,8 @@ cd jaffle-platform && tree
 .
 ├── jaffle_platform
 │   ├── __init__.py
-│   ├── components
 │   ├── definitions.py
+│   ├── defs
 │   └── lib
 │       └── __init__.py
 ├── jaffle_platform.egg-info

examples/docs_beta_snippets/docs_beta_snippets/guides/components/index/5-definitions.py

@@ -2,4 +2,4 @@
 
 from dagster_components import build_component_defs
 
-defs = build_component_defs(components_root=Path(__file__).parent / "components")
+defs = build_component_defs(components_root=Path(__file__).parent / "defs")

examples/docs_beta_snippets/docs_beta_snippets/guides/components/index/9-dg-scaffold-sling-replication.txt

@@ -1,4 +1,4 @@
 dg scaffold component 'dagster_components.lib.SlingReplicationCollectionComponent' ingest_files
 
-Creating a Dagster component instance folder at /.../jaffle-platform/jaffle_platform/components/ingest_files.
+Creating a Dagster component instance folder at /.../jaffle-platform/jaffle_platform/defs/ingest_files.
 Using /.../jaffle-platform/.venv/bin/dagster-components

examples/docs_beta_snippets/docs_beta_snippets/guides/components/migrating-definitions/1-tree.txt

@@ -8,8 +8,8 @@ tree
 │   │   ├── __init__.py
 │   │   ├── assets.py
 │   │   └── jobs.py
-│   ├── components
 │   ├── definitions.py
+│   ├── defs
 │   └── elt
 │       ├── __init__.py
 │       ├── assets.py

examples/docs_beta_snippets/docs_beta_snippets/guides/components/migrating-definitions/10-definitions-after-all.py

@@ -2,4 +2,4 @@
 
 import dagster_components as dg_components
 
-defs = dg_components.build_component_defs(Path(__file__).parent / "components")
+defs = dg_components.build_component_defs(Path(__file__).parent / "defs")

examples/docs_beta_snippets/docs_beta_snippets/guides/components/migrating-definitions/3-scaffold.txt

@@ -1,5 +1,5 @@
 dg scaffold component 'dagster_components.lib.DefinitionsComponent' elt-definitions
 
 Using /.../my-existing-project/.venv/bin/dagster-components
-Creating a Dagster component instance folder at /.../my-existing-project/my_existing_project/components/elt-definitions.
+Creating a Dagster component instance folder at /.../my-existing-project/my_existing_project/defs/elt-definitions.
 Using /.../my-existing-project/.venv/bin/dagster-components

examples/docs_beta_snippets/docs_beta_snippets/guides/components/migrating-definitions/4-mv.txt

@@ -1 +1 @@
-mv my_existing_project/elt/* my_existing_project/components/elt-definitions
+mv my_existing_project/elt/* my_existing_project/defs/elt-definitions

examples/docs_beta_snippets/docs_beta_snippets/guides/components/migrating-definitions/7-definitions-after.py

@@ -15,5 +15,5 @@
         jobs=[regenerate_analytics_job],
         schedules=[regenerate_analytics_hourly_schedule],
     ),
-    dg_components.build_component_defs(Path(__file__).parent / "components"),
+    dg_components.build_component_defs(Path(__file__).parent / "defs"),
 )

examples/docs_beta_snippets/docs_beta_snippets/guides/components/migrating-definitions/8-tree-after.txt

@@ -8,14 +8,14 @@ tree
 │   │   ├── __init__.py
 │   │   ├── assets.py
 │   │   └── jobs.py
-│   ├── components
-│   │   └── elt-definitions
-│   │       ├── __init__.py
-│   │       ├── assets.py
-│   │       ├── component.yaml
-│   │       ├── definitions.py
-│   │       └── jobs.py
-│   └── definitions.py
+│   ├── definitions.py
+│   └── defs
+│       └── elt-definitions
+│           ├── __init__.py
+│           ├── assets.py
+│           ├── component.yaml
+│           ├── definitions.py
+│           └── jobs.py
 ├── pyproject.toml
 └── uv.lock
 

examples/docs_beta_snippets/docs_beta_snippets/guides/components/migrating-definitions/9-tree-after-all.txt

@@ -4,20 +4,20 @@ tree
 ├── README.md
 ├── my_existing_project
 │   ├── __init__.py
-│   ├── components
-│   │   ├── analytics-definitions
-│   │   │   ├── __init__.py
-│   │   │   ├── assets.py
-│   │   │   ├── component.yaml
-│   │   │   ├── definitions.py
-│   │   │   └── jobs.py
-│   │   └── elt-definitions
-│   │       ├── __init__.py
-│   │       ├── assets.py
-│   │       ├── component.yaml
-│   │       ├── definitions.py
-│   │       └── jobs.py
-│   └── definitions.py
+│   ├── definitions.py
+│   └── defs
+│       ├── analytics-definitions
+│       │   ├── __init__.py
+│       │   ├── assets.py
+│       │   ├── component.yaml
+│       │   ├── definitions.py
+│       │   └── jobs.py
+│       └── elt-definitions
+│           ├── __init__.py
+│           ├── assets.py
+│           ├── component.yaml
+│           ├── definitions.py
+│           └── jobs.py
 ├── pyproject.toml
 └── uv.lock
 

examples/docs_beta_snippets/docs_beta_snippets/guides/components/shell-script-component/6-scaffold-instance-of-component.txt

@@ -1,5 +1,5 @@
 dg scaffold component 'my_component_library.lib.ShellCommand' my_shell_command
 
 Using /.../my-component-library/.venv/bin/dagster-components
-Creating a Dagster component instance folder at /.../my-component-library/my_component_library/components/my_shell_command.
+Creating a Dagster component instance folder at /.../my-component-library/my_component_library/defs/my_shell_command.
 Using /.../my-component-library/.venv/bin/dagster-components

examples/docs_beta_snippets/docs_beta_snippets/guides/components/workspace/2-tree.txt

@@ -6,8 +6,8 @@ cd dagster-workspace && tree
 │   └── project-1
 │       ├── project_1
 │       │   ├── __init__.py
-│       │   ├── components
 │       │   ├── definitions.py
+│       │   ├── defs
 │       │   └── lib
 │       │       └── __init__.py
 │       ├── project_1_tests

examples/docs_beta_snippets/docs_beta_snippets_tests/snippet_checks/guides/components/test_components_docs.py

@@ -135,7 +135,7 @@ def next_snip_no():
             custom_comparison_fn=compare_tree_output,
         )
         check_file(
-            Path("jaffle_platform") / "components" / "ingest_files" / "component.yaml",
+            Path("jaffle_platform") / "defs" / "ingest_files" / "component.yaml",
             COMPONENTS_SNIPPETS_DIR / f"{next_snip_no()}-component.yaml",
             update_snippets=update_snippets,
         )
@@ -193,7 +193,7 @@ def next_snip_no():
             )
             create_file(
                 file_path=Path("jaffle_platform")
-                / "components"
+                / "defs"
                 / "ingest_files"
                 / "replication.yaml",
                 snippet_path=COMPONENTS_SNIPPETS_DIR
@@ -258,14 +258,14 @@ def next_snip_no():
                 snippet_replace_regex=[MASK_JAFFLE_PLATFORM],
             )
             check_file(
-                Path("jaffle_platform") / "components" / "jdbt" / "component.yaml",
+                Path("jaffle_platform") / "defs" / "jdbt" / "component.yaml",
                 COMPONENTS_SNIPPETS_DIR / f"{next_snip_no()}-component-jdbt.yaml",
                 update_snippets=update_snippets,
             )
 
             # Update component file, with error, check and fix
             create_file(
-                Path("jaffle_platform") / "components" / "jdbt" / "component.yaml",
+                Path("jaffle_platform") / "defs" / "jdbt" / "component.yaml",
                 snippet_path=COMPONENTS_SNIPPETS_DIR
                 / f"{next_snip_no()}-project-jdbt-incorrect.yaml",
                 contents=format_multiline("""
@@ -290,7 +290,7 @@ def next_snip_no():
             )
 
             create_file(
-                Path("jaffle_platform") / "components" / "jdbt" / "component.yaml",
+                Path("jaffle_platform") / "defs" / "jdbt" / "component.yaml",
                 snippet_path=COMPONENTS_SNIPPETS_DIR
                 / f"{next_snip_no()}-project-jdbt.yaml",
                 contents=format_multiline("""

examples/docs_beta_snippets/docs_beta_snippets_tests/snippet_checks/guides/components/test_components_docs_creating_a_component.py

@@ -139,18 +139,15 @@ def test_components_docs_index(
 
         check_file(
             Path("my_component_library")
-            / "components"
+            / "defs"
             / "my_shell_command"
             / "component.yaml",
             COMPONENTS_SNIPPETS_DIR
             / f"{get_next_snip_number()}-scaffolded-component.yaml",
             update_snippets=update_snippets,
         )
         check_file(
-            Path("my_component_library")
-            / "components"
-            / "my_shell_command"
-            / "script.sh",
+            Path("my_component_library") / "defs" / "my_shell_command" / "script.sh",
             COMPONENTS_SNIPPETS_DIR
             / f"{get_next_snip_number()}-scaffolded-component-script.sh",
             update_snippets=update_snippets,

examples/docs_beta_snippets/docs_beta_snippets_tests/snippet_checks/guides/components/test_components_docs_existing_project/test_existing_code_location.py

@@ -50,7 +50,7 @@ def test_components_docs_index(update_snippets: bool) -> None:
 
             [tool.dg.project]
             root_module = "my_existing_project"
-            components_module = "my_existing_project.components"
+            components_module = "my_existing_project.defs"
         """)
         pyproject_contents = pyproject_contents.replace(
             "[tool.dagster]", f"{tool_dg_section}\n\n[tool.dagster]"

examples/docs_beta_snippets/docs_beta_snippets_tests/snippet_checks/guides/components/test_components_docs_migrating_definitions/my-existing-project/pyproject.toml

@@ -24,7 +24,7 @@ directory_type = "project"
 
 [tool.dg.project]
 root_module = "my_existing_project"
-components_module = "my_existing_project.components"
+components_module = "my_existing_project.defs"
 
 [tool.dagster]
 module_name = "my_existing_project.definitions"

examples/docs_beta_snippets/docs_beta_snippets_tests/snippet_checks/guides/components/test_components_docs_migrating_definitions/test_migrating_definitions.py

@@ -39,7 +39,7 @@ def test_components_docs_migrating_definitions(update_snippets: bool) -> None:
         _run_command(
             r"find . -type d -name my_existing_project.egg-info -exec rm -r {} \+"
         )
-        _run_command("mkdir -p my_existing_project/components")
+        _run_command("mkdir -p my_existing_project/defs")
 
         run_command_and_snippet_output(
             cmd="tree",
@@ -69,17 +69,14 @@ def test_components_docs_migrating_definitions(update_snippets: bool) -> None:
         )
 
         run_command_and_snippet_output(
-            cmd="mv my_existing_project/elt/* my_existing_project/components/elt-definitions",
+            cmd="mv my_existing_project/elt/* my_existing_project/defs/elt-definitions",
             snippet_path=COMPONENTS_SNIPPETS_DIR / f"{get_next_snip_number()}-mv.txt",
             update_snippets=update_snippets,
         )
         _run_command("rm -rf my_existing_project/elt")
 
         create_file(
-            Path("my_existing_project")
-            / "components"
-            / "elt-definitions"
-            / "definitions.py",
+            Path("my_existing_project") / "defs" / "elt-definitions" / "definitions.py",
             format_multiline("""
                 import dagster as dg
 
@@ -97,10 +94,7 @@ def test_components_docs_migrating_definitions(update_snippets: bool) -> None:
         )
 
         create_file(
-            Path("my_existing_project")
-            / "components"
-            / "elt-definitions"
-            / "component.yaml",
+            Path("my_existing_project") / "defs" / "elt-definitions" / "component.yaml",
             format_multiline("""
             type: dagster_components.lib.DefinitionsComponent
 
@@ -130,7 +124,7 @@ def test_components_docs_migrating_definitions(update_snippets: bool) -> None:
                     jobs=[regenerate_analytics_job],
                     schedules=[regenerate_analytics_hourly_schedule],
                 ),
-                dg_components.build_component_defs(Path(__file__).parent / "components"),
+                dg_components.build_component_defs(Path(__file__).parent / "defs"),
             )
         """),
             COMPONENTS_SNIPPETS_DIR / f"{get_next_snip_number()}-definitions-after.py",
@@ -159,11 +153,11 @@ def test_components_docs_migrating_definitions(update_snippets: bool) -> None:
             cmd="dg scaffold component 'dagster_components.lib.DefinitionsComponent' analytics-definitions",
         )
         _run_command(
-            cmd="mv my_existing_project/analytics/* my_existing_project/components/analytics-definitions && rm -rf my_existing_project/analytics",
+            cmd="mv my_existing_project/analytics/* my_existing_project/defs/analytics-definitions && rm -rf my_existing_project/analytics",
         )
         create_file(
             Path("my_existing_project")
-            / "components"
+            / "defs"
             / "analytics-definitions"
             / "definitions.py",
             format_multiline("""
@@ -181,7 +175,7 @@ def test_components_docs_migrating_definitions(update_snippets: bool) -> None:
         )
         create_file(
             Path("my_existing_project")
-            / "components"
+            / "defs"
             / "analytics-definitions"
             / "component.yaml",
             format_multiline("""
@@ -211,7 +205,7 @@ def test_components_docs_migrating_definitions(update_snippets: bool) -> None:
 
                 import dagster_components as dg_components
 
-                defs = dg_components.build_component_defs(Path(__file__).parent / "components")
+                defs = dg_components.build_component_defs(Path(__file__).parent / "defs")
             """),
             COMPONENTS_SNIPPETS_DIR
             / f"{get_next_snip_number()}-definitions-after-all.py",

python_modules/libraries/dagster-components/dagster_components/core/component.py

@@ -268,7 +268,7 @@ def build_defs(self, context: ComponentLoadContext) -> Definitions:
         In a typical setup you end up with module names such as "a_project.components.my_component.my_python_file".
 
         This handles "__init__.py" files by ending the module name at the parent directory
-        (e.g "a_project.components.my_component") if the file resides at "a_project/components/my_component/__init__.py".
+        (e.g "a_project.components.my_component") if the file resides at "a_project/defs/my_component/__init__.py".
 
         This calls importlib.import_module with that module name, going through the python module import system.
 
@@ -281,7 +281,7 @@ def build_defs(self, context: ComponentLoadContext) -> Definitions:
             # Problematic
             # See https://linear.app/dagster-labs/issue/BUILD-736/highly-suspect-hardcoding-of-components-string-is-component-relative
             component_module_relative_path = abs_context_path.parts[
-                abs_context_path.parts.index("components") + 2 :
+                abs_context_path.parts.index("defs") + 2 :
             ]
             component_module_name = ".".join([self.module_name, *component_module_relative_path])
             if abs_file_path.name != "__init__.py":