Module: Modern code folding

[jorgenschaefer]

Elpy should support code folding like current IDEs provide. That is, simple code folding commands for sensible blocks of Python code (indentation blocks?), with markers and interactable icons in the fringe.

• hs-toggle-hiding should do most of that for us
• Needs a good key shortcut
  • C-TAB maybe. Doesn't work in console. backtab there?
  • Or just TAB at the beginning of a line? Shouldn't be ambiguous.
  • Atom and Sublime Text use C-M-[ / C-M-], with shift for "everything". And people say Emacs has crazy key bindings.
    • With region, folds that region
    • Anywhere in a block of code, folds that block
• Prefix argument should hide leaf nodes (or lines with "def" in them)
• Visualization in the fringe is provided by http://www.emacswiki.org/emacs/hideshowvis.el but that's very limited, won't even auto-update

[jorgenschaefer]

Some example of code folding: http://ace.c9.io/build/kitchen-sink.html

Note especially the options to mark begin only / begin end / etc. in the options. Not sure we need that, but at least the begin one would be nice.

[flub]

Docstring folding would be nice IMHO, something which is often overlooked as folding happens only on blocks usually.

[jorgenschaefer]

Great idea! One of my pet peeves with docstrings is indeed that they separate function heads from bodies, which is why I would prefer comments over docstrings. Folding would help a lot with that.

[offby1]

I'd probably use this feature, and yet ... I do pretty well with plain old C-u C-x $.

[jpcirrus]

For reference, Sublime Text has a nice docstring folding package: Fold Python Docstrings

[cpitclaudel]

Indeed, folding docstrings would be very nice :)

[humitos]

Right now I'm using origami (https://github.com/gregsexton/origami.el) with these settings

(require 'origami)

(define-key origami-mode-map (kbd "C-c f a") 'origami-toggle-all-nodes)
;; http://stackoverflow.com/questions/916797/emacs-global-set-key-to-c-tab
(define-key origami-mode-map (kbd "<C-tab>") 'origami-recursively-toggle-node)

(global-origami-mode 1)

Yeah, it's not the best and I would prefer something better than that but it's something that could be considered in the research.

[aparkerlue]

I find that the following is an acceptable stopgap:

(add-hook 'python-mode-hook 'hs-minor-mode)
(with-eval-after-load "python"
  (define-key python-mode-map (kbd "C-c TAB") 'hs-toggle-hiding)
  )

[clawdelle]

@aparkerlue thx, that is coll,enough for me