tyler.durden/powerline
1
0
Fork 0
mirror of https://github.com/powerline/powerline.git synced 2025-04-08 19:25:04 +02:00
Code Issues Packages Projects Releases Wiki Activity

Add documentation for segment attributes

Browse Source
This commit is contained in:
ZyX 2014-08-29 19:36:30 +04:00
parent cde39f00c4
commit 67845dc96e
1 changed files with 35 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

35
docs/source/develop/segments.rst
View File

@ -29,6 +29,41 @@ object it should receive the following arguments:
And also any other argument(s) specified by user in :ref:`args key
<config-themes-seg-args>` (no additional arguments by default).
Object representing segment may have the following attributes used by
powerline:
``powerline_requires_segment_info``
This attribute controls whether segment will receive ``segment_info``
argument: if it is present argument will be received.
``powerline_requires_filesystem_watcher``
This attribute controls whether segment will receive ``create_watcher``
argument: if it is present argument will be received.
``startup``
This attribute must be a callable which accepts the following keyword
arguments:
* ``pl``: :py:class:`powerline.PowerlineLogger` instance which is to be used
for logging.
* ``shutdown_event``: :py:class:`Event` object which will be set when
powerline will be shut down.
* Any arguments found in user configuration for the given segment (i.e.
:ref:`args key <config-themes-seg-args>`).
This function is called at powerline startup when using long-running
processes (e.g. powerline in vim, in zsh with libzpython, in ipython or in
powerline daemon) and not called when ``powerline-render`` executable is
used (more specific: when :py:class:`powerline.Powerline` constructor
received true ``run_once`` argument).
``shutdown``
This attribute must be a callable that accepts no arguments and shuts down
threads and frees any other resources allocated in ``startup`` method of the
segment in question.
This function is not called when ``startup`` method is not called.
This callable object should may return either a string (``unicode`` in Python2
or ``str`` in Python3, *not* ``str`` in Python2 or ``bytes`` in Python3) object
or a list of dictionaries. String object is a short form of the following return