README
¶
INI
INI data parse by golang. INI config data management tool library.
Features
- Easy to use(get:
IntInt64BoolStringStringMap..., set:Set) - Support multi file, data load
- Support data override merge
- Support parse ENV variable
- Complete unit test(coverage > 90%)
- Support variable reference, default compatible with Python's configParser format
%(VAR)s
More formats
If you want more support for file content formats, recommended use gookit/config
- gookit/config - Support multi formats:
JSON(default),INI,YAML,TOML,HCL
GoDoc
Install
go get github.com/gookit/ini/v2
Usage
- example data(
testdata/test.ini):
# comments
name = inhere
age = 50
debug = true
hasQuota1 = 'this is val'
hasQuota2 = "this is val1"
can2arr = val0,val1,val2
shell = ${SHELL}
noEnv = ${NotExist|defValue}
nkey = val in default section
; comments
[sec1]
key = val0
some = value
stuff = things
varRef = %(nkey)s
Load data
package main
import (
"github.com/gookit/ini/v2"
)
// go run ./examples/demo.go
func main() {
// config, err := ini.LoadFiles("testdata/tesdt.ini")
// LoadExists will ignore not exists file
err := ini.LoadExists("testdata/test.ini", "not-exist.ini")
if err != nil {
panic(err)
}
// load more, will override prev data by key
err = ini.LoadStrings(`
age = 100
[sec1]
newK = newVal
some = change val
`)
// fmt.Printf("%v\n", config.Data())
}
Read data
- Get integer
age := ini.Int("age")
fmt.Print(age) // 100
- Get bool
val := ini.Bool("debug")
fmt.Print(val) // true
- Get string
name := ini.String("name")
fmt.Print(name) // inhere
- Get section data(string map)
val := ini.StringMap("sec1")
fmt.Println(val)
// map[string]string{"key":"val0", "some":"change val", "stuff":"things", "newK":"newVal"}
- Value is ENV var
value := ini.String("shell")
fmt.Printf("%q", value) // "/bin/zsh"
- Get value by key path
value := ini.String("sec1.key")
fmt.Print(value) // val0
- Use var refer
value := ini.String("sec1.varRef")
fmt.Printf("%q", value) // "val in default section"
- Setting new value
// set value
ini.Set("name", "new name")
name = ini.String("name")
fmt.Printf("%q", value) // "new name"
Variable reference resolution
[portal]
url = http://%(host)s:%(port)s/api
host = localhost
port = 8080
If variable resolution is enabled，will parse %(host)s and replace it：
cfg := ini.New()
// enable ParseVar
cfg.WithOptions(ini.ParseVar)
fmt.Print(cfg.MustString("portal.url"))
// OUT:
// http://localhost:8080/api
Available options
type Options struct {
// set to read-only mode. default False
Readonly bool
// parse ENV var name. default True
ParseEnv bool
// parse variable reference "%(varName)s". default False
ParseVar bool
// var left open char. default "%("
VarOpen string
// var right close char. default ")s"
VarClose string
// ignore key name case. default False
IgnoreCase bool
// default section name. default "__default"
DefSection string
// sep char for split key path. default ".", use like "section.subKey"
SectionSep string
}
- setting options for default instance
ini.WithOptions(ini.ParseEnv,ini.ParseVar)
- setting options with new instance
cfg := ini.New()
cfg.WithOptions(ini.ParseEnv,ini.ParseVar, func (opts *Options) {
opts.SectionSep = ":"
opts.DefSection = "default"
})
Tests
- go tests with cover
go test ./... -cover
- run lint by GoLint
golint ./...
Refer
- go-ini/ini ini parser and config manage
- dombenson/go-ini ini parser and config manage
License
MIT
Documentation
¶
Overview ¶
Package ini is a ini config file/data manage implement
Source code and other details for the project are available at GitHub:
https://github.com/gookit/ini
INI parser is: https://github.com/gookit/ini/parser
Example ¶
// config, err := LoadFiles("testdata/tesdt.ini")
// LoadExists will ignore not exists file
err := ini.LoadExists("testdata/test.ini", "not-exist.ini")
if err != nil {
panic(err)
}
config := ini.Default()
// load more, will override prev data by key
_ = config.LoadStrings(`
age = 100
[sec1]
newK = newVal
some = change val
`)
// fmt.Printf("%v\n", config.Data())
iv := config.Int("age")
fmt.Printf("get int\n - val: %v\n", iv)
bv := config.Bool("debug")
fmt.Printf("get bool\n - val: %v\n", bv)
name := config.String("name")
fmt.Printf("get string\n - val: %v\n", name)
sec1 := config.StringMap("sec1")
fmt.Printf("get section\n - val: %#v\n", sec1)
str := config.String("sec1.key")
fmt.Printf("get sub-value by path 'section.key'\n - val: %s\n", str)
// can parse env name(ParseEnv: true)
fmt.Printf("get env 'envKey' val: %s\n", config.String("shell"))
fmt.Printf("get env 'envKey1' val: %s\n", config.String("noEnv"))
// set value
_ = config.Set("name", "new name")
name = config.String("name")
fmt.Printf("set string\n - val: %v\n", name)
// export data to file
// _, err = config.WriteToFile("testdata/export.ini")
// if err != nil {
// panic(err)
// }
// Out:
// get int
// - val: 100
// get bool
// - val: true
// get string
// - val: inhere
// get section
// - val: map[string]string{"stuff":"things", "newK":"newVal", "key":"val0", "some":"change val"}
// get sub-value by path 'section.key'
// - val: val0
// get env 'envKey' val: /bin/zsh
// get env 'envKey1' val: defValue
// set string
// - val: new name
Output:
Index ¶
- Constants
- func Bool(key string, defVal ...bool) bool
- func Data() map[string]Section
- func Delete(key string) bool
- func Error() error
- func Get(key string, defVal ...string) string
- func GetValue(key string) (string, bool)
- func HasKey(key string) bool
- func IgnoreCase(opts *Options)
- func Int(key string, defVal ...int) int
- func Int64(key string, defVal ...int64) int64
- func IsEmpty() bool
- func LoadData(data map[string]Section) error
- func LoadExists(files ...string) error
- func LoadFiles(files ...string) error
- func LoadStrings(strings ...string) error
- func ParseEnv(opts *Options)
- func ParseVar(opts *Options)
- func Readonly(opts *Options)
- func Reset()
- func SectionKeys(withDefaultSection bool) (ls []string)
- func Set(key string, val interface{}, section ...string) error
- func String(key string, defVal ...string) string
- func StringMap(name string) map[string]string
- func Strings(key string, sep ...string) []string
- func Uint(key string, defVal ...uint) uint
- func WithOptions(opts ...func(*Options))
- type Ini
- func (c *Ini) Bool(key string, defVal ...bool) (value bool)
- func (c *Ini) Data() map[string]Section
- func (c *Ini) DefSection() string
- func (c *Ini) DelSection(name string) (ok bool)
- func (c *Ini) Delete(key string) (ok bool)
- func (c *Ini) Error() error
- func (c *Ini) Get(key string, defVal ...string) string
- func (c *Ini) GetValue(key string) (val string, ok bool)
- func (c *Ini) HasKey(key string) (ok bool)
- func (c *Ini) HasSection(name string) bool
- func (c *Ini) Int(key string, defVal ...int) (value int)
- func (c *Ini) Int64(key string, defVal ...int64) (value int64)
- func (c *Ini) IsEmpty() bool
- func (c *Ini) LoadData(data map[string]Section) (err error)
- func (c *Ini) LoadExists(files ...string) (err error)
- func (c *Ini) LoadFiles(files ...string) (err error)
- func (c *Ini) LoadStrings(strings ...string) (err error)
- func (c *Ini) MapTo(ptr interface{}) error
- func (c *Ini) NewSection(name string, values map[string]string) (err error)
- func (c *Ini) Options() Options
- func (c *Ini) PrettyJSON() string
- func (c *Ini) Reset()
- func (c *Ini) Section(name string) Section
- func (c *Ini) SectionKeys(withDefaultSection bool) (ls []string)
- func (c *Ini) Set(key string, val interface{}, section ...string) (err error)
- func (c *Ini) SetSection(name string, values map[string]string) (err error)
- func (c *Ini) String(key string, defVal ...string) string
- func (c *Ini) StringMap(name string) (mp map[string]string)
- func (c *Ini) Strings(key string, sep ...string) (ss []string)
- func (c *Ini) Uint(key string, defVal ...uint) (value uint)
- func (c *Ini) WithOptions(opts ...func(*Options))
- func (c *Ini) WriteTo(out io.Writer) (n int64, err error)
- func (c *Ini) WriteToFile(file string) (int64, error)
- type Options
- type Section
Examples ¶
Constants ¶
View Source
const ( SepSection = "." DefSection = "__default" )
some default constants
Variables ¶
This section is empty.
Functions ¶
func GetValue ¶
GetValue get a value by key string. you can use '.' split for get value in a special section
func LoadExists ¶
LoadExists load files, will ignore not exists
func ParseEnv ¶
func ParseEnv(opts *Options)
ParseEnv will parse ENV key on get value Usage:
ini.WithOptions(ini.ParseEnv)
func ParseVar ¶
func ParseVar(opts *Options)
ParseVar on get value Usage:
ini.WithOptions(ini.ParseVar)
func Readonly ¶
func Readonly(opts *Options)
Readonly setting Usage: ini.NewWithOptions(ini.Readonly)
func SectionKeys ¶ added in v2.0.3
SectionKeys get all section names
Types ¶
type Ini ¶
type Ini struct {
// contains filtered or unexported fields
}
Ini config data manager
func NewWithOptions ¶
NewWithOptions new a instance and with some options Usage: ini.NewWithOptions(ini.ParseEnv, ini.Readonly)
func (*Ini) Bool ¶
Bool Looks up a value for a key in this section and attempts to parse that value as a boolean, along with a boolean result similar to a map lookup. of following(case insensitive):
- true
- false
- yes
- no
- off
- on
- 0
- 1
The `ok` boolean will be false in the event that the value could not be parsed as a bool
func (*Ini) DelSection ¶
DelSection del section by name
func (*Ini) Get ¶
Get a value by key string. you can use '.' split for get value in a special section
func (*Ini) GetValue ¶
GetValue a value by key string. you can use '.' split for get value in a special section
func (*Ini) LoadExists ¶
LoadExists load files, will ignore not exists
func (*Ini) LoadStrings ¶
LoadStrings load data from strings
func (*Ini) NewSection ¶
NewSection add new section data, existed will be replace
func (*Ini) Options ¶
Options get options info. Notice: return is value. so, cannot change Ini instance
func (*Ini) PrettyJSON ¶
PrettyJSON translate to pretty JSON string
func (*Ini) SectionKeys ¶ added in v2.0.3
SectionKeys get all section names
func (*Ini) Set ¶
Set a value to the section by key. if section is empty, will set to default section
func (*Ini) SetSection ¶
SetSection if not exist, add new section. If exist, will merge to old section.
func (*Ini) WithOptions ¶
WithOptions apply some options
type Options ¶
type Options struct {
// Readonly set to read-only mode. default False
Readonly bool
// ParseEnv parse ENV var name. default True
ParseEnv bool
// ParseVar parse variable reference "%(varName)s". default False
ParseVar bool
// VarOpen var left open char. default "%("
VarOpen string
// VarClose var right close char. default ")s"
VarClose string
// IgnoreCase ignore key name case. default False
IgnoreCase bool
// DefSection default section name. default "__default", it's allow empty string.
DefSection string
// SectionSep sep char for split key path. default ".", use like "section.subKey"
SectionSep string
}
Options for config
func GetOptions ¶ added in v2.0.3
func GetOptions() Options
GetOptions get options info. Notice: return is value. so, cannot change Ini instance
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
Package parser is a Parser for parse INI format content to golang data There are example data: # comments name = inhere age = 28 debug = true hasQuota1 = 'this is val' hasQuota2 = "this is val1" shell = ${SHELL} noEnv = ${NotExist|defValue} ; array in def section tags[] = a tags[] = b tags[] = c ; comments [sec1] key = val0 some = value stuff = things ; array in section types[] = x types[] = y how to use, please see examples:
|
Package parser is a Parser for parse INI format content to golang data There are example data: # comments name = inhere age = 28 debug = true hasQuota1 = 'this is val' hasQuota2 = "this is val1" shell = ${SHELL} noEnv = ${NotExist|defValue} ; array in def section tags[] = a tags[] = b tags[] = c ; comments [sec1] key = val0 some = value stuff = things ; array in section types[] = x types[] = y how to use, please see examples: |
Click to show internal directories.
Click to hide internal directories.