CheeseAPI 0.0.1__py3-none-any.whl

CheeseAPI/server.py

@@ -0,0 +1,100 @@
+import os, datetime
+
+import CheeseType, CheeseType.network
+
+class Server:
+    def __init__(self, app):
+        from app import App
+
+        self._app: App = app
+        self.HOST: CheeseType.network.IPv4 = '127.0.0.1'
+        self.PORT: CheeseType.network.Port = 5214
+        self._WORKERS: CheeseType.NonNegativeInt = 1
+        self.IS_RELOAD: bool = False
+
+        self._IS_DEBUG: bool = False
+        self._IS_REQUEST_LOGGED: bool = True
+
+        self._STATIC_PATH: bool | str = False
+        self._LOG_FILENAME: bool | str = False
+
+    @property
+    def WORKERS(self) -> CheeseType.NonNegativeInt:
+        return self._WORKERS
+
+    @WORKERS.setter
+    def WORKERS(self, value):
+        value = CheeseType.NonNegativeInt(value)
+        if value == 0:
+            self._WORKERS = os.cpu_count() * 2
+        else:
+            self._WORKERS = value
+
+    @property
+    def IS_DEBUG(self) -> bool:
+        return self._IS_DEBUG
+
+    @IS_DEBUG.setter
+    def IS_DEBUG(self, value):
+        self._IS_DEBUG = CheeseType.Bool(value)
+        if isinstance(self._app.logger.filter, set):
+            if not self._IS_DEBUG:
+                self._app.logger.filter.add('DEBUG')
+            elif self._IS_DEBUG:
+                self._app.logger.filter.remove('DEBUG')
+
+    @property
+    def IS_REQUEST_LOGGED(self) -> bool:
+        return self._IS_REQUEST_LOGGED
+
+    @IS_REQUEST_LOGGED.setter
+    def IS_REQUEST_LOGGED(self, value):
+        self._IS_REQUEST_LOGGED = CheeseType.Bool(value)
+        if isinstance(self._app.logger.filter, set):
+            if not self._IS_REQUEST_LOGGED:
+                self._app.logger.filter.add('HTTP')
+                self._app.logger.filter.add('WEBSOCKET')
+            elif self._IS_REQUEST_LOGGED:
+                self._app.logger.filter.remove('HTTP')
+                self._app.logger.filter.add('WEBSOCKET')
+
+    @property
+    def LOG_FILENAME(self) -> str | bool:
+        return self._LOG_FILENAME
+
+    @LOG_FILENAME.setter
+    def LOG_FILENAME(self, value):
+        if self._app.process.name == 'MainProcess':
+            if value is not False:
+                if value is True:
+                    self._LOG_FILENAME = datetime.datetime.now().strftime('%Y_%m_%d-%H_%M_%S.log')
+                else:
+                    self._LOG_FILENAME = datetime.datetime.now().strftime(str(value))
+                self._app.logger.filePath = os.path.join(self._app.workspace.BASE_PATH + self._app.workspace.LOG_PATH + self.LOG_FILENAME)
+            elif value is False:
+                self._LOG_FILENAME = False
+                self._app.logger.filePath = None
+        else:
+            logPath = os.path.join(self._app.workspace.BASE_PATH + self._app.workspace.LOG_PATH)
+            logFiles = [ os.path.join(logPath, file) for file in os.listdir(logPath) if os.path.isfile(os.path.join(logPath, file)) ]
+            if not logFiles:
+                self._LOG_FILENAME = False
+                self._app.logger.filePath = None
+            else:
+                logFile = max(logFiles, key = os.path.getmtime)
+                self._LOG_FILENAME = logFile.split('/')[-1]
+                self._app.logger.filePath = logFile
+
+    @property
+    def STATIC_PATH(self) -> str | bool:
+        return self._STATIC_PATH
+
+    @STATIC_PATH.setter
+    def STATIC_PATH(self, value):
+        if value is not False:
+            if value is True:
+                self._STATIC_PATH = '/'
+            else:
+                self._STATIC_PATH = str(value)
+        elif value is False:
+            self._STATIC_PATH = False

CheeseAPI/system.py

@@ -0,0 +1,22 @@
+import platform, pkg_resources
+
+import CheeseType
+
+class System:
+    def __init__(self):
+        systems = {
+            'Windows': 'WINDOWS',
+            'Linux': 'LINUX',
+            'Darwin': 'MACOS'
+        }
+        system = platform.system()
+        if system in systems:
+            self.SYSTEM: CheeseType.System = CheeseType.System(systems[system])
+        else:
+            self.SYSTEM: CheeseType.System = CheeseType.System('OTHER')
+
+        self.PYTHON_VERSION: str = platform.python_version()
+        try:
+            self.CHEESEAPI_VERSION: str = pkg_resources.get_distribution('CheeseAPI').version
+        except:
+            self.CHEESEAPI_VERSION: str = None

CheeseAPI/websocket.py

@@ -0,0 +1,46 @@
+from typing import Dict
+
+import asyncio
+
+class Websocket:
+    def __init__(self):
+        self._CLIENTS: Dict[str, asyncio.Queue] = {}
+
+    async def _send(self, message: any, sid: str):
+        if sid in self._CLIENTS:
+            if isinstance(message, bytes):
+                async def func(send):
+                    await send({
+                        'type': 'websocket.send',
+                        'bytes': message
+                    })
+            else:
+                async def func(send):
+                    await send({
+                        'type': 'websocket.send',
+                        'text': str(message)
+                    })
+            await self._CLIENTS[sid].put(func)
+
+    async def send(self, message: any, sid: str | list[str] | None = None):
+        if not sid:
+            for key in self._CLIENTS:
+                await self._send(message, key)
+        elif isinstance(sid, list):
+            for s in sid:
+                await self._send(message, s)
+        else:
+            await self._send(message, sid)
+
+    async def _close(self, send):
+        await send({
+            'type': 'websocket.close'
+        })
+
+    async def close(self, sid: str):
+        await self._CLIENTS[sid].put(self._close)
+
+    def isOnline(self, sid: str) -> bool:
+        return sid in self._CLIENTS
+
+websocket = Websocket()

CheeseAPI/workspace.py

@@ -0,0 +1,9 @@
+import os
+
+class Workspace:
+    def __init__(self):
+        self.CHEESEAPI_PATH: str = os.path.dirname(os.path.realpath(__file__))
+        self.BASE_PATH: str = os.getcwd()
+        self.STATIC_PATH: str = '/static/'
+        self.MEDIA_PATH: str = '/media/'
+        self.LOG_PATH: str = '/logs/'

CheeseAPI-0.0.1.dist-info/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Cheese Unknown
+
+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.

CheeseAPI-0.0.1.dist-info/METADATA

@@ -0,0 +1,290 @@
+Metadata-Version: 2.1
+Name: CheeseAPI
+Version: 0.0.1
+Summary: 一款基于uvicorn的web协程框架
+Home-page: https://github.com/CheeseUnknown/CheeseAPI
+Author: Cheese Unknown
+Author-email: cheese@cheese.ren
+License: MIT
+Keywords: api framework backend asyncio
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3.11
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: uvicorn[standard]
+Requires-Dist: CheeseType
+Requires-Dist: CheeseLog
+Requires-Dist: xmltodict
+
+# **CheeseAPI**
+
+## **介绍**
+
+一款基于uvicorn的web协程框架，目前仍处于开发阶段，一些基础功能已经可以使用。
+
+目前仅保证支持python3.11。
+
+## **功能**
+
+1. 支持部分配置动态设置。
+
+2. 起飞般的请求速度。
+
+3. websocket支持。
+
+4. 类Django的项目结构。
+
+5. 外部模块导入。
+
+## **安装**
+
+```bash
+pip install CheeseAPI
+```
+
+## **使用**
+
+### **简单的示例**
+
+创建一个入口文件：
+
+```python
+# File path: /app.py
+
+from CheeseAPI import App, Request, Response
+
+app = App()
+
+@app.route('/', [ 'GET' ])
+async def index(request: Request):
+    return Response('你好，这里是CheeseAPI！')
+
+if __name__ == '__main__':
+    app.run()
+```
+
+使用命令行启动服务器，你可以看到相应的信息打印在控制台上（默认为彩色打印）:
+
+```bash
+$ python app.py
+(STARTING) 2023-08-01 00:44:11.143085 > Started CheeseAPI master process 92102
+(STARTING) 2023-08-01 00:44:11.143122 > The application starts loading...
+(STARTING) 2023-08-01 00:44:11.143133 > System information:
+    system: MacOS
+    python version: 3.11.4
+    CheeseAPI version: 0.0.1
+(STARTING) 2023-08-01 00:44:11.143142 > Workspace information:
+    CheeseAPI path: /Users/cheese/Desktop/CheeseAPI/CheeseAPI
+    base path: /Users/cheese/Desktop/CheeseAPI
+(STARTING) 2023-08-01 00:44:11.143155 > Server information:
+    host: 127.0.0.1
+    port: 5214
+    workers: 1
+    is reload: False
+    is debug: False
+    is request logged: True
+(STARTING) 2023-08-01 00:44:11.143215 > The server running on http://127.0.0.1:5214
+(STARTING) 2023-08-01 00:44:11.153093 > The server started, took 0.009919 seconds
+```
+
+此时访问`GET http://127.0.0.1:5214`，会返回相应的`Response`。
+
+### **项目结构**
+
+CheeseAPI采用类Django的结构：
+
+```
+| - User
+    | - model.py
+    | - api.py
+    | - service.py
+    | - decorator.py
+| - Permission
+    | - model.py
+    | - api.py
+    | - service.py
+    | - decorator.py
+| - app.py
+```
+
+在项目根目录下的文件夹（不包括隐藏文件夹）内的文件会在项目启动时自动导入。
+
+在CheeseAPI中并没有强制规定文件名与其代码的关联性，但建议的文件命名方式如下：
+
+| 文件名 | 备注 |
+| - | - |
+| model.py | 模型类 |
+| api.py | api接口 |
+| service.py | 业务逻辑实现 |
+| decorator.py | 装饰器 |
+
+### **用户的增删改查**
+
+该示例仅为演示，所用用户结构为普通的`class`构建，在正常项目中你应该使用`SQL`或`ORM`。
+
+在开始，首先需要创建一个用户类：
+
+```python
+# File path: /User/model.py
+
+import datetime, uuid
+from enum import Enum
+from typing import Optional
+
+class Gender(Enum):
+    MALE = 0
+    FEMALE = 1
+    UNKNOWN = 2
+
+class User:
+    def __init__(self, nickname: str, password: str, gender: Optional[Gender] = Gender.UNKNOWN):
+        self.id: uuid.UUID = uuid.uuid4()
+        self.nickname: str = nickname
+        self.password: str = password
+        self.gender: Gender = gender
+        self.join_date: datetime.datetime = datetime.datetime.now()
+```
+
+实现增删改查的逻辑代码：
+
+```python
+# File path: /User/service.py
+
+import uuid
+from typing import Optional, Dict
+
+from User.model import User, Gender
+
+users: Dict[uuid.UUID, User] = {}
+loginUsers: Dict[uuid.UUID, User] = {}
+
+# 注册用户
+def register(nickname: str, password: str, gender: Gender):
+    user = User(nickname, password, gender)
+    users[user.id] = user
+
+# 登入用户
+def login(nickname: str, password: str) -> User | None:
+    for id, user in users.item():
+        if user.nickname == nickname and user.password == password:
+            loginUsers[id] = user
+            return user
+    return None
+
+# 登出用户
+def logout(id: uuid.UUID):
+    if id in loginUsers:
+        del loginUsers[id]
+
+# 获取用户
+def get_user(id: uuid.UUID) -> User | None:
+    if id in users:
+        return users[id]
+    return None
+
+# 修改用户信息
+def set_user(id: uuid:UUID, nickname: str | None, password: str | None, gender: Gender | None) -> User | None:
+    if id in users:
+        user = users[id]
+        if nickname:
+            user.nickname = nickname
+        if password:
+            user.password = password
+        if gender:
+            user.gender = gender
+        return user
+    return None
+
+# 删除用户
+def delete_user(id: uuid.UUID) -> bool:
+    if id in loginUsers:
+        del loginUsers[id]
+    if id in users:
+        del users[id]
+        return True
+    return False
+```
+
+实现API接口，在实际项目中，你需要先进行数据的初步校验：
+
+```python
+# File path:
+
+import uuid
+
+from CheeseAPI import app, Request, Route, Response, JsonResponse
+
+from User.model import Gender
+from User import service
+
+route = Route('/User', app.route)
+
+@route.post('/register')
+def register(request: Request):
+    nickname = request.form.get('nickname')
+    password = request.form.get('password')
+    gender = Gender(request.form.get('gender', 2))
+    service.register(nickname, password, gender)
+    return Response('注册成功！')
+
+@route.post('/login')
+def login(request: Request):
+    nickname = request.form.get('nickname')
+    password = request.form.get('password')
+    user = service.login(nickname, password)
+    if user:
+        return JsonResponse(user.__dict__)
+    return Response('登入失败！', 401)
+
+@route.post('/<id:uuid>/logout')
+def logout(id: uuid.UUID):
+    service.logout(id)
+    return Response('登出成功！')
+
+@route.get('/<id:uuid>')
+def get_user(id: uuid.UUID):
+    user = service.get_user(id)
+    if user:
+        return JsonResponse(user.__dict__)
+    return Response('查找失败！', 404)
+
+@route.put('/<id:uuid>')
+def set_user(id: uuid:UUID):
+    nickname = request.form.get('nickname')
+    password = request.form.get('password')
+    gender = request.form.get('gender')
+    if gender:
+        gender = Gender(gender)
+    user = service.set_user(id, nickname, password, gender)
+    if user:
+        return JsonResponse(user.__dict__)
+    return Response('修改信息失败！', 404)
+
+@route.delete('/<id:uuid>')
+def delete_user(id: uuid:UUID):
+    flag = service.delete_user(id)
+    if flag:
+        return Response('删除用户成功！')
+    return Response('删除用户失败！', 404)
+```
+
+这样，一个简陋的用户系统就搭建完成了，其中有很多纰漏例如会把密码返回出去 :(
+
+## **更多...**
+
+### 1. **[详细配置](https://github.com/CheeseUnknown/CheeseAPI/tree/master/documents/detail.md)**
+
+### 2. **[模块](https://github.com/CheeseUnknown/CheeseAPI/tree/master/documents/module.md)**
+
+### 3. **[路由](https://github.com/CheeseUnknown/CheeseAPI/tree/master/documents/route.md)**
+
+### 4. **[请求](https://github.com/CheeseUnknown/CheeseAPI/tree/master/documents/request.md)**
+
+### 5. **[响应](https://github.com/CheeseUnknown/CheeseAPI/tree/master/documents/response.md)**
+
+### 6. **[装饰器](https://github.com/CheeseUnknown/CheeseAPI/tree/master/documents/decorator.md)**
+
+### 7. **[websocket](https://github.com/CheeseUnknown/CheeseAPI/tree/master/documents/websocket.md)**
+
+### 8. **[信号](https://github.com/CheeseUnknown/CheeseAPI/tree/master/documents/signal.md)**

CheeseAPI-0.0.1.dist-info/RECORD

@@ -0,0 +1,18 @@
+CheeseAPI/__init__.py,sha256=NY0-i6bZ9UwySWJIUBTD8I6gPLjDDRqMwq8wYzFgoPg,326
+CheeseAPI/app.py,sha256=OAIPBcCkv9SgEMQ1rXIMAEdv6hUEildlNNjswgOtuIQ,20884
+CheeseAPI/cSignal.py,sha256=pz1CbPftk9g2_C69NIpB-LS3zg7dEk_ZWVzjC5XYe28,1153
+CheeseAPI/exception.py,sha256=dQPyfbQrfcpf0WYxB0nEfhekGgMPXn_OvrZaP1O_CmM,492
+CheeseAPI/file.py,sha256=igUcsROGUWGOTMEqQNGw2NOuXA2FynAT_DwARwRPH5c,2434
+CheeseAPI/module.py,sha256=64SMJWH9e6Gqw20bR867S2TUGTKrs2Oy3nTE4MPDjk0,2287
+CheeseAPI/request.py,sha256=LP5sZh2blcNDl-GU7HryVOu9B1IwDC5QaVocvQEOIps,3674
+CheeseAPI/response.py,sha256=mUW3o2VrtRgXc1WO_X8ZorqnAnqOkAe4ddfU4Lv8xI4,12439
+CheeseAPI/route.py,sha256=24uHLiBGPS9zrkafOIzKwB4qPdkNLCqdPxu0TJSREX8,4317
+CheeseAPI/server.py,sha256=0uGVS2gosoMDozTq5PmvtkJMmq2BCkw_IbTvcrEgTtI,3525
+CheeseAPI/system.py,sha256=fFxS4m7TLoPKmAMtrjyJ_qaqX1Yit8HO8SrBW_mYOqQ,676
+CheeseAPI/websocket.py,sha256=I7viqhjafYcldYuLTdKgF_cCcImtpjddWqSdSrdhvGs,1345
+CheeseAPI/workspace.py,sha256=5VeV5UsoCPqLpeYzQf5YC-fwwxnJqEzTEY1esyLBxyc,295
+CheeseAPI-0.0.1.dist-info/LICENSE,sha256=5vFb3i4UDlskszJ3jGPh8bXrM_axJfDRRuvLu1M3bIs,1070
+CheeseAPI-0.0.1.dist-info/METADATA,sha256=r79UWaYbloPPS-1HUpqqPCYEhHzgaKjptrboVGDDaBM,7749
+CheeseAPI-0.0.1.dist-info/WHEEL,sha256=2wepM1nk4DS4eFpYrW1TTqPcoGNfHhhO_i5m4cOimbo,92
+CheeseAPI-0.0.1.dist-info/top_level.txt,sha256=aNM-zieAGzzB3H4eD7fPJBbAtRaJfF8l8Dej4cGh2qY,10
+CheeseAPI-0.0.1.dist-info/RECORD,,

CheeseAPI-0.0.1.dist-info/WHEEL

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

CheeseAPI-0.0.1.dist-info/top_level.txt

@@ -0,0 +1 @@
+CheeseAPI