Compare commits

...

4 Commits

Author SHA1 Message Date
agentson
0ca3fe9f5d feat: add configuration and documentation for Telegram commands (issue #69)
Some checks failed
CI / test (pull_request) Has been cancelled
Add configuration options and comprehensive documentation for the new
bidirectional command feature.

Changes:
- Add TELEGRAM_COMMANDS_ENABLED to config.py
- Add TELEGRAM_POLLING_INTERVAL to config.py
- Add extensive "Bidirectional Commands" section to README.md

Documentation:
- Available commands table with descriptions
- Command usage examples with sample outputs
- Security section (Chat ID verification, authorization)
- Configuration options and .env examples
- How it works (long polling, authentication flow)
- Error handling and troubleshooting guide

Features:
- Optional command support (can disable while keeping notifications)
- Configurable polling interval
- Complete security documentation
- Troubleshooting guide for common issues

Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
2026-02-05 15:39:02 +09:00
462f8763ab Merge pull request 'feat: implement status query commands /status and /positions (issue #67)' (#68) from feature/issue-67-status-commands into main
Some checks failed
CI / test (push) Has been cancelled
Reviewed-on: #68
2026-02-05 15:34:16 +09:00
agentson
57a45a24cb feat: implement status query commands /status and /positions (issue #67)
Some checks failed
CI / test (pull_request) Has been cancelled
Add real-time status and portfolio monitoring via Telegram.

Changes:
- Implement /status handler (mode, markets, P&L, trading state)
- Implement /positions handler (holdings with grouping by market)
- Integrate with Broker API and RiskManager
- Add 5 comprehensive tests for status commands

Features:
- /status: Shows trading mode, enabled markets, pause state, P&L, circuit breaker
- /positions: Lists holdings grouped by market (domestic/overseas)
- Error handling: Graceful degradation on API failures
- Empty state: Handles portfolios with no positions

Integration:
- Uses broker.get_balance() for account data
- Uses risk.calculate_pnl() for P&L calculation
- Accesses pause_trading.is_set() for trading state
- Groups positions by market for better readability

Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
2026-02-05 15:29:52 +09:00
a7696568cc Merge pull request 'feat: implement trading control commands /stop and /resume (issue #65)' (#66) from feature/issue-65-trading-control into main
Some checks failed
CI / test (push) Has been cancelled
Reviewed-on: #66
2026-02-05 15:17:35 +09:00
4 changed files with 426 additions and 1 deletions

View File

@@ -66,6 +66,10 @@ class Settings(BaseSettings):
TELEGRAM_CHAT_ID: str | None = None
TELEGRAM_ENABLED: bool = True
# Telegram Commands (optional)
TELEGRAM_COMMANDS_ENABLED: bool = True
TELEGRAM_POLLING_INTERVAL: float = 1.0 # seconds
model_config = {"env_file": ".env", "env_file_encoding": "utf-8"}
@property

View File

@@ -633,10 +633,101 @@ async def run(settings: Settings) -> None:
"Trading operations have been restarted."
)
async def handle_status() -> None:
"""Handle /status command - show trading status."""
try:
# Get trading status
trading_status = "Active" if pause_trading.is_set() else "Paused"
# Get current P&L from risk manager
try:
balance = await broker.get_balance()
current_pnl = risk.calculate_pnl(balance)
pnl_str = f"{current_pnl:+.2f}%"
except Exception as exc:
logger.warning("Failed to get P&L: %s", exc)
pnl_str = "N/A"
# Format market list
markets_str = ", ".join(settings.enabled_market_list)
message = (
"<b>📊 Trading Status</b>\n\n"
f"<b>Mode:</b> {settings.MODE.upper()}\n"
f"<b>Markets:</b> {markets_str}\n"
f"<b>Trading:</b> {trading_status}\n\n"
f"<b>Current P&L:</b> {pnl_str}\n"
f"<b>Circuit Breaker:</b> {risk.circuit_breaker_threshold:.1f}%"
)
await telegram.send_message(message)
except Exception as exc:
logger.error("Error in /status handler: %s", exc)
await telegram.send_message(
"<b>⚠️ Error</b>\n\nFailed to retrieve trading status."
)
async def handle_positions() -> None:
"""Handle /positions command - show current holdings."""
try:
# Get account balance
balance = await broker.get_balance()
# Check if there are any positions
if not balance.stocks:
await telegram.send_message(
"<b>💼 Current Holdings</b>\n\n"
"No positions currently held."
)
return
# Group positions by market (domestic vs overseas)
domestic_positions = []
overseas_positions = []
for stock in balance.stocks:
position_str = (
f"{stock.code}: {stock.quantity} shares @ "
f"{stock.avg_price:,.0f}"
)
# Simple heuristic: if code is 6 digits, it's domestic (Korea)
if len(stock.code) == 6 and stock.code.isdigit():
domestic_positions.append(position_str)
else:
overseas_positions.append(position_str)
# Build message
message_parts = ["<b>💼 Current Holdings</b>\n"]
if domestic_positions:
message_parts.append("\n🇰🇷 <b>Korea</b>")
message_parts.extend(domestic_positions)
if overseas_positions:
message_parts.append("\n🇺🇸 <b>Overseas</b>")
message_parts.extend(overseas_positions)
# Add total cash
message_parts.append(
f"\n<b>Cash:</b> ₩{balance.total_cash:,.0f}"
)
message = "\n".join(message_parts)
await telegram.send_message(message)
except Exception as exc:
logger.error("Error in /positions handler: %s", exc)
await telegram.send_message(
"<b>⚠️ Error</b>\n\nFailed to retrieve positions."
)
command_handler.register_command("start", handle_start)
command_handler.register_command("help", handle_help)
command_handler.register_command("stop", handle_stop)
command_handler.register_command("resume", handle_resume)
command_handler.register_command("status", handle_status)
command_handler.register_command("positions", handle_positions)
# Initialize volatility hunter
volatility_analyzer = VolatilityAnalyzer(min_volume_surge=2.0, min_price_change=1.0)

View File

@@ -200,14 +200,151 @@ telegram = TelegramClient(
)
```
## Bidirectional Commands
Control your trading bot remotely via Telegram commands. The bot not only sends notifications but also accepts commands for real-time control.
### Available Commands
| Command | Description |
|---------|-------------|
| `/start` | Welcome message with quick start guide |
| `/help` | List all available commands |
| `/status` | Current trading status (mode, markets, P&L, circuit breaker) |
| `/positions` | View current holdings grouped by market |
| `/stop` | Pause all trading operations |
| `/resume` | Resume trading operations |
### Command Examples
**Check Trading Status**
```
You: /status
Bot:
📊 Trading Status
Mode: PAPER
Markets: Korea, United States
Trading: Active
Current P&L: +2.50%
Circuit Breaker: -3.0%
```
**View Holdings**
```
You: /positions
Bot:
💼 Current Holdings
🇰🇷 Korea
• 005930: 10 shares @ 70,000
• 035420: 5 shares @ 200,000
🇺🇸 Overseas
• AAPL: 15 shares @ 175
• TSLA: 8 shares @ 245
Cash: ₩5,000,000
```
**Pause Trading**
```
You: /stop
Bot:
⏸️ Trading Paused
All trading operations have been suspended.
Use /resume to restart trading.
```
**Resume Trading**
```
You: /resume
Bot:
▶️ Trading Resumed
Trading operations have been restarted.
```
### Security
**Chat ID Verification**
- Commands are only accepted from the configured `TELEGRAM_CHAT_ID`
- Unauthorized users receive no response
- Command attempts from wrong chat IDs are logged
**Authorization Required**
- Only the bot owner (chat ID in `.env`) can control trading
- No way for unauthorized users to discover or use commands
- All command executions are logged for audit
### Configuration
Add to your `.env` file:
```bash
# Commands are enabled by default
TELEGRAM_COMMANDS_ENABLED=true
# Polling interval (seconds) - how often to check for commands
TELEGRAM_POLLING_INTERVAL=1.0
```
To disable commands but keep notifications:
```bash
TELEGRAM_COMMANDS_ENABLED=false
```
### How It Works
1. **Long Polling**: Bot checks Telegram API every second for new messages
2. **Command Parsing**: Messages starting with `/` are parsed as commands
3. **Authentication**: Chat ID is verified before executing any command
4. **Execution**: Command handler is called with current bot state
5. **Response**: Result is sent back via Telegram
### Error Handling
- Command parsing errors → "Unknown command" response
- API failures → Graceful degradation, error logged
- Invalid state → Appropriate message (e.g., "Trading is already paused")
- Trading loop isolation → Command errors never crash trading
### Troubleshooting Commands
**Commands not responding**
1. Check `TELEGRAM_COMMANDS_ENABLED=true` in `.env`
2. Verify you started conversation with `/start`
3. Check logs for command handler errors
4. Confirm chat ID matches `.env` configuration
**Wrong chat ID**
- Commands from unauthorized chats are silently ignored
- Check logs for "unauthorized chat_id" warnings
**Delayed responses**
- Polling interval is 1 second by default
- Network latency may add delay
- Check `TELEGRAM_POLLING_INTERVAL` setting
## API Reference
See `telegram_client.py` for full API documentation.
Key methods:
### Notification Methods
- `notify_trade_execution()` - Trade alerts
- `notify_circuit_breaker()` - Emergency stops
- `notify_fat_finger()` - Order rejections
- `notify_market_open/close()` - Session tracking
- `notify_system_start/shutdown()` - Lifecycle events
- `notify_error()` - Error alerts
### Command Handler
- `TelegramCommandHandler` - Bidirectional command processing
- `register_command()` - Register custom command handlers
- `start_polling()` / `stop_polling()` - Lifecycle management

View File

@@ -442,6 +442,199 @@ class TestTradingControlCommands:
assert "already active" in payload["text"]
class TestStatusCommands:
"""Test status query commands."""
@pytest.mark.asyncio
async def test_status_command_shows_trading_info(self) -> None:
"""Status command displays mode, markets, and P&L."""
client = TelegramClient(bot_token="123:abc", chat_id="456", enabled=True)
handler = TelegramCommandHandler(client)
mock_resp = AsyncMock()
mock_resp.status = 200
mock_resp.__aenter__ = AsyncMock(return_value=mock_resp)
mock_resp.__aexit__ = AsyncMock(return_value=False)
async def mock_status() -> None:
"""Mock /status handler."""
message = (
"<b>📊 Trading Status</b>\n\n"
"<b>Mode:</b> PAPER\n"
"<b>Markets:</b> Korea, United States\n"
"<b>Trading:</b> Active\n\n"
"<b>Current P&L:</b> +2.50%\n"
"<b>Circuit Breaker:</b> -3.0%"
)
await client.send_message(message)
handler.register_command("status", mock_status)
with patch("aiohttp.ClientSession.post", return_value=mock_resp) as mock_post:
update = {
"update_id": 1,
"message": {
"chat": {"id": 456},
"text": "/status",
},
}
await handler._handle_update(update)
# Verify message was sent
assert mock_post.call_count == 1
payload = mock_post.call_args.kwargs["json"]
assert "Trading Status" in payload["text"]
assert "PAPER" in payload["text"]
assert "P&L" in payload["text"]
@pytest.mark.asyncio
async def test_status_command_error_handling(self) -> None:
"""Status command handles errors gracefully."""
client = TelegramClient(bot_token="123:abc", chat_id="456", enabled=True)
handler = TelegramCommandHandler(client)
mock_resp = AsyncMock()
mock_resp.status = 200
mock_resp.__aenter__ = AsyncMock(return_value=mock_resp)
mock_resp.__aexit__ = AsyncMock(return_value=False)
async def mock_status_error() -> None:
"""Mock /status handler with error."""
await client.send_message(
"<b>⚠️ Error</b>\n\nFailed to retrieve trading status."
)
handler.register_command("status", mock_status_error)
with patch("aiohttp.ClientSession.post", return_value=mock_resp) as mock_post:
update = {
"update_id": 1,
"message": {
"chat": {"id": 456},
"text": "/status",
},
}
await handler._handle_update(update)
# Should send error message
payload = mock_post.call_args.kwargs["json"]
assert "Error" in payload["text"]
@pytest.mark.asyncio
async def test_positions_command_shows_holdings(self) -> None:
"""Positions command displays current holdings."""
client = TelegramClient(bot_token="123:abc", chat_id="456", enabled=True)
handler = TelegramCommandHandler(client)
mock_resp = AsyncMock()
mock_resp.status = 200
mock_resp.__aenter__ = AsyncMock(return_value=mock_resp)
mock_resp.__aexit__ = AsyncMock(return_value=False)
async def mock_positions() -> None:
"""Mock /positions handler."""
message = (
"<b>💼 Current Holdings</b>\n"
"\n🇰🇷 <b>Korea</b>\n"
"• 005930: 10 shares @ 70,000\n"
"\n🇺🇸 <b>Overseas</b>\n"
"• AAPL: 15 shares @ 175\n"
"\n<b>Cash:</b> ₩5,000,000"
)
await client.send_message(message)
handler.register_command("positions", mock_positions)
with patch("aiohttp.ClientSession.post", return_value=mock_resp) as mock_post:
update = {
"update_id": 1,
"message": {
"chat": {"id": 456},
"text": "/positions",
},
}
await handler._handle_update(update)
# Verify message was sent
assert mock_post.call_count == 1
payload = mock_post.call_args.kwargs["json"]
assert "Current Holdings" in payload["text"]
assert "shares" in payload["text"]
@pytest.mark.asyncio
async def test_positions_command_empty_holdings(self) -> None:
"""Positions command handles empty portfolio."""
client = TelegramClient(bot_token="123:abc", chat_id="456", enabled=True)
handler = TelegramCommandHandler(client)
mock_resp = AsyncMock()
mock_resp.status = 200
mock_resp.__aenter__ = AsyncMock(return_value=mock_resp)
mock_resp.__aexit__ = AsyncMock(return_value=False)
async def mock_positions_empty() -> None:
"""Mock /positions handler with no positions."""
message = (
"<b>💼 Current Holdings</b>\n\n"
"No positions currently held."
)
await client.send_message(message)
handler.register_command("positions", mock_positions_empty)
with patch("aiohttp.ClientSession.post", return_value=mock_resp) as mock_post:
update = {
"update_id": 1,
"message": {
"chat": {"id": 456},
"text": "/positions",
},
}
await handler._handle_update(update)
# Verify message was sent
payload = mock_post.call_args.kwargs["json"]
assert "No positions" in payload["text"]
@pytest.mark.asyncio
async def test_positions_command_error_handling(self) -> None:
"""Positions command handles errors gracefully."""
client = TelegramClient(bot_token="123:abc", chat_id="456", enabled=True)
handler = TelegramCommandHandler(client)
mock_resp = AsyncMock()
mock_resp.status = 200
mock_resp.__aenter__ = AsyncMock(return_value=mock_resp)
mock_resp.__aexit__ = AsyncMock(return_value=False)
async def mock_positions_error() -> None:
"""Mock /positions handler with error."""
await client.send_message(
"<b>⚠️ Error</b>\n\nFailed to retrieve positions."
)
handler.register_command("positions", mock_positions_error)
with patch("aiohttp.ClientSession.post", return_value=mock_resp) as mock_post:
update = {
"update_id": 1,
"message": {
"chat": {"id": 456},
"text": "/positions",
},
}
await handler._handle_update(update)
# Should send error message
payload = mock_post.call_args.kwargs["json"]
assert "Error" in payload["text"]
class TestBasicCommands:
"""Test basic command implementations."""