python-libs documentation

Project Documentation

• Common XenServer/XCP-ng Python classes
  • 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-privided Python CI tools
  • Create a virtual environment with the test dependencies
  • Running CI
  • Alternative: installing pytest packages using pipx
  • Background information on the provided tools
  • Installation of all development dependencies
  • 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
• xcp.bootloader
  • Bootloader
  • Grub2Format
  • MenuEntry
• xcp.cmd
  • OutputCache
  • runCmd()
• xcp.compat
  • open_defaults_for_utf8_text()
  • open_textfile()
  • open_with_codec_handling()
• xcp.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
• xcp.repository
• xcp.version
  • Version
• xcp.xmlunwrap

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.