XenServer Python libs for Dom0

Welcome to the python-libs documentation!

Each module is documented in its own section. Select a module from the menu to view its API documentation.

Project Documentation

• XenServer Python libs for Dom0
  • Test-driven Development (TDD) Model
  • Status Summary
  • Pylint results from GitHub CI in GitHub Actions page
  • Configuration files
  • Installation and setup of the development environment
  • Static analysis using mypy, pylint, pyright and pytype
  • Type annotations: Use Type comments for now
  • Guidelines
  • Users
• Development setup
  • Do not use distro-provided Python CI tools
  • Create a virtual environment with the test dependencies
  • Running CI
  • Alternative: Install pytest packages using pipx
  • Background information on the provided tools
  • Recommended tox and pytest plugins for development
  • Running GitHub actions locally using act
  • Recommendations for Windows and WSL2
• Documenting using Sphinx
  • Why Google Style Docstrings?
  • Example Google Style Docstring
  • Steps to Document Your Code
  • Benefits of using Sphinx
  • Building the documentation
  • References
• Unicode migration
  • Problem
  • Migrating subprocess.Popen()
  • Migrating builtins.open()

XCP Python Modules

• xcp.accessor
  • Accessor
  • AnyAccessor
  • DeviceAccessor
  • FTPAccessor
  • FileAccessor
  • FilesystemAccessor
  • HTTPAccessor
  • Mount
  • MountingAccessor
  • MountingAccessorTypes
  • NFSAccessor
  • SUPPORTED_ACCESSORS
  • createAccessor()
  • mapError()
  • rebuild_url()
• xcp.bootloader
  • Bootloader
  • Grub2Format
  • MenuEntry
• xcp.cmd
  • OutputCache
  • runCmd()
• xcp.compat
  • open_defaults_for_utf8_text()
  • open_textfile()
  • open_with_codec_handling()
• xcp.cpiofile
  • CpioError
  • CpioFile
  • CpioInfo
  • is_cpiofile()
• xcp.dmv
  • DriverMultiVersion
  • DriverMultiVersionManager
  • get_active_variant()
  • get_all_kabi_dirs()
  • get_loaded_modules()
  • hardware_present()
  • id_matches()
  • note_offset()
  • pci_matches()
• xcp.dom0
  • default_memory()
  • default_memory_for_version()
  • default_memory_v2()
  • default_memory_v3()
  • default_vcpus()
  • parse_mem()
• xcp.environ
  • InventoryError
  • buildingInitialTar()
  • installerRunning()
  • readInventory()
• xcp.logger
  • closeLogs()
  • critical()
  • debug()
  • error()
  • info()
  • log()
  • logException()
  • logToStderr()
  • logToStdout()
  • logToSyslog()
  • openLog()
  • warning()
• xcp.mount
  • MountException
  • TempMount
  • bindMount()
  • mount()
  • umount()
• xcp.pci
  • PCI
  • PCIDevices
  • PCIIds
  • pci_sbdfi_to_nic()
• xcp.repository
  • BaseRepository
  • BzippedPackage
  • DriverPackage
  • DriverRPMPackage
  • FirmwarePackage
  • NoRepository
  • Package
  • RPMPackage
  • RepoFormatError
  • Repository
  • YumRepository
• xcp.version
  • Version
• xcp.xmlunwrap
  • XmlUnwrapError
  • getBoolAttribute()
  • getElementsByTagName()
  • getIntAttribute()
  • getMapAttribute()
  • getStrAttribute()
  • getText()

XCP.Net Modules

• xcp.net.biosdevname
  • all_devices_all_names()
  • has_ppn_quirks()
• xcp.net.ip
  • ip_link_set_name()
• xcp.net.mac
  • MAC

XCP.Net.Ifrename Modules

• xcp.net.ifrename.util
  • get_new_temp_name()
  • get_nic_with_kname()
  • get_nic_with_mac()
  • get_nic_with_pci()
  • get_nics_with_pci()
  • needs_renaming()
  • niceformat()
  • tname_free()
• xcp.net.ifrename.static
  • StaticRules
• xcp.net.ifrename.logic
  • CurrentStateError
  • LastStateError
  • LogicError
  • OldStateError
  • StaticRuleError
  • rename()
  • rename_logic()
• xcp.net.ifrename.dynamic
  • DynamicRules
• xcp.net.ifrename.macpci
  • MACPCI