diff options
| author | Jeff Quast <contact@jeffquast.com> | 2015-09-20 13:57:54 -0700 |
|---|---|---|
| committer | Jeff Quast <contact@jeffquast.com> | 2015-09-20 14:45:06 -0700 |
| commit | 27f512d0b6bb290a6a79e4af95d31f7a3555d728 (patch) | |
| tree | f9cc22cf81fb14bf2b9994e9b4db44e402796522 /pexpect/spawnbase.py | |
| parent | faff3e605b2e1d6d30d3f9ded95473ccfbb8daf0 (diff) | |
| download | pexpect-git-27f512d0b6bb290a6a79e4af95d31f7a3555d728.tar.gz | |
Improve docstrings about searchwindowsize value
In class initializer:
- introduce its default value and its relationship
to the *maxread* keyword argument.
- reduce explanation search cost relationship
in expect method:
- document its similar re-use of class attribute
and keyword argument 'searchwindowsize' when the
value of -1 is used.
Diffstat (limited to 'pexpect/spawnbase.py')
| -rw-r--r-- | pexpect/spawnbase.py | 3 |
1 files changed, 3 insertions, 0 deletions
diff --git a/pexpect/spawnbase.py b/pexpect/spawnbase.py index 9fd2e18..4b1d387 100644 --- a/pexpect/spawnbase.py +++ b/pexpect/spawnbase.py @@ -251,6 +251,9 @@ class SpawnBase(object): If timeout is -1 then timeout will be set to the self.timeout value. + When the keyword argument searchwindowsize is -1 (default), then the + value specified by the class maxread attribute is used. + A list entry may be EOF or TIMEOUT instead of a string. This will catch these exceptions and return the index of the list entry instead of raising the exception. The attribute 'after' will be set to the |