OXIESEC PANEL

Name	Size	Modified	Perms
📁 ..	-	12/11/2024 09:39:44 AM	rwxr-xr-x
📄 Makefile	618 bytes	10/09/2024 06:13:32 AM	rw-r--r--
📄 api.rst	2.41 KB	10/09/2024 06:13:32 AM	rw-r--r--
📁 community	-	10/09/2024 06:13:32 AM	rwxr-xr-x
📄 conf.py	4.98 KB	10/09/2024 06:13:32 AM	rw-r--r--
📄 index.rst	2.29 KB	10/09/2024 06:13:32 AM	rw-r--r--
📄 make.bat	785 bytes	10/09/2024 06:13:32 AM	rw-r--r--
📄 requirements.txt	12 bytes	10/09/2024 06:13:32 AM	rw-r--r--
📁 user	-	10/09/2024 06:13:32 AM	rwxr-xr-x

Editing: api.rst

.. _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