mirror of
https://github.com/gryf/pythonhelper.git
synced 2025-12-18 12:00:27 +01:00
Updated README, added license file
This commit is contained in:
24
LICENSE
Normal file
24
LICENSE
Normal file
@@ -0,0 +1,24 @@
|
||||
Copyright (c) 2016, Roman Dobosz at al.
|
||||
All rights reserved.
|
||||
|
||||
Redistribution and use in source and binary forms, with or without
|
||||
modification, are permitted provided that the following conditions are met:
|
||||
* Redistributions of source code must retain the above copyright
|
||||
notice, this list of conditions and the following disclaimer.
|
||||
* Redistributions in binary form must reproduce the above copyright
|
||||
notice, this list of conditions and the following disclaimer in the
|
||||
documentation and/or other materials provided with the distribution.
|
||||
* Neither the name of the organization nor the names of its contributors
|
||||
may be used to endorse or promote products derived from this software
|
||||
without specific prior written permission.
|
||||
|
||||
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
|
||||
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
||||
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
|
||||
DISCLAIMED. IN NO EVENT SHALL ROMAN DOBOSZ BE LIABLE FOR ANY DIRECT, INDIRECT,
|
||||
INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
|
||||
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
|
||||
PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
|
||||
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
|
||||
NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
|
||||
EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
||||
5
README
5
README
@@ -1,5 +0,0 @@
|
||||
This is a mirror of http://www.vim.org/scripts/script.php?script_id=435
|
||||
|
||||
Vim script to help moving around in larger Python source files. It displays current class, method or function the cursor is placed in in the status line for every python file. It's more clever than Yegappan Lakshmanan's taglist.vim because it takes into account indetation and comments to determine what tag the cursor is placed in and from version 0.80 doesn't need exuberant ctags utility.
|
||||
|
||||
Note: The script displays current tag on the status line only in NORMAL mode. This is because CursorHold event in VIM is fired up only in this mode. However if you'd like to know what tag you are in even in INSERT or VISUAL mode, contact me (email specified in the script) and I'll send you a patch that enables firing up CursorHold event in those modes as well.
|
||||
98
README.rst
Normal file
98
README.rst
Normal file
@@ -0,0 +1,98 @@
|
||||
Pythonhelper
|
||||
============
|
||||
|
||||
This was a mirror of `http://www.vim.org/scripts/script.php?script_id=435`_.
|
||||
|
||||
This Vim plugin helps in Python development by placing a name of current class,
|
||||
method or function under the cursor on the status line in normal and insert
|
||||
mode.
|
||||
|
||||
Installation
|
||||
------------
|
||||
|
||||
To use this plugin either ``+python`` or ``+python3`` feature compiled in vim is
|
||||
required. To check it, issue ``:version`` in vim instance and look for python
|
||||
entries.
|
||||
|
||||
To install it, any kind of Vim package manager can be used, like NeoBundle_,
|
||||
Pathogen_, Vundle_ or vim-plug_.
|
||||
|
||||
For manual installation, copy subdirectories from this repository to your
|
||||
``~/.vim`` directory.
|
||||
|
||||
Next, place one of the available functions either on your ``.vimrc``:
|
||||
|
||||
.. code:: vim
|
||||
|
||||
set statusline=[....]\ %{TagInStatusLine()}\ [.....]
|
||||
|
||||
or under ``~/.vim/ftplugin/python/your_file.vim``:
|
||||
|
||||
.. code:: vim
|
||||
|
||||
setlocal statusline=[....]\ %{TagInStatusLine()}\ [.....]
|
||||
|
||||
Functions, which may be placed on the status line are as follows:
|
||||
|
||||
* ``TagInStatusLine`` - shows name and type of the tag, i.e.:
|
||||
|
||||
.. code::
|
||||
|
||||
ClassName.some_method_name (method)
|
||||
|
||||
* ``TagInStatusLineTag`` - shows only the name:
|
||||
|
||||
.. code::
|
||||
|
||||
ClassName.some_method_name
|
||||
|
||||
* ``TagInStatusLineType`` - shows only the tag type:
|
||||
|
||||
.. code::
|
||||
|
||||
method
|
||||
|
||||
Restart vim, and you all set.
|
||||
|
||||
Changelog
|
||||
---------
|
||||
|
||||
+---------+------------+----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| Version | Date | Author | Notes |
|
||||
+=========+============+================+===========================================================================================================================================================================================+
|
||||
| 1.0 | 2016-05-30 | Roman Dobosz | Rewrite python part (simplifying the code, clean it up, separate from vimscript, add some tests), make it Python3 compatible, lots of other changes |
|
||||
+---------+------------+----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| | 2012-02-12 | cheater | `Several bug fixes`_, code cleanup, docs update |
|
||||
+---------+------------+----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| | 2010-02-13 | Oluf Lorenzen | `Updated the way how to display information on status line`_ |
|
||||
+---------+------------+----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| 0.83 | 2010-01-04 | Michal Vitecek | Added support for the CursorHoldI event so that the class/method/function is recognized also in Insert mode |
|
||||
+---------+------------+----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| 0.82 | 2009-07-10 | Michal Vitecek | fixed a bug when nested functions/classes were not properly detected |
|
||||
+---------+------------+----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| 0.81 | 2003-03-13 | Michal Vitecek | fixed a small bug in indent level recognition |
|
||||
+---------+------------+----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| 0.80 | 2002-10-18 | Michal Vitecek | removed the dependency on exuberant ctags which parsed the python source code wrongly anyways. From now on only VIM with python support is needed. This might greatly help windoze users. |
|
||||
+---------+------------+----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| 0.72 | 2002-10-03 | Michal Vitecek | fixed problem with parsing ctags output on python files that use tabs |
|
||||
| | | | when there is a syntax error in the file and ctags parses it incorrectly a warning is displayed in the command line |
|
||||
+---------+------------+----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| 0.71 | 2002-10-02 | Michal Vitecek | fixed problem with undefined window-bound variable w:PHStatusLine when a window has been split into two. |
|
||||
| | | | unbound event BufWinEnter because it's not needed because of the above change now |
|
||||
+---------+------------+----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| 0.70 | 2002-10-02 | Michal Vitecek | Initial upload |
|
||||
+---------+------------+----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
License
|
||||
-------
|
||||
|
||||
Originally, there was no licence whatsoever, so I've put it under under 3-clause
|
||||
BSD license. See LICENSE file for details.
|
||||
|
||||
.. _Pathogen: https://github.com/tpope/vim-pathogen
|
||||
.. _Vundle: https://github.com/gmarik/Vundle.vim
|
||||
.. _NeoBundle: https://github.com/Shougo/neobundle.vim
|
||||
.. _vim-plug: https://github.com/junegunn/vim-plug
|
||||
.. _http://www.vim.org/scripts/script.php?script_id=435: http://www.vim.org/scripts/script.php?script_id=435
|
||||
.. _Updated the way how to display information on status line: https://github.com/Finkregh/pythonhelper/commit/49d018fdc638f759a4d3d89f97ba5d26baddb1cd
|
||||
.. _Several bug fixes: https://github.com/Finkregh/pythonhelper/pull/2
|
||||
Reference in New Issue
Block a user