Files
loader/_docs/02_document/modules/unlock_state.md
T
Oleksandr Bezdieniezhnykh 8f7deb3fca Add E2E tests, fix bugs
Made-with: Cursor
2026-04-13 05:17:48 +03:00

57 lines
1.1 KiB
Markdown

# Module: unlock_state
## Purpose
Defines the state machine enum for the multi-step Docker image unlock workflow.
## Public Interface
### Enums
#### `UnlockState` (str, Enum)
| Value | String Representation |
|------------------|-----------------------|
| idle | `"idle"` |
| authenticating | `"authenticating"` |
| downloading_key | `"downloading_key"` |
| decrypting | `"decrypting"` |
| loading_images | `"loading_images"` |
| ready | `"ready"` |
| error | `"error"` |
Inherits from `str` and `Enum`, so `.value` returns the string name directly.
## Internal Logic
No logic — pure enum definition. State transitions are managed externally by `main.py`.
## Dependencies
- **Internal**: none (leaf module)
- **External**: `enum` (stdlib)
## Consumers
- `main` — uses `UnlockState` to track and report the unlock workflow progress
## Data Models
`UnlockState` is the data model.
## Configuration
None.
## External Integrations
None.
## Security
None.
## Tests
No tests found.