From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mp2 ([2001:41d0:2:4a6f::]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) by ms0.migadu.com with LMTPS id mGREMiE6fWBXGQAAgWs5BA (envelope-from ) for ; Mon, 19 Apr 2021 10:06:57 +0200 Received: from aspmx1.migadu.com ([2001:41d0:2:4a6f::]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)) by mp2 with LMTPS id uPwsLSE6fWDHOAAAB5/wlQ (envelope-from ) for ; Mon, 19 Apr 2021 08:06:57 +0000 Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by aspmx1.migadu.com (Postfix) with ESMTPS id E192621AE9 for ; Mon, 19 Apr 2021 10:06:56 +0200 (CEST) Received: from localhost ([::1]:53502 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1lYOvo-0001Pt-1D for larch@yhetil.org; Mon, 19 Apr 2021 04:06:56 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]:60398) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1lYOuk-0001OR-Bt for emacs-orgmode@gnu.org; Mon, 19 Apr 2021 04:05:50 -0400 Received: from mout02.posteo.de ([185.67.36.66]:56127) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1lYOug-00056A-Fb for emacs-orgmode@gnu.org; Mon, 19 Apr 2021 04:05:50 -0400 Received: from submission (posteo.de [89.146.220.130]) by mout02.posteo.de (Postfix) with ESMTPS id 729262400E5 for ; Mon, 19 Apr 2021 10:05:41 +0200 (CEST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=posteo.eu; s=2017; t=1618819541; bh=3+YSoKRSde4xY6I600tfNg/NMZ0+6y2ky8+h2Qdtlgw=; h=Subject:To:Cc:From:Date:From; b=bhrIH4fYrLRPaB3lb6ZS9JJYL4w+tOYXs3pT83r6B5JO5wgyshT1KilhMvYa1uOem l4IHQhGy1S8z+e99Yl4fROVudiDBRXAKD0yUdQROt1zK3YggenjHcEfg8IllfjhnMm Mk7XbZprvv9FTNZYAZw98vdqLZugD1h60vVDz8YzwLJMGgPoIWG7YVO5oRjw83T41y jPS76QGrt7kndiByvj++yE9zgscf0e+8n4ksAHAtpRdvRbKxsgW9b5uXzxg1E+0BVG BAOHpCYQ5qLqx6iDbow7amoKZc80WC0nXu7Zlip6mHE+e6Dm3Xd4ai5xE0pP7LtuQS M8WgEWt0LrqWg== Received: from customer (localhost [127.0.0.1]) by submission (posteo.de) with ESMTPSA id 4FNzs05FM4z9rxY; Mon, 19 Apr 2021 10:05:40 +0200 (CEST) Subject: Re: [PATCH] ob-tangle.el: Speed up tangling To: Tom Gillespie References: <57480e77-024a-adcc-ec9a-c20b84ac762a@posteo.eu> From: =?UTF-8?Q?S=c3=a9bastien_Miquel?= Message-ID: Date: Mon, 19 Apr 2021 08:05:40 +0000 MIME-Version: 1.0 In-Reply-To: Content-Type: multipart/mixed; boundary="------------1D5174DCAC23C293E8862DEB" Content-Language: fr Received-SPF: pass client-ip=185.67.36.66; envelope-from=sebastien.miquel@posteo.eu; helo=mout02.posteo.de X-Spam_score_int: -27 X-Spam_score: -2.8 X-Spam_bar: -- X-Spam_report: (-2.8 / 5.0 requ) BAYES_00=-1.9, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1, RCVD_IN_DNSWL_LOW=-0.7, RCVD_IN_MSPIKE_H4=-0.01, RCVD_IN_MSPIKE_WL=-0.01, SPF_HELO_NONE=0.001, SPF_PASS=-0.001 autolearn=ham autolearn_force=no X-Spam_action: no action X-BeenThere: emacs-orgmode@gnu.org X-Mailman-Version: 2.1.23 Precedence: list List-Id: "General discussions about Org-mode." List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Reply-To: sebastien.miquel@posteo.eu Cc: emacs-orgmode Errors-To: emacs-orgmode-bounces+larch=yhetil.org@gnu.org Sender: "Emacs-orgmode" X-Migadu-Flow: FLOW_IN ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=yhetil.org; s=key1; t=1618819617; h=from:from:sender:sender:reply-to:reply-to:subject:subject:date:date: message-id:message-id:to:to:cc:cc:mime-version:mime-version: content-type:content-type:in-reply-to:in-reply-to: references:references:list-id:list-help:list-unsubscribe: list-subscribe:list-post:dkim-signature; bh=Y2Cc4Iyu0BqaoDo1+uBeypoYz87Te88WTAKBz7MQ5oc=; b=eMK86MqW9f6q2UFa/lAujnbemHSYsQx5T1jmSNL0XoqT4dQiYhfp9HmT/ztr1F0/ODBm/k HViU5YFzrk60PZCyVNVCoELcZBjuEvjBvXFfoXHOaaNxEQTyGYWb6ifr23mxQJh25WRA/e 8sq48IRdxTxOhtHf3FXEUyDHyc6dlW/VEqwiW3KbNMO+GtUXwOgWUxtH2wFdYxDSxBTMR1 +mSGukSFGx6/zCC6kBjw/LsmDAi0yVvcyR8loLx0Bc086TKWbVa/1SxNTwQtkyt4v6GDvF rSE0KGgKY+nds/GqctCkDJIst1Y8W1BKfw2H09uQqCvZiYMy7XlgoD97Xkgj0Q== ARC-Seal: i=1; s=key1; d=yhetil.org; t=1618819617; a=rsa-sha256; cv=none; b=odRfibC4RWM5Pq1OjHJ9hg6eYDhDlgsavKSBKnaxVlFuX0r4Z7PLiOKvfxV7ZqLZo9+ISc vYFTtnl+aZ42Njnq48Dg0EkIB+FKrYLHiXCnEslzvQ7IWH9ejTXekSsCNAJCQT7F1zQu5X 4MUoxEldJ4l80I2MhoWAPfj3iH3Ynkd1RgjtRwTkYEPw5Jzwgrw48p5N/i2bqOkovAAUWC vgBqzzC4iReIL+PmhU6r/nEaCTXVGk/Aj47B643ohHDoUtfRf5tWOZwpMx3zwQFPOn8llc o0hKMim79V8QneZs30G9RMiJ9TxGiyN6aOGKiy5kgOUW68TRMlsI50QyDb+vWg== ARC-Authentication-Results: i=1; aspmx1.migadu.com; dkim=pass header.d=posteo.eu header.s=2017 header.b=bhrIH4fY; spf=pass (aspmx1.migadu.com: domain of emacs-orgmode-bounces@gnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom=emacs-orgmode-bounces@gnu.org X-Migadu-Spam-Score: -3.14 Authentication-Results: aspmx1.migadu.com; dkim=pass header.d=posteo.eu header.s=2017 header.b=bhrIH4fY; dmarc=pass (policy=none) header.from=posteo.eu; spf=pass (aspmx1.migadu.com: domain of emacs-orgmode-bounces@gnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom=emacs-orgmode-bounces@gnu.org X-Migadu-Queue-Id: E192621AE9 X-Spam-Score: -3.14 X-Migadu-Scanner: scn0.migadu.com X-TUID: qONjkBSGw7Dc This is a multi-part message in MIME format. --------------1D5174DCAC23C293E8862DEB Content-Type: text/plain; charset=utf-8; format=flowed Content-Transfer-Encoding: 8bit Hi Tom, Thank you for the comments. Tom Gillespie writes: > All of the issues that I'm aware of are related to what > happens if tangling fails part way through the process. That's not something I had considered. I wrote a new version of the patch (attached) which addresses the insecure behaviour and the possibility of failure. Please tell me what you think. I've also  + silenced the ~write-region~ messages, since I'm now writing to    temporary files.  + added the list of tangled files to the message to the user at the    end of the tangling process.  + replaced the use of ~when-let~. Regards, -- Sébastien Miquel --------------1D5174DCAC23C293E8862DEB Content-Type: text/x-patch; charset=UTF-8; name="0001-ob-tangle.el-Improve-tangling.patch" Content-Transfer-Encoding: 7bit Content-Disposition: attachment; filename="0001-ob-tangle.el-Improve-tangling.patch" >From 82e4c1beade71194c90d377cdff7ef23532f4aa2 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?S=C3=A9bastien=20Miquel?= Date: Sat, 17 Apr 2021 21:48:30 +0200 Subject: [PATCH] ob-tangle.el: Improve tangling ,* lisp/ob-tangle.el (org-babel-tangle-collect-blocks): Group collected blocks by tangled file name. (org-babel-tangle): Avoid quadratic behavior in number of blocks. Preserve original file in case of failure. Display the list of tangled files at the end. --- lisp/ob-tangle.el | 167 ++++++++++++++++++++++++---------------------- 1 file changed, 87 insertions(+), 80 deletions(-) diff --git a/lisp/ob-tangle.el b/lisp/ob-tangle.el index 4c0c3132d..efafef5b8 100644 --- a/lisp/ob-tangle.el +++ b/lisp/ob-tangle.el @@ -225,87 +225,83 @@ matching a regular expression." (or (cdr (assq :tangle (nth 2 (org-babel-get-src-block-info 'light)))) (user-error "Point is not in a source code block")))) path-collector) - (mapc ;; map over all languages - (lambda (by-lang) - (let* ((lang (car by-lang)) - (specs (cdr by-lang)) - (ext (or (cdr (assoc lang org-babel-tangle-lang-exts)) lang)) - (lang-f (org-src-get-lang-mode lang)) - she-banged) - (mapc - (lambda (spec) - (let ((get-spec (lambda (name) (cdr (assoc name (nth 4 spec)))))) - (let* ((tangle (funcall get-spec :tangle)) - (she-bang (let ((sheb (funcall get-spec :shebang))) - (when (> (length sheb) 0) sheb))) - (tangle-mode (funcall get-spec :tangle-mode)) - (base-name (cond - ((string= "yes" tangle) - (file-name-sans-extension - (nth 1 spec))) - ((string= "no" tangle) nil) - ((> (length tangle) 0) tangle))) - (file-name (when base-name - ;; decide if we want to add ext to base-name - (if (and ext (string= "yes" tangle)) - (concat base-name "." ext) base-name)))) - (when file-name - ;; Possibly create the parent directories for file. - (let ((m (funcall get-spec :mkdirp)) - (fnd (file-name-directory file-name))) - (and m fnd (not (string= m "no")) - (make-directory fnd 'parents))) - ;; delete any old versions of file - (and (file-exists-p file-name) - (not (member file-name (mapcar #'car path-collector))) - (delete-file file-name)) - ;; drop source-block to file - (with-temp-buffer - (when (fboundp lang-f) (ignore-errors (funcall lang-f))) - (when (and she-bang (not (member file-name she-banged))) + (mapc ;; map over file-names + (lambda (by-fn) + (let ((file-name (car by-fn))) + (when file-name + (let ((lspecs (cdr by-fn)) + (fnd (file-name-directory file-name)) + modes make-dir she-banged lang) + ;; drop source-blocks to file + ;; We avoid append-to-file as it does not work with tramp. + (with-temp-buffer + (mapc + (lambda (lspec) + (let* ((block-lang (car lspec)) + (spec (cdr lspec)) + (get-spec (lambda (name) (cdr (assq name (nth 4 spec))))) + (she-bang (let ((sheb (funcall get-spec :shebang))) + (when (> (length sheb) 0) sheb))) + (tangle-mode (funcall get-spec :tangle-mode))) + (unless (string-equal block-lang lang) + (setq lang block-lang) + (let ((lang-f (org-src-get-lang-mode lang))) + (when (fboundp lang-f) (ignore-errors (funcall lang-f))))) + ;; if file contains she-bangs, then make it executable + (when she-bang + (unless tangle-mode (setq tangle-mode #o755))) + (when tangle-mode + (add-to-list modes tangle-mode)) + ;; Possibly create the parent directories for file. + (let ((m (funcall get-spec :mkdirp))) + (and m fnd (not (string= m "no")) + (setq make-dir t))) + ;; Handle :padlines unless first line in file + (unless (or (string= "no" (funcall get-spec :padline)) + (= (point) (point-min))) + (insert "\n")) + (when (and she-bang (not she-banged)) (insert (concat she-bang "\n")) - (setq she-banged (cons file-name she-banged))) - (org-babel-spec-to-string spec) - ;; We avoid append-to-file as it does not work with tramp. - (let ((content (buffer-string))) - (with-temp-buffer - (when (file-exists-p file-name) - (insert-file-contents file-name)) - (goto-char (point-max)) - ;; Handle :padlines unless first line in file - (unless (or (string= "no" (cdr (assq :padline (nth 4 spec)))) - (= (point) (point-min))) - (insert "\n")) - (insert content) - (write-region nil nil file-name)))) - ;; if files contain she-bangs, then make the executable - (when she-bang - (unless tangle-mode (setq tangle-mode #o755))) - ;; update counter - (setq block-counter (+ 1 block-counter)) - (unless (assoc file-name path-collector) - (push (cons file-name tangle-mode) path-collector)))))) - specs))) + (setq she-banged t)) + (org-babel-spec-to-string spec) + (setq block-counter (+ 1 block-counter)))) + lspecs) + (when make-dir + (make-directory fnd 'parents)) + ;; write buffer to file-name using a tmp-file to try to preserve + ;; the original file in case of failure + (let ((tmp-file (concat file-name ".tangling"))) + (condition-case ex + (progn + ;; set permissions on empty file before writing + (write-region "" nil tmp-file nil 0) + (mapc (lambda (mode) (set-file-modes tmp-file mode)) modes) + (write-region nil nil tmp-file nil 0) + (rename-file tmp-file file-name t) + (push file-name path-collector)) + ('error + (message (format "Failed to tangle to %s: [%s]" file-name ex)) + ;; try to cleanup + (when (file-exists-p tmp-file) + (ignore-errors (delete-file tmp-file))))))))))) (if (equal arg '(4)) (org-babel-tangle-single-block 1 t) (org-babel-tangle-collect-blocks lang-re tangle-file))) - (message "Tangled %d code block%s from %s" block-counter + (message "Tangled %d code block%s from %s to %s" block-counter (if (= block-counter 1) "" "s") (file-name-nondirectory (buffer-file-name - (or (buffer-base-buffer) (current-buffer))))) + (or (buffer-base-buffer) (current-buffer)))) + (if (= (length path-collector) 1) + (car path-collector) path-collector)) ;; run `org-babel-post-tangle-hook' in all tangled files (when org-babel-post-tangle-hook (mapc (lambda (file) (org-babel-with-temp-filebuffer file (run-hooks 'org-babel-post-tangle-hook))) - (mapcar #'car path-collector))) - ;; set permissions on tangled files - (mapc (lambda (pair) - (when (cdr pair) (set-file-modes (car pair) (cdr pair)))) - path-collector) - (mapcar #'car path-collector))))) + path-collector)) + path-collector)))) (defun org-babel-tangle-clean () "Remove comments inserted by `org-babel-tangle'. @@ -368,12 +364,12 @@ that the appropriate major-mode is set. SPEC has the form: (defun org-babel-tangle-collect-blocks (&optional lang-re tangle-file) "Collect source blocks in the current Org file. -Return an association list of source-code block specifications of -the form used by `org-babel-spec-to-string' grouped by language. -Optional argument LANG-RE can be used to limit the collected -source code blocks by languages matching a regular expression. -Optional argument TANGLE-FILE can be used to limit the collected -code blocks by target file." +Return an association list of language and source-code block +specifications of the form used by `org-babel-spec-to-string' +grouped by tangled file name. Optional argument LANG-RE can be +used to limit the collected source code blocks by languages +matching a regular expression. Optional argument TANGLE-FILE can +be used to limit the collected code blocks by target file." (let ((counter 0) last-heading-pos blocks) (org-babel-map-src-blocks (buffer-file-name) (let ((current-heading-pos @@ -390,12 +386,23 @@ code blocks by target file." (unless (or (string= src-tfile "no") (and tangle-file (not (equal tangle-file src-tfile))) (and lang-re (not (string-match-p lang-re src-lang)))) - ;; Add the spec for this block to blocks under its - ;; language. - (let ((by-lang (assoc src-lang blocks)) - (block (org-babel-tangle-single-block counter))) - (if by-lang (setcdr by-lang (cons block (cdr by-lang))) - (push (cons src-lang (list block)) blocks))))))) + ;; Add the spec for this block to blocks under its tangled + ;; file name. + (let* ((block (org-babel-tangle-single-block counter)) + (base-name (cond + ((string= "yes" src-tfile) + ;; buffer name + (file-name-sans-extension + (nth 1 block))) + ((> (length src-tfile) 0) src-tfile))) + (ext (or (cdr (assoc src-lang org-babel-tangle-lang-exts)) src-lang)) + (file-name (when base-name + ;; decide if we want to add ext to base-name + (if (and ext (string= "yes" src-tfile)) + (concat base-name "." ext) base-name))) + (by-fn (assoc file-name blocks))) + (if by-fn (setcdr by-fn (cons (cons src-lang block) (cdr by-fn))) + (push (cons file-name (list (cons src-lang block))) blocks))))))) ;; Ensure blocks are in the correct order. (mapcar (lambda (b) (cons (car b) (nreverse (cdr b)))) (nreverse blocks)))) -- 2.31.1 --------------1D5174DCAC23C293E8862DEB--