Skip to content

Commit

Permalink
feat(cli.project): enable optional minimalist configuration in templates
Browse files Browse the repository at this point in the history
PEP 621 (Nov 2020) introduced pyproject.toml.
Setuptools is fully compatible with pyroject Completes dagster config in project template.
Minimalist config to make adopting dagster easy.
  • Loading branch information
dbrtly committed Oct 12, 2024
1 parent a32d733 commit 1495a52
Show file tree
Hide file tree
Showing 3 changed files with 20 additions and 6 deletions.
11 changes: 9 additions & 2 deletions python_modules/dagster/dagster/_cli/project.py
Original file line number Diff line number Diff line change
Expand Up @@ -117,7 +117,14 @@ def scaffold_repository_command(name: str):
type=click.STRING,
help="Name of the new Dagster code location",
)
def scaffold_code_location_command(name: str):
@click.option(
'--skip-files',
multiple=True,
type=click.STRING,
default=[""],
help="exclude file patterns from the project template",
)
def scaffold_code_location_command(name: str, skip_files: list):
dir_abspath = os.path.abspath(name)
if os.path.isdir(dir_abspath) and os.path.exists(dir_abspath):
click.echo(
Expand All @@ -126,7 +133,7 @@ def scaffold_code_location_command(name: str):
)
sys.exit(1)

generate_code_location(dir_abspath)
generate_code_location(dir_abspath, skip_files)
click.echo(_styled_success_statement(name, dir_abspath))


Expand Down
10 changes: 7 additions & 3 deletions python_modules/dagster/dagster/_generate/generate.py
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ def generate_repository(path: str):
click.echo(f"Generated files for Dagster repository in {path}.")


def generate_code_location(path: str):
def generate_code_location(path: str, skip_files: list = []):
CODE_LOCATION_NAME_PLACEHOLDER = "CODE_LOCATION_NAME_PLACEHOLDER"

click.echo(f"Creating a Dagster code location at {path}.")
Expand All @@ -38,6 +38,7 @@ def generate_code_location(path: str):
project_template_path=os.path.join(
os.path.dirname(__file__), "templates", CODE_LOCATION_NAME_PLACEHOLDER
),
skip_files=skip_files,
)

click.echo(f"Generated files for Dagster code location in {path}.")
Expand Down Expand Up @@ -65,7 +66,7 @@ def generate_project(path: str):


def _generate_files_from_template(
path: str, name_placeholder: str, project_template_path: str, skip_mkdir: bool = False
path: str, name_placeholder: str, project_template_path: str, skip_mkdir: bool = False, skip_files: list = []
):
normalized_path = os.path.normpath(path)
code_location_name = os.path.basename(normalized_path).replace("-", "_")
Expand Down Expand Up @@ -124,12 +125,15 @@ def _generate_files_from_template(
f.write("\n")


def _should_skip_file(path):
def _should_skip_file(path: str, skip_files: list):
"""Given a file path `path` in a source template, returns whether or not the file should be skipped
when generating destination files.
Technically, `path` could also be a directory path that should be skipped.
"""
if skip_files: # for minimalist dagster projects from templates
IGNORE_PATTERN_LIST.extend(skip_files)

for pattern in IGNORE_PATTERN_LIST:
if pattern in path:
return True
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,14 +11,17 @@ dependencies = [

[project.optional-dependencies]
dev = [
"dagster-webserver",
"dagster-webserver",
"pytest",
]

[build-system]
requires = ["setuptools"]
build-backend = "setuptools.build_meta"

[tool.setuptools.packages.find]
exclude=["{{ code_location_name }}_tests"]

[tool.dagster]
module_name = "{{ code_location_name }}.definitions"
code_location_name = "{{ code_location_name }}"

0 comments on commit 1495a52

Please sign in to comment.