Tartiflette 项目教程

Tartiflette 项目教程

tartifletteGraphQL Engine built with Python 3.6+ / asyncio项目地址:https://gitcode.com/gh_mirrors/ta/tartiflette

1. 项目的目录结构及介绍

tartiflette/
├── docs/
│   ├── index.md
│   └── ...
├── examples/
│   ├── basic_example.py
│   └── ...
├── tartiflette/
│   ├── __init__.py
│   ├── engine.py
│   ├── parser/
│   │   ├── __init__.py
│   │   └── ...
│   └── ...
├── tests/
│   ├── __init__.py
│   ├── test_engine.py
│   └── ...
├── .gitignore
├── LICENSE
├── README.md
├── requirements.txt
└── setup.py

目录结构说明

• docs/: 存放项目的文档文件，包括 index.md 等。
• examples/: 存放项目的示例代码，如 basic_example.py。
• tartiflette/: 项目的主要代码目录，包含核心功能实现。
  • init.py: 初始化文件。
  • engine.py: 核心引擎文件。
  • parser/: 解析器相关代码。
• tests/: 存放项目的测试代码。
• .gitignore: Git 忽略文件配置。
• LICENSE: 项目许可证文件。
• README.md: 项目介绍和使用说明。
• requirements.txt: 项目依赖文件。
• setup.py: 项目安装配置文件。

2. 项目的启动文件介绍

项目的启动文件通常是 examples/basic_example.py 或类似的文件。以下是一个典型的启动文件示例：

from tartiflette import Engine

# 定义 GraphQL 模式
schema = """
    type Query {
        hello: String
    }
"""

# 创建引擎实例
engine = Engine(schema)

# 定义查询处理函数
@engine.query("Query.hello")
async def resolve_hello(parent, args, ctx, info):
    return "Hello, world!"

# 启动服务
if __name__ == "__main__":
    engine.run(host="127.0.0.1", port=8080)

启动文件说明

• 导入模块: 导入 Engine 类。
• 定义模式: 使用 GraphQL 模式字符串定义查询类型。
• 创建引擎实例: 使用 Engine 类创建一个实例。
• 定义查询处理函数: 使用装饰器 @engine.query 定义查询处理函数。
• 启动服务: 在 __main__ 块中启动服务。

3. 项目的配置文件介绍

项目的配置文件主要包括 setup.py 和 requirements.txt。

setup.py

from setuptools import setup, find_packages

setup(
    name="tartiflette",
    version="1.0.0",
    packages=find_packages(),
    install_requires=[
        "aiohttp>=3.6.2",
        "graphql-core>=3.0.0",
    ],
    entry_points={
        "console_scripts": [
            "tartiflette-cli=tartiflette.cli:main",
        ],
    },
)

requirements.txt

aiohttp>=3.6.2
graphql-core>=3.0.0

配置文件说明

• setup.py: 用于项目的安装和打包配置。
  • name: 项目名称。
  • version: 项目版本。
  • packages: 自动查找并包含所有包。
  • install_requires: 项目依赖列表。
  • entry_points: 定义命令行工具入口。
• requirements.txt: 列出项目所需的所有依赖包及其版本。

通过以上内容，您可以了解 Tartiflette 项目的目录结构、启动文件和配置文件的基本信息。

tartifletteGraphQL Engine built with Python 3.6+ / asyncio项目地址:https://gitcode.com/gh_mirrors/ta/tartiflette