chai2010 / gettext-go Goto Github PK

View Code? Open in Web Editor NEW

88.0 7.0 26.0 884 KB

:ab: GNU gettext for Go (Imported By Kubernetes)

Home Page: http://pkg.go.dev/github.com/chai2010/gettext-go

License: BSD 3-Clause "New" or "Revised" License

Go 99.79% Makefile 0.21%

go golang gettext i18n translation language po-files mo-files kubernetes k8s

gettext-go's Introduction

Go语言QQ群: 102319854, 1055927514
凹语言(凹读音“Wa”)(The Wa Programming Language): https://github.com/wa-lang/wa

gettext-go: GNU gettext for Go (Imported By Kubernetes)

PkgDoc: http://godoc.org/github.com/chai2010/gettext-go
PkgDoc: http://pkg.go.dev/github.com/chai2010/gettext-go

Install

go get github.com/chai2010/gettext-go
go run hello.go

The godoc.org or go.dev has more information.

Examples

package main

import (
	"fmt"

	"github.com/chai2010/gettext-go"
)

func main() {
	gettext := gettext.New("hello", "./examples/locale").SetLanguage("zh_CN")
	fmt.Println(gettext.Gettext("Hello, world!"))

	// Output: 你好, 世界!
}

package main

import (
	"fmt"

	"github.com/chai2010/gettext-go"
)

func main() {
	gettext.SetLanguage("zh_CN")
	gettext.BindLocale(gettext.New("hello", "locale"))

	// gettext.BindLocale("hello", "locale")              // from locale dir
	// gettext.BindLocale("hello", "locale.zip")          // from locale zip file
	// gettext.BindLocale("hello", "locale.zip", zipData) // from embedded zip data

	// translate source text
	fmt.Println(gettext.Gettext("Hello, world!"))
	// Output: 你好, 世界!

	// if no msgctxt in PO file (only msgid and msgstr),
	// specify context as "" by
	fmt.Println(gettext.PGettext("", "Hello, world!"))
	// Output: 你好, 世界!

	// translate resource
	fmt.Println(string(gettext.Getdata("poems.txt"))))
	// Output: ...
}

Go file: hello.go; PO file: hello.po;

API Changes (v0.1.0 vs v1.0.0)

Renamed package path

v0.1.0 (old)	v1.0.0 (new)
`github.com/chai2010/gettext-go/gettext`	`github.com/chai2010/gettext-go`
`github.com/chai2010/gettext-go/gettext/po`	`github.com/chai2010/gettext-go/po`
`github.com/chai2010/gettext-go/gettext/mo`	`github.com/chai2010/gettext-go/mo`
`github.com/chai2010/gettext-go/gettext/plural`	`github.com/chai2010/gettext-go/plural`

Renamed functions

v0.1.0 (old)	v1.0.0 (new)
`gettext-go/gettext.*`	`gettext-go.*`
`gettext-go/gettext.DefaultLocal`	`gettext-go.DefaultLanguage`
`gettext-go/gettext.BindTextdomain`	`gettext-go.BindLocale`
`gettext-go/gettext.Textdomain`	`gettext-go.SetDomain`
`gettext-go/gettext.SetLocale`	`gettext-go.SetLanguage`
`gettext-go/gettext/po.Load`	`gettext-go/po.LoadFile`
`gettext-go/gettext/po.LoadData`	`gettext-go/po.Load`
`gettext-go/gettext/mo.Load`	`gettext-go/mo.LoadFile`
`gettext-go/gettext/mo.LoadData`	`gettext-go/mo.Load`

Use empty string as the default context for `gettext.Gettext`

package main

// v0.1.0
// if the **context** missing, use `callerName(2)` as the context:

// v1.0.0
// if the **context** missing, use empty string as the context:

func main() {
	gettext.Gettext("hello")          
	// v0.1.0 => gettext.PGettext("main.main", "hello")
	// v1.0.0 => gettext.PGettext("", "hello")

	gettext.DGettext("domain", "hello")
	// v0.1.0 => gettext.DPGettext("domain", "main.main", "hello")
	// v1.0.0 => gettext.DPGettext("domain", "", "hello")

	gettext.NGettext("domain", "hello", "hello2", n)
	// v0.1.0 => gettext.PNGettext("domain", "main.main", "hello", "hello2", n)
	// v1.0.0 => gettext.PNGettext("domain", "", "hello", "hello2", n)

	gettext.DNGettext("domain", "hello", "hello2", n)
	// v0.1.0 => gettext.DPNGettext("domain", "main.main", "hello", "hello2", n)
	// v1.0.0 => gettext.DPNGettext("domain", "", "hello", "hello2", n)
}

`BindLocale` support `FileSystem` interface

// Use FileSystem:
//	BindLocale(New("poedit", "name", OS("path/to/dir"))) // bind "poedit" domain
//	BindLocale(New("poedit", "name", OS("path/to.zip"))) // bind "poedit" domain

New API in v1.0.0

Gettexter interface:

type Gettexter interface {
	FileSystem() FileSystem

	GetDomain() string
	SetDomain(domain string) Gettexter

	GetLanguage() string
	SetLanguage(lang string) Gettexter

	Gettext(msgid string) string
	PGettext(msgctxt, msgid string) string

	NGettext(msgid, msgidPlural string, n int) string
	PNGettext(msgctxt, msgid, msgidPlural string, n int) string

	DGettext(domain, msgid string) string
	DPGettext(domain, msgctxt, msgid string) string
	DNGettext(domain, msgid, msgidPlural string, n int) string
	DPNGettext(domain, msgctxt, msgid, msgidPlural string, n int) string

	Getdata(name string) []byte
	DGetdata(domain, name string) []byte
}

func New(domain, path string, data ...interface{}) Gettexter

FileSystem interface:

type FileSystem interface {
	LocaleList() []string
	LoadMessagesFile(domain, lang, ext string) ([]byte, error)
	LoadResourceFile(domain, lang, name string) ([]byte, error)
	String() string
}

func NewFS(name string, x interface{}) FileSystem
func OS(root string) FileSystem
func ZipFS(r *zip.Reader, name string) FileSystem
func NilFS(name string) FileSystem

BUGS

Please report bugs to [email protected].

Thanks!

gettext-go's People

Contributors

Stargazers

Watchers

gettext-go's Issues

Is DGettext working properly?

I have this file structure

And this in my dialogue.po file

msgid "Choose the day of the week ;)"
msgstr "Оберіть день тижня ;)"

When I am calling the foo.DGettext("dialogue", "Choose the day of the week ;)") english version is returned.
The normal translations are working properly, but when I try to load from other domain it just returns me what I typed in.

xgettext-go会提取出多余的反引号

xgettext-go 通过 go install github.com/chai2010/gettext-go/cmd/xgettext-go@latest 安装，环境 go 1.18.1 Windows 10

最小重现案例

package terminal

import "github.com/chai2010/gettext-go"

func f() {
	println(gettext.Gettext(`Hello world`))
}

output.pot 内容

#: github.com/nnnewb/qn/internal/terminal/t.go:6
#, go-format
msgid "`Hello world`"
msgstr ""

问题怀疑是在 cmd/xgettext-go/pkg.go 这里，没考虑到反引号包裹的字符串的情况。

Typo in README

Instasll should be Install

po文件中的词条如果没有msgctxt, 无法被找到。

在代码中：

gettext.Gettext("Hello world!").

po文件中：

#: main.go:19
msgid "Hello world!"
msgstr "你好世界！"

这种情况将无法得到翻译字符串。

看了代码，在解析mo文件并将翻译保存到dict中时，使用了msgctxt+'\004'+msgid做为key。
在有msgctxt的情况下工作很正常，如PGettext("msgctxt", "msgid")。
在无msgctxt的情况下，Gettext("msgid")无法得到翻译字符串。在dict中实际的key是msgid的内容。而Gettext函数到dict中查找翻译字符串时，以所在函数名做为msgctxt，最后形成<func name>+'\004'+msgid做为key来查找，结果无法找到翻译字符串。

如果Gettext()函数能生成正确的key，问题就能解决，修改方法如下：

diff --git a/gettext/gettext.go b/gettext/gettext.go
index ca14065..2171c74 100644
--- a/gettext/gettext.go
+++ b/gettext/gettext.go
@@ -80,7 +80,7 @@ func Textdomain(domain string) string {
 //     msg := gettext.Gettext("Hello") // msgctxt is "some/package/name.Foo"
 // }
 func Gettext(msgid string) string {
-   return PGettext(callerName(2), msgid)
+   return PGettext("", msgid)
 }

 // Getdata attempt to translate a resource file into the user's native language,

Test failure

The test suite fails for me on both Go 1.5.3 and 1.6.0:

$ go test
--- FAIL: TestCallerName (0.00s)
        caller_test.go:39: expect = github.com/chai2010/gettext-go/gettext.init, got = github.com/chai2010/gettext-go/gettext.init.1
FAIL
exit status 1
FAIL    github.com/chai2010/gettext-go/gettext  0.226s

web并发环境下存在并发问题

SetLanguage BindLocale 都是用的全局defaultGettexter 并发调SetLanguage会错乱

Load data files from main language if country one is not available

If the localization is provided for a fr and there is none for fr_FR, then the fr files should be loaded when the language is set to fr_FR. This would surely be better than no localization at all.

v1.0计划

目前的API还是从 google code 网址时代继承来的, 需要重新设计简化API和包路径
gettext是上个世纪的产物, 全局只有一个选择, 改进支持多局部多语言共存
目前的context有缺陷, 内部闭包的路径解析不够稳定, 需要重新设计
命令行工具, 可以自动从代码提取要翻译的文字, 同时对有问题的用法提供告警(比如传入的是变量字符串)
v0.1到v1.0的API变化, 尽量保证gofmt命令行替换可以完成升级
domain绑定到对象, 不同的pkg可以选择不同的domain, context是domain内部的区别, caller不再自动填充
自动生成多国文本(调用翻译服务的API/插件模式)
增加map类型的翻译文件, 可以作为po文件替代
支持单个po/mo文件，和map类型，对于一个具体的翻译 FileSystem.LoadMessagesMap(domain, lang string) (map[string][]string, error)/map[domain][lang][msgid][]string/gettext/mapfs.NewXXX()/jsonString/map[string]interface{}/LoadJsonFile(domain, lang) ([]byte, error)
json: LoadMessagesFile("hello", "zh_CN", "json"), Json(s) FileSystem
支持walk/playground等格式的json翻译
其它

https://pkg.go.dev/github.com/chai2010/gettext-go

也许可以考虑支持从go:embed加载翻译文件

Default plural formula should probably be the one for English

In most programs the default language is English. Should this be reflected in the formula of the nilTranslator instead of the no-plural one?
If that is not desirable, because changing a default may have an impact on other programs, then adding an API to allow changing it would be nice.

JSON支持

考虑添加JSON格式支持吗？前端用的。参考：https://github.com/php-gettext/Json

Need multiple languages support for multiple threads

One scenario is for serving web requests with different languages. It seems domainManager is not exported and only defaultDomainManager can be used. It would be nice to export domainManager or have some way to allow different clients/threads to have different domainManger with its own locale.

msgplural index parsing logic is wrong

https://github.com/chai2010/gettext-go/blob/master/po/message.go#L134

In the case where msgstr contains square brackets, the parsed index value would always be 0.

Example:

msgctxt "NAME OF BUTTON MERCHANTS CAN CLICK TO DOWNLOAD ALL THEIR PRODUCTS AS AN CSV "
"FILE. INCLUDED IS THE NAME OF THE WAREHOUSE AND THE NUMBER OF ROWS THAT WILL "
"BE IN THE FILE."
msgid "Download CSV [{%2=warehouse name}] ({%1=number of products} row)"
msgid_plural "Download CSV [{%2=warehouse name}] ({%1=number of products} rows)"
msgstr	[0] "Baix[1]ar CSV [{%2=warehouse name}] ({%1=number of products} linha)"
msgstr		[1] "Baix[2]ar CSV [{%2=warehouse name}] ({%1=number of products} linhas)"

The expected length of Message.MsgStrPlural should be 2 but the actual result is 1 because the message contains square brackets.