Package nltk :: Package corpus :: Package reader :: Module bnc :: Class BNCCorpusReader
[hide private]
[frames] | no frames]

type BNCCorpusReader

source code

         object --+        
                  |        
   api.CorpusReader --+    
                      |    
xmldocs.XMLCorpusReader --+
                          |
                         BNCCorpusReader

Corpus reader for the XML version of the British National Corpus. For access to the complete XML data structure, use the xml() method. For access to simple word lists and tagged word lists, use words(), sents(), tagged_words(), and tagged_sents().

Instance Methods [hide private]
 
__init__(self, root, fileids, lazy=True) source code
list of str
words(self, fileids=None, strip_space=True, stem=False)
Returns: the given file(s) as a list of words and punctuation symbols.
source code
list of (str,str)
tagged_words(self, fileids=None, c5=False, strip_space=True, stem=False)
Returns: the given file(s) as a list of tagged words and punctuation symbols, encoded as tuples (word,tag).
source code
list of (list of str)
sents(self, fileids=None, strip_space=True, stem=False)
Returns: the given file(s) as a list of sentences or utterances, each encoded as a list of word strings.
source code
list of (list of (str,str))
tagged_sents(self, fileids=None, c5=False, strip_space=True, stem=False)
Returns: the given file(s) as a list of sentences, each encoded as a list of (word,tag) tuples.
source code
 
_words(self, fileid, bracket_sent, tag, strip_space, stem)
Helper used to implement the view methods -- returns a list of words or a list of sentences, optionally tagged.
source code

Inherited from xmldocs.XMLCorpusReader: raw, xml

Inherited from api.CorpusReader: __repr__, abspath, abspaths, encoding, fileids, open, readme

Inherited from api.CorpusReader (private): _get_root

    Deprecated since 0.8

Inherited from xmldocs.XMLCorpusReader: read

    Deprecated since 0.9.7

Inherited from api.CorpusReader: files

    Deprecated since 0.9.1

Inherited from api.CorpusReader: items

Inherited from api.CorpusReader (private): _get_items

Instance Variables [hide private]

Inherited from api.CorpusReader (private): _encoding, _fileids, _root

Properties [hide private]

Inherited from api.CorpusReader: root

Method Details [hide private]

__init__(self, root, fileids, lazy=True)
(Constructor)

source code 
Parameters:
  • root - 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. 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: api.CorpusReader.__init__
(inherited documentation)

words(self, fileids=None, strip_space=True, stem=False)

source code 

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.

Parameters:
  • strip_space - If true, then strip trailing spaces from word tokens. Otherwise, leave the spaces on the tokens.
  • stem - If true, then use word stems instead of word strings.
Returns: list of str
the given file(s) as a list of words and punctuation symbols.
Overrides: xmldocs.XMLCorpusReader.words

tagged_words(self, fileids=None, c5=False, strip_space=True, stem=False)

source code 
Parameters:
  • c5 - If true, then the tags used will be the more detailed c5 tags. Otherwise, the simplified tags will be used.
  • strip_space - If true, then strip trailing spaces from word tokens. Otherwise, leave the spaces on the tokens.
  • stem - If true, then use word stems instead of word strings.
Returns: list of (str,str)
the given file(s) as a list of tagged words and punctuation symbols, encoded as tuples (word,tag).

sents(self, fileids=None, strip_space=True, stem=False)

source code 
Parameters:
  • strip_space - If true, then strip trailing spaces from word tokens. Otherwise, leave the spaces on the tokens.
  • stem - If true, then use word stems instead of word strings.
Returns: list of (list of str)
the given file(s) as a list of sentences or utterances, each encoded as a list of word strings.

tagged_sents(self, fileids=None, c5=False, strip_space=True, stem=False)

source code 
Parameters:
  • c5 - If true, then the tags used will be the more detailed c5 tags. Otherwise, the simplified tags will be used.
  • strip_space - If true, then strip trailing spaces from word tokens. Otherwise, leave the spaces on the tokens.
  • stem - If true, then use word stems instead of word strings.
Returns: list of (list of (str,str))
the given file(s) as a list of sentences, each encoded as a list of (word,tag) tuples.

_words(self, fileid, bracket_sent, tag, strip_space, stem)

source code 

Helper used to implement the view methods -- returns a list of words or a list of sentences, optionally tagged.

Parameters:
  • fileid - The name of the underlying file.
  • bracket_sent - If true, include sentence bracketing.
  • tag - The name of the tagset to use, or None for no tags.
  • strip_space - If true, strip spaces from word tokens.
  • stem - If true, then substitute stems for words.