xpk 0.17.2__py3-none-any.whl → 0.17.3__py3-none-any.whl

xpk/commands/shell.py

@@ -1,142 +0,0 @@
-"""
-Copyright 2024 Google LLC
-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
-     https://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.
-"""
-
-from ..core.commands import run_command_with_full_controls, run_command_for_value, run_command_with_updates
-from ..core.cluster import get_cluster_credentials, add_zone_and_project, setup_k8s_service_accounts
-from ..utils.console import xpk_exit, xpk_print
-from ..utils.validation import validate_dependencies_list, SystemDependency, should_validate_dependencies
-from argparse import Namespace
-
-from ..core.kjob import (
-    AppProfileDefaults,
-    prepare_kjob,
-    get_pod_template_interactive_command,
-    get_storage_annotations,
-)
-
-exit_instructions = 'To exit the shell input "exit".'
-
-
-def shell(args: Namespace):
-  """Enter interactive shell.
-  Args:
-    args: user provided arguments for running the command.
-  Returns:
-    0 if successful and 1 otherwise.
-  """
-  if should_validate_dependencies(args):
-    validate_dependencies_list([
-        SystemDependency.KUBECTL,
-        SystemDependency.KJOB,
-        SystemDependency.GCLOUD,
-    ])
-  exisitng_shell_pod_name = get_existing_shell_pod_name(args)
-
-  if exisitng_shell_pod_name is None:
-    return_code = connect_to_new_interactive_shell(args)
-  else:
-    return_code = connect_to_existing_interactive_shell(exisitng_shell_pod_name)
-
-  if return_code != 0:
-    xpk_print(f'The command failed with code {return_code}.')
-    xpk_exit(return_code)
-
-  xpk_exit(0)
-
-
-def get_existing_shell_pod_name(args: Namespace) -> str | None:
-  if not args.kind_cluster:
-    add_zone_and_project(args)
-    get_cluster_credentials(args)
-
-  return_code, shell_name = run_command_for_value(
-      command=(
-          'kubectl get pods --no-headers --field-selector status.phase=Running'
-          ' -o custom-columns=":metadata.name"'
-      ),
-      task='Get existing interactive shell pod name.',
-  )
-  if return_code != 0:
-    xpk_print(
-        f'Encounter an error with a code {return_code} when checking for'
-        ' existing running shell.'
-    )
-    xpk_exit(return_code)
-
-  pod_names = shell_name.strip().split('\n')
-  kjob_pod_names = [
-      name for name in pod_names if AppProfileDefaults.NAME.value in name
-  ]
-  shell_pod_names = [name for name in kjob_pod_names if 'interactive' in name]
-
-  return shell_pod_names[0] if shell_pod_names else None
-
-
-def connect_to_new_interactive_shell(args: Namespace) -> int:
-  err_code = prepare_kjob(args)
-  if err_code > 0:
-    xpk_exit(err_code)
-  setup_k8s_service_accounts()
-
-  cmd = (
-      'kubectl-kjob create interactive --profile'
-      f' {AppProfileDefaults.NAME.value} --pod-running-timeout 180s'
-  )
-
-  for annotation in get_storage_annotations(args):
-    cmd += f' --pod-template-annotation {annotation}'
-
-  return run_command_with_full_controls(
-      command=cmd,
-      task='Creating new interactive shell and entering it',
-      instructions=exit_instructions,
-  )
-
-
-def connect_to_existing_interactive_shell(pod_name: str) -> int:
-  return run_command_with_full_controls(
-      command=(
-          f'kubectl exec --stdin --tty {pod_name} --'
-          f' {get_pod_template_interactive_command()}'
-      ),
-      task='Entering existing interactive shell',
-      instructions=exit_instructions,
-  )
-
-
-def shell_stop(args: Namespace):
-  """Stop the running interactive shell by deleting the pod.
-  Args:
-    args: user provided arguments for running the command.
-  Returns:
-    0 if successful and 1 otherwise.
-  """
-  if should_validate_dependencies(args):
-    validate_dependencies_list(
-        [SystemDependency.KUBECTL, SystemDependency.GCLOUD]
-    )
-  exisitng_shell_pod_name = get_existing_shell_pod_name(args)
-
-  if exisitng_shell_pod_name is None:
-    xpk_print('There is no shell running to stop')
-    xpk_exit(0)
-
-  return_code = run_command_with_updates(
-      command=f'kubectl delete pod {exisitng_shell_pod_name}',
-      task='Deleting the existing shell.',
-  )
-  if return_code != 0:
-    xpk_exit(return_code)
-
-  xpk_print('The shell was deleted successfully.')
-  xpk_exit(0)

xpk/parser/batch.py

@@ -1,43 +0,0 @@
-"""
-Copyright 2024 Google LLC
-
-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
-
-     https://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.
-"""
-
-from .common import (
-    add_shared_arguments,
-    add_slurm_arguments,
-    add_cluster_arguments,
-    add_kind_cluster_arguments,
-)
-from ..commands.batch import batch
-
-
-def set_batch_parser(batch_parser):
-  batch_required_arguments = batch_parser.add_argument_group(
-      'batch Built-in Arguments', 'Arguments required for `batch`.'
-  )
-  batch_optional_arguments = batch_parser.add_argument_group(
-      'Optional Arguments', 'Arguments optional for `batch`.'
-  )
-
-  ### "batch" Required arguments
-  batch_required_arguments.add_argument(
-      'script', help='script with batch task to run'
-  )
-
-  add_cluster_arguments(batch_optional_arguments)
-  add_kind_cluster_arguments(batch_optional_arguments)
-  add_shared_arguments(batch_optional_arguments)
-  add_slurm_arguments(batch_optional_arguments)
-  batch_parser.set_defaults(func=batch)

xpk/parser/job.py

@@ -1,147 +0,0 @@
-"""
-Copyright 2024 Google LLC
-
-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
-
-     https://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.
-"""
-
-import argparse
-from ..commands.job import job_info, job_list, job_cancel
-
-from .common import add_shared_arguments
-from .validators import name_type
-
-
-def set_job_parser(job_parser: argparse.ArgumentParser):
-  job_subcommands = job_parser.add_subparsers(
-      title='job subcommands',
-      dest='xpk_job_subcommands',
-      help=(
-          'These are commands related to job management. Look at help for'
-          ' specific subcommands for more details.'
-      ),
-  )
-  set_job_info_parser(
-      job_info_parser=job_subcommands.add_parser(
-          'info', help='Show information about specified job.'
-      )
-  )
-  set_job_list_parser(
-      job_list_parser=job_subcommands.add_parser('ls', help='List jobs.')
-  )
-  set_job_cancel_parser(
-      job_cancel_parser=job_subcommands.add_parser(
-          'cancel', help='Cancel job execution.'
-      )
-  )
-
-
-def set_job_info_parser(job_info_parser: argparse.ArgumentParser):
-  job_info_required_arguments = job_info_parser.add_argument_group(
-      'Required arguments',
-      'The basic information required to identify the job.',
-  )
-  job_info_optional_arguments = job_info_parser.add_argument_group(
-      'Optional Arguments', 'Arguments optional for job info.'
-  )
-
-  ### Required arguments
-  job_info_required_arguments.add_argument(
-      '--cluster',
-      type=name_type,
-      default=None,
-      help='The name of the cluster to info jobs on.',
-      required=True,
-  )
-
-  job_info_optional_arguments.add_argument(
-      '--kind-cluster',
-      type=bool,
-      action=argparse.BooleanOptionalAction,
-      default=False,
-      help='Apply command to a local test cluster.',
-  )
-  job_info_required_arguments.add_argument(
-      'name',
-      type=str,
-      default=None,
-      help='Name of the job.',
-  )
-  job_info_parser.set_defaults(func=job_info)
-  add_shared_arguments(job_info_parser)
-
-
-def set_job_list_parser(job_list_parser: argparse.ArgumentParser):
-  job_list_required_arguments = job_list_parser.add_argument_group(
-      'Required Arguments',
-      'Arguments required for job list.',
-  )
-  job_list_optional_arguments = job_list_parser.add_argument_group(
-      'Optional Arguments', 'Arguments optional for job list.'
-  )
-
-  ### Required arguments
-  job_list_required_arguments.add_argument(
-      '--cluster',
-      type=name_type,
-      default=None,
-      help='The name of the cluster to list jobs on.',
-      required=True,
-  )
-
-  job_list_optional_arguments.add_argument(
-      '--kind-cluster',
-      type=bool,
-      action=argparse.BooleanOptionalAction,
-      default=False,
-      help='Apply command to a local test cluster.',
-  )
-
-  job_list_parser.set_defaults(func=job_list)
-  add_shared_arguments(job_list_optional_arguments)
-
-
-def set_job_cancel_parser(job_cancel_parser: argparse.ArgumentParser):
-  job_cancel_required_arguments = job_cancel_parser.add_argument_group(
-      'Required Arguments',
-      'Arguments required for job cancel.',
-  )
-  job_cancel_optional_arguments = job_cancel_parser.add_argument_group(
-      'Optional Arguments', 'Arguments optional for job cancel.'
-  )
-
-  job_cancel_required_arguments.add_argument(
-      'name',
-      type=str,
-      default=None,
-      help='The name of the job to be cancelled.',
-      nargs='+',
-  )
-
-  job_cancel_required_arguments.add_argument(
-      '--cluster',
-      type=name_type,
-      default=None,
-      help='The name of the cluster to delete the job on.',
-      required=True,
-  )
-
-  job_cancel_optional_arguments.add_argument(
-      '--kind-cluster',
-      type=bool,
-      action=argparse.BooleanOptionalAction,
-      default=False,
-      help='Apply command to a local test cluster.',
-  )
-
-  job_cancel_parser.set_defaults(func=job_cancel)
-  add_shared_arguments(job_cancel_optional_arguments)

xpk/parser/run.py

@@ -1,47 +0,0 @@
-"""
-Copyright 2025 Google LLC
-
-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
-
-     https://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.
-"""
-
-from ..commands.run import run
-from .common import (
-    add_shared_arguments,
-    add_slurm_arguments,
-    add_cluster_arguments,
-    add_kind_cluster_arguments,
-)
-
-
-def set_run_parser(run_parser):
-  run_required_arguments = run_parser.add_argument_group(
-      'Required Arguments', 'Arguments required for `run`.'
-  )
-  run_optional_arguments = run_parser.add_argument_group(
-      'Optional Arguments', 'Arguments optional for `run`.'
-  )
-
-  run_required_arguments.add_argument('script', help='script with task to run')
-  run_optional_arguments.add_argument(
-      '--timeout',
-      type=int,
-      default=None,
-      help='Amount of time to wait for job in seconds',
-      required=False,
-  )
-
-  add_cluster_arguments(run_optional_arguments)
-  add_kind_cluster_arguments(run_optional_arguments)
-  add_slurm_arguments(run_optional_arguments)
-  add_shared_arguments(run_parser)
-  run_parser.set_defaults(func=run)

xpk/parser/shell.py

@@ -1,59 +0,0 @@
-"""
-Copyright 2024 Google LLC
-
-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
-
-     https://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.
-"""
-
-from ..commands.shell import shell, shell_stop
-from .common import (
-    add_shared_arguments,
-    add_cluster_arguments,
-    add_kind_cluster_arguments,
-)
-import argparse
-
-
-def set_shell_parser(shell_parser: argparse.ArgumentParser) -> None:
-  shell_optional_arguments = shell_parser.add_argument_group(
-      'Optional Arguments', 'Arguments optional for shell.'
-  )
-  add_shared_arguments(shell_optional_arguments)
-  shell_parser.set_defaults(func=shell)
-
-  add_cluster_arguments(shell_optional_arguments)
-  add_kind_cluster_arguments(shell_optional_arguments)
-
-  shell_subcommands = shell_parser.add_subparsers(
-      title='shell subcommands',
-      dest='xpk_shell_subcommands',
-      help=(
-          'These are commands related to interactive shell. Look at help for'
-          ' specific subcommands for more details.'
-      ),
-  )
-
-  set_shell_stop_parser(
-      shell_stop_parser=shell_subcommands.add_parser(
-          name='stop', help='Stop the running shell.'
-      )
-  )
-
-
-def set_shell_stop_parser(shell_stop_parser: argparse.ArgumentParser):
-  shell_stop_optional_arguments = shell_stop_parser.add_argument_group(
-      'Optional Arguments', 'Arguments optional for shell stop.'
-  )
-  add_shared_arguments(shell_stop_optional_arguments)
-  shell_stop_parser.set_defaults(func=shell_stop)
-  add_cluster_arguments(shell_stop_parser)
-  add_kind_cluster_arguments(shell_stop_optional_arguments)