pycross.wordsrc.TextWordsource Class Reference

Word source based on a simple list of strings (stored in memory). More...

Inheritance diagram for pycross.wordsrc.TextWordsource:

Public Member Functions
def	__init__ (self, words=[], max_fetch=None, shuffle=True)
	Constructor. More...
def	isvalid (self)
	Valid only if TextWordsource::words not empty. More...
def	fetch (self, word=None, blank=' ', pos=None, filter_func=None, shuffle=True, truncate=True)
	Fetches results from TextWordsource::words. More...
Public Member Functions inherited from pycross.wordsrc.Wordsource
def	__init__ (self, max_fetch=None, shuffle=True)
	Constructor. More...
def	truncate (self, suggestions)
	Truncates the results by the threshold number stored in Wordsource::max_fetch. More...
def	shuffle (self, suggestions)
	Shuffles the results randomly. More...
def	check (self, word, pos=None, filter_func=None)
	Checks if a given word or word pattern is found in the word source. More...
def	pop_word (self, suggestions)
	Retrieves the last suggestion (word) from the list of suggestions, removing that word from the original results. More...
def	__repr__ (self)
	Python repr() overload. More...
def	__bool__ (self)
	Python bool() overload. More...

Public Attributes
	bpos
	bool True if the source word list contains part-of-speech data More...
	words
	list list of 2-tuples, where the first element is the source word and the second element is either a list of parts of speech or None if no part-of-speech data is available More...
Public Attributes inherited from pycross.wordsrc.Wordsource
	max_fetch
	int maximum number of suggestions returned from the word source More...
	shuffle_words
	bool if True, fetched words will be shuffled More...
	active
	bool if True, this word source will be used; otherwise it will be ignored More...

Detailed Description

Word source based on a simple list of strings (stored in memory).

Constructor & Destructor Documentation

__init__()

def pycross.wordsrc.TextWordsource.__init__	(		self,
			words = [],
			max_fetch = None,
			shuffle = True
	)

Constructor.

Parameters

words	list list of source words, each of which is EITHER: str a single string, e.g. 'father'; OR 2-tuple a tuple with 2 elements: ** str word string ** iterable parts of speech that word belongs to, e.g. ['N', 'V'] (noun or verb)
max_fetch	int maximum number of suggestions returned from the word source

Warning

None means no limit on suggestions, which may be time/resource consuming!

Parameters

shuffle

bool if True, fetched words will be shuffled

Member Function Documentation

fetch()

def pycross.wordsrc.TextWordsource.fetch	(		self,
			word = None,
			blank = ' ',
			pos = None,
			filter_func = None,
			shuffle = True,
			truncate = True
	)

Fetches results from TextWordsource::words.

Reimplemented from pycross.wordsrc.Wordsource.

isvalid()

def pycross.wordsrc.TextWordsource.isvalid

(

self

)

Valid only if TextWordsource::words not empty.

Reimplemented from pycross.wordsrc.Wordsource.

Member Data Documentation

bpos

pycross.wordsrc.TextWordsource.bpos

bool True if the source word list contains part-of-speech data

words

pycross.wordsrc.TextWordsource.words

list list of 2-tuples, where the first element is the source word and the second element is either a list of parts of speech or None if no part-of-speech data is available

---

The documentation for this class was generated from the following file:

• pycross/wordsrc.py