valar 1.1.3__tar.gz → 1.2.0__tar.gz

{valar-1.1.3/src/valar.egg-info → valar-1.2.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: valar
-Version: 1.1.3
+Version: 1.2.0
 Summary: valar for morghulis
 Home-page: https://gitee.com/GRIFFIN120/valar_dev
 Author: LYP
@@ -36,16 +36,28 @@ pip install valar
 # 1. settings
 
 ```python
-
+from django.core.management.utils import get_random_secret_key
 from pathlib import Path
 
-""" Compulsory settings """
+"""       Compulsory settings       """
+
 DEBUG = True
 BASE_DIR = Path(__file__).resolve().parent.parent
 BASE_APP = str(BASE_DIR.name)
 DEFAULT_AUTO_FIELD = 'django.db.models.BigAutoField'
-SECRET_KEY = 'django-insecure-of@tfouoq^_f$l!yki#m=6j7)@&kjri$1_$!mca-=%7=+@f@5^'
-""" Minimized compulsory settings """
+SECRET_KEY = get_random_secret_key()
+
+
+
+"""       Valar Options       """
+
+HANDLER_MAPPING = "%s.urls.channel_mapping" % BASE_APP
+MONGO_URI = 'mongodb://root:19870120@121.41.111.175:27017/'
+MINIO_URL = "s3://admin:password@120.27.8.186:9000"
+
+
+
+"""       Minimized compulsory settings       """
 
 DATABASES = {
     'default': {
@@ -53,55 +65,38 @@ DATABASES = {
         'NAME': BASE_DIR / 'db.sqlite3',
     }
 }
-
 INSTALLED_APPS = [
     'django.contrib.sessions',
     "corsheaders",
     'channels',
-    'src.valar.data',
+    'valar',
 ]
-
 MIDDLEWARE = [
     'django.contrib.sessions.middleware.SessionMiddleware',
     'corsheaders.middleware.CorsMiddleware',
     'django.middleware.common.CommonMiddleware',
 ]
-
 CHANNEL_LAYERS = {
     "default": {
         "BACKEND": "channels.layers.InMemoryChannelLayer"
     }
 }
-
 CORS_ORIGIN_ALLOW_ALL = True
 CORS_ALLOW_CREDENTIALS = True
 ROOT_URLCONF = "%s.urls" % BASE_APP
 ASGI_APPLICATION = "%s.asgi.application" % BASE_APP
 
-MONGO = {
-    'host': '<IP>',
-    'port': '<PORT>',
-    "username": "<USERNAME>",
-    "password": '<PASSWORD>'
-}
-
-MINIO = {
-    'endpoint': '<IP>:<PORT>',
-    'access_key': '<USERNAME>',
-    "secret_key": "<PASSWORD>",
-    'secure': False
-}
+"""       Optional settings       """
 
-""" Optional settings """
-# ALLOWED_HOSTS = ['*']
-# LANGUAGE_CODE = 'en-us'
-# TIME_ZONE = 'Asia/Shanghai'
-# USE_I18N = True
-# USE_TZ = False
-# SESSION_SAVE_EVERY_REQUEST = True
-# SESSION_COOKIE_AGE = 60 * 60
-# FILE_UPLOAD_MAX_MEMORY_SIZE = 1024 * 1024 * 100
-# DATA_UPLOAD_MAX_MEMORY_SIZE = 1024 * 1024 * 100
+ALLOWED_HOSTS = ['*']
+LANGUAGE_CODE = 'en-us'
+TIME_ZONE = 'Asia/Shanghai'
+USE_I18N = True
+USE_TZ = False
+SESSION_SAVE_EVERY_REQUEST = True
+SESSION_COOKIE_AGE = 60 * 60
+FILE_UPLOAD_MAX_MEMORY_SIZE = 1024 * 1024 * 100
+DATA_UPLOAD_MAX_MEMORY_SIZE = 1024 * 1024 * 100
 
 ```
 # 2. asgi
@@ -110,7 +105,7 @@ MINIO = {
 from django.core.asgi import get_asgi_application
 from channels.routing import ProtocolTypeRouter, URLRouter
 from django.urls import re_path
-from src.valar.channels import ValarConsumer
+from valar.channels.consumer import ValarConsumer
 
 application = ProtocolTypeRouter({
     'http': get_asgi_application(),
@@ -122,41 +117,39 @@ application = ProtocolTypeRouter({
 ```
 
 # 3. migrate
-```shell
-python manage.py makemigrations
-python manage.py migrate
-```
+no need, valar will auto migration
 
 
 # 4. root urls
 
-```python
-from django.urls import path, include
+no need, valar will auto set urlpatterns
 
-urlpatterns = [
-    path('data/', include('src.valar.data.urls')),
-]
+# 5. how to use valar_channel
 
-channel_mapping = {
-    # 'test': test_handler
-}
-```
 
-# 5. channel_handler
+5.1 set HANDLER_MAPPING in settings
 
 ```python
+HANDLER_MAPPING = "%s.urls.channel_mapping" % BASE_APP
+```
 
-import time
-
-from src.valar.channels.sender import ValarSocketSender
-from src.valar import Counter
-
+5.2 create a handler
 
+```python
+from valar.channels.sender import ValarSocketSender
 def test_handler(sender: ValarSocketSender):
     data = sender.data
-    length = data.get('length', 50)
-    counter = Counter(length)
+    length = data.get('length',30)
+    counter = sender.create_counter(length)
     for i in range(length):
-        time.sleep(0.1)
-        sender.to_clients(counter.tick(), sender.client, wait=True)
+        # sync method
+        sender.to_clients(counter.tick() ,sender.client, wait=True)
+```
+
+5.3 register handler in channel_mapping
+
+```python
+channel_mapping = {
+    'test': test_handler,
+}
 ```

{valar-1.1.3 → valar-1.2.0}/README.md

@@ -8,16 +8,28 @@ pip install valar
 # 1. settings
 
 ```python
-
+from django.core.management.utils import get_random_secret_key
 from pathlib import Path
 
-""" Compulsory settings """
+"""       Compulsory settings       """
+
 DEBUG = True
 BASE_DIR = Path(__file__).resolve().parent.parent
 BASE_APP = str(BASE_DIR.name)
 DEFAULT_AUTO_FIELD = 'django.db.models.BigAutoField'
-SECRET_KEY = 'django-insecure-of@tfouoq^_f$l!yki#m=6j7)@&kjri$1_$!mca-=%7=+@f@5^'
-""" Minimized compulsory settings """
+SECRET_KEY = get_random_secret_key()
+
+
+
+"""       Valar Options       """
+
+HANDLER_MAPPING = "%s.urls.channel_mapping" % BASE_APP
+MONGO_URI = 'mongodb://root:19870120@121.41.111.175:27017/'
+MINIO_URL = "s3://admin:password@120.27.8.186:9000"
+
+
+
+"""       Minimized compulsory settings       """
 
 DATABASES = {
     'default': {
@@ -25,55 +37,38 @@ DATABASES = {
         'NAME': BASE_DIR / 'db.sqlite3',
     }
 }
-
 INSTALLED_APPS = [
     'django.contrib.sessions',
     "corsheaders",
     'channels',
-    'src.valar.data',
+    'valar',
 ]
-
 MIDDLEWARE = [
     'django.contrib.sessions.middleware.SessionMiddleware',
     'corsheaders.middleware.CorsMiddleware',
     'django.middleware.common.CommonMiddleware',
 ]
-
 CHANNEL_LAYERS = {
     "default": {
         "BACKEND": "channels.layers.InMemoryChannelLayer"
     }
 }
-
 CORS_ORIGIN_ALLOW_ALL = True
 CORS_ALLOW_CREDENTIALS = True
 ROOT_URLCONF = "%s.urls" % BASE_APP
 ASGI_APPLICATION = "%s.asgi.application" % BASE_APP
 
-MONGO = {
-    'host': '<IP>',
-    'port': '<PORT>',
-    "username": "<USERNAME>",
-    "password": '<PASSWORD>'
-}
-
-MINIO = {
-    'endpoint': '<IP>:<PORT>',
-    'access_key': '<USERNAME>',
-    "secret_key": "<PASSWORD>",
-    'secure': False
-}
+"""       Optional settings       """
 
-""" Optional settings """
-# ALLOWED_HOSTS = ['*']
-# LANGUAGE_CODE = 'en-us'
-# TIME_ZONE = 'Asia/Shanghai'
-# USE_I18N = True
-# USE_TZ = False
-# SESSION_SAVE_EVERY_REQUEST = True
-# SESSION_COOKIE_AGE = 60 * 60
-# FILE_UPLOAD_MAX_MEMORY_SIZE = 1024 * 1024 * 100
-# DATA_UPLOAD_MAX_MEMORY_SIZE = 1024 * 1024 * 100
+ALLOWED_HOSTS = ['*']
+LANGUAGE_CODE = 'en-us'
+TIME_ZONE = 'Asia/Shanghai'
+USE_I18N = True
+USE_TZ = False
+SESSION_SAVE_EVERY_REQUEST = True
+SESSION_COOKIE_AGE = 60 * 60
+FILE_UPLOAD_MAX_MEMORY_SIZE = 1024 * 1024 * 100
+DATA_UPLOAD_MAX_MEMORY_SIZE = 1024 * 1024 * 100
 
 ```
 # 2. asgi
@@ -82,7 +77,7 @@ MINIO = {
 from django.core.asgi import get_asgi_application
 from channels.routing import ProtocolTypeRouter, URLRouter
 from django.urls import re_path
-from src.valar.channels import ValarConsumer
+from valar.channels.consumer import ValarConsumer
 
 application = ProtocolTypeRouter({
     'http': get_asgi_application(),
@@ -94,41 +89,39 @@ application = ProtocolTypeRouter({
 ```
 
 # 3. migrate
-```shell
-python manage.py makemigrations
-python manage.py migrate
-```
+no need, valar will auto migration
 
 
 # 4. root urls
 
-```python
-from django.urls import path, include
+no need, valar will auto set urlpatterns
 
-urlpatterns = [
-    path('data/', include('src.valar.data.urls')),
-]
+# 5. how to use valar_channel
 
-channel_mapping = {
-    # 'test': test_handler
-}
-```
 
-# 5. channel_handler
+5.1 set HANDLER_MAPPING in settings
 
 ```python
+HANDLER_MAPPING = "%s.urls.channel_mapping" % BASE_APP
+```
 
-import time
-
-from src.valar.channels.sender import ValarSocketSender
-from src.valar import Counter
-
+5.2 create a handler
 
+```python
+from valar.channels.sender import ValarSocketSender
 def test_handler(sender: ValarSocketSender):
     data = sender.data
-    length = data.get('length', 50)
-    counter = Counter(length)
+    length = data.get('length',30)
+    counter = sender.create_counter(length)
     for i in range(length):
-        time.sleep(0.1)
-        sender.to_clients(counter.tick(), sender.client, wait=True)
+        # sync method
+        sender.to_clients(counter.tick() ,sender.client, wait=True)
+```
+
+5.3 register handler in channel_mapping
+
+```python
+channel_mapping = {
+    'test': test_handler,
+}
 ```

{valar-1.1.3 → valar-1.2.0}/setup.py

@@ -16,16 +16,16 @@ requires = [
 
 setup(
     name="valar",  # 包名
-    version="1.1.3",  # 版本号
+    version="1.2.0",  # 版本号
     author="LYP",  # 作者
     author_email="liuyinpeng@buaa.edu.cn",  # 邮箱
     description="valar for morghulis",  # 简短描述
     long_description=long_description,  # 详细说明
     long_description_content_type="text/markdown",  # 详细说明使用标记类型
-    url="https://gitee.com/GRIFFIN120/valar_dev",                     # 项目主页
+    url="https://gitee.com/GRIFFIN120/valar_dev",  # 项目主页
     packages=find_packages(where="src"),  # 需要打包的部分
     package_dir={"": "src"},  # 设置src目录为根目录
     python_requires=">=3.9",  # 项目支持的Python版本
-    install_requires=requires,                     # 项目必须的依赖
+    install_requires=requires,  # 项目必须的依赖
     include_package_data=False  # 是否包含非Python文件（如资源文件）
-)
+)

valar-1.2.0/src/valar/apps.py

@@ -0,0 +1,18 @@
+import os
+from django.apps import AppConfig
+from .classes.app_mixins.auto_migration_mixin import AutoMigrationMixin
+from .classes.app_mixins.auto_urlpatterns_mixin import AutoUrlPatternsMixin
+
+valar_app = __package__.replace('src.', '')
+
+
+class ValarConfig(AutoMigrationMixin, AutoUrlPatternsMixin, AppConfig):
+    default_auto_field = 'django.db.models.BigAutoField'
+    name = __package__
+
+    def ready(self):
+        if os.environ.get('RUN_MAIN') == 'true':
+            from .dao.frame import MetaFrame
+            getattr(super(), 'set_url', None)()
+            getattr(super(), 'auto_migrate', None)()
+            MetaFrame()

{valar-1.1.3 → valar-1.2.0}/src/valar/channels/consumer.py

@@ -1,8 +1,8 @@
-
 from channels.generic.websocket import AsyncJsonWebsocketConsumer
 
 VALAR_CHANNEL_GROUP = 'VALAR'
 
+
 class ValarConsumer(AsyncJsonWebsocketConsumer):
 
     def __init__(self):
@@ -24,25 +24,23 @@ class ValarConsumer(AsyncJsonWebsocketConsumer):
         pass
 
     async def user_emit(self, event):
-        users: list = event.get('users',[])
-        data = event.get('data',{})
+        users: list = event.get('users', [])
+        data = event.get('data', {})
         if self.uid in users:
             await self.send_json(data)
 
     async def client_emit(self, event):
-        clients: list = event.get('clients',[])
-        data = event.get('data',{})
+        clients: list = event.get('clients', [])
+        data = event.get('data', {})
         if self.client in clients:
             await self.send_json(data)
 
     async def broadcast_emit(self, event):
-        data = event.get('data',{})
+        data = event.get('data', {})
         await self.send_json(data)
 
     async def register_emit(self, event):
-        users: list = event.get('users', [])
-        clients: list = event.get('clients',[])
-        if self.client in clients:
-            self.uid = users[0]
-
-
+        uid = event.get('uid', )
+        client = event.get('client')
+        if self.client == client:
+            self.uid = uid

valar-1.2.0/src/valar/channels/executer.py

@@ -0,0 +1,14 @@
+import asyncio
+
+from ..channels.sender import ValarChannelSender
+
+
+async def execute_channel(method, sender: ValarChannelSender):
+    thread = asyncio.to_thread(__execute__, method, sender)
+    asyncio.create_task(thread)
+
+
+def __execute__(method, sender: ValarChannelSender):
+    sender.start()
+    method(sender)
+    sender.stop()

valar-1.2.0/src/valar/channels/sender.py

@@ -0,0 +1,116 @@
+import json
+import time
+from datetime import datetime
+
+from asgiref.sync import async_to_sync
+from channels.layers import get_channel_layer
+from django.http import HttpRequest
+import threading
+from .consumer import VALAR_CHANNEL_GROUP
+
+
+class Channel:
+
+    def __init__(self, request: HttpRequest):
+        body = json.loads(request.body)
+        self.handler = body.get('handler')
+        self.url = body.get('url')
+        self.auth = body.get('auth')
+        self.broadcast = body.get('broadcast')
+        self.data = body.get('data')
+
+    def to_dict(self, status, payload):
+        data = {
+            'handler': self.handler,
+            'url': self.url,
+            'auth': self.auth,
+            'broadcast': self.broadcast,
+            'timestamp': datetime.now().timestamp()
+        }
+        if status:
+            data.update({'status': status})
+        if payload:
+            data.update({'payload': payload})
+        return data
+
+
+class Sender:
+
+    def __init__(self, request: HttpRequest):
+        self.client = request.headers.get('CLIENT')
+        self.uid = request.session.get('UID')
+        self.group_send = async_to_sync(get_channel_layer().group_send)
+
+
+class ValarChannelSender(Sender):
+
+    def __init__(self, request: HttpRequest, interval=1):
+        super().__init__(request)
+        self.__channel__ = Channel(request)
+        self.data = self.__channel__.data
+        self.__payload__ = None
+        self.__loading__ = False
+        self.__thread__ = None
+        self.__lock__ = threading.Lock()
+        self.__interval__ = interval
+        if self.__channel__.auth and not self.uid:
+            raise Exception('Unauthorized!')
+
+    def _run(self):
+        while self.__loading__:
+            self.__emit__()
+            time.sleep(self.__interval__)
+
+    def start(self):
+        if self.__loading__:
+            return  # 避免重复启动
+        self.__payload__ = None
+        self.__loading__ = True
+        self.__emit__('start')
+        self.__thread__ = threading.Thread(target=self._run, daemon=True)
+        self.__thread__.start()
+
+    def stop(self):
+        self.__payload__ = None
+        self.__loading__ = False
+        self.__emit__('stop')
+        if self.__thread__:
+            self.__thread__.join()
+            self.__thread__ = None
+
+    def load(self, payload):
+        with self.__lock__:
+            self.__payload__ = payload
+
+    def done(self, payload):
+        self.__emit__('done', payload)
+
+    def __emit__(self, status='proceed', data=None):
+        scope = 'broadcast' if self.__channel__.broadcast else 'client'
+        body = {
+            'type': f'{scope}.emit',
+            'data': self.__channel__.to_dict(status, data or self.__payload__),
+            'clients': [self.client],
+            'users': []
+        }
+        self.group_send(VALAR_CHANNEL_GROUP, body)
+
+
+class ValarSocketSender(Sender):
+    def __init__(self, request: HttpRequest):
+        super().__init__(request)
+        if self.uid:
+            body = {'type': 'broadcast.emit', 'uid': self.uid, 'client': self.client}
+            self.group_send(VALAR_CHANNEL_GROUP, body)
+
+    def to_users(self, payload, users: list):
+        body = {'type': 'user.emit', 'data': payload, 'users': users}
+        self.group_send(VALAR_CHANNEL_GROUP, body)
+
+    def to_clients(self, payload, clients: list):
+        body = {'type': 'client.emit', 'data': payload, 'clients': clients}
+        self.group_send(VALAR_CHANNEL_GROUP, body)
+
+    def broadcast(self, payload):
+        body = {'type': 'broadcast.emit', 'data': payload}
+        self.group_send(VALAR_CHANNEL_GROUP, body)

{valar-1.1.3 → valar-1.2.0}/src/valar/channels/views.py

@@ -1,12 +1,11 @@
-
 from .executer import execute_channel
 from .mapping import ChannelMapping
-from .sender import ValarSocketSender
+from .sender import ValarChannelSender
 from ..classes.valar_response import ValarResponse
 
 
 async def handel_channel(request, handler):
-    sender = ValarSocketSender(request)
+    sender = ValarChannelSender(request)
     method = ChannelMapping().get_handler(handler)
     await execute_channel(method, sender)
     return ValarResponse(True)

valar-1.2.0/src/valar/classes/app_mixins/auto_migration_mixin.py

@@ -0,0 +1,8 @@
+class AutoMigrationMixin:
+    name = None  # 子类必须提供
+    def auto_migrate(self):
+        from django.core.management import call_command
+        app = self.name.replace('src.','')
+        call_command('makemigrations', app, interactive=False, verbosity=0)
+        call_command('migrate', app, interactive=False, verbosity=0)
+

{valar-1.1.3/src/valar/classes → valar-1.2.0/src/valar/classes/app_mixins}/auto_urlpatterns_mixin.py

@@ -3,13 +3,13 @@ import importlib
 from django.conf import settings
 from django.urls import path, include
 
+
 class AutoUrlPatternsMixin:
     name = None  # 子类必须提供
+
     def set_url(self):
         root = settings.ROOT_URLCONF
         module = importlib.import_module(root)
         urlpatterns: list = getattr(module, 'urlpatterns')
         url = f'{self.name}.urls'
-        urlpatterns.append(path('data/', include(url)))
-
-
+        urlpatterns.append(path('valar/', include(url)))