mirror of https://github.com/nocturn9x/giambio.git
159 lines
3.7 KiB
Python
159 lines
3.7 KiB
Python
"""
|
|
Various object wrappers and abstraction layers
|
|
|
|
Copyright (C) 2020 nocturn9x
|
|
|
|
Licensed under the Apache License, Version 2.0 (the "License");
|
|
you may not use this file except in compliance with the License.
|
|
You may obtain a copy of the License at
|
|
|
|
http://www.apache.org/licenses/LICENSE-2.0
|
|
|
|
Unless required by applicable law or agreed to in writing, software
|
|
distributed under the License is distributed on an "AS IS" BASIS,
|
|
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
See the License for the specific language governing permissions and
|
|
limitations under the License.
|
|
"""
|
|
|
|
import types
|
|
from .traps import join, cancel, event_set, event_wait
|
|
from heapq import heappop, heappush
|
|
from .exceptions import GiambioError
|
|
from dataclasses import dataclass, field
|
|
|
|
|
|
@dataclass
|
|
class Task:
|
|
|
|
"""
|
|
A simple wrapper around a coroutine object
|
|
"""
|
|
|
|
coroutine: types.CoroutineType
|
|
name: str
|
|
cancelled: bool = False # True if the task gets cancelled
|
|
exc: BaseException = None
|
|
result: object = None
|
|
finished: bool = False
|
|
status: str = "init"
|
|
steps: int = 0
|
|
last_io: tuple = ()
|
|
parent: object = None
|
|
joined: bool= False
|
|
cancel_pending: bool = False
|
|
waiters: list = field(default_factory=list)
|
|
|
|
def run(self, what=None):
|
|
"""
|
|
Simple abstraction layer over coroutines' ``send`` method
|
|
"""
|
|
|
|
return self.coroutine.send(what)
|
|
|
|
def throw(self, err: Exception):
|
|
"""
|
|
Simple abstraction layer over coroutines ``throw`` method
|
|
"""
|
|
|
|
return self.coroutine.throw(err)
|
|
|
|
async def join(self):
|
|
"""
|
|
Joins the task
|
|
"""
|
|
|
|
res = await join(self)
|
|
if self.exc:
|
|
raise self.exc
|
|
return res
|
|
|
|
async def cancel(self):
|
|
"""
|
|
Cancels the task
|
|
"""
|
|
|
|
await cancel(self)
|
|
|
|
def __del__(self):
|
|
self.coroutine.close()
|
|
|
|
|
|
class Event:
|
|
"""
|
|
A class designed similarly to threading.Event
|
|
"""
|
|
|
|
def __init__(self):
|
|
"""
|
|
Object constructor
|
|
"""
|
|
|
|
self.set = False
|
|
self.waiters = []
|
|
self.event_caught = False
|
|
|
|
async def trigger(self):
|
|
"""
|
|
Sets the event, waking up all tasks that called
|
|
pause() on us
|
|
"""
|
|
|
|
if self.set:
|
|
raise GiambioError("The event has already been set")
|
|
await event_set(self)
|
|
|
|
async def wait(self):
|
|
"""
|
|
Waits until the event is set
|
|
"""
|
|
|
|
await event_wait(self)
|
|
|
|
|
|
class TimeQueue:
|
|
"""
|
|
An abstraction layer over a heap queue based on time. This is where
|
|
sleeping tasks will be put when they are not running
|
|
"""
|
|
|
|
def __init__(self, clock):
|
|
"""
|
|
Object constructor
|
|
"""
|
|
|
|
self.clock = clock
|
|
self.sequence = 0
|
|
self.container = []
|
|
|
|
def __contains__(self, item):
|
|
return item in self.container
|
|
|
|
def __iter__(self):
|
|
return iter(self.container)
|
|
|
|
def __getitem__(self, item):
|
|
return self.container.__getitem__(item)
|
|
|
|
def __bool__(self):
|
|
return bool(self.container)
|
|
|
|
def __repr__(self):
|
|
return f"TimeQueue({self.container}, clock={self.clock})"
|
|
|
|
def put(self, item, amount):
|
|
"""
|
|
Pushes an item onto the queue with its unique
|
|
time amount and ID
|
|
"""
|
|
|
|
heappush(self.container, (self.clock() + amount, self.sequence, item))
|
|
self.sequence += 1
|
|
|
|
def get(self):
|
|
"""
|
|
Gets the first task that is meant to run
|
|
"""
|
|
|
|
return heappop(self.container)[2]
|