Add pyramid

[dakra]

As this is my first melpa package I would appreciate comments about code and style.
Even "nitpicky" and opinionated comments like "I always put 2 new lines between function definitions" or "Separate sections with ^L" are welcome :)

Brief summary of what the package does

Pyramid provides utilities for working with the python
web framework pyramid.

Direct link to the package repository

https://github.com/dakra/pyramid.el

Your association with the package

Maintainer

Checklist

Please confirm with x:

• The package is released under a GPL-Compatible Free Software License.
• I've read CONTRIBUTING.md
• I've used the latest version of package-lint to check for packaging issues, and addressed its feedback
• My elisp byte-compiles cleanly
• M-x checkdoc is happy with my docstrings
• I've built and installed the package using the instructions in CONTRIBUTING.md

[DamienCassou]

please replace "*.el" with :defaults:

:files (:defaults "snippets")

[dakra]

done. thanks

[dakra]

Not sure if this is the right place to ask but I saw that when
my track pdb compilation filter matches and tries to start
inferior-python-mode it errors with void variable for
python-shell--interpreter and python-shell--interpreter-args.

That's why this commit is needed.
Just let binding them doesn't work either, I have to put the devfar
there and let bind them to nil.
Somehow that doesn't look right, am I doing something wrong or is it
even a bug in python.el?
Link to the relevant python.el section for the lazy.

[DamienCassou]

Some feedback:

• you don't have to specify :group for each of your defcustom as this is inferred from the previous defgroup

• regarding pyramid-project-root, I guess you can use the directory type instead of string.

• docstrings typically contain the phrasing "non-nil" instead of "True".

• you can specify that the type of pyramid-cookiecutters is a list of strings if you want to

• if the variable pyramid-get-views-code keeps on growing, I would recommend moving its value to an external file. Python syntax-highlighting will make understanding easier. Same comment for the other python variable.

• I typically split my code into sections, separated with ^L\n;;; Some title. Then you can use section-movement keybindings (such as C-x [, backward-page)

• the function pyramid-call is a bit weird in my opinion:

  • I usually avoid using setq when a let is enough: I would move the value of output inside the let bindings and replace the let with a let* so the block can reference exit-code:

  (let* ((exit-code nil)
          (output (with-output-to-string ...))))

  • there is a call to hack-dir-local-variables-non-file-buffer but it's not clear which directory is being used as base one
  • I've never seen standard-output used that way. What about something like that (untested):

  (let* ((buffer (get-buffer-create "*pyramid-pythonic*"))
         (exit-code (call-pythonic :buffer buffer))
         (output (with-current-buffer buffer (buffer-string))))
    (when ()
      (pyramid-show-error output (format "Python exit with status code %d" exit-code)))
    output)

• I find the docstring of pyramid-find-file-and-line not really clear. What is KEY? What is COLLECTION made of? You can say that COLLECTION is analist of (VAL1 . VAL2) where VAL1... and VAL2... for example (please use descriptive names instead of VALx).

• please check if funcall would be more appropriate than apply

• pyramid-find-file-and-line uses the variable value for two different things. I would use two variables.

[dakra]

@DamienCassou thank you for the thorough feedback.
I fixed almost all of you points 👍

there is a call to hack-dir-local-variables-non-file-buffer but it's not
clear which directory is being used as base one

As with-current-buffer changes the buffer, the dir-locals from the
user where he potentially sets the python interpreter is ignored.
So the hack-dir-local-variables-non-file-buffer uses the
directory of the file where the function was originally called.
See: pythonic-emacs/djangonaut#2
Do you think I should a comment there with explanation?

pyramid-find-file-and-line uses the variable value for two different
things. I would use two variables.

It's used for the same thing.
It only appends tramp specific things when the source file
is located on the network/docker/etc.

Thanks again.

[purcell]

Basically looks great, but just a couple of notes:

• When you build commands using concat like here, you'll have a bad time if paths contain spaces or quotes. Use shell-quote-argument to avoid this.
• When the minor mode is disabled, this line will cause the snippets to be loaded. You probably want to wrap that with (when pyramid-mode (pyramid-load-snippets)). But in any case, you almost certainly just want to load the snippets once, so consider (with-eval-after-load 'yasnippet ...) at the top level instead.
• You can omit the 1 here - when called non-interactively, this is the default behaviour of mode functions.

In any case, this is ready to merge, and you can address the above separately. Welcome to MELPA!