aioodbc 项目教程
1. 项目的目录结构及介绍
aioodbc 项目的目录结构如下:
aioodbc/
├── aioodbc/
│ ├── __init__.py
│ ├── connection.py
│ ├── cursor.py
│ ├── pool.py
│ └── utils.py
├── tests/
│ ├── __init__.py
│ ├── test_connection.py
│ ├── test_cursor.py
│ ├── test_pool.py
│ └── test_utils.py
├── .gitignore
├── .travis.yml
├── LICENSE
├── README.md
├── setup.py
└── requirements.txt
目录介绍
aioodbc/
: 包含项目的主要代码文件。__init__.py
: 模块初始化文件。connection.py
: 处理数据库连接的代码。cursor.py
: 处理数据库游标的代码。pool.py
: 处理数据库连接池的代码。utils.py
: 包含一些工具函数。
tests/
: 包含项目的测试代码。__init__.py
: 测试模块初始化文件。test_connection.py
: 测试数据库连接的代码。test_cursor.py
: 测试数据库游标的代码。test_pool.py
: 测试数据库连接池的代码。test_utils.py
: 测试工具函数的代码。
.gitignore
: Git 忽略文件配置。.travis.yml
: Travis CI 配置文件。LICENSE
: 项目许可证文件。README.md
: 项目说明文档。setup.py
: 项目安装配置文件。requirements.txt
: 项目依赖文件。
2. 项目的启动文件介绍
aioodbc 项目的启动文件是 aioodbc/__init__.py
。这个文件包含了项目的初始化代码,并导入了其他模块以便使用。
# aioodbc/__init__.py
from .connection import connect, Connection
from .cursor import Cursor
from .pool import create_pool, Pool
__all__ = ('connect', 'Connection', 'Cursor', 'create_pool', 'Pool')
启动文件介绍
connect
: 用于创建数据库连接的函数。Connection
: 数据库连接类。Cursor
: 数据库游标类。create_pool
: 用于创建数据库连接池的函数。Pool
: 数据库连接池类。
3. 项目的配置文件介绍
aioodbc 项目的配置文件主要是 setup.py
和 requirements.txt
。
setup.py
setup.py
文件用于项目的安装和分发配置。
# setup.py
from setuptools import setup, find_packages
setup(
name='aioodbc',
version='0.5.0',
packages=find_packages(),
install_requires=[
'pyodbc',
'uvloop; platform_system != "Windows"',
],
author='Nikolay Novik',
author_email='nickolainovik@gmail.com',
description='ODBC driver for asyncio',
license='MIT',
keywords='asyncio odbc',
url='https://github.com/aio-libs/aioodbc',
classifiers=[
'Development Status :: 3 - Alpha',
'Intended Audience :: Developers',
'License :: OSI Approved :: MIT License',
'Operating System :: POSIX',
'Programming Language :: Python :: 3',
'Programming Language :: Python :: 3.3',
'Programming Language :: Python :: 3.4',
'Programming Language :: Python :: 3.5',
'Topic :: Database :: Front-Ends',
],
)
requirements.txt
requirements.txt
文件列出了项目运行所需的依赖包。
pyodbc
uvloop; platform_system != "Windows"
配置文件介绍
setup.py
: 包含项目的名称、版本、依赖、作者等信息。requirements.txt
: 列出了项目运行所需的依赖包