pip._vendor.chardet.cli.chardetect Namespace Reference

Functions
Optional[str]	description_of (Iterable[bytes] lines, str name="stdin", bool minimal=False, bool should_rename_legacy=False)
None	main (Optional[List[str]] argv=None)

Detailed Description

Script which takes one or more file paths and reports on their detected
encodings

Example::

    % chardetect somefile someotherfile
    somefile: windows-1252 with confidence 0.5
    someotherfile: ascii with confidence 1.0

If no paths are provided, it takes its input from stdin.

Function Documentation

description_of()

Optional[str] pip._vendor.chardet.cli.chardetect.description_of	(	Iterable[bytes]	lines,
		str	name = "stdin",
		bool	minimal = False,
		bool	should_rename_legacy = False
	)

Return a string describing the probable encoding of a file or
list of strings.

:param lines: The lines to get the encoding of.
:type lines: Iterable of bytes
:param name: Name of file or collection of lines
:type name: str
:param should_rename_legacy:  Should we rename legacy encodings to
                              their more modern equivalents?
:type should_rename_legacy:   ``bool``

main()

None pip._vendor.chardet.cli.chardetect.main

(

Optional[List[str]]

argv = None

)

Handles command line arguments and gets things started.

:param argv: List of arguments, as if specified on the command-line.
             If None, ``sys.argv[1:]`` is used instead.
:type argv: list of str