Use Keep A Changelog style (#1310)

Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>

Author: Copilot

CHANGELOG.md

@@ -4,116 +4,180 @@ SPDX-FileType: DOCUMENTATION
 SPDX-License-Identifier: CC0-1.0
 ---
 
+<!-- markdownlint-disable MD024 -->
+
 # Changelog
 
-Notable changes between versions.
-
-- For full release notes, see:
-  <https://github.com/PyThaiNLP/pythainlp/releases>
-- For detailed commit changes, see:
-  <https://github.com/PyThaiNLP/pythainlp/compare/v5.2.0...dev>
-  (select tags to compare)
-
-## Version 5.2.0 -> dev
-
-Minimum required version is now 3.9.
-Support for Python 3.7 and 3.8 has been removed.
-Added official support and CI testing for Python 3.14.
-
-Some features and fixes in this version are AI-assisted.
-See PR for prompt and details.
-
-- Fix `royin` romanization #1172
-- Fix final consonant classification in `check_marttra()` #1173
-- Lazy load dictionaries to reduce memory usage #1186
-- Fix Kho Khon alphabet issue in `tltk` transliteration #1187
-- Migrate configurations to pyproject.toml #1188 #1226 #1239
-- Update type hints; Use Python 3.9 features #1189 #1190 & etc.
-- Remove duplicated entries in volubilis dictionary #1200
-- Remove star imports #1207
-- Remove `requests` dependency #1211
-- Make package zip-safe #1212
-- Ensure thread-safety for tokenizers #1213
-- Add Thai-NNER integration with top-level entity filtering #1221
-- Reorganize noauto test suite by dependency groups
-  (torch, tensorflow, onnx, cython, network) #1290
-- Add BLEU, ROUGE, WER, and CER metrics to pythainlp.benchmarks #1295
-- Add `check_khuap_klam` to `pythainlp.util` for checking
-  Thai consonant clusters #1308
-- Add Attaparse engine to dependency parser
-  (`dependency_parsing`, engine="attaparse") #1303
-- `get_corpus_path()` now respects `PYTHAINLP_OFFLINE` env var (same semantics
-  as `HF_HUB_OFFLINE`): when set, raises `FileNotFoundError` if the corpus is
-  not already cached locally; when unset, auto-downloads as before #1306
-- Added `pythainlp.is_offline_mode()` helper function (mirrors
-  `huggingface_hub.is_offline_mode()`) #1306
-- `PYTHAINLP_DATA` is now the preferred env var for the data directory
-  (same pattern as `NLTK_DATA`); `PYTHAINLP_DATA_DIR` is deprecated
-  and will emit a `DeprecationWarning` #1306
-- Callers raise `FileNotFoundError` with download instructions when a corpus
-  path cannot be resolved (e.g. download failed) #1306
-- Improved documentation; code cleanup; more tests
-
-## Version 5.1.2 -> 5.2.0
-
-- Add pythainlp.translate.word_translate #1102
-- Update Dockerfile #1049
-- Add Words Spelling Correction using Char2Vec #1075
-- Add Thailand Ancient Currency Converter #1113
-- Add B-K/umt5-thai-g2p-v2-0.5k #1140
-- Add budoux #1161
-- Remove conceptnet #1103
-- fix the connectivity of cli commands #1154
-- Fix Docker build failure, add docker compose file
-  for convenience #1132
-
-## Version 5.1.1 -> 5.1.2
-
-- Update romanize docs and keep space #1110
-
-## Version 5.1.0 -> 5.1.1
-
-- PR Description: Refactor thai_consonants_all to
-  use set in syllable.py #1087
-- ThaiTransliterator: Select 1D CPU int64 tensor device #1089
-
-## Version 5.0.5 -> 5.1.0
-
-- Add Thai Discourse Treebank postag #910
-- Add Thai Universal Dependency Treebank postag #916
-- Add Thai G2P v2 Grapheme-to-Phoneme model #923
-- Add support for list of strings as input
-  to sent_tokenize() #927
-- Add pythainlp.tools.safe_print to handle UnicodeEncodeError
-  on console #969
-- Fix collate() to consider tonemark in ordering #926
-- Fix nlpo3.load_dict() that never print error msg when
-  not success #979
-- Add Thai Solar Date convert to Thai Lunar Date #998
-- Add Thai pangram text #1045
-- Remove clause_tokenize #1024
-
-## Version 5.0.4 -> 5.0.5
-
-- Add clause_tokenize warnings #1026
-- Fix maiyamok() that expanding the wrong word #962
-
-## Version 5.0.3 -> 5.0.4
-
-- Fix: pythainlp.util.maiyamok does not duplicate words
-  when more than one Maiyamok is used #917
-
-## Version 5.0.2 -> 5.0.3
-
-- Fix: empty string ('') added when using word_tokenize with
-  join_broken_num=True #912
-
-## Version 5.0.1 -> 5.0.2
-
-- Fix: crfcut: Ensure splitting of sentences using terminal
-  punctuation #905
-
-## Version 5.0.0 -> 5.0.1
-
-- Fix: delay calling syllable_tokenize to avoid
-  pycrfsuite ImportError #901
+All notable changes to this project are documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
+and this project adheres to
+[Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+- Full release notes: <https://github.com/PyThaiNLP/pythainlp/releases>
+- Commit history: <https://github.com/PyThaiNLP/pythainlp/compare/v5.2.0...HEAD>
+
+## [Unreleased]
+
+This release focuses on stability and performance, featuring optimized memory
+efficiency and standardized error messaging. We’ve expanded our test suite to
+include Python 3.14 and broadened type hint support for a better developer
+experience.
+
+The minimum requirement is now Python 3.9.
+
+### Added
+
+- Tapsai et al. 2020 soundex (#1175)
+- Thai-NNER integration with top-level entity filtering (#1221)
+- BLEU, ROUGE, WER, and CER metrics to `pythainlp.benchmarks` (#1295)
+- Attaparse engine to dependency parser
+  (`dependency_parsing`, engine="attaparse") (#1303)
+- `pythainlp.is_offline_mode()` helper function (#1306)
+- Thai consonant cluster detection (`check_khuap_klam`) (#1308)
+
+### Changed
+
+- Lazy load dictionaries to reduce memory usage (#1186)
+- Migrate configurations to `pyproject.toml` (#1188, #1226, #1239)
+- Update type hints; use Python 3.9 features (#1189, #1190)
+- Make package zip-safe (#1212)
+- Ensure thread-safety for tokenizers (#1213)
+- Reorganize "noauto" test suite by dependency groups
+  (torch, tensorflow, onnx, cython, network) (#1290)
+- `get_corpus_path()` now respects `PYTHAINLP_OFFLINE` env var
+  (follows `HF_HUB_OFFLINE` convention from Hugging Face):
+  raises `FileNotFoundError` if the corpus is not cached locally
+  when the var is set; auto-downloads otherwise (#1306)
+- Callers raise `FileNotFoundError` with download instructions when
+  a corpus path cannot be resolved (#1306)
+
+### Deprecated
+
+- `PYTHAINLP_DATA_DIR` env var; use `PYTHAINLP_DATA` instead
+  (follows `NLTK_DATA` convention from NLTK) (#1306)
+
+### Removed
+
+- Duplicated entries in Volubilis dictionary (#1200)
+- Star imports (#1207)
+- `requests` dependency (#1211)
+
+### Fixed
+
+- Consonant cluster boundary issue in `royin` romanization (#1172)
+- Final consonant classification in `check_marttra()` (#1173)
+- Kho Khon alphabet issue in `tltk` transliteration (#1187)
+
+## [5.2.0] - 2025-12-20
+
+### Added
+
+- `pythainlp.translate.word_translate` (#1102)
+- Words spelling correction using Char2Vec (#1075)
+- Thailand ancient currency converter (#1113)
+- B-K/umt5-thai-g2p-v2-0.5k model (#1140)
+- budoux integration (#1161)
+- Docker Compose file for convenience (#1132)
+
+### Changed
+
+- Update Dockerfile (#1049)
+
+### Removed
+
+- ConceptNet integration (#1103)
+
+### Fixed
+
+- Connectivity of CLI commands (#1154)
+- Docker build failure (#1132)
+
+## [5.1.2] - 2025-05-09
+
+### Changed
+
+- Romanize docs; keep space (#1110)
+
+## [5.1.1] - 2025-03-31
+
+### Changed
+
+- Refactor `thai_consonants_all` to use set in `syllable.py` (#1087)
+- `ThaiTransliterator`: select 1D CPU int64 tensor device (#1089)
+
+## [5.1.0] - 2025-02-25
+
+### Added
+
+- Thai Discourse Treebank POS tag (#910)
+- Thai Universal Dependency Treebank POS tag (#916)
+- Thai G2P v2 grapheme-to-phoneme model (#923)
+- Support for list of strings as input to `sent_tokenize()` (#927)
+- `pythainlp.tools.safe_print` to handle `UnicodeEncodeError`
+  on console (#969)
+- Thai Solar Date to Thai Lunar Date conversion (#998)
+- Thai pangram text (#1045)
+
+### Removed
+
+- `clause_tokenize` (#1024)
+
+### Fixed
+
+- `collate()` to consider tone mark in ordering (#926)
+- `nlpo3.load_dict()` not printing error when unsuccessful (#979)
+
+## [5.0.5] - 2024-12-14
+
+### Changed
+
+- Add `clause_tokenize` deprecation warnings (#1026)
+
+### Fixed
+
+- `maiyamok()` expanding the wrong word (#962)
+
+## [5.0.4] - 2024-06-02
+
+### Fixed
+
+- `pythainlp.util.maiyamok` not duplicating words when more
+  than one Maiyamok is used (#917)
+
+## [5.0.3] - 2024-05-12
+
+### Fixed
+
+- Empty string added when using `word_tokenize` with
+  `join_broken_num=True` (#912)
+
+## [5.0.2] - 2024-04-03
+
+### Fixed
+
+- `crfcut`: ensure splitting of sentences using terminal
+  punctuation (#905)
+
+## [5.0.1] - 2024-02-10
+
+### Fixed
+
+- Delay calling `syllable_tokenize` to avoid
+  `pycrfsuite` import error (#901)
+
+## [5.0.0] - 2024-02-10
+
+- See <https://github.com/PyThaiNLP/pythainlp/releases/tag/v5.0.0>
+
+[Unreleased]: https://github.com/PyThaiNLP/pythainlp/compare/v5.2.0...HEAD
+[5.2.0]: https://github.com/PyThaiNLP/pythainlp/compare/v5.1.2...v5.2.0
+[5.1.2]: https://github.com/PyThaiNLP/pythainlp/compare/v5.1.1...v5.1.2
+[5.1.1]: https://github.com/PyThaiNLP/pythainlp/compare/v5.1.0...v5.1.1
+[5.1.0]: https://github.com/PyThaiNLP/pythainlp/compare/v5.0.5...v5.1.0
+[5.0.5]: https://github.com/PyThaiNLP/pythainlp/compare/v5.0.4...v5.0.5
+[5.0.4]: https://github.com/PyThaiNLP/pythainlp/compare/v5.0.3...v5.0.4
+[5.0.3]: https://github.com/PyThaiNLP/pythainlp/compare/v5.0.2...v5.0.3
+[5.0.2]: https://github.com/PyThaiNLP/pythainlp/compare/v5.0.1...v5.0.2
+[5.0.1]: https://github.com/PyThaiNLP/pythainlp/compare/v5.0.0...v5.0.1
+[5.0.0]: https://github.com/PyThaiNLP/pythainlp/releases/tag/v5.0.0

pythainlp/braille/core.py

@@ -138,7 +138,7 @@
 _v1: list[str] = ["เ-tอ", "เ-ีtย", "เ-ืtอ", "-ัtว", "เ-tา", "เ-tาะ"]
 
 # Create trie for efficient pattern matching
-char_trie = Trie(list(thai_braille_mapping_dict.keys()) + _v1 + [" ", "<N>"])
+char_trie: Trie = Trie(list(thai_braille_mapping_dict.keys()) + _v1 + [" ", "<N>"])
 
 # Build vowel replacement patterns
 _vowel_patterns: list[str] = [

pythainlp/generate/thai2fit.py

@@ -68,10 +68,10 @@
         "    CLI:    thainlp data get wiki_itos_lstm"
     )
 
-# Security Note: This loads a pickle file from PyThaiNLP's trusted corpus.
-# The file is downloaded from PyThaiNLP's official repository with MD5 verification.
-# Users should only use corpus files from trusted sources.
-# WARNING: Pickle deserialization can execute arbitrary code if the file is malicious.
+# Loads a pickle file from PyThaiNLP's official repository with MD5 verification.
+# WARNING:
+# Pickle deserialization can execute arbitrary code if the file is malicious.
+# Users should only use files from trusted sources.
 with open(thwiki["itos_fname"], "rb") as f:
     thwiki_itos: list[str] = pickle.load(f)  # noqa: S301
 thwiki_vocab: "Vocab" = fastai.text.transform.Vocab(thwiki_itos)

pythainlp/transliterate/iso_11940.py

@@ -97,13 +97,10 @@
 }
 
 _punctuation_and_digits: dict[str, str] = {
-    # ฯ can has two meanings in ISO 11940.
-    # If it is for abbreviation, it is paiyan noi.
-    # If it is for sentence termination, it is angkhan diao.
-    # Without semantic analysis, they cannot be distinguished from each other.
-    # In this simple implementation, we decided to always treat ฯ as paiyan noi.
-    # We commented out angkhan diao line to remove it from the dictionary
-    # and avoid having duplicate keys.
+    # ฯ can mean abbreviation (paiyan noi) or sentence termination (angkhan diao).
+    # Without semantic analysis, they cannot be distinguished.
+    # Treat ฯ as paiyan noi here; angkhan diao entry is excluded to avoid
+    # duplicate keys.
     "ๆ": "«",
     "ฯ": "ǂ",  # paiyan noi: U+01C2 ǂ Alveolar Click; ICU uses ‡ (double dagger)
     "๏": "§",

pythainlp/util/syllable.py

@@ -37,7 +37,7 @@
 pattern: Pattern[str] = re.compile("เ(.*)า", re.U)  # เ-า is live syllable
 
 _check_1: list[str] = []
-# These spelling consonant ares live syllables.
+# These spelling consonants are live syllables.
 for i in ["กง", "กน", "กม", "เกย", "เกอว"]:
     _check_1.extend(spelling_class[i])