PyPcre 0.1.0__tar.gz

pypcre-0.1.0/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   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.

pypcre-0.1.0/PKG-INFO

@@ -0,0 +1,237 @@
+Metadata-Version: 2.4
+Name: PyPcre
+Version: 0.1.0
+Summary: Modern, GIL-friendly, Fast Python bindings for PCRE2 with auto caching and JIT of compiled patterns.
+Author-email: ModelCloud <qubitium@modelcloud.ai>
+License-Expression: Apache-2.0
+Project-URL: Homepage, https://github.com/ModelCloud/pcre
+Keywords: regex,pcre2,bindings
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Programming Language :: Python :: Free Threading
+Classifier: Programming Language :: Python :: Free Threading :: 3 - Stable
+Classifier: Programming Language :: C
+Classifier: Topic :: Software Development :: Libraries
+Classifier: Topic :: Text Processing :: Linguistic
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Dynamic: license-file
+
+<!--
+# SPDX-FileCopyrightText: 2025 ModelCloud.ai
+# SPDX-FileCopyrightText: 2025 qubitium@modelcloud.ai
+# SPDX-License-Identifier: Apache-2.0
+# Contact: qubitium@modelcloud.ai, x.com/qubitium
+-->
+
+# PyPcre (Python Pcre2 Binding)
+
+Python bindings for the system PCRE2 library with a familiar `re`-style API.
+
+## Installation
+
+```bash
+pip install PyPcre
+```
+
+The package links against the `libpcre2-8` variant already available on your
+system. See [Building](#building) for manual build details.
+
+## Usage
+
+### Drop-in helpers
+
+```python
+from pcre import match, search, findall, compile, Flag
+
+if match(r"(?P<word>\\w+)", "hello world"):
+    print("found word")
+
+pattern = compile(rb"\d+", flags=Flag.MULTILINE)
+numbers = pattern.findall(b"line 1\nline 22")
+```
+
+`pcre` mirrors the core helpers from Python’s standard library `re` module—
+`match`, `search`, `fullmatch`, `finditer`, `findall`, and `compile`—while
+exposing PCRE2’s extended flag set through the Pythonic `Flag` enum
+(`Flag.CASELESS`, `Flag.MULTILINE`, `Flag.UTF`, ...).
+
+### Stdlib `re` compatibility
+
+- Module-level helpers and the `Pattern` class follow the same call shapes as
+  the standard library `re` module, including `pos`, `endpos`, and `flags`
+  behaviour.
+- `Pattern` mirrors `re.Pattern` attributes like `.pattern`, `.groupindex`,
+  and `.groups`, while `Match` objects surface the familiar `.re`, `.string`,
+  `.pos`, `.endpos`, `.lastindex`, `.lastgroup`, `.regs`, and `.expand()` API.
+- Substitution helpers enforce the same type rules as the standard library
+  `re` module: string patterns require string replacements, byte patterns
+  require bytes-like replacements, and callable replacements receive the
+  wrapped `Match`.
+- `compile()` accepts native `Flag` values as well as compatible
+  `re.RegexFlag` members from the standard library. Supported stdlib flags
+  map 1:1 to PCRE2 options (`IGNORECASE→CASELESS`, `MULTILINE→MULTILINE`,
+  `DOTALL→DOTALL`, `VERBOSE→EXTENDED`); passing unsupported stdlib flags
+  raises a compatibility `ValueError` to prevent silent divergences.
+- `pcre.escape()` delegates directly to `re.escape` for byte and text
+  patterns so escaping semantics remain identical.
+
+### `regex` package compatibility
+
+The [`regex`](https://pypi.org/project/regex/) package interprets
+`\uXXXX` and `\UXXXXXXXX` escapes as UTF-8 code points, while PCRE2 expects
+hexadecimal escapes to use the `\x{...}` form. Enable `Flag.COMPAT_UNICODE_ESCAPE` to
+translate those escapes automatically when compiling patterns:
+
+```python
+from pcre import compile, Flag
+
+pattern = compile(r"\\U0001F600", flags=Flag.COMPAT_UNICODE_ESCAPE)
+assert pattern.pattern == r"\\x{0001F600}"
+```
+
+Set the default behaviour globally with `pcre.configure(compat_regex=True)`
+so that subsequent calls to `compile()` and the module-level helpers apply
+the conversion without repeating the flag.
+
+### Automatic pattern caching
+
+`pcre.compile()` caches the final `Pattern` wrapper for up to 128
+unique `(pattern, flags)` pairs when the pattern object is hashable. This
+keeps repeated calls to top-level helpers efficient without any extra work
+from the caller. Adjust the capacity with `pcre.set_cache_limit(n)`—pass
+`0` to disable caching completely or `None` for an unlimited cache—and
+check the current limit with `pcre.get_cache_limit()`. The cache can be
+emptied at any time with `pcre.clear_cache()` if your application needs to
+release memory proactively.
+
+Non-hashable patterns (for example, custom objects) bypass the cache and are
+still compiled immediately.
+
+### Text versus bytes defaults
+
+String patterns follow the same defaults as Python’s `re` module,
+automatically enabling the `Flag.UTF` and `Flag.UCP` options so Unicode
+pattern and character semantics “just work.” Byte patterns remain raw by
+default—neither option is activated—so you retain full control over
+binary-oriented matching. Explicitly set `Flag.NO_UTF`/`Flag.NO_UCP` if you
+need to opt out for strings, or add the UTF/UCP flags yourself when compiling
+bytes.
+
+### Working with compiled patterns
+
+- `compile()` accepts either a pattern literal or an existing `Pattern`
+  instance, making it easy to mix compiled objects with the convenience
+  helpers.
+- `Pattern.match/search/fullmatch/finditer/findall` accept optional
+  `pos`, `endpos`, and `options` arguments, mirroring the standard library
+  `re` module while letting you thread PCRE2 execution flags through
+  individual calls.
+
+### Threaded execution
+
+- `pcre.parallel_map()` fans out work across a shared thread pool for
+  `match`, `search`, `fullmatch`, and `findall`. The helper preserves the
+  order of the provided subjects and returns the same result objects you’d
+  normally receive from the `Pattern` methods.
+- Threading is **opt-in by default** when Python runs without the GIL
+  (e.g. CPython with `-X gil=0` or `PYTHON_GIL=0`). When the GIL is active the default falls
+  back to sequential execution to avoid needless overhead.
+- With auto threading enabled (`configure_threads(enabled=True)`), the pool
+  is only engaged when at least one subject is larger than the configured
+  threshold (60 kB by default). Smaller jobs run sequentially to avoid the
+  cost of thread hand-offs; adjust the boundary via
+  `configure_threads(threshold=...)`.
+- Use `Flag.THREADS` to force threaded execution for a specific pattern or
+  `Flag.NO_THREADS` to lock it to sequential mode regardless of global
+  settings.
+- `pcre.configure_thread_pool(max_workers=...)` controls the size of the
+  shared executor (capped to half the available CPUs); call it with
+  `preload=True` to spin the pool up eagerly, and `shutdown_thread_pool()`
+  to tear it down manually if needed.
+
+### JIT control
+
+Pcre’s JIT compiler is enabled by default for every compiled pattern. The
+wrapper exposes two complementary ways to adjust that behaviour:
+
+- Toggle the global default at runtime with `pcre.configure(jit=False)` to
+  turn JIT off (call `pcre.configure(jit=True)` to turn it back on).
+- Override the default per pattern using the Python-only flags `Flag.JIT`
+  and `Flag.NO_JIT`:
+
+  ```python
+  from pcre import compile, configure, Flag
+
+  configure(jit=False)              # disable JIT globally
+  baseline = compile(r"expr")      # JIT disabled
+
+  fast = compile(r"expr", flags=Flag.JIT)      # force-enable for this pattern
+  slow = compile(r"expr", flags=Flag.NO_JIT)   # force-disable for this pattern
+  ```
+
+## Building
+
+The extension links against an existing PCRE2 installation (the `libpcre2-8`
+variant). Install the development headers for your platform before building,
+for example `apt install libpcre2-dev` on Debian/Ubuntu, `dnf install pcre2-devel`
+on Fedora/RHEL derivatives, or `brew install pcre2` on macOS.
+
+If the headers or library live in a non-standard location you can export one
+or more of the following environment variables prior to invoking the build
+(`pip install .`, `python -m build`, etc.):
+
+- `PCRE2_ROOT`
+- `PCRE2_INCLUDE_DIR`
+- `PCRE2_LIBRARY_DIR`
+- `PCRE2_LIBRARY_PATH` *(pathsep-separated directories or explicit library files to
+  prioritise when resolving `libpcre2-8`)*
+- `PCRE2_LIBRARIES`
+- `PCRE2_CFLAGS`
+- `PCRE2_LDFLAGS`
+
+When `pkg-config` is available the build will automatically pick up the
+required include and link flags via `pkg-config --cflags/--libs libpcre2-8`.
+Without `pkg-config`, the build script scans common installation prefixes for
+Linux distributions (Debian, Ubuntu, Fedora/RHEL/CentOS, openSUSE, Alpine),
+FreeBSD, macOS (including Homebrew), and Solaris to locate the headers and
+libraries.
+
+If your system ships `libpcre2-8` under `/usr` but you also maintain a
+manually built copy under `/usr/local`, export `PCRE2_LIBRARY_PATH` (and, if
+needed, a matching `PCRE2_INCLUDE_DIR`) so the build links against the desired
+location.
+
+# Notes
+
+## Pattern cache
+- `pcre.compile()` caches hashable `(pattern, flags)` pairs, keeping up to 128 entries.
+- Use `pcre.clear_cache()` when you need to free the cache proactively.
+- Non-hashable pattern objects skip the cache and are compiled each time.
+
+## Default flags for text patterns
+- String patterns enable `Flag.UTF` and `Flag.UCP` automatically so behaviour matches `re`.
+- Byte patterns keep both flags disabled; opt in manually if Unicode semantics are desired.
+- Explicitly supply `Flag.NO_UTF`/`Flag.NO_UCP` to override the defaults for strings.
+
+## Additional usage notes
+- All top-level helpers (`match`, `search`, `fullmatch`, `finditer`, `findall`) defer to the cached compiler.
+- Compiled `Pattern` objects expose `.pattern`, `.flags`, `.jit`, and `.groupindex` for introspection.
+- Execution helpers accept `pos`, `endpos`, and `options`, allowing you to thread PCRE2 execution flags per call.
+
+## Memory allocation
+- The extension selects the fastest available allocator at import time: it
+  prefers jemalloc, then tcmalloc, and finally falls back to the platform
+  `malloc`. Optional allocators are loaded via `dlopen`, so no additional
+  link flags are required when they are absent.
+- All internal buffers (match data wrappers, JIT stack cache entries, error
+  formatting scratch space) use the chosen allocator; CPython’s `PyMem_*`
+  family is no longer used within the extension.
+- Call `pcre_ext_c.get_allocator()` to inspect which backend is active at
+  runtime.

pypcre-0.1.0/PyPcre.egg-info/PKG-INFO

@@ -0,0 +1,237 @@
+Metadata-Version: 2.4
+Name: PyPcre
+Version: 0.1.0
+Summary: Modern, GIL-friendly, Fast Python bindings for PCRE2 with auto caching and JIT of compiled patterns.
+Author-email: ModelCloud <qubitium@modelcloud.ai>
+License-Expression: Apache-2.0
+Project-URL: Homepage, https://github.com/ModelCloud/pcre
+Keywords: regex,pcre2,bindings
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Programming Language :: Python :: Free Threading
+Classifier: Programming Language :: Python :: Free Threading :: 3 - Stable
+Classifier: Programming Language :: C
+Classifier: Topic :: Software Development :: Libraries
+Classifier: Topic :: Text Processing :: Linguistic
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Dynamic: license-file
+
+<!--
+# SPDX-FileCopyrightText: 2025 ModelCloud.ai
+# SPDX-FileCopyrightText: 2025 qubitium@modelcloud.ai
+# SPDX-License-Identifier: Apache-2.0
+# Contact: qubitium@modelcloud.ai, x.com/qubitium
+-->
+
+# PyPcre (Python Pcre2 Binding)
+
+Python bindings for the system PCRE2 library with a familiar `re`-style API.
+
+## Installation
+
+```bash
+pip install PyPcre
+```
+
+The package links against the `libpcre2-8` variant already available on your
+system. See [Building](#building) for manual build details.
+
+## Usage
+
+### Drop-in helpers
+
+```python
+from pcre import match, search, findall, compile, Flag
+
+if match(r"(?P<word>\\w+)", "hello world"):
+    print("found word")
+
+pattern = compile(rb"\d+", flags=Flag.MULTILINE)
+numbers = pattern.findall(b"line 1\nline 22")
+```
+
+`pcre` mirrors the core helpers from Python’s standard library `re` module—
+`match`, `search`, `fullmatch`, `finditer`, `findall`, and `compile`—while
+exposing PCRE2’s extended flag set through the Pythonic `Flag` enum
+(`Flag.CASELESS`, `Flag.MULTILINE`, `Flag.UTF`, ...).
+
+### Stdlib `re` compatibility
+
+- Module-level helpers and the `Pattern` class follow the same call shapes as
+  the standard library `re` module, including `pos`, `endpos`, and `flags`
+  behaviour.
+- `Pattern` mirrors `re.Pattern` attributes like `.pattern`, `.groupindex`,
+  and `.groups`, while `Match` objects surface the familiar `.re`, `.string`,
+  `.pos`, `.endpos`, `.lastindex`, `.lastgroup`, `.regs`, and `.expand()` API.
+- Substitution helpers enforce the same type rules as the standard library
+  `re` module: string patterns require string replacements, byte patterns
+  require bytes-like replacements, and callable replacements receive the
+  wrapped `Match`.
+- `compile()` accepts native `Flag` values as well as compatible
+  `re.RegexFlag` members from the standard library. Supported stdlib flags
+  map 1:1 to PCRE2 options (`IGNORECASE→CASELESS`, `MULTILINE→MULTILINE`,
+  `DOTALL→DOTALL`, `VERBOSE→EXTENDED`); passing unsupported stdlib flags
+  raises a compatibility `ValueError` to prevent silent divergences.
+- `pcre.escape()` delegates directly to `re.escape` for byte and text
+  patterns so escaping semantics remain identical.
+
+### `regex` package compatibility
+
+The [`regex`](https://pypi.org/project/regex/) package interprets
+`\uXXXX` and `\UXXXXXXXX` escapes as UTF-8 code points, while PCRE2 expects
+hexadecimal escapes to use the `\x{...}` form. Enable `Flag.COMPAT_UNICODE_ESCAPE` to
+translate those escapes automatically when compiling patterns:
+
+```python
+from pcre import compile, Flag
+
+pattern = compile(r"\\U0001F600", flags=Flag.COMPAT_UNICODE_ESCAPE)
+assert pattern.pattern == r"\\x{0001F600}"
+```
+
+Set the default behaviour globally with `pcre.configure(compat_regex=True)`
+so that subsequent calls to `compile()` and the module-level helpers apply
+the conversion without repeating the flag.
+
+### Automatic pattern caching
+
+`pcre.compile()` caches the final `Pattern` wrapper for up to 128
+unique `(pattern, flags)` pairs when the pattern object is hashable. This
+keeps repeated calls to top-level helpers efficient without any extra work
+from the caller. Adjust the capacity with `pcre.set_cache_limit(n)`—pass
+`0` to disable caching completely or `None` for an unlimited cache—and
+check the current limit with `pcre.get_cache_limit()`. The cache can be
+emptied at any time with `pcre.clear_cache()` if your application needs to
+release memory proactively.
+
+Non-hashable patterns (for example, custom objects) bypass the cache and are
+still compiled immediately.
+
+### Text versus bytes defaults
+
+String patterns follow the same defaults as Python’s `re` module,
+automatically enabling the `Flag.UTF` and `Flag.UCP` options so Unicode
+pattern and character semantics “just work.” Byte patterns remain raw by
+default—neither option is activated—so you retain full control over
+binary-oriented matching. Explicitly set `Flag.NO_UTF`/`Flag.NO_UCP` if you
+need to opt out for strings, or add the UTF/UCP flags yourself when compiling
+bytes.
+
+### Working with compiled patterns
+
+- `compile()` accepts either a pattern literal or an existing `Pattern`
+  instance, making it easy to mix compiled objects with the convenience
+  helpers.
+- `Pattern.match/search/fullmatch/finditer/findall` accept optional
+  `pos`, `endpos`, and `options` arguments, mirroring the standard library
+  `re` module while letting you thread PCRE2 execution flags through
+  individual calls.
+
+### Threaded execution
+
+- `pcre.parallel_map()` fans out work across a shared thread pool for
+  `match`, `search`, `fullmatch`, and `findall`. The helper preserves the
+  order of the provided subjects and returns the same result objects you’d
+  normally receive from the `Pattern` methods.
+- Threading is **opt-in by default** when Python runs without the GIL
+  (e.g. CPython with `-X gil=0` or `PYTHON_GIL=0`). When the GIL is active the default falls
+  back to sequential execution to avoid needless overhead.
+- With auto threading enabled (`configure_threads(enabled=True)`), the pool
+  is only engaged when at least one subject is larger than the configured
+  threshold (60 kB by default). Smaller jobs run sequentially to avoid the
+  cost of thread hand-offs; adjust the boundary via
+  `configure_threads(threshold=...)`.
+- Use `Flag.THREADS` to force threaded execution for a specific pattern or
+  `Flag.NO_THREADS` to lock it to sequential mode regardless of global
+  settings.
+- `pcre.configure_thread_pool(max_workers=...)` controls the size of the
+  shared executor (capped to half the available CPUs); call it with
+  `preload=True` to spin the pool up eagerly, and `shutdown_thread_pool()`
+  to tear it down manually if needed.
+
+### JIT control
+
+Pcre’s JIT compiler is enabled by default for every compiled pattern. The
+wrapper exposes two complementary ways to adjust that behaviour:
+
+- Toggle the global default at runtime with `pcre.configure(jit=False)` to
+  turn JIT off (call `pcre.configure(jit=True)` to turn it back on).
+- Override the default per pattern using the Python-only flags `Flag.JIT`
+  and `Flag.NO_JIT`:
+
+  ```python
+  from pcre import compile, configure, Flag
+
+  configure(jit=False)              # disable JIT globally
+  baseline = compile(r"expr")      # JIT disabled
+
+  fast = compile(r"expr", flags=Flag.JIT)      # force-enable for this pattern
+  slow = compile(r"expr", flags=Flag.NO_JIT)   # force-disable for this pattern
+  ```
+
+## Building
+
+The extension links against an existing PCRE2 installation (the `libpcre2-8`
+variant). Install the development headers for your platform before building,
+for example `apt install libpcre2-dev` on Debian/Ubuntu, `dnf install pcre2-devel`
+on Fedora/RHEL derivatives, or `brew install pcre2` on macOS.
+
+If the headers or library live in a non-standard location you can export one
+or more of the following environment variables prior to invoking the build
+(`pip install .`, `python -m build`, etc.):
+
+- `PCRE2_ROOT`
+- `PCRE2_INCLUDE_DIR`
+- `PCRE2_LIBRARY_DIR`
+- `PCRE2_LIBRARY_PATH` *(pathsep-separated directories or explicit library files to
+  prioritise when resolving `libpcre2-8`)*
+- `PCRE2_LIBRARIES`
+- `PCRE2_CFLAGS`
+- `PCRE2_LDFLAGS`
+
+When `pkg-config` is available the build will automatically pick up the
+required include and link flags via `pkg-config --cflags/--libs libpcre2-8`.
+Without `pkg-config`, the build script scans common installation prefixes for
+Linux distributions (Debian, Ubuntu, Fedora/RHEL/CentOS, openSUSE, Alpine),
+FreeBSD, macOS (including Homebrew), and Solaris to locate the headers and
+libraries.
+
+If your system ships `libpcre2-8` under `/usr` but you also maintain a
+manually built copy under `/usr/local`, export `PCRE2_LIBRARY_PATH` (and, if
+needed, a matching `PCRE2_INCLUDE_DIR`) so the build links against the desired
+location.
+
+# Notes
+
+## Pattern cache
+- `pcre.compile()` caches hashable `(pattern, flags)` pairs, keeping up to 128 entries.
+- Use `pcre.clear_cache()` when you need to free the cache proactively.
+- Non-hashable pattern objects skip the cache and are compiled each time.
+
+## Default flags for text patterns
+- String patterns enable `Flag.UTF` and `Flag.UCP` automatically so behaviour matches `re`.
+- Byte patterns keep both flags disabled; opt in manually if Unicode semantics are desired.
+- Explicitly supply `Flag.NO_UTF`/`Flag.NO_UCP` to override the defaults for strings.
+
+## Additional usage notes
+- All top-level helpers (`match`, `search`, `fullmatch`, `finditer`, `findall`) defer to the cached compiler.
+- Compiled `Pattern` objects expose `.pattern`, `.flags`, `.jit`, and `.groupindex` for introspection.
+- Execution helpers accept `pos`, `endpos`, and `options`, allowing you to thread PCRE2 execution flags per call.
+
+## Memory allocation
+- The extension selects the fastest available allocator at import time: it
+  prefers jemalloc, then tcmalloc, and finally falls back to the platform
+  `malloc`. Optional allocators are loaded via `dlopen`, so no additional
+  link flags are required when they are absent.
+- All internal buffers (match data wrappers, JIT stack cache entries, error
+  formatting scratch space) use the chosen allocator; CPython’s `PyMem_*`
+  family is no longer used within the extension.
+- Call `pcre_ext_c.get_allocator()` to inspect which backend is active at
+  runtime.