asimpy 0.1.0__py3-none-any.whl → 0.2.0__py3-none-any.whl

asimpy/__init__.py

@@ -4,5 +4,5 @@ from .environment import Environment as Environment
 from .gate import Gate as Gate
 from .interrupt import Interrupt as Interrupt
 from .process import Process as Process
-from .queue import Queue as Queue
+from .queue import Queue as Queue, PriorityQueue as PriorityQueue
 from .resource import Resource as Resource

asimpy/queue.py

@@ -1,18 +1,33 @@
 """Queues."""
 
 from abc import ABC, abstractmethod
+import heapq
+from typing import TYPE_CHECKING
 from .actions import BaseAction
 
+if TYPE_CHECKING:
+    from .environment import Environment
+
 
 class BaseQueue(ABC):
-    def __init__(self, env):
+    """Base class for all queues."""
+
+    def __init__(self, env: "Environment"):
+        """
+        Generic queue construction.
+
+        Args:
+            env: simulation environment.
+        """
         self._env = env
         self._gets = []
 
     async def get(self):
+        """Get an item from the queue when one is available."""
         return await _Get(self)
 
     async def put(self, obj):
+        """Add an item to the queue."""
         await _Put(self, obj)
 
     @abstractmethod
@@ -28,8 +43,19 @@ class BaseQueue(ABC):
         pass
 
 
+# ----------------------------------------------------------------------
+
+
 class Queue(BaseQueue):
+    """FIFO queue."""
+
     def __init__(self, env):
+        """
+        Construct queue.
+
+        Args:
+            env: simulation environment.
+        """
         super().__init__(env)
         self._items = []
 
@@ -50,7 +76,39 @@ class Queue(BaseQueue):
 # ----------------------------------------------------------------------
 
 
+class PriorityQueue(BaseQueue):
+    """Priority queue (lower values have higher priority)."""
+
+    def __init__(self, env):
+        """
+        Construct queue.
+
+        Args:
+            env: simulation environment.
+        """
+        super().__init__(env)
+        self._items = []
+
+    def _dequeue(self):
+        assert len(self._items) > 0
+        return heapq.heappop(self._items)
+
+    def _enqueue(self, obj):
+        heapq.heappush(self._items, obj)
+
+    def _empty(self):
+        return len(self._items) == 0
+
+    def __str__(self):
+        return f"PriorityQueue({', '.join(str(i) for i in self._items)})"
+
+
+# ----------------------------------------------------------------------
+
+
 class _Get(BaseAction):
+    """Get an item from the queue."""
+
     def __init__(self, queue):
         super().__init__(queue._env)
         self._queue = queue
@@ -71,6 +129,8 @@ class _Get(BaseAction):
 
 
 class _Put(BaseAction):
+    """Put an item in a queue."""
+
     def __init__(self, queue, obj):
         super().__init__(queue._env)
         self._queue = queue

{asimpy-0.1.0.dist-info → asimpy-0.2.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: asimpy
-Version: 0.1.0
+Version: 0.2.0
 Summary: A simple discrete event simulator using async/await
 Author-email: Greg Wilson <gvwilson@third-bit.com>
 Maintainer-email: Greg Wilson <gvwilson@third-bit.com>
@@ -13,6 +13,7 @@ Requires-Python: >=3.13
 Provides-Extra: dev
 Requires-Dist: build>=1.4.0; extra == 'dev'
 Requires-Dist: markdown-include>=0.8.1; extra == 'dev'
+Requires-Dist: mkdocs-awesome-pages-plugin>=2.10.1; extra == 'dev'
 Requires-Dist: mkdocs-material>=9.7.1; extra == 'dev'
 Requires-Dist: mkdocs>=1.6.1; extra == 'dev'
 Requires-Dist: mkdocstrings[python]>=1.0.0; extra == 'dev'
@@ -25,3 +26,16 @@ Description-Content-Type: text/markdown
 # asimpy
 
 A simple discrete event simulation framework in Python using `async`/`await`.
+
+-   [Documentation][docs]
+-   [Package][package]
+-   [Repository][repo]
+-   [Examples][examples]
+
+*Thanks to the creators of [SimPy][simpy] for inspiration.*
+
+[docs]: https://gvwilson.github.io/asimpy
+[examples]: https://gvwilson.github.io/asimpy/examples/
+[package]: https://pypi.org/project/asimpy/
+[repo]: https://github.com/gvwilson/asimpy
+[simpy]: https://simpy.readthedocs.io/

{asimpy-0.1.0.dist-info → asimpy-0.2.0.dist-info}/RECORD

@@ -1,12 +1,12 @@
-asimpy/__init__.py,sha256=BJoqSPhuG6zSHkEqYh8OBZPrqbAn52EYg9Hjf236xRk,298
+asimpy/__init__.py,sha256=i_T5R48aoPnE3zhHaDIWmCOmvjOb32OfmSnhhUWL37g,330
 asimpy/actions.py,sha256=G9f4Zt3Mgt1dvwOgXKbdZwmoy8Z-7pxVvre2C1J-WD0,546
 asimpy/environment.py,sha256=9KooPy0v4gERqyX7H1O7cJQyYmTA04wWT8WExrqHAGI,3098
 asimpy/gate.py,sha256=MFepFLcb8TNhzbaRAF5jJFFbprbRB-Q5phf1uMdl3LA,1381
 asimpy/interrupt.py,sha256=G925y6jHB6b6y30sbq4e3jjutZDIW7Dwg9YY0mgf24Y,572
 asimpy/process.py,sha256=6LRQRHzHI8PVt_AtckSQgsAPqv65BlUNJ8xOOVx9bXs,1550
-asimpy/queue.py,sha256=qQOmQfuZ_MBS5aRax7pEuWrR6swlRmI-MU0iiWD6s-0,1938
+asimpy/queue.py,sha256=MVCEsDU5a2774Y5xKD0HlTZAnZwpBDeThbjFEXpkd8s,3287
 asimpy/resource.py,sha256=O18VJARLIZHbvntOxtTfYefGO5Zibz3EcsKWretIlxE,2107
-asimpy-0.1.0.dist-info/METADATA,sha256=oArpUAofvClqpvODhBOE_DyY2vyPWPZikHOTSQrA8MY,1044
-asimpy-0.1.0.dist-info/WHEEL,sha256=WLgqFyCfm_KASv4WHyYy0P3pM_m7J5L9k2skdKLirC8,87
-asimpy-0.1.0.dist-info/licenses/LICENSE.md,sha256=IjTDUvBk8xdl_n50CG1Vtk4FYdrS-C3uEYrRWAoOQqQ,1066
-asimpy-0.1.0.dist-info/RECORD,,
+asimpy-0.2.0.dist-info/METADATA,sha256=XxrAW1lY1xpFpn5xPF00--rFEe8pZQGcOC8WjjVaTWU,1495
+asimpy-0.2.0.dist-info/WHEEL,sha256=WLgqFyCfm_KASv4WHyYy0P3pM_m7J5L9k2skdKLirC8,87
+asimpy-0.2.0.dist-info/licenses/LICENSE.md,sha256=IjTDUvBk8xdl_n50CG1Vtk4FYdrS-C3uEYrRWAoOQqQ,1066
+asimpy-0.2.0.dist-info/RECORD,,