Home       Trees       Indices       Help   
pydsc
Module pydsc :: Class checker_t

Class checker_t

source code

object --+
         |
        checker_t

applies spell check process on every imported module

This is the main class of this module. This class applies spell check process on every imported module. Every documentation string within the module will be checked. Some comments will be checked too. You should read inspect module documentation, in order to find out which comments will be checked.

Instance Methods
 
__init__(self, speller, writer=None, filter=None, ignore_identifiers=True)
initialization method		 source code
 
should_be_checked(self, obj, module=None)
returns True, if obj should be checked, False otherwise		 source code
 
import_(self, name, globals=None, locals=None, fromlist=None)
Hook to import functionality		 source code

Inherited from object: __delattr__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __repr__, __setattr__, __str__

Properties

Inherited from object: __class__

Method Details

__init__(self, speller, writer=None, filter=None, ignore_identifiers=True)
(Constructor)

source code 

initialization method

During this method, reference to __builtin__.__import__ function is saved in one of the members of the class, and replaced with import_ member function.

Parameters:
  • speller (enchant.checker.SpellChecker) - reference to enchant.checker.SpellChecker object
  • writer - reference to instance of class that has write method. By default sys.stdout will be used.
  • filter ([ str ]) - list of files or directories
  • filter_type (FILTER_TYPE) - provides interpretation for content of filter parameter
  • ignore_identifiers (bool) - often comments/documentation strings contains class\method\function names. Those names, usually introduce spell error. If ignore_identifiers set to True, those names will be ignored.
Overrides: object.__init__

   Home       Trees       Indices       Help   
pydsc
Generated by Epydoc 3.0 on Sun Feb 03 18:43:43 2008 http://epydoc.sourceforge.net