Rooba
/
mitogen
mirror of https://github.com/mitogen-hq/mitogen.git
1
1
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Normalize docstring formatting

This commit is contained in:
David Wilson 2019-07-28 01:07:45 +01:00
parent 4e6aadc40a
commit 93342ba60c
5 changed files with 62 additions and 31 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

38
mitogen/core.py
View File

@ -337,19 +337,25 @@ class ChannelError(Error):
class StreamError(Error):
"""Raised when a stream cannot be established."""
"""
Raised when a stream cannot be established.
"""
pass
class TimeoutError(Error):
"""Raised when a timeout occurs on a stream."""
"""
Raised when a timeout occurs on a stream.
"""
pass
def to_text(o):
"""Coerce `o` to Unicode by decoding it from UTF-8 if it is an instance of
"""
Coerce `o` to Unicode by decoding it from UTF-8 if it is an instance of
:class:`bytes`, otherwise pass it to the :class:`str` constructor. The
returned object is always a plain :class:`str`, any subclass is removed."""
returned object is always a plain :class:`str`, any subclass is removed.
"""
if isinstance(o, BytesType):
return o.decode('utf-8')
return UnicodeType(o)
@ -1952,7 +1958,9 @@ class MitogenProtocol(Protocol):
return self._writer._len
def on_transmit(self, broker):
"""Transmit buffered messages."""
"""
Transmit buffered messages.
"""
_vv and IOLOG.debug('%r.on_transmit()', self)
self._writer.on_transmit(broker)
@ -1961,12 +1969,16 @@ class MitogenProtocol(Protocol):
self._writer.write(msg.pack())
def send(self, msg):
"""Send `data` to `handle`, and tell the broker we have output. May
be called from any thread."""
"""
Send `data` to `handle`, and tell the broker we have output. May be
called from any thread.
"""
self._router.broker.defer(self._send, msg)
def on_shutdown(self, broker):
"""Disable :class:`Protocol` immediate disconnect behaviour."""
"""
Disable :class:`Protocol` immediate disconnect behaviour.
"""
_v and LOG.debug('%r: shutting down', self)
@ -2628,7 +2640,9 @@ class IoLoggerProtocol(DelimitedProtocol):
self._log.handlers = logging.getLogger().handlers[:]
def on_shutdown(self, broker):
"""Shut down the write end of the logging socket."""
"""
Shut down the write end of the logging socket.
"""
_v and LOG.debug('%r: shutting down', self)
if not IS_WSL:
# #333: WSL generates invalid readiness indication on shutdown().
@ -2912,8 +2926,10 @@ class Router(object):
del self._handle_map[handle]
def on_shutdown(self, broker):
"""Called during :meth:`Broker.shutdown`, informs callbacks registered
with :meth:`add_handle_cb` the connection is dead."""
"""
Called during :meth:`Broker.shutdown`, informs callbacks registered
with :meth:`add_handle_cb` the connection is dead.
"""
_v and LOG.debug('%r: shutting down', self, broker)
fire(self, 'shutdown')
for handle, (persist, fn) in self._handle_map.iteritems():

34
mitogen/master.py
View File

@ -91,7 +91,8 @@ RLOG = logging.getLogger('mitogen.ctx')
def _stdlib_paths():
"""Return a set of paths from which Python imports the standard library.
"""
Return a set of paths from which Python imports the standard library.
"""
attr_candidates = [
'prefix',
@ -111,8 +112,8 @@ def _stdlib_paths():
def is_stdlib_name(modname):
"""Return :data:`True` if `modname` appears to come from the standard
library.
"""
Return :data:`True` if `modname` appears to come from the standard library.
"""
if imp.is_builtin(modname) != 0:
return True
@ -139,7 +140,8 @@ def is_stdlib_path(path):
def get_child_modules(path):
"""Return the suffixes of submodules directly neated beneath of the package
"""
Return the suffixes of submodules directly neated beneath of the package
directory at `path`.
:param str path:
@ -301,8 +303,10 @@ class ThreadWatcher(object):
@classmethod
def _reset(cls):
"""If we have forked since the watch dictionaries were initialized, all
that has is garbage, so clear it."""
"""
If we have forked since the watch dictionaries were initialized, all
that has is garbage, so clear it.
"""
if os.getpid() != cls._cls_pid:
cls._cls_pid = os.getpid()
cls._cls_instances_by_target.clear()
@ -668,7 +672,8 @@ class ModuleFinder(object):
]
def get_module_source(self, fullname):
"""Given the name of a loaded module `fullname`, attempt to find its
"""
Given the name of a loaded module `fullname`, attempt to find its
source code.
:returns:
@ -692,9 +697,10 @@ class ModuleFinder(object):
return tup
def resolve_relpath(self, fullname, level):
"""Given an ImportFrom AST node, guess the prefix that should be tacked
on to an alias name to produce a canonical name. `fullname` is the name
of the module in which the ImportFrom appears.
"""
Given an ImportFrom AST node, guess the prefix that should be tacked on
to an alias name to produce a canonical name. `fullname` is the name of
the module in which the ImportFrom appears.
"""
mod = sys.modules.get(fullname, None)
if hasattr(mod, '__path__'):
@ -845,9 +851,11 @@ class ModuleResponder(object):
self.blacklist.append(fullname)
def neutralize_main(self, path, src):
"""Given the source for the __main__ module, try to find where it
begins conditional execution based on a "if __name__ == '__main__'"
guard, and remove any code after that point."""
"""
Given the source for the __main__ module, try to find where it begins
conditional execution based on a "if __name__ == '__main__'" guard, and
remove any code after that point.
"""
match = self.MAIN_RE.search(src)
if match:
return src[:match.start()]

12
mitogen/minify.py
View File

@ -44,7 +44,8 @@ else:
def minimize_source(source):
"""Remove comments and docstrings from Python `source`, preserving line
"""
Remove comments and docstrings from Python `source`, preserving line
numbers and syntax of empty blocks.
:param str source:
@ -62,7 +63,8 @@ def minimize_source(source):
def strip_comments(tokens):
"""Drop comment tokens from a `tokenize` stream.
"""
Drop comment tokens from a `tokenize` stream.
Comments on lines 1-2 are kept, to preserve hashbang and encoding.
Trailing whitespace is remove from all lines.
@ -84,7 +86,8 @@ def strip_comments(tokens):
def strip_docstrings(tokens):
"""Replace docstring tokens with NL tokens in a `tokenize` stream.
"""
Replace docstring tokens with NL tokens in a `tokenize` stream.
Any STRING token not part of an expression is deemed a docstring.
Indented docstrings are not yet recognised.
@ -119,7 +122,8 @@ def strip_docstrings(tokens):
def reindent(tokens, indent=' '):
"""Replace existing indentation in a token steam, with `indent`.
"""
Replace existing indentation in a token steam, with `indent`.
"""
old_levels = []
old_level = 0

4
mitogen/parent.py
View File

@ -1429,7 +1429,9 @@ class Connection(object):
self._complete_connection()
def on_stream_shutdown(self):
"""Request the slave gracefully shut itself down."""
"""
Request the slave gracefully shut itself down.
"""
LOG.debug('%r: requesting child shutdown', self)
self.stream.protocol._send(
mitogen.core.Message(

5
mitogen/profiler.py
View File

@ -28,7 +28,8 @@
# !mitogen: minify_safe
"""mitogen.profiler
"""
mitogen.profiler
Record and report cProfile statistics from a run. Creates one aggregated
output file, one aggregate containing only workers, and one for the
top-level process.
@ -152,7 +153,7 @@ def do_stat(tmpdir, sort, *args):
def main():
if len(sys.argv) < 2 or sys.argv[1] not in ('record', 'report', 'stat'):
sys.stderr.write(__doc__)
sys.stderr.write(__doc__.lstrip())
sys.exit(1)
func = globals()['do_' + sys.argv[1]]