# openpyxl.packaging.workbook module

class openpyxl.packaging.workbook.ChildSheet(name=None, sheetId=None, state='visible', id=None)

  Bases: `Serialisable`

  Represents a reference to a worksheet or chartsheet in workbook.xml

  It contains the title, order and state but only an indirect reference to the objects themselves.

  id

    Values must be of type <class ‘str’>

  name

    Values must be of type <class ‘str’>

  sheetId

    Values must be of type <class ‘int’>

  state

    Value must be one of [‘hidden’, ‘veryHidden’, ‘visible’]

  tagname = 'sheet'

class openpyxl.packaging.workbook.FileRecoveryProperties(autoRecover=None, crashSave=None, dataExtractLoad=None, repairLoad=None)

  Bases: `Serialisable`

  autoRecover

    Values must be of type <class ‘bool’>

  crashSave

    Values must be of type <class ‘bool’>

  dataExtractLoad

    Values must be of type <class ‘bool’>

  repairLoad

    Values must be of type <class ‘bool’>

  tagname = 'fileRecoveryPr'

class openpyxl.packaging.workbook.PivotCache(cacheId=None, id=None)

  Bases: `Serialisable`

  cacheId

    Values must be of type <class ‘int’>

  id

    Values must be of type <class ‘str’>

  tagname = 'pivotCache'

class openpyxl.packaging.workbook.WorkbookPackage(conformance=None, fileVersion=None, fileSharing=None, workbookPr=None, workbookProtection=None, bookViews=(), sheets=(), functionGroups=None, externalReferences=(), definedNames=None, calcPr=None, oleSize=None, customWorkbookViews=(), pivotCaches=(), smartTagPr=None, smartTagTypes=None, webPublishing=None, fileRecoveryPr=None, webPublishObjects=None, extLst=None, Ignorable=None)

  Bases: `Serialisable`

  Represent the workbook file in the archive

  Ignorable

    Values must be of type <class ‘str’>

  property active
  bookViews

    Wrap a sequence in an containing object

  calcPr

    Values must be of type <class ‘openpyxl.workbook.properties.CalcProperties’>

  conformance

    Value must be one of [‘strict’, ‘transitional’]

  customWorkbookViews

    Wrap a sequence in an containing object

  definedNames

    Values must be of type <class ‘openpyxl.workbook.defined_name.DefinedNameList’>

  extLst

    Values must be of type <class ‘openpyxl.descriptors.excel.ExtensionList’>

  externalReferences

    Wrap a sequence in an containing object

  fileRecoveryPr

    Values must be of type <class ‘openpyxl.packaging.workbook.FileRecoveryProperties’>

  fileSharing

    Values must be of type <class ‘openpyxl.workbook.protection.FileSharing’>

  fileVersion

    Values must be of type <class ‘openpyxl.workbook.properties.FileVersion’>

  functionGroups

    Values must be of type <class ‘openpyxl.workbook.function_group.FunctionGroupList’>

  oleSize

    Values must be of type <class ‘str’>

  pivotCaches

    Wrap a sequence in an containing object

  properties

    Aliases can be used when either the desired attribute name is not allowed or confusing in Python (eg. “type”) or a more descriptive name is desired (eg. “underline” for “u”)

  sheets

    Wrap a sequence in an containing object

  smartTagPr

    Values must be of type <class ‘openpyxl.workbook.smart_tags.SmartTagProperties’>

  smartTagTypes

    Values must be of type <class ‘openpyxl.workbook.smart_tags.SmartTagList’>

  tagname = 'workbook'
  to_tree()
  webPublishObjects

    Values must be of type <class ‘openpyxl.workbook.web.WebPublishObjectList’>

  webPublishing

    Values must be of type <class ‘openpyxl.workbook.web.WebPublishing’>

  workbookPr

    Values must be of type <class ‘openpyxl.workbook.properties.WorkbookProperties’>

  workbookProtection

    Values must be of type <class ‘openpyxl.workbook.protection.WorkbookProtection’>