Re-enable doctest, fix broken docstrings

This commit is contained in:
Jason Gerard DeRose 2009-05-12 18:47:19 -06:00 committed by Rob Crittenden
parent 252e9b61eb
commit 87480b7bde
4 changed files with 18 additions and 23 deletions

View File

@ -601,7 +601,7 @@ For example, say we setup a command like this:
... textui.print_count(result, format) ... textui.print_count(result, format)
... ...
>>> api = create_api() >>> api = create_api()
>>> api.env.in_server = True # We want to execute, not forward. >>> api.bootstrap(in_server=True) # We want to execute, not forward
>>> api.register(show_items) >>> api.register(show_items)
>>> api.finalize() >>> api.finalize()
@ -694,14 +694,7 @@ After `API.bootstrap()` has been called, the `Env` instance will be populated
with all the environment information used by the built-in plugins. with all the environment information used by the built-in plugins.
This will be called before any plugins are registered, so plugin authors can This will be called before any plugins are registered, so plugin authors can
assume these variables will all exist by the time the module containing their assume these variables will all exist by the time the module containing their
plugin (or plugins) is imported. For example: plugin (or plugins) is imported.
>>> api = create_api()
>>> len(api.env)
1
>>> api.bootstrap(in_server=True) # We want to execute, not forward
>>> len(api.env)
39
`Env._bootstrap()`, which is called by `API.bootstrap()`, will create several `Env._bootstrap()`, which is called by `API.bootstrap()`, will create several
run-time variables that connot be overriden in configuration files or through run-time variables that connot be overriden in configuration files or through
@ -747,8 +740,10 @@ For example:
... """Print message of the day.""" ... """Print message of the day."""
... ...
... def execute(self): ... def execute(self):
... return self.env.message_of_the_day ... return self.env.message
... ...
>>> api = create_api()
>>> api.bootstrap(in_server=True, message='Hello, world!')
>>> api.register(motd) >>> api.register(motd)
>>> api.finalize() >>> api.finalize()
>>> api.Command.motd() >>> api.Command.motd()

View File

@ -264,9 +264,9 @@ class textui(backend.Backend):
>>> entry = dict(sn='Last', givenname='First', uid='flast') >>> entry = dict(sn='Last', givenname='First', uid='flast')
>>> ui = textui() >>> ui = textui()
>>> ui.print_entry(entry) >>> ui.print_entry(entry)
givenname: 'First' givenname: First
sn: 'Last' sn: Last
uid: 'flast' uid: flast
""" """
assert type(entry) is dict assert type(entry) is dict
if entry.get('dn'): if entry.get('dn'):

View File

@ -708,7 +708,7 @@ class NoSuchNamespaceError(InvocationError):
>>> raise NoSuchNamespaceError(name='Plugins') >>> raise NoSuchNamespaceError(name='Plugins')
Traceback (most recent call last): Traceback (most recent call last):
... ...
NoSuchNamespaceError: api has no such namespace: Plugins NoSuchNamespaceError: api has no such namespace: 'Plugins'
""" """
errno = 3010 errno = 3010
@ -779,7 +779,7 @@ class MalformedServicePrincipal(ExecutionError):
For example: For example:
>>> raise MalformedServicePrincipal(reason="missing service") >>> raise MalformedServicePrincipal(reason='missing service')
Traceback (most recent call last): Traceback (most recent call last):
... ...
MalformedServicePrincipal: Service principal is not of the form: service/fully-qualified host name: missing service MalformedServicePrincipal: Service principal is not of the form: service/fully-qualified host name: missing service
@ -787,7 +787,7 @@ class MalformedServicePrincipal(ExecutionError):
""" """
errno = 4004 errno = 4004
format = _('Service principal is not of the form: service/fully-qualified host name: %(reason)r') format = _('Service principal is not of the form: service/fully-qualified host name: %(reason)s')
class RealmMismatch(ExecutionError): class RealmMismatch(ExecutionError):
""" """
@ -843,10 +843,10 @@ class MalformedUserPrincipal(ExecutionError):
For example: For example:
>>> raise MalformedUserPrincipal(principal=jsmith@@EXAMPLE.COM) >>> raise MalformedUserPrincipal(principal='jsmith@@EXAMPLE.COM')
Traceback (most recent call last): Traceback (most recent call last):
... ...
MalformedUserPrincipal: Principal is not of the form user@REALM: jsmith@@EXAMPLE.COM MalformedUserPrincipal: Principal is not of the form user@REALM: 'jsmith@@EXAMPLE.COM'
""" """
@ -955,7 +955,7 @@ class Base64DecodeError(ExecutionError):
For example: For example:
>>> raise Base64DecodeError(reason="Incorrect padding") >>> raise Base64DecodeError(reason='Incorrect padding')
Traceback (most recent call last): Traceback (most recent call last):
... ...
Base64DecodeError: Base64 decoding failed: Incorrect padding Base64DecodeError: Base64 decoding failed: Incorrect padding
@ -963,7 +963,7 @@ class Base64DecodeError(ExecutionError):
""" """
errno = 4015 errno = 4015
format = _('Base64 decoding failed: %(reason)r') format = _('Base64 decoding failed: %(reason)s')
class BuiltinError(ExecutionError): class BuiltinError(ExecutionError):
""" """
@ -1035,14 +1035,14 @@ class DatabaseError(ExecutionError):
For example: For example:
>>> raise DatabaseError(desc="Can't contact LDAP server", info="") >>> raise DatabaseError(desc="Can't contact LDAP server", info='')
Traceback (most recent call last): Traceback (most recent call last):
... ...
DatabaseError: Can't contact LDAP server: DatabaseError: Can't contact LDAP server:
""" """
errno = 4203 errno = 4203
format = _('%(desc)r:%(info)r') format = _('%(desc)s:%(info)s')
class LimitsExceeded(ExecutionError): class LimitsExceeded(ExecutionError):

View File

@ -11,7 +11,7 @@ do
if [[ -f $executable ]]; then if [[ -f $executable ]]; then
echo "[ $name: Starting tests... ]" echo "[ $name: Starting tests... ]"
((runs += 1)) ((runs += 1))
if $executable /usr/bin/nosetests -v #--with-doctest if $executable /usr/bin/nosetests -v --with-doctest --exclude="plugins"
then then
echo "[ $name: Tests OK ]" echo "[ $name: Tests OK ]"
else else