pinyin

package module

v0.20.0 Latest Latest Go to latest Published: Dec 7, 2021 License: MIT Imports: 2 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/ufoundit-dev/go-pinyin

README ¶

go-pinyin

汉语拼音转换工具 Go 版。

Installation

go get -u github.com/mozillazg/go-pinyin

install CLI tool:

go get -u github.com/mozillazg/go-pinyin/cmd/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 参数的值来自定义如何处理没有拼音的字符，详见示例）。
根据《汉语拼音方案》 y，w，ü (yu) 都不是声母，以及不是所有拼音都有声母，如果这不是你预期的话，你可能需要的是首字母风格 FirstLetter （详细信息）。

hotoo/pinyin: 汉语拼音转换工具 Node.js/JavaScript 版。
mozillazg/python-pinyin: 汉语拼音转换工具 Python 版。
mozillazg/rust-pinyin: 汉语拼音转换工具 Rust 版。

pinyin data

使用 pinyin-data 的拼音数据

License

Under the MIT License.

Documentation ¶

Overview ¶

Package 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]]
}

Index ¶

Constants
Variables
func Convert(s string, a *Args) [][]string
func LazyConvert(s string, a *Args) []string
func LazyPinyin(s string, a Args) []string
func Name(s string, a Args) [][]string
func Pinyin(s string, a Args) [][]string
func SinglePinyin(r rune, a Args) []string
func Slug(s string, a Args) string
type Args
- func NewArgs() Args

Constants ¶

View Source

const (
	Version   = "0.18.0"
	Author    = "mozillazg, 闲耘"
	License   = "MIT"
	Copyright = "Copyright (c) 2016 mozillazg, 闲耘"
)

Variables ¶

View Source

var Fallback = func(r rune, a Args) []string {
	return []string{}
}

Fallback 默认配置: 如何处理没有拼音的字符(忽略这个字符)

View Source

var Heteronym = false

Heteronym 默认配置：是否启用多音字模式

View Source

var PinyinDict = map[int]string{}/* 41455 elements not displayed */

PinyinDict is data map Warning: Auto-generated file, don't edit.

View Source

var Separator = "-"

Separator 默认配置： `Slug` 中 Join 所用的分隔符

View Source

var Style = Normal

Style 默认配置：风格

View Source

var Surnames = map[string]string{

	"万俟": "mo qi",
	"尉迟": "yu chi",
	"单于": "chan yu",
	"不":  "fou3",
	"沈":  "shen3",
	"称":  "cheng1",
	"车":  "che1",
	"万":  "wan4",
	"汤":  "tang1",
	"阿":  "a1",
	"丁":  "ding1",
	"强":  "qiang2",
	"仇":  "qiu2",
	"叶":  "ye4",
	"阚":  "kan4",
	"乐":  "yue4",
	"乜":  "nie4",
	"陆":  "lu4",
	"殷":  "yin1",
	"牟":  "mou2",
	"区":  "ou1",
	"宿":  "su4",
	"俞":  "yu2",
	"余":  "yu2",
	"齐":  "qi2",
	"许":  "xu3",
	"信":  "xin4",
	"无":  "wu2",
	"浣":  "wan3",
	"艾":  "ai4",
	"浅":  "qian3",
	"烟":  "yan1",
	"蓝":  "lan2",
	"於":  "yu2",
	"寻":  "xun2",
	"殳":  "shu1",
	"思":  "si1",
	"鸟":  "niao3",
	"卜":  "bu3",
	"单":  "shan4",
	"南":  "nan2",
	"柏":  "bai3",
	"朴":  "piao2",
	"繁":  "po2",
	"曾":  "zeng1",
	"瞿":  "qu2",
	"缪":  "miao4",
	"石":  "shi2",
	"冯":  "feng2",
	"覃":  "qin2",
	"幺":  "yao1",
	"种":  "chong2",
	"折":  "she4",
	"燕":  "yan1",
	"纪":  "ji3",
	"过":  "guo1",
	"华":  "hua4",
	"冼":  "xian3",
	"秘":  "bi4",
	"重":  "chong2",
	"解":  "xie4",
	"那":  "na1",
	"和":  "he2",
	"贾":  "jia3",
	"塔":  "ta3",
	"盛":  "sheng4",
	"查":  "zha1",
	"盖":  "ge3",
	"居":  "ju1",
	"哈":  "ha3",
	"的":  "de1",
	"薄":  "bo2",
	"佴":  "nai4",
	"六":  "lu4",
	"都":  "du1",
	"翟":  "zhai2",
	"扎":  "za1",
	"藏":  "zang4",
	"粘":  "nian4",
	"难":  "nan4",
	"若":  "ruo4",
}

Functions ¶

func Convert ¶ added in v0.9.0

func Convert(s string, a *Args) [][]string

Convert 跟 Pinyin 的唯一区别就是 a 参数可以是 nil

Example ¶

hans := "中国人"
fmt.Println("default:", pinyin.Convert(hans, nil))

Output:

default: [[zhong] [guo] [ren]]

func LazyConvert ¶ added in v0.9.0

func LazyConvert(s string, a *Args) []string

LazyConvert 跟 LazyPinyin 的唯一区别就是 a 参数可以是 nil

func LazyPinyin ¶

func LazyPinyin(s string, a Args) []string

LazyPinyin 汉字转拼音，与 `Pinyin` 的区别是：返回值类型不同，并且不支持多音字模式，每个汉字只取第一个音.

Example ¶

hans := "中国人"
a := pinyin.NewArgs()
fmt.Println(pinyin.LazyPinyin(hans, a))

Output:

[zhong guo ren]

func Name ¶ added in v0.18.1

func Name(s string, a Args) [][]string

Name 名字解析解析名字

func Pinyin ¶

func Pinyin(s string, a Args) [][]string

Pinyin 汉字转拼音，支持多音字模式.

Example (Default) ¶

hans := "中国人"
a := pinyin.NewArgs()
fmt.Println("default:", pinyin.Pinyin(hans, a))

Output:

default: [[zhong] [guo] [ren]]

Example (FallbackCustom1) ¶

hans := "中国人abc"
a := pinyin.NewArgs()
a.Fallback = func(r rune, a pinyin.Args) []string {
	return []string{string(r)}
}
fmt.Println(pinyin.Pinyin(hans, a))

Output:

[[zhong] [guo] [ren] [a] [b] [c]]

Example (FallbackCustom2) ¶

hans := "中国人アイウ"
a := pinyin.NewArgs()
a.Fallback = func(r rune, a pinyin.Args) []string {
	data := map[rune][]string{
		'ア': {"a"},
		'イ': {"i"},
		'ウ': {"u"},
	}
	s, ok := data[r]
	if ok {
		return s
	} else {
		return []string{}
	}
}
fmt.Println(pinyin.Pinyin(hans, a))

Output:

[[zhong] [guo] [ren] [a] [i] [u]]

Example (Finals) ¶

hans := "中国人"
a := pinyin.NewArgs()
a.Style = pinyin.Finals
fmt.Println(pinyin.Pinyin(hans, a))

Output:

[[ong] [uo] [en]]

Example (FinalsTone) ¶

hans := "中国人"
a := pinyin.NewArgs()
a.Style = pinyin.FinalsTone
fmt.Println(pinyin.Pinyin(hans, a))

Output:

[[ōng] [uó] [én]]

Example (FinalsTone2) ¶

hans := "中国人"
a := pinyin.NewArgs()
a.Style = pinyin.FinalsTone2
fmt.Println(pinyin.Pinyin(hans, a))

Output:

[[o1ng] [uo2] [e2n]]

Example (FirstLetter) ¶

hans := "中国人"
a := pinyin.NewArgs()
a.Style = pinyin.FirstLetter
fmt.Println(pinyin.Pinyin(hans, a))

Output:

[[z] [g] [r]]

Example (Heteronym) ¶

hans := "中国人"
a := pinyin.NewArgs()
a.Heteronym = true
a.Style = pinyin.Tone2
fmt.Println(pinyin.Pinyin(hans, a))

Output:

[[zho1ng zho4ng] [guo2] [re2n]]

Example (Initials) ¶

hans := "中国人"
a := pinyin.NewArgs()
a.Style = pinyin.Initials
fmt.Println("Initials:", pinyin.Pinyin(hans, a))

Output:

Initials: [[zh] [g] [r]]

Example (Normal) ¶

hans := "中国人"
a := pinyin.NewArgs()
a.Style = pinyin.Normal
fmt.Println("Normal:", pinyin.Pinyin(hans, a))

Output:

Normal: [[zhong] [guo] [ren]]

Example (Tone) ¶

hans := "中国人"
a := pinyin.NewArgs()
a.Style = pinyin.Tone
fmt.Println("Tone:", pinyin.Pinyin(hans, a))

Output:

Tone: [[zhōng] [guó] [rén]]

Example (Tone2) ¶

hans := "中国人"
a := pinyin.NewArgs()
a.Style = pinyin.Tone2
fmt.Println("Tone2:", pinyin.Pinyin(hans, a))

Output:

Tone2: [[zho1ng] [guo2] [re2n]]

func SinglePinyin ¶

func SinglePinyin(r rune, a Args) []string

SinglePinyin 把单个 `rune` 类型的汉字转换为拼音.

func Slug ¶

func Slug(s string, a Args) string

Slug join `LazyPinyin` 的返回值. 建议改用 https://github.com/mozillazg/go-slugify

Example ¶

hans := "中国人"
a := pinyin.NewArgs()
fmt.Println(pinyin.Slug(hans, a))

Output:

zhong-guo-ren

Types ¶

type Args ¶

type Args struct {
	Style     int    // 拼音风格（默认： Normal)
	Heteronym bool   // 是否启用多音字模式（默认：禁用）
	Separator string // Slug 中使用的分隔符（默认：-)

	// 处理没有拼音的字符（默认忽略没有拼音的字符）
	// 函数返回的 slice 的长度为0 则表示忽略这个字符
	Fallback func(r rune, a Args) []string
}

Args 配置信息

func NewArgs ¶ added in v0.2.0

func NewArgs() Args

NewArgs 返回包含默认配置的 `Args`

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
_tools
cmd
pinyin

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL

README ¶

go-pinyin

Installation

Documentation

Usage

Related Projects

pinyin data

License

Documentation ¶

Overview ¶

Index ¶

Examples ¶

Constants ¶

Variables ¶

Functions ¶

func Convert ¶ added in v0.9.0

func LazyConvert ¶ added in v0.9.0

func LazyPinyin ¶

func Name ¶ added in v0.18.1

func Pinyin ¶

func SinglePinyin ¶

func Slug ¶

Types ¶

type Args ¶

func NewArgs ¶ added in v0.2.0

Source Files ¶

Directories ¶