https://github.com/pythonic-emacs/company-anaconda
Anaconda backend for company-mode.
https://github.com/pythonic-emacs/company-anaconda
Last synced: 5 months ago
JSON representation
Anaconda backend for company-mode.
- Host: GitHub
- URL: https://github.com/pythonic-emacs/company-anaconda
- Owner: pythonic-emacs
- Created: 2014-06-17T18:10:44.000Z (almost 11 years ago)
- Default Branch: master
- Last Pushed: 2024-07-21T10:58:23.000Z (9 months ago)
- Last Synced: 2024-08-05T06:06:39.377Z (9 months ago)
- Language: Emacs Lisp
- Size: 54.7 KB
- Stars: 102
- Watchers: 6
- Forks: 12
- Open Issues: 4
-
Metadata Files:
- Readme: README.rst
Awesome Lists containing this project
README
.. |melpa| image:: http://melpa.org/packages/company-anaconda-badge.svg
:target: http://melpa.org/#/company-anaconda
:alt: Melpa
.. |melpa-stable| image:: https://stable.melpa.org/packages/company-anaconda-badge.svg
:target: https://stable.melpa.org/#/company-anaconda
:alt: Melpa-Stable
.. |CI| image:: https://github.com/pythonic-emacs/company-anaconda/actions/workflows/test.yml/badge.svg
:target: https://github.com/pythonic-emacs/company-anaconda/actions/workflows/test.yml
:alt: CI
================
Company anaconda
================
|melpa| |melpa-stable| |CI|
Anaconda_ backend for company-mode_.
.. figure:: static/company-anaconda.png
Installation
------------
You can install this package from Melpa_::
M-x package-install RET company-anaconda RET
Usage
-----
Add ``company-anaconda`` to allowed ``company-mode`` backends list
.. code:: lisp
(eval-after-load "company"
'(add-to-list 'company-backends 'company-anaconda))
Enable ``anaconda-mode`` in buffers you want to use ``company-anaconda``
.. code:: lisp
(add-hook 'python-mode-hook 'anaconda-mode)
If you want to see ``anaconda-mode`` completions together with ones
comes from inferior python process use company grouped backend instead:
.. code:: lisp
(eval-after-load "company"
'(add-to-list 'company-backends '(company-anaconda :with company-capf)))
Customization
-------------
By default, company-anaconda uses Jedi's ``description`` for
candidates as annotations in company-mode's list of completions. This
usually tells you the type, and often the fully-qualified name, of a
completion candidate. For example, for a candidate ``a_method``, you
may see the annotation ````.
You can customize these annotations by setting
``company-anaconda-annotation-function`` to a function that takes a
candidate string and returns the string company-mode should use as the
annotation for that candidate. The candidate string *may* have the
following text properties, which provide additional information about the candidate:
- description: Jedi's description, typically the type of completion
optionally followed by a fully-qualified name for the candidate. For example, \"class: foo.bar.Baz\" or \"statement\".
- module-path: The path to the file that contains this candidate.
- line: The line within that file where the candidate is defined.
- docstring: The candidate's docstring.
Here is an example of an alternate annotation function that only returns the first letter of the candidate's ``description`` property (indicating its type) in chevrons:
.. code:: lisp
(defun my-annotation-function (candidate)
(let ((description (get-text-property 0 'description candidate)))
(when description
(concat "<" (substring description 0 1) ">"))))
(setq company-anaconda-annotation-function 'my-annotation-function)
For a candidate with a description such as ``function:
some_module.SomeClass.a_method``, this would make its annotation in
company-mode's completion list simply ````.
.. _Anaconda: https://github.com/proofit404/anaconda-mode
.. _company-mode: http://company-mode.github.io/
.. _Melpa: http://melpa.milkbox.net/