mirror of
https://github.com/vale981/emacs-ipython-notebook
synced 2025-03-06 09:31:39 -05:00
193 lines
7.2 KiB
EmacsLisp
193 lines
7.2 KiB
EmacsLisp
;;; ein-pytools.el --- Python tools build on top of kernel
|
|
|
|
;; Copyright (C) 2012- Takafumi Arakaki
|
|
|
|
;; Author: Takafumi Arakaki
|
|
|
|
;; This file is NOT part of GNU Emacs.
|
|
|
|
;; ein-pytools.el is free software: you can redistribute it and/or modify
|
|
;; it under the terms of the GNU General Public License as published by
|
|
;; the Free Software Foundation, either version 3 of the License, or
|
|
;; (at your option) any later version.
|
|
|
|
;; ein-pytools.el is distributed in the hope that it will be useful,
|
|
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
;; GNU General Public License for more details.
|
|
|
|
;; You should have received a copy of the GNU General Public License
|
|
;; along with ein-pytools.el. If not, see <http://www.gnu.org/licenses/>.
|
|
|
|
;;; Commentary:
|
|
|
|
;;
|
|
|
|
;;; Code:
|
|
|
|
(eval-when-compile (require 'cl))
|
|
|
|
(require 'ein-kernel)
|
|
(require 'ein-shared-output)
|
|
|
|
(eval-when-compile (defvar ein:notebook)
|
|
(defvar ein:@connect))
|
|
(declare-function ein:$notebook-kernel "ein-notebook")
|
|
(declare-function ein:notebook-buffer "ein-notebook")
|
|
(declare-function ein:connect-get-kernel "ein-connect")
|
|
(declare-function ein:connect-get-notebook "ein-connect")
|
|
(declare-function ein:connect-to-notebook "ein-connect")
|
|
|
|
(defun ein:goto-file (filename lineno &optional other-window)
|
|
"Jump to file FILEAME at line LINENO.
|
|
If OTHER-WINDOW is non-`nil', open the file in the other window."
|
|
(funcall (if other-window #'find-file-other-window #'find-file) filename)
|
|
(goto-char (point-min))
|
|
(forward-line (1- lineno)))
|
|
|
|
(defun ein:goto-marker (marker &optional other-window)
|
|
(funcall (if other-window #'pop-to-buffer #'switch-to-buffer)
|
|
(marker-buffer marker))
|
|
(goto-char marker))
|
|
|
|
(defcustom ein:propagate-connect t
|
|
"Set to `t' to connect to the notebook after jumping to a buffer."
|
|
:type '(choice (const :tag "Yes" t)
|
|
(const :tag "No" nil))
|
|
:group 'ein)
|
|
|
|
(defun ein:pytools-get-kernel ()
|
|
(require 'ein-connect)
|
|
(cond
|
|
(ein:notebook (ein:$notebook-kernel ein:notebook))
|
|
(ein:@connect (ein:connect-get-kernel))
|
|
((eq major-mode 'ein:shared-output-mode) (ein:shared-output-get-kernel))))
|
|
|
|
(defun ein:pytools-get-notebook ()
|
|
(require 'ein-connect)
|
|
(cond
|
|
(ein:notebook ein:notebook)
|
|
(ein:@connect (ein:connect-get-notebook))))
|
|
|
|
(defun ein:pytools-get-notebook-buffer ()
|
|
(ein:aand (ein:pytools-get-notebook) (ein:notebook-buffer it)))
|
|
|
|
(defun ein:pytools-setup-hooks (kernel)
|
|
(push (cons #'ein:pytools-add-sys-path kernel)
|
|
(ein:$kernel-after-start-hook kernel)))
|
|
|
|
(defun ein:pytools-add-sys-path (kernel)
|
|
(ein:kernel-execute
|
|
kernel
|
|
(format "__import__('sys').path.append('%s')" ein:source-dir)))
|
|
|
|
(defvar ein:pytools-jump-stack nil)
|
|
|
|
(defvar ein:pytools-jump-to-source-not-found-regexp
|
|
(ein:join-str "\\|"
|
|
(list "^WARNING: .*"
|
|
"^Traceback (most recent call last):\n"
|
|
"^.*<ipython-input-[^>\n]+>\n"
|
|
"^\n")))
|
|
|
|
(defun ein:pytools-jump-to-source (kernel object &optional
|
|
other-window notebook-buffer)
|
|
(ein:log 'info "Jumping to the source of %s..." object)
|
|
(let ((last (car ein:pytools-jump-stack)))
|
|
(if (ein:aand last (eql (current-buffer) (marker-buffer it)))
|
|
(unless (equal (point) (marker-position last))
|
|
(push (point-marker) ein:pytools-jump-stack))
|
|
(setq ein:pytools-jump-stack (list (point-marker)))))
|
|
(ein:kernel-execute
|
|
kernel
|
|
(format "__import__('ein').find_source('%s')" object)
|
|
(list
|
|
:output
|
|
(cons
|
|
(lambda (packed msg-type content)
|
|
(let ((object (nth 0 packed))
|
|
(other-window (nth 1 packed))
|
|
(notebook-buffer (nth 2 packed)))
|
|
(ein:case-equal msg-type
|
|
(("stream")
|
|
(ein:aif (plist-get content :data)
|
|
(if (string-match ein:pytools-jump-to-source-not-found-regexp
|
|
it)
|
|
(ein:log 'info
|
|
"Jumping to the source of %s...Not found" object)
|
|
(destructuring-bind (filename &optional lineno &rest ignore)
|
|
(split-string it "\n")
|
|
(setq lineno (string-to-number lineno))
|
|
(ein:goto-file filename lineno other-window)
|
|
(when (and notebook-buffer (not ein:@connect))
|
|
(ein:connect-to-notebook notebook-buffer))
|
|
(push (point-marker) ein:pytools-jump-stack)
|
|
(ein:log 'info
|
|
"Jumping to the source of %s...Done" object)))))
|
|
(("pyerr")
|
|
(ein:log 'info
|
|
"Jumping to the source of %s...Not found" object)))))
|
|
(list object other-window notebook-buffer)))))
|
|
|
|
(defun ein:pytools-jump-to-source-command (&optional other-window)
|
|
"Jump to the source code of the object at point.
|
|
When the prefix argument ``C-u`` is given, open the source code
|
|
in the other window. You can explicitly specify the object by
|
|
selecting it."
|
|
(interactive "P")
|
|
(let ((kernel (ein:pytools-get-kernel))
|
|
(object (ein:object-at-point)))
|
|
(assert (ein:kernel-ready-p kernel) nil "Kernel is not ready.")
|
|
(assert object nil "Object at point not found.")
|
|
(ein:pytools-jump-to-source kernel object other-window
|
|
(when ein:propagate-connect
|
|
(ein:pytools-get-notebook-buffer)))))
|
|
|
|
(defun ein:pytools-jump-back-command (&optional other-window)
|
|
"Go back to the point where `ein:pytools-jump-to-source-command'
|
|
is executed last time. When the prefix argument ``C-u`` is
|
|
given, open the last point in the other window."
|
|
(interactive "P")
|
|
(when (ein:aand (car ein:pytools-jump-stack)
|
|
(equal (point) (marker-position it)))
|
|
(setq ein:pytools-jump-stack (cdr ein:pytools-jump-stack)))
|
|
(ein:aif (car ein:pytools-jump-stack)
|
|
(ein:goto-marker it other-window)
|
|
(ein:log 'info "Nothing on stack.")))
|
|
|
|
(defun ein:pytools-eval-string-internal (code &optional popup)
|
|
(let ((cell (ein:shared-output-get-cell))
|
|
(kernel (ein:pytools-get-kernel))
|
|
(code (ein:trim-indent code)))
|
|
(ein:cell-execute cell kernel code popup)))
|
|
|
|
(defun ein:pytools-doctest ()
|
|
"Do the doctest of the object at point."
|
|
(interactive)
|
|
(let ((object (ein:object-at-point)))
|
|
(ein:pytools-eval-string-internal
|
|
(format "__import__('ein').run_docstring_examples(%s)" object)
|
|
t)))
|
|
|
|
(defun ein:pytools-whos ()
|
|
"Execute ``%whos`` magic command and popup the result."
|
|
(interactive)
|
|
(ein:pytools-eval-string-internal "%whos" t))
|
|
|
|
(defun ein:pytools-hierarchy (&optional ask)
|
|
"Draw inheritance graph of the class at point.
|
|
hierarchymagic_ extension is needed to be installed.
|
|
You can explicitly specify the object by selecting it.
|
|
|
|
.. _hierarchymagic: https://github.com/tkf/ipython-hierarchymagic"
|
|
(interactive "P")
|
|
(let ((object (ein:object-at-point)))
|
|
(when ask
|
|
(setq object (read-from-minibuffer "class or object: " object)))
|
|
(assert (and object (not (equal object "")))
|
|
nil "Object at point not found.")
|
|
(ein:pytools-eval-string-internal (format "%%hierarchy %s" object) t)))
|
|
|
|
(provide 'ein-pytools)
|
|
|
|
;;; ein-pytools.el ends here
|