File size: 1,917 Bytes
1fa3c6c | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 | # Copyright 2020-2026 The HuggingFace Team. All rights reserved.
#
# 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.
from abc import ABC, abstractmethod
from argparse import Namespace
from dataclasses import dataclass
@dataclass(slots=True)
class CommandContext:
"""Context shared by CLI commands during execution."""
argv: list[str]
def argv_after(self, token: str) -> list[str]:
"""
Return CLI tokens after the first occurrence of `token`.
Parameters:
token (`str`):
Subcommand name as it appears in `argv`.
"""
try:
index = self.argv.index(token)
except ValueError:
return []
return self.argv[index + 1 :]
class Command(ABC):
"""
Base command definition for the TRL CLI.
Parameters:
name (`str`):
Subcommand name exposed by the CLI.
help_text (`str`):
Short description displayed in help output.
"""
def __init__(self, name: str, help_text: str):
self.name = name
self.help_text = help_text
@abstractmethod
def register(self, subparsers) -> None:
"""Register this command parser in the subparser collection."""
@abstractmethod
def run(self, args: Namespace, context: CommandContext) -> int:
"""Execute the command."""
|