icupy 0.8.0.post2

Python bindings for ICU4C

icupy

Python bindings for ICU4C.

Installation

Prerequisites

• Python >=3.8
• ICU4C (>=64 recommended)
• C++17 compatible compiler (depends on pybind11)
• CMake >=3.7

Building from source

1. If installing icupy on Windows or if ICU is located in a non-regular place, set the ICU_ROOT environment variable to the root of the ICU installation. (e.g., set ICU_ROOT=C:\icu)

2. Installing from PyPI:

   pip install icupy
   

   Alternatively, installing from the git repository:

   git clone --recursive https://github.com/miute/icupy.git
   pip install ./icupy
   

Changes

• Naming Rules
  • Renamed C functions and C++ class methods from mixed case to snake case. (e.g., findAndReplace() → find_and_replace())
  • Renamed C++ enumerators to upper snake case without "k" prefix. (e.g., kDateOffset → DATE_OFFSET)

Examples

• icu::UnicodeString with error callback

  >>> import icupy as icu
  >>> cnv = icu.ucnv_open("utf-8")
  >>> action = icu.UCNV_TO_U_CALLBACK_ESCAPE
  >>> context = icu.ConstVoidPtr(icu.UCNV_ESCAPE_C)
  >>> icu.ucnv_set_to_u_call_back(cnv, action, context)
  >>> utf8 = b"\x61\xfe\x62"  # Impossible bytes
  >>> s = icu.UnicodeString(utf8, -1, cnv)
  >>> str(s)
  'a\\xFEb'
  

• icu::IDNA (UTS #46)

  >>> import icupy as icu
  >>> uts46 = icu.IDNA.create_uts46_instance(icu.UIDNA_NONTRANSITIONAL_TO_ASCII)
  >>> dest = icu.UnicodeString()
  >>> info = icu.IDNAInfo()
  >>> uts46.name_to_ascii(icu.UnicodeString("faß.ExAmPlE"), dest, info)
  UnicodeString("xn--fa-hia.example")
  >>> str(dest)
  'xn--fa-hia.example'
  

• See also tests directory.

License

This project is licensed under the MIT License.