mirror of
https://github.com/Textualize/textual.git
synced 2025-10-17 02:38:12 +03:00
4148b1d450
* First prototype of PB.
* Repurpose UnderlineBar.
* Factor out 'Bar' widget.
* Revert "Factor out 'Bar' widget."
This reverts commit 0bb4871adf.
* Add Bar widget.
* Cap progress at 100%.
* Add skeleton for the ETA label.
[skip ci]
* Add ETA display.
* Improve docstrings.
* Directly compute percentage.
* Watch percentage changes directly.
[skip ci]
* Documentation.
* Make reactive percentage private.
Instead, we create a public read-only percentage property.
* Update griffe to fix documentation issue.
Related issues: #1572, https://github.com/mkdocstrings/griffe/issues/128.
Related PRs: https://github.com/mkdocstrings/griffe/pull/135.
* Add example and docs.
* Address review feedback.
[skip ci]
* More documentation.
* Add tests.
* Changelog.
* More tests.
* Fix/fake tests.
* Final tweaks.
166 lines
3.5 KiB
Python
166 lines
3.5 KiB
Python
import pytest
|
|
from pytest import approx
|
|
|
|
from textual.app import App
|
|
from textual.css.query import NoMatches
|
|
from textual.widget import Widget
|
|
from textual.widgets import ProgressBar
|
|
|
|
|
|
def test_initial_status():
|
|
pb = ProgressBar()
|
|
assert pb.total is None
|
|
assert pb.progress == 0
|
|
assert pb.percentage is None
|
|
|
|
pb = ProgressBar(total=100)
|
|
assert pb.total == 100
|
|
assert pb.progress == 0
|
|
assert pb.percentage == 0
|
|
|
|
|
|
def test_advance():
|
|
pb = ProgressBar(total=100)
|
|
|
|
pb.advance(10)
|
|
assert pb.progress == 10
|
|
assert pb.percentage == approx(0.1)
|
|
|
|
pb.advance(42)
|
|
assert pb.progress == 52
|
|
assert pb.percentage == approx(0.52)
|
|
|
|
pb.advance(0.0625)
|
|
assert pb.progress == 52.0625
|
|
assert pb.percentage == approx(0.520625)
|
|
|
|
|
|
def test_advance_backwards():
|
|
pb = ProgressBar(total=100)
|
|
|
|
pb.progress = 50
|
|
|
|
pb.advance(-10)
|
|
assert pb.progress == 40
|
|
|
|
|
|
def test_progress_overflow():
|
|
pb = ProgressBar(total=100)
|
|
|
|
pb.advance(999_999)
|
|
assert pb.progress == 100
|
|
assert pb.percentage == 1
|
|
|
|
pb.update(total=50)
|
|
assert pb.progress == 50
|
|
assert pb.percentage == 1
|
|
|
|
|
|
def test_progress_underflow():
|
|
pb = ProgressBar(total=100)
|
|
|
|
pb.advance(-999_999)
|
|
assert pb.progress == 0
|
|
assert pb.percentage == 0
|
|
|
|
|
|
def test_non_negative_total():
|
|
pb = ProgressBar(total=-100)
|
|
assert pb.total == 0
|
|
|
|
|
|
def test_update_total():
|
|
pb = ProgressBar()
|
|
|
|
pb.update(total=100)
|
|
assert pb.total == 100
|
|
|
|
pb.update(total=1000)
|
|
assert pb.total == 1000
|
|
|
|
pb.update(total=None)
|
|
assert pb.total == 1000
|
|
|
|
pb.update(total=100)
|
|
assert pb.total == 100
|
|
|
|
|
|
def test_update_progress():
|
|
pb = ProgressBar(total=100)
|
|
|
|
pb.update(progress=10)
|
|
assert pb.progress == 10
|
|
|
|
pb.update(progress=73)
|
|
assert pb.progress == 73
|
|
|
|
pb.update(progress=40)
|
|
assert pb.progress == 40
|
|
|
|
|
|
def test_update_advance():
|
|
pb = ProgressBar(total=100)
|
|
|
|
pb.update(advance=10)
|
|
assert pb.progress == 10
|
|
|
|
pb.update(advance=10)
|
|
assert pb.progress == 20
|
|
|
|
pb.update(advance=10)
|
|
assert pb.progress == 30
|
|
|
|
|
|
def test_update():
|
|
pb = ProgressBar()
|
|
|
|
pb.update(total=100, progress=30, advance=20)
|
|
assert pb.total == 100
|
|
assert pb.progress == 50
|
|
|
|
|
|
@pytest.mark.parametrize(
|
|
["show_bar", "show_percentage", "show_eta"],
|
|
[
|
|
(True, True, True),
|
|
(True, True, False),
|
|
(True, False, True),
|
|
(True, False, False),
|
|
(False, True, True),
|
|
(False, True, False),
|
|
(False, False, True),
|
|
(False, False, False),
|
|
],
|
|
)
|
|
async def test_show_sub_widgets(show_bar: bool, show_percentage: bool, show_eta: bool):
|
|
class PBApp(App[None]):
|
|
def compose(self):
|
|
self.pb = ProgressBar(
|
|
show_bar=show_bar, show_percentage=show_percentage, show_eta=show_eta
|
|
)
|
|
yield self.pb
|
|
|
|
app = PBApp()
|
|
|
|
async with app.run_test():
|
|
if show_bar:
|
|
bar = app.pb.query_one("#bar")
|
|
assert isinstance(bar, Widget)
|
|
else:
|
|
with pytest.raises(NoMatches):
|
|
app.pb.query_one("#bar")
|
|
|
|
if show_percentage:
|
|
percentage = app.pb.query_one("#percentage")
|
|
assert isinstance(percentage, Widget)
|
|
else:
|
|
with pytest.raises(NoMatches):
|
|
app.pb.query_one("#percentage")
|
|
|
|
if show_eta:
|
|
eta = app.pb.query_one("#eta")
|
|
assert isinstance(eta, Widget)
|
|
else:
|
|
with pytest.raises(NoMatches):
|
|
app.pb.query_one("#eta")
|