dagster-shared 1.11.8__tar.gz → 1.11.9__tar.gz

{dagster_shared-1.11.8/dagster_shared.egg-info → dagster_shared-1.11.9}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: dagster_shared
-Version: 1.11.8
+Version: 1.11.9
 Summary: Shared code between dagster and dagster-dg-core.
 Home-page: https://github.com/dagster-io/dagster/tree/master/python_modules/libraries/dagster-shared
 Author: Dagster Labs

{dagster_shared-1.11.8 → dagster_shared-1.11.9}/dagster_shared/plus/config.py

@@ -67,6 +67,64 @@ class DagsterPlusCliConfig:
         _, _, raw_plus_config, _ = result
         return cls(**raw_plus_config)
 
+    @classmethod
+    def create_for_deployment(
+        cls,
+        deployment: Optional[str],
+        organization: Optional[str] = None,
+        user_token: Optional[str] = None,
+    ) -> "DagsterPlusCliConfig":
+        """Create a DagsterPlusCliConfig instance for deployment-scoped operations.
+
+        Args:
+            deployment: The deployment name to target
+            organization: Organization name (if None, will try to load from existing config)
+            user_token: User token (if None, will try to load from existing config)
+        """
+        # Try to get base config if it exists, but don't require it
+        base_config = {}
+        if cls.exists():
+            try:
+                base_config = cls.get().__dict__
+            except Exception:
+                # If config exists but is invalid, start with empty base
+                pass
+
+        return cls(
+            url=base_config.get("url"),
+            organization=organization or base_config.get("organization"),
+            default_deployment=deployment,  # Override with specific deployment
+            user_token=user_token or base_config.get("user_token"),
+            agent_timeout=base_config.get("agent_timeout"),
+        )
+
+    @classmethod
+    def create_for_organization(
+        cls, organization: Optional[str] = None, user_token: Optional[str] = None
+    ) -> "DagsterPlusCliConfig":
+        """Create a DagsterPlusCliConfig instance for organization-scoped operations.
+
+        Args:
+            organization: Organization name (if None, will try to load from existing config)
+            user_token: User token (if None, will try to load from existing config)
+        """
+        # Try to get base config if it exists, but don't require it
+        base_config = {}
+        if cls.exists():
+            try:
+                base_config = cls.get().__dict__
+            except Exception:
+                # If config exists but is invalid, start with empty base
+                pass
+
+        return cls(
+            url=base_config.get("url"),
+            organization=organization or base_config.get("organization"),
+            default_deployment=None,  # No deployment for organization-scoped operations
+            user_token=user_token or base_config.get("user_token"),
+            agent_timeout=base_config.get("agent_timeout"),
+        )
+
     def write(self):
         existing_config = _get_dagster_plus_config_path_and_raw_config()
         if existing_config is None:

dagster_shared-1.11.9/dagster_shared/plus/config_utils.py

@@ -0,0 +1,186 @@
+import functools
+import os
+from typing import Optional
+
+import click
+
+from dagster_shared.plus.config import DagsterPlusCliConfig
+
+# Constants for CLI arguments and environment variables
+DEPLOYMENT_CLI_ARGUMENT = "deployment"
+DEPLOYMENT_ENV_VAR_NAME = "DAGSTER_CLOUD_DEPLOYMENT"
+
+ORGANIZATION_CLI_ARGUMENT = "organization"
+ORGANIZATION_ENV_VAR_NAME = "DAGSTER_CLOUD_ORGANIZATION"
+
+TOKEN_CLI_ARGUMENT = "api_token"
+TOKEN_ENV_VAR_NAME = "DAGSTER_CLOUD_API_TOKEN"
+
+
+def get_deployment(ctx: Optional[click.Context] = None) -> Optional[str]:
+    """Gets the configured deployment to target.
+    Highest precedence is a deployment argument, then `DAGSTER_CLOUD_DEPLOYMENT` env var, then config file default.
+    """
+    if ctx and ctx.params.get(DEPLOYMENT_CLI_ARGUMENT):
+        return ctx.params[DEPLOYMENT_CLI_ARGUMENT]
+
+    env_value = os.getenv(DEPLOYMENT_ENV_VAR_NAME)
+    if env_value:
+        return env_value
+
+    # Fall back to config file
+    if DagsterPlusCliConfig.exists():
+        try:
+            config = DagsterPlusCliConfig.get()
+            return config.default_deployment
+        except Exception:
+            pass
+
+    return None
+
+
+def get_organization(ctx: Optional[click.Context] = None) -> Optional[str]:
+    """Gets the configured organization to target.
+    Highest precedence is an organization argument, then `DAGSTER_CLOUD_ORGANIZATION` env var, then config file.
+    """
+    if ctx and ctx.params.get(ORGANIZATION_CLI_ARGUMENT):
+        return ctx.params[ORGANIZATION_CLI_ARGUMENT]
+
+    env_value = os.getenv(ORGANIZATION_ENV_VAR_NAME)
+    if env_value:
+        return env_value
+
+    # Fall back to config file
+    if DagsterPlusCliConfig.exists():
+        try:
+            config = DagsterPlusCliConfig.get()
+            return config.organization
+        except Exception:
+            pass
+
+    return None
+
+
+def get_user_token(ctx: Optional[click.Context] = None) -> Optional[str]:
+    """Gets the configured user token to use.
+    Highest precedence is an api-token argument, then `DAGSTER_CLOUD_API_TOKEN` env var, then config file.
+    """
+    if ctx and ctx.params.get(TOKEN_CLI_ARGUMENT):
+        return ctx.params[TOKEN_CLI_ARGUMENT]
+
+    env_value = os.getenv(TOKEN_ENV_VAR_NAME)
+    if env_value:
+        return env_value
+
+    # Fall back to config file
+    if DagsterPlusCliConfig.exists():
+        try:
+            config = DagsterPlusCliConfig.get()
+            return config.user_token
+        except Exception:
+            pass
+
+    return None
+
+
+# Click option definitions for reuse across commands
+DEPLOYMENT_OPTION = click.option(
+    "--deployment",
+    "-d",
+    help="Deployment to target.",
+    envvar=DEPLOYMENT_ENV_VAR_NAME,
+)
+
+ORGANIZATION_OPTION = click.option(
+    "--organization",
+    "-o",
+    help="Organization to target.",
+    envvar=ORGANIZATION_ENV_VAR_NAME,
+)
+
+TOKEN_OPTION = click.option(
+    "--api-token",
+    help="Dagster Cloud API token.",
+    envvar=TOKEN_ENV_VAR_NAME,
+)
+
+VIEW_GRAPHQL_OPTION = click.option(
+    "--view-graphql",
+    is_flag=True,
+    help="Print GraphQL queries and responses to stderr for debugging.",
+)
+
+
+def dg_api_options(
+    deployment_scoped: bool = False,
+    organization_scoped: bool = False,
+):
+    """Apply this decorator to Click commands to add organization, deployment, and token options.
+
+    Args:
+        deployment_scoped: If True, requires deployment to be specified and validates it
+        organization_scoped: If True, only requires organization (deployment is optional)
+    """
+    if deployment_scoped and organization_scoped:
+        raise ValueError("Cannot specify both deployment_scoped and organization_scoped")
+
+    if not deployment_scoped and not organization_scoped:
+        raise ValueError("Must specify either deployment_scoped or organization_scoped")
+
+    def decorator(func):
+        # Add options in reverse order (Click applies them in reverse)
+        func = VIEW_GRAPHQL_OPTION(func)
+        func = TOKEN_OPTION(func)
+        func = ORGANIZATION_OPTION(func)
+
+        if deployment_scoped:
+            func = DEPLOYMENT_OPTION(func)
+
+        @functools.wraps(func)
+        def wrapper(*args, **kwargs):
+            ctx = click.get_current_context()
+
+            # Check if we're in test mode with DgApiTestContext
+            # Import here to avoid circular imports
+            from dagster_dg_cli.cli.api.client import DgApiTestContext
+
+            if ctx.obj and isinstance(ctx.obj, DgApiTestContext):
+                organization = ctx.obj.organization
+                deployment = ctx.obj.deployment if deployment_scoped else None
+                api_token = None
+                view_graphql = False  # Default to False in test mode
+            else:
+                # Get resolved values using precedence chain
+                organization = get_organization(ctx)
+                deployment = get_deployment(ctx) if deployment_scoped else None
+                api_token = get_user_token(ctx)
+                view_graphql = kwargs.get("view_graphql", False)
+
+            if not organization:
+                raise click.UsageError(
+                    "A Dagster Cloud organization must be specified.\n\n"
+                    "You may specify an organization by:\n"
+                    f"- Providing the --organization parameter\n"
+                    f"- Setting the {ORGANIZATION_ENV_VAR_NAME} environment variable"
+                )
+
+            if deployment_scoped and not deployment:
+                raise click.UsageError(
+                    "A Dagster Cloud deployment must be specified for this command.\n\n"
+                    "You may specify a deployment by:\n"
+                    f"- Providing the --deployment parameter\n"
+                    f"- Setting the {DEPLOYMENT_ENV_VAR_NAME} environment variable"
+                )
+
+            # Update kwargs with resolved values
+            kwargs["organization"] = organization
+            kwargs["api_token"] = api_token
+            kwargs["view_graphql"] = view_graphql
+            if deployment_scoped:
+                kwargs["deployment"] = deployment
+
+            return func(*args, **kwargs)
+
+        return wrapper
+
+    return decorator

dagster_shared-1.11.9/dagster_shared/version.py

@@ -0,0 +1 @@
+__version__ = "1.11.9"

{dagster_shared-1.11.8 → dagster_shared-1.11.9/dagster_shared.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: dagster_shared
-Version: 1.11.8
+Version: 1.11.9
 Summary: Shared code between dagster and dagster-dg-core.
 Home-page: https://github.com/dagster-io/dagster/tree/master/python_modules/libraries/dagster-shared
 Author: Dagster Labs

{dagster_shared-1.11.8 → dagster_shared-1.11.9}/dagster_shared.egg-info/SOURCES.txt

@@ -29,6 +29,7 @@ dagster_shared/dagster_model/pydantic_compat_layer.py
 dagster_shared/libraries/__init__.py
 dagster_shared/plus/__init__.py
 dagster_shared/plus/config.py
+dagster_shared/plus/config_utils.py
 dagster_shared/plus/login_server.py
 dagster_shared/record/__init__.py
 dagster_shared/scaffold/__init__.py

dagster_shared-1.11.8/dagster_shared/version.py

@@ -1 +0,0 @@
-__version__ = "1.11.8"