.. vim: set fileencoding=utf-8:
.. -*- coding: utf-8 -*-
.. +--------------------------------------------------------------------------+
   |                                                                          |
   | Licensed under the Apache License, Version 2.0 (the "License");          |
   | you may not use this file except in compliance with the License.         |
   | You may obtain a copy of the License at                                  |
   |                                                                          |
   |     http://www.apache.org/licenses/LICENSE-2.0                           |
   |                                                                          |
   | Unless required by applicable law or agreed to in writing, software      |
   | distributed under the License is distributed on an "AS IS" BASIS,        |
   | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
   | See the License for the specific language governing permissions and      |
   | limitations under the License.                                           |
   |                                                                          |
   +--------------------------------------------------------------------------+


*******************************************************************************
Release Notes
*******************************************************************************

.. towncrier release notes start

detextive 3.1 (2026-02-16)
==========================

Enhancements
------------

- API: Add ``Behaviors.utf_16_32_requires_byte_order`` to optionally reject
  BOM-less trial decodes for generic ``utf-16`` and ``utf-32`` while keeping
  permissive behavior as the default.


Repairs
-------

- API: Report UTF charset results from BOM provenance rather than decode codec
  choice so ``utf-8-sig`` is returned only when a UTF-8 BOM is present, and
  apply the same provenance normalization to UTF-16/UTF-32 reporting across
  decode, detection, and inference surfaces.


detextive 3.0 (2026-02-13)
==========================

Enhancements
------------

- API: Add ``decode_inform`` to return decoded text together with charset, MIME
  type, and line-separator metadata in a single call.
- API: Honor supplied textual ``http_content_type`` metadata consistently across
  decode and inference paths, including header-guided charset trial decode.


Removals
--------

- API: Remove ``charset_default``, ``mimetype_default``, and
  ``mimetype_supplement`` parameters from ``decode`` so decoding follows
  decode-or-error semantics instead of fallback-return inference semantics.
- API: Replace ``Behaviors.charset_detect`` and ``Behaviors.mimetype_detect``
  tristates with booleans; pass ``True`` or ``False`` instead of
  ``BehaviorTristate`` values.


Repairs
-------

- Fix UTF-8 content incorrectly decoded when charset detector misidentifies encoding, causing mojibake with non-ASCII characters and emoji.
- Fix malformed ``http_content_type`` parameter parsing so inference no longer
  raises raw ``ValueError`` for invalid header parameter syntax.
  Also include the resolved MIME type value in ``TextualMimetypeInvalidity``
  messages.
- Reject binary content with non-textual MIME types instead of attempting to decode, preventing false positives where binary data was incorrectly decoded as text.


detextive 2.0 (2025-09-20)
==========================

Enhancements
------------

- API: Add comprehensive type aliases for function arguments with PEP 593 annotations for improved API documentation and semantic clarity.
- API: Add confidence-based detection with new functions ``detect_charset_confidence()``, ``detect_mimetype_confidence()``, ``infer_charset_confidence()``, and ``infer_mimetype_charset_confidence()`` returning Result objects with confidence scores.
- API: Enhance ``decode()`` function with intelligent MIME type validation, graceful error fallback, and single-pass decoding efficiency.
- API: Implement comprehensive text validation system with Unicode-aware profiles including TEXTUAL, TERMINAL, TERMINAL_ANSI, and PRINTER configurations.
- Platform: Improve Windows compatibility by using python-magic-bin to avoid Cygwin buffer issues and handle MIME type detection differences.


Notices
-------

- API: Rename ``detect_mimetype_and_charset()`` to ``infer_mimetype_charset()`` and ``is_textual_content()`` to ``is_valid_text()`` for improved clarity.


Detextive 1.0 (2025-08-12)
==========================

Enhancements
------------

- Provide ``LineSeparators`` enum with detection, normalization, and nativization
  methods.
- Provide ``detect_charset``, ``detect_mimetype``,
  ``detect_charset_and_mimetype``, ``is_textual_mimetype``, and
  ``is_textual_content``.