Hanziconv

https://pythonhosted.org/hanziconv/
Admin
Hanziconv is a Python library and command-line tool that converts between simplified and traditional...
Tokens:1,633
Snippets:16
Trust Score:9.5
Update:6 months ago
Show doc for...
Tokens:
Raw
### Install hanziconv

Source: https://pythonhosted.org/hanziconv/index.html

Install the package using pip.

```bash
$ pip install hanziconv
```

--------------------------------

### Install pytest

Source: https://pythonhosted.org/hanziconv/index.html

Install the testing framework required for running tests.

```bash
$ [sudo] pip install pytest
```

--------------------------------

### Python API Usage

Source: https://pythonhosted.org/hanziconv/index.html

Examples of using the HanziConv class for conversion and comparison.

```python
>>> from hanziconv import HanziConv
>>> print(HanziConv.toSimplified('繁簡轉換器'))
繁简转换器
>>> print(HanziConv.toTraditional('繁简转换器'))
繁簡轉換器
>>> HanziConv.same('繁簡轉換器', '繁简转换器')
True
```

```python
>>> from hanziconv import HanziConv
>>> print(HanziConv.same('繁简转换器', '繁簡轉換器'))
True
```

```python
>>> from hanziconv import HanziConv
>>> print(HanziConv.toSimplified('繁簡轉換器'))
繁简转换器
```

```python
>>> from hanziconv import HanziConv
>>> print(HanziConv.toTraditional('繁简转换器'))
繁簡轉換器
```

--------------------------------

### View Command Line Help

Source: https://pythonhosted.org/hanziconv/index.html

Display the help menu for the hanzi-convert tool.

```bash
$ ./hanzi-convert --help
usage: hanzi-convert [-h] [-o OUTFILE] [-s] [-v] infile

Simplified and Traditional Chinese Character Conversion
Version 0.3.2 (By Bernard Yue)

Converting to Traditional Hanzi by default with no -s flag

positional arguments:
  infile                filename | "-", corresponds to stdin

optional arguments:
  -h, --help            show this help message and exit
  -o OUTFILE, --output OUTFILE
                        filename to save output, stdout if omitted
  -s, --simplified      convert to simplified characters
  -v, --version         show program's version number and exit
```

--------------------------------

### Run Tests

Source: https://pythonhosted.org/hanziconv/index.html

Clone the repository and execute the test suite.

```bash
$ git clone https://github.com/berniey/hanziconv.git
$ cd hanziconv
$ python setup.py test
```

--------------------------------

### Convert via Stdin

Source: https://pythonhosted.org/hanziconv/index.html

Use the command line tool to convert text provided via standard input.

```bash
$ ./hanzi-convert -
Press Crtl-D when finished
Typing away
Now write some chinese characters
繁简转换器
^D
Typing away
Now write some chinese characters
繁簡轉換器
$
```

--------------------------------

### hanziconv Module Documentation

Source: https://pythonhosted.org/hanziconv/_sources/index.txt

This section details the hanziconv module, listing its members, undocumented members, and inheritance.

```APIDOC
## hanziconv Module

### Description
Provides functionality for converting between simplified and traditional Chinese characters.

### Members
This module contains the following members:

- `members`: Lists all public members of the module.
- `undoc-members`: Lists members that are not documented.
- `show-inheritance`: Indicates whether to show the inheritance of classes.

### Usage Example
```python
import hanziconv

# Example usage would go here, assuming functions are available.
# For instance, if there's a function like convert_simplified_to_traditional:
# traditional_text = hanziconv.convert_simplified_to_traditional(simplified_text)
```
```

--------------------------------

### Hanziconv Class Methods

Source: https://pythonhosted.org/hanziconv/genindex.html

This section details the methods available within the HanziConv class for character conversion.

```APIDOC
## HanziConv Class Methods

### Description
Provides methods for converting between simplified and traditional Chinese characters.

### Methods
- `same()`
- `toSimplified()`
- `toTraditional()`

### Usage Examples

#### `same()`
```python
from hanziconv import HanziConv

# Example usage for same()
```

#### `toSimplified()`
```python
from hanziconv import HanziConv

# Example usage for toSimplified()
```

#### `toTraditional()`
```python
from hanziconv import HanziConv

# Example usage for toTraditional()
```
```

--------------------------------

### HanziConv.same

Source: https://pythonhosted.org/hanziconv/index.html

Compares two strings to determine if they are semantically identical in Chinese.

```APIDOC
## HanziConv.same

### Description
Compares two strings and returns True if they represent the same Chinese characters regardless of whether they are simplified or traditional.

### Parameters
- **text1** (string) - Required - The first string to compare.
- **text2** (string) - Required - The second string to compare.

### Response
- **Returns** (boolean) - True if the strings are semantically the same, False otherwise.

### Example
```python
from hanziconv import HanziConv
HanziConv.same('繁簡轉換器', '繁简转换器')
# Output: True
```
```

--------------------------------

### Uninstall hanziconv

Source: https://pythonhosted.org/hanziconv/index.html

Remove the package using pip.

```bash
$ [sudo] pip uninstall hanziconv
```

--------------------------------

### HanziConv.toTraditional

Source: https://pythonhosted.org/hanziconv/index.html

Converts a simplified Chinese character string to traditional Chinese.

```APIDOC
## HanziConv.toTraditional

### Description
Converts the provided text to a traditional character string, assuming the input is in simplified Chinese.

### Parameters
- **text** (string) - Required - The simplified Chinese text to convert.

### Response
- **Returns** (string) - The converted traditional UTF-8 characters.

### Example
```python
from hanziconv import HanziConv
print(HanziConv.toTraditional('繁简转换器'))
# Output: 繁簡轉換器
```
```

--------------------------------

### HanziConv.toSimplified

Source: https://pythonhosted.org/hanziconv/index.html

Converts a traditional Chinese character string to simplified Chinese.

```APIDOC
## HanziConv.toSimplified

### Description
Converts the provided text to a simplified character string, assuming the input is in traditional Chinese.

### Parameters
- **text** (string) - Required - The traditional Chinese text to convert.

### Response
- **Returns** (string) - The converted simplified UTF-8 characters.

### Example
```python
from hanziconv import HanziConv
print(HanziConv.toSimplified('繁簡轉換器'))
# Output: 繁简转换器
```
```
Tokens:
Raw