nltk.corpus.reader.CorpusReader

class documentation

class CorpusReader(object): (source)

Constructor: CorpusReader(root, fileids, encoding, tagset)

View In Hierarchy

A base class for "corpus reader" classes, each of which can be used to read a specific corpus format. Each individual corpus reader instance is used to read a specific corpus, consisting of one or more files under a common root directory. Each file is identified by its file identifier, which is the relative path to the file from the root directory.

A separate subclass is defined for each corpus format. These subclasses define one or more methods that provide 'views' on the corpus contents, such as words() (for a list of words) and parsed_sents() (for a list of parsed sentences). Called with no arguments, these methods will return the contents of the entire corpus. For most corpora, these methods define one or more selection arguments, such as fileids or categories, which can be used to select which portion of the corpus should be returned.

Method	`__init__`	No summary
Method	`__repr__`	Undocumented
Method	`abspath`	Return the absolute path for the given file.
Method	`abspaths`	Return a list of the absolute paths for all fileids in this corpus; or for the given list of fileids, if specified.
Method	`citation`	Return the contents of the corpus citation.bib file, if it exists.
Method	`encoding`	Return the unicode encoding for the given corpus file, if known. If the encoding is unknown, or if the given file should be processed using byte strings (str), then return None.
Method	`ensure_loaded`	Load this corpus (if it has not already been loaded). This is used by LazyCorpusLoader as a simple method that can be used to make sure a corpus is loaded -- e.g., in case a user wants to do help(some_corpus).
Method	`fileids`	Return a list of file identifiers for the fileids that make up this corpus.
Method	`license`	Return the contents of the corpus LICENSE file, if it exists.
Method	`open`	Return an open stream that can be used to read the given file. If the file's encoding is not None, then the stream will automatically decode the file's contents into unicode.
Method	`readme`	Return the contents of the corpus README file, if it exists.
Class Variable	`root`	Undocumented
Method	`_get_root`	Undocumented
Instance Variable	`_encoding`	The default unicode encoding for the fileids that make up this corpus. If `encoding` is None, then the file contents are processed using byte strings.
Instance Variable	`_fileids`	A list of the relative paths for the fileids that make up this corpus.
Instance Variable	`_root`	The root directory for this corpus.
Instance Variable	`_tagset`	Undocumented

def __init__(self, root, fileids, encoding='utf8', tagset=None): (source) ¶

overridden in nltk.corpus.reader.AlignedCorpusReader, nltk.corpus.reader.BracketParseCorpusReader, nltk.corpus.reader.CategorizedSentencesCorpusReader, nltk.corpus.reader.ChasenCorpusReader, nltk.corpus.reader.ChunkedCorpusReader, nltk.corpus.reader.ComparativeSentencesCorpusReader, nltk.corpus.reader.ConllCorpusReader, nltk.corpus.reader.CrubadanCorpusReader, nltk.corpus.reader.DependencyCorpusReader, nltk.corpus.reader.IPIPANCorpusReader, nltk.corpus.reader.KNBCorpusReader, nltk.corpus.reader.LinThesaurusCorpusReader, nltk.corpus.reader.NombankCorpusReader, nltk.corpus.reader.PanLexLiteCorpusReader, nltk.corpus.reader.PanlexSwadeshCorpusReader, nltk.corpus.reader.PlaintextCorpusReader, nltk.corpus.reader.PropbankCorpusReader, nltk.corpus.reader.ProsConsCorpusReader, nltk.corpus.reader.ReviewsCorpusReader, nltk.corpus.reader.SentiWordNetCorpusReader, nltk.corpus.reader.StringCategoryCorpusReader, nltk.corpus.reader.SwitchboardCorpusReader, nltk.corpus.reader.TaggedCorpusReader, nltk.corpus.reader.TimitCorpusReader, nltk.corpus.reader.TwitterCorpusReader, nltk.corpus.reader.WordNetCorpusReader, nltk.corpus.reader.WordNetICCorpusReader, nltk.corpus.reader.XMLCorpusReader, nltk.corpus.reader.YCOECorpusReader

Parameters
root:PathPointer or str	A path pointer identifying the root directory for this corpus. If a string is specified, then it will be converted to a `PathPointer` automatically.
fileids	A list of the files that make up this corpus. This list can either be specified explicitly, as a list of strings; or implicitly, as a regular expression over file paths. The absolute path for each file will be constructed by joining the reader's root to each file name.
encoding	The default unicode encoding for the files that make up the corpus. The value of `encoding` can be any of the following: - A string: `encoding` is the encoding name for all files. - A dictionary: `encoding[file_id]` is the encoding name for the file whose identifier is `file_id`. If `file_id` is not in `encoding`, then the file contents will be processed using non-unicode byte strings. A list: `encoding` should be a list of `(regexp, encoding)` tuples. The encoding for a file whose identifier is `file_id` will be the `encoding` value for the first tuple whose `regexp` matches the `file_id`. If no tuple's `regexp` matches the `file_id`, the file contents will be processed using non-unicode byte strings. None: the file contents of all files will be processed using non-unicode byte strings.
tagset	The name of the tagset used by this corpus, to be used for normalizing or converting the POS tags returned by the tagged_...() methods.

def __repr__(self): (source) ¶

Undocumented

def abspath(self, fileid): (source) ¶

Return the absolute path for the given file.

Parameters
fileid:str	The file identifier for the file whose path should be returned.
Returns
PathPointer	Undocumented

def abspaths(self, fileids=None, include_encoding=False, include_fileid=False): (source) ¶

Return a list of the absolute paths for all fileids in this corpus; or for the given list of fileids, if specified.

Parameters
fileids:None or str or list	Specifies the set of fileids for which paths should be returned. Can be None, for all fileids; a list of file identifiers, for a specified set of fileids; or a single file identifier, for a single file. Note that the return value is always a list of paths, even if `fileids` is a single file identifier.
include_encoding	If true, then return a list of `(path_pointer, encoding)` tuples.
include_fileid	Undocumented
Returns
list(PathPointer)	Undocumented

def citation(self): (source) ¶

overridden in nltk.corpus.reader.WordNetCorpusReader

Return the contents of the corpus citation.bib file, if it exists.

def encoding(self, file): (source) ¶

Return the unicode encoding for the given corpus file, if known. If the encoding is unknown, or if the given file should be processed using byte strings (str), then return None.

def ensure_loaded(self): (source) ¶

Load this corpus (if it has not already been loaded). This is used by LazyCorpusLoader as a simple method that can be used to make sure a corpus is loaded -- e.g., in case a user wants to do help(some_corpus).

def fileids(self): (source) ¶

overridden in nltk.corpus.reader.IPIPANCorpusReader, nltk.corpus.reader.NKJPCorpusReader, nltk.corpus.reader.TimitCorpusReader, nltk.corpus.reader.VerbnetCorpusReader, nltk.corpus.reader.YCOECorpusReader

Return a list of file identifiers for the fileids that make up this corpus.

def license(self): (source) ¶

overridden in nltk.corpus.reader.PanlexSwadeshCorpusReader, nltk.corpus.reader.WordNetCorpusReader

Return the contents of the corpus LICENSE file, if it exists.

def open(self, file): (source) ¶

Return an open stream that can be used to read the given file. If the file's encoding is not None, then the stream will automatically decode the file's contents into unicode.

Parameters
file	The file identifier of the file to read.

def readme(self): (source) ¶

overridden in nltk.corpus.reader.CategorizedSentencesCorpusReader, nltk.corpus.reader.ComparativeSentencesCorpusReader, nltk.corpus.reader.FramenetCorpusReader, nltk.corpus.reader.MTECorpusReader, nltk.corpus.reader.PanlexSwadeshCorpusReader, nltk.corpus.reader.ReviewsCorpusReader, nltk.corpus.reader.WordNetCorpusReader

Return the contents of the corpus README file, if it exists.

root = (source) ¶

Undocumented

def _get_root(self): (source) ¶

Undocumented

_encoding = (source) ¶

The default unicode encoding for the fileids that make up this corpus. If encoding is None, then the file contents are processed using byte strings.

_fileids = (source) ¶

overridden in nltk.corpus.reader.NombankCorpusReader

A list of the relative paths for the fileids that make up this corpus.

_root = (source) ¶

overridden in nltk.corpus.reader.TimitCorpusReader

The root directory for this corpus.

_tagset = (source) ¶

overridden in nltk.corpus.reader.BracketParseCorpusReader, nltk.corpus.reader.ConllCorpusReader, nltk.corpus.reader.NPSChatCorpusReader, nltk.corpus.reader.SwitchboardCorpusReader, nltk.corpus.reader.TaggedCorpusReader

Undocumented