future-framework 3.0.2__tar.gz → 3.1.0__tar.gz

{future_framework-3.0.2 → future_framework-3.1.0}/PKG-INFO

@@ -1,37 +1,31 @@
 Metadata-Version: 2.4
 Name: future-framework
-Version: 3.0.2
+Version: 3.1.0
 Summary: ASGI-based framework for web APIs
-License: LICENSE
-License-File: LICENSE
 Author: nicolaipre
-Requires-Python: >=3.12,<4.0
-Classifier: License :: Other/Proprietary License
-Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.12
-Classifier: Programming Language :: Python :: 3.13
-Classifier: Programming Language :: Python :: 3.14
-Classifier: Programming Language :: Python :: 3.15
-Requires-Dist: aiomysql (>=0.2.0,<0.3.0)
-Requires-Dist: aiosqlite (>=0.21.0,<0.22.0)
-Requires-Dist: asynch (>=0.2.5,<0.3.0)
-Requires-Dist: asyncpg (>=0.30.0,<0.31.0)
-Requires-Dist: clickhouse-driver (>=0.2.11,<0.3.0)
-Requires-Dist: elasticsearch (>=8.15.0,<9)
-Requires-Dist: faker (>=40.0.0,<41.0.0)
-Requires-Dist: httpx (>=0.28.1,<0.29.0)
-Requires-Dist: inflection (>=0.5.1,<0.6.0)
-Requires-Dist: pymongo (>=4.17.0,<5.0.0)
-Requires-Dist: python-dotenv (>=1.2.2,<2.0.0)
-Requires-Dist: redis (>=8.0.0,<9.0.0)
-Requires-Dist: rich (>=15.0.0,<16.0.0)
-Requires-Dist: sqlalchemy (>=2.0.51,<3.0.0)
-Requires-Dist: strawberry-graphql (>=0.323.0,<0.324.0)
-Requires-Dist: uvicorn (>=0.51.0,<0.52.0)
-Project-URL: Bug Tracker, https://github.com/nicolaipre/future-framework/issues
-Project-URL: Documentation, https://nicolaipre.github.io/future-framework/
+License-Expression: MIT
+License-File: LICENSE
+Requires-Dist: uvicorn>=0.51.0,<0.52.0
+Requires-Dist: httpx>=0.28.1,<0.29.0
+Requires-Dist: rich>=15.0.0,<16.0.0
+Requires-Dist: elasticsearch>=8.15.0,<9.0.0
+Requires-Dist: strawberry-graphql>=0.323.0,<0.324.0
+Requires-Dist: python-dotenv>=1.2.2,<2.0.0
+Requires-Dist: sqlalchemy[asyncio]>=2.0.51,<3.0.0
+Requires-Dist: inflection>=0.5.1,<0.6.0
+Requires-Dist: pymongo>=4.17.0,<5.0.0
+Requires-Dist: aiosqlite>=0.21.0,<0.22.0
+Requires-Dist: aiomysql>=0.2.0,<0.3.0
+Requires-Dist: asyncpg>=0.30.0,<0.31.0
+Requires-Dist: asynch>=0.2.5,<0.3.0
+Requires-Dist: clickhouse-driver>=0.2.11,<0.3.0
+Requires-Dist: redis>=8.0.0,<9.0.0
+Requires-Dist: faker>=40.0.0,<41.0.0
+Requires-Python: >=3.12, <4.0
 Project-URL: Homepage, https://github.com/nicolaipre/future-framework
 Project-URL: Repository, https://github.com/nicolaipre/future-framework
+Project-URL: Documentation, https://nicolaipre.github.io/future-framework/
+Project-URL: Bug Tracker, https://github.com/nicolaipre/future-framework/issues
 Description-Content-Type: text/markdown
 
 # Future
@@ -42,12 +36,12 @@ Description-Content-Type: text/markdown
 [![Coverage](https://codecov.io/gh/nicolaipre/future-framework/branch/master/graph/badge.svg)](https://codecov.io/gh/nicolaipre/future-framework)
 
 ## Documentation
-Published at **[nicolaipre.github.io/future-framework](https://nicolaipre.github.io/future-framework/)**. To preview locally: `poetry install --with docs && poetry run mkdocs serve`.
+Published at **[nicolaipre.github.io/future-framework](https://nicolaipre.github.io/future-framework/)**. To preview locally: `uv sync --group docs && uv run mkdocs serve`.
 
 ## Install
 ```bash
-poetry add future-framework
-poetry run future init myproject
+uv add future-framework
+uv run future init myproject
 ```
 
 Import name is `future` (`from future.application import Future`).
@@ -71,4 +65,3 @@ app.run(host="127.0.0.1", port=8000)
 
 ## License
 See [LICENSE](LICENSE). Versioning: [CHANGELOG.md](CHANGELOG.md).
-

{future_framework-3.0.2 → future_framework-3.1.0}/README.md

@@ -6,12 +6,12 @@
 [![Coverage](https://codecov.io/gh/nicolaipre/future-framework/branch/master/graph/badge.svg)](https://codecov.io/gh/nicolaipre/future-framework)
 
 ## Documentation
-Published at **[nicolaipre.github.io/future-framework](https://nicolaipre.github.io/future-framework/)**. To preview locally: `poetry install --with docs && poetry run mkdocs serve`.
+Published at **[nicolaipre.github.io/future-framework](https://nicolaipre.github.io/future-framework/)**. To preview locally: `uv sync --group docs && uv run mkdocs serve`.
 
 ## Install
 ```bash
-poetry add future-framework
-poetry run future init myproject
+uv add future-framework
+uv run future init myproject
 ```
 
 Import name is `future` (`from future.application import Future`).

{future_framework-3.0.2 → future_framework-3.1.0}/future/cli.py

@@ -23,13 +23,13 @@ STUB_KINDS = {
 
             ```bash
             cp .env.example .env   # DB_DATABASE=database → database.sqlite
-            poetry install
-            poetry run future make:migration ExampleModel
-            poetry run future migrate
-            poetry run future make:seed ExampleModel
-            poetry run future seed
-            poetry run python run.py
-            poetry run future routes
+            uv sync
+            uv run future make:migration ExampleModel
+            uv run future migrate
+            uv run future make:seed ExampleModel
+            uv run future seed
+            uv run python run.py
+            uv run future routes
             ```
         """).lstrip("\n"),
     },
@@ -62,23 +62,23 @@ STUB_KINDS = {
     "pyproject": {
         "path": "pyproject.toml",
         "template": dedent("""
-            [tool.poetry]
+            [project]
             name = "future-boilerplate"
             version = "0.0.1"
             description = "Boilerplate app for the Future framework."
-            authors = ["nicolaipre"]
+            requires-python = ">=3.12,<4.0"
             readme = "README.md"
+            dependencies = [
+                "python-dotenv>=1.0.1,<2.0.0",
+                "future-framework>=3.0.2,<4.0.0",
+            ]
 
-            [tool.poetry.dependencies]
-            python = "^3.12"
-            python-dotenv = "^1.0.1"
-            future-framework = "^2.0.0"
             # Or, while developing Future next to this app:
-            # future-framework = { path = "../future-framework", develop = true }
+            # [tool.uv.sources]
+            # future-framework = { path = "../future-framework", editable = true }
 
-            [build-system]
-            requires = ["poetry-core"]
-            build-backend = "poetry.core.masonry.api"
+            [tool.uv]
+            package = false
         """).lstrip("\n"),
     },
     "license": {
@@ -114,7 +114,6 @@ STUB_KINDS = {
             .vscode/
             .env
             .venv
-            poetry.lock
             __pycache__/
             *.sqlite
             *.sqlite3

{future_framework-3.0.2 → future_framework-3.1.0}/future/interfaces/ITask.py

@@ -2,7 +2,7 @@ from datetime import datetime
 from typing import Optional
 
 from future.interfacing import Interface
-from future.taskscheduler import Unit
+from future.scheduling import Unit, WorkingHours
 
 
 class ITask(Interface):
@@ -11,6 +11,7 @@ class ITask(Interface):
     unit: Optional[Unit] = None
     start_time: Optional[datetime] = None
     jitter: Optional[float] = None
+    working_hours: Optional[WorkingHours] = None
 
     async def run(self) -> None:
         raise NotImplementedError

future_framework-3.1.0/future/scheduling.py

@@ -0,0 +1,73 @@
+from datetime import datetime, time
+from enum import Enum, IntEnum
+from typing import Optional
+from zoneinfo import ZoneInfo, ZoneInfoNotFoundError
+
+
+class Unit(Enum):
+    SECONDS = "seconds"
+    MINUTES = "minutes"
+    HOURS = "hours"
+    DAYS = "days"
+
+
+class Weekday(IntEnum):
+    MONDAY = 0
+    TUESDAY = 1
+    WEDNESDAY = 2
+    THURSDAY = 3
+    FRIDAY = 4
+    SATURDAY = 5
+    SUNDAY = 6
+
+
+class WorkingHours:
+    """A recurring local-time window in which a scheduled task may run."""
+
+    def __init__(self, start: time, end: time, timezone: str = "UTC", weekdays: Optional[frozenset[Weekday]] = None) -> None:
+        self.start = start
+        self.end = end
+        self.timezone = timezone
+        self.weekdays = weekdays if weekdays is not None else frozenset({Weekday.MONDAY, Weekday.TUESDAY, Weekday.WEDNESDAY, Weekday.THURSDAY, Weekday.FRIDAY})
+        self._validate()
+
+    def _validate(self) -> None:
+        if self.start.tzinfo is not None or self.end.tzinfo is not None:
+            raise ValueError("Working-hours start and end must be timezone-naive times")
+        if self.start == self.end:
+            raise ValueError("Working-hours start and end must be different")
+
+        try:
+            ZoneInfo(self.timezone)
+        except ZoneInfoNotFoundError as error:
+            raise ValueError(f"Unknown working-hours timezone: {self.timezone}") from error
+
+        try:
+            weekdays = frozenset(Weekday(day) for day in self.weekdays)
+        except ValueError as error:
+            raise ValueError("Working-hours weekdays must contain valid Weekday values") from error
+        if not weekdays:
+            raise ValueError("Working-hours weekdays cannot be empty")
+        self.weekdays = weekdays
+
+    def allows(self, moment: datetime) -> bool:
+        """Return whether an aware instant falls within this working window."""
+        if moment.tzinfo is None:
+            raise ValueError("WorkingHours.allows requires a timezone-aware datetime")
+
+        local = moment.astimezone(ZoneInfo(self.timezone))
+        local_time = local.time()
+        weekday = Weekday(local.weekday())
+
+        if self.start < self.end:
+            return weekday in self.weekdays and self.start <= local_time < self.end
+
+        # Overnight windows belong to the day on which they open. For example,
+        # Friday 22:00-06:00 includes early Saturday morning.
+        if local_time >= self.start:
+            opening_day = weekday
+        elif local_time < self.end:
+            opening_day = Weekday((weekday - 1) % 7)
+        else:
+            return False
+        return opening_day in self.weekdays

{future_framework-3.0.2 → future_framework-3.1.0}/future/taskscheduler.py

@@ -1,36 +1,39 @@
 import asyncio
 import random
 
-from datetime import datetime, timedelta
-from enum import Enum
-from typing import Optional
+from datetime import datetime, timedelta, timezone as datetime_timezone
+from typing import Callable, Optional
 
 from future.logger import log
+from future.scheduling import Unit, Weekday, WorkingHours
 
+__all__ = ["CronScheduler", "ScheduledTask", "Unit", "Weekday", "WorkingHours"]
 
-class Unit(Enum):
-    SECONDS = "seconds"
-    MINUTES = "minutes"
-    HOURS = "hours"
-    DAYS = "days"
+
+def _as_utc(moment: datetime) -> datetime:
+    """Normalize datetimes for safe comparison and interval arithmetic."""
+    if moment.tzinfo is None:
+        moment = moment.astimezone()
+    return moment.astimezone(datetime_timezone.utc)
 
 
 class ScheduledTask:
     """Represents a scheduled task with its timing configuration."""
 
-    def __init__(self, task) -> None:
+    def __init__(self, task, now: Optional[datetime] = None) -> None:
         self.task = task
         self.name = task.name
         self.interval = task.interval
         self.unit = task.unit
-        self.start_time = task.start_time
+        self.start_time = _as_utc(task.start_time) if task.start_time is not None else _as_utc(now or datetime.now(datetime_timezone.utc))
         self.jitter = task.jitter
+        self.working_hours = getattr(task, "working_hours", None)
+        if self.working_hours is not None and not isinstance(self.working_hours, WorkingHours):
+            raise TypeError("task.working_hours must be a WorkingHours instance or None")
         self.last_run: Optional[datetime] = None
         self.next_run: Optional[datetime] = None
         self.running = False
 
-        if self.start_time is None:
-            self.start_time = datetime.now()
         self.calculate_next_run()
 
     def calculate_next_run(self) -> None:
@@ -49,21 +52,32 @@ class ScheduledTask:
         if self.next_run is not None and self.jitter and self.jitter > 0:
             self.next_run = self.next_run + timedelta(seconds=random.uniform(0, self.jitter))
 
+    def is_due(self, now: datetime) -> bool:
+        """Return whether the task is due and permitted to run now."""
+        now = _as_utc(now)
+        if self.running or self.next_run is None or now < self.next_run:
+            return False
+        return self.working_hours is None or self.working_hours.allows(now)
+
 
 class CronScheduler:
     """A cron-like scheduler for running background tasks."""
 
-    def __init__(self) -> None:
+    def __init__(self, clock: Optional[Callable[[], datetime]] = None) -> None:
         self.tasks: dict[str, ScheduledTask] = {}
         self.running = False
         self.check_interval = 1.0  # Check every second for tasks to run
+        self._clock = clock or (lambda: datetime.now(datetime_timezone.utc))
+
+    def _now(self) -> datetime:
+        return _as_utc(self._clock())
 
     def add_task(self, task) -> None:
         if task.interval is None or task.unit is None or not task.name:
             log.warning(f"Skipping task '{task.name or '?'}' - missing required parameters")
             return
 
-        scheduled = ScheduledTask(task)
+        scheduled = ScheduledTask(task, self._now())
         self.tasks[task.name] = scheduled
         jitter_note = f" (jitter 0–{task.jitter}s)" if task.jitter else ""
         log.info(f"Added scheduled task '{task.name}' to run every {task.interval} {task.unit.value}{jitter_note}")
@@ -91,7 +105,7 @@ class CronScheduler:
             log.debug(f"Running scheduled task '{scheduled.name}'")
             await scheduled.task.run()
 
-            scheduled.last_run = datetime.now()
+            scheduled.last_run = self._now()
             scheduled.calculate_next_run()
             if scheduled.next_run:
                 log.debug(f"Completed scheduled task '{scheduled.name}', next run at {scheduled.next_run.strftime('%Y-%m-%d %H:%M:%S')}")
@@ -109,12 +123,12 @@ class CronScheduler:
         log.info("Starting cron scheduler...")
 
         while self.running:
-            now = datetime.now()
+            now = self._now()
             tasks_to_run = []
 
             # Check which tasks need to run
             for scheduled in self.tasks.values():
-                if scheduled.next_run and now >= scheduled.next_run and not scheduled.running:
+                if scheduled.is_due(now):
                     scheduled.running = True
                     tasks_to_run.append(scheduled)
 

future_framework-3.1.0/pyproject.toml

@@ -0,0 +1,127 @@
+[project]
+name = "future-framework"
+version = "3.1.0"
+description = "ASGI-based framework for web APIs"
+license = "MIT"
+license-files = ["LICENSE"]
+readme = "README.md"
+requires-python = ">=3.12,<4.0"
+dependencies = [
+    "uvicorn>=0.51.0,<0.52.0",
+    "httpx>=0.28.1,<0.29.0",
+    "rich>=15.0.0,<16.0.0",
+    "elasticsearch>=8.15.0,<9.0.0",
+    "strawberry-graphql>=0.323.0,<0.324.0",
+    "python-dotenv>=1.2.2,<2.0.0",
+    "sqlalchemy[asyncio]>=2.0.51,<3.0.0",
+    "inflection>=0.5.1,<0.6.0",
+    "pymongo>=4.17.0,<5.0.0",
+    "aiosqlite>=0.21.0,<0.22.0",
+    "aiomysql>=0.2.0,<0.3.0",
+    "asyncpg>=0.30.0,<0.31.0",
+    "asynch>=0.2.5,<0.3.0",
+    "clickhouse-driver>=0.2.11,<0.3.0",
+    "redis>=8.0.0,<9.0.0",
+    "faker>=40.0.0,<41.0.0",
+]
+
+[[project.authors]]
+name = "nicolaipre"
+
+[project.urls]
+Homepage = "https://github.com/nicolaipre/future-framework"
+Repository = "https://github.com/nicolaipre/future-framework"
+Documentation = "https://nicolaipre.github.io/future-framework/"
+"Bug Tracker" = "https://github.com/nicolaipre/future-framework/issues"
+
+[project.scripts]
+future = "future.cli:main"
+
+[dependency-groups]
+dev = [
+    "pytest>=9.1.0,<10.0.0",
+    "pytest-asyncio>=1.4.0,<2.0.0",
+    "coverage>=7.15.0,<8.0.0",
+    "ruff>=0.15.0,<0.16.0",
+    "mypy>=2.3.0,<3.0.0",
+    "types-psutil>=7.2.0,<8.0.0",
+    "types-requests>=2.32.0,<3.0.0",
+    "twine>=6.2.0,<7.0.0",
+]
+docs = ["mkdocs>=1.6.1,<2.0.0"]
+
+[tool.pytest.ini_options]
+asyncio_mode = "auto"
+asyncio_default_fixture_loop_scope = "function"
+
+[tool.ruff]
+line-length = 256
+extend-exclude = [
+    ".venv",
+    "venv",
+    "build",
+    "dist",
+]
+
+[tool.ruff.lint]
+select = [
+    "E",
+    "F",
+    "W",
+    "B",
+]
+ignore = [
+    "E501",
+    "E261",
+    "E266",
+    "E302",
+    "E303",
+    "E402",
+    "E731",
+    "W291",
+    "W293",
+    "B008",
+    "B007",
+    "B009",
+    "B904",
+    "F541",
+]
+
+[tool.ruff.lint.per-file-ignores]
+"**/__init__.py" = ["F401"]
+"tests/**" = [
+    "B011",
+    "F401",
+]
+
+[tool.ruff.format]
+quote-style = "double"
+indent-style = "space"
+line-ending = "auto"
+skip-magic-trailing-comma = true
+docstring-code-format = false
+
+[tool.uv.build-backend]
+module-name = "future"
+module-root = ""
+
+[tool.mypy]
+python_version = "3.12"
+warn_return_any = false
+warn_unused_configs = true
+disallow_untyped_defs = false
+ignore_missing_imports = true
+check_untyped_defs = false
+pretty = true
+disable_error_code = [
+    "misc",
+    "var-annotated",
+    "assignment",
+    "arg-type",
+    "import-untyped",
+]
+exclude = ['(?x)(build/|dist/|\.venv/)']
+
+[build-system]
+requires = ["uv_build>=0.12.18,<0.13"]
+build-backend = "uv_build"

future_framework-3.0.2/pyproject.toml → future_framework-3.1.0/pyproject.toml.orig

@@ -1,55 +1,54 @@
-[tool.poetry]
+[project]
 name = "future-framework"
-version = "3.0.2"
+version = "3.1.0"
 description = "ASGI-based framework for web APIs"
-authors = ["nicolaipre"]
-license = "LICENSE"
+authors = [{ name = "nicolaipre" }]
+license = "MIT"
+license-files = ["LICENSE"]
 readme = "README.md"
-homepage = "https://github.com/nicolaipre/future-framework"
-repository = "https://github.com/nicolaipre/future-framework"
-documentation = "https://nicolaipre.github.io/future-framework/"
-packages = [{ include = "future" }]
+requires-python = ">=3.12,<4.0"
+dependencies = [
+    "uvicorn>=0.51.0,<0.52.0",
+    "httpx>=0.28.1,<0.29.0",
+    "rich>=15.0.0,<16.0.0",
+    "elasticsearch>=8.15.0,<9.0.0",
+    "strawberry-graphql>=0.323.0,<0.324.0",
+    "python-dotenv>=1.2.2,<2.0.0",
+    "sqlalchemy[asyncio]>=2.0.51,<3.0.0",
+    "inflection>=0.5.1,<0.6.0",
+    "pymongo>=4.17.0,<5.0.0",
+    "aiosqlite>=0.21.0,<0.22.0",
+    "aiomysql>=0.2.0,<0.3.0",
+    "asyncpg>=0.30.0,<0.31.0",
+    "asynch>=0.2.5,<0.3.0",
+    "clickhouse-driver>=0.2.11,<0.3.0",
+    "redis>=8.0.0,<9.0.0",
+    "faker>=40.0.0,<41.0.0",
+]
 
-[tool.poetry.urls]
+[project.urls]
+Homepage = "https://github.com/nicolaipre/future-framework"
+Repository = "https://github.com/nicolaipre/future-framework"
+Documentation = "https://nicolaipre.github.io/future-framework/"
 "Bug Tracker" = "https://github.com/nicolaipre/future-framework/issues"
 
-[tool.poetry.dependencies]
-python = "^3.12"
-uvicorn = "^0.51.0"
-httpx = "^0.28.1"
-rich = "^15.0.0"
-elasticsearch = ">=8.15.0,<9"
-strawberry-graphql = "^0.323.0"
-python-dotenv = "^1.2.2"
-sqlalchemy = "^2.0.51"
-inflection = "^0.5.1"
-pymongo = "^4.17.0"
-aiosqlite = "^0.21.0"
-aiomysql = "^0.2.0"
-asyncpg = "^0.30.0"
-asynch = "^0.2.5"
-clickhouse-driver = "^0.2.11"
-redis = "^8.0.0"
-faker = "^40.0.0"
-
-[tool.poetry.group.dev.dependencies]
-pytest = "^9.1.0"
-pytest-asyncio = "^1.4.0"
-coverage = "^7.15.0"
-ruff = "^0.15.0"
-mypy = "^2.3.0"
-types-psutil = "^7.2.0"
-types-requests = "^2.32.0"
-build = "^1.5.0"
-twine = "^6.2.0"
-
-[tool.poetry.group.docs.dependencies]
-mkdocs = "^1.6.1"
+[project.scripts]
+future = "future.cli:main"
 
-[tool.poetry-dynamic-versioning]
-enable = true
-vcs = "git"
-style = "semver"
+[dependency-groups]
+dev = [
+    "pytest>=9.1.0,<10.0.0",
+    "pytest-asyncio>=1.4.0,<2.0.0",
+    "coverage>=7.15.0,<8.0.0",
+    "ruff>=0.15.0,<0.16.0",
+    "mypy>=2.3.0,<3.0.0",
+    "types-psutil>=7.2.0,<8.0.0",
+    "types-requests>=2.32.0,<3.0.0",
+    "twine>=6.2.0,<7.0.0",
+]
+docs = [
+    "mkdocs>=1.6.1,<2.0.0",
+]
 
 [tool.pytest.ini_options]
 asyncio_mode = "auto"
@@ -98,8 +97,12 @@ skip-magic-trailing-comma = true
 docstring-code-format = false
 
 [build-system]
-requires = ["poetry-core"]
-build-backend = "poetry.core.masonry.api"
+requires = ["uv_build>=0.12.18,<0.13"]
+build-backend = "uv_build"
+
+[tool.uv.build-backend]
+module-name = "future"
+module-root = ""
 
 [tool.mypy]
 python_version = "3.12"
@@ -112,6 +115,3 @@ pretty = true
 # Gradual typing; Model.__table__ overrides and similar are normal in this codebase.
 disable_error_code = ["misc", "var-annotated", "assignment", "arg-type", "import-untyped"]
 exclude = ["(?x)(build/|dist/|\\.venv/)"]
-
-[tool.poetry.scripts]
-future = "future.cli:main"