Google Git
Sign in
edge / third_party / go-yaml / yaml / 14227de293ca979cf205cd88769fe71ed96a97e2
commit14227de293ca979cf205cd88769fe71ed96a97e2[log] [tgz]
authorJoe Tsai <joetsai@digital-static.net>Tue Jan 24 08:25:11 2017 -0800
committerGustavo Niemeyer <gustavo@niemeyer.net>Tue Jan 24 14:25:11 2017 -0200
tree1bf2a34d3fea48b0d0dc46e4c6bb37210b3de245
parenta5b47d31c556af34a302ce5d659e6fea44d90de0 [diff]
Fix decode test for Go 1.8 (#217)

An upstream change (http://golang.org/cl/31144) alters the time package
to be more consistent about the representation of UTC location.
We adjust the time.Time used in the test to work on both 1.7 and 1.8.
1 file changed
tree: 1bf2a34d3fea48b0d0dc46e4c6bb37210b3de245
  1. .travis.yml
  2. apic.go
  3. decode.go
  4. decode_test.go
  5. emitterc.go
  6. encode.go
  7. encode_test.go
  8. LICENSE
  9. LICENSE.libyaml
  10. parserc.go
  11. readerc.go
  12. README.md
  13. resolve.go
  14. scannerc.go
  15. sorter.go
  16. suite_test.go
  17. writerc.go
  18. yaml.go
  19. yamlh.go
  20. yamlprivateh.go
README.md

YAML support for the Go language

Introduction

The yaml package enables Go programs to comfortably encode and decode YAML values. It was developed within Canonical as part of the juju project, and is based on a pure Go port of the well-known libyaml C library to parse and generate YAML data quickly and reliably.

Compatibility

The yaml package supports most of YAML 1.1 and 1.2, including support for anchors, tags, map merging, etc. Multi-document unmarshalling is not yet implemented, and base-60 floats from YAML 1.1 are purposefully not supported since they're a poor design and are gone in YAML 1.2.

Installation and usage

The import path for the package is gopkg.in/yaml.v2.

To install it, run:

go get gopkg.in/yaml.v2

API documentation

If opened in a browser, the import path itself leads to the API documentation:

API stability

The package API for yaml v2 will remain stable as described in gopkg.in.

License

The yaml package is licensed under the Apache License 2.0. Please see the LICENSE file for details.

Example

package main

import (
        "fmt"
        "log"

        "gopkg.in/yaml.v2"
)

var data = `
a: Easy!
b:
  c: 2
  d: [3, 4]
`

type T struct {
        A string
        B struct {
                RenamedC int   `yaml:"c"`
                D        []int `yaml:",flow"`
        }
}

func main() {
        t := T{}
    
        err := yaml.Unmarshal([]byte(data), &t)
        if err != nil {
                log.Fatalf("error: %v", err)
        }
        fmt.Printf("--- t:\n%v\n\n", t)
    
        d, err := yaml.Marshal(&t)
        if err != nil {
                log.Fatalf("error: %v", err)
        }
        fmt.Printf("--- t dump:\n%s\n\n", string(d))
    
        m := make(map[interface{}]interface{})
    
        err = yaml.Unmarshal([]byte(data), &m)
        if err != nil {
                log.Fatalf("error: %v", err)
        }
        fmt.Printf("--- m:\n%v\n\n", m)
    
        d, err = yaml.Marshal(&m)
        if err != nil {
                log.Fatalf("error: %v", err)
        }
        fmt.Printf("--- m dump:\n%s\n\n", string(d))
}

This example will generate the following output:

--- t:
{Easy! {2 [3 4]}}

--- t dump:
a: Easy!
b:
  c: 2
  d: [3, 4]


--- m:
map[a:Easy! b:map[c:2 d:[3 4]]]

--- m dump:
a: Easy!
b:
  c: 2
  d:
  - 3
  - 4