Files
portfolio-hub/app/cli/commands/user.py
T
genichin 7bcf5cbb2b docs: update CLI documentation to use username instead of user-id
CLI Changes:
- Update user.get command to accept username parameter instead of user-id
- Update user.update command signature in documentation
- Update user.delete command signature in documentation

Implementation Consistency:
- Align README.md CLI examples with app/cli/commands/user.py implementation
- Clarify username-based user identification across all user management commands
- Update test expectations to match username-based interface

Documentation:
- README.md: Replace <user-id> with <username> in all user command examples
- Ensure consistency across user create, get, update, delete commands
2026-05-12 12:26:06 +00:00

147 lines
5.1 KiB
Python

"""User CLI commands."""
from __future__ import annotations
import typer
from app.cli.core.utils import execute_command, render_output
from app.cli.commands.portfolio import _confirm
from app.schemas.user import CreateUserRequest, UpdateUserRequest, UserDetailResponse, UserResponse
from app.services.user_service import UserService
user_app = typer.Typer(help="User management commands.")
def _with_service(ctx: typer.Context, callback):
app_context = ctx.obj
repository = app_context.repository_factory(app_context.settings)
service = UserService(repository)
try:
return execute_command(app_context.console, callback=lambda: callback(service, app_context))
finally:
if callable(getattr(type(repository), "close", None)):
repository.close()
def _to_user_response(user) -> UserResponse:
return UserResponse(
id=user.id,
username=user.username,
email=user.email,
permission=user.permission,
is_active=user.is_active,
created_at=user.created_at,
updated_at=user.updated_at,
last_login_at=user.last_login_at,
)
def _to_user_detail_response(user, service_token_names: list[str]) -> UserDetailResponse:
return UserDetailResponse(
id=user.id,
username=user.username,
email=user.email,
permission=user.permission,
is_active=user.is_active,
created_at=user.created_at,
updated_at=user.updated_at,
last_login_at=user.last_login_at,
service_token_count=len(service_token_names),
service_token_names=service_token_names,
)
@user_app.command("list")
def list_users(ctx: typer.Context) -> None:
users = _with_service(ctx, lambda service, app_context: [_to_user_response(user) for user in service.list()])
render_output(ctx.obj.console, ctx.obj.output_format, users, empty_message="No users found.")
@user_app.command("get")
def get_user(
ctx: typer.Context,
username: str = typer.Argument(..., help="Username."),
) -> None:
def _get(service: UserService, app_context) -> UserDetailResponse:
user = service.get_by_username(username)
service_token_names = sorted(token.name for token in service.list_service_tokens(user.id))
return _to_user_detail_response(user, service_token_names)
user = _with_service(
ctx,
_get,
)
render_output(ctx.obj.console, ctx.obj.output_format, user)
@user_app.command("create")
def create_user(
ctx: typer.Context,
username: str = typer.Option(..., help="Username."),
password: str = typer.Option(..., help="Initial password."),
email: str | None = typer.Option(None, help="Email address."),
permission: str = typer.Option("read", help="Permission: read, trade-write, admin."),
is_active: bool = typer.Option(True, help="Whether the user is active."),
force: bool = typer.Option(False, "--force", help="Skip confirmation prompt."),
) -> None:
_confirm(force, f"Create user {username}?")
user = _with_service(
ctx,
lambda service, app_context: _to_user_response(
service.create(
CreateUserRequest(
username=username,
password=password,
email=email,
permission=permission,
is_active=is_active,
)
)
),
)
render_output(ctx.obj.console, ctx.obj.output_format, user)
@user_app.command("update")
def update_user(
ctx: typer.Context,
current_username: str = typer.Argument(..., help="Username."),
username: str | None = typer.Option(None, help="New username."),
password: str | None = typer.Option(None, help="New password."),
email: str | None = typer.Option(None, help="New email address."),
permission: str | None = typer.Option(None, help="New permission."),
is_active: bool | None = typer.Option(None, help="Whether the user is active."),
force: bool = typer.Option(False, "--force", help="Skip confirmation prompt."),
) -> None:
_confirm(force, f"Update user {current_username}?")
user = _with_service(
ctx,
lambda service, app_context: _to_user_response(
service.update(
service.get_by_username(current_username).id,
UpdateUserRequest(
username=username,
password=password,
email=email,
permission=permission,
is_active=is_active,
),
)
),
)
render_output(ctx.obj.console, ctx.obj.output_format, user)
@user_app.command("delete")
def delete_user(
ctx: typer.Context,
username: str = typer.Argument(..., help="Username."),
force: bool = typer.Option(False, "--force", help="Skip confirmation prompt."),
) -> None:
_confirm(force, f"Delete user {username}?")
_with_service(ctx, lambda service, app_context: service.delete(service.get_by_username(username).id))
if ctx.obj.output_format == "json":
render_output(ctx.obj.console, ctx.obj.output_format, {"deleted": username})
else:
ctx.obj.console.print(f"Deleted user: {username}")