PyUCIS Reference

This section provides information on APIs and file formats used by PyUCIS.

• Coverage Report Object
  • Building a CoverageReport
  • CoverageReport Object
• JSON Coverage Report
  • PyUCIS JSON Coverage Report
  • Covergroup Type
  • Covergroup Inst
  • Coverpoint
  • Cross
  • Cover Bin
• HTML Coverage Report Format
  • Generating HTML Reports
  • Report Features
  • Technical Details
  • Use Cases
  • Advantages
  • Limitations
  • Advanced Options
  • Examples
  • API Reference
  • See Also
• XML Interchange Format
  • Functional Coverage
  • Coverage Options Support
  • Schema Compliance
  • Known Format Limitations
  • Version Information
• YAML Coverage Data Format
  • Format Reference
• Best Practices for Recording Coverage
  • Naming Cross Bins
• UCIS Object-Oriented API
  • Obj
• UCIS C-Style API
  • ucis_GetIntProperty()
  • ucis_SetIntProperty()
  • ucis_GetRealProperty()
  • ucis_SetRealProperty()
  • ucis_GetStringProperty()
  • ucis_SetStringProperty()
  • ucis_GetHandleProperty()
  • ucis_SetHandleProperty()
  • ucis_CreateScope()
  • ucis_CreateInstance()
  • ucis_CreateToggle()
  • ucis_CreateNextCover()
  • ucis_RemoveScope()
  • ucis_CreateHistoryNode()
  • ucis_CreateFileHandle()
  • ucis_SetTestData()
  • ucis_Write()
  • ucis_Close()
  • ucis_Time()
• SQLite Backend API
  • Overview
  • Quick Start
  • API Reference
  • Merge Support
  • Performance
  • Database Format
  • Examples
• SQLite Schema Reference
  • Design Principles
  • Schema Initialization
  • Table Reference
  • Query Examples
  • Performance Tuning
  • See Also
• Native C Library API
  • Overview
  • Building
  • API Reference
  • Type Definitions
  • Complete Examples
  • Performance
  • See Also

Back-End APIs

PyUCIS supports multiple backend storage implementations, each with different trade-offs:

In-Memory

The in-memory backend stores all coverage data in RAM for fast access. Best for:

• Small to medium databases that fit in memory

• Temporary coverage processing

• Fast iteration and analysis

See UCIS Object-Oriented API for the Python object-oriented API.

SQLite

The SQLite backend provides persistent, queryable storage using SQLite3 databases. Best for:

• Large coverage databases

• Persistent storage requirements

• SQL-based queries and analysis

• Integration with database tools

See SQLite Backend API for the Python SQLite API and SQLite Schema Reference for detailed schema documentation.

Native C Library

The native C library provides a UCIS 1.0 compliant C API with SQLite3 backend. Best for:

• C/C++ applications

• Performance-critical operations

• Integration with native tools

• Python ctypes integration

See Native C Library API for the C API documentation.

UCIS C API

The UCIS C API wrapper provides access to external UCIS libraries. See UCIS C-Style API for details.

XML

The XML backend reads and writes UCIS data in XML format for interchange. See XML Interchange Format for details.

YAML

The YAML backend provides a human-readable text format. See YAML Coverage Data Format for details.