1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100
|
.. _api:
Developer Interfaces
====================
.. module:: charset_normalizer
Main Interfaces
---------------
Those functions are publicly exposed and are protected through our BC guarantee.
.. autofunction:: from_bytes
.. autofunction:: from_fp
.. autofunction:: from_path
.. autofunction:: is_binary
.. autoclass:: charset_normalizer.models.CharsetMatches
:inherited-members:
.. autoclass:: charset_normalizer.models.CharsetMatch
:inherited-members:
.. autofunction:: detect
.. autofunction:: charset_normalizer.utils.set_logging_handler
Mess Detector
-------------
.. autofunction:: charset_normalizer.md.mess_ratio
This library allows you to extend the capabilities of the mess detector by extending the
class `MessDetectorPlugin`.
.. autoclass:: charset_normalizer.md.MessDetectorPlugin
:inherited-members:
.. autofunction:: charset_normalizer.md.is_suspiciously_successive_range
Coherence Detector
------------------
.. autofunction:: charset_normalizer.cd.coherence_ratio
Utilities
---------
Some reusable functions used across the project. We do not guarantee the BC in this area.
.. autofunction:: charset_normalizer.utils.is_accentuated
.. autofunction:: charset_normalizer.utils.remove_accent
.. autofunction:: charset_normalizer.utils.unicode_range
.. autofunction:: charset_normalizer.utils.is_latin
.. autofunction:: charset_normalizer.utils.is_punctuation
.. autofunction:: charset_normalizer.utils.is_symbol
.. autofunction:: charset_normalizer.utils.is_emoticon
.. autofunction:: charset_normalizer.utils.is_separator
.. autofunction:: charset_normalizer.utils.is_case_variable
.. autofunction:: charset_normalizer.utils.is_cjk
.. autofunction:: charset_normalizer.utils.is_hiragana
.. autofunction:: charset_normalizer.utils.is_katakana
.. autofunction:: charset_normalizer.utils.is_hangul
.. autofunction:: charset_normalizer.utils.is_thai
.. autofunction:: charset_normalizer.utils.is_unicode_range_secondary
.. autofunction:: charset_normalizer.utils.any_specified_encoding
.. autofunction:: charset_normalizer.utils.is_multi_byte_encoding
.. autofunction:: charset_normalizer.utils.identify_sig_or_bom
.. autofunction:: charset_normalizer.utils.should_strip_sig_or_bom
.. autofunction:: charset_normalizer.utils.iana_name
.. autofunction:: charset_normalizer.utils.range_scan
.. autofunction:: charset_normalizer.utils.is_cp_similar
.. class:: os.PathLike
.. class:: typing.BinaryIO
|