mirror of
https://github.com/powerline/powerline.git
synced 2025-10-27 17:44:06 +01:00
06211cbe63
Now imports follow the following structure:
1. __future__ line: exactly one line allowed:
from __future__ import (unicode_literals, division, absolute_import, print_function)
(powerline.shell is the only exception due to problems with argparse).
2. Standard python library imports in a form `import X`.
3. Standard python library imports in a form `from X import Y`.
4. and 5. 2. and 3. for third-party (non-python and non-powerline imports).
6. 3. for powerline non-test imports.
7. and 8. 2. and 3. for powerline testing module imports.
Each list entry is separated by exactly one newline from another import. If
there is module docstring it goes between `# vim:` comment and `__future__`
import. So the structure containing all items is the following:
#!/usr/bin/env python
# vim:fileencoding=utf-8:noet
'''Powerline super module'''
import sys
from argparse import ArgumentParser
import psutil
from colormath.color_diff import delta_e_cie2000
from powerline.lib.unicode import u
import tests.vim as vim_module
from tests import TestCase
.
35 lines
1.0 KiB
Python
35 lines
1.0 KiB
Python
# vim:fileencoding=utf-8:noet
|
|
from __future__ import (unicode_literals, division, absolute_import, print_function)
|
|
|
|
from inspect import formatargspec
|
|
|
|
from sphinx.ext import autodoc
|
|
|
|
from powerline.lint.inspect import getconfigargspec
|
|
from powerline.segments import Segment
|
|
from powerline.lib.unicode import unicode
|
|
|
|
|
|
def formatvalue(val):
|
|
if type(val) is str:
|
|
return '="' + unicode(val, 'utf-8').replace('"', '\\"').replace('\\', '\\\\') + '"'
|
|
else:
|
|
return '=' + repr(val)
|
|
|
|
|
|
class ThreadedDocumenter(autodoc.FunctionDocumenter):
|
|
'''Specialized documenter subclass for ThreadedSegment subclasses.'''
|
|
@classmethod
|
|
def can_document_member(cls, member, membername, isattr, parent):
|
|
return (isinstance(member, Segment) or
|
|
super(ThreadedDocumenter, cls).can_document_member(member, membername, isattr, parent))
|
|
|
|
def format_args(self):
|
|
argspec = getconfigargspec(self.object)
|
|
return formatargspec(*argspec, formatvalue=formatvalue).replace('\\', '\\\\')
|
|
|
|
|
|
def setup(app):
|
|
autodoc.setup(app)
|
|
app.add_autodocumenter(ThreadedDocumenter)
|