# diskimage_builder package

## Subpackages

- diskimage_builder.block_device package
  - Subpackages
    - diskimage_builder.block_device.level0 package
      - Submodules
      - diskimage_builder.block_device.level0.localloop module
      - Module contents
    - diskimage_builder.block_device.level1 package
      - Submodules
      - diskimage_builder.block_device.level1.lvm module
      - diskimage_builder.block_device.level1.mbr module
      - diskimage_builder.block_device.level1.partition module
      - diskimage_builder.block_device.level1.partitioning module
      - Module contents
    - diskimage_builder.block_device.level2 package
      - Submodules
      - diskimage_builder.block_device.level2.mkfs module
      - Module contents
    - diskimage_builder.block_device.level3 package
      - Submodules
      - diskimage_builder.block_device.level3.mount module
      - Module contents
    - diskimage_builder.block_device.level4 package
      - Submodules
      - diskimage_builder.block_device.level4.fstab module
      - Module contents
    - diskimage_builder.block_device.tests package
      - Subpackages
      - Submodules
      - diskimage_builder.block_device.tests.test_base module
      - diskimage_builder.block_device.tests.test_config module
      - diskimage_builder.block_device.tests.test_gpt module
      - diskimage_builder.block_device.tests.test_lvm module
      - diskimage_builder.block_device.tests.test_mbr module
      - diskimage_builder.block_device.tests.test_mkfs module
      - diskimage_builder.block_device.tests.test_mount_order module
      - diskimage_builder.block_device.tests.test_state module
      - diskimage_builder.block_device.tests.test_utils module
      - Module contents
  - Submodules
  - diskimage_builder.block_device.blockdevice module
  - diskimage_builder.block_device.cmd module
  - diskimage_builder.block_device.config module
  - diskimage_builder.block_device.exception module
  - diskimage_builder.block_device.plugin module
  - diskimage_builder.block_device.utils module
  - Module contents

## Submodules

## diskimage_builder.disk_image_create module

diskimage_builder.disk_image_create.main()

## diskimage_builder.element_dependencies module

exception diskimage_builder.element_dependencies.AlreadyProvidedException

  Bases: `Exception`

class diskimage_builder.element_dependencies.Element(name, path)

  Bases: `object`

  An element

exception diskimage_builder.element_dependencies.InvalidElementDir

  Bases: `Exception`

exception diskimage_builder.element_dependencies.MissingElementException

  Bases: `Exception`

exception diskimage_builder.element_dependencies.MissingOSException

  Bases: `Exception`

diskimage_builder.element_dependencies.expand_dependencies(user_elements, element_dirs)

  Deprecated method for expanding element dependencies.

  Warning

  DO NOT USE THIS FUNCTION. For compatibility reasons, this function does not provide paths to the returned elements. This means the caller must process override rules if two elements with the same name appear in element_dirs

  Parameters

    - user_elements – iterable enumerating the elements a user requested

    - element_dirs – The ELEMENTS_PATH to process

  Returns

    a set containing user_elements and all dependent elements including any transitive dependencies.

diskimage_builder.element_dependencies.get_elements(elements, paths=None)

  Return the canonical list of elements with their dependencies

  Note

  You probably do not want to use this! Elements that require access to the list of all other elements should generally use the environment variables exported by disk-image-create below.

  Parameters

    - elements – user specified elements

    - paths – Alternative ELEMENTS_PATH; default is to use from env

  Returns

    A de-duplicated list of tuples [(element, path), (element, path) …] with all elements and their dependents, including any transitive dependencies.

diskimage_builder.element_dependencies.main()

## diskimage_builder.logging_config module

class diskimage_builder.logging_config.DibFormatter(*args, **kwargs)

  Bases: `logging.Formatter`

  format(record)

    Format the specified record as text.

    The record’s attribute dictionary is used as the operand to a string formatting operation which yields the returned string. Before formatting the dictionary, a couple of preparatory steps are carried out. The message attribute of the record is computed using LogRecord.getMessage(). If the formatting string uses the time (as determined by a call to usesTime(), formatTime() is called to format the event time. If there is exception information, it is formatted using formatException() and appended to the message.

diskimage_builder.logging_config.setup()

## diskimage_builder.paths module

Export paths

diskimage_builder.paths.get_path(var)

diskimage_builder.paths.show_path(var)

## diskimage_builder.version module

## Module contents

this page last updated: 2022-01-12 16:32:54

Except where otherwise noted, this document is licensed under Creative Commons Attribution 3.0 License. See all OpenStack Legal Documents.

found an error? report a bug