Elasticsearch-Python 客户端教程

1. 项目目录结构及介绍

在 elastic/elasticsearch-py 仓库中，主要的目录结构如下：

.
├── CHANGES.txt                # 版本更新记录
├── CONTRIBUTING.rst           # 贡献指南
├── Dockerfile                  # Docker 镜像构建文件
├── docs                        # 文档源代码
│   ├── make.bat                # Windows上的文档构建脚本
│   ├── Makefile                # Linux/MacOS上的文档构建脚本
│   └── ...                     # 其他文档相关文件
├── elastic                      # 包含客户端源码
│   ├── __init__.py
│   ├── ...
├── examples                    # 示例代码
├── requirements-dev.txt        # 开发依赖项
├── setup.py                    # Python包安装配置
└── tests                       # 测试代码
    ├── conftest.py
    ├── test_client.py
    ├── test_connection.py
    └── ...                       # 更多测试文件

elastic 目录是主要的源代码存放处，包含了 elasticsearch 客户端的相关类和方法。docs 和 examples 分别存储了项目文档和示例代码，而 tests 目录则用于存放单元测试。

2. 项目启动文件介绍

由于 elasticsearch-py 是一个库而非独立的应用程序，它没有明确的 "启动" 文件。不过，你可以通过导入库并创建客户端实例来开始使用它。以下是如何初始化一个 Elasticsearch 客户端的基本步骤：

from elasticsearch import Elasticsearch

es = Elasticsearch([{'host': 'localhost', 'port': 9200}])

这段代码导入 Elasticsearch 类并创建了一个连接到本地运行的 Elasticsearch 实例的客户端对象。

3. 项目的配置文件介绍

elasticsearch-py 不直接支持配置文件，但允许在创建客户端时传递配置参数。这些参数可以通过字典形式的列表传递给 Elasticsearch 构造函数。例如：

es = Elasticsearch([
    {'host': 'localhost', 'port': 9200},
    {'host': 'backup.es.example.com', 'port': 9200, 'use_ssl': True, 'ca_certs': '/path/to/cert.pem'}
], 
    max_retries=5, retry_on_timeout=True,
)

在这个例子中，我们设置了两个节点（主节点和备份节点），还配置了最大重试次数以及超时时是否进行重试。对于更复杂的配置，可以考虑将这些设置保存在一个单独的配置文件中，然后在程序中读取它们：

import yaml
from elasticsearch import Elasticsearch

with open('config.yml') as f:
    config = yaml.safe_load(f)

es = Elasticsearch(config['nodes'], **config['connection_params'])

config.yml 可以这样编写：

nodes:
  - host: localhost
    port: 9200
  - host: backup.es.example.com
    port: 9200
    use_ssl: true
    ca_certs: /path/to/cert.pem

connection_params:
  max_retries: 5
  retry_on_timeout: true

请注意，这种方法不是官方支持的，而是根据需求自定义实现的一种方式。