The Advanced Python Yasnippet Collection

This repository contains a small collection of advanced Python snippets for yasnippet.

Installation

As this collection has only just been created, for the time being this collection is not available on MELPA. In the meantime, you may install it directly from my personal archive. This can be done by adding the following snippet to your Emacs configuration:

(require 'package)
(add-to-list 'package-archives
             '("xaldew" . "https://gustafwaldemarson.com/elpa/"))
(add-to-list 'package-unsigned-archives "xaldew")
(package-initialize)

Once that is done, then just refresh the packages and install it with:

• M-x package-refresh-contents
• M-x package-install yasnippet-snippets

Alternatively, you can also install the package using e.g. use-package with the following snippet in your .emacs:

(use-package py-snippets
  :ensure t
  :after yasnippet
  :config
  (py-snippets-initialize))

For Doom Emacs:

(package! py-snippets
  :recipe (:host github :repo "Xaldew/py-snippets"
           :files (:defaults "snippets" "py-snippets.el")))

Examples

Below are some examples of the snippets available in this repository, with some caveats listed below.

Python

Non-Type Annotated Function - Google Style

Non-Type Annotated Function - ReST Style

Type Annotated Function

Requested, but not implemented yet.

Update Existing Function Arguments

Python Class Documentation

Contributing

If you have a similarly interesting snippet that you think is too complex for a general collection, feel free to create an issue or pull-request to discuss it.

If you have found a bug in any of the available snippets and want to report it, please provide a minimal example that can reproduce it; these snippets are often a bit difficult to debug, so please make it as easy as possible for us to do so.