Simple example
# main.py
from typing import NamedTuple
from pyllot import (
Router,
ScreenBase,
ScreenPresenting,
ScreensFactoryBase,
Transition,
TransitionDirection,
)
class MyScreen(ScreenBase):
def will_present(self) -> None:
print(f'Will present "{self.screen_name}"')
def did_present(self) -> None:
print(f'Did present "{self.screen_name}"')
def will_disappear(self) -> None:
print(f'Will disappear "{self.screen_name}"')
class HomeScreen(MyScreen):
@property
def screen_name(self) -> str:
return "home"
class VideoPlayerScreen(MyScreen):
@property
def screen_name(self) -> str:
return "video_player"
class State(NamedTuple):
current_video_url: str | None
def has_current_video(state: State) -> bool:
return state.current_video_url is not None
class MyPresenter(ScreenPresenting[MyScreen]):
def present(self, screen: MyScreen) -> None:
print(f'Presenting "{screen.screen_name}"')
class MyScreensFactory(ScreensFactoryBase[MyScreen]):
def create(self, screen_name: str) -> MyScreen:
print(f'Creating screen "{screen_name}"')
match screen_name:
case "home":
return HomeScreen()
case "video_player":
return VideoPlayerScreen()
case _:
raise NotImplementedError
HOME_TO_VIDEO_PLAYER: Transition[State] = Transition(
source="home",
destination="video_player",
direction=TransitionDirection.PUSH,
condition=has_current_video,
)
VIDEO_PLAYER_TO_HOME: Transition[State] = Transition(
source="video_player",
destination="home",
direction=TransitionDirection.POP,
condition=lambda state: not has_current_video(state),
)
def main() -> None:
router: Router[State, MyScreen] = Router(
initial_screen=HomeScreen(),
presenter=MyPresenter(),
screens_factory=MyScreensFactory(),
)
router.add_transition(
Transition(
source="home",
destination="video_player",
direction=TransitionDirection.PUSH,
condition=has_current_video,
)
)
router.add_transition(
Transition(
source="video_player",
destination="home",
direction=TransitionDirection.POP,
condition=lambda state: not has_current_video(state),
)
)
print("Presenting video player...")
router.on_state(State(current_video_url="https://tombartk.com/funny_cats.mp4"))
print("\nGoing back to home screen...")
router.on_state(State(current_video_url=None))
if __name__ == "__main__":
main()
$ python3 main.py
Presenting video player...
Creating screen "video_player"
Will disappear "home"
Will present "video_player"
Presenting "video_player"
Did present "video_player"
Going back to home screen...
Will disappear "video_player"
Will present "home"
Presenting "home"
Did present "home"
Installation
Pyllot is available as pyllot on PyPI:
pip install pyllot
Usage
For detailed quickstart and API reference, visit the Documentation.
License
Copyright (C) 2023 tombartk
This program is free software: you can redistribute it and/or modify it under the terms
of the GNU Affero General Public License as published by the Free Software Foundation,
either version 3 of the License, or (at your option) any later version.
This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY;
without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
See the GNU Affero General Public License for more details.
You should have received a copy of the GNU Affero General Public License along with this program.
If not, see https://www.gnu.org/licenses/.
Metadata
Release files for pyllot 0.1.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| pyllot-0.1.0.tar.gz | 26.2 kB | Without provenance | Details for pyllot-0.1.0.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| pyllot-0.1.0-py3-none-any.whl | Python 3 | none | any | Details for pyllot-0.1.0-py3-none-any.whl |
Total release size: 47.7 kB
Release files / pyllot-0.1.0.tar.gz
| Download URL | pyllot-0.1.0.tar.gz |
|---|---|
| Size | 26.2 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
3325bc453a40272dcdd25339d979837b193a01a50a61b64f09909584be931a27
|
|
BLAKE2b-256 checksum How to use checksums |
eeaacbf3727cb193f09c3d6aacb444b541ba5e86d6b8285f334556e363939e46
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
python-httpx/0.24.1
|
Release files / pyllot-0.1.0-py3-none-any.whl
| Download URL | pyllot-0.1.0-py3-none-any.whl |
|---|---|
| Size | 21.4 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
d0c76636dadb10ed3a7890821d6b2c5d34caf53a16e94c814fe9293d95f58455
|
|
BLAKE2b-256 checksum How to use checksums |
26670647782812dec519a052d2b5f5a93550d72042196689fc33b441b261fc17
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
python-httpx/0.24.1
|
Security for pyllot 0.1.0
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.