[components] Break dagster-components into separate package (#26237)

## Summary & Motivation

Breaks components code into a new `dagster-components` package that will
be published independently of the main Dagster release cycle. For now,
`dagster-components` also includes the `dg` CLI tool.

Because this is placed in `examples/experimental` rather than a
directory containing by-default published packages, no modifications are
required to the release machinery to prevent its publication.

## How I Tested These Changes

Existing test suite after moving everything over.

examples/experimental/components/examples/hello_world_deployment/code_locations/hello_world/hello_world/definitions.py

@@ -1,8 +1,8 @@
 from pathlib import Path
 
 import dagster as dg
-from dagster._components import ComponentRegistry, build_defs_from_toplevel_components_folder
-from dagster._components.impls.pipes_subprocess_script_collection import (
+from dagster_components import ComponentRegistry, build_defs_from_toplevel_components_folder
+from dagster_components.impls.pipes_subprocess_script_collection import (
     PipesSubprocessScriptCollection,
 )
 

examples/experimental/dagster-components/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "{}"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2023 Dagster Labs, Inc.
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

examples/experimental/dagster-components/MANIFEST.in

@@ -0,0 +1,3 @@
+include README.md
+include LICENSE
+include dagster_components/py.typed

examples/experimental/dagster-components/README.md

@@ -0,0 +1,4 @@
+# dagster-components
+
+Experimental API for defining Dagster definitions factories ("components").
+Includes the `dg` CLI tool.

python_modules/dagster/dagster/_components/__init__.py → examples/experimental/dagster-components/dagster_components/__init__.py

@@ -1,8 +1,8 @@
-from dagster._components.core.component import (
+from dagster_components.core.component import (
     Component as Component,
     ComponentLoadContext as ComponentLoadContext,
     ComponentRegistry as ComponentRegistry,
 )
-from dagster._components.core.component_defs_builder import (
+from dagster_components.core.component_defs_builder import (
     build_defs_from_toplevel_components_folder as build_defs_from_toplevel_components_folder,
 )

python_modules/dagster/dagster/_components/cli/__init__.py → examples/experimental/dagster-components/dagster_components/cli/__init__.py

@@ -1,8 +1,8 @@
 import click
-
-from dagster._components.cli.generate import generate_cli
 from dagster.version import __version__
 
+from dagster_components.cli.generate import generate_cli
+
 
 def create_dagster_components_cli():
     commands = {

python_modules/dagster/dagster/_components/cli/generate.py → examples/experimental/dagster-components/dagster_components/cli/generate.py

@@ -4,14 +4,14 @@
 
 import click
 
-from dagster._components.core.component import ComponentRegistry
-from dagster._components.core.deployment import (
+from dagster_components.core.component import ComponentRegistry
+from dagster_components.core.deployment import (
     CodeLocationProjectContext,
     DeploymentProjectContext,
     is_inside_code_location_project,
     is_inside_deployment_project,
 )
-from dagster._generate.generate import (
+from dagster_components.generate import (
     generate_code_location,
     generate_component_instance,
     generate_component_type,

python_modules/dagster/dagster/_components/core/component.py → examples/experimental/dagster-components/dagster_components/core/component.py

@@ -2,10 +2,9 @@
 from types import ModuleType
 from typing import TYPE_CHECKING, ClassVar, Dict, Iterable, Mapping, Optional, Type
 
-from typing_extensions import Self
-
 from dagster._core.errors import DagsterError
 from dagster._utils import snakecase
+from typing_extensions import Self
 
 if TYPE_CHECKING:
     from dagster._core.definitions.definitions_class import Definitions

python_modules/dagster/dagster/_components/core/component_decl_builder.py → examples/experimental/dagster-components/dagster_components/core/component_decl_builder.py

@@ -1,11 +1,11 @@
 from pathlib import Path
 from typing import Any, Mapping, Optional, Sequence, Union
 
-from pydantic import BaseModel
-
-from dagster._components.core.component import ComponentDeclNode
 from dagster._record import record
 from dagster._utils.pydantic_yaml import parse_yaml_file_to_pydantic
+from pydantic import BaseModel
+
+from dagster_components.core.component import ComponentDeclNode
 
 
 class DefsFileModel(BaseModel):

python_modules/dagster/dagster/_components/core/component_defs_builder.py → examples/experimental/dagster-components/dagster_components/core/component_defs_builder.py

@@ -1,14 +1,15 @@
 from pathlib import Path
 from typing import TYPE_CHECKING, List, Mapping, Optional, Sequence
 
-from dagster._components.core.component import Component, ComponentLoadContext, ComponentRegistry
-from dagster._components.core.component_decl_builder import (
+from dagster._utils.warnings import suppress_dagster_warnings
+
+from dagster_components.core.component import Component, ComponentLoadContext, ComponentRegistry
+from dagster_components.core.component_decl_builder import (
     ComponentFolder,
     YamlComponentDecl,
     find_component_decl,
 )
-from dagster._components.core.deployment import CodeLocationProjectContext
-from dagster._utils.warnings import suppress_dagster_warnings
+from dagster_components.core.deployment import CodeLocationProjectContext
 
 if TYPE_CHECKING:
     from dagster._core.definitions.definitions_class import Definitions

python_modules/dagster/dagster/_components/core/deployment.py → examples/experimental/dagster-components/dagster_components/core/deployment.py

@@ -4,14 +4,14 @@
 from pathlib import Path
 from typing import Final, Iterable, Type
 
+from dagster._core.errors import DagsterError
 from typing_extensions import Self
 
-from dagster._components.core.component import (
+from dagster_components.core.component import (
     Component,
     ComponentRegistry,
     register_components_in_module,
 )
-from dagster._core.errors import DagsterError
 
 
 def is_inside_deployment_project(path: Path) -> bool:

examples/experimental/dagster-components/dagster_components/generate.py

@@ -0,0 +1,61 @@
+import os
+from typing import Type
+
+import click
+from dagster._generate.generate import generate_project
+from dagster._utils import camelcase, pushd
+
+from dagster_components.core.component import Component
+
+
+def generate_deployment(path: str) -> None:
+    click.echo(f"Creating a Dagster deployment at {path}.")
+
+    generate_project(
+        path=path,
+        name_placeholder="DEPLOYMENT_NAME_PLACEHOLDER",
+        templates_path=os.path.join(
+            os.path.dirname(__file__), "templates", "DEPLOYMENT_NAME_PLACEHOLDER"
+        ),
+    )
+
+
+def generate_code_location(path: str) -> None:
+    click.echo(f"Creating a Dagster code location at {path}.")
+
+    generate_project(
+        path=path,
+        name_placeholder="CODE_LOCATION_NAME_PLACEHOLDER",
+        templates_path=os.path.join(
+            os.path.dirname(__file__), "templates", "CODE_LOCATION_NAME_PLACEHOLDER"
+        ),
+    )
+
+
+def generate_component_type(root_path: str, name: str) -> None:
+    click.echo(f"Creating a Dagster component type at {root_path}/{name}.py.")
+
+    generate_project(
+        path=root_path,
+        name_placeholder="COMPONENT_TYPE_NAME_PLACEHOLDER",
+        templates_path=os.path.join(os.path.dirname(__file__), "templates", "COMPONENT_TYPE"),
+        project_name=name,
+        component_type_class_name=camelcase(name),
+    )
+
+
+def generate_component_instance(root_path: str, name: str, component_type: Type[Component]) -> None:
+    click.echo(f"Creating a Dagster component instance at {root_path}/{name}.py.")
+
+    component_instance_root_path = os.path.join(root_path, name)
+    generate_project(
+        path=component_instance_root_path,
+        name_placeholder="COMPONENT_INSTANCE_NAME_PLACEHOLDER",
+        templates_path=os.path.join(
+            os.path.dirname(__file__), "templates", "COMPONENT_INSTANCE_NAME_PLACEHOLDER"
+        ),
+        project_name=name,
+        component_type=component_type.registered_name(),
+    )
+    with pushd(component_instance_root_path):
+        component_type.generate_files()