pyVmomi 项目教程

1. 项目目录结构及介绍

pyVmomi 项目的目录结构如下：

pyvmomi/
├── pyVim/
│   ├── __init__.py
│   ├── connect.py
│   ├── disconnect.py
│   └── ...
├── pyVmomi/
│   ├── __init__.py
│   ├── vim.py
│   ├── vmodl.py
│   └── ...
├── tests/
│   ├── __init__.py
│   ├── test_connect.py
│   ├── test_vim.py
│   └── ...
├── .gitignore
├── CHANGELOG.md
├── LICENSE.txt
├── MANIFEST.in
├── NOTICE.txt
├── README.rst
├── requirements.txt
├── setup.cfg
├── setup.py
├── test-requirements.txt
├── tox.ini
├── vsanapiutils.py
└── vsanmgmtObjects.py

目录结构介绍

• pyVim/: 包含与 VMware vSphere 管理 API 交互的核心模块。

  • __init__.py: 初始化文件。
  • connect.py: 连接到 vSphere 的模块。
  • disconnect.py: 断开与 vSphere 连接的模块。
  • 其他相关模块。

• pyVmomi/: 包含与 VMware vSphere API 绑定的核心模块。

  • __init__.py: 初始化文件。
  • vim.py: 包含与 vSphere 管理对象交互的模块。
  • vmodl.py: 包含与 vSphere 数据对象交互的模块。
  • 其他相关模块。

• tests/: 包含项目的单元测试文件。

  • __init__.py: 初始化文件。
  • test_connect.py: 测试连接功能的模块。
  • test_vim.py: 测试 vSphere 管理对象功能的模块。
  • 其他测试模块。

• 其他文件:

  • .gitignore: Git 忽略文件配置。
  • CHANGELOG.md: 项目变更日志。
  • LICENSE.txt: 项目许可证文件。
  • MANIFEST.in: 打包清单文件。
  • NOTICE.txt: 项目通知文件。
  • README.rst: 项目介绍和使用说明。
  • requirements.txt: 项目依赖文件。
  • setup.cfg: 项目配置文件。
  • setup.py: 项目安装脚本。
  • test-requirements.txt: 测试依赖文件。
  • tox.ini: 多环境测试配置文件。
  • vsanapiutils.py: 与 vSAN API 交互的工具模块。
  • vsanmgmtObjects.py: 与 vSAN 管理对象交互的模块。

2. 项目启动文件介绍

pyVmomi 项目的启动文件主要是 setup.py 和 setup.cfg。

setup.py

setup.py 是 Python 项目的标准安装脚本，用于定义项目的元数据和依赖关系。通过运行 python setup.py install 可以安装项目及其依赖。

setup.cfg

setup.cfg 是 setuptools 的配置文件，用于定义项目的各种配置选项，如包的元数据、依赖关系、测试配置等。

3. 项目配置文件介绍

pyVmomi 项目的配置文件主要包括 setup.cfg 和 tox.ini。

setup.cfg

setup.cfg 文件用于配置项目的各种选项，如包的元数据、依赖关系、测试配置等。以下是一些常见的配置项：

[metadata]
name = pyvmomi
version = 8.0.3.0
description = VMware vSphere API Python Bindings
long_description = file: README.rst
author = VMware, Inc.
author_email = [e-mail]
license = Apache 2.0
url = https://github.com/vmware/pyvmomi

[options]
packages = find:
install_requires =
    requests
    six

[options.packages.find]
where = .

[options.extras_require]
sso =
    pywin32

[options.entry_points]
console_scripts =
    pyvmomi = pyvmomi.cli:main

tox.ini

tox.ini 文件用于配置多环境测试，确保项目在不同 Python 版本和环境中都能正常运行。以下是一些常见的配置项：

[tox]
envlist = py27,py34,py35,py36,py37,py38,py39,py310

[testenv]
deps =
    -rrequirements.txt
    -rtest-requirements.txt
commands =
    python -m unittest discover -s tests

通过 tox 命令可以自动在多个环境中运行测试，确保项目的兼容性和稳定性。

---

以上是 pyVmomi 项目的目录结构、启动文件和配置文件的介绍。希望这份教程能帮助你更好地理解和使用 pyVmomi 项目。