nltk.corpus.reader.api.CorpusReader

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 be 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 files or categories, which can be used to select which portion of the corpus should be returned.

init(self, root, files, encoding=None, tag_mapping_function=None)
(Constructor)

source code

x.__init__(...) initializes x; see x.__class__.__doc__ for signature

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.
files - 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. encoding's value 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.
tag_mapping_function - A function for normalizing or simplifying the POS tags returned by the tagged_words() or tagged_sents() methods.

Overrides: object.__init__

abspaths(self, files=None, include_encoding=False)

source code

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

Parameters:

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

Returns: list of PathPointer

Class CorpusReader

init(self, root, files, encoding=None, tag_mapping_function=None)
(Constructor)

repr(self)
(Representation operator)

_get_items(*args, **kwargs)

abspath(self, file)

abspaths(self, files=None, include_encoding=False)

encoding(self, file)

filenames(*args, **kwargs)

open(self, file)

_encoding

items

root

Class CorpusReader

__init__(self, root, files, encoding=None, tag_mapping_function=None) (Constructor)

__repr__(self) (Representation operator)

_get_items(*args, **kwargs)

abspath(self, file)

abspaths(self, files=None, include_encoding=False)

encoding(self, file)

filenames(*args, **kwargs)

open(self, file)

_encoding

items

root

init(self, root, files, encoding=None, tag_mapping_function=None)
(Constructor)

repr(self)
(Representation operator)