How ovirt/ovirt-engine-sdk works
The oVirt Python SDK lets callers make Engine API requests through a connection and generated service objects, then converts XML responses into SDK values. Its documented generation workflow uses the API model to produce service, type, and reader code; the runtime also includes XML parsing/rendering backed by libxml2. The excerpts show service request handling and generator responsibilities, but not all runtime wiring, so uncertain XML-extension connections are marked unverified.
Main entry points: Tool.java Generator tool · service.py API services · PythonNames.java Python naming · ServicesGenerator.java Service generator
Components 22
SDK runtime
- Connection
sdk/lib/ovirtsdk4/__init__.py - API services
sdk/lib/ovirtsdk4/service.py - HTTP messages
sdk/lib/ovirtsdk4/http.py - API types
sdk/lib/ovirtsdk4/__init__.py
XML serialization
- Response reader
sdk/lib/ovirtsdk4/reader.py - Request writer
sdk/lib/ovirtsdk4/writer.py - XML extension
sdk/ext/xml.c - XML parser
sdk/ext/ov_xml_reader.c - XML renderer
sdk/ext/ov_xml_writer.c - XML utilities
sdk/ext/ov_xml_utils.c
SDK generation
- Generator tool
generator/src/main/java/org/ovirt/sdk/python/Tool.java - Generator interface
generator/src/main/java/org/ovirt/sdk/python/PythonGenerator.java - Python naming
generator/src/main/java/org/ovirt/sdk/python/PythonNames.java - Code buffer
generator/src/main/java/org/ovirt/sdk/python/PythonBuffer.java - Service generator
generator/src/main/java/org/ovirt/sdk/python/ServicesGenerator.java - Reader generator
generator/src/main/java/org/ovirt/sdk/python/ReadersGenerator.java - Type generator
generator/src/main/java/org/ovirt/sdk/python/TypesGenerator.java - Writer generator
generator/src/main/java/org/ovirt/sdk/python/WritersGenerator.java
External systems
- oVirt Engine API
- API model
- libxml2
Other components
- SDK caller
Connections 34
- SDK caller → Connection: creates
sdk/lib/ovirtsdk4/__init__.py - SDK caller → API services: uses
- API services → Connection: sends requests
sdk/lib/ovirtsdk4/service.py - API services → HTTP messages: builds requests
sdk/lib/ovirtsdk4/service.py - API services → Request writer: serializes bodies
sdk/lib/ovirtsdk4/service.py - API services → Response reader: reads responses
sdk/lib/ovirtsdk4/service.py - Connection → oVirt Engine API: sends HTTP
README.adoc - oVirt Engine API → Connection: returns responses
- Response reader → API types: constructs values
sdk/lib/ovirtsdk4/reader.py - Response reader → XML extension: parses XML
- Request writer → XML extension: renders XML
- XML extension → XML parser: initializes
sdk/ext/xml.c - XML extension → XML renderer: initializes
sdk/ext/xml.c - XML parser → XML utilities: uses utilities
sdk/ext/ov_xml_reader.c - XML renderer → XML utilities: uses utilities
sdk/ext/ov_xml_writer.c - XML parser → libxml2: parses with
README.adoc - XML renderer → libxml2: renders with
README.adoc - Generator tool → Generator interface: runs generators
generator/src/main/java/org/ovirt/sdk/python/Tool.java - Generator tool → Python naming: uses names
generator/src/main/java/org/ovirt/sdk/python/Tool.java - Service generator → Generator interface: implements
generator/src/main/java/org/ovirt/sdk/python/ServicesGenerator.java - Reader generator → Generator interface: implements
generator/src/main/java/org/ovirt/sdk/python/ReadersGenerator.java - Service generator → Python naming: uses names
generator/src/main/java/org/ovirt/sdk/python/ServicesGenerator.java - Reader generator → Python naming: uses names
generator/src/main/java/org/ovirt/sdk/python/ReadersGenerator.java - Type generator → Python naming: uses names
generator/src/main/java/org/ovirt/sdk/python/TypesGenerator.java - Writer generator → Python naming: uses names
generator/src/main/java/org/ovirt/sdk/python/WritersGenerator.java - Service generator → Code buffer: writes through
generator/src/main/java/org/ovirt/sdk/python/ServicesGenerator.java - Reader generator → Code buffer: writes through
generator/src/main/java/org/ovirt/sdk/python/ReadersGenerator.java - Type generator → Code buffer: writes through
generator/src/main/java/org/ovirt/sdk/python/PythonBuffer.java - Writer generator → Code buffer: writes through
generator/src/main/java/org/ovirt/sdk/python/WritersGenerator.java - Generator tool → API model: loads model
README.adoc - Generator tool → Service generator: generates services
- Generator tool → Reader generator: generates readers
- Generator tool → Type generator: generates types
- Generator tool → Writer generator: generates writers