load

This is the main module you should interface with if wanting to load an entire CoNLL file, rather than individual sentences which should be less common. The API allows for loading CoNLL data from a string or from a file, and allows for iteration over the data, rather than storing a large CoNLL object in memory if so desired.

Note that the fully qualified name is pyconll.load, but these methods can also be accessed using the pyconll namespace.

Example

This example counts the number of times a token with a lemma of linguistic appeared in the treebank. Note that if all the operations that will be done on the CoNLL file are readonly, consider using the iter_from alternatives. These methods will return an iterator over each sentence in the CoNLL file rather than storing an entire CoNLL object in memory, which can be convenient when dealing with large files that do not need to persist.

import pyconll

example_treebank = '/home/myuser/englishdata.conll'
conll = pyconll.iter_from_file(example_treebank)

count = 0
for sentence in conll:
    for word in sentence:
        if word.lemma == 'linguistic':
            count += 1

print(count)

API

pyconll.load.iter_from_file(filename)

Iterate over a CoNLL-U file’s sentences.

Parameters:

filename – The name of the file whose sentences should be iterated over.

Yields:

The sentences that make up the CoNLL-U file.

Raises:

• IOError if there is an error opening the file.
• ParseError – If there is an error parsing the input into a Conll object.

pyconll.load.iter_from_string(source)

Iterate over a CoNLL-U string’s sentences.

Use this method if you only need to iterate over the CoNLL-U file once and do not need to create or store the Conll object.

Parameters:source – The CoNLL-U string. Yields:The sentences that make up the CoNLL-U file. Raises:ParseError – If there is an error parsing the input into a Conll object.

pyconll.load.iter_from_url(url)

Iterate over a CoNLL-U file that is pointed to by a given URL.

Parameters:

url – The URL that points to the CoNLL-U file.

Yields:

The sentences that make up the CoNLL-U file.

Raises:

• requests.exceptions.RequestException – If the url was unable to be properly retrieved.
• ParseError – If there is an error parsing the input into a Conll object.

pyconll.load.load_from_file(filename)

Load a CoNLL-U file given the filename where it resides.

Parameters:

filename – The location of the file.

Returns:

A Conll object equivalent to the provided file.

Raises:

• IOError – If there is an error opening the given filename.
• ParseError – If there is an error parsing the input into a Conll object.

pyconll.load.load_from_string(source)

Load CoNLL-U source in a string into a Conll object.

Parameters:source – The CoNLL-U formatted string. Returns:A Conll object equivalent to the provided source. Raises:ParseError – If there is an error parsing the input into a Conll object.

pyconll.load.load_from_url(url)

Load a CoNLL-U file that is pointed to by a given URL.

Parameters:

url – The URL that points to the CoNLL-U file.

Returns:

A Conll object equivalent to the provided file.

Raises:

• requests.exceptions.RequestException – If the url was unable to be properly retrieved and status was 4xx or 5xx.
• ParseError – If there is an error parsing the input into a Conll object.