C:\Users\xxx>python -m pydoc
pydoc-the Python documentation tool
pydoc ...
Show text documentation on something. may be the name of a
Python keyword, topic,function, module, or package, or a dotted
reference to a class orfunction within a module or module ina
package.If contains a '\', it is used as the path to a
Python source file to document.Ifname is 'keywords', 'topics',
or 'modules', a listing of these things is displayed.
pydoc-k Searchfor a keyword inthe synopsis lines of all available modules.
pydoc-p Start an HTTP server on the given port on the local machine. Port
number0can be used to get an arbitrary unused port.
pydoc-b
Start an HTTP server on an arbitrary unused port and open a Web browser
to interactively browse documentation. The-p option can be used with
the-b option to explicitly specify the server port.
pydoc-w ...
Write out the HTML documentationfor a module to a file inthe current
directory.If contains a '\', it is treated as a filename; ifit names a directory, documentation is writtenforall the contents.
C:\Users\xxx>python -m pydoc xlrd
Help on package xlrd:
NAME
xlrd
DESCRIPTION#Copyright (c) 2005-2012 Stephen John Machin, Lingfo Pty Ltd
#This module is part of the xlrd package, which is released under a
#BSD-style licence.
PACKAGE CONTENTS
biffh
book
compdoc
formatting
formula
info
sheet
timemachine
xldate
xlsx
FUNCTIONS
count_records(filename, outfile=<_io.textiowrapper name="<stdout>" mode="w" encoding="utf-8">)Fordebugging and analysis: summarise the file's BIFF records.
ie: produce a sorted file of ``(record_name, count)``.
:paramfilename: The path to the file to be summarised.
:paramoutfile: An open file, to which the summary is written.
dump(filename, outfile=<_io.textiowrapper name="<stdout>" mode="w" encoding="utf-8">, unnumbered=False)For debugging: dump an XLS file's BIFF records in char &hex.
:paramfilename: The path to the file to be dumped.
:paramoutfile: An open file, to which the dump is written.
:param unnumbered: If true, omit offsets (formeaningful diffs).
open_workbook(filename=None, logfile=<_io.textiowrapper name="<stdout>" mode="w" encoding="utf-8">, verbosity=0, use_mmap=1, file_contents=None, encoding_override=None, formatting_info=False, on_demand=False, ragged_rows=False)
Open a spreadsheet filefordata extraction.
:paramfilename: The path to the spreadsheet file to be opened.
:paramlogfile: An open file to which messages and diagnostics are written.
:paramverbosity: Increases the volume of trace material written to the
logfile.
:paramuse_mmap:
Whether to use the mmap module is determined heuristically.
Use this arg to override the result.
Current heuristic: mmap is usedifit exists.
:paramfile_contents:
A string or an :class:`mmap.mmap` object or some other behave-alike
object.If``file_contents`` is supplied, ``filename`` will not be used,
except (possibly)inmessages.
:paramencoding_override:
Used to overcome missing or bad codepage informationin older-version files. See :doc:`unicode`.
:paramformatting_info:
Thedefault is ``False``, which saves memory.In this case, "Blank"cells, which are those with their own formatting
information but no data, are treated as empty by ignoring the file's
``BLANK`` and ``MULBLANK`` records.
This cuts off any bottom or right"margin"of rows of empty or blank
cells.
Only :meth:`~xlrd.sheet.Sheet.cell_value` and
:meth:`~xlrd.sheet.Sheet.cell_type` are available.
When ``True``, formatting information will be read from the spreadsheet
file. This provides all cells, including empty and blank cells.
Formatting information is availableforeach cell.
Note that this will raise a NotImplementedError when used with an
xlsx file.
:paramon_demand:
Governs whether sheets are all loaded initially or when demanded
by the caller. See :doc:`on_demand`.
:paramragged_rows:
Thedefault of ``False`` means all rows are padded out with empty cells so
that all rows have the same size as foundin:attr:`~xlrd.sheet.Sheet.ncols`.
``True`` means that there are no empty cells at the ends of rows.
This can resultin substantial memory savings ifrows are of widely
varying sizes. See also the :meth:`~xlrd.sheet.Sheet.row_len` method.
:returns: An instance of the :class:`~xlrd.book.Book` class.
DATA
FMLA_TYPE_ARRAY= 4FMLA_TYPE_CELL= 1FMLA_TYPE_COND_FMT= 8FMLA_TYPE_DATA_VAL= 16FMLA_TYPE_NAME= 32FMLA_TYPE_SHARED= 2MMAP_AVAILABLE= 1
-- More --