openpyxl API Reference
Full documentation for openpyxl (3.1.5)
openpyxl.DEBUG
Python Library Documentation: bool object class bool(int) | bool(x) -> bool | | Returns True when the argument x is true, False otherwise. | The builtins True and False are the only two instances of the class bool. | The class bool is a subclass of the class int, and cannot be subclassed. | | Method resolution order: | bool | int | object | | Methods defined here: | | __and__(self, value, /) | Return self&value. | | __invert__(self, /) | ~self | | __or__(self, value, /) | Return self|value. | | __rand__(self, value, /) | Return value&self. | | __repr__(self, /) | Return repr(self). | | __ror__(self, value, /) | Return value|self. | | __rxor__(self, value, /) | Return value^self. | | __xor__(self, value, /) | Return self^value. | | ---------------------------------------------------------------------- | Static methods defined here: | | __new__(*args, **kwargs) | Create and return a new object. See help(type) for accurate signature. | | ---------------------------------------------------------------------- | Methods inherited from int: | | __abs__(self, /) | abs(self) | | __add__(self, value, /) | Return self+value. | | __bool__(self, /) | True if self else False | | __ceil__(...) | Ceiling of an Integral returns itself. | | __divmod__(self, value, /) | Return divmod(self, value). | | __eq__(self, value, /) | Return self==value. | | __float__(self, /) | float(self) | | __floor__(...) | Flooring an Integral returns itself. | | __floordiv__(self, value, /) | Return self//value. | | __format__(self, format_spec, /) | Convert to a string according to format_spec. | | __ge__(self, value, /) | Return self>=value. | | __getattribute__(self, name, /) | Return getattr(self, name). | | __getnewargs__(self, /) | | __gt__(self, value, /) | Return self>value. | | __hash__(self, /) | Return hash(self). | | __index__(self, /) | Return self converted to an integer, if self is suitable for use as an index into a list. | | __int__(self, /) | int(self) | | __le__(self, value, /) | Return self<=value. | | __lshift__(self, value, /) | Return self<<value. | | __lt__(self, value, /) | Return self<value. | | __mod__(self, value, /) | Return self%value. | | __mul__(self, value, /) | Return self*value. | | __ne__(self, value, /) | Return self!=value. | | __neg__(self, /) | -self | | __pos__(self, /) | +self | | __pow__(self, value, mod=None, /) | Return pow(self, value, mod). | | __radd__(self, value, /) | Return value+self. | | __rdivmod__(self, value, /) | Return divmod(value, self). | | __rfloordiv__(self, value, /) | Return value//self. | | __rlshift__(self, value, /) | Return value<<self. | | __rmod__(self, value, /) | Return value%self. | | __rmul__(self, value, /) | Return value*self. | | __round__(...) | Rounding an Integral returns itself. | | Rounding with an ndigits argument also returns an integer. | | __rpow__(self, value, mod=None, /) | Return pow(value, self, mod). | | __rrshift__(self, value, /) | Return value>>self. | | __rshift__(self, value, /) | Return self>>value. | | __rsub__(self, value, /) | Return value-self. | | __rtruediv__(self, value, /) | Return value/self. | | __sizeof__(self, /) | Returns size in memory, in bytes. | | __sub__(self, value, /) | Return self-value. | | __truediv__(self, value, /) | Return self/value. | | __trunc__(...) | Truncating an Integral returns itself. | | as_integer_ratio(self, /) | Return a pair of integers, whose ratio is equal to the original int. | | The ratio is in lowest terms and has a positive denominator. | | >>> (10).as_integer_ratio() | (10, 1) | >>> (-10).as_integer_ratio() | (-10, 1) | >>> (0).as_integer_ratio() | (0, 1) | | bit_count(self, /) | Number of ones in the binary representation of the absolute value of self. | | Also known as the population count. | | >>> bin(13) | '0b1101' | >>> (13).bit_count() | 3 | | bit_length(self, /) | Number of bits necessary to represent self in binary. | | >>> bin(37) | '0b100101' | >>> (37).bit_length() | 6 | | conjugate(...) | Returns self, the complex conjugate of any int. | | is_integer(self, /) | Returns True. Exists for duck type compatibility with float.is_integer. | | to_bytes(self, /, length=1, byteorder='big', *, signed=False) | Return an array of bytes representing an integer. | | length | Length of bytes object to use. An OverflowError is raised if the | integer is not representable with the given number of bytes. Default | is length 1. | byteorder | The byte order used to represent the integer. If byteorder is 'big', | the most significant byte is at the beginning of the byte array. If | byteorder is 'little', the most significant byte is at the end of the | byte array. To request the native byte order of the host system, use | `sys.byteorder' as the byte order value. Default is to use 'big'. | signed | Determines whether two's complement is used to represent the integer. | If signed is False and a negative integer is given, an OverflowError | is raised. | | ---------------------------------------------------------------------- | Class methods inherited from int: | | from_bytes(bytes, byteorder='big', *, signed=False) | Return the integer represented by the given array of bytes. | | bytes | Holds the array of bytes to convert. The argument must either | support the buffer protocol or be an iterable object producing bytes. | Bytes and bytearray are examples of built-in objects that support the | buffer protocol. | byteorder | The byte order used to represent the integer. If byteorder is 'big', | the most significant byte is at the beginning of the byte array. If | byteorder is 'little', the most significant byte is at the end of the | byte array. To request the native byte order of the host system, use | `sys.byteorder' as the byte order value. Default is to use 'big'. | signed | Indicates whether two's complement is used to represent the integer. | | ---------------------------------------------------------------------- | Data descriptors inherited from int: | | denominator | the denominator of a rational number in lowest terms | | imag | the imaginary part of a complex number | | numerator | the numerator of a rational number in lowest terms | | real | the real part of a complex number
openpyxl.DEFUSEDXML
Python Library Documentation: bool object class bool(int) | bool(x) -> bool | | Returns True when the argument x is true, False otherwise. | The builtins True and False are the only two instances of the class bool. | The class bool is a subclass of the class int, and cannot be subclassed. | | Method resolution order: | bool | int | object | | Methods defined here: | | __and__(self, value, /) | Return self&value. | | __invert__(self, /) | ~self | | __or__(self, value, /) | Return self|value. | | __rand__(self, value, /) | Return value&self. | | __repr__(self, /) | Return repr(self). | | __ror__(self, value, /) | Return value|self. | | __rxor__(self, value, /) | Return value^self. | | __xor__(self, value, /) | Return self^value. | | ---------------------------------------------------------------------- | Static methods defined here: | | __new__(*args, **kwargs) | Create and return a new object. See help(type) for accurate signature. | | ---------------------------------------------------------------------- | Methods inherited from int: | | __abs__(self, /) | abs(self) | | __add__(self, value, /) | Return self+value. | | __bool__(self, /) | True if self else False | | __ceil__(...) | Ceiling of an Integral returns itself. | | __divmod__(self, value, /) | Return divmod(self, value). | | __eq__(self, value, /) | Return self==value. | | __float__(self, /) | float(self) | | __floor__(...) | Flooring an Integral returns itself. | | __floordiv__(self, value, /) | Return self//value. | | __format__(self, format_spec, /) | Convert to a string according to format_spec. | | __ge__(self, value, /) | Return self>=value. | | __getattribute__(self, name, /) | Return getattr(self, name). | | __getnewargs__(self, /) | | __gt__(self, value, /) | Return self>value. | | __hash__(self, /) | Return hash(self). | | __index__(self, /) | Return self converted to an integer, if self is suitable for use as an index into a list. | | __int__(self, /) | int(self) | | __le__(self, value, /) | Return self<=value. | | __lshift__(self, value, /) | Return self<<value. | | __lt__(self, value, /) | Return self<value. | | __mod__(self, value, /) | Return self%value. | | __mul__(self, value, /) | Return self*value. | | __ne__(self, value, /) | Return self!=value. | | __neg__(self, /) | -self | | __pos__(self, /) | +self | | __pow__(self, value, mod=None, /) | Return pow(self, value, mod). | | __radd__(self, value, /) | Return value+self. | | __rdivmod__(self, value, /) | Return divmod(value, self). | | __rfloordiv__(self, value, /) | Return value//self. | | __rlshift__(self, value, /) | Return value<<self. | | __rmod__(self, value, /) | Return value%self. | | __rmul__(self, value, /) | Return value*self. | | __round__(...) | Rounding an Integral returns itself. | | Rounding with an ndigits argument also returns an integer. | | __rpow__(self, value, mod=None, /) | Return pow(value, self, mod). | | __rrshift__(self, value, /) | Return value>>self. | | __rshift__(self, value, /) | Return self>>value. | | __rsub__(self, value, /) | Return value-self. | | __rtruediv__(self, value, /) | Return value/self. | | __sizeof__(self, /) | Returns size in memory, in bytes. | | __sub__(self, value, /) | Return self-value. | | __truediv__(self, value, /) | Return self/value. | | __trunc__(...) | Truncating an Integral returns itself. | | as_integer_ratio(self, /) | Return a pair of integers, whose ratio is equal to the original int. | | The ratio is in lowest terms and has a positive denominator. | | >>> (10).as_integer_ratio() | (10, 1) | >>> (-10).as_integer_ratio() | (-10, 1) | >>> (0).as_integer_ratio() | (0, 1) | | bit_count(self, /) | Number of ones in the binary representation of the absolute value of self. | | Also known as the population count. | | >>> bin(13) | '0b1101' | >>> (13).bit_count() | 3 | | bit_length(self, /) | Number of bits necessary to represent self in binary. | | >>> bin(37) | '0b100101' | >>> (37).bit_length() | 6 | | conjugate(...) | Returns self, the complex conjugate of any int. | | is_integer(self, /) | Returns True. Exists for duck type compatibility with float.is_integer. | | to_bytes(self, /, length=1, byteorder='big', *, signed=False) | Return an array of bytes representing an integer. | | length | Length of bytes object to use. An OverflowError is raised if the | integer is not representable with the given number of bytes. Default | is length 1. | byteorder | The byte order used to represent the integer. If byteorder is 'big', | the most significant byte is at the beginning of the byte array. If | byteorder is 'little', the most significant byte is at the end of the | byte array. To request the native byte order of the host system, use | `sys.byteorder' as the byte order value. Default is to use 'big'. | signed | Determines whether two's complement is used to represent the integer. | If signed is False and a negative integer is given, an OverflowError | is raised. | | ---------------------------------------------------------------------- | Class methods inherited from int: | | from_bytes(bytes, byteorder='big', *, signed=False) | Return the integer represented by the given array of bytes. | | bytes | Holds the array of bytes to convert. The argument must either | support the buffer protocol or be an iterable object producing bytes. | Bytes and bytearray are examples of built-in objects that support the | buffer protocol. | byteorder | The byte order used to represent the integer. If byteorder is 'big', | the most significant byte is at the beginning of the byte array. If | byteorder is 'little', the most significant byte is at the end of the | byte array. To request the native byte order of the host system, use | `sys.byteorder' as the byte order value. Default is to use 'big'. | signed | Indicates whether two's complement is used to represent the integer. | | ---------------------------------------------------------------------- | Data descriptors inherited from int: | | denominator | the denominator of a rational number in lowest terms | | imag | the imaginary part of a complex number | | numerator | the numerator of a rational number in lowest terms | | real | the real part of a complex number
openpyxl.LXML
Python Library Documentation: bool object class bool(int) | bool(x) -> bool | | Returns True when the argument x is true, False otherwise. | The builtins True and False are the only two instances of the class bool. | The class bool is a subclass of the class int, and cannot be subclassed. | | Method resolution order: | bool | int | object | | Methods defined here: | | __and__(self, value, /) | Return self&value. | | __invert__(self, /) | ~self | | __or__(self, value, /) | Return self|value. | | __rand__(self, value, /) | Return value&self. | | __repr__(self, /) | Return repr(self). | | __ror__(self, value, /) | Return value|self. | | __rxor__(self, value, /) | Return value^self. | | __xor__(self, value, /) | Return self^value. | | ---------------------------------------------------------------------- | Static methods defined here: | | __new__(*args, **kwargs) | Create and return a new object. See help(type) for accurate signature. | | ---------------------------------------------------------------------- | Methods inherited from int: | | __abs__(self, /) | abs(self) | | __add__(self, value, /) | Return self+value. | | __bool__(self, /) | True if self else False | | __ceil__(...) | Ceiling of an Integral returns itself. | | __divmod__(self, value, /) | Return divmod(self, value). | | __eq__(self, value, /) | Return self==value. | | __float__(self, /) | float(self) | | __floor__(...) | Flooring an Integral returns itself. | | __floordiv__(self, value, /) | Return self//value. | | __format__(self, format_spec, /) | Convert to a string according to format_spec. | | __ge__(self, value, /) | Return self>=value. | | __getattribute__(self, name, /) | Return getattr(self, name). | | __getnewargs__(self, /) | | __gt__(self, value, /) | Return self>value. | | __hash__(self, /) | Return hash(self). | | __index__(self, /) | Return self converted to an integer, if self is suitable for use as an index into a list. | | __int__(self, /) | int(self) | | __le__(self, value, /) | Return self<=value. | | __lshift__(self, value, /) | Return self<<value. | | __lt__(self, value, /) | Return self<value. | | __mod__(self, value, /) | Return self%value. | | __mul__(self, value, /) | Return self*value. | | __ne__(self, value, /) | Return self!=value. | | __neg__(self, /) | -self | | __pos__(self, /) | +self | | __pow__(self, value, mod=None, /) | Return pow(self, value, mod). | | __radd__(self, value, /) | Return value+self. | | __rdivmod__(self, value, /) | Return divmod(value, self). | | __rfloordiv__(self, value, /) | Return value//self. | | __rlshift__(self, value, /) | Return value<<self. | | __rmod__(self, value, /) | Return value%self. | | __rmul__(self, value, /) | Return value*self. | | __round__(...) | Rounding an Integral returns itself. | | Rounding with an ndigits argument also returns an integer. | | __rpow__(self, value, mod=None, /) | Return pow(value, self, mod). | | __rrshift__(self, value, /) | Return value>>self. | | __rshift__(self, value, /) | Return self>>value. | | __rsub__(self, value, /) | Return value-self. | | __rtruediv__(self, value, /) | Return value/self. | | __sizeof__(self, /) | Returns size in memory, in bytes. | | __sub__(self, value, /) | Return self-value. | | __truediv__(self, value, /) | Return self/value. | | __trunc__(...) | Truncating an Integral returns itself. | | as_integer_ratio(self, /) | Return a pair of integers, whose ratio is equal to the original int. | | The ratio is in lowest terms and has a positive denominator. | | >>> (10).as_integer_ratio() | (10, 1) | >>> (-10).as_integer_ratio() | (-10, 1) | >>> (0).as_integer_ratio() | (0, 1) | | bit_count(self, /) | Number of ones in the binary representation of the absolute value of self. | | Also known as the population count. | | >>> bin(13) | '0b1101' | >>> (13).bit_count() | 3 | | bit_length(self, /) | Number of bits necessary to represent self in binary. | | >>> bin(37) | '0b100101' | >>> (37).bit_length() | 6 | | conjugate(...) | Returns self, the complex conjugate of any int. | | is_integer(self, /) | Returns True. Exists for duck type compatibility with float.is_integer. | | to_bytes(self, /, length=1, byteorder='big', *, signed=False) | Return an array of bytes representing an integer. | | length | Length of bytes object to use. An OverflowError is raised if the | integer is not representable with the given number of bytes. Default | is length 1. | byteorder | The byte order used to represent the integer. If byteorder is 'big', | the most significant byte is at the beginning of the byte array. If | byteorder is 'little', the most significant byte is at the end of the | byte array. To request the native byte order of the host system, use | `sys.byteorder' as the byte order value. Default is to use 'big'. | signed | Determines whether two's complement is used to represent the integer. | If signed is False and a negative integer is given, an OverflowError | is raised. | | ---------------------------------------------------------------------- | Class methods inherited from int: | | from_bytes(bytes, byteorder='big', *, signed=False) | Return the integer represented by the given array of bytes. | | bytes | Holds the array of bytes to convert. The argument must either | support the buffer protocol or be an iterable object producing bytes. | Bytes and bytearray are examples of built-in objects that support the | buffer protocol. | byteorder | The byte order used to represent the integer. If byteorder is 'big', | the most significant byte is at the beginning of the byte array. If | byteorder is 'little', the most significant byte is at the end of the | byte array. To request the native byte order of the host system, use | `sys.byteorder' as the byte order value. Default is to use 'big'. | signed | Indicates whether two's complement is used to represent the integer. | | ---------------------------------------------------------------------- | Data descriptors inherited from int: | | denominator | the denominator of a rational number in lowest terms | | imag | the imaginary part of a complex number | | numerator | the numerator of a rational number in lowest terms | | real | the real part of a complex number
openpyxl.NUMPY
Python Library Documentation: bool object class bool(int) | bool(x) -> bool | | Returns True when the argument x is true, False otherwise. | The builtins True and False are the only two instances of the class bool. | The class bool is a subclass of the class int, and cannot be subclassed. | | Method resolution order: | bool | int | object | | Methods defined here: | | __and__(self, value, /) | Return self&value. | | __invert__(self, /) | ~self | | __or__(self, value, /) | Return self|value. | | __rand__(self, value, /) | Return value&self. | | __repr__(self, /) | Return repr(self). | | __ror__(self, value, /) | Return value|self. | | __rxor__(self, value, /) | Return value^self. | | __xor__(self, value, /) | Return self^value. | | ---------------------------------------------------------------------- | Static methods defined here: | | __new__(*args, **kwargs) | Create and return a new object. See help(type) for accurate signature. | | ---------------------------------------------------------------------- | Methods inherited from int: | | __abs__(self, /) | abs(self) | | __add__(self, value, /) | Return self+value. | | __bool__(self, /) | True if self else False | | __ceil__(...) | Ceiling of an Integral returns itself. | | __divmod__(self, value, /) | Return divmod(self, value). | | __eq__(self, value, /) | Return self==value. | | __float__(self, /) | float(self) | | __floor__(...) | Flooring an Integral returns itself. | | __floordiv__(self, value, /) | Return self//value. | | __format__(self, format_spec, /) | Convert to a string according to format_spec. | | __ge__(self, value, /) | Return self>=value. | | __getattribute__(self, name, /) | Return getattr(self, name). | | __getnewargs__(self, /) | | __gt__(self, value, /) | Return self>value. | | __hash__(self, /) | Return hash(self). | | __index__(self, /) | Return self converted to an integer, if self is suitable for use as an index into a list. | | __int__(self, /) | int(self) | | __le__(self, value, /) | Return self<=value. | | __lshift__(self, value, /) | Return self<<value. | | __lt__(self, value, /) | Return self<value. | | __mod__(self, value, /) | Return self%value. | | __mul__(self, value, /) | Return self*value. | | __ne__(self, value, /) | Return self!=value. | | __neg__(self, /) | -self | | __pos__(self, /) | +self | | __pow__(self, value, mod=None, /) | Return pow(self, value, mod). | | __radd__(self, value, /) | Return value+self. | | __rdivmod__(self, value, /) | Return divmod(value, self). | | __rfloordiv__(self, value, /) | Return value//self. | | __rlshift__(self, value, /) | Return value<<self. | | __rmod__(self, value, /) | Return value%self. | | __rmul__(self, value, /) | Return value*self. | | __round__(...) | Rounding an Integral returns itself. | | Rounding with an ndigits argument also returns an integer. | | __rpow__(self, value, mod=None, /) | Return pow(value, self, mod). | | __rrshift__(self, value, /) | Return value>>self. | | __rshift__(self, value, /) | Return self>>value. | | __rsub__(self, value, /) | Return value-self. | | __rtruediv__(self, value, /) | Return value/self. | | __sizeof__(self, /) | Returns size in memory, in bytes. | | __sub__(self, value, /) | Return self-value. | | __truediv__(self, value, /) | Return self/value. | | __trunc__(...) | Truncating an Integral returns itself. | | as_integer_ratio(self, /) | Return a pair of integers, whose ratio is equal to the original int. | | The ratio is in lowest terms and has a positive denominator. | | >>> (10).as_integer_ratio() | (10, 1) | >>> (-10).as_integer_ratio() | (-10, 1) | >>> (0).as_integer_ratio() | (0, 1) | | bit_count(self, /) | Number of ones in the binary representation of the absolute value of self. | | Also known as the population count. | | >>> bin(13) | '0b1101' | >>> (13).bit_count() | 3 | | bit_length(self, /) | Number of bits necessary to represent self in binary. | | >>> bin(37) | '0b100101' | >>> (37).bit_length() | 6 | | conjugate(...) | Returns self, the complex conjugate of any int. | | is_integer(self, /) | Returns True. Exists for duck type compatibility with float.is_integer. | | to_bytes(self, /, length=1, byteorder='big', *, signed=False) | Return an array of bytes representing an integer. | | length | Length of bytes object to use. An OverflowError is raised if the | integer is not representable with the given number of bytes. Default | is length 1. | byteorder | The byte order used to represent the integer. If byteorder is 'big', | the most significant byte is at the beginning of the byte array. If | byteorder is 'little', the most significant byte is at the end of the | byte array. To request the native byte order of the host system, use | `sys.byteorder' as the byte order value. Default is to use 'big'. | signed | Determines whether two's complement is used to represent the integer. | If signed is False and a negative integer is given, an OverflowError | is raised. | | ---------------------------------------------------------------------- | Class methods inherited from int: | | from_bytes(bytes, byteorder='big', *, signed=False) | Return the integer represented by the given array of bytes. | | bytes | Holds the array of bytes to convert. The argument must either | support the buffer protocol or be an iterable object producing bytes. | Bytes and bytearray are examples of built-in objects that support the | buffer protocol. | byteorder | The byte order used to represent the integer. If byteorder is 'big', | the most significant byte is at the beginning of the byte array. If | byteorder is 'little', the most significant byte is at the end of the | byte array. To request the native byte order of the host system, use | `sys.byteorder' as the byte order value. Default is to use 'big'. | signed | Indicates whether two's complement is used to represent the integer. | | ---------------------------------------------------------------------- | Data descriptors inherited from int: | | denominator | the denominator of a rational number in lowest terms | | imag | the imaginary part of a complex number | | numerator | the numerator of a rational number in lowest terms | | real | the real part of a complex number
openpyxl.Workbook
Python Library Documentation: class Workbook in module openpyxl.workbook.workbook class Workbook(builtins.object) | Workbook(write_only=False, iso_dates=False) | | Workbook is the container for all other parts of the document. | | Methods defined here: | | __contains__(self, key) | | __delitem__(self, key) | | __getitem__(self, key) | Returns a worksheet by its name. | | :param name: the name of the worksheet to look for | :type name: string | | __init__(self, write_only=False, iso_dates=False) | Initialize self. See help(type(self)) for accurate signature. | | __iter__(self) | | add_named_style(self, style) | Add a named style | | close(self) | Close workbook file if open. Only affects read-only and write-only modes. | | copy_worksheet(self, from_worksheet) | Copy an existing worksheet in the current workbook | | .. warning:: | This function cannot copy worksheets between workbooks. | worksheets can only be copied within the workbook that they belong | | :param from_worksheet: the worksheet to be copied from | :return: copy of the initial worksheet | | create_chartsheet(self, title=None, index=None) | | create_named_range(self, name, worksheet=None, value=None, scope=None) | Create a new named_range on a worksheet | | | | .. note:: | Deprecated: Assign scoped named ranges directly to worksheets or global ones to the workbook. Deprecated in 3.1 | | create_sheet(self, title=None, index=None) | Create a worksheet (at an optional index). | | :param title: optional title of the sheet | :type title: str | :param index: optional position at which the sheet will be inserted | :type index: int | | get_index(self, worksheet) | Return the index of the worksheet. | | .. note:: | Deprecated: Use wb.index(worksheet) | | get_sheet_by_name(self, name) | Returns a worksheet by its name. | | :param name: the name of the worksheet to look for | :type name: string | | | | .. note:: | Deprecated: Use wb[sheetname] | | get_sheet_names(self) | .. note:: | Deprecated: Use wb.sheetnames | | index(self, worksheet) | Return the index of a worksheet. | | move_sheet(self, sheet, offset=0) | Move a sheet or sheetname | | remove(self, worksheet) | Remove `worksheet` from this workbook. | | remove_sheet(self, worksheet) | Remove `worksheet` from this workbook. | | .. note:: | Deprecated: Use wb.remove(worksheet) or del wb[sheetname] | | save(self, filename) | Save the current workbook under the given `filename`. | Use this function instead of using an `ExcelWriter`. | | .. warning:: | When creating your workbook using `write_only` set to True, | you will only be able to call this function once. Subsequent attempts to | modify or save the file will raise an :class:`openpyxl.shared.exc.WorkbookAlreadySaved` exception. | | ---------------------------------------------------------------------- | Readonly properties defined here: | | chartsheets | A list of Chartsheets in this workbook | | :type: list of :class:`openpyxl.chartsheet.chartsheet.Chartsheet` | | data_only | | excel_base_date | | mime_type | The mime type is determined by whether a workbook is a template or | not and whether it contains macros or not. Excel requires the file | extension to match but openpyxl does not enforce this. | | named_styles | List available named styles | | read_only | | sheetnames | Returns the list of the names of worksheets in this workbook. | | Names are returned in the worksheets order. | | :type: list of strings | | style_names | List of named styles | | worksheets | A list of sheets in this workbook | | :type: list of :class:`openpyxl.worksheet.worksheet.Worksheet` | | write_only | | ---------------------------------------------------------------------- | Data descriptors defined here: | | __dict__ | dictionary for instance variables | | __weakref__ | list of weak references to the object | | active | Get the currently active sheet or None | | :type: :class:`openpyxl.worksheet.worksheet.Worksheet` | | epoch | | ---------------------------------------------------------------------- | Data and other attributes defined here: | | path = '/xl/workbook.xml' | | template = False
openpyxl.cell
Python Library Documentation: package openpyxl.cell in openpyxl
NAME
openpyxl.cell - # Copyright (c) 2010-2024 openpyxl
PACKAGE CONTENTS
_writer
cell
read_only
rich_text
text
FILE
c:\users\youse\appdata\local\programs\python\python312\lib\site-packages\openpyxl\cell\__init__.py
openpyxl.chart
Python Library Documentation: package openpyxl.chart in openpyxl
NAME
openpyxl.chart - # Copyright (c) 2010-2024 openpyxl
PACKAGE CONTENTS
_3d
_chart
area_chart
axis
bar_chart
bubble_chart
chartspace
data_source
descriptors
error_bar
label
layout
legend
line_chart
marker
picture
pie_chart
pivot
plotarea
print_settings
radar_chart
reader
reference
scatter_chart
series
series_factory
shapes
stock_chart
surface_chart
text
title
trendline
updown_bars
FILE
c:\users\youse\appdata\local\programs\python\python312\lib\site-packages\openpyxl\chart\__init__.py
openpyxl.chartsheet
Python Library Documentation: package openpyxl.chartsheet in openpyxl
NAME
openpyxl.chartsheet - # Copyright (c) 2010-2024 openpyxl
PACKAGE CONTENTS
chartsheet
custom
properties
protection
publish
relation
views
FILE
c:\users\youse\appdata\local\programs\python\python312\lib\site-packages\openpyxl\chartsheet\__init__.py
openpyxl.comments
Python Library Documentation: package openpyxl.comments in openpyxl
NAME
openpyxl.comments - # Copyright (c) 2010-2024 openpyxl
PACKAGE CONTENTS
author
comment_sheet
comments
shape_writer
FILE
c:\users\youse\appdata\local\programs\python\python312\lib\site-packages\openpyxl\comments\__init__.py
openpyxl.compat
Python Library Documentation: package openpyxl.compat in openpyxl
NAME
openpyxl.compat - # Copyright (c) 2010-2024 openpyxl
PACKAGE CONTENTS
abc
numbers
product
singleton
strings
CLASSES
builtins.object
DummyCode
class DummyCode(builtins.object)
| Data descriptors defined here:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
FUNCTIONS
deprecated(reason)
DATA
NUMERIC_TYPES = (<class 'int'>, <class 'float'>, <class 'decimal.Decim...
string_types = (<class 'bytes'>, <class 'str'>)
FILE
c:\users\youse\appdata\local\programs\python\python312\lib\site-packages\openpyxl\compat\__init__.py
openpyxl.constants
Python Library Documentation: module openpyxl._constants in openpyxl
NAME
openpyxl._constants - Package metadata
DATA
__author_email__ = 'charlie.clark@clark-consulting.eu'
__license__ = 'MIT'
__maintainer_email__ = 'openpyxl-users@googlegroups.com'
__python__ = '3.8'
__url__ = 'https://openpyxl.readthedocs.io'
VERSION
3.1.5
AUTHOR
See AUTHORS
FILE
c:\users\youse\appdata\local\programs\python\python312\lib\site-packages\openpyxl\_constants.py
openpyxl.descriptors
Python Library Documentation: package openpyxl.descriptors in openpyxl
NAME
openpyxl.descriptors - # Copyright (c) 2010-2024 openpyxl
PACKAGE CONTENTS
base
container
excel
namespace
nested
sequence
serialisable
slots
CLASSES
builtins.object
Strict
builtins.type(builtins.object)
MetaSerialisable
MetaStrict
class MetaSerialisable(builtins.type)
| MetaSerialisable(clsname, bases, methods)
|
| Method resolution order:
| MetaSerialisable
| builtins.type
| builtins.object
|
| Static methods defined here:
|
| __new__(cls, clsname, bases, methods)
| Create and return a new object. See help(type) for accurate signature.
|
| ----------------------------------------------------------------------
| Data and other attributes defined here:
|
| __annotations__ = {}
|
| ----------------------------------------------------------------------
| Methods inherited from builtins.type:
|
| __call__(self, /, *args, **kwargs)
| Call self as a function.
|
| __delattr__(self, name, /)
| Implement delattr(self, name).
|
| __dir__(self, /)
| Specialized __dir__ implementation for types.
|
| __getattribute__(self, name, /)
| Return getattr(self, name).
|
| __init__(self, /, *args, **kwargs)
| Initialize self. See help(type(self)) for accurate signature.
|
| __instancecheck__(self, instance, /)
| Check if an object is an instance.
|
| __or__(self, value, /)
| Return self|value.
|
| __repr__(self, /)
| Return repr(self).
|
| __ror__(self, value, /)
| Return value|self.
|
| __setattr__(self, name, value, /)
| Implement setattr(self, name, value).
|
| __sizeof__(self, /)
| Return memory consumption of the type object.
|
| __subclasscheck__(self, subclass, /)
| Check if a class is a subclass.
|
| __subclasses__(self, /)
| Return a list of immediate subclasses.
|
| mro(self, /)
| Return a type's method resolution order.
|
| ----------------------------------------------------------------------
| Class methods inherited from builtins.type:
|
| __prepare__(...)
| __prepare__() -> dict
| used to create the namespace for the class statement
|
| ----------------------------------------------------------------------
| Data descriptors inherited from builtins.type:
|
| __abstractmethods__
|
| __dict__
|
| __text_signature__
|
| ----------------------------------------------------------------------
| Data and other attributes inherited from builtins.type:
|
| __base__ = <class 'type'>
| type(object) -> the object's type
| type(name, bases, dict, **kwds) -> a new type
|
|
| __bases__ = (<class 'type'>,)
|
| __basicsize__ = 920
|
| __dictoffset__ = 264
|
| __flags__ = 2156420608
|
| __itemsize__ = 40
|
| __mro__ = (<class 'openpyxl.descriptors.MetaSerialisable'>, <class 'ty...
|
| __type_params__ = ()
|
| __weakrefoffset__ = 368
class MetaStrict(builtins.type)
| MetaStrict(clsname, bases, methods)
|
| Method resolution order:
| MetaStrict
| builtins.type
| builtins.object
|
| Static methods defined here:
|
| __new__(cls, clsname, bases, methods)
| Create and return a new object. See help(type) for accurate signature.
|
| ----------------------------------------------------------------------
| Data and other attributes defined here:
|
| __annotations__ = {}
|
| ----------------------------------------------------------------------
| Methods inherited from builtins.type:
|
| __call__(self, /, *args, **kwargs)
| Call self as a function.
|
| __delattr__(self, name, /)
| Implement delattr(self, name).
|
| __dir__(self, /)
| Specialized __dir__ implementation for types.
|
| __getattribute__(self, name, /)
| Return getattr(self, name).
|
| __init__(self, /, *args, **kwargs)
| Initialize self. See help(type(self)) for accurate signature.
|
| __instancecheck__(self, instance, /)
| Check if an object is an instance.
|
| __or__(self, value, /)
| Return self|value.
|
| __repr__(self, /)
| Return repr(self).
|
| __ror__(self, value, /)
| Return value|self.
|
| __setattr__(self, name, value, /)
| Implement setattr(self, name, value).
|
| __sizeof__(self, /)
| Return memory consumption of the type object.
|
| __subclasscheck__(self, subclass, /)
| Check if a class is a subclass.
|
| __subclasses__(self, /)
| Return a list of immediate subclasses.
|
| mro(self, /)
| Return a type's method resolution order.
|
| ----------------------------------------------------------------------
| Class methods inherited from builtins.type:
|
| __prepare__(...)
| __prepare__() -> dict
| used to create the namespace for the class statement
|
| ----------------------------------------------------------------------
| Data descriptors inherited from builtins.type:
|
| __abstractmethods__
|
| __dict__
|
| __text_signature__
|
| ----------------------------------------------------------------------
| Data and other attributes inherited from builtins.type:
|
| __base__ = <class 'type'>
| type(object) -> the object's type
| type(name, bases, dict, **kwds) -> a new type
|
|
| __bases__ = (<class 'type'>,)
|
| __basicsize__ = 920
|
| __dictoffset__ = 264
|
| __flags__ = 2156420608
|
| __itemsize__ = 40
|
| __mro__ = (<class 'openpyxl.descriptors.MetaStrict'>, <class 'type'>, ...
|
| __type_params__ = ()
|
| __weakrefoffset__ = 368
class Strict(builtins.object)
| Data descriptors defined here:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
DATA
DEBUG = False
FILE
c:\users\youse\appdata\local\programs\python\python312\lib\site-packages\openpyxl\descriptors\__init__.py
openpyxl.drawing
Python Library Documentation: package openpyxl.drawing in openpyxl
NAME
openpyxl.drawing - # Copyright (c) 2010-2024 openpyxl
PACKAGE CONTENTS
colors
connector
drawing
effect
fill
geometry
graphic
image
line
picture
properties
relation
spreadsheet_drawing
text
xdr
FILE
c:\users\youse\appdata\local\programs\python\python312\lib\site-packages\openpyxl\drawing\__init__.py
openpyxl.formatting
Python Library Documentation: package openpyxl.formatting in openpyxl
NAME
openpyxl.formatting - # Copyright (c) 2010-2024 openpyxl
PACKAGE CONTENTS
formatting
rule
FILE
c:\users\youse\appdata\local\programs\python\python312\lib\site-packages\openpyxl\formatting\__init__.py
openpyxl.formula
Python Library Documentation: package openpyxl.formula in openpyxl
NAME
openpyxl.formula - # Copyright (c) 2010-2024 openpyxl
PACKAGE CONTENTS
tokenizer
translate
FILE
c:\users\youse\appdata\local\programs\python\python312\lib\site-packages\openpyxl\formula\__init__.py
openpyxl.load_workbook
Python Library Documentation: function load_workbook in module openpyxl.reader.excel
load_workbook(filename, read_only=False, keep_vba=False, data_only=False, keep_links=True, rich_text=False)
Open the given filename and return the workbook
:param filename: the path to open or a file-like object
:type filename: string or a file-like object open in binary mode c.f., :class:`zipfile.ZipFile`
:param read_only: optimised for reading, content cannot be edited
:type read_only: bool
:param keep_vba: preserve vba content (this does NOT mean you can use it)
:type keep_vba: bool
:param data_only: controls whether cells with formulae have either the formula (default) or the value stored the last time Excel read the sheet
:type data_only: bool
:param keep_links: whether links to external workbooks should be preserved. The default is True
:type keep_links: bool
:param rich_text: if set to True openpyxl will preserve any rich text formatting in cells. The default is False
:type rich_text: bool
:rtype: :class:`openpyxl.workbook.Workbook`
.. note::
When using lazy load, all worksheets will be :class:`openpyxl.worksheet.iter_worksheet.IterableWorksheet`
and the returned workbook will be read-only.
openpyxl.open
Python Library Documentation: function load_workbook in module openpyxl.reader.excel
load_workbook(filename, read_only=False, keep_vba=False, data_only=False, keep_links=True, rich_text=False)
Open the given filename and return the workbook
:param filename: the path to open or a file-like object
:type filename: string or a file-like object open in binary mode c.f., :class:`zipfile.ZipFile`
:param read_only: optimised for reading, content cannot be edited
:type read_only: bool
:param keep_vba: preserve vba content (this does NOT mean you can use it)
:type keep_vba: bool
:param data_only: controls whether cells with formulae have either the formula (default) or the value stored the last time Excel read the sheet
:type data_only: bool
:param keep_links: whether links to external workbooks should be preserved. The default is True
:type keep_links: bool
:param rich_text: if set to True openpyxl will preserve any rich text formatting in cells. The default is False
:type rich_text: bool
:rtype: :class:`openpyxl.workbook.Workbook`
.. note::
When using lazy load, all worksheets will be :class:`openpyxl.worksheet.iter_worksheet.IterableWorksheet`
and the returned workbook will be read-only.
openpyxl.packaging
Python Library Documentation: package openpyxl.packaging in openpyxl
NAME
openpyxl.packaging - Stuff related to Office OpenXML packaging: relationships, archive, content types.
PACKAGE CONTENTS
core
custom
extended
interface
manifest
relationship
workbook
FILE
c:\users\youse\appdata\local\programs\python\python312\lib\site-packages\openpyxl\packaging\__init__.py
openpyxl.pivot
Python Library Documentation: package openpyxl.pivot in openpyxl
NAME
openpyxl.pivot - # Copyright (c) 2010-2024 openpyxl
PACKAGE CONTENTS
cache
fields
record
table
FILE
c:\users\youse\appdata\local\programs\python\python312\lib\site-packages\openpyxl\pivot\__init__.py
openpyxl.reader
Python Library Documentation: package openpyxl.reader in openpyxl
NAME
openpyxl.reader - # Copyright (c) 2010-2024 openpyxl
PACKAGE CONTENTS
drawings
excel
strings
workbook
FILE
c:\users\youse\appdata\local\programs\python\python312\lib\site-packages\openpyxl\reader\__init__.py
openpyxl.styles
Python Library Documentation: package openpyxl.styles in openpyxl
NAME
openpyxl.styles - # Copyright (c) 2010-2024 openpyxl
PACKAGE CONTENTS
alignment
borders
builtins
cell_style
colors
differential
fills
fonts
named_styles
numbers
protection
proxy
styleable
stylesheet
table
DATA
DEFAULT_FONT = <openpyxl.styles.fonts.Font object>
Parameters:
..., sz...
FILE
c:\users\youse\appdata\local\programs\python\python312\lib\site-packages\openpyxl\styles\__init__.py
openpyxl.utils
Python Library Documentation: package openpyxl.utils in openpyxl
NAME
openpyxl.utils - # Copyright (c) 2010-2024 openpyxl
PACKAGE CONTENTS
bound_dictionary
cell
dataframe
datetime
escape
exceptions
formulas
indexed_list
inference
protection
units
DATA
FORMULAE = frozenset({'ABS', 'ACCRINT', 'ACCRINTM', 'ACOS', 'ACOSH', '...
FILE
c:\users\youse\appdata\local\programs\python\python312\lib\site-packages\openpyxl\utils\__init__.py
openpyxl.workbook
Python Library Documentation: package openpyxl.workbook in openpyxl
NAME
openpyxl.workbook - # Copyright (c) 2010-2024 openpyxl
PACKAGE CONTENTS
_writer
child
defined_name
external_link (package)
external_reference
function_group
properties
protection
smart_tags
views
web
workbook
FILE
c:\users\youse\appdata\local\programs\python\python312\lib\site-packages\openpyxl\workbook\__init__.py
openpyxl.worksheet
Python Library Documentation: package openpyxl.worksheet in openpyxl
NAME
openpyxl.worksheet - # Copyright (c) 2010-2024 openpyxl
PACKAGE CONTENTS
_read_only
_reader
_write_only
_writer
cell_range
cell_watch
controls
copier
custom
datavalidation
dimensions
drawing
errors
filters
formula
header_footer
hyperlink
merge
ole
page
pagebreak
picture
print_settings
properties
protection
related
scenario
smart_tag
table
views
worksheet
FILE
c:\users\youse\appdata\local\programs\python\python312\lib\site-packages\openpyxl\worksheet\__init__.py
openpyxl.writer
Python Library Documentation: package openpyxl.writer in openpyxl
NAME
openpyxl.writer - # Copyright (c) 2010-2024 openpyxl
PACKAGE CONTENTS
excel
theme
FILE
c:\users\youse\appdata\local\programs\python\python312\lib\site-packages\openpyxl\writer\__init__.py
openpyxl.xml
Python Library Documentation: package openpyxl.xml in openpyxl
NAME
openpyxl.xml - Collection of XML resources compatible across different Python versions
PACKAGE CONTENTS
constants
functions
FUNCTIONS
defusedxml_available()
defusedxml_env_set()
lxml_available()
lxml_env_set()
DATA
DEFUSEDXML = True
LXML = True
FILE
c:\users\youse\appdata\local\programs\python\python312\lib\site-packages\openpyxl\xml\__init__.py