mirror of
https://github.com/Textualize/textual.git
synced 2025-10-17 02:38:12 +03:00
console screenshot
This commit is contained in:
18
docs/examples/getting_started/console.py
Normal file
18
docs/examples/getting_started/console.py
Normal file
@@ -0,0 +1,18 @@
|
||||
"""
|
||||
Simulates a screenshot of the Textual devtools
|
||||
|
||||
"""
|
||||
|
||||
from textual.app import App
|
||||
|
||||
from textual.devtools.renderables import DevConsoleHeader
|
||||
from textual.widgets import Static
|
||||
|
||||
|
||||
class ConsoleApp(App):
|
||||
def compose(self):
|
||||
self.dark = True
|
||||
yield Static(DevConsoleHeader())
|
||||
|
||||
|
||||
app = ConsoleApp()
|
||||
@@ -18,9 +18,6 @@ pip install textual
|
||||
|
||||
If you installed the dev dependencies, you have have access to the `textual` CLI command. There are a number of sub-commands which will aid you in building Textual apps. See the help for more details:
|
||||
|
||||
```python
|
||||
```bash
|
||||
textual --help
|
||||
```
|
||||
|
||||
### Textual Console
|
||||
|
||||
|
||||
@@ -28,20 +28,24 @@ textual run my_app.py:alternative_app
|
||||
|
||||
## Console
|
||||
|
||||
When running any terminal application, you can no longer use `print` when debugging (or log to the console). This is because anything you write to standard output would typically overwrite application content, which generally makes an unreadable mess. Fortunately Textual supplies a debug console of it's own which has some super helpful features.
|
||||
When running any terminal application, you can no longer use `print` when debugging (or log to the console). This is because anything you write to standard output would overwrite application content, making it unreadable. Fortunately Textual supplies a debug console of it's own which has some super helpful features.
|
||||
|
||||
To use the console, open up 2 console emulators. In the first one, run the following:
|
||||
To use the console, open up 2 terminal emulators. In the first one, run the following:
|
||||
|
||||
```bash
|
||||
textual console
|
||||
```
|
||||
|
||||
This should look something like the following:
|
||||
|
||||
```{.textual title="textual console" path="docs/examples/getting_started/console.py", press="_,_"}
|
||||
```
|
||||
|
||||
In the other console, run your application using `textual run` and the `--dev` switch:
|
||||
|
||||
```bash
|
||||
textual run my_app.py --dev
|
||||
```
|
||||
|
||||
You should notice that the console will display information regarding the running application, such as events which are sent.
|
||||
|
||||
Anything you `print` from your application will be displayed in the console window. You can also call the `log()` method on App and Widget objects for advanced formatting. Try it with `self.log(self.tree)`.
|
||||
|
||||
|
||||
@@ -15,7 +15,7 @@ By the end of this page you should have a good idea of the steps involved in cre
|
||||
|
||||
## Stopwatch Application
|
||||
|
||||
We're going to build a stopwatch app. This app will display the elapsed time since the user hit a "Start" button. The user will be able to stop, resume, and reset each stopwatch in addition to adding or removing them.
|
||||
We're going to build a stopwatch application. It should show a list of stopwatches with a time display the user can start, stop, and reset. We also want the user to be able to add and remove stopwatches as required.
|
||||
|
||||
This will be a simple yet **fully featured** app — you could distribute this app if you wanted to!
|
||||
|
||||
|
||||
Reference in New Issue
Block a user