APSchedulerServer 0.1.0__py3-none-any.whl

APSchedulerServer/base_config.py

@@ -0,0 +1,37 @@
+from apscheduler.jobstores.memory import MemoryJobStore
+from apscheduler.schedulers.blocking import BlockingScheduler
+
+# 执行器配置
+SCHEDULER_EXECUTORS = {"default": {"type": "threadpool", "max_workers": 20},
+                       "cpu": {"type": "processpool", "max_workers": 8}}  # 高并发环境  # CPU核心数
+
+# 任务默认参数
+SCHEDULER_JOB_DEFAULTS = {"coalesce": True, "max_instances": 5,
+                          "misfire_grace_time": 300}  # 合并错过执行，避免堆积  # 允许一定并发  # 5分钟宽限期
+
+# APScheduler 配置
+APSCHEDULER_DATETIME_FORMAT = "N j, Y, f:s a"  # 日期时间格式
+APSCHEDULER_RUN_NOW_TIMEOUT = 25  # 最大允许运行时间（秒）
+APSCHEDULER_DELETE_OLD_JOB_EXECUTIONS = 180  # 每次有新任务执行时，系统会自动删除超过设定天数的旧记录（保留最近180天数据）
+TIME_ZONE = "Asia/Shanghai"
+
+
+
+
+class BaseConfig(object):
+
+    def set_job_stores(self):
+        return MemoryJobStore()
+
+    def set_scheduler(self):
+        scheduler = BlockingScheduler(
+            executors=SCHEDULER_EXECUTORS,
+            job_defaults=SCHEDULER_JOB_DEFAULTS,
+            timezone=TIME_ZONE
+        )
+        
+        # 添加自定义配置属性
+        scheduler.run_now_timeout = APSCHEDULER_RUN_NOW_TIMEOUT
+        scheduler.datetime_format = APSCHEDULER_DATETIME_FORMAT
+        scheduler.cleanup_days = APSCHEDULER_DELETE_OLD_JOB_EXECUTIONS
+        return scheduler

APSchedulerServer/loader.py

@@ -0,0 +1,21 @@
+import importlib
+import importlib.util
+
+class Loader(object):
+    # 默认配置类名
+    DEFAULT_CONFIG_CLASS = "APSchedulerConfig"
+
+    def __init__(self):
+        try:
+            config = importlib.import_module("APSchedulerConfig.config")
+            self.config = config.ApsConfig()
+        except Exception as e:
+            print(e)
+            self.config = None
+
+        try:
+            registry = importlib.import_module("APSchedulerConfig.registry_tasks")
+            self.set_registry_tasks = registry.set_registry_tasks
+        except Exception as e:
+            print(e)
+            self.set_registry_tasks = None

APSchedulerServer/main.py

@@ -0,0 +1,61 @@
+import sys
+import signal
+import logging
+import platform
+from .loader import Loader
+
+logger = logging.getLogger(__name__)
+
+
+def main():
+    logging.basicConfig(
+        level=logging.INFO,
+        format='%(asctime)s - %(name)s - %(levelname)s - %(message)s'
+    )
+
+    loader = Loader()
+    if loader.config is None:
+        logger.error("配置加载失败，请检查 APSchedulerConfig 模块")
+        sys.exit(1)
+
+    scheduler = loader.config.set_scheduler()
+    jobStore = loader.config.set_job_stores()
+    scheduler.add_jobstore(jobStore, "default")
+
+    if loader.set_registry_tasks:
+        loader.set_registry_tasks(scheduler)
+    else:
+        logger.warning("未找到任务注册函数")
+
+    def graceful_shutdown(signum, frame):
+        logger.info("正在关闭调度器...")
+        scheduler.shutdown()
+        sys.exit(0)
+
+    signal.signal(signal.SIGINT, graceful_shutdown)
+    signal.signal(signal.SIGTERM, graceful_shutdown)
+
+    try:
+        scheduler.start()
+        logger.info("调度器已启动")
+
+        if platform.system() == 'Windows':
+            import time
+            while scheduler.running:
+                time.sleep(1)
+        else:
+            signal.pause()
+
+    except (KeyboardInterrupt, SystemExit):
+        logger.info("收到退出信号")
+    except Exception as e:
+        logger.exception(f"调度器运行错误: {str(e)}")
+        try:
+            scheduler.shutdown(wait=False)
+        except Exception:
+            logger.exception("关闭调度器时出错")
+        sys.exit(1)
+
+
+if __name__ == "__main__":
+    main()

apschedulerserver-0.1.0.dist-info/METADATA

@@ -0,0 +1,442 @@
+Metadata-Version: 2.4
+Name: APSchedulerServer
+Version: 0.1.0
+Summary: 基于 APScheduler 的任务调度服务器，支持多种 JobStore 后端
+Author: fly
+Author-email: fly <fzkf117@163.com>
+License: MIT
+Keywords: apscheduler,scheduler,task,job,cron,redis,mysql,django
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.6
+Classifier: Programming Language :: Python :: 3.7
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Topic :: System :: Distributed Computing
+Requires-Python: >=3.6
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: APScheduler>=3.10.0
+Provides-Extra: redis
+Requires-Dist: redis>=4.0.0; extra == "redis"
+Provides-Extra: mysql
+Requires-Dist: mysql-connector-python>=8.0.0; extra == "mysql"
+Provides-Extra: django
+Requires-Dist: django>=3.2.0; extra == "django"
+Provides-Extra: sqlalchemy
+Requires-Dist: sqlalchemy>=1.4.0; extra == "sqlalchemy"
+Provides-Extra: all
+Requires-Dist: APSchedulerServer[django,mysql,redis,sqlalchemy]; extra == "all"
+Dynamic: license-file
+
+# APSchedulerServer 使用教程
+
+## 项目简介
+
+APSchedulerServer 是一个基于 APScheduler 的任务调度服务器，支持多种 JobStore 后端（Redis、MySQL、Django 等），提供了灵活的任务配置和注册机制。
+
+## 项目结构
+
+```
+APSchedulerServer/
+├── src/                     # 源代码目录
+│   └── APSchedulerServer/   # 核心代码包
+│       ├── __init__.py
+│       ├── base_config.py   # 基础配置类
+│       ├── loader.py        # 配置加载器
+│       └── main.py          # 主程序入口
+├── APSchedulerConfig/       # 配置目录（用户需要创建）
+│   ├── config.py           # 调度器配置
+│   └── registry_tasks.py   # 任务注册
+├── pyproject.toml          # 项目配置文件
+├── setup.py               # 安装脚本
+└── README.md              # 项目文档
+```
+
+## 安装
+
+### 基础安装
+
+```bash
+pip install APSchedulerServer
+```
+
+### 安装可选依赖
+
+根据所选的 JobStore，安装额外的依赖：
+
+```bash
+# Redis JobStore
+pip install APSchedulerServer[redis]
+
+# MySQL JobStore
+pip install APSchedulerServer[mysql]
+
+# Django JobStore (需要在 Django 项目中使用)
+pip install APSchedulerServer[django]
+
+# SQLAlchemy JobStore
+pip install APSchedulerServer[sqlalchemy]
+
+# 安装所有可选依赖
+pip install APSchedulerServer[all]
+```
+
+### 从源码安装
+
+```bash
+git clone https://github.com/yourusername/APSchedulerServer.git
+cd APSchedulerServer
+pip install -e .
+```
+
+## 快速开始
+
+### 1. 基础配置
+
+编辑 `APSchedulerConfig/config.py`，配置调度器和 JobStore：
+
+```python
+from APSchedulerServer.base_config import BaseConfig
+from apscheduler.jobstores.redis import RedisJobStore
+from apscheduler.jobstores.sqlalchemy import SQLAlchemyJobStore
+from apscheduler.jobstores.django import DjangoJobStore
+
+
+class ApsConfig(BaseConfig):
+
+   def __init__(self):
+      print("配置加载成功")
+
+   def set_job_stores(self):
+      """配置 JobStore"""
+      return {
+         # Redis JobStore
+         'redis': RedisJobStore(
+            jobs_key='apscheduler.jobs',
+            run_times_key='apscheduler.run_times',
+            host='localhost',
+            port=6379,
+            db=0
+         ),
+         # MySQL JobStore
+         'mysql': SQLAlchemyJobStore(
+            url='mysql+mysqlconnector://user:password@localhost/scheduler_db'
+         ),
+         # Django JobStore
+         'django': DjangoJobStore(),
+         # Memory JobStore (默认)
+         'default': MemoryJobStore()
+      }
+
+   def set_scheduler(self):
+      """配置调度器"""
+      scheduler = super().set_scheduler()
+      # 可以在这里添加自定义配置
+      return scheduler
+```
+
+### 2. 任务注册
+
+编辑 `APSchedulerConfig/registry_tasks.py`，注册你的定时任务：
+
+```python
+from apscheduler.triggers.cron import CronTrigger
+from apscheduler.triggers.interval import IntervalTrigger
+from apscheduler.triggers.date import DateTrigger
+import datetime
+
+def set_registry_tasks(scheduler):
+    """注册所有定时任务"""
+
+    # 示例1: 使用 Cron 表达式（每天 8:30 执行）
+    scheduler.add_job(
+        func=daily_task,
+        trigger=CronTrigger(hour=8, minute=30),
+        id='daily_task',
+        name='每日任务',
+        replace_existing=True
+    )
+
+    # 示例2: 使用间隔触发器（每 5 分钟执行一次）
+    scheduler.add_job(
+        func=interval_task,
+        trigger=IntervalTrigger(minutes=5),
+        id='interval_task',
+        name='间隔任务',
+        replace_existing=True
+    )
+
+    # 示例3: 使用日期触发器（在指定时间执行一次）
+    scheduler.add_job(
+        func=one_time_task,
+        trigger=DateTrigger(run_date=datetime.datetime(2024, 1, 1, 12, 0)),
+        id='one_time_task',
+        name='一次性任务',
+        replace_existing=True
+    )
+
+    print("所有任务注册完成")
+
+# 定义任务函数
+def daily_task():
+    """每日任务"""
+    print("执行每日任务")
+    # 在这里添加你的业务逻辑
+
+def interval_task():
+    """间隔任务"""
+    print("执行间隔任务")
+    # 在这里添加你的业务逻辑
+
+def one_time_task():
+    """一次性任务"""
+    print("执行一次性任务")
+    # 在这里添加你的业务逻辑
+```
+
+### 3. 运行调度器
+
+#### 方法1：使用命令行工具（推荐）
+
+```bash
+apscheduler-server
+```
+
+#### 方法2：使用 Python 模块方式
+
+在项目根目录下执行：
+
+```bash
+python -m APSchedulerServer.main
+```
+
+#### 方法3：直接运行
+
+```python
+from APSchedulerServer.main import main
+
+if __name__ == '__main__':
+    main()
+```
+
+## JobStore 配置详解
+
+### Redis JobStore
+
+```python
+from apscheduler.jobstores.redis import RedisJobStore
+
+def set_job_stores(self):
+    return {
+        'redis': RedisJobStore(
+            jobs_key='apscheduler.jobs',      # 存储任务的键名
+            run_times_key='apscheduler.run_times',  # 存储运行时间的键名
+            host='localhost',                 # Redis 主机
+            port=6379,                        # Redis 端口
+            db=0,                             # Redis 数据库
+            password='your_password'          # Redis 密码（可选）
+        )
+    }
+```
+
+### MySQL JobStore
+
+```python
+from apscheduler.jobstores.sqlalchemy import SQLAlchemyJobStore
+
+def set_job_stores(self):
+    return {
+        'mysql': SQLAlchemyJobStore(
+            url='mysql+mysqlconnector://user:password@localhost/scheduler_db'
+        )
+    }
+```
+
+支持的数据库 URL 格式：
+- MySQL: `mysql+mysqlconnector://user:password@host/dbname`
+- PostgreSQL: `postgresql://user:password@host/dbname`
+- SQLite: `sqlite:///jobs.sqlite`
+
+### Django JobStore
+
+```python
+from apscheduler.jobstores.django import DjangoJobStore
+
+def set_job_stores(self):
+    return {
+        'django': DjangoJobStore()
+    }
+```
+
+注意：使用 Django JobStore 需要将 `apscheduler` 添加到 Django 的 `INSTALLED_APPS` 中。
+
+## 高级配置
+
+### 修改执行器配置
+
+编辑 `APSchedulerServer/base_config.py` 中的 `SCHEDULER_EXECUTORS`：
+
+```python
+SCHEDULER_EXECUTORS = {
+    "default": {"type": "threadpool", "max_workers": 20},
+    "cpu": {"type": "processpool", "max_workers": 8}
+}
+```
+
+### 修改任务默认参数
+
+编辑 `APSchedulerServer/base_config.py` 中的 `SCHEDULER_JOB_DEFAULTS`：
+
+```python
+SCHEDULER_JOB_DEFAULTS = {
+    "coalesce": True,              # 合并错过的执行
+    "max_instances": 5,            # 最大并发实例数
+    "misfire_grace_time": 300      # 错过执行的宽限期（秒）
+}
+```
+
+### 时区配置
+
+编辑 `APSchedulerServer/base_config.py` 中的 `TIME_ZONE`：
+
+```python
+TIME_ZONE = "Asia/Shanghai"
+```
+
+## 常见问题
+
+### 1. 找不到模块错误
+
+确保在项目根目录下运行：
+
+```bash
+python -m APSchedulerServer.main
+```
+
+### 2. Redis 连接失败
+
+检查 Redis 服务是否启动，以及连接配置是否正确。
+
+### 3. MySQL 连接失败
+
+确保 MySQL 服务已启动，并且数据库已创建。
+
+### 4. 任务没有执行
+
+检查任务的触发器配置是否正确，以及调度器是否正常运行。
+
+## 示例项目
+
+### 示例 1: 使用 Redis JobStore
+
+```python
+# APSchedulerConfig/config.py
+from APSchedulerServer.base_config import BaseConfig
+from apscheduler.jobstores.redis import RedisJobStore
+
+
+class ApsConfig(BaseConfig):
+   def __init__(self):
+      print("Redis JobStore 配置加载成功")
+
+   def set_job_stores(self):
+      return {
+         'default': RedisJobStore(
+            host='localhost',
+            port=6379,
+            db=0
+         )
+      }
+```
+
+### 示例 2: 使用 MySQL JobStore
+
+```python
+# APSchedulerConfig/config.py
+from APSchedulerServer.base_config import BaseConfig
+from apscheduler.jobstores.sqlalchemy import SQLAlchemyJobStore
+
+
+class ApsConfig(BaseConfig):
+   def __init__(self):
+      print("MySQL JobStore 配置加载成功")
+
+   def set_job_stores(self):
+      return {
+         'default': SQLAlchemyJobStore(
+            url='mysql+mysqlconnector://user:password@localhost/scheduler_db'
+         )
+      }
+```
+
+### 示例 3: 使用 Django JobStore
+
+```python
+# APSchedulerConfig/config.py
+from APSchedulerServer.base_config import BaseConfig
+from apscheduler.jobstores.django import DjangoJobStore
+
+
+class ApsConfig(BaseConfig):
+   def __init__(self):
+      print("Django JobStore 配置加载成功")
+
+   def set_job_stores(self):
+      return {
+         'default': DjangoJobStore()
+      }
+```
+
+### 示例 4: 使用 SQLAlchemy JobStore
+
+```python
+# APSchedulerConfig/config.py
+from APSchedulerServer.base_config import BaseConfig
+from apscheduler.jobstores.sqlalchemy import SQLAlchemyJobStore
+
+
+class ApsConfig(BaseConfig):
+   def __init__(self):
+      print("SQLAlchemy JobStore 配置加载成功")
+
+   def set_job_stores(self):
+      return {
+         'default': SQLAlchemyJobStore(
+            url='postgresql://user:password@localhost/scheduler_db'
+         )
+      }
+```
+
+## 最佳实践
+
+1. **选择合适的 JobStore**：
+   - 开发环境：使用 MemoryJobStore
+   - 生产环境：使用 Redis 或 SQLAlchemy JobStore
+   - Django 项目：使用 Django JobStore
+   - 需要跨平台支持：使用 SQLAlchemy JobStore（支持 PostgreSQL、MySQL、SQLite 等）
+
+2. **任务设计**：
+   - 任务函数应该是幂等的（可以安全地多次执行）
+   - 避免长时间运行的任务
+   - 合理设置任务的并发实例数
+
+3. **监控和日志**：
+   - 添加任务执行日志
+   - 监控任务执行状态
+   - 设置任务失败告警
+
+4. **错误处理**：
+   - 在任务函数中添加适当的异常处理
+   - 设置合理的重试策略
+
+## 许可证
+
+本项目采用 MIT 许可证。

apschedulerserver-0.1.0.dist-info/RECORD

@@ -0,0 +1,10 @@
+APSchedulerServer/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+APSchedulerServer/base_config.py,sha256=6P9B_qU-AGO1FFKYFSZdQYR3PzKv0ikckC8_An3QIhw,1490
+APSchedulerServer/loader.py,sha256=SEvhmwdz5kvWOd0mEJ1KTBwnkmVTL59vW2dCaNXplFo,650
+APSchedulerServer/main.py,sha256=Yvlm1VRO30B27Ohc84NZ1vUCCA2ofmu4RGjdStPqxCI,1635
+apschedulerserver-0.1.0.dist-info/licenses/LICENSE,sha256=W4H6dAH8qOQT5sMYw3si792b44Bosyn0nISPSFi-l8w,1060
+apschedulerserver-0.1.0.dist-info/METADATA,sha256=e2cdAahhAbXnTBl4k66O-tUQxNy2yN1-hOgsr_WQitY,11725
+apschedulerserver-0.1.0.dist-info/WHEEL,sha256=YCfwYGOYMi5Jhw2fU4yNgwErybb2IX5PEwBKV4ZbdBo,91
+apschedulerserver-0.1.0.dist-info/entry_points.txt,sha256=p5k8V6JA9IxNK_aYRcx6tMlyWcCpeRbBmK3kCd1jAEI,67
+apschedulerserver-0.1.0.dist-info/top_level.txt,sha256=vtLCm0oboxNsNZoTjq1pHzBPuPavt58lqIvlTysw28c,18
+apschedulerserver-0.1.0.dist-info/RECORD,,

apschedulerserver-0.1.0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (82.0.0)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

apschedulerserver-0.1.0.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+apscheduler-server = APSchedulerServer.main:main

apschedulerserver-0.1.0.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 fly
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+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 OR COPYRIGHT HOLDERS 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.

apschedulerserver-0.1.0.dist-info/top_level.txt

@@ -0,0 +1 @@
+APSchedulerServer