Vertica Python 项目教程

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

vertica-python/
├── AUTHORS
├── CONTRIBUTING.md
├── LICENSE
├── MANIFEST.in
├── README.md
├── Vagrantfile
├── requirements-dev.txt
├── setup.py
├── tox.ini
├── vertica_python/
│   ├── __init__.py
│   ├── connection.py
│   ├── cursor.py
│   ├── errors.py
│   ├── messages/
│   │   ├── __init__.py
│   │   ├── copy_both_req.py
│   │   ├── copy_both_resp.py
│   │   ├── ...
│   ├── types/
│   │   ├── __init__.py
│   │   ├── array.py
│   │   ├── base.py
│   │   ├── ...
│   ├── util/
│   │   ├── __init__.py
│   │   ├── helpers.py
│   │   ├── ...

目录结构介绍

• AUTHORS: 项目贡献者列表。
• CONTRIBUTING.md: 贡献指南。
• LICENSE: 项目许可证。
• MANIFEST.in: 打包清单文件。
• README.md: 项目说明文档。
• Vagrantfile: Vagrant 配置文件。
• requirements-dev.txt: 开发依赖项。
• setup.py: 安装脚本。
• tox.ini: Tox 配置文件。
• vertica_python/: 项目核心代码目录。
  • __init__.py: 模块初始化文件。
  • connection.py: 数据库连接处理。
  • cursor.py: 数据库游标处理。
  • errors.py: 错误处理。
  • messages/: 消息处理模块。
  • types/: 数据类型处理模块。
  • util/: 工具函数模块。

2. 项目的启动文件介绍

项目的启动文件主要是 setup.py，这是一个标准的 Python 安装脚本，用于安装和管理项目的依赖项。

setup.py 文件介绍

from setuptools import setup, find_packages

setup(
    name='vertica-python',
    version='1.4.0',
    description='Official native Python client for the Vertica database',
    long_description=open('README.md').read(),
    long_description_content_type='text/markdown',
    author='Justin Berka, Alex Kim, Kenneth Tran',
    author_email='[e-mail]',
    url='https://github.com/vertica/vertica-python',
    packages=find_packages(),
    install_requires=[
        'pytz',
    ],
    classifiers=[
        'Development Status :: 4 - Beta',
        'Intended Audience :: Developers',
        'License :: OSI Approved :: MIT License',
        'Operating System :: OS Independent',
        'Programming Language :: Python',
        'Topic :: Database :: Database Engines/Servers',
    ],
    license='MIT',
    keywords='database vertica',
)

启动文件功能

• 定义项目名称、版本、描述等信息。
• 读取 README.md 作为长描述。
• 指定作者和联系方式。
• 指定项目 URL 和包列表。
• 定义安装依赖项。
• 设置分类器和许可证信息。

3. 项目的配置文件介绍

项目的配置文件主要是 tox.ini，这是一个用于自动化测试的配置文件。

tox.ini 文件介绍

[tox]
envlist = py27, py34

[testenv]
deps =
    pytz
commands =
    python setup.py test

配置文件功能

• 定义测试环境列表，如 py27 和 py34。
• 指定测试环境的依赖项，如 pytz。
• 定义测试命令，如运行 python setup.py test。

通过以上介绍，您可以更好地理解和使用 vertica-python 项目。