├── static ├── logo.png ├── completion.png └── reference.png ├── Cask ├── .github ├── dependabot.yml └── workflows │ └── test.yml ├── Makefile ├── .gitignore ├── scripts └── init.el ├── Eask ├── anaconda-mode.py ├── README.markdown ├── anaconda-mode.el └── LICENSE /static/logo.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/pythonic-emacs/anaconda-mode/HEAD/static/logo.png -------------------------------------------------------------------------------- /static/completion.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/pythonic-emacs/anaconda-mode/HEAD/static/completion.png -------------------------------------------------------------------------------- /static/reference.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/pythonic-emacs/anaconda-mode/HEAD/static/reference.png -------------------------------------------------------------------------------- /Cask: -------------------------------------------------------------------------------- 1 | (source melpa) 2 | 3 | (package-file "anaconda-mode.el") 4 | 5 | (development 6 | (depends-on "cask") 7 | (depends-on "zenburn-theme")) 8 | -------------------------------------------------------------------------------- /.github/dependabot.yml: -------------------------------------------------------------------------------- 1 | version: 2 2 | updates: 3 | - package-ecosystem: github-actions 4 | directory: / 5 | schedule: 6 | interval: daily 7 | -------------------------------------------------------------------------------- /Makefile: -------------------------------------------------------------------------------- 1 | emacs: 2 | cask emacs -Q -l scripts/init.el simple.py 3 | 4 | install: 5 | cask install 6 | 7 | update: 8 | cask update 9 | 10 | ci: 11 | eask clean all 12 | eask package 13 | eask install 14 | eask compile 15 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | *.egg-info/ 2 | *.elc 3 | *.pyc 4 | *~ 5 | .cask/ 6 | .eask/ 7 | /dist 8 | .cache/ 9 | .coverage 10 | .tox/ 11 | .vagrant/ 12 | [#]*[#] 13 | __pycache__/ 14 | build/ 15 | dist/ 16 | .pytest_cache/ 17 | 18 | # OS generated 19 | .DS_Store 20 | -------------------------------------------------------------------------------- /scripts/init.el: -------------------------------------------------------------------------------- 1 | ;;; init.el --- minimal anaconda-mode configuration 2 | 3 | ;;; Commentary: 4 | 5 | ;;; Code: 6 | 7 | (require 'cask) 8 | 9 | (let ((source-directory (locate-dominating-file load-file-name "Cask"))) 10 | (cask-initialize source-directory) 11 | (add-to-list 'load-path source-directory)) 12 | 13 | (require 'anaconda-mode) 14 | 15 | (add-hook 'python-mode-hook 'anaconda-mode) 16 | 17 | (add-hook 'python-mode-hook 'anaconda-eldoc-mode) 18 | 19 | (load-theme 'zenburn t) 20 | 21 | (add-to-list 'default-frame-alist '(font . "Liberation Mono-14")) 22 | 23 | (menu-bar-mode -1) 24 | 25 | (scroll-bar-mode -1) 26 | 27 | (tool-bar-mode -1) 28 | 29 | (blink-cursor-mode -1) 30 | 31 | ;;; init.el ends here 32 | -------------------------------------------------------------------------------- /Eask: -------------------------------------------------------------------------------- 1 | ;; -*- mode: eask; lexical-binding: t -*- 2 | 3 | (package "anaconda-mode" 4 | "0.1.15" 5 | "Code navigation, documentation lookup and completion for Python") 6 | 7 | (website-url "https://github.com/proofit404/anaconda-mode") 8 | (keywords "convenience" "anaconda") 9 | 10 | (package-file "anaconda-mode.el") 11 | 12 | (script "test" "echo \"Error: no test specified\" && exit 1") 13 | 14 | (source 'gnu) 15 | (source 'melpa) 16 | 17 | (depends-on "emacs" "25.1") 18 | (depends-on "pythonic") 19 | (depends-on "dash") 20 | (depends-on "s") 21 | (depends-on "f") 22 | 23 | (development 24 | (depends-on "cask") 25 | (depends-on "zenburn-theme")) 26 | 27 | (setq network-security-level 'low) ; see https://github.com/jcs090218/setup-emacs-windows/issues/156#issuecomment-932956432 28 | -------------------------------------------------------------------------------- /.github/workflows/test.yml: -------------------------------------------------------------------------------- 1 | name: CI 2 | 3 | on: 4 | push: 5 | branches: 6 | - master 7 | pull_request: 8 | workflow_dispatch: 9 | 10 | concurrency: 11 | group: ${{ github.workflow }}-${{ github.ref }} 12 | cancel-in-progress: true 13 | 14 | jobs: 15 | test: 16 | runs-on: ${{ matrix.os }} 17 | continue-on-error: ${{ matrix.experimental }} 18 | strategy: 19 | fail-fast: false 20 | matrix: 21 | os: [ubuntu-latest, macos-latest, windows-latest] 22 | emacs-version: 23 | - 26.3 24 | - 27.2 25 | - 28.2 26 | - 29.4 27 | - 30.1 28 | experimental: [false] 29 | include: 30 | - os: ubuntu-latest 31 | emacs-version: snapshot 32 | experimental: true 33 | - os: macos-latest 34 | emacs-version: snapshot 35 | experimental: true 36 | - os: windows-latest 37 | emacs-version: snapshot 38 | experimental: true 39 | exclude: 40 | - os: macos-latest 41 | emacs-version: 26.3 42 | - os: macos-latest 43 | emacs-version: 27.2 44 | 45 | steps: 46 | - uses: actions/checkout@v6 47 | 48 | - uses: jcs090218/setup-emacs@master 49 | with: 50 | version: ${{ matrix.emacs-version }} 51 | 52 | - uses: emacs-eask/setup-eask@master 53 | with: 54 | version: 'snapshot' 55 | 56 | - name: Run tests 57 | run: 58 | make ci 59 | -------------------------------------------------------------------------------- /anaconda-mode.py: -------------------------------------------------------------------------------- 1 | from __future__ import print_function 2 | import sys 3 | import os 4 | 5 | # CLI arguments. 6 | 7 | assert len(sys.argv) > 3, 'CLI arguments: %s' % sys.argv 8 | 9 | server_directory = sys.argv[-3] 10 | server_address = sys.argv[-2] 11 | virtual_environment = sys.argv[-1] 12 | 13 | # Ensure directory. 14 | 15 | server_directory = os.path.expanduser(server_directory) 16 | virtual_environment = os.path.expanduser(virtual_environment) 17 | 18 | # Installation check. 19 | 20 | IS_PY2 = sys.version_info[0] == 2 21 | 22 | # jedi versions >= 0.18 don't support Python 2 23 | if IS_PY2: 24 | jedi_dep = ('jedi', '0.17.2') 25 | server_directory += '-py2' 26 | else: 27 | jedi_dep = ('jedi', '0.19.2') 28 | server_directory += '-py3' 29 | service_factory_dep = ('service_factory', '0.1.6') 30 | 31 | if not os.path.exists(server_directory): 32 | os.makedirs(server_directory) 33 | sys.path.insert(1, server_directory) 34 | 35 | missing_dependencies = [] 36 | 37 | 38 | def is_package_dir(path): 39 | if os.path.isdir(path): 40 | if IS_PY2: 41 | return path.endswith(".egg") 42 | else: 43 | return not (path.endswith(".dist-info") or path.endswith(".egg-info")) 44 | return False 45 | 46 | def instrument_installation(): 47 | for package in (jedi_dep, service_factory_dep): 48 | package_is_installed = False 49 | for path in os.listdir(server_directory): 50 | path = os.path.join(server_directory, path) 51 | if is_package_dir(path): 52 | if path not in sys.path: 53 | sys.path.insert(0, path) 54 | if package[0] in path: 55 | package_is_installed = True 56 | if not package_is_installed: 57 | missing_dependencies.append('=='.join(package)) 58 | 59 | instrument_installation() 60 | 61 | # Installation. 62 | 63 | def install_deps_setuptools(): 64 | import setuptools.command.easy_install 65 | cmd = ['--install-dir', server_directory, 66 | '--site-dirs', server_directory, 67 | '--always-copy', '--always-unzip'] 68 | cmd.extend(missing_dependencies) 69 | setuptools.command.easy_install.main(cmd) 70 | instrument_installation() 71 | 72 | def install_deps_pip(): 73 | import pathlib 74 | import shutil 75 | import subprocess 76 | import tempfile 77 | import venv 78 | temp_dir = pathlib.Path(tempfile.mkdtemp()) 79 | venv.create(temp_dir, with_pip=True) 80 | binname = 'Scripts' if sys.platform == 'win32' else 'bin' 81 | cmd = [temp_dir / binname / 'pip', 'install', '--target', server_directory] 82 | cmd.extend(missing_dependencies) 83 | try: 84 | subprocess.check_call(cmd) 85 | finally: 86 | shutil.rmtree(temp_dir) 87 | instrument_installation() 88 | 89 | if missing_dependencies: 90 | if IS_PY2: 91 | install_deps_setuptools() 92 | else: 93 | install_deps_pip() 94 | 95 | del missing_dependencies[:] 96 | 97 | try: 98 | import jedi 99 | except ImportError: 100 | missing_dependencies.append('=='.join(jedi_dep)) 101 | 102 | try: 103 | import service_factory 104 | except ImportError: 105 | missing_dependencies.append('>='.join(service_factory_dep)) 106 | 107 | # Try one more time in case if anaconda installation gets broken somehow 108 | if missing_dependencies: 109 | if IS_PY2: 110 | install_deps_setuptools() 111 | else: 112 | install_deps_pip() 113 | import jedi 114 | import service_factory 115 | 116 | 117 | # Setup server. 118 | def is_jedi_dep_satisfied(): 119 | dep = jedi_dep[1].split('.') 120 | jed = jedi.__version__.split('.') 121 | for (d, j) in zip(dep, jed): 122 | if int(d) < int(j): 123 | return True 124 | elif int(d) > int(j): 125 | return False 126 | return (len(dep) <= len(jed)) 127 | 128 | 129 | assert is_jedi_dep_satisfied(), 'Jedi version should be >= %s, current version: %s' % (jedi_dep[1], jedi.__version__) 130 | 131 | 132 | if virtual_environment: 133 | virtual_environment = jedi.create_environment(virtual_environment, safe=False) 134 | else: 135 | virtual_environment = None 136 | 137 | # Define JSON-RPC application. 138 | 139 | import functools 140 | import threading 141 | 142 | def script_method(f): 143 | @functools.wraps(f) 144 | def wrapper(source, line, column, path): 145 | timer = threading.Timer(30.0, sys.exit) 146 | timer.start() 147 | result = f(jedi.Script(source, path=path, environment=virtual_environment), line, column) 148 | timer.cancel() 149 | return result 150 | return wrapper 151 | 152 | def process_definitions(f): 153 | @functools.wraps(f) 154 | def wrapper(script, line, column): 155 | definitions = f(script, line, column) 156 | if len(definitions) == 1 and not definitions[0].module_path: 157 | return '%s is defined in %s compiled module' % ( 158 | definitions[0].name, definitions[0].module_name) 159 | return [[str(definition.module_path), 160 | definition.line, 161 | definition.column, 162 | definition.get_line_code().strip()] 163 | for definition in definitions 164 | if definition.module_path] or None 165 | return wrapper 166 | 167 | @script_method 168 | def complete(script, line, column): 169 | return [[definition.name, definition.type] 170 | for definition in script.complete(line, column)] 171 | 172 | @script_method 173 | def company_complete(script, line, column): 174 | return [[definition.name, 175 | definition.type, 176 | definition.docstring(), 177 | str(definition.module_path), 178 | definition.line] 179 | for definition in script.complete(line, column)] 180 | 181 | @script_method 182 | def show_doc(script, line, column): 183 | return [[definition.module_name, definition.docstring()] 184 | for definition in script.infer(line, column)] 185 | 186 | @script_method 187 | @process_definitions 188 | def infer(script, line, column): 189 | return script.infer(line, column) 190 | 191 | @script_method 192 | @process_definitions 193 | def goto(script, line, column): 194 | return script.goto(line, column) 195 | 196 | @script_method 197 | @process_definitions 198 | def get_references(script, line, column): 199 | return script.get_references(line, column) 200 | 201 | @script_method 202 | def eldoc(script, line, column): 203 | signatures = script.get_signatures(line, column) 204 | if len(signatures) >= 1: 205 | return [(s.name, 206 | s.index, 207 | [param.description[6:] for param in s.params]) 208 | for s in signatures] 209 | 210 | # Run. 211 | 212 | app = [complete, company_complete, show_doc, infer, goto, get_references, eldoc] 213 | 214 | service_factory.service_factory(app, server_address, 0, 'anaconda_mode port {port}') 215 | -------------------------------------------------------------------------------- /README.markdown: -------------------------------------------------------------------------------- 1 | # Anaconda mode [![MELPA](https://melpa.org/packages/anaconda-mode-badge.svg)](https://melpa.org/#/anaconda-mode) [![MELPA Stable](https://stable.melpa.org/packages/anaconda-mode-badge.svg)](https://stable.melpa.org/#/anaconda-mode) 2 | 3 | [![CI](https://github.com/pythonic-emacs/anaconda-mode/actions/workflows/test.yml/badge.svg)](https://github.com/pythonic-emacs/anaconda-mode/actions/workflows/test.yml) 4 | 5 | Code navigation, documentation lookup and completion for Python. 6 | 7 | ![Completion screenshot](static/completion.png) 8 | 9 | ![Reference search screenshot](static/reference.png) 10 | 11 | ## Features 12 | 13 | Anaconda mode provides the following features 14 | 15 | * context-sensitive code completion 16 | * jump to definitions 17 | * find references 18 | * view documentation 19 | * virtual environment 20 | * eldoc mode 21 | * all this stuff inside vagrant, docker and remote hosts 22 | 23 | ## Supported Python Versions 24 | 25 | 2.7, 3.4 - 3.13 26 | 27 | ## Installation 28 | 29 | To use this package you need to install `setuptools`. 30 | 31 | #### package.el 32 | 33 | All you need to do is install the package from 34 | [Melpa](https://melpa.org/) 35 | 36 | M-x package-install RET anaconda-mode RET 37 | 38 | #### Manual 39 | 40 | Clone this repository somewhere and add this directory to your 41 | `load-path`. 42 | 43 | #### Prelude 44 | 45 | `anaconda-mode` is included in the [Emacs 46 | Prelude](https://github.com/bbatsov/prelude) distribution. You can 47 | use it as well. Look at the `prelude-python` module to see more 48 | details. 49 | 50 | #### Spacemacs 51 | 52 | `anaconda-mode` is included in the 53 | [Spacemacs](https://github.com/syl20bnr/spacemacs) distribution. You 54 | can use it as well. Look at the [python](https://develop.spacemacs.org/layers/+lang/python/README.html) language layer to see more 55 | details. 56 | 57 | ## Configuration 58 | 59 | You can automatically enable `anaconda-mode` in all python buffers 60 | with following code in your configuration: 61 | 62 | ```lisp 63 | (add-hook 'python-mode-hook 'anaconda-mode) 64 | ``` 65 | 66 | #### ElDoc 67 | 68 | `anaconda-eldoc-mode` provide document function to `eldoc-mode` so 69 | when your point is between the parenthesis of a function call, its 70 | parameters are shown in the echo area. All You need is to enable 71 | `anaconda-eldoc-mode` in addition to the previous setup. 72 | 73 | ```lisp 74 | (add-hook 'python-mode-hook 'anaconda-eldoc-mode) 75 | ``` 76 | 77 | ## Usage 78 | 79 | To start a completion press `C-M-i`. This is the standard emacs 80 | binding for `complete-at-point` function. You can use 81 | [company-mode](http://company-mode.github.io/) with 82 | [company-anaconda](https://github.com/proofit404/company-anaconda) 83 | backend to get more intelligent UI. 84 | 85 | #### Interactive commands 86 | 87 | Here is a list of interactive commands available with anaconda-mode 88 | 89 | |Keybinding | Description | 90 | |------------|---------------------------------------------| 91 | | C-M-i | anaconda-mode-complete | 92 | | M-. | anaconda-mode-find-definitions | 93 | | C-x 4 . | anaconda-mode-find-definitions-other-window | 94 | | C-x 5 . | anaconda-mode-find-definitions-other-frame | 95 | | M-= | anaconda-mode-find-assignments | 96 | | C-x 4 = | anaconda-mode-find-assignments-other-window | 97 | | C-x 5 = | anaconda-mode-find-assignments-other-frame | 98 | | M-r | anaconda-mode-find-references | 99 | | C-x 4 r | anaconda-mode-find-references-other-window | 100 | | C-x 5 r | anaconda-mode-find-references-other-frame | 101 | | M-, | xref-pop-marker-stack | 102 | | M-? | anaconda-mode-show-doc | 103 | 104 | If multiple candidates are found for definitions, assignments or 105 | usages, you'll see an advanced anaconda navigator buffer. 106 | 107 | #### PYTHONPATH 108 | 109 | You can add your project to the Emacs `PYTHONPATH`. If you store 110 | project dependencies somewhere on your machine, you can add them as 111 | well. 112 | 113 | ```lisp 114 | (add-to-list 'python-shell-extra-pythonpaths "/path/to/the/project") 115 | (add-to-list 'python-shell-extra-pythonpaths "/path/to/the/dependency") 116 | ``` 117 | 118 | #### Virtual environment 119 | 120 | Use a virtual environment to isolate your project dependencies from 121 | others on the system. You can additionally install your project in an 122 | editable mode in the virtual environment. This will improve search 123 | functionality. Then activate this virtual environment inside Emacs. 124 | 125 | M-x pythonic-activate RET /path/to/virtualenv RET 126 | 127 | Also you can use 128 | [pyenv-mode](https://github.com/proofit404/pyenv-mode) or similar 129 | package to hold virtual environment in actual state. 130 | 131 | Each action above applies to `anaconda-mode` immediately. The next 132 | `anaconda-mode` command you call will use this environment for search 133 | completion candidates. 134 | 135 | #### Tramp 136 | 137 | It's possible to use anaconda-mode on a remote server when you connect 138 | to it using tramp. Anaconda-mode can search for completion candidates 139 | and all other stuff on remote server while you're running Emacs 140 | locally. Just open an interesting remote file. 141 | 142 | C-x C-f /ssh:remote_host:project/__init__.py RET 143 | 144 | After tramp successfully connects and you see actual buffer content, 145 | completion and definitions search should work as usual. You can even 146 | use virtual environment from remote host. 147 | 148 | M-x pythonic-activate RET /ssh:remote_host:/home/user/venv RET 149 | 150 | Or specify another remote interpreter 151 | 152 | ```lisp 153 | (setq python-shell-interpreter "/usr/bin/python") 154 | ``` 155 | 156 | It is important to remember that `remote_host` must be a real host 157 | name or an IP address. SSH aliases not allowed to be used with 158 | anaconda-mode. All kinds of searching from inside the virtual 159 | environment are available from any buffer. However searching inside 160 | your project is available only if you open it on the same machine as 161 | the interpreter. 162 | 163 | #### Vagrant 164 | 165 | You can get all the intelligent features of anaconda-mode with virtual 166 | environments deployed on your vagrant box. Fire up the vagrant machine 167 | as usual. The easiest way to handle authentication is to copy your 168 | public ssh key to the vagrant box. 169 | 170 | ssh-copy-id vagrant@localhost -p 2222 171 | 172 | Now open your project inside the vagrant box. 173 | 174 | C-x C-f /ssh:vagrant@localhost#2222:/vagrant/polls/views.py 175 | 176 | Optionally you can activate your project environment, if installed 177 | inside vagrant. 178 | 179 | M-x pythonic-activate RET /ssh:vagrant@localhost#2222:/vagrant/polls/venv RET 180 | 181 | #### Docker 182 | 183 | You can use definition, reference and auto-completion search for 184 | dependencies installed in the Docker container. Let suppose your 185 | project layout is the same as in [Compose and 186 | Django](https://docs.docker.com/compose/django/) tutorial. To use 187 | `anaconda-mode` together with Docker you need to install two 188 | additional external dependencies. First of all, you need to install 189 | [docker-tramp](https://github.com/emacs-pe/docker-tramp.el) Emacs 190 | package. The second step is to install Unix `socat` utility. You 191 | should have your containers up and running 192 | 193 | docker-compose up web 194 | 195 | After that, you can set Python interpreter to one installed inside 196 | container 197 | 198 | ```lisp 199 | (setq python-shell-interpreter "/usr/local/bin/python") 200 | ``` 201 | 202 | Now you can open some file inside the project running inside a 203 | container 204 | 205 | C-x C-f /docker:root@django_web_1:/code/manage.py 206 | 207 | If you try to find the definition of the Django module imported in 208 | this buffer, `anaconda-mode` will jump to the package installed inside 209 | this Docker container. 210 | 211 | ## FAQ 212 | 213 | If you see constant response reading error, try to change localhost 214 | address from default `127.0.0.1` to `localhost`. This is likely to 215 | fix problems on Mac OS. 216 | 217 | ```lisp 218 | (setq anaconda-mode-localhost-address "localhost") 219 | ``` 220 | 221 | ## Bug Reports 222 | 223 | Please attach `*anaconda-mode*`, `*anaconda-response*` and 224 | `*anaconda-socat*` buffer content to every created issue. 225 | 226 | ## Thanks 227 | 228 | * Dmitry Gutov **@dgutov** 229 | * Bo Lin **@sadboy** 230 | * Vasilij Schneidermann **@wasamasa** 231 | * Fredrik Bergroth **@fbergroth** 232 | * Fabio Corneti **@fabiocorneti** 233 | * Tom Davis **@tdavis** 234 | * Sviridov Alexander **@sviridov** 235 | * Mario Rodas **@marsam** 236 | -------------------------------------------------------------------------------- /anaconda-mode.el: -------------------------------------------------------------------------------- 1 | ;;; anaconda-mode.el --- Code navigation, documentation lookup and completion for Python -*- lexical-binding: t; -*- 2 | 3 | ;; Copyright (C) 2013-2018 by Artem Malyshev 4 | 5 | ;; Author: Artem Malyshev 6 | ;; URL: https://github.com/proofit404/anaconda-mode 7 | ;; Version: 0.1.16 8 | ;; Package-Requires: ((emacs "25.1") (pythonic "0.1.0") (dash "2.6.0") (s "1.9") (f "0.16.2")) 9 | ;; Keywords: convenience anaconda 10 | 11 | ;; This program is free software; you can redistribute it and/or modify 12 | ;; it under the terms of the GNU General Public License as published by 13 | ;; the Free Software Foundation, either version 3 of the License, or 14 | ;; (at your option) any later version. 15 | 16 | ;; This program is distributed in the hope that it will be useful, 17 | ;; but WITHOUT ANY WARRANTY; without even the implied warranty of 18 | ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 19 | ;; GNU General Public License for more details. 20 | 21 | ;; You should have received a copy of the GNU General Public License 22 | ;; along with this program. If not, see . 23 | 24 | ;;; Commentary: 25 | 26 | ;; See the README for more details. 27 | 28 | ;;; Code: 29 | 30 | (require 'ansi-color) 31 | (require 'pythonic) 32 | (require 'cl-lib) 33 | (require 'tramp) 34 | (require 'xref) 35 | (require 'json) 36 | (require 'dash) 37 | (require 'url) 38 | (require 's) 39 | (require 'f) 40 | 41 | (defgroup anaconda nil 42 | "Code navigation, documentation lookup and completion for Python." 43 | :group 'programming) 44 | 45 | (defcustom anaconda-mode-installation-directory 46 | (locate-user-emacs-file "anaconda-mode") 47 | "Installation directory for `anaconda-mode' server." 48 | :type 'directory) 49 | 50 | (defcustom anaconda-mode-eldoc-as-single-line nil 51 | "If not nil, trim eldoc string to frame width." 52 | :type 'boolean) 53 | 54 | (defcustom anaconda-mode-lighter " Anaconda" 55 | "Text displayed in the mode line when `anaconda-mode’ is active." 56 | :type 'sexp) 57 | 58 | (defcustom anaconda-mode-localhost-address "127.0.0.1" 59 | "Address used by `anaconda-mode' to resolve localhost." 60 | :type 'string) 61 | 62 | (defcustom anaconda-mode-doc-frame-background (face-attribute 'default :background) 63 | "Doc frame background color, default color is current theme's background." 64 | :type 'string) 65 | 66 | (defcustom anaconda-mode-doc-frame-foreground (face-attribute 'default :foreground) 67 | "Doc frame foreground color, default color is current theme's foreground." 68 | :type 'string) 69 | 70 | (defcustom anaconda-mode-use-posframe-show-doc nil 71 | "If the value is not nil, use posframe to show eldoc." 72 | :type 'boolean) 73 | 74 | (defcustom anaconda-mode-tunnel-setup-sleep 2 75 | "Time in seconds `anaconda-mode' waits after tunnel creation before first RPC call." 76 | :type 'integer) 77 | 78 | (defcustom anaconda-mode-sync-request-timeout 2 79 | "Time in seconds `anaconda-mode' waits for a synchronous response." 80 | :type 'integer) 81 | 82 | ; create a defcustom that only allows for 'never, 'always, or 'remote 83 | (defcustom anaconda-mode-disable-rpc 'never 84 | "Disable RPC calls to the `anaconda-mode' server when remote." 85 | :type '(choice (const :tag "Never" never) 86 | (const :tag "Always" always) 87 | (const :tag "Remote" remote))) 88 | 89 | ;;; Compatibility 90 | 91 | ;; Functions from posframe which is an optional dependency 92 | (declare-function posframe-workable-p "posframe") 93 | (declare-function posframe-hide "posframe") 94 | (declare-function posframe-show "posframe") 95 | 96 | ;;; Server. 97 | (defvar anaconda-mode-server-version "0.1.17" 98 | "Server version needed to run `anaconda-mode'.") 99 | 100 | (defvar anaconda-mode-process-name "anaconda-mode" 101 | "Process name for `anaconda-mode' processes.") 102 | 103 | (defvar anaconda-mode-process-buffer "*anaconda-mode*" 104 | "Buffer name for `anaconda-mode' process.") 105 | 106 | (defvar anaconda-mode-process nil 107 | "Currently running `anaconda-mode' process.") 108 | 109 | (defvar anaconda-mode-response-buffer "*anaconda-response*" 110 | "Buffer name for error report when `anaconda-mode' fail to read server response.") 111 | 112 | (defvar anaconda-mode-socat-process-name "anaconda-socat" 113 | "Process name for `anaconda-mode' socat companion process.") 114 | 115 | (defvar anaconda-mode-socat-process-buffer "*anaconda-socat*" 116 | "Buffer name for `anaconda-mode' socat companion process.") 117 | 118 | (defvar anaconda-mode-socat-process nil 119 | "Currently running `anaconda-mode' socat companion process.") 120 | 121 | (defvar anaconda-mode-ssh-process-name "anaconda-ssh" 122 | "Process name for `anaconda-mode' ssh port forward companion process.") 123 | 124 | (defvar anaconda-mode-ssh-process-buffer "*anaconda-ssh*" 125 | "Buffer name for `anaconda-mode' ssh port forward companion process.") 126 | 127 | (defvar anaconda-mode-ssh-process nil 128 | "Currently running `anaconda-mode' ssh port forward companion process.") 129 | 130 | (defvar anaconda-mode-doc-frame-name "*Anaconda Posframe*" 131 | "The posframe to show anaconda documentation.") 132 | 133 | (defvar anaconda-mode-frame-last-point 0 134 | "The last point of anaconda doc view frame, use for hide frame after move point.") 135 | 136 | (defvar anaconda-mode-frame-last-scroll-offset 0 137 | "The last scroll offset when show doc view frame, use for hide frame after window scroll.") 138 | 139 | (defun anaconda-mode-server-directory () 140 | "Anaconda mode installation directory." 141 | (f-short (f-join anaconda-mode-installation-directory 142 | anaconda-mode-server-version))) 143 | 144 | (defun anaconda-mode-host () 145 | "Target host with `anaconda-mode' server." 146 | (cond 147 | ((pythonic-remote-docker-p) 148 | anaconda-mode-localhost-address) 149 | ((pythonic-remote-p) 150 | (pythonic-remote-host)) 151 | (t 152 | anaconda-mode-localhost-address))) 153 | 154 | (defun anaconda-mode-port () 155 | "Port for `anaconda-mode' connection." 156 | (process-get anaconda-mode-process 'port)) 157 | 158 | (defun anaconda-mode-start (&optional callback) 159 | "Start `anaconda-mode' server. 160 | CALLBACK function will be called when `anaconda-mode-port' will 161 | be bound." 162 | (when (anaconda-mode-need-restart) 163 | (anaconda-mode-stop)) 164 | (if (anaconda-mode-running-p) 165 | (and callback 166 | (anaconda-mode-bound-p) 167 | (funcall callback)) 168 | (anaconda-mode-bootstrap callback))) 169 | 170 | (defun anaconda-mode-stop () 171 | "Stop `anaconda-mode' server." 172 | (when (anaconda-mode-running-p) 173 | (set-process-filter anaconda-mode-process nil) 174 | (set-process-sentinel anaconda-mode-process nil) 175 | (kill-process anaconda-mode-process) 176 | (setq anaconda-mode-process nil)) 177 | (when (anaconda-mode-socat-running-p) 178 | (kill-process anaconda-mode-socat-process) 179 | (setq anaconda-mode-socat-process nil)) 180 | (when (anaconda-mode-ssh-running-p) 181 | (kill-process anaconda-mode-ssh-process) 182 | (setq anaconda-mode-ssh-process nil))) 183 | 184 | (defun anaconda-mode-running-p () 185 | "Is `anaconda-mode' server running." 186 | (and anaconda-mode-process 187 | (process-live-p anaconda-mode-process))) 188 | 189 | (defun anaconda-mode-socat-running-p () 190 | "Is `anaconda-mode' socat companion process running." 191 | (and anaconda-mode-socat-process 192 | (process-live-p anaconda-mode-socat-process))) 193 | 194 | (defun anaconda-mode-ssh-running-p () 195 | "Is `anaconda-mode' ssh port forward companion process running." 196 | (and anaconda-mode-ssh-process 197 | (process-live-p anaconda-mode-ssh-process))) 198 | 199 | (defun anaconda-mode-bound-p () 200 | "Is `anaconda-mode' port bound." 201 | (numberp (anaconda-mode-port))) 202 | 203 | (defun anaconda-mode-need-restart () 204 | "Check if we need to restart `anaconda-mode-server'." 205 | (when (and (anaconda-mode-running-p) 206 | (anaconda-mode-bound-p)) 207 | (not (and (equal (process-get anaconda-mode-process 'interpreter) 208 | python-shell-interpreter) 209 | (equal (process-get anaconda-mode-process 'virtualenv) 210 | python-shell-virtualenv-root) 211 | (equal (process-get anaconda-mode-process 'remote-p) 212 | (pythonic-remote-p)) 213 | (if (pythonic-local-p) 214 | t 215 | (equal (process-get anaconda-mode-process 'remote-method) 216 | (pythonic-remote-method)) 217 | (equal (process-get anaconda-mode-process 'remote-user) 218 | (pythonic-remote-user)) 219 | (equal (process-get anaconda-mode-process 'remote-host) 220 | (pythonic-remote-host)) 221 | (equal (process-get anaconda-mode-process 'remote-port) 222 | (pythonic-remote-port))))))) 223 | 224 | (defun anaconda-mode-get-server-process-cwd () 225 | "Get the working directory for starting the anaconda server process. 226 | 227 | The current working directory ends up being on sys.path, which may 228 | result in conflicts with stdlib modules. 229 | 230 | When running python from the local machine, we start the server 231 | process from `anaconda-mode-installation-directory'. 232 | This function creates that directory if it doesn't exist yet." 233 | (when (pythonic-local-p) 234 | (unless (file-directory-p anaconda-mode-installation-directory) 235 | (make-directory anaconda-mode-installation-directory t)) 236 | anaconda-mode-installation-directory)) 237 | 238 | (defun anaconda-mode-server-command-args () 239 | "Return list of arguments to start anaconda-mode server. 240 | 241 | Passes local file anaconda-mode.py if local, or uses python 242 | module as string if connecting through TRAMP. 243 | 244 | Arguments are: 245 | 1. anaconda-mode.py (local) or -c anaconda-mode.py string (remote) 246 | 2. anaconda-mode-server-directory 247 | 3. anaconda-mode-localhost-address (local) or 0.0.0.0 (remote) 248 | 4. python-shell-virtualenv-root or empty string if not set" 249 | (let ((server-command-file (concat (file-name-directory (locate-library "anaconda-mode")) "anaconda-mode.py")) 250 | (arg-list (list (anaconda-mode-server-directory) 251 | (if (pythonic-remote-p) 252 | "0.0.0.0" 253 | anaconda-mode-localhost-address) 254 | (or python-shell-virtualenv-root "") )) 255 | server-command) 256 | (if (pythonic-remote-p) 257 | (with-temp-buffer 258 | (insert-file-contents server-command-file) 259 | (setq server-command (list "-c" (buffer-string)))) 260 | (setq server-command (list server-command-file))) 261 | (append server-command arg-list))) 262 | 263 | 264 | (defun anaconda-mode-bootstrap (&optional callback) 265 | "Run `anaconda-mode' server. 266 | CALLBACK function will be called when `anaconda-mode-port' will 267 | be bound." 268 | (setq anaconda-mode-process 269 | (pythonic-start-process :process anaconda-mode-process-name 270 | :cwd (anaconda-mode-get-server-process-cwd) 271 | :buffer (get-buffer-create anaconda-mode-process-buffer) 272 | :query-on-exit nil 273 | :filter (lambda (process output) 274 | (anaconda-mode-bootstrap-filter process output callback)) 275 | :sentinel (lambda (_process _event)) 276 | :args (anaconda-mode-server-command-args))) 277 | (process-put anaconda-mode-process 'interpreter python-shell-interpreter) 278 | (process-put anaconda-mode-process 'virtualenv python-shell-virtualenv-root) 279 | (process-put anaconda-mode-process 'port nil) 280 | (when (pythonic-remote-p) 281 | (process-put anaconda-mode-process 'remote-p t) 282 | (process-put anaconda-mode-process 'remote-method (pythonic-remote-method)) 283 | (process-put anaconda-mode-process 'remote-user (pythonic-remote-user)) 284 | (process-put anaconda-mode-process 'remote-host (pythonic-remote-host)) 285 | (process-put anaconda-mode-process 'remote-port (pythonic-remote-port)))) 286 | 287 | (defun anaconda-jump-proxy-string () 288 | "Create -J option string for SSH tunnel." 289 | (let ((dfn 290 | (tramp-dissect-file-name (pythonic-aliased-path default-directory)))) 291 | (when (tramp-file-name-hop dfn) 292 | (let ((hop-list (split-string (tramp-file-name-hop dfn) "|")) 293 | (result "-J ")) 294 | (delete "" hop-list) ;; remove empty string after final pipe 295 | (dolist (elt hop-list result) 296 | ;; tramp-dissect-file-name expects a filename so give it dummy.file 297 | (let ((ts (tramp-dissect-file-name (concat "/" elt ":/dummy.file")))) 298 | (setq result (concat result 299 | (format "%s@%s:%s," 300 | (tramp-file-name-user ts) 301 | (tramp-file-name-host ts) 302 | (or (tramp-file-name-port-or-default ts) 22)))))) 303 | ;; Remove final comma 304 | (substring result 0 -1))))) 305 | 306 | (defun anaconda-mode-bootstrap-filter (process output &optional callback) 307 | "Set `anaconda-mode-port' from PROCESS OUTPUT. 308 | Connect to the `anaconda-mode' server. CALLBACK function will be 309 | called when `anaconda-mode-port' will be bound." 310 | ;; Mimic default filter. 311 | (when (buffer-live-p (process-buffer process)) 312 | (with-current-buffer (process-buffer process) 313 | (save-excursion 314 | (goto-char (process-mark process)) 315 | (insert (ansi-color-apply output)) 316 | (set-marker (process-mark process) (point))))) 317 | (unless (anaconda-mode-bound-p) 318 | (--when-let (s-match "anaconda_mode port \\([0-9]+\\)" output) 319 | (process-put anaconda-mode-process 'port (string-to-number (cadr it))) 320 | (cond ((pythonic-remote-docker-p) 321 | (let* ((container-raw-description (with-output-to-string 322 | (with-current-buffer 323 | standard-output 324 | (call-process "docker" nil t nil "inspect" (pythonic-remote-host))))) 325 | (container-description (let ((json-array-type 'list)) 326 | (json-read-from-string container-raw-description))) 327 | (container-ip (cdr (assoc 'IPAddress 328 | (cdadr (assoc 'Networks 329 | (cdr (assoc 'NetworkSettings 330 | (car container-description))))))))) 331 | (setq anaconda-mode-socat-process 332 | (start-process anaconda-mode-socat-process-name 333 | anaconda-mode-socat-process-buffer 334 | "socat" 335 | (format "TCP4-LISTEN:%d" (anaconda-mode-port)) 336 | (format "TCP4:%s:%d" container-ip (anaconda-mode-port)))) 337 | (set-process-query-on-exit-flag anaconda-mode-socat-process nil))) 338 | ((pythonic-remote-ssh-p) 339 | (let ((jump (anaconda-jump-proxy-string))) 340 | (message (format "Anaconda Jump Proxy: %s" jump)) 341 | (setq anaconda-mode-ssh-process 342 | (if jump 343 | (start-process anaconda-mode-ssh-process-name 344 | anaconda-mode-ssh-process-buffer 345 | "ssh" jump "-nNT" 346 | "-L" (format "%s:localhost:%s" (anaconda-mode-port) (anaconda-mode-port)) 347 | (format "%s@%s" (pythonic-remote-user) (pythonic-remote-host)) 348 | "-p" (number-to-string (or (pythonic-remote-port) 22))) 349 | (apply 'start-process 350 | anaconda-mode-ssh-process-name 351 | anaconda-mode-ssh-process-buffer 352 | "ssh" "-nNT" 353 | "-L" (format "%s:localhost:%s" (anaconda-mode-port) (anaconda-mode-port)) 354 | (if (pythonic-remote-user) 355 | (format "%s@%s" (pythonic-remote-user) (pythonic-remote-host)) 356 | ;; Asssume remote host is an ssh alias 357 | (pythonic-remote-host)) 358 | ;; Pass in port only if it exists (might be included in ssh alias) 359 | (when-let ((port (pythonic-remote-port))) 360 | '("-p" (number-to-string port)))))) 361 | ;; prevent race condition between tunnel setup and first use 362 | (sleep-for anaconda-mode-tunnel-setup-sleep) 363 | (set-process-query-on-exit-flag anaconda-mode-ssh-process nil)))) 364 | (when callback 365 | (funcall callback))))) 366 | 367 | 368 | ;;; Interaction. 369 | 370 | (defun anaconda-mode-call (command callback) 371 | "Make remote procedure call for COMMAND. 372 | Apply CALLBACK to the result asynchronously." 373 | (unless (or (eq anaconda-mode-disable-rpc 'always) 374 | (and (eq anaconda-mode-disable-rpc 'remote) 375 | (pythonic-remote-p))) 376 | (anaconda-mode-start 377 | (lambda () (anaconda-mode-jsonrpc command callback))))) 378 | 379 | (defun anaconda-mode-call-sync (command callback) 380 | "Make remote procedure call for COMMAND. 381 | Apply CALLBACK to the result synchronously." 382 | (let ((start-time (current-time)) 383 | (result 'pending)) 384 | (anaconda-mode-call 385 | command 386 | (lambda (r) (setq result r))) 387 | (while (eq result 'pending) 388 | (accept-process-output nil 0.01) 389 | (when (> (cadr (time-subtract (current-time) start-time)) 390 | anaconda-mode-sync-request-timeout) 391 | (error "%s request timed out" command))) 392 | (funcall callback result))) 393 | 394 | (defun anaconda-mode-jsonrpc (command callback) 395 | "Perform JSONRPC call for COMMAND. 396 | Apply CALLBACK to the call result when retrieve it. Remote 397 | COMMAND must expect four arguments: python buffer content, line 398 | number position, column number position and file path." 399 | (let ((url-request-method "POST") 400 | (url-request-data (anaconda-mode-jsonrpc-request command))) 401 | (url-retrieve 402 | (format "http://%s:%s" anaconda-mode-localhost-address (anaconda-mode-port)) 403 | (anaconda-mode-create-response-handler callback) 404 | nil 405 | t))) 406 | 407 | (defun anaconda-mode-jsonrpc-request (command) 408 | "Prepare JSON encoded buffer data for COMMAND call." 409 | (encode-coding-string (json-encode (anaconda-mode-jsonrpc-request-data command)) 'utf-8)) 410 | 411 | (defun anaconda-mode-jsonrpc-request-data (command) 412 | "Prepare buffer data for COMMAND call." 413 | `((jsonrpc . "2.0") 414 | (id . 1) 415 | (method . ,command) 416 | (params . ((source . ,(buffer-substring-no-properties (point-min) (point-max))) 417 | (line . ,(line-number-at-pos (point))) 418 | (column . ,(- (point) (line-beginning-position))) 419 | (path . ,(when (buffer-file-name) 420 | (pythonic-python-readable-file-name (buffer-file-name)))))))) 421 | 422 | (defun anaconda-mode-create-response-handler (callback) 423 | "Create server response handler based on CALLBACK function." 424 | (let ((anaconda-mode-request-point (point)) 425 | (anaconda-mode-request-buffer (current-buffer)) 426 | (anaconda-mode-request-window (selected-window)) 427 | (anaconda-mode-request-tick (buffer-chars-modified-tick))) 428 | (lambda (status) 429 | (let ((http-buffer (current-buffer))) 430 | (unwind-protect 431 | (if (or (not (equal anaconda-mode-request-window (selected-window))) 432 | (with-current-buffer (window-buffer anaconda-mode-request-window) 433 | (or (not (equal anaconda-mode-request-buffer (current-buffer))) 434 | (not (equal anaconda-mode-request-point (point))) 435 | (not (equal anaconda-mode-request-tick (buffer-chars-modified-tick)))))) 436 | nil 437 | (search-forward-regexp "\r?\n\r?\n" nil t) 438 | (let ((response (condition-case nil 439 | (json-read) 440 | ((json-readtable-error json-end-of-file end-of-file) 441 | (let ((response (concat (format "# status: %s\n# point: %s\n" status (point)) 442 | (buffer-string)))) 443 | (with-current-buffer (get-buffer-create anaconda-mode-response-buffer) 444 | (erase-buffer) 445 | (insert response) 446 | (goto-char (point-min))) 447 | nil))))) 448 | (if (null response) 449 | (message "Cannot read anaconda-mode server response") 450 | (if (assoc 'error response) 451 | (let* ((error-structure (cdr (assoc 'error response))) 452 | (error-message (cdr (assoc 'message error-structure))) 453 | (error-data (cdr (assoc 'data error-structure))) 454 | (error-template (concat (if error-data "%s: %s" "%s") 455 | " - see " anaconda-mode-process-buffer 456 | " for more information."))) 457 | (apply 'message error-template (delq nil (list error-message error-data)))) 458 | (with-current-buffer anaconda-mode-request-buffer 459 | (let ((result (cdr (assoc 'result response)))) 460 | ;; Terminate `apply' call with empty list so response 461 | ;; will be treated as single argument. 462 | (condition-case nil 463 | (apply callback result nil) 464 | (quit nil)))))))) 465 | (kill-buffer http-buffer)))))) 466 | 467 | 468 | ;;; Code completion. 469 | 470 | (defun anaconda-mode-complete () 471 | "Request completion candidates." 472 | (interactive) 473 | (unless (python-syntax-comment-or-string-p) 474 | (anaconda-mode-call "complete" 'anaconda-mode-complete-callback))) 475 | 476 | (defun anaconda-mode-complete-callback (result) 477 | "Start interactive completion on RESULT receiving." 478 | (let* ((bounds (bounds-of-thing-at-point 'symbol)) 479 | (start (or (car bounds) (point))) 480 | (stop (or (cdr bounds) (point))) 481 | (collection (anaconda-mode-complete-extract-names result)) 482 | (completion-extra-properties '(:annotation-function anaconda-mode-complete-annotation))) 483 | (completion-in-region start stop collection))) 484 | 485 | (defun anaconda-mode-complete-extract-names (result) 486 | "Extract completion names from `anaconda-mode' RESULT." 487 | (--map (let ((name (aref it 0)) 488 | (type (aref it 1))) 489 | (put-text-property 0 1 'type type name) 490 | name) 491 | result)) 492 | 493 | (defun anaconda-mode-complete-annotation (candidate) 494 | "Get annotation for CANDIDATE." 495 | (--when-let (get-text-property 0 'type candidate) 496 | (concat " <" it ">"))) 497 | 498 | 499 | ;;; View documentation. 500 | 501 | (defun anaconda-mode-show-doc () 502 | "Show documentation for context at point." 503 | (interactive) 504 | (anaconda-mode-call "show_doc" 'anaconda-mode-show-doc-callback)) 505 | 506 | (defun anaconda-mode-show-doc-callback (result) 507 | "Process view doc RESULT." 508 | (if (> (length result) 0) 509 | (if (and anaconda-mode-use-posframe-show-doc 510 | (require 'posframe nil 'noerror) 511 | (posframe-workable-p)) 512 | (anaconda-mode-documentation-posframe-view result) 513 | (pop-to-buffer (anaconda-mode-documentation-view result) t)) 514 | (message "No documentation available"))) 515 | 516 | (defun anaconda-mode-documentation-view (result) 517 | "Show documentation view for rpc RESULT, and return buffer." 518 | (let ((buf (get-buffer-create "*Anaconda*"))) 519 | (with-current-buffer buf 520 | (view-mode -1) 521 | (erase-buffer) 522 | (mapc 523 | (lambda (it) 524 | (insert (propertize (aref it 0) 'face 'bold)) 525 | (insert "\n") 526 | (insert (s-trim-right (aref it 1))) 527 | (insert "\n\n")) 528 | result) 529 | (view-mode 1) 530 | (goto-char (point-min)) 531 | buf))) 532 | 533 | (defun anaconda-mode-documentation-posframe-view (result) 534 | "Show documentation view in posframe for rpc RESULT." 535 | (with-current-buffer (get-buffer-create anaconda-mode-doc-frame-name) 536 | (erase-buffer) 537 | (mapc 538 | (lambda (it) 539 | (insert (propertize (aref it 0) 'face 'bold)) 540 | (insert "\n") 541 | (insert (s-trim-left (aref it 1))) 542 | (insert "\n\n")) 543 | result)) 544 | (posframe-show anaconda-mode-doc-frame-name 545 | :position (point) 546 | :internal-border-width 10 547 | :background-color anaconda-mode-doc-frame-background 548 | :foreground-color anaconda-mode-doc-frame-foreground) 549 | (add-hook 'post-command-hook 'anaconda-mode-hide-frame) 550 | (setq anaconda-mode-frame-last-point (point)) 551 | (setq anaconda-mode-frame-last-scroll-offset (window-start))) 552 | 553 | (defun anaconda-mode-hide-frame () 554 | "Hide posframe when window scroll or move point." 555 | (ignore-errors 556 | (when (get-buffer anaconda-mode-doc-frame-name) 557 | (unless (and (equal (point) anaconda-mode-frame-last-point) 558 | (equal (window-start) anaconda-mode-frame-last-scroll-offset)) 559 | (posframe-hide anaconda-mode-doc-frame-name) 560 | (remove-hook 'post-command-hook 'anaconda-mode-hide-frame))))) 561 | 562 | 563 | ;;; Find definitions. 564 | 565 | (defun anaconda-mode-find-definitions () 566 | "Find definitions for thing at point." 567 | (interactive) 568 | (anaconda-mode-call 569 | "infer" 570 | (lambda (result) 571 | (anaconda-mode-show-xrefs result nil "No definitions found")))) 572 | 573 | (defun anaconda-mode-find-definitions-other-window () 574 | "Find definitions for thing at point." 575 | (interactive) 576 | (anaconda-mode-call 577 | "infer" 578 | (lambda (result) 579 | (anaconda-mode-show-xrefs result 'window "No definitions found")))) 580 | 581 | (defun anaconda-mode-find-definitions-other-frame () 582 | "Find definitions for thing at point." 583 | (interactive) 584 | (anaconda-mode-call 585 | "infer" 586 | (lambda (result) 587 | (anaconda-mode-show-xrefs result 'frame "No definitions found")))) 588 | 589 | 590 | ;;; Find assignments. 591 | 592 | (defun anaconda-mode-find-assignments () 593 | "Find assignments for thing at point." 594 | (interactive) 595 | (anaconda-mode-call 596 | "goto" 597 | (lambda (result) 598 | (anaconda-mode-show-xrefs result nil "No assignments found")))) 599 | 600 | (defun anaconda-mode-find-assignments-other-window () 601 | "Find assignments for thing at point." 602 | (interactive) 603 | (anaconda-mode-call 604 | "goto" 605 | (lambda (result) 606 | (anaconda-mode-show-xrefs result 'window "No assignments found")))) 607 | 608 | (defun anaconda-mode-find-assignments-other-frame () 609 | "Find assignments for thing at point." 610 | (interactive) 611 | (anaconda-mode-call 612 | "goto" 613 | (lambda (result) 614 | (anaconda-mode-show-xrefs result 'frame "No assignments found")))) 615 | 616 | 617 | ;;; Find references. 618 | 619 | (defun anaconda-mode-find-references () 620 | "Find references for thing at point." 621 | (interactive) 622 | (anaconda-mode-call 623 | "get_references" 624 | (lambda (result) 625 | (anaconda-mode-show-xrefs result nil "No references found")))) 626 | 627 | (defun anaconda-mode-find-references-other-window () 628 | "Find references for thing at point." 629 | (interactive) 630 | (anaconda-mode-call 631 | "get_references" 632 | (lambda (result) 633 | (anaconda-mode-show-xrefs result 'window "No references found")))) 634 | 635 | (defun anaconda-mode-find-references-other-frame () 636 | "Find references for thing at point." 637 | (interactive) 638 | (anaconda-mode-call 639 | "get_references" 640 | (lambda (result) 641 | (anaconda-mode-show-xrefs result 'frame "No references found")))) 642 | 643 | 644 | ;;; Xref. 645 | 646 | (defun anaconda-mode-xref-backend () 647 | "Integrate `anaconda-mode' with xref." 648 | 'anaconda) 649 | 650 | (cl-defmethod xref-backend-definitions ((_backend (eql anaconda)) _identifier) 651 | "Find definitions for thing at point." 652 | (anaconda-mode-call-sync 653 | "infer" 654 | (lambda (result) 655 | (if result 656 | (if (stringp result) 657 | (progn 658 | (message result) 659 | nil) 660 | (anaconda-mode-make-xrefs result)))))) 661 | 662 | (cl-defmethod xref-backend-references ((_backend (eql anaconda)) _identifier) 663 | "Find references for thing at point." 664 | (anaconda-mode-call-sync 665 | "get_references" 666 | (lambda (result) 667 | (if result 668 | (if (stringp result) 669 | (progn 670 | (message result) 671 | nil) 672 | (anaconda-mode-make-xrefs result)))))) 673 | 674 | (cl-defmethod xref-backend-apropos ((_backend (eql anaconda)) _pattern) 675 | "Not implemented." 676 | nil) 677 | 678 | (cl-defmethod xref-backend-identifier-completion-table ((_backend (eql anaconda))) 679 | "Not implemented." 680 | nil) 681 | 682 | (defun anaconda-mode-show-xrefs (result display-action error-message) 683 | "Show xref from RESULT using DISPLAY-ACTION. 684 | Show ERROR-MESSAGE if result is empty." 685 | (if result 686 | (if (stringp result) 687 | (message result) 688 | (let ((xrefs (anaconda-mode-make-xrefs result))) 689 | (if (not (cdr xrefs)) 690 | (progn 691 | (xref-push-marker-stack) 692 | (funcall (if (fboundp 'xref-pop-to-location) 693 | 'xref-pop-to-location 694 | 'xref--pop-to-location) 695 | (cl-first xrefs) 696 | display-action)) 697 | (xref--show-xrefs (if (functionp 'xref--create-fetcher) 698 | (lambda (&rest _) xrefs) 699 | xrefs) 700 | display-action)))) 701 | (message error-message))) 702 | 703 | (defun anaconda-mode-make-xrefs (result) 704 | "Return a list of x-reference candidates created from RESULT." 705 | (--map 706 | (xref-make 707 | (aref it 3) 708 | (xref-make-file-location (pythonic-emacs-readable-file-name (aref it 0)) (aref it 1) (aref it 2))) 709 | result)) 710 | 711 | 712 | ;;; Eldoc. 713 | 714 | (defun anaconda-mode-eldoc-function (callback &rest _ignored) 715 | "Show eldoc for context at point." 716 | (anaconda-mode-call 717 | "eldoc" 718 | (lambda (x) 719 | (funcall callback (anaconda-mode-eldoc-format x)))) 720 | ;; Don't show response buffer name as ElDoc message. 721 | nil) 722 | 723 | (defun anaconda-mode-eldoc-format (result) 724 | "Format eldoc string from RESULT." 725 | (when result 726 | (let ((doc (cl-map 'list 727 | (lambda (s) 728 | (anaconda-mode-eldoc-format-definition 729 | (aref s 0) 730 | (aref s 1) 731 | (aref s 2))) 732 | result))) 733 | (if anaconda-mode-eldoc-as-single-line 734 | (let ((d (mapconcat #'identity doc ", "))) 735 | (substring d 0 (min (frame-width) (length d)))) 736 | (mapconcat #'identity doc "\n"))))) 737 | 738 | (defun anaconda-mode-eldoc-format-definition (name index params) 739 | "Format function definition from NAME, INDEX and PARAMS." 740 | (when index 741 | (aset params index (propertize (aref params index) 'face 'eldoc-highlight-function-argument))) 742 | (concat (propertize name 'face 'font-lock-function-name-face) "(" (mapconcat 'identity params ", ") ")")) 743 | 744 | 745 | ;;; Anaconda minor mode. 746 | 747 | (defvar anaconda-mode-map 748 | (let ((map (make-sparse-keymap))) 749 | (define-key map (kbd "C-M-i") 'anaconda-mode-complete) 750 | (define-key map (kbd "M-.") 'anaconda-mode-find-definitions) 751 | (define-key map (kbd "C-x 4 .") 'anaconda-mode-find-definitions-other-window) 752 | (define-key map (kbd "C-x 5 .") 'anaconda-mode-find-definitions-other-frame) 753 | (define-key map (kbd "M-=") 'anaconda-mode-find-assignments) 754 | (define-key map (kbd "C-x 4 =") 'anaconda-mode-find-assignments-other-window) 755 | (define-key map (kbd "C-x 5 =") 'anaconda-mode-find-assignments-other-frame) 756 | (define-key map (kbd "M-r") 'anaconda-mode-find-references) 757 | (define-key map (kbd "C-x 4 r") 'anaconda-mode-find-references-other-window) 758 | (define-key map (kbd "C-x 5 r") 'anaconda-mode-find-references-other-frame) 759 | (define-key map (kbd "M-,") 'xref-pop-marker-stack) 760 | (define-key map (kbd "M-?") 'anaconda-mode-show-doc) 761 | map) 762 | "Keymap for `anaconda-mode'.") 763 | 764 | ;;;###autoload 765 | (define-minor-mode anaconda-mode 766 | "Code navigation, documentation lookup and completion for Python. 767 | 768 | \\{anaconda-mode-map}" 769 | :lighter anaconda-mode-lighter 770 | :keymap anaconda-mode-map 771 | (setq-local url-http-attempt-keepalives nil) 772 | (if anaconda-mode 773 | (add-hook 'xref-backend-functions #'anaconda-mode-xref-backend nil t) 774 | (remove-hook 'xref-backend-functions #'anaconda-mode-xref-backend t))) 775 | 776 | ;;;###autoload 777 | (define-minor-mode anaconda-eldoc-mode 778 | "Toggle echo area display of Python objects at point." 779 | :lighter "" 780 | (if anaconda-eldoc-mode 781 | (turn-on-anaconda-eldoc-mode) 782 | (turn-off-anaconda-eldoc-mode))) 783 | 784 | (defun turn-on-anaconda-eldoc-mode () 785 | "Turn on `anaconda-eldoc-mode'." 786 | (add-hook 'eldoc-documentation-functions 787 | #'anaconda-mode-eldoc-function nil 't) 788 | (unless (bound-and-true-p eldoc-mode) 789 | (eldoc-mode +1))) 790 | 791 | (defun turn-off-anaconda-eldoc-mode () 792 | "Turn off `anaconda-eldoc-mode'." 793 | (remove-hook 'eldoc-documentation-functions 794 | #'anaconda-mode-eldoc-function 't)) 795 | 796 | (provide 'anaconda-mode) 797 | 798 | ;;; anaconda-mode.el ends here 799 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | --------------------------------------------------------------------------------