easy-captcha-python 0.1.0__py3-none-any.whl

easy_captcha/constants.py

@@ -0,0 +1,55 @@
+# -*- coding: utf-8 -*-
+"""
+常量定义
+"""
+
+# 常用颜色 RGB值
+COLORS = [
+    (0, 135, 255),
+    (51, 153, 51),
+    (255, 102, 102),
+    (255, 153, 0),
+    (153, 102, 0),
+    (153, 102, 153),
+    (51, 153, 153),
+    (102, 102, 255),
+    (0, 102, 204),
+    (204, 51, 51),
+    (0, 153, 204),
+    (0, 51, 102)
+]
+
+# 验证码字符类型
+TYPE_DEFAULT = 1  # 数字和字母混合
+TYPE_ONLY_NUMBER = 2  # 纯数字
+TYPE_ONLY_CHAR = 3  # 纯字母
+TYPE_ONLY_UPPER = 4  # 纯大写字母
+TYPE_ONLY_LOWER = 5  # 纯小写字母
+TYPE_NUM_AND_UPPER = 6  # 数字和大写字母
+
+# 内置字体索引
+FONT_1 = 0
+FONT_2 = 1
+FONT_3 = 2
+FONT_4 = 3
+FONT_5 = 4
+FONT_6 = 5
+FONT_7 = 6
+FONT_8 = 7
+FONT_9 = 8
+FONT_10 = 9
+
+# 字体文件名
+FONT_NAMES = [
+    "actionj.ttf",
+    "epilog.ttf",
+    "fresnel.ttf",
+    "headache.ttf",
+    "lexo.ttf",
+    "prefix.ttf",
+    "progbot.ttf",
+    "ransom.ttf",
+    "robot.ttf",
+    "scandal.ttf"
+]
+

easy_captcha_python-0.1.0.dist-info/METADATA

@@ -0,0 +1,445 @@
+Metadata-Version: 2.4
+Name: easy-captcha-python
+Version: 0.1.0
+Summary: Python图形验证码生成库，支持GIF、中文、算术等类型
+Author-email: Kevin Roo <mostvegetableplayer@gmail.com>
+License: Apache-2.0
+Project-URL: Homepage, https://gitee.com/diamondore/EasyCaptcha-Python
+Project-URL: Repository, https://gitee.com/diamondore/EasyCaptcha-Python
+Keywords: captcha,verification code,gif,image,验证码
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python :: 3
+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
+Requires-Python: >=3.7
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: Pillow>=9.0.0
+Provides-Extra: dev
+Requires-Dist: pytest>=7.0; extra == "dev"
+Requires-Dist: pytest-cov; extra == "dev"
+Requires-Dist: black; extra == "dev"
+Requires-Dist: flake8; extra == "dev"
+Dynamic: license-file
+Dynamic: requires-python
+
+# EasyCaptcha-Python
+
+![Python](https://img.shields.io/badge/python-3.7+-blue.svg)
+![License](https://img.shields.io/badge/license-Apache%202.0-green.svg)
+
+Python 图形验证码生成库，支持 GIF、中文、算术等类型，可用于 Python Web、桌面应用等项目。
+
+这是 [EasyCaptcha](https://github.com/whvcse/EasyCaptcha) Java 版本的 Python 实现。
+
+---
+
+## 1.简介
+
+&emsp;Python 图形验证码，支持 gif、中文、算术等类型，可用于 Flask、Django、FastAPI 等 Web 框架。
+
+---
+
+## 2.效果展示
+
+**PNG 类型：**
+
+![验证码](https://s2.ax1x.com/2019/08/23/msFrE8.png)
+&emsp;&emsp;
+![验证码](https://s2.ax1x.com/2019/08/23/msF0DP.png)
+&emsp;&emsp;
+![验证码](https://s2.ax1x.com/2019/08/23/msFwut.png)
+
+**GIF 类型：**
+
+![验证码](https://s2.ax1x.com/2019/08/23/msFzVK.gif)
+&emsp;&emsp;
+![验证码](https://s2.ax1x.com/2019/08/23/msFvb6.gif)
+&emsp;&emsp;
+![验证码](https://s2.ax1x.com/2019/08/23/msFXK1.gif)
+
+**算术类型：**
+
+![验证码](https://s2.ax1x.com/2019/08/23/mskKPg.png)
+&emsp;&emsp;
+![验证码](https://s2.ax1x.com/2019/08/23/msknIS.png)
+&emsp;&emsp;
+![验证码](https://s2.ax1x.com/2019/08/23/mskma8.png)
+
+**中文类型：**
+
+![验证码](https://s2.ax1x.com/2019/08/23/mskcdK.png)
+&emsp;&emsp;
+![验证码](https://s2.ax1x.com/2019/08/23/msk6Z6.png)
+&emsp;&emsp;
+![验证码](https://s2.ax1x.com/2019/08/23/msksqx.png)
+
+**内置字体：**
+
+![验证码](https://s2.ax1x.com/2019/08/23/msAVSJ.png)
+&emsp;&emsp;
+![验证码](https://s2.ax1x.com/2019/08/23/msAAW4.png)
+&emsp;&emsp;
+![验证码](https://s2.ax1x.com/2019/08/23/msAkYF.png)
+
+---
+
+## 3.安装
+
+### 3.1.使用 pip 安装
+
+```bash
+pip install easy-captcha-python
+```
+
+### 3.2.从源码安装
+
+```bash
+git clone https://github.com/yourusername/easy-captcha-python.git
+cd easy-captcha-python
+pip install -e .
+```
+
+---
+
+## 4.使用方法
+
+### 4.1.快速开始
+
+```python
+from easy_captcha import SpecCaptcha
+from io import BytesIO
+
+# 三个参数分别为宽、高、位数
+captcha = SpecCaptcha(130, 48, 5)
+
+# 获取验证码文本
+code = captcha.text()
+print(f"验证码: {code}")
+
+# 输出到文件
+with open('captcha.png', 'wb') as f:
+    stream = BytesIO()
+    captcha.out(stream)
+    f.write(stream.getvalue())
+```
+
+### 4.2.在 Flask 中使用
+
+```python
+from flask import Flask, session, make_response
+from easy_captcha import SpecCaptcha
+from io import BytesIO
+
+app = Flask(__name__)
+app.secret_key = 'your-secret-key'
+
+@app.route('/captcha')
+def captcha():
+    # 创建验证码
+    cap = SpecCaptcha(130, 48, 5)
+    # 验证码文本存入session
+    session['captcha'] = cap.text().lower()
+
+    # 输出图片
+    stream = BytesIO()
+    cap.out(stream)
+
+    response = make_response(stream.getvalue())
+    response.headers['Content-Type'] = 'image/png'
+    return response
+
+@app.route('/verify/<code>')
+def verify(code):
+    # 获取session中的验证码
+    if code.lower() == session.get('captcha'):
+        return '验证成功'
+    return '验证失败'
+```
+
+前端 HTML 代码：
+
+```html
+<img src="/captcha" width="130px" height="48px" />
+```
+
+### 4.3.在 Django 中使用
+
+```python
+from django.http import HttpResponse
+from easy_captcha import SpecCaptcha
+from io import BytesIO
+
+def captcha(request):
+    cap = SpecCaptcha(130, 48, 5)
+    # 验证码文本存入session
+    request.session['captcha'] = cap.text().lower()
+
+    # 输出图片
+    stream = BytesIO()
+    cap.out(stream)
+
+    return HttpResponse(stream.getvalue(), content_type='image/png')
+```
+
+### 4.4.在 FastAPI 中使用
+
+```python
+from fastapi import FastAPI, Response
+from easy_captcha import SpecCaptcha
+from io import BytesIO
+
+app = FastAPI()
+
+@app.get("/captcha")
+async def captcha():
+    cap = SpecCaptcha(130, 48, 5)
+    code = cap.text()
+
+    stream = BytesIO()
+    cap.out(stream)
+
+    return Response(content=stream.getvalue(), media_type="image/png")
+```
+
+### 4.5.前后端分离项目
+
+&emsp;前后端分离项目建议使用 base64 编码返回：
+
+```python
+from flask import Flask, jsonify, request
+import uuid
+
+app = Flask(__name__)
+# 这里使用字典模拟，生产环境建议使用Redis
+captcha_store = {}
+
+@app.route('/captcha')
+def get_captcha():
+    from easy_captcha import SpecCaptcha
+
+    cap = SpecCaptcha(130, 48, 5)
+    code = cap.text().lower()
+    key = str(uuid.uuid4())
+
+    # 存储验证码（生产环境建议存到Redis并设置过期时间）
+    captcha_store[key] = code
+
+    # 返回key和base64图片
+    return jsonify({
+        'key': key,
+        'image': cap.to_base64()
+    })
+
+@app.route('/login', methods=['POST'])
+def login():
+    data = request.json
+    ver_key = data.get('verKey')
+    ver_code = data.get('verCode', '').lower()
+
+    # 验证验证码
+    if ver_code == captcha_store.get(ver_key):
+        # 验证成功后删除
+        captcha_store.pop(ver_key, None)
+        return jsonify({'success': True})
+    return jsonify({'success': False, 'message': '验证码错误'})
+```
+
+前端使用示例：
+
+```html
+<img id="verImg" width="130px" height="48px" />
+
+<script>
+    var verKey;
+    // 获取验证码
+    fetch("/captcha")
+        .then((res) => res.json())
+        .then((data) => {
+            verKey = data.key;
+            document.getElementById("verImg").src = data.image;
+        });
+
+    // 登录
+    fetch("/login", {
+        method: "POST",
+        headers: { "Content-Type": "application/json" },
+        body: JSON.stringify({
+            verKey: verKey,
+            verCode: "8u6h",
+            username: "admin",
+            password: "admin",
+        }),
+    })
+        .then((res) => res.json())
+        .then((data) => console.log(data));
+</script>
+```
+
+---
+
+## 5.更多设置
+
+### 5.1.验证码类型
+
+```python
+from easy_captcha import (
+    SpecCaptcha, GifCaptcha, ChineseCaptcha,
+    ChineseGifCaptcha, ArithmeticCaptcha
+)
+
+# PNG类型
+captcha = SpecCaptcha(130, 48, 5)
+code = captcha.text()  # 获取验证码文本
+chars = captcha.text_char()  # 获取验证码字符数组
+
+# GIF类型
+captcha = GifCaptcha(130, 48, 5)
+
+# 中文类型
+captcha = ChineseCaptcha(130, 48, 4)
+
+# 中文GIF类型
+captcha = ChineseGifCaptcha(130, 48, 4)
+
+# 算术类型
+captcha = ArithmeticCaptcha(130, 48, 2)
+captcha.len = 3  # 几位数运算，默认是两位
+formula = captcha.get_arithmetic_string()  # 获取运算公式：3+2=?
+result = captcha.text()  # 获取运算结果：5
+
+# 输出验证码
+from io import BytesIO
+stream = BytesIO()
+captcha.out(stream)
+```
+
+> 注意：<br/> > &emsp;算术验证码的 len 表示是几位数运算，而其他验证码的 len 表示验证码的位数，算术验证码的 text()表示的是公式的结果，
+> 对于算术验证码，你应该把公式的结果存储到 session，而不是公式。
+
+### 5.2.验证码字符类型
+
+| 类型               | 描述           |
+| :----------------- | :------------- |
+| TYPE_DEFAULT       | 数字和字母混合 |
+| TYPE_ONLY_NUMBER   | 纯数字         |
+| TYPE_ONLY_CHAR     | 纯字母         |
+| TYPE_ONLY_UPPER    | 纯大写字母     |
+| TYPE_ONLY_LOWER    | 纯小写字母     |
+| TYPE_NUM_AND_UPPER | 数字和大写字母 |
+
+使用方法：
+
+```python
+from easy_captcha import SpecCaptcha, TYPE_ONLY_NUMBER
+
+captcha = SpecCaptcha(130, 48, 5)
+captcha.char_type = TYPE_ONLY_NUMBER
+```
+
+> 只有`SpecCaptcha`和`GifCaptcha`设置才有效果。
+
+### 5.3.字体设置
+
+内置字体：
+
+| 字体    | 效果                                           |
+| :------ | :--------------------------------------------- |
+| FONT_1  | ![](https://s2.ax1x.com/2019/08/23/msMe6U.png) |
+| FONT_2  | ![](https://s2.ax1x.com/2019/08/23/msMAf0.png) |
+| FONT_3  | ![](https://s2.ax1x.com/2019/08/23/msMCwj.png) |
+| FONT_4  | ![](https://s2.ax1x.com/2019/08/23/msM9mQ.png) |
+| FONT_5  | ![](https://s2.ax1x.com/2019/08/23/msKz6S.png) |
+| FONT_6  | ![](https://s2.ax1x.com/2019/08/23/msKxl8.png) |
+| FONT_7  | ![](https://s2.ax1x.com/2019/08/23/msMPTs.png) |
+| FONT_8  | ![](https://s2.ax1x.com/2019/08/23/msMmXF.png) |
+| FONT_9  | ![](https://s2.ax1x.com/2019/08/23/msMVpV.png) |
+| FONT_10 | ![](https://s2.ax1x.com/2019/08/23/msMZlT.png) |
+
+使用方法：
+
+```python
+from easy_captcha import SpecCaptcha, FONT_1, FONT_2
+
+captcha = SpecCaptcha(130, 48, 5)
+
+# 设置内置字体
+captcha.set_font(FONT_1, size=32)
+
+# 也可以使用系统字体（需要PIL.ImageFont支持）
+from PIL import ImageFont
+captcha._font = ImageFont.truetype("arial.ttf", 32)
+```
+
+### 5.4.输出 base64 编码
+
+```python
+from easy_captcha import SpecCaptcha
+
+captcha = SpecCaptcha(130, 48, 5)
+base64_str = captcha.to_base64()
+
+# 如果不想要base64的头部data:image/png;base64,
+base64_str = captcha.to_base64("")  # 加一个空的参数即可
+```
+
+### 5.5.输出到文件
+
+```python
+from easy_captcha import SpecCaptcha
+from io import BytesIO
+
+captcha = SpecCaptcha(130, 48, 5)
+
+# 输出到文件
+with open('captcha.png', 'wb') as f:
+    stream = BytesIO()
+    captcha.out(stream)
+    f.write(stream.getvalue())
+```
+
+---
+
+## 6.完整示例
+
+查看 `examples/` 目录获取更多示例：
+
+-   `basic_usage.py` - 基本使用示例
+-   `all_types_demo.py` - 所有验证码类型演示
+
+运行示例：
+
+```bash
+# 运行基本示例
+python examples/basic_usage.py
+
+# 运行完整演示
+python examples/all_types_demo.py
+```
+
+所有生成的验证码图片将保存到 `./out/` 目录。
+
+---
+
+## 7.许可证
+
+Apache License 2.0
+
+---
+
+## 8.致谢
+
+本项目是 [EasyCaptcha](https://github.com/whvcse/EasyCaptcha) 的 Python 实现版本。
+
+---
+
+## 9.贡献
+
+欢迎提交 Issue 和 Pull Request！

easy_captcha_python-0.1.0.dist-info/RECORD

@@ -0,0 +1,28 @@
+easy_captcha/__init__.py,sha256=9pD-Bn3mDHOKQO8Tl3twXeuXnfV_sPlai8cYDn3BX28,1049
+easy_captcha/constants.py,sha256=EGRwpINfXVWF-9MbouUlZAzTK2nLqlD133rX8gLm6WM,980
+easy_captcha/base/__init__.py,sha256=WgOokF66LZc1f0kOJBkwRAUH9NvIFw3lghxlQs213kg,360
+easy_captcha/base/arithmetic_captcha_abstract.py,sha256=1j5srYkVQlZhZNaHOwZdWvFQVw93qtk7AmFLzWmTbgw,2327
+easy_captcha/base/captcha.py,sha256=zo1HWyVhpmVoXJiFb4aHLUom6SGrdqQR9km5SVIe_8Q,10017
+easy_captcha/base/chinese_captcha_abstract.py,sha256=tHBl87LNKbk19NMLrzFj68y6dlTd6CdrebnbLsK1kx8,4060
+easy_captcha/base/randoms.py,sha256=aQ7Mu44qM9ndYUtmMqeX_MFydk7hcdZu_noAIiCm-IY,2612
+easy_captcha/captcha/__init__.py,sha256=af9DUIkh-RFGiuoK_92lCVZKtINMh9g0RKI1497UEfU,417
+easy_captcha/captcha/arithmetic_captcha.py,sha256=QPNyX8KCYRhbT173uErL8x4txbGgsVQxXN6COPJsnBc,3240
+easy_captcha/captcha/chinese_captcha.py,sha256=mCh01efw1VT_zPDb1zZQg8q5iCShMJR4Bhms1qasOa4,3230
+easy_captcha/captcha/chinese_gif_captcha.py,sha256=Sgn9_KnfNszgOCVtmsM3DGNPwKnmBAsyrjaYrcODAPI,5547
+easy_captcha/captcha/gif_captcha.py,sha256=cxmu85R7YfvZkZkneWAjLBJmcmF8FHzZTGaEQqR8mNY,5493
+easy_captcha/captcha/spec_captcha.py,sha256=DYmgQ6ubqBubiYFpT-K8EKWzMWJYrnMChpVOWXm-snI,3188
+easy_captcha/fonts/actionj.ttf,sha256=VEQI9i-3woTFkvtaSG7W0NAGItzY97vRK0DWnMrYCPc,34944
+easy_captcha/fonts/epilog.ttf,sha256=ErdQS9dU2i67OpO9vZr3r4ZYCxDA8o8I5D63uaQIAgg,30136
+easy_captcha/fonts/fresnel.ttf,sha256=rfJdx1BDyHrDehvGK-olPasYVDvTWZmuviRKf1SRj7c,75560
+easy_captcha/fonts/headache.ttf,sha256=Tab_L454Hbocf7GSaJuzCaNX4mhEDHIvGXhNJF3bg8w,45292
+easy_captcha/fonts/lexo.ttf,sha256=mjChjEkU0eOUwZnSZw36DfgzWXaxjgneQ4gWeE_S53M,77600
+easy_captcha/fonts/prefix.ttf,sha256=u3pwW39SNi2XnY4eTn6_JuCCd6bMaVWzvZ9Yt13mCHE,99016
+easy_captcha/fonts/progbot.ttf,sha256=cvB-KMqU5qt2jO8Qzqrel8g-BSaf40N3L4Eyb3-ia_E,86956
+easy_captcha/fonts/ransom.ttf,sha256=v0BkWa6YuLnJ93D2z1FvY1r6wjTsNO9Ygj79i3NzdZM,35812
+easy_captcha/fonts/robot.ttf,sha256=Wup1XBhJsusoJoYshAnMbyB4pLP3rPR0Bf6GmNOgbiQ,45072
+easy_captcha/fonts/scandal.ttf,sha256=uXDDqJKqLc41IOFUH62OB1U-cCp1pdPqwDsNkm8lvbY,41320
+easy_captcha_python-0.1.0.dist-info/licenses/LICENSE,sha256=gcuuhKKc5-dwvyvHsXjlC9oM6N5gZ6umYbC8ewW1Yvg,35821
+easy_captcha_python-0.1.0.dist-info/METADATA,sha256=aDWsXiVOzvOzc4GkW-BPPlkWWBUFpouL43Hd7sAfnJ0,11340
+easy_captcha_python-0.1.0.dist-info/WHEEL,sha256=qELbo2s1Yzl39ZmrAibXA2jjPLUYfnVhUNTlyF1rq0Y,92
+easy_captcha_python-0.1.0.dist-info/top_level.txt,sha256=Xw8j3C2lzHMkbiHr_3frpjIy0C8XPn86WecmcS9kicc,13
+easy_captcha_python-0.1.0.dist-info/RECORD,,

easy_captcha_python-0.1.0.dist-info/WHEEL

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