Storage API¶
Pluggable storage backend for component data.
Overview¶
AgentECS uses a protocol-based storage architecture, allowing different backend implementations: - LocalStorage: In-memory storage for single-process use - Future: Archetypal storage, distributed backends, persistent storage
Key Features: - Protocol-based: Easy to swap implementations - Generational liveness: Safe entity recycling - Efficient queries: Filter entities by component types - Batch operations: Apply multiple updates atomically
Storage Protocol¶
Interface that all storage backends must implement.
Storage
¶
Bases: Protocol
Abstract storage interface. Implementations handle actual data.
Source code in src/agentecs/storage/protocol.py
create_entity()
¶
destroy_entity(entity)
¶
entity_exists(entity)
¶
get_component(entity, component_type, copy=True)
¶
set_component(entity, component)
¶
remove_component(entity, component_type)
¶
has_component(entity, component_type)
¶
get_component_types(entity)
¶
query(*component_types, copy=True)
¶
snapshot()
¶
LocalStorage¶
In-memory implementation for single-process use.
LocalStorage
¶
Simple in-memory storage using nested dicts.
Structure
_components[entity][component_type] = component_instance
Not cache-efficient - for production, use archetypal storage.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
shard
|
int
|
Shard number for this storage instance (default 0 for local). |
0
|
Source code in src/agentecs/storage/local.py
26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 | |
__init__(shard=0)
¶
Initialize local storage.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
shard
|
int
|
Shard number for this storage instance (default 0). |
0
|
Source code in src/agentecs/storage/local.py
create_entity()
¶
destroy_entity(entity)
¶
Destroy an entity and remove all its components.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
entity
|
EntityId
|
Entity to destroy. |
required |
Source code in src/agentecs/storage/local.py
entity_exists(entity)
¶
Check if an entity exists and is alive.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
entity
|
EntityId
|
Entity to check. |
required |
Returns:
| Type | Description |
|---|---|
bool
|
True if entity exists and is alive, False otherwise. |
Source code in src/agentecs/storage/local.py
get_component(entity, component_type, copy=True)
¶
Get a component from an entity.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
entity
|
EntityId
|
Entity to query. |
required |
component_type
|
type[T]
|
Type of component to retrieve. |
required |
copy
|
bool
|
Whether to return a copy of the component (default True). |
True
|
Returns:
| Type | Description |
|---|---|
Copy[T] | T | None
|
Component instance or None if not present. |
Source code in src/agentecs/storage/local.py
set_component(entity, component)
¶
Set or update a component on an entity.
If the component is wrapped in Shared, it is stored as a shared instance and mapped to the entity via instance_id. Otherwise, stored directly.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
entity
|
EntityId
|
Entity to modify. |
required |
component
|
Any
|
Component instance to set (type inferred). |
required |
Source code in src/agentecs/storage/local.py
remove_component(entity, component_type)
¶
Remove a component from an entity.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
entity
|
EntityId
|
Entity to modify. |
required |
component_type
|
type
|
Type of component to remove. |
required |
Returns:
| Type | Description |
|---|---|
bool
|
True if component was removed, False if not present. |
Source code in src/agentecs/storage/local.py
has_component(entity, component_type)
¶
Check if an entity has a specific component type.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
entity
|
EntityId
|
Entity to check. |
required |
component_type
|
type
|
Component type to look for. |
required |
Returns:
| Type | Description |
|---|---|
bool
|
True if entity has component, False otherwise. |
Source code in src/agentecs/storage/local.py
get_component_types(entity)
¶
Get all component types present on an entity.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
entity
|
EntityId
|
Entity to query. |
required |
Returns:
| Type | Description |
|---|---|
frozenset[type]
|
Frozenset of component types on entity. |
Source code in src/agentecs/storage/local.py
query(*component_types, copy=True)
¶
Find entities with all specified components.
O(n) scan - archetypal storage would be O(matched).
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
*component_types
|
type
|
Component types to query for. |
()
|
copy
|
bool
|
Whether to return copies of components (default True). |
True
|
Yields:
| Type | Description |
|---|---|
tuple[EntityId, tuple[Any, ...]]
|
Tuples of (entity, (component1, component2, ...)) for each match. |
Source code in src/agentecs/storage/local.py
snapshot()
¶
Pickle entire state for serialization.
Not efficient - use only for testing/prototyping, not production.
Returns:
| Type | Description |
|---|---|
bytes
|
Pickled bytes of storage state. |
Source code in src/agentecs/storage/local.py
restore(data)
¶
Restore from pickle snapshot.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
data
|
bytes
|
Pickled bytes from previous snapshot() call. |
required |
Source code in src/agentecs/storage/local.py
Usage Example¶
from agentecs import World
from agentecs.storage import LocalStorage
# Use default LocalStorage
world = World()
# Or provide custom storage
custom_storage = LocalStorage()
world = World(storage=custom_storage)
Future Storage Backends¶
ArchetypalStorage (Planned): - Cache-friendly memory layout - O(matched) query performance - Optimized for iteration over large entity sets
Distributed Storage (Research): - Cross-shard queries - Eventual consistency models - Network-aware optimization