turnq 0.0.1__tar.gz

turnq-0.0.1/LICENSE

@@ -0,0 +1,24 @@
+This is free and unencumbered software released into the public domain.
+
+Anyone is free to copy, modify, publish, use, compile, sell, or
+distribute this software, either in source code form or as a compiled
+binary, for any purpose, commercial or non-commercial, and by any
+means.
+
+In jurisdictions that recognize copyright laws, the author or authors
+of this software dedicate any and all copyright interest in the
+software to the public domain. We make this dedication for the benefit
+of the public at large and to the detriment of our heirs and
+successors. We intend this dedication to be an overt act of
+relinquishment in perpetuity of all present and future rights to this
+software under copyright law.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
+OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
+ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+OTHER DEALINGS IN THE SOFTWARE.
+
+For more information, please refer to <http://unlicense.org/>

turnq-0.0.1/PKG-INFO

@@ -0,0 +1,20 @@
+Metadata-Version: 2.4
+Name: turnq
+Version: 0.0.1
+Summary: A priority queue scheduler for use in game development.
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-Expression: Unlicense
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3
+Classifier: Typing :: Typed
+License-File: LICENSE
+Project-URL: Changelog, https://github.com/HexDecimal/tqueue/blob/main/CHANGELOG.md
+Project-URL: Issues, https://github.com/HexDecimal/tqueue/issues
+Project-URL: Repository, https://github.com/HexDecimal/tqueue
+
+# turnq
+
+A turn-based scheduler build on top of heapq.
+

turnq-0.0.1/README.md

@@ -0,0 +1,3 @@
+# turnq
+
+A turn-based scheduler build on top of heapq.

turnq-0.0.1/pyproject.toml

@@ -0,0 +1,62 @@
+[build-system]
+requires = ["flit_scm"]
+build-backend = "flit_scm:buildapi"
+
+[project] # https://packaging.python.org/en/latest/guides/writing-pyproject-toml/
+name = "turnq"
+readme = "README.md"
+license = "Unlicense"
+dynamic = ["version", "description"]
+requires-python = ">=3.8"
+classifiers = [ # https://pypi.org/classifiers/
+    "Development Status :: 3 - Alpha",
+    "Intended Audience :: Developers",
+    "Programming Language :: Python :: 3",
+    "Typing :: Typed",
+]
+
+[project.urls] # https://packaging.python.org/en/latest/guides/writing-pyproject-toml/#urls
+Repository = "https://github.com/HexDecimal/tqueue"
+Issues = "https://github.com/HexDecimal/tqueue/issues"
+Changelog = "https://github.com/HexDecimal/tqueue/blob/main/CHANGELOG.md"
+
+[tool.setuptools_scm]
+write_to = "turnq/_version.py"
+
+[tool.coverage.report] # https://coverage.readthedocs.io/en/latest/config.html
+exclude_lines = ['^\s*\.\.\.', "if TYPE_CHECKING:", "# pragma: no cover"]
+omit = ["_version.py"]
+
+[tool.mypy] # https://mypy.readthedocs.io/en/stable/config_file.html
+files = "."
+exclude = ['^build/', '^\.']
+explicit_package_bases = true
+python_version = "3.8"
+warn_unused_configs = true
+disallow_any_generics = true
+disallow_subclassing_any = true
+disallow_untyped_calls = true
+disallow_untyped_defs = true
+disallow_incomplete_defs = true
+check_untyped_defs = true
+disallow_untyped_decorators = true
+no_implicit_optional = true
+warn_redundant_casts = true
+warn_unused_ignores = true
+warn_return_any = true
+no_implicit_reexport = true
+strict_equality = true
+
+[tool.ruff]
+line-length = 120
+
+[tool.ruff.lint] # https://docs.astral.sh/ruff/rules/
+select = ["ALL"]
+ignore = [
+    "COM",  # flake8-commas
+    "E501", # line-too-long
+    "S101", # assert
+]
+
+[tool.ruff.lint.pydocstyle]
+convention = "google" # Use Google-style docstrings

turnq-0.0.1/turnq/__init__.py

@@ -0,0 +1,122 @@
+# This is free and unencumbered software released into the public domain.
+#
+# Anyone is free to copy, modify, publish, use, compile, sell, or
+# distribute this software, either in source code form or as a compiled
+# binary, for any purpose, commercial or non-commercial, and by any
+# means.
+#
+# In jurisdictions that recognize copyright laws, the author or authors
+# of this software dedicate any and all copyright interest in the
+# software to the public domain. We make this dedication for the benefit
+# of the public at large and to the detriment of our heirs and
+# successors. We intend this dedication to be an overt act of
+# relinquishment in perpetuity of all present and future rights to this
+# software under copyright law.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+# IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
+# OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
+# ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+# OTHER DEALINGS IN THE SOFTWARE.
+#
+# For more information, please refer to <http://unlicense.org/>
+"""A priority queue scheduler for use in game development.
+
+See the queued turns time system:
+http://www.roguebasin.com/index.php?title=Time_Systems#Queued_turns
+"""
+
+from __future__ import annotations
+
+__all__ = (
+    "Ticket",
+    "TurnQueue",
+)
+
+import dataclasses
+import heapq
+from typing import Generic, NamedTuple, TypeVar
+
+try:
+    from ._version import __version__
+except ImportError:  # pragma: no cover
+    __version__ = ""
+
+T = TypeVar("T")
+
+
+class Ticket(NamedTuple, Generic[T]):
+    """Describes a scheduled object."""
+
+    time: int
+    """The time this Ticket will be returned from the scheduler."""
+    uid: int
+    """A unique number which enforces FIFO ordering of tickets with the same `time`."""
+    value: T
+    """The scheduled object."""
+    insert_time: int
+    """The time this ticket was inserted into the scheduler.
+
+    This can be used to get the delta time of this Ticket with
+    `time - insert_time` or some equivalent.
+    """
+
+    def get_time_passed(self, current_time: int) -> int:
+        """Return the amount of time passed since this Ticket was initially scheduled."""
+        return current_time - self.insert_time
+
+    def get_time_left(self, current_time: int) -> int:
+        """Return the amount of time until this Ticket is triggered."""
+        return self.time - current_time
+
+    def get_progress(self, current_time: int) -> float:
+        """Return the current progress of this Ticket as a float from 0 to 1."""
+        return self.get_time_passed(current_time) / (self.time - self.insert_time)
+
+
+@dataclasses.dataclass(eq=False)
+class TurnQueue(Generic[T]):
+    """Turned queue manager."""
+
+    time: int = 0
+    """The current tick. Always the time of the most recently popped ticket."""
+    next_uid: int = 0
+    """Incrementing unique id used to enforce FIFO order on tickets."""
+    heap: list[Ticket[T]] = dataclasses.field(default_factory=list)
+    """A min-heap queue of events maintained by Python's `heapq` module."""
+
+    def __post_init__(self) -> None:
+        """Ensure heap is sorted."""
+        heapq.heapify(self.heap)
+
+    def __bool__(self) -> bool:
+        """Return True if a scheduled object exists in this scheduler."""
+        return bool(self.heap)
+
+    def peek(self) -> Ticket[T]:
+        """Return the next scheduled ticket without removing it.
+
+        IndexError will be raised if the heap is empty.
+        """
+        return self.heap[0]
+
+    def schedule(self, interval: int, value: T) -> Ticket[T]:
+        """Schedule `value` to be returned after `internal` time passes.
+
+        Returns the new Ticket associated with the scheduled `value`.
+        """
+        ticket = Ticket(self.time + interval, self.next_uid, value, self.time)
+        self.next_uid += 1
+        heapq.heappush(self.heap, ticket)
+        return ticket
+
+    def pop(self) -> Ticket[T]:
+        """Pop and return the next scheduled Ticket from the queue.
+
+        This will set `TurnQueue.time` to the tickets current time.
+        """
+        ticket = heapq.heappop(self.heap)
+        self.time = ticket.time
+        return ticket

turnq-0.0.1/turnq/_version.py

@@ -0,0 +1,34 @@
+# file generated by setuptools-scm
+# don't change, don't track in version control
+
+__all__ = [
+    "__version__",
+    "__version_tuple__",
+    "version",
+    "version_tuple",
+    "__commit_id__",
+    "commit_id",
+]
+
+TYPE_CHECKING = False
+if TYPE_CHECKING:
+    from typing import Tuple
+    from typing import Union
+
+    VERSION_TUPLE = Tuple[Union[int, str], ...]
+    COMMIT_ID = Union[str, None]
+else:
+    VERSION_TUPLE = object
+    COMMIT_ID = object
+
+version: str
+__version__: str
+__version_tuple__: VERSION_TUPLE
+version_tuple: VERSION_TUPLE
+commit_id: COMMIT_ID
+__commit_id__: COMMIT_ID
+
+__version__ = version = '0.0.1'
+__version_tuple__ = version_tuple = (0, 0, 1)
+
+__commit_id__ = commit_id = 'g534fb0315'