service/vendor/github.com/mozillazg/go-pinyin
Leufolium b45bddf849 by Robin at 20240613 2024-06-13 12:29:14 +08:00
..
.editorconfig by Robin at 20240613 2024-06-13 12:29:14 +08:00
.gitignore by Robin at 20240613 2024-06-13 12:29:14 +08:00
.gitmodules by Robin at 20240613 2024-06-13 12:29:14 +08:00
CHANGELOG.md by Robin at 20240613 2024-06-13 12:29:14 +08:00
LICENSE by Robin at 20240613 2024-06-13 12:29:14 +08:00
Makefile by Robin at 20240613 2024-06-13 12:29:14 +08:00
README.md by Robin at 20240613 2024-06-13 12:29:14 +08:00
doc.go by Robin at 20240613 2024-06-13 12:29:14 +08:00
phonetic_symbol.go by Robin at 20240613 2024-06-13 12:29:14 +08:00
pinyin.go by Robin at 20240613 2024-06-13 12:29:14 +08:00
pinyin_dict.go by Robin at 20240613 2024-06-13 12:29:14 +08:00

README.md

go-pinyin

Build Status Coverage Status Go Report Card GoDoc

汉语拼音转换工具 Go 版。

Installation

go get github.com/mozillazg/go-pinyin

install CLI tool:

# go version>=1.17
go install github.com/mozillazg/go-pinyin/cli/pinyin@latest

# go version<1.17
go get -u github.com/mozillazg/go-pinyin/cli/pinyin

$ pinyin 中国人
zhōng guó rén

Documentation

API documentation can be found here: https://godoc.org/github.com/mozillazg/go-pinyin

Usage

package main

import (
	"fmt"
	"github.com/mozillazg/go-pinyin"
)

func main() {
	hans := "中国人"

	// 默认
	a := pinyin.NewArgs()
	fmt.Println(pinyin.Pinyin(hans, a))
	// [[zhong] [guo] [ren]]

	// 包含声调
	a.Style = pinyin.Tone
	fmt.Println(pinyin.Pinyin(hans, a))
	// [[zhōng] [guó] [rén]]

	// 声调用数字表示
	a.Style = pinyin.Tone2
	fmt.Println(pinyin.Pinyin(hans, a))
	// [[zho1ng] [guo2] [re2n]]

	// 开启多音字模式
	a = pinyin.NewArgs()
	a.Heteronym = true
	fmt.Println(pinyin.Pinyin(hans, a))
	// [[zhong zhong] [guo] [ren]]
	a.Style = pinyin.Tone2
	fmt.Println(pinyin.Pinyin(hans, a))
	// [[zho1ng zho4ng] [guo2] [re2n]]

	fmt.Println(pinyin.LazyPinyin(hans, pinyin.NewArgs()))
	// [zhong guo ren]

	fmt.Println(pinyin.Convert(hans, nil))
	// [[zhong] [guo] [ren]]

	fmt.Println(pinyin.LazyConvert(hans, nil))
	// [zhong guo ren]
}

注意:

  • 默认情况下会忽略没有拼音的字符(可以通过自定义 Fallback 参数的值来自定义如何处理没有拼音的字符, 详见 示例)。
  • 根据 《汉语拼音方案》 ywü (yu) 都不是声母, 以及不是所有拼音都有声母,如果这不是你预期的话,你可能需要的是首字母风格 FirstLetter 详细信息 )。

pinyin data

License

Under the MIT License.