CQL 教程/CQL 入门/安装

CQL 安装

安装 CQL 编译器的几种方式,以及安装完成后如何验证环境可用。

2.1环境要求

安装 CQL 之前,请先确认本机环境满足以下条件:

  • Python 3.7 及以上版本,CQL 依赖 Python 解释器来执行转译后的代码。
  • 唯一第三方依赖为 lark 解析器,其余功能均使用 Python 标准库实现。
  • 平台无关,Windows / macOS / Linux 均可正常安装与使用。

2.2从 PyPI 安装(推荐)

在终端中执行以下命令即可安装最新版本的 CQL:

bash
$ pip install cql-lang

安装完成后会得到两个命令:cql(编译器 / 解释器)与 cqlip(包管理器)。

2.3从源码安装

从 GitHub 仓库克隆源码后,在项目根目录执行:

bash
cd cql-lang
pip install .

2.4安装中文适配子包

19 个中文适配子包的依赖均为可选 extras,按需安装即可:

bash
pip install .[all]           # 安装全部中文适配子包的依赖
pip install .[web]           # CQFastAPI:fastapi + uvicorn
pip install .[desktop]       # CQPyqt:PySide6
pip install .[http]          # CQHttp:requests + httpx
pip install .[security]      # CQSecurity:PyJWT + bcrypt
pip install .[image]         # CQPillow:Pillow
pip install .[crypto]        # CQCrypto:cryptography
pip install .[data]          # CQData:pydantic v2
pip install .[office]        # CQOffice:python-docx + openpyxl
pip install .[dataframe]     # CQDataFrame:pandas + numpy
pip install .[schedule]      # CQSchedule:APScheduler
pip install .[test]          # CQTest:pytest
pip install .[orm]           # CQORM:SQLAlchemy
pip install .[datetime]      # CQDateTime:arrow + python-dateutil
pip install .[redis]         # CQRedis:redis
pip install .[cli]           # CQCLI:typer + click
提示:cqsqlite 基于 Python 内置 sqlite3,无需额外安装;cqlog 优先使用 loguru,未安装时自动回退标准库 logging;cqoffice 的 Excel 部分基于 openpyxl,无需安装 Microsoft Excel。

2.5开发模式安装

如需在源码上进行修改并让改动即时生效,可使用开发模式安装:

bash
pip install -e .

2.6运行测试

安装 pytest 后,在源码目录运行测试套件:

bash
pip install pytest
pytest tests/ -v

2.7验证安装

安装完成后,可以通过以下命令验证 CQL 是否可用:

bash
cql repl            # 进入交互式解释器
cql --help          # 查看帮助

进入 cql repl 后输入 打印("你好") 并回车,即可看到输出,说明安装成功。