Skip to content

Commit bc8de5d

Browse files
New-dev0New-dev0
committed
docs: add more examples
1 parent 9f812a2 commit bc8de5d

10 files changed

+1447
-2
lines changed

‎docs/docs/examples/_category_.json

-1
Original file line numberDiff line numberDiff line change
@@ -6,5 +6,4 @@
66
"description": "5 minutes to learn the most important SwiBots concepts."
77
},
88
"collapsed": true
9-
109
}

‎docs/docs/examples/calculator-bot.md

+171
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,171 @@
1+
# Calculator Bot Example
2+
3+
This example demonstrates a more complex use case of a mini app using SwiBots. The bot creates an advanced calculator with basic arithmetic, scientific functions, and calculation history.
4+
5+
## Prerequisites
6+
7+
Before you begin, make sure you have:
8+
9+
1. Installed SwiBots (`pip install swibots`)
10+
2. Obtained a bot token from the Switch platform
11+
3. Installed the `math` module (usually comes pre-installed with Python)
12+
13+
## The Code
14+
15+
Here's the complete code for our advanced calculator bot:
16+
17+
```python
18+
import logging
19+
import math
20+
from swibots import (
21+
Client, BotContext, CommandEvent, CallbackQueryEvent, BotCommand,
22+
AppPage, Text, Button, ButtonGroup,
23+
ScreenType, TextSize, InlineKeyboardButton, InlineMarkup, regexp
24+
)
25+
26+
logging.basicConfig(level=logging.INFO)
27+
logger = logging.getLogger(__name__)
28+
29+
TOKEN = "YOUR_BOT_TOKEN_HERE"
30+
31+
app = Client(TOKEN, is_app=True, home_callback="show_calculator")
32+
app.set_bot_commands([BotCommand("start", "Open the calculator", True)])
33+
34+
# Store calculation history
35+
user_history = {}
36+
37+
def evaluate_expression(expression):
38+
try:
39+
# Replace '^' with '**' for exponentiation
40+
expression = expression.replace('^', '**')
41+
# Add math. prefix to mathematical functions
42+
for func in ['sin', 'cos', 'tan', 'log', 'sqrt']:
43+
expression = expression.replace(func, f'math.{func}')
44+
return str(eval(expression, {"__builtins__": None}, {"math": math}))
45+
except Exception as e:
46+
return f"Error: {str(e)}"
47+
48+
@app.on_command("start")
49+
async def start_command(ctx: BotContext[CommandEvent]):
50+
await ctx.event.message.reply_text(
51+
"Welcome to the Advanced Calculator! Click the button below to start calculating.",
52+
inline_markup=InlineMarkup([[
53+
InlineKeyboardButton("Open Calculator", callback_data="show_calculator", app=True)
54+
]])
55+
)
56+
57+
@app.on_callback_query(regexp("show_calculator"))
58+
async def show_calculator(ctx: BotContext[CallbackQueryEvent]):
59+
user_id = ctx.event.action_by_id
60+
current_expression = user_history.get(user_id, {}).get('current', '')
61+
62+
calculator_buttons = [
63+
["7", "8", "9", "/"],
64+
["4", "5", "6", "*"],
65+
["1", "2", "3", "-"],
66+
["0", ".", "=", "+"],
67+
["(", ")", "C", "←"],
68+
["sin", "cos", "tan", "^"],
69+
["log", "sqrt", "π", "e"],
70+
]
71+
72+
button_groups = [
73+
ButtonGroup([Button(btn, callback_data=f"calc_{btn}") for btn in row])
74+
for row in calculator_buttons
75+
]
76+
77+
page = AppPage(
78+
screen=ScreenType.SCREEN,
79+
components=[
80+
Text("Advanced Calculator", size=TextSize.LARGE),
81+
Text(current_expression or "0", size=TextSize.MEDIUM),
82+
*button_groups,
83+
Button("View History", callback_data="view_history"),
84+
]
85+
)
86+
await ctx.event.answer(callback=page)
87+
88+
@app.on_callback_query(regexp("calc_"))
89+
async def handle_calculation(ctx: BotContext[CallbackQueryEvent]):
90+
user_id = ctx.event.action_by_id
91+
button = ctx.event.callback_data.split("_")[1]
92+
93+
if user_id not in user_history:
94+
user_history[user_id] = {'current': '', 'history': []}
95+
96+
current = user_history[user_id]['current']
97+
98+
if button == "=":
99+
result = evaluate_expression(current)
100+
user_history[user_id]['history'].append(f"{current} = {result}")
101+
user_history[user_id]['current'] = result
102+
elif button == "C":
103+
user_history[user_id]['current'] = ''
104+
elif button == "←":
105+
user_history[user_id]['current'] = current[:-1]
106+
elif button == "π":
107+
user_history[user_id]['current'] += str(math.pi)
108+
elif button == "e":
109+
user_history[user_id]['current'] += str(math.e)
110+
else:
111+
user_history[user_id]['current'] += button
112+
113+
await show_calculator(ctx)
114+
115+
@app.on_callback_query(regexp("view_history"))
116+
async def view_history(ctx: BotContext[CallbackQueryEvent]):
117+
user_id = ctx.event.action_by_id
118+
history = user_history.get(user_id, {}).get('history', [])
119+
120+
if not history:
121+
await ctx.event.answer("No calculation history available.", show_alert=True)
122+
return
123+
124+
page = AppPage(
125+
screen=ScreenType.SCREEN,
126+
components=[
127+
Text("Calculation History", size=TextSize.LARGE),
128+
Text("\n".join(history[-10:]), size=TextSize.MEDIUM),
129+
Button("Back to Calculator", callback_data="show_calculator"),
130+
]
131+
)
132+
await ctx.event.answer(callback=page)
133+
134+
if __name__ == "__main__":
135+
app.run()
136+
```
137+
138+
## Features Demonstrated
139+
140+
This example showcases the following SwiBots features:
141+
142+
1. Creating a complex mini app with advanced functionality
143+
2. Using various UI components:
144+
- Text
145+
- Buttons and ButtonGroups
146+
3. Implementing a calculator interface with multiple operations
147+
4. Maintaining user state (current expression and calculation history)
148+
5. Handling user actions for various calculator functions
149+
6. Integrating with Python's `math` module for advanced calculations
150+
151+
## How It Works
152+
153+
1. The bot starts with a welcome message and a button to open the calculator.
154+
2. The main calculator screen shows the current expression and buttons for various operations.
155+
3. Users can input numbers and perform various operations, including basic arithmetic and scientific functions.
156+
4. The calculator evaluates expressions and displays results.
157+
5. Users can view their calculation history.
158+
159+
This example demonstrates how to create a more complex, interactive mini app that provides practical functionality while showcasing various SwiBots features.
160+
161+
## Running the Bot
162+
163+
To run the bot, save the complete code in a file (e.g., `advanced_calculator_bot.py`) and execute it:
164+
165+
```bash
166+
python advanced_calculator_bot.py
167+
```
168+
169+
## Note
170+
171+
This implementation uses Python's `eval()` function, which can be dangerous if used with untrusted input. In a production environment, you should implement a safer method of evaluating mathematical expressions, such as using a parsing library or implementing your own expression evaluator.

0 commit comments

Comments
 (0)