cloudoll 2.4.0__py3-none-any.whl

cloudoll/web/http.py

@@ -0,0 +1,79 @@
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+
+__author__ = "chuchur/chuchur.com"
+# from aiohttp.web import middleware
+from curl_cffi import requests
+
+
+class Client(object):
+    def __init__(self):
+        self.session = requests.Session()
+
+    def requests(self, method, url, **kw) -> requests.Response:
+        impersonate = kw.get("impersonate", None)
+        if not impersonate:
+            kw["impersonate"] = "chrome133a"
+        fun = getattr(self.session, method, None)
+        result: requests.Response = fun(url, **kw)
+        return result
+
+
+http = Client()
+
+
+def get(url, **kw):
+    """
+    get 请求
+    :params params=dict() 传参
+    """
+    return http.requests("get", url, **kw)
+
+
+def post(url, **kw):
+    """
+    post 请求
+    :params data=dict() or json=dict() 传参
+    """
+    return http.requests("post", url, **kw)
+
+
+def put(url, **kw):
+    """
+    post 请求
+    data=dict()传参
+    """
+    return http.requests("put", url, **kw)
+
+
+def delete(url, **kw):
+    return http.requests("delete", url, **kw)
+
+
+def head(url, **kw):
+    return http.requests("head", url, **kw)
+
+
+def option(url, **kw):
+    return http.requests("option", url, **kw)
+
+
+def download(url, savepath=None, **kw):
+    """
+    下载文件
+    :params url 文件的地址
+    :params savepath 保存路径
+    """
+    response = http.requests("get", url, **kw)
+    if response.status_code == 200:
+        # 如果传入了保存路径，保存文件
+        if savepath:
+            with open(savepath, "wb") as file:
+                file.write(response.content)
+            print(f"File saved to {savepath}")
+        else:
+            # 如果没有传入保存路径，返回文件内容
+            return response.content
+    else:
+        print(f"Failed to download the file. Status code: {response.status_code}")
+        return None

cloudoll/web/jwt.py

@@ -0,0 +1,40 @@
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+
+__author__ = "chuchur/chuchur.com"
+
+import jwt, datetime
+from ..logging import print_error
+from typing import Union
+
+def encode(payload, key, exp: Union[int, str] = 3600)->str:
+    """
+    jwt 加密
+    :params payload
+    :params key
+    :params exp 过期时间单位秒，默认1个小时
+    """
+    headers = dict(typ="jwt", alg="HS256")
+    exp = datetime.datetime.now() + datetime.timedelta(seconds=eval(exp) if isinstance(exp, str) else exp)  # 过期时间
+    payload["exp"] = exp.timestamp()
+    result = jwt.encode(payload=payload, key=key, algorithm="HS256", headers=headers)
+    return result
+
+
+def decode(token, key):
+    """
+    jwt
+    :params token
+    :params key
+    """
+    try:
+        payload = jwt.decode(token, key, algorithms=['HS256'])
+        if not payload:
+            return None
+        now = datetime.datetime.now().timestamp()  # 当前时间
+        if int(now) > int(payload["exp"]):  # 登录时间过期
+            return None
+        return payload  # 返回自定义内容
+    except Exception as e:
+        print_error(e)
+        return None

cloudoll/web/requests.py

@@ -0,0 +1,161 @@
+import aiohttp
+import asyncio
+from typing import Optional, Dict, Any, Union
+
+
+class AsyncRequest:
+    def __init__(
+        self,
+        timeout: int = 30,
+        max_retries: int = 3,
+        retry_delay: float = 1.0,
+        session: Optional[aiohttp.ClientSession] = None,
+    ):
+        """
+        异步HTTP请求客户端
+
+        :param timeout: 请求超时时间(秒)
+        :param max_retries: 最大重试次数
+        :param retry_delay: 重试延迟(秒)
+        :param session: 可复用的aiohttp会话
+        """
+        self.timeout = aiohttp.ClientTimeout(total=timeout)
+        self.max_retries = max_retries
+        self.retry_delay = retry_delay
+        self._session = session
+
+    async def request(
+        self,
+        method: str,
+        url: str,
+        params: Optional[Dict[str, Any]] = None,
+        data: Optional[Union[Dict[str, Any], str, bytes]] = None,
+        json_data: Optional[Any] = None,
+        headers: Optional[Dict[str, str]] = None,
+        cookies: Optional[Dict[str, str]] = None,
+        allow_redirects: bool = True,
+        raise_for_status: bool = True,
+    ) -> aiohttp.ClientResponse:
+        """
+        执行异步HTTP请求
+
+        :param method: HTTP方法 (GET, POST, PUT, DELETE等)
+        :param url: 请求URL
+        :param params: URL查询参数
+        :param data: 请求体数据 (表单或原始数据)
+        :param json_data: JSON格式的请求体数据
+        :param headers: 请求头
+        :param cookies: cookies
+        :param allow_redirects: 是否允许重定向
+        :param raise_for_status: 是否在HTTP错误状态时抛出异常
+        :return: aiohttp.ClientResponse
+        """
+        session = self._session or aiohttp.ClientSession(timeout=self.timeout)
+        last_exception = None
+
+        for attempt in range(self.max_retries):
+            try:
+                async with session.request(
+                    method=method,
+                    url=url,
+                    params=params,
+                    data=data,
+                    json=json_data,
+                    headers=headers,
+                    cookies=cookies,
+                    allow_redirects=allow_redirects,
+                ) as response:
+                    if raise_for_status:
+                        response.raise_for_status()
+                    return response
+
+            except (aiohttp.ClientError, asyncio.TimeoutError) as e:
+                last_exception = e
+                if attempt < self.max_retries - 1:
+                    await asyncio.sleep(self.retry_delay * (attempt + 1))
+                continue
+
+        if self._session is None:
+            await session.close()
+
+        raise last_exception or RuntimeError("Request failed")
+
+    async def get(
+        self,
+        url: str,
+        params: Optional[Dict[str, Any]] = None,
+        headers: Optional[Dict[str, str]] = None,
+        **kwargs
+    ) -> aiohttp.ClientResponse:
+        """发送GET请求"""
+        return await self.request("GET", url, params=params, headers=headers, **kwargs)
+
+    async def post(
+        self,
+        url: str,
+        data: Optional[Union[Dict[str, Any], str, bytes]] = None,
+        json_data: Optional[Any] = None,
+        headers: Optional[Dict[str, str]] = None,
+        **kwargs
+    ) -> aiohttp.ClientResponse:
+        """发送POST请求"""
+        return await self.request(
+            "POST", url, data=data, json_data=json_data, headers=headers, **kwargs
+        )
+
+    async def put(
+        self,
+        url: str,
+        data: Optional[Union[Dict[str, Any], str, bytes]] = None,
+        json_data: Optional[Any] = None,
+        headers: Optional[Dict[str, str]] = None,
+        **kwargs
+    ) -> aiohttp.ClientResponse:
+        """发送PUT请求"""
+        return await self.request(
+            "PUT", url, data=data, json_data=json_data, headers=headers, **kwargs
+        )
+
+    async def delete(
+        self, url: str, headers: Optional[Dict[str, str]] = None, **kwargs
+    ) -> aiohttp.ClientResponse:
+        """发送DELETE请求"""
+        return await self.request("DELETE", url, headers=headers, **kwargs)
+
+    async def close(self) -> None:
+        """关闭客户端会话"""
+        if self._session is not None:
+            await self._session.close()
+            self._session = None
+
+    async def __aenter__(self):
+        return self
+
+    async def __aexit__(self, exc_type, exc_val, exc_tb):
+        await self.close()
+
+
+# 使用示例
+"""
+async def test():
+    async with AsyncRequest() as client:
+        try:
+            # GET请求示例
+            response = await client.get(
+                "https://httpbin.org/get",
+                params={"key": "value"},
+                headers={"User-Agent": "AsyncRequest/1.0"},
+            )
+            print(await response.json())
+
+            # POST请求示例
+            response = await client.post(
+                "https://httpbin.org/post",
+                json_data={"key": "value"},
+                headers={"Content-Type": "application/json"},
+            )
+            print(await response.json())
+
+        except Exception as e:
+            print(f"Request failed: {e}")
+"""

cloudoll/web/settings.py

@@ -0,0 +1,22 @@
+import yaml
+import os
+from ..logging import error, info
+from envyaml import EnvYAML
+
+
+def get_config(env):
+    if env is None:
+        return {}
+    conf_path = os.path.join(os.path.abspath("."), "config", f"conf.{env}.yaml")
+    info(f"loading config {conf_path}")
+    if not os.path.exists(conf_path):
+        error(f"Configuration file does not exist: {conf_path}")
+        return {}
+    with open(conf_path, "r", encoding="utf-8") as f:
+        config = yaml.safe_load(f)
+    try:
+        config_ori = EnvYAML(conf_path, strict=False)
+        config = dict(config_ori)
+    except BaseException as e:
+        error(e)
+    return config or {}

cloudoll-2.4.0.dist-info/METADATA

@@ -0,0 +1,414 @@
+Metadata-Version: 2.4
+Name: cloudoll
+Version: 2.4.0
+Summary: 辅助快速创建可分布的微服务。
+Home-page: https://gitee.com/chuchur/cloudoll-py
+Author: chuchur
+Author-email: chuchur@qq.com
+License: MIT
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.6
+Classifier: Programming Language :: Python :: Implementation :: CPython
+Classifier: Programming Language :: Python :: Implementation :: PyPy
+Requires-Python: >=3.6.0
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: watchfiles
+Requires-Dist: colorlog
+Requires-Dist: aiomysql
+Requires-Dist: aiopg
+Requires-Dist: aiohttp
+Requires-Dist: redis[hiredis]
+Requires-Dist: aiomcache
+Requires-Dist: jinja2
+Requires-Dist: pyjwt
+Requires-Dist: aiohttp_session[secure]
+Requires-Dist: PyYAML
+Requires-Dist: click
+Requires-Dist: envyaml
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: license
+Dynamic: license-file
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
+
+
+# cloudoll 云端玩具
+
+## 更新日志
+
+`2.2.28` 2023-07-04
+- 多数据库支持
+- 优化orm
+- 
+`2.0.14` 2023-07-04
+- 加入cli,devtoll
+- 优化orm
+- 
+`2.0.13` 2023-07-04
+- 修复已知 问题
+- 
+`2.0.12` 2023-07-04
+- 修复已知 问题
+- 
+`2.0.11` 2023-07-04
+- 修复已知 问题
+- 
+`2.0.10` 2023-07-04
+- 修复已知 问题
+- 
+`2.0.9` 2023-07-04
+- 修复已知 问题
+- 
+`2.0.8` 2023-07-04
+- 修复已知 问题
+- 
+`2.0.7` 2023-07-04
+- 修复logging 问题
+
+`2.0.5` 2023-07-04
+- 修复redis在 3.11+环境下的问题
+
+`2.0.4` 2023-07-04
+- 切换热更为adev
+
+
+`2.0.2` 2023-07-03
+- 优化一系列问题
+- 可以热加载
+
+`2.0.0` 2023-06-09
+- 优化一系列问题
+- orm 执行更优雅
+
+`0.1.6` 2022-11-03
+- orm 允许更新为空数据
+- server 文件上传加入大小限制
+- smtp 出错异常处理
+
+`0.1.5` 2022-09-19
+- 修复logging level 错误的问题
+- 修正默认依赖
+ 
+`0.1.4` 2022-09-12
+- 优化orm 超时的问题
+- 增加websocket 支持
+
+
+## Documentation
+
+
+[Docs](https://cloudoll.chuchur.com)
+
+[Docs](https://cloudoll.chuchur.com)
+
+[Structure](https://cloudoll.chuchur.com/structure)
+
+[Config](https://cloudoll.chuchur.com/config)
+
+[Middleware](https://cloudoll.chuchur.com/middleware)
+
+[Router](https://cloudoll.chuchur.com/router)
+
+[View](https://cloudoll.chuchur.com/view)
+
+[Cookie and Session](https://cloudoll.chuchur.com/session-cookie)
+
+[Upload file](https://cloudoll.chuchur.com/file-uploads)
+
+[WebSocket](https://cloudoll.chuchur.com/websockets)
+
+[Mysql](https://cloudoll.chuchur.com/mysql)
+
+[Deployment](https://cloudoll.chuchur.com/deployment)
+
+
+## 环境准备
+
+- 操作系统：支持 macOS，Linux，Windows
+- 运行环境：最低要求 3.6.0。
+
+## 快速开始
+
+```sh
+$ mkdir cloudoll-demo && cd cloudoll-demo
+$ pip3 install cloudoll
+$ vi app.py
+```
+
+`app.py` 内容如下:
+
+```python
+## /app.py
+from cloudoll.web import app
+
+
+if __name__ == "__main__":
+    app.create().run()
+```
+
+### 编写 Controller
+
+```sh
+$ mkdir -p controllers/home
+$ touch controllers/home/__init__.py
+$ vi controllers/home/index.py
+```
+
+`controllers/home/index.py` 内容如下:
+
+```python
+# /controllers/home/index.py
+from cloudoll.web import get
+
+@get('/')
+async def home():
+    return {"name": "chuchur" ,"msg": "ok"}
+```
+
+运行:
+```sh
+$ python3 app.py
+$ open http://localhost:9001
+```
+
+在浏览器打开 [http://127.0.0.1:9001/](http://127.0.0.1:9001/)
+
+就能看到:
+
+```json
+{ 
+    "name": "chuchur" ,
+    "msg": "ok" ,
+    "timestamp": 1681993906410 
+}
+```
+
+恭喜, 你已经成功的写好了一个 `Restful API`接口. 
+
+
+### 模板渲染
+
+绝大多数情况，我们都需要读取数据后渲染模板，然后呈现给用户。故我们需要引入对应的模板引擎。
+
+在本例中，我们使用 [Nunjucks](https://mozilla.github.io/nunjucks/) 来渲染
+```sh
+$ mkdir templates
+$ vi templates/index.html
+```
+
+`index.html` 内容如下:
+
+```html
+<!-- /templates/index.html -->
+
+<!DOCTYPE html>
+<html lang="zh">
+<head>
+    <meta charset="UTF-8">
+    <meta http-equiv="X-UA-Compatible" content="IE=edge">
+    <meta name="viewport" content="width=device-width, initial-scale=1.0">
+    <title>Home</title>
+</head>
+<body>
+    <p>My name is {{name} }</p>
+</body>
+</html>
+```
+
+
+修改 `/controllers/home/index.py` 内容如下:
+
+```python
+# /controllers/home/index.py
+from cloudoll.web import get, render_view
+
+@get('/')
+async def home():
+    data = {"name": "chuchur" ,"msg": "ok"}
+    return render_view("index.html",data)
+```
+
+这时 页面正常渲染 ,可以看到  `“My name is chuchur”`
+
+恭喜, 你已经成功的写好了一个视图页面.
+
+### 静态资源
+
+我们想在模版里面嵌入静态资源,如图片,js ,css , 这个时候就得用到静态资源. 我们把这些`js` ,`css` ,`image`  都放到 `static` 目录
+
+线上环境建议部署到 CDN，或者使用 `nginx` 等相关服务器
+
+```sh
+$ mkdir -p static/img
+$ mkdir -p static/js
+$ mkdir -p static/css
+```
+在 `img`目录 放入在张图 名`logo.png`
+
+在 `js` 目录新建 `index.js` ,内容如下:
+
+点击页面 弹出 "hello world"
+```js
+// /static/js/index.js
+document.addEventListener('DOMContentLoaded',function(){
+    document.body.addEventListener('click',function(){
+        alert('hello world.')
+    })
+})
+```
+在 `css` 目录新建 `index.css` ,内容如下:
+```css
+ /* /static/css/index.css */
+html,body {
+    width: 100%;
+    height: 100%;
+    color: red;
+}
+```
+
+修改视图 `/templates/index.html` ,在 `head` 引入 静态资源, 内容如下:
+
+```html
+<!-- /templates/index.html -->
+<!DOCTYPE html>
+<html lang="zh">
+<head>
+    <meta charset="UTF-8">
+    <meta http-equiv="X-UA-Compatible" content="IE=edge">
+    <meta name="viewport" content="width=device-width, initial-scale=1.0">
+    <link rel="icon" type="image/png" href="/static/img/logo.png"/>
+    <link rel="stylesheet" href="/static/css/index.css">
+    <script src="/static/js/index.js"></script>
+    <title>Home</title>
+</head>
+<body>
+    <p>My name is {{name} }</p>
+</body>
+</html>
+```
+
+我们新建一个配置文件, 在配置文件里面配置静态 资源.
+
+```sh
+$ mkdir config
+$ vi config/conf.local.yaml
+```
+
+`/config/conf.local.yaml` 内容如下:
+
+```yaml
+server:
+  static:
+    prefix: /static
+```
+
+
+刷新页面之后, 我们所改动即可呈现.
+
+### 编写 Middleware
+
+假设有个需求：我们的新闻站点，禁止百度爬虫访问。
+
+所以可以通过 `Middleware` 判断 User-Agent，如下：
+
+```sh
+$ mkdir middlewares
+$ vi middlewares/robot.py
+```
+
+修改 `middlewares/robot.py`, 内容如下:
+
+```python
+# /middlewares/robot.py
+from cloudoll.web import middleware, render_json
+import re
+
+@middleware()
+def mid_robot():
+    async def robot(request, handler):
+        ua = request.headers.get('user-agent')
+        if re.match('Baiduspider', ua):
+            return render_json(status=403, text="Go away , robot.")
+        return await handler(request)
+
+    return robot
+```
+
+重新启动之后, 现在可以使用 `curl http://localhost:7001/news -A "Baiduspider"` 看看效果。
+
+更多参见中间件文档。
+
+### 配置文件
+写业务的时候，不可避免的需要有配置文件，使用代码管理配置，在代码中添加多个环境的配置，在启动时传入当前环境的参数即可.
+
+cloudoll 支持根据环境来加载配置，定义多个环境的配置文件
+
+```ini
+config
+|- conf.local.yaml
+|- conf.prod.yaml
+`- conf.test.yaml
+```
+
+我们创建配置文件：
+
+```sh
+$ mkdir -p config/conf.local.yaml
+$ vi config/conf.local.yaml
+```
+
+如下是 mysql 和 server 的配置：
+
+```yaml
+server:
+  host: 192.168.0.1
+  port: 9001
+  static: false
+  client_max_size: 1024000
+  static: 
+    prefix: /static
+    show_index: true
+    append_version: true
+    follow_symlinks: true
+database:
+	mysql:
+		host: 127.0.0.1
+		port: 3306
+		user: root
+		password: abcd
+		db: blog
+		charset: utf8mb4
+```
+
+默认开发会使用默认的`local`作为配置。 启动时 通过 `env` 加载对应的配置。 如 `python3 app.py --env=prod` 会加载 `conf.prod.yaml`
+
+# cli 
+
+## 生成模型
+
+从数据库导出 `users` 表模型
+```sh
+cloudoll gen -t users 
+```
+更多参数 :
+- -p (--path) 导出的模型路径
+- -c (--create) 值 model(默认) 生成模型, 值table 建表
+- -t (--table) 要生的模型或要建的表名,以`,`分开, `ALL` 所有表
+- -env (--environment) 读取配置名 ,值 local(默认) / test / prod 
+- -db (--database) 数据库实例名,取决于配置文件,如果有多个数据库
+- -h (--help) 帮助
+
+## 开发调试
+
+```sh
+cloudoll start
+```