METADATA 41 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827
  1. Metadata-Version: 2.4
  2. Name: charset-normalizer
  3. Version: 3.4.9
  4. Summary: The Real First Universal Charset Detector. Open, modern and actively maintained alternative to Chardet.
  5. Author-email: "Ahmed R. TAHRI" <tahri.ahmed@proton.me>
  6. Maintainer-email: "Ahmed R. TAHRI" <tahri.ahmed@proton.me>
  7. License: MIT
  8. Project-URL: Changelog, https://github.com/jawah/charset_normalizer/blob/master/CHANGELOG.md
  9. Project-URL: Documentation, https://charset-normalizer.readthedocs.io/
  10. Project-URL: Code, https://github.com/jawah/charset_normalizer
  11. Project-URL: Issue tracker, https://github.com/jawah/charset_normalizer/issues
  12. Keywords: encoding,charset,charset-detector,detector,normalization,unicode,chardet,detect
  13. Classifier: Development Status :: 5 - Production/Stable
  14. Classifier: Intended Audience :: Developers
  15. Classifier: Operating System :: OS Independent
  16. Classifier: Programming Language :: Python
  17. Classifier: Programming Language :: Python :: 3
  18. Classifier: Programming Language :: Python :: 3.7
  19. Classifier: Programming Language :: Python :: 3.8
  20. Classifier: Programming Language :: Python :: 3.9
  21. Classifier: Programming Language :: Python :: 3.10
  22. Classifier: Programming Language :: Python :: 3.11
  23. Classifier: Programming Language :: Python :: 3.12
  24. Classifier: Programming Language :: Python :: 3.13
  25. Classifier: Programming Language :: Python :: 3.14
  26. Classifier: Programming Language :: Python :: 3 :: Only
  27. Classifier: Programming Language :: Python :: Implementation :: CPython
  28. Classifier: Programming Language :: Python :: Implementation :: PyPy
  29. Classifier: Programming Language :: Python :: Free Threading :: 4 - Resilient
  30. Classifier: Topic :: Text Processing :: Linguistic
  31. Classifier: Topic :: Utilities
  32. Classifier: Typing :: Typed
  33. Requires-Python: >=3.7
  34. Description-Content-Type: text/markdown
  35. License-File: LICENSE
  36. Provides-Extra: unicode-backport
  37. Dynamic: license-file
  38. <h1 align="center">Charset Detection, for Everyone 👋</h1>
  39. <p align="center">
  40. <sup>The Real First Universal Charset Detector</sup><br>
  41. <a href="https://pypi.org/project/charset-normalizer">
  42. <img src="https://img.shields.io/pypi/pyversions/charset_normalizer.svg?orange=blue" />
  43. </a>
  44. <a href="https://pepy.tech/project/charset-normalizer/">
  45. <img alt="Download Count Total" src="https://static.pepy.tech/badge/charset-normalizer/month" />
  46. </a>
  47. <a href="https://bestpractices.coreinfrastructure.org/projects/7297">
  48. <img src="https://bestpractices.coreinfrastructure.org/projects/7297/badge">
  49. </a>
  50. </p>
  51. <p align="center">
  52. <sup><i>Featured Packages</i></sup><br>
  53. <a href="https://github.com/jawah/niquests">
  54. <img alt="Static Badge" src="https://img.shields.io/badge/Niquests-Most_Advanced_HTTP_Client-cyan">
  55. </a>
  56. <a href="https://github.com/jawah/wassima">
  57. <img alt="Static Badge" src="https://img.shields.io/badge/Wassima-Certifi_Replacement-cyan">
  58. </a>
  59. </p>
  60. <p align="center">
  61. <sup><i>In other language (unofficial port - by the community)</i></sup><br>
  62. <a href="https://github.com/nickspring/charset-normalizer-rs">
  63. <img alt="Static Badge" src="https://img.shields.io/badge/Rust-red">
  64. </a>
  65. </p>
  66. > A library that helps you read text from an unknown charset encoding.<br /> Motivated by `chardet`,
  67. > I'm trying to resolve the issue by taking a new approach.
  68. > All IANA character set names for which the Python core library provides codecs are supported.
  69. > You can also register your own set of codecs, and yes, it would work as-is.
  70. This project offers you an alternative to **Universal Charset Encoding Detector**, also known as **Chardet**.
  71. | Feature | [Chardet](https://github.com/chardet/chardet) | Charset Normalizer | [cChardet](https://github.com/PyYoshi/cChardet) |
  72. |--------------------------------------------------|:---------------------------------------------:|:-----------------------------------------------------------------------------------------------:|:-----------------------------------------------:|
  73. | `Fast` | ✅ | ✅ | ✅ |
  74. | `Universal`[^1] | ❌ | ✅ | ❌ |
  75. | `Reliable` **without** distinguishable standards | ✅ | ✅ | ✅ |
  76. | `Reliable` **with** distinguishable standards | ✅ | ✅ | ✅ |
  77. | `License` | _Disputed_[^2]<br>_restrictive_ | MIT | MPL-1.1<br>_restrictive_ |
  78. | `Native Python` | ✅ | ✅ | ❌ |
  79. | `Detect spoken language` | ✅ | ✅ | N/A |
  80. | `UnicodeDecodeError Safety` | ✅ | ✅ | ❌ |
  81. | `Whl Size (min)` | 500 kB | 150 kB | ~200 kB |
  82. | `Supported Encoding` | 99 | [99](https://charset-normalizer.readthedocs.io/en/latest/user/support.html#supported-encodings) | 40 |
  83. | `Can register custom encoding` | ❌ | ✅ | ❌ |
  84. <p align="center">
  85. <img src="https://i.imgflip.com/373iay.gif" alt="Reading Normalized Text" width="226"/><img src="https://media.tenor.com/images/c0180f70732a18b4965448d33adba3d0/tenor.gif" alt="Cat Reading Text" width="200"/>
  86. </p>
  87. [^1]: They are clearly using specific code for a specific encoding even if covering most of used one.
  88. [^2]: Chardet 7.0+ was relicensed from LGPL-2.1 to MIT following an AI-assisted rewrite. This relicensing is disputed on two independent grounds: **(a)** the original author [contests](https://github.com/chardet/chardet/issues/327) that the maintainer had the right to relicense, arguing the rewrite is a derivative work of the LGPL-licensed codebase since it was not a clean room implementation; **(b)** the copyright claim itself is [questionable](https://github.com/chardet/chardet/issues/334) given the code was primarily generated by an LLM, and AI-generated output may not be copyrightable under most jurisdictions. Either issue alone could undermine the MIT license. Beyond licensing, the rewrite raises questions about responsible use of AI in open source: key architectural ideas pioneered by charset-normalizer - notably decode-first validity filtering (our foundational approach since v1) and encoding pairwise similarity with the same algorithm and threshold — surfaced in chardet 7 without acknowledgment. The project also imported test files from charset-normalizer to train and benchmark against it, then claimed superior accuracy on those very files. Charset-normalizer has always been MIT-licensed, encoding-agnostic by design, and built on a verifiable human-authored history.
  89. ## ⚡ Performance
  90. This package offer better performances against Chardet. Here are some numbers.
  91. | Package | Accuracy | Mean per file (ms) | File per sec (est) |
  92. |---------------------------------------------------|:--------:|:------------------:|:------------------:|
  93. | [chardet 7.4](https://github.com/chardet/chardet) | 89 % | 3 ms | 333 file/sec |
  94. | charset-normalizer | **97 %** | 1 ms | 1000 file/sec |
  95. | Package | 99th percentile | 95th percentile | 50th percentile |
  96. |---------------------------------------------------|:---------------:|:---------------:|:---------------:|
  97. | [chardet 7.4](https://github.com/chardet/chardet) | 28 ms | 16 ms | < 1 ms |
  98. | charset-normalizer | 8 ms | 5 ms | 1 ms |
  99. _updated as of July 2026 using CPython 3.12, Charset-Normalizer 3.4.8, and Chardet 7.4.3_
  100. ~Chardet's performance on larger file (1MB+) are very poor. Expect huge difference on large payload.~ No longer the case since Chardet 7.0+
  101. > Stats are generated using 400+ files using default parameters. More details on used files, see GHA workflows.
  102. > And yes, these results might change at any time. The dataset can be updated to include more files.
  103. > The actual delays heavily depends on your CPU capabilities. The factors should remain the same.
  104. > Chardet claims on his documentation to have a greater accuracy than us based on the dataset they trained Chardet on(...)
  105. > Well, it's normal, the opposite would have been worrying. Whereas charset-normalizer don't train on anything, our solution
  106. > is based on a completely different algorithm, still heuristic through, it does not need weights across every encoding tables.
  107. ## ✨ Installation
  108. Using pip:
  109. ```sh
  110. pip install charset-normalizer -U
  111. ```
  112. ## 🚀 Basic Usage
  113. ### CLI
  114. This package comes with a CLI.
  115. ```
  116. usage: normalizer [-h] [-v] [-a] [-n] [-m] [-r] [-f] [-t THRESHOLD]
  117. file [file ...]
  118. The Real First Universal Charset Detector. Discover originating encoding used
  119. on text file. Normalize text to unicode.
  120. positional arguments:
  121. files File(s) to be analysed
  122. optional arguments:
  123. -h, --help show this help message and exit
  124. -v, --verbose Display complementary information about file if any.
  125. Stdout will contain logs about the detection process.
  126. -a, --with-alternative
  127. Output complementary possibilities if any. Top-level
  128. JSON WILL be a list.
  129. -n, --normalize Permit to normalize input file. If not set, program
  130. does not write anything.
  131. -m, --minimal Only output the charset detected to STDOUT. Disabling
  132. JSON output.
  133. -r, --replace Replace file when trying to normalize it instead of
  134. creating a new one.
  135. -f, --force Replace file without asking if you are sure, use this
  136. flag with caution.
  137. -t THRESHOLD, --threshold THRESHOLD
  138. Define a custom maximum amount of chaos allowed in
  139. decoded content. 0. <= chaos <= 1.
  140. --version Show version information and exit.
  141. ```
  142. ```bash
  143. normalizer ./data/sample.1.fr.srt
  144. ```
  145. or
  146. ```bash
  147. python -m charset_normalizer ./data/sample.1.fr.srt
  148. ```
  149. 🎉 Since version 1.4.0 the CLI produce easily usable stdout result in JSON format.
  150. ```json
  151. {
  152. "path": "/home/default/projects/charset_normalizer/data/sample.1.fr.srt",
  153. "encoding": "cp1252",
  154. "encoding_aliases": [
  155. "1252",
  156. "windows_1252"
  157. ],
  158. "alternative_encodings": [
  159. "cp1254",
  160. "cp1256",
  161. "cp1258",
  162. "iso8859_14",
  163. "iso8859_15",
  164. "iso8859_16",
  165. "iso8859_3",
  166. "iso8859_9",
  167. "latin_1",
  168. "mbcs"
  169. ],
  170. "language": "French",
  171. "alphabets": [
  172. "Basic Latin",
  173. "Latin-1 Supplement"
  174. ],
  175. "has_sig_or_bom": false,
  176. "chaos": 0.149,
  177. "coherence": 97.152,
  178. "unicode_path": null,
  179. "is_preferred": true
  180. }
  181. ```
  182. ### Python
  183. *Just print out normalized text*
  184. ```python
  185. from charset_normalizer import from_path
  186. results = from_path('./my_subtitle.srt')
  187. print(str(results.best()))
  188. ```
  189. *Upgrade your code without effort*
  190. ```python
  191. from charset_normalizer import detect
  192. ```
  193. The above code will behave the same as **chardet**. We ensure that we offer the best (reasonable) BC result possible.
  194. See the docs for advanced usage : [readthedocs.io](https://charset-normalizer.readthedocs.io/en/latest/)
  195. ## 😇 Why
  196. When I started using Chardet, I noticed that it was not suited to my expectations, and I wanted to propose a
  197. reliable alternative using a completely different method. Also! I never back down on a good challenge!
  198. I **don't care** about the **originating charset** encoding, because **two different tables** can
  199. produce **two identical rendered string.**
  200. What I want is to get readable text, the best I can.
  201. In a way, **I'm brute forcing text decoding.** How cool is that ? 😎
  202. Don't confuse package **ftfy** with charset-normalizer or chardet. ftfy goal is to repair Unicode string whereas charset-normalizer to convert raw file in unknown encoding to unicode.
  203. ## 🍰 How
  204. - Discard all charset encoding table that could not fit the binary content.
  205. - Measure noise, or the mess once opened (by chunks) with a corresponding charset encoding.
  206. - Extract matches with the lowest mess detected.
  207. - Additionally, we measure coherence / probe for a language.
  208. **Wait a minute**, what is noise/mess and coherence according to **YOU ?**
  209. *Noise :* I opened hundred of text files, **written by humans**, with the wrong encoding table. **I observed**, then
  210. **I established** some ground rules about **what is obvious** when **it seems like** a mess (aka. defining noise in rendered text).
  211. I know that my interpretation of what is noise is probably incomplete, feel free to contribute in order to
  212. improve or rewrite it.
  213. *Coherence :* For each language there is on earth, we have computed ranked letter appearance occurrences (the best we can). So I thought
  214. that intel is worth something here. So I use those records against decoded text to check if I can detect intelligent design.
  215. ## ⚡ Known limitations
  216. - Language detection is unreliable when text contains two or more languages sharing identical letters. (eg. HTML (english tags) + Turkish content (Sharing Latin characters))
  217. - Every charset detector heavily depends on sufficient content. In common cases, do not bother run detection on very tiny content.
  218. ## ⚠️ About Python EOLs
  219. **If you are running:**
  220. - Python >=2.7,<3.5: Unsupported
  221. - Python 3.5: charset-normalizer < 2.1
  222. - Python 3.6: charset-normalizer < 3.1
  223. Upgrade your Python interpreter as soon as possible.
  224. ## 👤 Contributing
  225. Contributions, issues and feature requests are very much welcome.<br />
  226. Feel free to check [issues page](https://github.com/ousret/charset_normalizer/issues) if you want to contribute.
  227. ## 📝 License
  228. Copyright © [Ahmed TAHRI @Ousret](https://github.com/Ousret).<br />
  229. This project is [MIT](https://github.com/Ousret/charset_normalizer/blob/master/LICENSE) licensed.
  230. Characters frequencies used in this project © 2012 [Denny Vrandečić](http://simia.net/letters/)
  231. ## 💼 For Enterprise
  232. Professional support for charset-normalizer is available as part of the [Tidelift
  233. Subscription][1]. Tidelift gives software development teams a single source for
  234. purchasing and maintaining their software, with professional grade assurances
  235. from the experts who know it best, while seamlessly integrating with existing
  236. tools.
  237. [1]: https://tidelift.com/subscription/pkg/pypi-charset-normalizer?utm_source=pypi-charset-normalizer&utm_medium=readme
  238. [![OpenSSF Best Practices](https://www.bestpractices.dev/projects/7297/badge)](https://www.bestpractices.dev/projects/7297)
  239. # Changelog
  240. All notable changes to charset-normalizer will be documented in this file. This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
  241. The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
  242. ## [3.4.9](https://github.com/Ousret/charset_normalizer/compare/3.4.8...3.4.9) (2026-07-07)
  243. ### Fixed
  244. - Regression in our fallback path leading to a decode error. (#771)
  245. We've yanked 3.4.8 as a result of that bug.
  246. ## [3.4.8](https://github.com/Ousret/charset_normalizer/compare/3.4.7...3.4.8) (2026-07-06)
  247. ### Fixed
  248. - Wall import time due to cascade codec imports for our multibyte first sort of iana supported codecs (#742)
  249. - Unnecessary json import at runtime (#753)
  250. - Inverse capitalization not seen by noise detector (#731)
  251. ### Changed
  252. - No longer holding a global cache for our noise / coherence measurements. Relax RSS memory usage.
  253. - Micro-optimizations in our noise / coherence measurements.
  254. - No longer using regex search by default for our preemptive charset mark algorithm.
  255. - Raised upperbound of setuptools to v83.
  256. - Raised upperbound of mypy(c) to v2.1.
  257. ### Removed
  258. - Redundant UTF7 BOM marker (#730)
  259. ## [3.4.7](https://github.com/Ousret/charset_normalizer/compare/3.4.6...3.4.7) (2026-04-02)
  260. ### Changed
  261. - Pre-built optimized version using mypy[c] v1.20.
  262. - Relax `setuptools` constraint to `setuptools>=68,<82.1`.
  263. ### Fixed
  264. - Correctly remove SIG remnant in utf-7 decoded string. (#718) (#716)
  265. ## [3.4.6](https://github.com/Ousret/charset_normalizer/compare/3.4.5...3.4.6) (2026-03-15)
  266. ### Changed
  267. - Flattened the logic in `charset_normalizer.md` for higher performance. Removed `eligible(..)` and `feed(...)`
  268. in favor of `feed_info(...)`.
  269. - Raised upper bound for mypy[c] to 1.20, for our optimized version.
  270. - Updated `UNICODE_RANGES_COMBINED` using Unicode blocks v17.
  271. ### Fixed
  272. - Edge case where noise difference between two candidates can be almost insignificant. (#672)
  273. - CLI `--normalize` writing to wrong path when passing multiple files in. (#702)
  274. ### Misc
  275. - Freethreaded pre-built wheels now shipped in PyPI starting with 3.14t. (#616)
  276. ## [3.4.5](https://github.com/Ousret/charset_normalizer/compare/3.4.4...3.4.5) (2026-03-06)
  277. ### Changed
  278. - Update `setuptools` constraint to `setuptools>=68,<=82`.
  279. - Raised upper bound of mypyc for the optional pre-built extension to v1.19.1
  280. ### Fixed
  281. - Add explicit link to lib math in our optimized build. (#692)
  282. - Logger level not restored correctly for empty byte sequences. (#701)
  283. - TypeError when passing bytearray to from_bytes. (#703)
  284. ### Misc
  285. - Applied safe micro-optimizations in both our noise detector and language detector.
  286. - Rewrote the `query_yes_no` function (inside CLI) to avoid using ambiguous licensed code.
  287. - Added `cd.py` submodule into mypyc optional compilation to reduce further the performance impact.
  288. ## [3.4.4](https://github.com/Ousret/charset_normalizer/compare/3.4.2...3.4.4) (2025-10-13)
  289. ### Changed
  290. - Bound `setuptools` to a specific constraint `setuptools>=68,<=81`.
  291. - Raised upper bound of mypyc for the optional pre-built extension to v1.18.2
  292. ### Removed
  293. - `setuptools-scm` as a build dependency.
  294. ### Misc
  295. - Enforced hashes in `dev-requirements.txt` and created `ci-requirements.txt` for security purposes.
  296. - Additional pre-built wheels for riscv64, s390x, and armv7l architectures.
  297. - Restore ` multiple.intoto.jsonl` in GitHub releases in addition to individual attestation file per wheel.
  298. ## [3.4.3](https://github.com/Ousret/charset_normalizer/compare/3.4.2...3.4.3) (2025-08-09)
  299. ### Changed
  300. - mypy(c) is no longer a required dependency at build time if `CHARSET_NORMALIZER_USE_MYPYC` isn't set to `1`. (#595) (#583)
  301. - automatically lower confidence on small bytes samples that are not Unicode in `detect` output legacy function. (#391)
  302. ### Added
  303. - Custom build backend to overcome inability to mark mypy as an optional dependency in the build phase.
  304. - Support for Python 3.14
  305. ### Fixed
  306. - sdist archive contained useless directories.
  307. - automatically fallback on valid UTF-16 or UTF-32 even if the md says it's noisy. (#633)
  308. ### Misc
  309. - SBOM are automatically published to the relevant GitHub release to comply with regulatory changes.
  310. Each published wheel comes with its SBOM. We choose CycloneDX as the format.
  311. - Prebuilt optimized wheel are no longer distributed by default for CPython 3.7 due to a change in cibuildwheel.
  312. ## [3.4.2](https://github.com/Ousret/charset_normalizer/compare/3.4.1...3.4.2) (2025-05-02)
  313. ### Fixed
  314. - Addressed the DeprecationWarning in our CLI regarding `argparse.FileType` by backporting the target class into the package. (#591)
  315. - Improved the overall reliability of the detector with CJK Ideographs. (#605) (#587)
  316. ### Changed
  317. - Optional mypyc compilation upgraded to version 1.15 for Python >= 3.8
  318. ## [3.4.1](https://github.com/Ousret/charset_normalizer/compare/3.4.0...3.4.1) (2024-12-24)
  319. ### Changed
  320. - Project metadata are now stored using `pyproject.toml` instead of `setup.cfg` using setuptools as the build backend.
  321. - Enforce annotation delayed loading for a simpler and consistent types in the project.
  322. - Optional mypyc compilation upgraded to version 1.14 for Python >= 3.8
  323. ### Added
  324. - pre-commit configuration.
  325. - noxfile.
  326. ### Removed
  327. - `build-requirements.txt` as per using `pyproject.toml` native build configuration.
  328. - `bin/integration.py` and `bin/serve.py` in favor of downstream integration test (see noxfile).
  329. - `setup.cfg` in favor of `pyproject.toml` metadata configuration.
  330. - Unused `utils.range_scan` function.
  331. ### Fixed
  332. - Converting content to Unicode bytes may insert `utf_8` instead of preferred `utf-8`. (#572)
  333. - Deprecation warning "'count' is passed as positional argument" when converting to Unicode bytes on Python 3.13+
  334. ## [3.4.0](https://github.com/Ousret/charset_normalizer/compare/3.3.2...3.4.0) (2024-10-08)
  335. ### Added
  336. - Argument `--no-preemptive` in the CLI to prevent the detector to search for hints.
  337. - Support for Python 3.13 (#512)
  338. ### Fixed
  339. - Relax the TypeError exception thrown when trying to compare a CharsetMatch with anything else than a CharsetMatch.
  340. - Improved the general reliability of the detector based on user feedbacks. (#520) (#509) (#498) (#407) (#537)
  341. - Declared charset in content (preemptive detection) not changed when converting to utf-8 bytes. (#381)
  342. ## [3.3.2](https://github.com/Ousret/charset_normalizer/compare/3.3.1...3.3.2) (2023-10-31)
  343. ### Fixed
  344. - Unintentional memory usage regression when using large payload that match several encoding (#376)
  345. - Regression on some detection case showcased in the documentation (#371)
  346. ### Added
  347. - Noise (md) probe that identify malformed arabic representation due to the presence of letters in isolated form (credit to my wife)
  348. ## [3.3.1](https://github.com/Ousret/charset_normalizer/compare/3.3.0...3.3.1) (2023-10-22)
  349. ### Changed
  350. - Optional mypyc compilation upgraded to version 1.6.1 for Python >= 3.8
  351. - Improved the general detection reliability based on reports from the community
  352. ## [3.3.0](https://github.com/Ousret/charset_normalizer/compare/3.2.0...3.3.0) (2023-09-30)
  353. ### Added
  354. - Allow to execute the CLI (e.g. normalizer) through `python -m charset_normalizer.cli` or `python -m charset_normalizer`
  355. - Support for 9 forgotten encoding that are supported by Python but unlisted in `encoding.aliases` as they have no alias (#323)
  356. ### Removed
  357. - (internal) Redundant utils.is_ascii function and unused function is_private_use_only
  358. - (internal) charset_normalizer.assets is moved inside charset_normalizer.constant
  359. ### Changed
  360. - (internal) Unicode code blocks in constants are updated using the latest v15.0.0 definition to improve detection
  361. - Optional mypyc compilation upgraded to version 1.5.1 for Python >= 3.8
  362. ### Fixed
  363. - Unable to properly sort CharsetMatch when both chaos/noise and coherence were close due to an unreachable condition in \_\_lt\_\_ (#350)
  364. ## [3.2.0](https://github.com/Ousret/charset_normalizer/compare/3.1.0...3.2.0) (2023-06-07)
  365. ### Changed
  366. - Typehint for function `from_path` no longer enforce `PathLike` as its first argument
  367. - Minor improvement over the global detection reliability
  368. ### Added
  369. - Introduce function `is_binary` that relies on main capabilities, and optimized to detect binaries
  370. - Propagate `enable_fallback` argument throughout `from_bytes`, `from_path`, and `from_fp` that allow a deeper control over the detection (default True)
  371. - Explicit support for Python 3.12
  372. ### Fixed
  373. - Edge case detection failure where a file would contain 'very-long' camel cased word (Issue #289)
  374. ## [3.1.0](https://github.com/Ousret/charset_normalizer/compare/3.0.1...3.1.0) (2023-03-06)
  375. ### Added
  376. - Argument `should_rename_legacy` for legacy function `detect` and disregard any new arguments without errors (PR #262)
  377. ### Removed
  378. - Support for Python 3.6 (PR #260)
  379. ### Changed
  380. - Optional speedup provided by mypy/c 1.0.1
  381. ## [3.0.1](https://github.com/Ousret/charset_normalizer/compare/3.0.0...3.0.1) (2022-11-18)
  382. ### Fixed
  383. - Multi-bytes cutter/chunk generator did not always cut correctly (PR #233)
  384. ### Changed
  385. - Speedup provided by mypy/c 0.990 on Python >= 3.7
  386. ## [3.0.0](https://github.com/Ousret/charset_normalizer/compare/2.1.1...3.0.0) (2022-10-20)
  387. ### Added
  388. - Extend the capability of explain=True when cp_isolation contains at most two entries (min one), will log in details of the Mess-detector results
  389. - Support for alternative language frequency set in charset_normalizer.assets.FREQUENCIES
  390. - Add parameter `language_threshold` in `from_bytes`, `from_path` and `from_fp` to adjust the minimum expected coherence ratio
  391. - `normalizer --version` now specify if current version provide extra speedup (meaning mypyc compilation whl)
  392. ### Changed
  393. - Build with static metadata using 'build' frontend
  394. - Make the language detection stricter
  395. - Optional: Module `md.py` can be compiled using Mypyc to provide an extra speedup up to 4x faster than v2.1
  396. ### Fixed
  397. - CLI with opt --normalize fail when using full path for files
  398. - TooManyAccentuatedPlugin induce false positive on the mess detection when too few alpha character have been fed to it
  399. - Sphinx warnings when generating the documentation
  400. ### Removed
  401. - Coherence detector no longer return 'Simple English' instead return 'English'
  402. - Coherence detector no longer return 'Classical Chinese' instead return 'Chinese'
  403. - Breaking: Method `first()` and `best()` from CharsetMatch
  404. - UTF-7 will no longer appear as "detected" without a recognized SIG/mark (is unreliable/conflict with ASCII)
  405. - Breaking: Class aliases CharsetDetector, CharsetDoctor, CharsetNormalizerMatch and CharsetNormalizerMatches
  406. - Breaking: Top-level function `normalize`
  407. - Breaking: Properties `chaos_secondary_pass`, `coherence_non_latin` and `w_counter` from CharsetMatch
  408. - Support for the backport `unicodedata2`
  409. ## [3.0.0rc1](https://github.com/Ousret/charset_normalizer/compare/3.0.0b2...3.0.0rc1) (2022-10-18)
  410. ### Added
  411. - Extend the capability of explain=True when cp_isolation contains at most two entries (min one), will log in details of the Mess-detector results
  412. - Support for alternative language frequency set in charset_normalizer.assets.FREQUENCIES
  413. - Add parameter `language_threshold` in `from_bytes`, `from_path` and `from_fp` to adjust the minimum expected coherence ratio
  414. ### Changed
  415. - Build with static metadata using 'build' frontend
  416. - Make the language detection stricter
  417. ### Fixed
  418. - CLI with opt --normalize fail when using full path for files
  419. - TooManyAccentuatedPlugin induce false positive on the mess detection when too few alpha character have been fed to it
  420. ### Removed
  421. - Coherence detector no longer return 'Simple English' instead return 'English'
  422. - Coherence detector no longer return 'Classical Chinese' instead return 'Chinese'
  423. ## [3.0.0b2](https://github.com/Ousret/charset_normalizer/compare/3.0.0b1...3.0.0b2) (2022-08-21)
  424. ### Added
  425. - `normalizer --version` now specify if current version provide extra speedup (meaning mypyc compilation whl)
  426. ### Removed
  427. - Breaking: Method `first()` and `best()` from CharsetMatch
  428. - UTF-7 will no longer appear as "detected" without a recognized SIG/mark (is unreliable/conflict with ASCII)
  429. ### Fixed
  430. - Sphinx warnings when generating the documentation
  431. ## [3.0.0b1](https://github.com/Ousret/charset_normalizer/compare/2.1.0...3.0.0b1) (2022-08-15)
  432. ### Changed
  433. - Optional: Module `md.py` can be compiled using Mypyc to provide an extra speedup up to 4x faster than v2.1
  434. ### Removed
  435. - Breaking: Class aliases CharsetDetector, CharsetDoctor, CharsetNormalizerMatch and CharsetNormalizerMatches
  436. - Breaking: Top-level function `normalize`
  437. - Breaking: Properties `chaos_secondary_pass`, `coherence_non_latin` and `w_counter` from CharsetMatch
  438. - Support for the backport `unicodedata2`
  439. ## [2.1.1](https://github.com/Ousret/charset_normalizer/compare/2.1.0...2.1.1) (2022-08-19)
  440. ### Deprecated
  441. - Function `normalize` scheduled for removal in 3.0
  442. ### Changed
  443. - Removed useless call to decode in fn is_unprintable (#206)
  444. ### Fixed
  445. - Third-party library (i18n xgettext) crashing not recognizing utf_8 (PEP 263) with underscore from [@aleksandernovikov](https://github.com/aleksandernovikov) (#204)
  446. ## [2.1.0](https://github.com/Ousret/charset_normalizer/compare/2.0.12...2.1.0) (2022-06-19)
  447. ### Added
  448. - Output the Unicode table version when running the CLI with `--version` (PR #194)
  449. ### Changed
  450. - Reuse decoded buffer for single byte character sets from [@nijel](https://github.com/nijel) (PR #175)
  451. - Fixing some performance bottlenecks from [@deedy5](https://github.com/deedy5) (PR #183)
  452. ### Fixed
  453. - Workaround potential bug in cpython with Zero Width No-Break Space located in Arabic Presentation Forms-B, Unicode 1.1 not acknowledged as space (PR #175)
  454. - CLI default threshold aligned with the API threshold from [@oleksandr-kuzmenko](https://github.com/oleksandr-kuzmenko) (PR #181)
  455. ### Removed
  456. - Support for Python 3.5 (PR #192)
  457. ### Deprecated
  458. - Use of backport unicodedata from `unicodedata2` as Python is quickly catching up, scheduled for removal in 3.0 (PR #194)
  459. ## [2.0.12](https://github.com/Ousret/charset_normalizer/compare/2.0.11...2.0.12) (2022-02-12)
  460. ### Fixed
  461. - ASCII miss-detection on rare cases (PR #170)
  462. ## [2.0.11](https://github.com/Ousret/charset_normalizer/compare/2.0.10...2.0.11) (2022-01-30)
  463. ### Added
  464. - Explicit support for Python 3.11 (PR #164)
  465. ### Changed
  466. - The logging behavior have been completely reviewed, now using only TRACE and DEBUG levels (PR #163 #165)
  467. ## [2.0.10](https://github.com/Ousret/charset_normalizer/compare/2.0.9...2.0.10) (2022-01-04)
  468. ### Fixed
  469. - Fallback match entries might lead to UnicodeDecodeError for large bytes sequence (PR #154)
  470. ### Changed
  471. - Skipping the language-detection (CD) on ASCII (PR #155)
  472. ## [2.0.9](https://github.com/Ousret/charset_normalizer/compare/2.0.8...2.0.9) (2021-12-03)
  473. ### Changed
  474. - Moderating the logging impact (since 2.0.8) for specific environments (PR #147)
  475. ### Fixed
  476. - Wrong logging level applied when setting kwarg `explain` to True (PR #146)
  477. ## [2.0.8](https://github.com/Ousret/charset_normalizer/compare/2.0.7...2.0.8) (2021-11-24)
  478. ### Changed
  479. - Improvement over Vietnamese detection (PR #126)
  480. - MD improvement on trailing data and long foreign (non-pure latin) data (PR #124)
  481. - Efficiency improvements in cd/alphabet_languages from [@adbar](https://github.com/adbar) (PR #122)
  482. - call sum() without an intermediary list following PEP 289 recommendations from [@adbar](https://github.com/adbar) (PR #129)
  483. - Code style as refactored by Sourcery-AI (PR #131)
  484. - Minor adjustment on the MD around european words (PR #133)
  485. - Remove and replace SRTs from assets / tests (PR #139)
  486. - Initialize the library logger with a `NullHandler` by default from [@nmaynes](https://github.com/nmaynes) (PR #135)
  487. - Setting kwarg `explain` to True will add provisionally (bounded to function lifespan) a specific stream handler (PR #135)
  488. ### Fixed
  489. - Fix large (misleading) sequence giving UnicodeDecodeError (PR #137)
  490. - Avoid using too insignificant chunk (PR #137)
  491. ### Added
  492. - Add and expose function `set_logging_handler` to configure a specific StreamHandler from [@nmaynes](https://github.com/nmaynes) (PR #135)
  493. - Add `CHANGELOG.md` entries, format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/) (PR #141)
  494. ## [2.0.7](https://github.com/Ousret/charset_normalizer/compare/2.0.6...2.0.7) (2021-10-11)
  495. ### Added
  496. - Add support for Kazakh (Cyrillic) language detection (PR #109)
  497. ### Changed
  498. - Further, improve inferring the language from a given single-byte code page (PR #112)
  499. - Vainly trying to leverage PEP263 when PEP3120 is not supported (PR #116)
  500. - Refactoring for potential performance improvements in loops from [@adbar](https://github.com/adbar) (PR #113)
  501. - Various detection improvement (MD+CD) (PR #117)
  502. ### Removed
  503. - Remove redundant logging entry about detected language(s) (PR #115)
  504. ### Fixed
  505. - Fix a minor inconsistency between Python 3.5 and other versions regarding language detection (PR #117 #102)
  506. ## [2.0.6](https://github.com/Ousret/charset_normalizer/compare/2.0.5...2.0.6) (2021-09-18)
  507. ### Fixed
  508. - Unforeseen regression with the loss of the backward-compatibility with some older minor of Python 3.5.x (PR #100)
  509. - Fix CLI crash when using --minimal output in certain cases (PR #103)
  510. ### Changed
  511. - Minor improvement to the detection efficiency (less than 1%) (PR #106 #101)
  512. ## [2.0.5](https://github.com/Ousret/charset_normalizer/compare/2.0.4...2.0.5) (2021-09-14)
  513. ### Changed
  514. - The project now comply with: flake8, mypy, isort and black to ensure a better overall quality (PR #81)
  515. - The BC-support with v1.x was improved, the old staticmethods are restored (PR #82)
  516. - The Unicode detection is slightly improved (PR #93)
  517. - Add syntax sugar \_\_bool\_\_ for results CharsetMatches list-container (PR #91)
  518. ### Removed
  519. - The project no longer raise warning on tiny content given for detection, will be simply logged as warning instead (PR #92)
  520. ### Fixed
  521. - In some rare case, the chunks extractor could cut in the middle of a multi-byte character and could mislead the mess detection (PR #95)
  522. - Some rare 'space' characters could trip up the UnprintablePlugin/Mess detection (PR #96)
  523. - The MANIFEST.in was not exhaustive (PR #78)
  524. ## [2.0.4](https://github.com/Ousret/charset_normalizer/compare/2.0.3...2.0.4) (2021-07-30)
  525. ### Fixed
  526. - The CLI no longer raise an unexpected exception when no encoding has been found (PR #70)
  527. - Fix accessing the 'alphabets' property when the payload contains surrogate characters (PR #68)
  528. - The logger could mislead (explain=True) on detected languages and the impact of one MBCS match (PR #72)
  529. - Submatch factoring could be wrong in rare edge cases (PR #72)
  530. - Multiple files given to the CLI were ignored when publishing results to STDOUT. (After the first path) (PR #72)
  531. - Fix line endings from CRLF to LF for certain project files (PR #67)
  532. ### Changed
  533. - Adjust the MD to lower the sensitivity, thus improving the global detection reliability (PR #69 #76)
  534. - Allow fallback on specified encoding if any (PR #71)
  535. ## [2.0.3](https://github.com/Ousret/charset_normalizer/compare/2.0.2...2.0.3) (2021-07-16)
  536. ### Changed
  537. - Part of the detection mechanism has been improved to be less sensitive, resulting in more accurate detection results. Especially ASCII. (PR #63)
  538. - According to the community wishes, the detection will fall back on ASCII or UTF-8 in a last-resort case. (PR #64)
  539. ## [2.0.2](https://github.com/Ousret/charset_normalizer/compare/2.0.1...2.0.2) (2021-07-15)
  540. ### Fixed
  541. - Empty/Too small JSON payload miss-detection fixed. Report from [@tseaver](https://github.com/tseaver) (PR #59)
  542. ### Changed
  543. - Don't inject unicodedata2 into sys.modules from [@akx](https://github.com/akx) (PR #57)
  544. ## [2.0.1](https://github.com/Ousret/charset_normalizer/compare/2.0.0...2.0.1) (2021-07-13)
  545. ### Fixed
  546. - Make it work where there isn't a filesystem available, dropping assets frequencies.json. Report from [@sethmlarson](https://github.com/sethmlarson). (PR #55)
  547. - Using explain=False permanently disable the verbose output in the current runtime (PR #47)
  548. - One log entry (language target preemptive) was not show in logs when using explain=True (PR #47)
  549. - Fix undesired exception (ValueError) on getitem of instance CharsetMatches (PR #52)
  550. ### Changed
  551. - Public function normalize default args values were not aligned with from_bytes (PR #53)
  552. ### Added
  553. - You may now use charset aliases in cp_isolation and cp_exclusion arguments (PR #47)
  554. ## [2.0.0](https://github.com/Ousret/charset_normalizer/compare/1.4.1...2.0.0) (2021-07-02)
  555. ### Changed
  556. - 4x to 5 times faster than the previous 1.4.0 release. At least 2x faster than Chardet.
  557. - Accent has been made on UTF-8 detection, should perform rather instantaneous.
  558. - The backward compatibility with Chardet has been greatly improved. The legacy detect function returns an identical charset name whenever possible.
  559. - The detection mechanism has been slightly improved, now Turkish content is detected correctly (most of the time)
  560. - The program has been rewritten to ease the readability and maintainability. (+Using static typing)+
  561. - utf_7 detection has been reinstated.
  562. ### Removed
  563. - This package no longer require anything when used with Python 3.5 (Dropped cached_property)
  564. - Removed support for these languages: Catalan, Esperanto, Kazakh, Baque, Volapük, Azeri, Galician, Nynorsk, Macedonian, and Serbocroatian.
  565. - The exception hook on UnicodeDecodeError has been removed.
  566. ### Deprecated
  567. - Methods coherence_non_latin, w_counter, chaos_secondary_pass of the class CharsetMatch are now deprecated and scheduled for removal in v3.0
  568. ### Fixed
  569. - The CLI output used the relative path of the file(s). Should be absolute.
  570. ## [1.4.1](https://github.com/Ousret/charset_normalizer/compare/1.4.0...1.4.1) (2021-05-28)
  571. ### Fixed
  572. - Logger configuration/usage no longer conflict with others (PR #44)
  573. ## [1.4.0](https://github.com/Ousret/charset_normalizer/compare/1.3.9...1.4.0) (2021-05-21)
  574. ### Removed
  575. - Using standard logging instead of using the package loguru.
  576. - Dropping nose test framework in favor of the maintained pytest.
  577. - Choose to not use dragonmapper package to help with gibberish Chinese/CJK text.
  578. - Require cached_property only for Python 3.5 due to constraint. Dropping for every other interpreter version.
  579. - Stop support for UTF-7 that does not contain a SIG.
  580. - Dropping PrettyTable, replaced with pure JSON output in CLI.
  581. ### Fixed
  582. - BOM marker in a CharsetNormalizerMatch instance could be False in rare cases even if obviously present. Due to the sub-match factoring process.
  583. - Not searching properly for the BOM when trying utf32/16 parent codec.
  584. ### Changed
  585. - Improving the package final size by compressing frequencies.json.
  586. - Huge improvement over the larges payload.
  587. ### Added
  588. - CLI now produces JSON consumable output.
  589. - Return ASCII if given sequences fit. Given reasonable confidence.
  590. ## [1.3.9](https://github.com/Ousret/charset_normalizer/compare/1.3.8...1.3.9) (2021-05-13)
  591. ### Fixed
  592. - In some very rare cases, you may end up getting encode/decode errors due to a bad bytes payload (PR #40)
  593. ## [1.3.8](https://github.com/Ousret/charset_normalizer/compare/1.3.7...1.3.8) (2021-05-12)
  594. ### Fixed
  595. - Empty given payload for detection may cause an exception if trying to access the `alphabets` property. (PR #39)
  596. ## [1.3.7](https://github.com/Ousret/charset_normalizer/compare/1.3.6...1.3.7) (2021-05-12)
  597. ### Fixed
  598. - The legacy detect function should return UTF-8-SIG if sig is present in the payload. (PR #38)
  599. ## [1.3.6](https://github.com/Ousret/charset_normalizer/compare/1.3.5...1.3.6) (2021-02-09)
  600. ### Changed
  601. - Amend the previous release to allow prettytable 2.0 (PR #35)
  602. ## [1.3.5](https://github.com/Ousret/charset_normalizer/compare/1.3.4...1.3.5) (2021-02-08)
  603. ### Fixed
  604. - Fix error while using the package with a python pre-release interpreter (PR #33)
  605. ### Changed
  606. - Dependencies refactoring, constraints revised.
  607. ### Added
  608. - Add python 3.9 and 3.10 to the supported interpreters
  609. MIT License
  610. Copyright (c) 2025 TAHRI Ahmed R.
  611. Permission is hereby granted, free of charge, to any person obtaining a copy
  612. of this software and associated documentation files (the "Software"), to deal
  613. in the Software without restriction, including without limitation the rights
  614. to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  615. copies of the Software, and to permit persons to whom the Software is
  616. furnished to do so, subject to the following conditions:
  617. The above copyright notice and this permission notice shall be included in all
  618. copies or substantial portions of the Software.
  619. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  620. IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  621. FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  622. AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  623. LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  624. OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  625. SOFTWARE.