goquery: github.com/PuerkitoBio/goquery Index | Files

package goquery

import "github.com/PuerkitoBio/goquery"

Package goquery implements features similar to jQuery, including the chainable syntax, to manipulate and query an HTML document.

GoQuery brings a syntax and a set of features similar to jQuery to the Go language. It is based on Go's net/html package and the CSS Selector library cascadia. Since the net/html parser returns tokens (nodes), and not a full-featured DOM object, jQuery's manipulation and modification functions have been left off (no point in modifying data in the parsed tree of the HTML, it has no effect).

Also, because the net/html parser requires UTF-8 encoding, so does goquery: it is the caller's responsibility to ensure that the source document provides UTF-8 encoded HTML.

Supported functions are query-oriented features (`hasClass()`, `attr()` and the likes), as well as traversing functions that make sense given what we have to work with. This makes GoQuery a great library for scraping web pages.

Syntax-wise, it is as close as possible to jQuery, with the same function names when possible, and that warm and fuzzy chainable interface. jQuery being the ultra-popular library that it is, I felt that writing a similar HTML-manipulating library was better to follow its API than to start anew (in the same spirit as Go's fmt package), even though some of its methods are less than intuitive (looking at you, index()...).

It is hosted on GitHub, along with additional documentation in the README.md file: https://github.com/puerkitobio/goquery

Please note that because of the net/html dependency, goquery requires Go1.1+.

The various methods are split into files based on the category of behavior:

* array.go : array-like positional manipulation of the selection.

- Eq()
- First()
- Get()
- Index...()
- Last()
- Slice()

* expand.go : methods that expand or augment the selection's set.

- Add...()
- AndSelf()
- Union(), which is an alias for AddSelection()

* filter.go : filtering methods, that reduce the selection's set.

- End()
- Filter...()
- Has...()
- Intersection(), which is an alias of FilterSelection()
- Not...()

* iteration.go : methods to loop over the selection's nodes.

- Each()
- EachWithBreak()
- Map()

* property.go : methods that inspect and get the node's properties values.

- Attr()
- Html()
- Length()
- Size(), which is an alias for Length()
- Text()

* query.go : methods that query, or reflect, a node's identity.

- Contains()
- HasClass()
- Is...()

* traversal.go : methods to traverse the HTML document tree.

- Children...()
- Contents()
- Find...()
- Next...()
- Parent[s]...()
- Prev...()
- Siblings...()

* type.go : definition of the types exposed by GoQuery.

- Document
- Selection

Index

Package Files

array.go doc.go expand.go filter.go iteration.go property.go query.go traversal.go type.go utilities.go

type Document

type Document struct {
    *Selection
    Url *url.URL
    // contains filtered or unexported fields
}

Document represents an HTML document to be manipulated. Unlike jQuery, which is loaded as part of a DOM document, and thus acts upon its containing document, GoQuery doesn't know which HTML document to act upon. So it needs to be told, and that's what the Document class is for. It holds the root document node to manipulate, and can make selections on this document.

func NewDocument

func NewDocument(url string) (*Document, error)

NewDocument is a Document constructor that takes a string URL as argument. It loads the specified document, parses it, and stores the root Document node, ready to be manipulated.

func NewDocumentFromNode

func NewDocumentFromNode(root *html.Node) *Document

NewDocumentFromNode is a Document constructor that takes a root html Node as argument.

func NewDocumentFromReader

func NewDocumentFromReader(r io.Reader) (*Document, error)

NewDocumentFromReader returns a Document from a generic reader. It returns an error as second value if the reader's data cannot be parsed as html. It does *not* check if the reader is also an io.Closer, so the provided reader is never closed by this call, it is the responsibility of the caller to close it if required.

func NewDocumentFromResponse

func NewDocumentFromResponse(res *http.Response) (*Document, error)

NewDocumentFromResponse is another Document constructor that takes an http resonse as argument. It loads the specified response's document, parses it, and stores the root Document node, ready to be manipulated. The response's body is closed on return.

type Selection

type Selection struct {
    Nodes []*html.Node
    // contains filtered or unexported fields
}

Selection represents a collection of nodes matching some criteria. The initial Selection can be created by using Document.Find, and then manipulated using the jQuery-like chainable syntax and methods.

func (*Selection) Add

func (s *Selection) Add(selector string) *Selection

Add adds the selector string's matching nodes to those in the current selection and returns a new Selection object. The selector string is run in the context of the document of the current Selection object.

func (*Selection) AddNodes

func (s *Selection) AddNodes(nodes ...*html.Node) *Selection

AddNodes adds the specified nodes to those in the current selection and returns a new Selection object.

func (*Selection) AddSelection

func (s *Selection) AddSelection(sel *Selection) *Selection

AddSelection adds the specified Selection object's nodes to those in the current selection and returns a new Selection object.

func (*Selection) AndSelf

func (s *Selection) AndSelf() *Selection

AndSelf adds the previous set of elements on the stack to the current set. It returns a new Selection object containing the current Selection combined with the previous one.

func (*Selection) Attr

func (s *Selection) Attr(attrName string) (val string, exists bool)

Attr gets the specified attribute's value for the first element in the Selection. To get the value for each element individually, use a looping construct such as Each or Map method.

func (*Selection) Children

func (s *Selection) Children() *Selection

Children gets the child elements of each element in the Selection. It returns a new Selection object containing these elements.

func (*Selection) ChildrenFiltered

func (s *Selection) ChildrenFiltered(selector string) *Selection

ChildrenFiltered gets the child elements of each element in the Selection, filtered by the specified selector. It returns a new Selection object containing these elements.

func (*Selection) Closest

func (s *Selection) Closest(selector string) *Selection

Closest gets the first element that matches the selector by testing the element itself and traversing up through its ancestors in the DOM tree.

func (*Selection) ClosestNodes

func (s *Selection) ClosestNodes(nodes ...*html.Node) *Selection

ClosestNodes gets the first element that matches one of the nodes by testing the element itself and traversing up through its ancestors in the DOM tree.

func (*Selection) ClosestSelection

func (s *Selection) ClosestSelection(sel *Selection) *Selection

ClosestSelection gets the first element that matches one of the nodes in the Selection by testing the element itself and traversing up through its ancestors in the DOM tree.

func (*Selection) Contains

func (s *Selection) Contains(n *html.Node) bool

Contains returns true if the specified Node is within, at any depth, one of the nodes in the Selection object. It is NOT inclusive, to behave like jQuery's implementation, and unlike Javascript's .contains, so if the contained node is itself in the selection, it returns false.

func (*Selection) Contents

func (s *Selection) Contents() *Selection

Contents gets the children of each element in the Selection, including text and comment nodes. It returns a new Selection object containing these elements.

func (*Selection) ContentsFiltered

func (s *Selection) ContentsFiltered(selector string) *Selection

ContentsFiltered gets the children of each element in the Selection, filtered by the specified selector. It returns a new Selection object containing these elements. Since selectors only act on Element nodes, this function is an alias to ChildrenFiltered unless the selector is empty, in which case it is an alias to Contents.

func (*Selection) Each

func (s *Selection) Each(f func(int, *Selection)) *Selection

Each iterates over a Selection object, executing a function for each matched element. It returns the current Selection object.

func (*Selection) EachWithBreak

func (s *Selection) EachWithBreak(f func(int, *Selection) bool) *Selection

EachWithBreak iterates over a Selection object, executing a function for each matched element. It is identical to Each except that it is possible to break out of the loop by returning false in the callback function. It returns the current Selection object.

func (*Selection) End

func (s *Selection) End() *Selection

End ends the most recent filtering operation in the current chain and returns the set of matched elements to its previous state.

func (*Selection) Eq

func (s *Selection) Eq(index int) *Selection

Eq reduces the set of matched elements to the one at the specified index. If a negative index is given, it counts backwards starting at the end of the set. It returns a new Selection object, and an empty Selection object if the index is invalid.

func (*Selection) Filter

func (s *Selection) Filter(selector string) *Selection

Filter reduces the set of matched elements to those that match the selector string. It returns a new Selection object for this subset of matching elements.

func (*Selection) FilterFunction

func (s *Selection) FilterFunction(f func(int, *Selection) bool) *Selection

FilterFunction reduces the set of matched elements to those that pass the function's test. It returns a new Selection object for this subset of elements.

func (*Selection) FilterNodes

func (s *Selection) FilterNodes(nodes ...*html.Node) *Selection

FilterNodes reduces the set of matched elements to those that match the specified nodes. It returns a new Selection object for this subset of elements.

func (*Selection) FilterSelection

func (s *Selection) FilterSelection(sel *Selection) *Selection

FilterSelection reduces the set of matched elements to those that match a node in the specified Selection object. It returns a new Selection object for this subset of elements.

func (*Selection) Find

func (s *Selection) Find(selector string) *Selection

Find gets the descendants of each element in the current set of matched elements, filtered by a selector. It returns a new Selection object containing these matched elements.

func (*Selection) FindNodes

func (s *Selection) FindNodes(nodes ...*html.Node) *Selection

FindNodes gets the descendants of each element in the current Selection, filtered by some nodes. It returns a new Selection object containing these matched elements.

func (*Selection) FindSelection

func (s *Selection) FindSelection(sel *Selection) *Selection

FindSelection gets the descendants of each element in the current Selection, filtered by a Selection. It returns a new Selection object containing these matched elements.

func (*Selection) First

func (s *Selection) First() *Selection

First reduces the set of matched elements to the first in the set. It returns a new Selection object, and an empty Selection object if the the selection is empty.

func (*Selection) Get

func (s *Selection) Get(index int) *html.Node

Get retrieves the underlying node at the specified index. Get without parameter is not implemented, since the node array is available on the Selection object.

func (*Selection) Has

func (s *Selection) Has(selector string) *Selection

Has reduces the set of matched elements to those that have a descendant that matches the selector. It returns a new Selection object with the matching elements.

func (*Selection) HasClass

func (s *Selection) HasClass(class string) bool

HasClass determines whether any of the matched elements are assigned the given class.

func (*Selection) HasNodes

func (s *Selection) HasNodes(nodes ...*html.Node) *Selection

HasNodes reduces the set of matched elements to those that have a descendant that matches one of the nodes. It returns a new Selection object with the matching elements.

func (*Selection) HasSelection

func (s *Selection) HasSelection(sel *Selection) *Selection

HasSelection reduces the set of matched elements to those that have a descendant that matches one of the nodes of the specified Selection object. It returns a new Selection object with the matching elements.

func (*Selection) Html

func (s *Selection) Html() (ret string, e error)

Html gets the HTML contents of the first element in the set of matched elements. It includes text and comment nodes.

func (*Selection) Index

func (s *Selection) Index() int

Index returns the position of the first element within the Selection object relative to its sibling elements.

func (*Selection) IndexOfNode

func (s *Selection) IndexOfNode(node *html.Node) int

IndexOfNode returns the position of the specified node within the Selection object, or -1 if not found.

func (*Selection) IndexOfSelection

func (s *Selection) IndexOfSelection(sel *Selection) int

IndexOfSelection returns the position of the first node in the specified Selection object within this Selection object, or -1 if not found.

func (*Selection) IndexSelector

func (s *Selection) IndexSelector(selector string) int

IndexSelector returns the position of the first element within the Selection object relative to the elements matched by the selector, or -1 if not found.

func (*Selection) Intersection

func (s *Selection) Intersection(sel *Selection) *Selection

Intersection is an alias for FilterSelection.

func (*Selection) Is

func (s *Selection) Is(selector string) bool

Is checks the current matched set of elements against a selector and returns true if at least one of these elements matches.

func (*Selection) IsFunction

func (s *Selection) IsFunction(f func(int, *Selection) bool) bool

IsFunction checks the current matched set of elements against a predicate and returns true if at least one of these elements matches.

func (*Selection) IsNodes

func (s *Selection) IsNodes(nodes ...*html.Node) bool

IsNodes checks the current matched set of elements against the specified nodes and returns true if at least one of these elements matches.

func (*Selection) IsSelection

func (s *Selection) IsSelection(sel *Selection) bool

IsSelection checks the current matched set of elements against a Selection object and returns true if at least one of these elements matches.

func (*Selection) Last

func (s *Selection) Last() *Selection

Last reduces the set of matched elements to the last in the set. It returns a new Selection object, and an empty Selection object if the selection is empty.

func (*Selection) Length

func (s *Selection) Length() int

Length returns the number of elements in the Selection object.

func (*Selection) Map

func (s *Selection) Map(f func(int, *Selection) string) (result []string)

Map passes each element in the current matched set through a function, producing a slice of string holding the returned values.

func (*Selection) Next

func (s *Selection) Next() *Selection

Next gets the immediately following sibling of each element in the Selection. It returns a new Selection object containing the matched elements.

func (*Selection) NextAll

func (s *Selection) NextAll() *Selection

NextAll gets all the following siblings of each element in the Selection. It returns a new Selection object containing the matched elements.

func (*Selection) NextAllFiltered

func (s *Selection) NextAllFiltered(selector string) *Selection

NextAllFiltered gets all the following siblings of each element in the Selection filtered by a selector. It returns a new Selection object containing the matched elements.

func (*Selection) NextFiltered

func (s *Selection) NextFiltered(selector string) *Selection

NextFiltered gets the immediately following sibling of each element in the Selection filtered by a selector. It returns a new Selection object containing the matched elements.

func (*Selection) NextFilteredUntil

func (s *Selection) NextFilteredUntil(filterSelector string, untilSelector string) *Selection

NextFilteredUntil is like NextUntil, with the option to filter the results based on a selector string. It returns a new Selection object containing the matched elements.

func (*Selection) NextFilteredUntilNodes

func (s *Selection) NextFilteredUntilNodes(filterSelector string, nodes ...*html.Node) *Selection

NextFilteredUntilNodes is like NextUntilNodes, with the option to filter the results based on a selector string. It returns a new Selection object containing the matched elements.

func (*Selection) NextFilteredUntilSelection

func (s *Selection) NextFilteredUntilSelection(filterSelector string, sel *Selection) *Selection

NextFilteredUntilSelection is like NextUntilSelection, with the option to filter the results based on a selector string. It returns a new Selection object containing the matched elements.

func (*Selection) NextUntil

func (s *Selection) NextUntil(selector string) *Selection

NextUntil gets all following siblings of each element up to but not including the element matched by the selector. It returns a new Selection object containing the matched elements.

func (*Selection) NextUntilNodes

func (s *Selection) NextUntilNodes(nodes ...*html.Node) *Selection

NextUntilNodes gets all following siblings of each element up to but not including the element matched by the nodes. It returns a new Selection object containing the matched elements.

func (*Selection) NextUntilSelection

func (s *Selection) NextUntilSelection(sel *Selection) *Selection

NextUntilSelection gets all following siblings of each element up to but not including the element matched by the Selection. It returns a new Selection object containing the matched elements.

func (*Selection) Not

func (s *Selection) Not(selector string) *Selection

Not removes elements from the Selection that match the selector string. It returns a new Selection object with the matching elements removed.

func (*Selection) NotFunction

func (s *Selection) NotFunction(f func(int, *Selection) bool) *Selection

NotFunction removes elements from the Selection that pass the function's test. It returns a new Selection object with the matching elements removed.

func (*Selection) NotNodes

func (s *Selection) NotNodes(nodes ...*html.Node) *Selection

NotNodes removes elements from the Selection that match the specified nodes. It returns a new Selection object with the matching elements removed.

func (*Selection) NotSelection

func (s *Selection) NotSelection(sel *Selection) *Selection

NotSelection removes elements from the Selection that match a node in the specified Selection object. It returns a new Selection object with the matching elements removed.

func (*Selection) Parent

func (s *Selection) Parent() *Selection

Parent gets the parent of each element in the Selection. It returns a new Selection object containing the matched elements.

func (*Selection) ParentFiltered

func (s *Selection) ParentFiltered(selector string) *Selection

ParentFiltered gets the parent of each element in the Selection filtered by a selector. It returns a new Selection object containing the matched elements.

func (*Selection) Parents

func (s *Selection) Parents() *Selection

Parents gets the ancestors of each element in the current Selection. It returns a new Selection object with the matched elements.

func (*Selection) ParentsFiltered

func (s *Selection) ParentsFiltered(selector string) *Selection

ParentsFiltered gets the ancestors of each element in the current Selection. It returns a new Selection object with the matched elements.

func (*Selection) ParentsFilteredUntil

func (s *Selection) ParentsFilteredUntil(filterSelector string, untilSelector string) *Selection

ParentsFilteredUntil is like ParentsUntil, with the option to filter the results based on a selector string. It returns a new Selection object containing the matched elements.

func (*Selection) ParentsFilteredUntilNodes

func (s *Selection) ParentsFilteredUntilNodes(filterSelector string, nodes ...*html.Node) *Selection

ParentsFilteredUntilNodes is like ParentsUntilNodes, with the option to filter the results based on a selector string. It returns a new Selection object containing the matched elements.

func (*Selection) ParentsFilteredUntilSelection

func (s *Selection) ParentsFilteredUntilSelection(filterSelector string, sel *Selection) *Selection

ParentsFilteredUntilSelection is like ParentsUntilSelection, with the option to filter the results based on a selector string. It returns a new Selection object containing the matched elements.

func (*Selection) ParentsUntil

func (s *Selection) ParentsUntil(selector string) *Selection

ParentsUntil gets the ancestors of each element in the Selection, up to but not including the element matched by the selector. It returns a new Selection object containing the matched elements.

func (*Selection) ParentsUntilNodes

func (s *Selection) ParentsUntilNodes(nodes ...*html.Node) *Selection

ParentsUntilNodes gets the ancestors of each element in the Selection, up to but not including the specified nodes. It returns a new Selection object containing the matched elements.

func (*Selection) ParentsUntilSelection

func (s *Selection) ParentsUntilSelection(sel *Selection) *Selection

ParentsUntilSelection gets the ancestors of each element in the Selection, up to but not including the elements in the specified Selection. It returns a new Selection object containing the matched elements.

func (*Selection) Prev

func (s *Selection) Prev() *Selection

Prev gets the immediately preceding sibling of each element in the Selection. It returns a new Selection object containing the matched elements.

func (*Selection) PrevAll

func (s *Selection) PrevAll() *Selection

PrevAll gets all the preceding siblings of each element in the Selection. It returns a new Selection object containing the matched elements.

func (*Selection) PrevAllFiltered

func (s *Selection) PrevAllFiltered(selector string) *Selection

PrevAllFiltered gets all the preceding siblings of each element in the Selection filtered by a selector. It returns a new Selection object containing the matched elements.

func (*Selection) PrevFiltered

func (s *Selection) PrevFiltered(selector string) *Selection

PrevFiltered gets the immediately preceding sibling of each element in the Selection filtered by a selector. It returns a new Selection object containing the matched elements.

func (*Selection) PrevFilteredUntil

func (s *Selection) PrevFilteredUntil(filterSelector string, untilSelector string) *Selection

PrevFilteredUntil is like PrevUntil, with the option to filter the results based on a selector string. It returns a new Selection object containing the matched elements.

func (*Selection) PrevFilteredUntilNodes

func (s *Selection) PrevFilteredUntilNodes(filterSelector string, nodes ...*html.Node) *Selection

PrevFilteredUntilNodes is like PrevUntilNodes, with the option to filter the results based on a selector string. It returns a new Selection object containing the matched elements.

func (*Selection) PrevFilteredUntilSelection

func (s *Selection) PrevFilteredUntilSelection(filterSelector string, sel *Selection) *Selection

PrevFilteredUntilSelection is like PrevUntilSelection, with the option to filter the results based on a selector string. It returns a new Selection object containing the matched elements.

func (*Selection) PrevUntil

func (s *Selection) PrevUntil(selector string) *Selection

PrevUntil gets all preceding siblings of each element up to but not including the element matched by the selector. It returns a new Selection object containing the matched elements.

func (*Selection) PrevUntilNodes

func (s *Selection) PrevUntilNodes(nodes ...*html.Node) *Selection

PrevUntilNodes gets all preceding siblings of each element up to but not including the element matched by the nodes. It returns a new Selection object containing the matched elements.

func (*Selection) PrevUntilSelection

func (s *Selection) PrevUntilSelection(sel *Selection) *Selection

PrevUntilSelection gets all preceding siblings of each element up to but not including the element matched by the Selection. It returns a new Selection object containing the matched elements.

func (*Selection) Siblings

func (s *Selection) Siblings() *Selection

Siblings gets the siblings of each element in the Selection. It returns a new Selection object containing the matched elements.

func (*Selection) SiblingsFiltered

func (s *Selection) SiblingsFiltered(selector string) *Selection

SiblingsFiltered gets the siblings of each element in the Selection filtered by a selector. It returns a new Selection object containing the matched elements.

func (*Selection) Size

func (s *Selection) Size() int

Size is an alias for Length.

func (*Selection) Slice

func (s *Selection) Slice(start int, end int) *Selection

Slice reduces the set of matched elements to a subset specified by a range of indices.

func (*Selection) Text

func (s *Selection) Text() string

Text gets the combined text contents of each element in the set of matched elements, including their descendants.

func (*Selection) Union

func (s *Selection) Union(sel *Selection) *Selection

Union is an alias for AddSelection.

Package goquery imports 9 packages (graph) and is imported by 76 packages. Updated 2014-08-18. Refresh now. Tools for package owners.