{"id":13610579,"url":"https://github.com/ovalhub/pyicu","last_synced_at":"2025-10-21T20:33:30.262Z","repository":{"id":30472685,"uuid":"34026716","full_name":"ovalhub/pyicu","owner":"ovalhub","description":"The PyICU project repository has moved to https://pyicu.org. ","archived":true,"fork":false,"pushed_at":"2021-04-08T22:53:00.000Z","size":1413,"stargazers_count":133,"open_issues_count":2,"forks_count":49,"subscribers_count":12,"default_branch":"master","last_synced_at":"2025-03-11T10:43:16.646Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"C++","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ovalhub.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGES","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2015-04-16T01:00:41.000Z","updated_at":"2024-03-11T17:44:40.000Z","dependencies_parsed_at":"2022-09-14T16:40:37.584Z","dependency_job_id":null,"html_url":"https://github.com/ovalhub/pyicu","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ovalhub%2Fpyicu","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ovalhub%2Fpyicu/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ovalhub%2Fpyicu/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ovalhub%2Fpyicu/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ovalhub","download_url":"https://codeload.github.com/ovalhub/pyicu/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248642308,"owners_count":21138350,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-08-01T19:01:46.067Z","updated_at":"2025-10-21T20:33:24.927Z","avatar_url":"https://github.com/ovalhub.png","language":"C++","readme":"# README file for PyICU\n\n## Welcome\n\nWelcome to PyICU, a Python extension wrapping the ICU C++ libraries.\n\nICU stands for \"International Components for Unicode\".\nThese are the i18n libraries of the Unicode Consortium.\nThey implement much of the Unicode Standard,\nmany of its companion Unicode Technical Standards,\nand much of Unicode CLDR.\n\nThe PyICU source code is hosted at https://gitlab.pyicu.org/main/pyicu.\n\nThe ICU homepage is http://site.icu-project.org/\n\nSee also the CLDR homepage at http://cldr.unicode.org/\n\n## Installing PyICU\n\nPyICU is a python extension implemented in C++ that wraps the C/C++ ICU library.\nIt is known to also work as a [PyPy](https://www.pypy.org/) extension.\nUnless ``pkg-config`` and the ICU libraries and headers are already installed,\nbuilding PyICU from the sources on [PyPI](https://pypi.org/project/PyICU/)\ninvolves more than just a ``pip`` call. Many operating systems distribute\npre-built binary packages of ICU and PyICU, see below.\n\n  - Mac OS X\n    - Ensure ICU is installed and can be found by `pkg-config` (as `icu-config` was [deprecated](http://userguide.icu-project.org/howtouseicu#TOC-C-Makefiles) as of ICU 63.1), either by following [ICU build instructions](https://unicode-org.github.io/icu/userguide/icu4c/build.html), or by using Homebrew:\n      ```sh\n      # install libicu (keg-only)\n      brew install pkg-config icu4c\n\n      # let setup.py discover keg-only icu4c via pkg-config\n      export PATH=\"/usr/local/opt/icu4c/bin:/usr/local/opt/icu4c/sbin:$PATH\"\n      export PKG_CONFIG_PATH=\"$PKG_CONFIG_PATH:/usr/local/opt/icu4c/lib/pkgconfig\"\n      ```\n    - Install PyICU **with the same C++ compiler as your Python distribution**\n      ([more info](https://gitlab.pyicu.org/main/pyicu/merge_requests/140#issuecomment-782283491)):\n      ```sh\n      # EITHER - when using a gcc-built CPython (e.g. from Homebrew)\n      export CC=\"$(which gcc)\" CXX=\"$(which g++)\"\n      # OR - when using system CPython or another clang-based CPython, ensure system clang is used (for proper libstdc++ https://gitlab.pyicu.org/main/pyicu/issues/5#issuecomment-291631507):\n      unset CC CXX\n\n      # avoid wheels from previous runs or PyPI\n      pip install --no-binary=:pyicu: pyicu\n      ```\n\n  - Debian\n    ```sh\n    apt-get update\n    \n    # EITHER - from apt directly https://packages.debian.org/source/stable/pyicu\n    apt-get install python3-icu\n    # OR - from source\n    apt-get install pkg-config libicu-dev\n    pip install --no-binary=:pyicu: pyicu\n    ```\n\n  - Ubuntu: similar to Debian, there is a pyicu\n    [package](https://packages.ubuntu.com/source/xenial/python/pyicu)\n    available via ``apt``.\n\n  - Alpine Linux: there is a pyicu\n    [package](https://pkgs.alpinelinux.org/package/edge/community/x86/py3-icu)\n    available via ``apk``.\n\n  - NetBSD: there is a pyicu [package](https://pkgsrc.se/textproc/py-ICU)\n    available via ``pkg_add``.\n\n  - OpenBSD: there is a pyicu [package](https://openports.se/textproc/py-ICU)\n    available via ``pkg_add``.\n\n  - Other operating systems: see below.\n\n## Building PyICU\n\nBefore building PyICU the ICU libraries must be built and installed. Refer\nto each system's [instructions](https://unicode-org.github.io/icu/userguide/icu4c/build.html) for more information.\n\nPyICU is built with setuptools:\n\n   - verify that ``pkg-config`` is available (the ``icu-config`` program is\n     [deprecated](http://userguide.icu-project.org/howtouseicu#TOC-C-Makefiles)\n     as of ICU 63.1)\n     ```sh\n     pkg-config --cflags --libs icu-i18n\n     ```\n     If this command returns an error or doesn't return the paths expected\n     then ensure that the ``INCLUDES``, ``LFLAGS``, ``CFLAGS`` and ``LIBRARIES``\n     dictionaries in ``setup.py`` contain correct values for your platform.\n     Starting with ICU 60, ``-std=c++11`` must appear in your CFLAGS or be the\n     default for your C++ compiler.\n\n   - build and install pyicu\n     ```sh\n     python setup.py build\n     sudo python setup.py install\n     ```\n\n## Running PyICU\n\n  - Mac OS X\n    Make sure that ``DYLD_LIBRARY_PATH`` contains paths to the directory(ies)\n    containing the ICU libs.\n\n  - Linux \u0026 Solaris\n    Make sure that ``LD_LIBRARY_PATH`` contains paths to the directory(ies)\n    containing the ICU libs or that you added the corresponding ``-rpath``\n    argument to ``LFLAGS``.\n\n  - Windows\n    Make sure that ``PATH`` contains paths to the directory(ies)\n    containing the ICU DLLs.\n\n\n## What's available\n\nSee the [CHANGES](https://gitlab.pyicu.org/main/pyicu/blob/main/CHANGES) file\nfor an up to date log of changes and additions.\n\n\n## API Documentation\n\nThere is no API documentation for PyICU. The API for ICU is documented at\nhttps://unicode-org.github.io/icu-docs/apidoc/released/icu4c/ and the\nfollowing patterns can be used to translate from the C++ APIs to the\ncorresponding Python APIs.\n\n### strings\n\nThe ICU string type, [UnicodeString](https://unicode-org.github.io/icu-docs/apidoc/dev/icu4c/classicu_1_1UnicodeString.html), is a type pointing at a mutable array of [UChar](https://unicode-org.github.io/icu-docs/apidoc/dev/icu4c/umachine_8h.html#a6bb9fad572d65b305324ef288165e2ac) Unicode 16-bit wide characters and is described [here](https://unicode-org.github.io/icu-docs/apidoc/dev/icu4c/classicu_1_1UnicodeString.html#details). The Python 3 [str](https://docs.python.org/3/library/stdtypes.html#str) type is described [here](https://docs.python.org/3/library/stdtypes.html#index-26) and [here](https://docs.python.org/3/howto/unicode.html). The Python 2 [unicode](https://docs.python.org/2.7/reference/datamodel.html#index-23) type is described [here](https://docs.python.org/2.7/library/stdtypes.html#sequence-types-str-unicode-list-tuple-bytearray-buffer-xrange).\n\nBecause of their differences, ICU's and Python's string objects are not merged\ninto the same type when crossing the C++ boundary but converted.\n\nICU APIs taking ``UnicodeString`` arguments have been overloaded to also\naccept arguments that are Python 3 ``str`` or Python 2 ``unicode`` objects.\nPython 2 ``str`` objects are auto-decoded into ICU strings using the ``utf-8``\nencoding.\n\nTo convert a Python 3 ``bytes`` or a Python 2 ``str`` object encoded in an\nencoding other than ``utf-8`` to an ICU ``UnicodeString`` use the\n``UnicodeString(str, encodingName)`` constructor.\n\nICU's C++ APIs accept and return ``UnicodeString`` arguments in several\nways: by value, by pointer or by reference.\nWhen an ICU C++ API is documented to accept a ``UnicodeString`` reference\nparameter, it is safe to assume that there are several corresponding\nPyICU python APIs making it accessible in simpler ways:\n\nFor example, the ``'UnicodeString \u0026Locale::getDisplayName(UnicodeString \u0026)'``\nAPI, documented\n[here](https://unicode-org.github.io/icu-docs/apidoc/released/icu4c/classicu_1_1Locale.html#a61def321a9cfd9904b59e3f1897f835e),\ncan be invoked from Python in several ways:\n\n1. The ICU way\n\n        \u003e\u003e\u003e from icu import UnicodeString, Locale\n        \u003e\u003e\u003e locale = Locale('pt_BR')\n        \u003e\u003e\u003e string = UnicodeString()\n        \u003e\u003e\u003e name = locale.getDisplayName(string)\n        \u003e\u003e\u003e name\n        \u003cUnicodeString: 'Portuguese (Brazil)'\u003e\n        \u003e\u003e\u003e name is string\n        True                  \u003c-- string arg was returned, modified in place\n\n2. The Python way\n\n        \u003e\u003e\u003e from icu import Locale\n        \u003e\u003e\u003e locale = Locale('pt_BR')\n        \u003e\u003e\u003e name = locale.getDisplayName()\n        \u003e\u003e\u003e name\n        'Portuguese (Brazil)'\n\n    A ``UnicodeString`` object was allocated and converted to a Python\n    ``str`` object.\n\nA UnicodeString can be converted to a Python unicode string with Python 3's\n``str()`` or Python 2's ``unicode()`` constructor. The usual ``len()``,\ncomparison, `[]`` and ``[:]`` operators are all available, with the additional\ntwists that slicing is not read-only and that ``+=`` is also available since a\nUnicodeString is mutable. For example:\n\n    \u003e\u003e\u003e name = locale.getDisplayName()\n    'Portuguese (Brazil)'\n    \u003e\u003e\u003e name = UnicodeString(name)\n    \u003e\u003e\u003e name\n    \u003cUnicodeString: 'Portuguese (Brazil)'\u003e\n    \u003e\u003e\u003e str(name)\n    'Portuguese (Brazil)'\n    \u003e\u003e\u003e len(name)\n    19\n    \u003e\u003e\u003e str(name)\n    'Portuguese (Brazil)'\n    \u003e\u003e\u003e name[3]\n    't'\n    \u003e\u003e\u003e name[12:18]\n    \u003cUnicodeString: 'Brazil'\u003e\n    \u003e\u003e\u003e name[12:18] = 'the country of Brasil'\n    \u003e\u003e\u003e name\n    \u003cUnicodeString: 'Portuguese (the country of Brasil)'\u003e\n    \u003e\u003e\u003e name += ' oh joy'\n    \u003e\u003e\u003e name\n    \u003cUnicodeString: 'Portuguese (the country of Brasil) oh joy'\u003e\n\n### error reporting\n\nThe C++ ICU library does not use C++ exceptions to report errors. ICU\nC++ APIs return errors via a ``UErrorCode`` reference argument. All such\nAPIs are wrapped by Python APIs that omit this argument and throw an\n``ICUError`` Python exception instead. The same is true for ICU APIs\ntaking both a ``ParseError`` and a ``UErrorCode``, they are both to be\nomitted.\n\nFor example, the ``'UnicodeString \u0026DateFormat::format(const Formattable \u0026, UnicodeString \u0026, FieldPosition \u0026, UErrorCode \u0026)'`` API, documented [here](https://unicode-org.github.io/icu-docs/apidoc/released/icu4c/classicu_1_1DateFormat.html#aae63209f1202550c91e2beed5691b062) is invoked from Python with:\n\n    \u003e\u003e\u003e from icu import DateFormat, Formattable\n    \u003e\u003e\u003e df = DateFormat.createInstance()\n    \u003e\u003e\u003e df\n    \u003cSimpleDateFormat: M/d/yy h:mm a\u003e\n    \u003e\u003e\u003e f = Formattable(940284258.0, Formattable.kIsDate)\n    \u003e\u003e\u003e df.format(f)\n    '10/18/99 3:04 PM'\n\nOf course, the simpler ``'UnicodeString \u0026DateFormat::format(UDate, UnicodeString \u0026)'`` documented [here](https://unicode-org.github.io/icu-docs/apidoc/released/icu4c/classicu_1_1DateFormat.html#a5940ccf5676d3fa043d8255c55b7ddd1) can be used too:\n\n    \u003e\u003e\u003e from icu import DateFormat\n    \u003e\u003e\u003e df = DateFormat.createInstance()\n    \u003e\u003e\u003e df\n    \u003cSimpleDateFormat: M/d/yy h:mm a\u003e\n    \u003e\u003e\u003e df.format(940284258.0)\n    '10/18/99 3:04 PM'\n\n### dates\n\nICU uses a double floating point type called ``UDate`` that represents the\nnumber of milliseconds elapsed since 1970-jan-01 UTC for dates.\n\nIn Python, the value returned by the ``time`` module's ``time()``\nfunction is the number of seconds since 1970-jan-01 UTC. Because of this\ndifference, floating point values are multiplied by 1000 when passed to\nAPIs taking ``UDate`` and divided by 1000 when returned as ``UDate``.\n\nPython's ``datetime`` objects, with or without timezone information, can\nalso be used with APIs taking ``UDate`` arguments. The ``datetime``\nobjects get converted to ``UDate`` when crossing into the C++ layer.\n\n### arrays\n\nMany ICU API take array arguments. A list of elements of the array\nelement types is to be passed from Python.\n\n### StringEnumeration\n\nAn ICU ``StringEnumeration`` has three ``next`` methods: ``next()`` which\nreturns ``str`` objects, ``unext()`` which returns ``str`` objects in Python 3\nor ``unicode`` objects in Python 2 and ``snext()`` which returns\n``UnicodeString`` objects. Any of these methods can be used as an iterator,\nusing the Python built-in ``iter`` function.\n\nFor example, let ``e`` be a ``StringEnumeration`` instance:\n\n```python\ne = TimeZone.createEnumeration()\n[s for s in e] # a list of 'str' objects\n[s for s in iter(e.unext, '')] # a list of 'str' or 'unicode' objects\n[s for s in iter(e.snext, '')] # a list of 'UnicodeString' objects\n```\n\n### timezones\n\nThe ICU ``TimeZone`` type may be wrapped with an ``ICUtzinfo`` type for\nusage with Python's ``datetime`` type. For example:\n\n```python\nfrom datetime import datetime\ntz = ICUtzinfo(TimeZone.createTimeZone('US/Mountain'))\ndatetime.now(tz)\n```\n\nor, even simpler:\n\n```python\ntz = ICUtzinfo.getInstance('Pacific/Fiji')\ndatetime.now(tz)\n```\n\nTo get the default time zone use:\n\n```python\ndefaultTZ = ICUtzinfo.getDefault()\n```\n\nTo get the time zone's id, use the ``tzid`` attribute or coerce the time\nzone to a string:\n\n```python\nICUtzinfo.getInstance('Pacific/Fiji').tzid -\u003e 'Pacific/Fiji'\nstr(ICUtzinfo.getInstance('Pacific/Fiji')) -\u003e 'Pacific/Fiji'\n```\n","funding_links":[],"categories":["Internationalization","资源列表","国际化","Internationalization [🔝](#readme)","Awesome Python"],"sub_categories":["国际化","Internationalization"],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fovalhub%2Fpyicu","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fovalhub%2Fpyicu","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fovalhub%2Fpyicu/lists"}