Classe « ExcelFile »

Informations générales

Héritage

builtins.object
    ExcelFile

Définition

class ExcelFile(builtins.object):

help(ExcelFile)

Class for parsing tabular Excel sheets into DataFrame objects.

See read_excel for more documentation.

Parameters
----------
path_or_buffer : str, bytes, path object (pathlib.Path or py._path.local.LocalPath),
    A file-like object, xlrd workbook or openpyxl workbook.
    If a string or path object, expected to be a path to a
    .xls, .xlsx, .xlsb, .xlsm, .odf, .ods, or .odt file.
engine : str, default None
    If io is not a buffer or path, this must be set to identify io.
    Supported engines: ``xlrd``, ``openpyxl``, ``odf``, ``pyxlsb``, ``calamine``
    Engine compatibility :

    - ``xlrd`` supports old-style Excel files (.xls).
    - ``openpyxl`` supports newer Excel file formats.
    - ``odf`` supports OpenDocument file formats (.odf, .ods, .odt).
    - ``pyxlsb`` supports Binary Excel files.
    - ``calamine`` supports Excel (.xls, .xlsx, .xlsm, .xlsb)
      and OpenDocument (.ods) file formats.

    .. versionchanged:: 1.2.0

       The engine `xlrd <https://xlrd.readthedocs.io/en/latest/>`_
       now only supports old-style ``.xls`` files.
       When ``engine=None``, the following logic will be
       used to determine the engine:

       - If ``path_or_buffer`` is an OpenDocument format (.odf, .ods, .odt),
         then `odf <https://pypi.org/project/odfpy/>`_ will be used.
       - Otherwise if ``path_or_buffer`` is an xls format,
         ``xlrd`` will be used.
       - Otherwise if ``path_or_buffer`` is in xlsb format,
         `pyxlsb <https://pypi.org/project/pyxlsb/>`_ will be used.

       .. versionadded:: 1.3.0

       - Otherwise if `openpyxl <https://pypi.org/project/openpyxl/>`_ is installed,
         then ``openpyxl`` will be used.
       - Otherwise if ``xlrd >= 2.0`` is installed, a ``ValueError`` will be raised.

       .. warning::

        Please do not report issues when using ``xlrd`` to read ``.xlsx`` files.
        This is not supported, switch to using ``openpyxl`` instead.
engine_kwargs : dict, optional
    Arbitrary keyword arguments passed to excel engine.

Examples
--------
>>> file = pd.ExcelFile('myfile.xlsx')  # doctest: +SKIP
>>> with pd.ExcelFile("myfile.xls") as xls:  # doctest: +SKIP
...     df1 = pd.read_excel(xls, "Sheet1")  # doctest: +SKIP

Constructeur(s)

Signature du constructeur	Description
__init__(self, path_or_buffer, engine: 'str \| None' = None, storage_options: 'StorageOptions \| None' = None, engine_kwargs: 'dict \| None' = None) -> 'None'

Liste des propriétés

Nom de la propriété	Description
book
sheet_names

Liste des opérateurs

Opérateurs hérités de la classe object

__eq__, __ge__, __gt__, __le__, __lt__, __ne__

Liste des méthodes

Toutes les méthodes Méthodes d'instance Méthodes statiques

Signature de la méthode	Description
__enter__(self) -> 'Self'
__exit__(self, exc_type: 'type[BaseException] \| None', exc_value: 'BaseException \| None', traceback: 'TracebackType \| None') -> 'None'
__fspath__(self)
close(self) -> 'None'	close io if necessary _{[extrait de close.__doc__]}
parse(self, sheet_name: 'str \| int \| list[int] \| list[str] \| None' = 0, header: 'int \| Sequence[int] \| None' = 0, names: 'SequenceNotStr[Hashable] \| range \| None' = None, index_col: 'int \| Sequence[int] \| None' = None, usecols=None, converters=None, true_values: 'Iterable[Hashable] \| None' = None, false_values: 'Iterable[Hashable] \| None' = None, skiprows: 'Sequence[int] \| int \| Callable[[int], object] \| None' = None, nrows: 'int \| None' = None, na_values=None, parse_dates: 'list \| dict \| bool' = False, date_parser: 'Callable \| lib.NoDefault' = <no_default>, date_format: 'str \| dict[Hashable, str] \| None' = None, thousands: 'str \| None' = None, comment: 'str \| None' = None, skipfooter: 'int' = 0, dtype_backend: 'DtypeBackend \| lib.NoDefault' = <no_default>, **kwds) -> 'DataFrame \| dict[str, DataFrame] \| dict[int, DataFrame]'