Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

allow arbitrary expressions as job parameters #247

Merged
merged 3 commits into from
Nov 1, 2022
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 12 additions & 14 deletions jupyter_scheduler/models.py
Original file line number Diff line number Diff line change
@@ -1,12 +1,10 @@
import os
from enum import Enum
from typing import Dict, List, Optional, Union
from typing import Any, Dict, List, Optional

from pydantic import BaseModel, root_validator

Tags = List[str]
ParameterValues = Union[int, str, float, bool]
EnvironmentParameterValues = Union[int, str, float, bool]

EMAIL_RE = ""
SCHEDULE_RE = ""
Expand Down Expand Up @@ -76,11 +74,11 @@ class CreateJob(BaseModel):
input_uri: str
input_filename: str = None
runtime_environment_name: str
runtime_environment_parameters: Optional[Dict[str, EnvironmentParameterValues]]
runtime_environment_parameters: Optional[Dict[str, Any]]
dlqqq marked this conversation as resolved.
Show resolved Hide resolved
output_formats: Optional[List[str]] = None
idempotency_token: Optional[str] = None
job_definition_id: Optional[str] = None
parameters: Optional[Dict[str, ParameterValues]] = None
parameters: Optional[Dict[str, str]] = None
tags: Optional[Tags] = None
name: Optional[str] = None
output_filename_template: Optional[str] = OUTPUT_FILENAME_TEMPLATE
Expand Down Expand Up @@ -126,11 +124,11 @@ class JobFile(BaseModel):
class DescribeJob(BaseModel):
input_filename: str = None
runtime_environment_name: str
runtime_environment_parameters: Optional[Dict[str, EnvironmentParameterValues]]
runtime_environment_parameters: Optional[Dict[str, Any]]
dlqqq marked this conversation as resolved.
Show resolved Hide resolved
output_formats: Optional[List[str]] = None
idempotency_token: Optional[str] = None
job_definition_id: Optional[str] = None
parameters: Optional[Dict[str, ParameterValues]] = None
parameters: Optional[Dict[str, str]] = None
tags: Optional[Tags] = None
name: Optional[str] = None
output_filename_template: Optional[str] = OUTPUT_FILENAME_TEMPLATE
Expand Down Expand Up @@ -200,9 +198,9 @@ class CreateJobDefinition(BaseModel):
input_uri: str
input_filename: str = None
runtime_environment_name: str
runtime_environment_parameters: Optional[Dict[str, EnvironmentParameterValues]]
runtime_environment_parameters: Optional[Dict[str, Any]]
dlqqq marked this conversation as resolved.
Show resolved Hide resolved
output_formats: Optional[List[str]] = None
parameters: Optional[Dict[str, ParameterValues]] = None
parameters: Optional[Dict[str, str]] = None
tags: Optional[Tags] = None
name: Optional[str] = None
output_filename_template: Optional[str] = OUTPUT_FILENAME_TEMPLATE
Expand All @@ -221,9 +219,9 @@ def compute_input_filename(cls, values) -> Dict:
class DescribeJobDefinition(BaseModel):
input_filename: str = None
runtime_environment_name: str
runtime_environment_parameters: Optional[Dict[str, EnvironmentParameterValues]]
runtime_environment_parameters: Optional[Dict[str, Any]]
dlqqq marked this conversation as resolved.
Show resolved Hide resolved
output_formats: Optional[List[str]] = None
parameters: Optional[Dict[str, ParameterValues]] = None
parameters: Optional[Dict[str, str]] = None
tags: Optional[Tags] = None
name: Optional[str] = None
output_filename_template: Optional[str] = OUTPUT_FILENAME_TEMPLATE
Expand All @@ -241,9 +239,9 @@ class Config:

class UpdateJobDefinition(BaseModel):
runtime_environment_name: Optional[str]
runtime_environment_parameters: Optional[Dict[str, EnvironmentParameterValues]]
runtime_environment_parameters: Optional[Dict[str, Any]]
dlqqq marked this conversation as resolved.
Show resolved Hide resolved
output_formats: Optional[List[str]] = None
parameters: Optional[Dict[str, ParameterValues]] = None
parameters: Optional[Dict[str, str]] = None
tags: Optional[Tags] = None
name: Optional[str] = None
url: Optional[str] = None
Expand All @@ -270,7 +268,7 @@ class ListJobDefinitionsResponse(BaseModel):


class CreateJobFromDefinition(BaseModel):
parameters: Optional[Dict[str, ParameterValues]] = None
parameters: Optional[Dict[str, str]] = None


class JobFeature(str, Enum):
Expand Down
8 changes: 2 additions & 6 deletions jupyter_scheduler/parameterize.py
Original file line number Diff line number Diff line change
Expand Up @@ -2,18 +2,14 @@

from nbformat import NotebookNode, v4

from jupyter_scheduler.models import ParameterValues
from jupyter_scheduler.utils import find_cell_index_with_tag


def add_parameters(nb: NotebookNode, parameters: Dict[str, ParameterValues]) -> NotebookNode:
def add_parameters(nb: NotebookNode, parameters: Dict[str, str]) -> NotebookNode:
content = []

for key, value in parameters.items():
if type(value) == str:
content.append(f"{key} = '{value}'")
else:
content.append(f"{key} = {value}")
content.append(f"{key} = {value}")

new_cell = v4.new_code_cell(source="\n".join(content))
new_cell.metadata["tags"] = ["injected-parameters"]
Expand Down
6 changes: 2 additions & 4 deletions src/handler.ts
Original file line number Diff line number Diff line change
Expand Up @@ -331,10 +331,8 @@ export namespace SchedulerService {
}

export namespace Scheduler {
export type RuntimeEnvironmentParameters = {
[key: string]: number | string | boolean;
};
export type Parameters = { [key: string]: number | string | boolean };
export type RuntimeEnvironmentParameters = Record<string, any>;
dlqqq marked this conversation as resolved.
Show resolved Hide resolved
export type Parameters = Record<string, string>;

export interface ICreateJobDefinition {
input_uri: string;
Expand Down