«

nltk.corpus.reader.XMLCorpusReader

class documentation

class XMLCorpusReader(CorpusReader): (source)

Known subclasses: nltk.corpus.reader.BNCCorpusReader, nltk.corpus.reader.CHILDESCorpusReader, nltk.corpus.reader.FramenetCorpusReader, nltk.corpus.reader.NKJPCorpusReader, nltk.corpus.reader.NPSChatCorpusReader, nltk.corpus.reader.Pl196xCorpusReader, nltk.corpus.reader.RTECorpusReader, nltk.corpus.reader.SemcorCorpusReader, nltk.corpus.reader.VerbnetCorpusReader

Constructor: XMLCorpusReader(root, fileids, wrap_etree)

View In Hierarchy

Corpus reader for corpora whose documents are xml files.

Note that the XMLCorpusReader constructor does not take an encoding argument, because the unicode encoding is specified by the XML files themselves. See the XML specs for more info.

Method __init__ No summary
Method raw Undocumented
Method words Returns all of the words and punctuation symbols in the specified file that were in text nodes -- ie, tags are ignored. Like the xml() method, fileid can only specify one file.
Method xml Undocumented
Instance Variable _wrap_etree Undocumented

Inherited from CorpusReader:

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, wrap_etree=False): (source)
overrides nltk.corpus.reader.CorpusReader.__init__
overridden in nltk.corpus.reader.BNCCorpusReader, nltk.corpus.reader.CHILDESCorpusReader, nltk.corpus.reader.FramenetCorpusReader, nltk.corpus.reader.NKJPCorpusReader, nltk.corpus.reader.NPSChatCorpusReader, nltk.corpus.reader.Pl196xCorpusReader, nltk.corpus.reader.SemcorCorpusReader, nltk.corpus.reader.VerbnetCorpusReader
Parameters
root:PathPointer or strA path pointer identifying the root directory for this corpus. If a string is specified, then it will be converted to a PathPointer automatically.
fileidsA 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.
wrap_etreeUndocumented
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.
tagsetThe name of the tagset used by this corpus, to be used for normalizing or converting the POS tags returned by the tagged_...() methods.
def raw(self, fileids=None): (source)
overridden in nltk.corpus.reader.NKJPCorpusReader, nltk.corpus.reader.Pl196xCorpusReader

Undocumented

def words(self, fileid=None): (source)
overridden in nltk.corpus.reader.BNCCorpusReader, nltk.corpus.reader.CHILDESCorpusReader, nltk.corpus.reader.NKJPCorpusReader, nltk.corpus.reader.NPSChatCorpusReader, nltk.corpus.reader.Pl196xCorpusReader, nltk.corpus.reader.SemcorCorpusReader

Returns all of the words and punctuation symbols in the specified file that were in text nodes -- ie, tags are ignored. Like the xml() method, fileid can only specify one file.

Returns
list(str)the given file's text nodes as a list of words and punctuation symbols
def xml(self, fileid=None): (source)
overridden in nltk.corpus.reader.Pl196xCorpusReader

Undocumented

_wrap_etree = (source)

Undocumented