Python code folding with Vim

Question

I have tried a bunch of Python code folding plugins and I have seen this question asked once here, but they all don't seem to be too useful to achieve Python code folding in this manner:

class myClass(models.Model):
    [folded code]

    class Meta:
        [folded code]

    def __unicode__(self):
        [folded code]

    def save(self, *args, **kwargs):
        [folded code]

So my question is, Is there any Python code folding plugin that can do this? I haven't been able to find any so far and I have tried out quite a number of such Vim plugins already.

Community · Accepted Answer · 2020-06-20 09:12:55Z

11

description

Because of its reliance on significant whitespace rather than explicit block delimiters, properly folding Python code can be tricky. The Python syntax definition that comes bundled with Vim doesn't contain any fold directives at all, and the simplest workaround is to :set foldmethod=indent, which usually ends up folding a lot more than you really want it to.

There's no shortage of Vim plugins for improved Python folding, but most seem to suffer from cobbled-together algorithms with bizarre, intractable bugs in the corner cases. SimpylFold aims to be exactly what its name suggests: simple, correct folding for Python. It's nothing more than it needs to be: it properly folds class and function/method definitions, and leaves your loops and conditional blocks untouched. There's no BS involved: no screwing around with unrelated options (which several of the other plugins do), no choice of algorithms to scratch your head over (because there's only one that's correct); it just works, simply.

http://www.vim.org/scripts/script.php?script_id=3723

edited Jun 20, 2020 at 9:12

CommunityBot

11 silver badge

answered Sep 15, 2011 at 1:42

A T

14k23 gold badges107 silver badges171 bronze badges

Sign up to request clarification or add additional context in comments.

3 Comments

Calvin Cheng Over a year ago

looks promising. I have tried this plugin yet. Giving it a shot! thanks!

Calvin Cheng Over a year ago

That doesn't seem to work. Moved to the line right below class myClass and hit za but the entire class folded (and all the class methods are hidden) instead folding as I described above.

Keith Pinson Over a year ago

This may be useful information, but my understanding is that bare links are discouraged as answers. If you fleshed it out a little (inserted explanatory text, for example), you could stand a chance of getting some upvotes.

Sedrik · Accepted Answer · 2011-09-15 06:16:33Z

0

I almost always use set foldmethod=indent and it does almost what you want it to do (except for folding the class global variables).

see the help for how to tweak it.

answered Sep 15, 2011 at 6:16

Sedrik

2,2212 gold badges18 silver badges19 bronze badges

Comments

T.R. Fitz-Gibbon · Accepted Answer · 2013-04-18 00:13:40Z

0

I have been looking for the same thing, a folding method for python that leaves the entire method signature even when it spans multiple lines. This script worked for me. However, to get multiple line signatures to work, you'll want to add "let g:ifold_mode=2" to your .vimrc file.

I haven't used this script very long, so there may be other issues with it. Good luck!

edited Apr 18, 2013 at 0:13

answered Apr 17, 2013 at 23:38

T.R. Fitz-Gibbon

11 bronze badge

Collectives™ on Stack Overflow

Python code folding with Vim

3 Answers 3

description

3 Comments

Comments

Comments

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

3 Answers 3

description

3 Comments

Comments

Comments

Your Answer

Sign up or log in

Post as a guest

Linked

Related