Class WorkSheet

O365/excel.py:1476–1679

An Excel WorkSheet

class WorkSheet(ApiComponent):
    """ An Excel WorkSheet """

    _endpoints = {
        'get_tables': '/tables',
        'get_table': '/tables/{id}',
        'get_range': '/range',
        'add_table': '/tables/add',
        'get_used_range': '/usedRange(valuesOnly={})',
        'get_cell': '/cell(row={row},column={column})',
        'add_named_range': '/names/add',
        'add_named_range_f': '/names/addFormulaLocal',
        'get_named_range': '/names/{name}',
    }

    table_constructor = Table
    range_constructor = Range
    named_range_constructor = NamedRange

    def __init__(self, parent=None, session=None, **kwargs):
        if parent and session:
            raise ValueError('Need a parent or a session but not both')

        self.workbook = parent
        self.session = parent.session if parent else session

        cloud_data = kwargs.get(self._cloud_data_key, {})

        self.object_id = cloud_data.get('id', None)

        # Choose the main_resource passed in kwargs over parent main_resource
        main_resource = kwargs.pop('main_resource', None) or (
            getattr(parent, 'main_resource', None) if parent else None)

        # append the encoded worksheet path
        main_resource = "{}/worksheets('{}')".format(main_resource, quote(self.object_id))

        super().__init__(
            protocol=parent.protocol if parent else kwargs.get('protocol'),
            main_resource=main_resource)

        self.name = cloud_data.get('name', None)
        self.position = cloud_data.get('position', None)
        self.visibility = cloud_data.get('visibility', None)

    def __str__(self):
        return self.__repr__()

    def __repr__(self):
        return 'Worksheet: {}'.format(self.name)

    def __eq__(self, other):
        return self.object_id == other.object_id

    def delete(self):
        """ Deletes this worksheet """
        return bool(self.session.delete(self.build_url('')))