├── .ert-runner ├── Cask ├── LICENSE ├── Makefile ├── Readme.org ├── lisp ├── ob-session-async-R.el ├── ob-session-async-python.el ├── ob-session-async-ruby.el └── ob-session-async.el └── test ├── ob-session-async-R-test.el ├── ob-session-async-python-test.el ├── ob-session-async-ruby-test.el └── test-helper.el /.ert-runner: -------------------------------------------------------------------------------- 1 | -L ./lisp -------------------------------------------------------------------------------- /Cask: -------------------------------------------------------------------------------- 1 | (source gnu) 2 | (source melpa) 3 | 4 | (package-file "lisp/ob-session-async.el") 5 | 6 | (development 7 | (depends-on "ert-runner") 8 | (depends-on "org-mode" 9 | :git "https://code.orgmode.org/bzg/org-mode.git" 10 | :files ("lisp/*.el" "contrib/lisp/*.el" "testing/org-test.el")) 11 | (depends-on "ob-async") 12 | (depends-on "inf-ruby") 13 | (depends-on "ess")) 14 | -------------------------------------------------------------------------------- /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 | -------------------------------------------------------------------------------- /Makefile: -------------------------------------------------------------------------------- 1 | SHELL = bash 2 | CASK ?= $(shell command -v cask) 3 | 4 | ifneq ($(TAGS),) 5 | override TAGS := -t $(TAGS) 6 | endif 7 | 8 | ifneq ($(PATTERN),) 9 | override PATTERN := -p $(PATTERN) 10 | endif 11 | 12 | .PHONY: cask 13 | cask: 14 | ifeq ($(CASK),) 15 | $(error "Install cask (https://github.com/cask/cask)") 16 | endif 17 | 18 | .PHONY: init 19 | init: cask 20 | $(CASK) --dev install 21 | $(CASK) --dev update 22 | 23 | .PHONY: test 24 | test: cask 25 | $(CASK) exec ert-runner --script $(TAGS) $(PATTERN) 26 | -------------------------------------------------------------------------------- /Readme.org: -------------------------------------------------------------------------------- 1 | #+TITLE: ob-session-async 2 | 3 | As of Org 9.5, this package is obsolete, with the core functionality 4 | now included in Org mode. 5 | 6 | This was a package to extend org-babel to allow asynchronous session 7 | evaluation. It implemented async session evaluation for R, Ruby, and 8 | Python, and also provides functionality for implementing async session 9 | evaluation in other language modes that use comint. 10 | 11 | * Status 12 | 13 | This project has achieved its goal of being added upstream into Org 14 | mode. Therefore, I am archiving it. 15 | 16 | * Installation & usage 17 | 18 | First, make sure you have installed Org 9.4 or later. 19 | 20 | Next ensure the ~lisp/~ directory is in your ~load-path~, and ~R~ is 21 | in ~org-babel-load-languages~. Then, ~(require 22 | 'ob-session-async-R)~. You will then be able to asynchronously 23 | evaluate R code blocks like the below: 24 | 25 | #+begin_src org 26 | ,#+begin_src R :async :session 27 | Sys.sleep(5) 28 | "this won't hang your emacs" 29 | ,#+end_src 30 | #+end_src 31 | 32 | * Related packages 33 | 34 | - [[https://github.com/dzop/emacs-jupyter][emacs-jupyter]] enables 35 | using jupyter kernels with org-babel source blocks, and supports 36 | async session evaluation. It's an excellent package and I like using 37 | it, especially with Python. However, there are some situations where 38 | I'd rather not use jupyter, which lead me to writing this 39 | package. For example, when using R, I prefer the 40 | [[https://ess.r-project.org/][ESS (Emacs Speaks Statistics)]] 41 | environment over the jupyter IRkernel. 42 | - [[https://github.com/astahlman/ob-async][ob-async]] enables async 43 | evaluation for regular (non-session) org-babel source blocks. It 44 | does *not* support the =:session= header argument for evaluating 45 | multiple source blocks in an existing session. 46 | 47 | * How it works 48 | 49 | Whenever new output is added to the session's comint buffer, the 50 | function ~ob-session-async-filter~ scans the output for an indicator 51 | token. Upon encountering the token, the filter uses a regular 52 | expression to extract a UUID or temp-file associated with the result, 53 | then searches for the appropriate location to add the result in. 54 | 55 | This code is loosely based on ~org-babel-comint-with-output~ in 56 | ~ob-comint.el~, which is the upstream code in org-mode to evaluate 57 | code in a comint session and return the output. 58 | 59 | A lot of the code in this package is just copied from org-mode, then 60 | slightly adjusted to accommodate async evaluation. I plan to 61 | eventually refactor the code and contribute it back upstream to 62 | org-mode, to reduce code duplication and improve code reuse. 63 | 64 | * Links 65 | 66 | - [[https://lists.gnu.org/archive/html/emacs-orgmode/2019-06/msg00014.html][emacs-orgmode post]] 67 | - [[https://github.com/astahlman/ob-async/issues/1][ob-async issue #1]] 68 | -------------------------------------------------------------------------------- /lisp/ob-session-async-R.el: -------------------------------------------------------------------------------- 1 | ;;; ob-session-async-R.el --- Async Babel Interaction with R sessions -*- lexical-binding: t -*- 2 | 3 | ;; Copyright (C) 2019 4 | 5 | ;; Author: 6 | 7 | ;; This file is free software; you can redistribute it and/or modify 8 | ;; it under the terms of the GNU General Public License as published by 9 | ;; the Free Software Foundation; either version 3, or (at your option) 10 | ;; any later version. 11 | 12 | ;; This program is distributed in the hope that it will be useful, 13 | ;; but WITHOUT ANY WARRANTY; without even the implied warranty of 14 | ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 15 | ;; GNU General Public License for more details. 16 | 17 | ;; For a full copy of the GNU General Public License 18 | ;; see . 19 | 20 | 21 | ;;; Commentary: 22 | 23 | ;; Support for evaluating R code asynchronously in org-babel sessions. 24 | 25 | ;;; Code: 26 | 27 | (require 'ob-R) 28 | (require 'ob-session-async) 29 | (require 'subr-x) 30 | 31 | (defun ob-session-async-org-babel-execute:R (orig-fun body params) 32 | "Advice around `org-babel-execute:R' to enable asynchronous evaluation." 33 | (let ((async (assq :async params)) 34 | (session (assq :session params))) 35 | (if (or (not async) 36 | (equal (cdr async) "no") 37 | (equal (cdr session) "none")) 38 | (funcall orig-fun body params) 39 | (let (ess-eval-visibly) 40 | (advice-add 'org-babel-R-evaluate-session 41 | :override 'ob-session-async-org-babel-R-evaluate-session) 42 | (let ((result (funcall orig-fun body params))) 43 | (advice-remove 'org-babel-R-evaluate-session 44 | 'ob-session-async-org-babel-R-evaluate-session) 45 | result))))) 46 | 47 | (advice-add 'org-babel-execute:R :around 'ob-session-async-org-babel-execute:R) 48 | 49 | (defconst ob-session-async-R-indicator "'ob_comint_async_R_%s_%s'") 50 | 51 | (defun ob-session-async-org-babel-R-evaluate-session 52 | (session body result-type result-params column-names-p row-names-p) 53 | "Asynchronously evaluate BODY in SESSION. 54 | Returns a placeholder string for insertion, to later be replaced 55 | by `ob-session-async-filter'." 56 | (ob-session-async-register 57 | session (current-buffer) 58 | "^\\(?:[>.+] \\)*\\[1\\] \"ob_comint_async_R_\\(.+?\\)_\\(.+\\)\"$" 59 | 'org-babel-chomp 60 | 'ob-session-async-R-value-callback) 61 | (cl-case result-type 62 | (value 63 | (let ((tmp-file (org-babel-temp-file "R-"))) 64 | (with-temp-buffer 65 | (insert 66 | (org-babel-chomp body)) 67 | (let ((ess-local-process-name 68 | (process-name (get-buffer-process session)))) 69 | (ess-eval-buffer nil))) 70 | (with-temp-buffer 71 | (insert 72 | (mapconcat 73 | 'org-babel-chomp 74 | (list (format org-babel-R-write-object-command 75 | (if row-names-p "TRUE" "FALSE") 76 | (if column-names-p 77 | (if row-names-p "NA" "TRUE") 78 | "FALSE") 79 | ".Last.value" 80 | (org-babel-process-file-name tmp-file 'noquote)) 81 | (format ob-session-async-R-indicator 82 | "file" tmp-file)) 83 | "\n")) 84 | (let ((ess-local-process-name 85 | (process-name (get-buffer-process session)))) 86 | (ess-eval-buffer nil))) 87 | tmp-file)) 88 | (output 89 | (let ((uuid (md5 (number-to-string (random 100000000)))) 90 | (ess-local-process-name 91 | (process-name (get-buffer-process session)))) 92 | (with-temp-buffer 93 | (insert (format ob-session-async-R-indicator 94 | "start" uuid)) 95 | (insert "\n") 96 | (insert body) 97 | (insert "\n") 98 | (insert (format ob-session-async-R-indicator 99 | "end" uuid)) 100 | (ess-eval-buffer nil)) 101 | uuid)))) 102 | 103 | (defun ob-session-async-R-value-callback (params tmp-file) 104 | "Callback for async value results. 105 | Assigned locally to `ob-session-async-file-callback' in R 106 | comint buffers used for asynchronous Babel evaluation." 107 | (let* ((graphics-file (and (member "graphics" (assq :result-params params)) 108 | (org-babel-graphical-output-file params))) 109 | (colnames-p (unless graphics-file (cdr (assq :colnames params))))) 110 | (org-babel-R-process-value-result 111 | (org-babel-result-cond (assq :result-params params) 112 | (with-temp-buffer 113 | (insert-file-contents tmp-file) 114 | (org-babel-chomp (buffer-string) "\n")) 115 | (org-babel-import-elisp-from-file tmp-file '(16))) 116 | (or (equal "yes" colnames-p) 117 | (org-babel-pick-name 118 | (cdr (assq :colname-names params)) colnames-p))))) 119 | 120 | (provide 'ob-session-async-R) 121 | 122 | ;;; ob-session-async-R.el ends here 123 | -------------------------------------------------------------------------------- /lisp/ob-session-async-python.el: -------------------------------------------------------------------------------- 1 | ;;; ob-session-async-python.el --- Async Babel Interaction with R sessions -*- lexical-binding: t -*- 2 | 3 | ;; Copyright (C) 2019 4 | 5 | ;; Author: 6 | ;; Package-Requires: ((org "9.4")) 7 | 8 | ;; This file is free software; you can redistribute it and/or modify 9 | ;; it under the terms of the GNU General Public License as published by 10 | ;; the Free Software Foundation; either version 3, or (at your option) 11 | ;; any later version. 12 | 13 | ;; This program is distributed in the hope that it will be useful, 14 | ;; but WITHOUT ANY WARRANTY; without even the implied warranty of 15 | ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 16 | ;; GNU General Public License for more details. 17 | 18 | ;; For a full copy of the GNU General Public License 19 | ;; see . 20 | 21 | 22 | ;;; Commentary: 23 | 24 | ;; Support for evaluating python code asynchronously in org-babel sessions. 25 | 26 | ;;; Code: 27 | 28 | (require 'ob-python) 29 | (require 'ob-session-async) 30 | (require 'subr-x) 31 | 32 | (defun ob-session-async-org-babel-execute:python (orig-fun body params) 33 | "Advice around `org-babel-execute:python' to enable asynchronous evaluation." 34 | (let ((async (assq :async params)) 35 | (session (assq :session params))) 36 | (if (or (not async) 37 | (equal (cdr async) "no") 38 | (equal (cdr session) "none")) 39 | (funcall orig-fun body params) 40 | (advice-add 'org-babel-python-evaluate-session 41 | :override 'ob-session-async-org-babel-python-evaluate-session) 42 | (let ((result (funcall orig-fun body params))) 43 | (advice-remove 'org-babel-python-evaluate-session 44 | 'ob-session-async-org-babel-python-evaluate-session) 45 | result)))) 46 | 47 | (advice-add 'org-babel-execute:python :around 'ob-session-async-org-babel-execute:python) 48 | 49 | (defconst ob-session-async-python-indicator "print ('ob_comint_async_python_%s_%s')") 50 | 51 | (defun ob-session-async-python-value-callback (params tmp-file) 52 | (org-babel-eval-read-file tmp-file)) 53 | 54 | (defun ob-session-async-org-babel-python-evaluate-session 55 | (session body &optional result-type result-params) 56 | "Asynchronously evaluate BODY in SESSION. 57 | Returns a placeholder string for insertion, to later be replaced 58 | by `ob-session-async-filter'." 59 | (ob-session-async-register 60 | session (current-buffer) 61 | "ob_comint_async_python_\\(.+?\\)_\\(.+\\)" 62 | 'org-babel-chomp 'ob-session-async-python-value-callback) 63 | (let ((python-shell-buffer-name (org-babel-python-without-earmuffs session))) 64 | (pcase result-type 65 | (`output 66 | (let ((uuid (md5 (number-to-string (random 100000000))))) 67 | (with-temp-buffer 68 | (insert (format ob-session-async-python-indicator "start" uuid)) 69 | (insert "\n") 70 | (insert body) 71 | (insert "\n") 72 | (insert (format ob-session-async-python-indicator "end" uuid)) 73 | (python-shell-send-buffer)) 74 | uuid)) 75 | (`value 76 | (let ((tmp-results-file (org-babel-temp-file "python-")) 77 | (tmp-src-file (org-babel-temp-file "python-"))) 78 | (with-temp-file tmp-src-file (insert body)) 79 | (with-temp-buffer 80 | (insert (org-babel-python-format-session-value tmp-src-file tmp-results-file result-params)) 81 | (insert "\n") 82 | (insert (format ob-session-async-python-indicator "file" tmp-results-file)) 83 | (python-shell-send-buffer)) 84 | tmp-results-file))))) 85 | 86 | (provide 'ob-session-async-python) 87 | 88 | ;;; ob-session-async-python.el ends here 89 | -------------------------------------------------------------------------------- /lisp/ob-session-async-ruby.el: -------------------------------------------------------------------------------- 1 | ;;; ob-session-async-ruby.el --- Async Babel Interaction with Ruby sessions -*- lexical-binding: t -*- 2 | 3 | ;; Copyright (C) 2019 4 | 5 | ;; Author: 6 | 7 | ;; This file is free software; you can redistribute it and/or modify 8 | ;; it under the terms of the GNU General Public License as published by 9 | ;; the Free Software Foundation; either version 3, or (at your option) 10 | ;; any later version. 11 | 12 | ;; This program is distributed in the hope that it will be useful, 13 | ;; but WITHOUT ANY WARRANTY; without even the implied warranty of 14 | ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 15 | ;; GNU General Public License for more details. 16 | 17 | ;; For a full copy of the GNU General Public License 18 | ;; see . 19 | 20 | 21 | ;;; Commentary: 22 | 23 | ;; Support for evaluating Ruby code asynchronously in org-babel sessions. 24 | 25 | ;;; Code: 26 | 27 | (require 'ob-ruby) 28 | (require 'ob-session-async) 29 | (require 'subr-x) 30 | 31 | (defun ob-session-async-org-babel-execute:ruby (orig-fun body params) 32 | "Advice around `org-babel-execute:ruby' to enable asynchronous evaluation." 33 | (let ((async (assq :async params)) 34 | (session (assq :session params))) 35 | (if (or (not async) 36 | (equal (cdr async) "no") 37 | (equal (cdr session) "none")) 38 | (funcall orig-fun body params) 39 | (advice-add 'org-babel-ruby-evaluate 40 | :override 'ob-session-async-org-babel-ruby-evaluate-session) 41 | (let ((result (funcall orig-fun body params))) 42 | (advice-remove 'org-babel-ruby-evaluate 'ob-session-async-org-babel-ruby-evaluate-session) 43 | result)))) 44 | 45 | (advice-add 'org-babel-execute:ruby :around 'ob-session-async-org-babel-execute:ruby) 46 | 47 | (defconst ob-session-async-ruby-indicator "puts 'ob_comint_async_ruby_%s_%s'") 48 | 49 | (defun ob-session-async-ruby-chunk-callback (string) 50 | (let* ((prefix-regexp "^=> nil\nirb([A-Za-z]+)[0-9:]+> ") 51 | (suffix-regexp "\n=> true\nirb([A-Za-z]+)[0-9:]+>$") 52 | (new-string (replace-regexp-in-string suffix-regexp "" 53 | (replace-regexp-in-string prefix-regexp "" string)))) 54 | (org-babel-chomp new-string))) 55 | 56 | (defun ob-session-async-org-babel-ruby-evaluate-session (buffer body &optional result-type result-params) 57 | "Asynchronously evaluate BODY in SESSION. 58 | Returns a placeholder string for insertion, to later be replaced 59 | by `ob-session-async-filter'." 60 | (ob-session-async-register 61 | buffer (current-buffer) 62 | "ob_comint_async_ruby_\\(.+?\\)_\\(.+\\)" 63 | 'ob-session-async-ruby-chunk-callback 64 | 'ob-session-async-ruby-value-callback) 65 | ;; comint session evaluation 66 | (pcase result-type 67 | (`output 68 | (let* ((uuid (md5 (number-to-string (random 100000000))))) 69 | (with-current-buffer buffer 70 | (mapc 71 | (lambda (line) 72 | (insert (org-babel-chomp line)) (comint-send-input nil t)) 73 | (list 74 | (format ob-session-async-ruby-indicator "start" uuid) 75 | "conf.echo=false;_org_prompt_mode=conf.prompt_mode;conf.prompt_mode=:NULL" 76 | body 77 | "conf.prompt_mode=_org_prompt_mode;conf.echo=true" 78 | (format ob-session-async-ruby-indicator "end" uuid))) 79 | (comint-send-input)) 80 | uuid)) 81 | (`value 82 | (let* ((tmp-file (org-babel-temp-file "ruby-")) 83 | (ppp (or (member "code" result-params) 84 | (member "pp" result-params)))) 85 | (with-current-buffer buffer 86 | ;; (buffer org-babel-ruby-eoe-indicator t body) 87 | (when ppp (insert "\nrequire 'pp';") (comint-send-input nil t)) 88 | (insert "\n") 89 | (mapc 90 | (lambda (line) 91 | (insert (org-babel-chomp line)) (comint-send-input nil t)) 92 | (append 93 | (list body) 94 | (if (not ppp) 95 | (list (format org-babel-ruby-f-write 96 | (org-babel-process-file-name tmp-file 'noquote))) 97 | (list 98 | "results=_" "require 'pp'" "orig_out = $stdout" 99 | (format org-babel-ruby-pp-f-write 100 | (org-babel-process-file-name tmp-file 'noquote)))) 101 | (list (format ob-session-async-ruby-indicator "file" tmp-file)))) 102 | (comint-send-input nil t)) 103 | tmp-file)))) 104 | 105 | (defun ob-session-async-ruby-value-callback (params tmp-file) 106 | "Callback for async value results. 107 | Assigned locally to `ob-session-async-file-callback' in Ruby 108 | comint buffers used for asynchronous Babel evaluation." 109 | (with-temp-buffer 110 | (insert-file-contents tmp-file) 111 | (buffer-string))) 112 | 113 | (provide 'ob-session-async-ruby) 114 | 115 | ;;; ob-session-async-ruby.el ends here 116 | -------------------------------------------------------------------------------- /lisp/ob-session-async.el: -------------------------------------------------------------------------------- 1 | ;;; ob-session-async.el --- Asynchronous Babel Interaction with Comint Buffers -*- lexical-binding: t; -*- 2 | 3 | ;; Copyright (C) 2019 4 | 5 | ;; Author: 6 | ;; Keywords: outlines, languages 7 | ;; Version: 0.1.0 8 | 9 | ;; This program is free software; you can redistribute it and/or modify 10 | ;; it under the terms of the GNU General Public License as published by 11 | ;; the Free Software Foundation, either version 3 of the License, or 12 | ;; (at your option) any later version. 13 | 14 | ;; This program is distributed in the hope that it will be useful, 15 | ;; but WITHOUT ANY WARRANTY; without even the implied warranty of 16 | ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 17 | ;; GNU General Public License for more details. 18 | 19 | ;; You should have received a copy of the GNU General Public License 20 | ;; along with this program. If not, see . 21 | 22 | ;;; Commentary: 23 | 24 | ;; Functions for asynchronous session evaluation of org-babel source 25 | ;; blocks in comint buffers. 26 | 27 | ;;; Code: 28 | 29 | (require 'ob-comint) 30 | 31 | (with-eval-after-load 'ob-async 32 | (defun ob-session-async-org-babel-execute-src-block 33 | (orig-advice orig-fun &optional arg info params) 34 | "Advice to wrap around `ob-async-org-babel-execute-src-block'. 35 | That function is itself an advice around `org-babel-execute-src-block'." 36 | (let ((block-info (nth 2 (or info (org-babel-get-src-block-info))))) 37 | ;; if no :session, use the original ob-async advice 38 | (if (equal (cdr (assoc :session block-info)) "none") 39 | (funcall orig-advice orig-fun arg info params) 40 | ;; else, skip it 41 | (funcall orig-fun arg info params)))) 42 | 43 | (advice-add 'ob-async-org-babel-execute-src-block 44 | :around 'ob-session-async-org-babel-execute-src-block)) 45 | 46 | (defvar-local ob-session-async-indicator nil 47 | "Regular expression that `ob-session-async-filter' scans for. 48 | It should have 2 parenthesized expressions, 49 | e.g. \"org_babel_async_\\(start\\|end\\|file\\)_\\(.*\\)\". The 50 | first parenthesized expression determines whether the token is 51 | delimiting a result block, or whether the result is in a file. If 52 | delimiting a block, the second expression gives a UUID for the 53 | location to insert the result. Otherwise, the result is in a tmp 54 | file, and the second expression gives the file name.") 55 | 56 | (defvar-local ob-session-async-buffers nil 57 | "List of org-mode buffers to check for Babel async output results.") 58 | 59 | (defvar-local ob-session-async-file-callback nil 60 | "Callback to clean and insert Babel async results from a temp file. 61 | The callback function takes two arguments: the alist of params of the Babel 62 | source block, and the name of the temp file.") 63 | 64 | (defvar-local ob-session-async-chunk-callback nil 65 | "Callback function to clean Babel async output results before insertion. 66 | Its single argument is a string consisting of output from the 67 | comint process. It should return a string that will be be passed 68 | to `org-babel-insert-result'.") 69 | 70 | (defvar-local ob-session-async-dangling nil 71 | "Dangling piece of the last process output, in case 72 | `ob-session-async-indicator' is spread across multiple 73 | comint outputs due to buffering.") 74 | 75 | (defun ob-session-async-filter (string) 76 | "Captures Babel async output from comint buffer back to org-mode buffers. 77 | This function is added as a hook to `comint-output-filter-functions'. 78 | STRING contains the output originally inserted into the comint buffer." 79 | ;; Remove outdated org-mode buffers 80 | (setq ob-session-async-buffers 81 | (cl-loop for buf in ob-session-async-buffers 82 | if (buffer-live-p buf) 83 | collect buf)) 84 | (let* ((indicator ob-session-async-indicator) 85 | (org-buffers ob-session-async-buffers) 86 | (file-callback ob-session-async-file-callback) 87 | (combined-string (concat ob-session-async-dangling string)) 88 | (new-dangling combined-string) 89 | ;; list of UUID's matched by `ob-session-async-indicator' 90 | uuid-list) 91 | (with-temp-buffer 92 | (insert combined-string) 93 | (goto-char (point-min)) 94 | (while (re-search-forward indicator nil t) 95 | ;; update dangling 96 | (setq new-dangling (buffer-substring (point) (point-max))) 97 | (cond ((equal (match-string 1) "end") 98 | ;; save UUID for insertion later 99 | (push (match-string 2) uuid-list)) 100 | ((equal (match-string 1) "file") 101 | ;; insert results from tmp-file 102 | (let ((tmp-file (match-string 2))) 103 | (cl-loop for buf in org-buffers 104 | until 105 | (with-current-buffer buf 106 | (save-excursion 107 | (goto-char (point-min)) 108 | (when (search-forward tmp-file nil t) 109 | (org-babel-previous-src-block) 110 | (let* ((info (org-babel-get-src-block-info)) 111 | (params (nth 2 info)) 112 | (result-params 113 | (cdr (assq :result-params params)))) 114 | (org-babel-insert-result 115 | (funcall file-callback 116 | (nth 117 | 2 (org-babel-get-src-block-info)) 118 | tmp-file) 119 | result-params info)) 120 | t)))))))) 121 | ;; Truncate dangling to only the most recent output 122 | (when (> (length new-dangling) (length string)) 123 | (setq new-dangling string))) 124 | (setq-local ob-session-async-dangling new-dangling) 125 | (when uuid-list 126 | ;; Search for results in the comint buffer 127 | (save-excursion 128 | (goto-char (point-max)) 129 | (while uuid-list 130 | (re-search-backward indicator) 131 | (when (equal (match-string 1) "end") 132 | (let* ((uuid (match-string-no-properties 2)) 133 | (res-str-raw 134 | (buffer-substring 135 | ;; move point to beginning of indicator 136 | (- (match-beginning 0) 1) 137 | ;; find the matching start indicator 138 | (cl-loop for pos = (re-search-backward indicator) 139 | until (and (equal (match-string 1) "start") 140 | (equal (match-string 2) uuid)) 141 | finally return (+ 1 (match-end 0))))) 142 | ;; Apply callback to clean up the result 143 | (res-str (funcall ob-session-async-chunk-callback 144 | res-str-raw))) 145 | ;; Search for uuid in associated org-buffers to insert results 146 | (cl-loop for buf in org-buffers 147 | until (with-current-buffer buf 148 | (save-excursion 149 | (goto-char (point-min)) 150 | (when (search-forward uuid nil t) 151 | (org-babel-previous-src-block) 152 | (let* ((info (org-babel-get-src-block-info)) 153 | (params (nth 2 info)) 154 | (result-params 155 | (cdr (assq :result-params params)))) 156 | (org-babel-insert-result 157 | res-str result-params info)) 158 | t)))) 159 | ;; Remove uuid from the list to search for 160 | (setq uuid-list (delete uuid uuid-list))))))))) 161 | 162 | (defun ob-session-async-register 163 | (session-buffer org-buffer indicator-regexp 164 | chunk-callback file-callback) 165 | "Sets local ob-session-async variables in SESSION-BUFFER. 166 | ORG-BUFFER is added to `ob-session-async-buffers' if not 167 | present. `ob-session-async-indicator', 168 | `ob-session-async-chunk-callback', and 169 | `ob-session-async-file-callback' are set to 170 | INDICATOR-REGEXP, CHUNK-CALLBACK, and FILE-CALLBACK 171 | respectively." 172 | (org-babel-comint-in-buffer session-buffer 173 | (setq ob-session-async-indicator indicator-regexp 174 | ob-session-async-chunk-callback chunk-callback 175 | ob-session-async-file-callback file-callback) 176 | (unless (memq org-buffer ob-session-async-buffers) 177 | (setq ob-session-async-buffers 178 | (cons org-buffer ob-session-async-buffers))) 179 | (add-hook 'comint-output-filter-functions 180 | 'ob-session-async-filter nil t))) 181 | 182 | (defmacro ob-session-async-delete-dangling-and-eval 183 | (session-buffer &rest body) 184 | "Remove dangling text in SESSION-BUFFER and evaluate BODY. 185 | This is analogous to `org-babel-comint-with-output', but meant 186 | for asynchronous output, and much shorter because inserting the 187 | result is delegated to `ob-session-async-filter'." 188 | (declare (indent 1)) 189 | `(org-babel-comint-in-buffer ,session-buffer 190 | (goto-char (process-mark (get-buffer-process (current-buffer)))) 191 | (delete-region (point) (point-max)) 192 | ,@body)) 193 | (def-edebug-spec ob-session-async-with-output (sexp body)) 194 | 195 | (provide 'ob-session-async) 196 | ;;; ob-session-async.el ends here 197 | -------------------------------------------------------------------------------- /test/ob-session-async-R-test.el: -------------------------------------------------------------------------------- 1 | ;;; ob-session-async-R-test.el --- Tests for ob-session-async 2 | 3 | (require 'org-test) 4 | (require 'ess-r-mode) 5 | (require 'ob-session-async-R) 6 | 7 | (ert-deftest ob-session-async-R-simple-session-async-value () 8 | (let (ess-ask-for-ess-directory 9 | ess-history-file 10 | (org-babel-temporary-directory "/tmp") 11 | (org-confirm-babel-evaluate nil)) 12 | (org-test-with-temp-text 13 | "#+begin_src R :session R :async yes\n Sys.sleep(.1)\n paste(\"Yep!\")\n#+end_src\n" 14 | (should (let ((expected "Yep!")) 15 | (and (not (string= expected (org-babel-execute-src-block))) 16 | (string= expected 17 | (progn 18 | (sleep-for 0 200) 19 | (goto-char (org-babel-where-is-src-block-result)) 20 | (org-babel-read-result))))))))) 21 | 22 | (ert-deftest ob-session-async-R-simple-session-async-output () 23 | (let (ess-ask-for-ess-directory 24 | ess-history-file 25 | (org-babel-temporary-directory "/tmp") 26 | (org-confirm-babel-evaluate nil)) 27 | (org-test-with-temp-text 28 | "#+begin_src R :session R :results output :async yes\n Sys.sleep(.1)\n 1:5\n#+end_src\n" 29 | (should (let ((expected "[1] 1 2 3 4 5")) 30 | (and (not (string= expected (org-babel-execute-src-block))) 31 | (string= expected 32 | (progn 33 | (sleep-for 0 200) 34 | (goto-char (org-babel-where-is-src-block-result)) 35 | (org-babel-read-result))))))))) 36 | 37 | (ert-deftest ob-session-async-R-named-output () 38 | (let (ess-ask-for-ess-directory 39 | ess-history-file 40 | (org-babel-temporary-directory "/tmp") 41 | org-confirm-babel-evaluate 42 | (src-block "#+begin_src R :async :session R :results output\n 1:5\n#+end_src") 43 | (results-before "\n\n#+NAME: foobar\n#+RESULTS:\n: [1] 1") 44 | (results-after "\n\n#+NAME: foobar\n#+RESULTS:\n: [1] 1 2 3 4 5\n")) 45 | (org-test-with-temp-text 46 | (concat src-block results-before) 47 | (should (progn (org-babel-execute-src-block) 48 | (sleep-for 0 200) 49 | (string= (concat src-block results-after) 50 | (buffer-string))))))) 51 | 52 | (ert-deftest ob-session-async-R-named-value () 53 | (let (ess-ask-for-ess-directory 54 | ess-history-file 55 | org-confirm-babel-evaluate 56 | (org-babel-temporary-directory "/tmp") 57 | (src-block "#+begin_src R :async :session R :results value\n paste(\"Yep!\")\n#+end_src") 58 | (results-before "\n\n#+NAME: foobar\n#+RESULTS:\n: [1] 1") 59 | (results-after "\n\n#+NAME: foobar\n#+RESULTS:\n: Yep!\n")) 60 | (org-test-with-temp-text 61 | (concat src-block results-before) 62 | (should (progn (org-babel-execute-src-block) 63 | (sleep-for 0 200) 64 | (string= (concat src-block results-after) 65 | (buffer-string))))))) 66 | 67 | (ert-deftest ob-session-async-R-output-drawer () 68 | (let (ess-ask-for-ess-directory 69 | ess-history-file 70 | org-confirm-babel-evaluate 71 | (org-babel-temporary-directory "/tmp") 72 | (src-block "#+begin_src R :async :session R :results output drawer\n 1:5\n#+end_src") 73 | (result "\n\n#+RESULTS:\n:results:\n[1] 1 2 3 4 5\n:end:\n")) 74 | (org-test-with-temp-text 75 | src-block 76 | (should (progn (org-babel-execute-src-block) 77 | (sleep-for 0 200) 78 | (string= (concat src-block result) 79 | (buffer-string))))))) 80 | 81 | (ert-deftest ob-session-async-R-value-drawer () 82 | (let (ess-ask-for-ess-directory 83 | ess-history-file 84 | org-confirm-babel-evaluate 85 | (org-babel-temporary-directory "/tmp") 86 | (src-block "#+begin_src R :async :session R :results value drawer\n 1:3\n#+end_src") 87 | (result "\n\n#+RESULTS:\n:results:\n1\n2\n3\n:end:\n")) 88 | (org-test-with-temp-text 89 | src-block 90 | (should (progn (org-babel-execute-src-block) 91 | (sleep-for 0 200) 92 | (string= (concat src-block result) 93 | (buffer-string))))))) 94 | 95 | ;;; ob-session-async-R-test.el ends here 96 | -------------------------------------------------------------------------------- /test/ob-session-async-python-test.el: -------------------------------------------------------------------------------- 1 | ;;; ob-session-async-python-test.el --- Tests for ob-session-async 2 | 3 | (require 'org-test) 4 | (require 'python) 5 | (require 'ob-session-async-python) 6 | 7 | (ert-deftest ob-session-async-python-simple-session-async-output () 8 | (let ((org-babel-temporary-directory "/tmp") 9 | (org-confirm-babel-evaluate nil)) 10 | (org-test-with-temp-text 11 | "#+begin_src python :session python :async yes :results output\nimport time\ntime.sleep(.1)\nprint('Yep!')\n#+end_src\n" 12 | (should (let ((expected "Yep!")) 13 | (and (not (string= expected (org-babel-execute-src-block))) 14 | (string= expected 15 | (progn 16 | (sleep-for 0 200) 17 | (goto-char (org-babel-where-is-src-block-result)) 18 | (org-babel-read-result))))))))) 19 | 20 | (ert-deftest ob-session-async-python-named-output () 21 | (let (org-confirm-babel-evaluate 22 | (org-babel-temporary-directory "/tmp") 23 | (src-block "#+begin_src python :async :session R :results output\n print(\"Yep!\")\n#+end_src") 24 | (results-before "\n\n#+NAME: foobar\n#+RESULTS:\n: Nope!") 25 | (results-after "\n\n#+NAME: foobar\n#+RESULTS:\n: Yep!\n")) 26 | (org-test-with-temp-text 27 | (concat src-block results-before) 28 | (should (progn (org-babel-execute-src-block) 29 | (sleep-for 0 200) 30 | (string= (concat src-block results-after) 31 | (buffer-string))))))) 32 | 33 | (ert-deftest ob-session-async-python-output-drawer () 34 | (let (org-confirm-babel-evaluate 35 | (org-babel-temporary-directory "/tmp") 36 | (src-block "#+begin_src python :async :session python :results output drawer\n print(list(range(3)))\n#+end_src") 37 | (result "\n\n#+RESULTS:\n:results:\n[0, 1, 2]\n:end:\n")) 38 | (org-test-with-temp-text 39 | src-block 40 | (should (progn (org-babel-execute-src-block) 41 | (sleep-for 0 200) 42 | (string= (concat src-block result) 43 | (buffer-string))))))) 44 | 45 | ;;; ob-session-async-python-test.el ends here 46 | -------------------------------------------------------------------------------- /test/ob-session-async-ruby-test.el: -------------------------------------------------------------------------------- 1 | ;;; ob-session-async-ruby-test.el --- Tests for ob-session-async 2 | 3 | (require 'org-test) 4 | (require 'ob-session-async-ruby) 5 | 6 | 7 | (defvar ob-session-async-ruby--ert-expected-output-result 8 | (let* ((irb-version (shell-command-to-string "irb --version")) 9 | (irb-version (progn (string-match "irb \\([0-9]+\\.[0-9]\\)+\\.[0-9]+" 10 | irb-version) 11 | (match-string 1 irb-version)))) 12 | (if irb-version 13 | (if (< 1.2 (string-to-number irb-version)) 14 | :passed 15 | :failed) 16 | :failed))) 17 | 18 | (ert-deftest ob-session-async-ruby-simple-session-async-value () 19 | (let ((org-babel-temporary-directory "/tmp") 20 | (org-confirm-babel-evaluate nil)) 21 | (org-test-with-temp-text 22 | "#+begin_src ruby :async :session ruby :results value\n\"Yep!\"\n#+end_src\n" 23 | (should (let ((expected "Yep!")) 24 | (string= expected 25 | (progn 26 | (org-babel-execute-src-block) 27 | (sleep-for 0 300) 28 | (goto-char (org-babel-where-is-src-block-result)) 29 | (org-babel-read-result)))))))) 30 | 31 | (ert-deftest ob-session-async-ruby-simple-session-async-output () 32 | :expected-result ob-session-async-ruby--ert-expected-output-result 33 | (let ((org-babel-temporary-directory "/tmp") 34 | (org-confirm-babel-evaluate nil)) 35 | (org-test-with-temp-text 36 | "#+begin_src ruby :async :session ruby :results output\np [1, 2, 3, 4]\n#+end_src\n" 37 | (should (let ((expected "[1, 2, 3, 4]")) 38 | (and (not (string= expected (org-babel-execute-src-block))) 39 | (string= expected 40 | (progn 41 | (sleep-for 0 400) 42 | (goto-char (org-babel-where-is-src-block-result)) 43 | (org-babel-read-result))))))))) 44 | 45 | (ert-deftest ob-session-async-ruby-named-output () 46 | :expected-result ob-session-async-ruby--ert-expected-output-result 47 | (let ((org-babel-temporary-directory "/tmp") 48 | (org-confirm-babel-evaluate nil) 49 | (src-block "#+begin_src ruby :async :session ruby :results output\n p [1, 2, 3, 4]\n#+end_src") 50 | (results-before "\n\n#+NAME: foobar\n#+RESULTS:\n: [1, 2, 3, 4]") 51 | (results-after "\n\n#+NAME: foobar\n#+RESULTS:\n: [1, 2, 3, 4]\n")) 52 | (org-test-with-temp-text 53 | (concat src-block results-before) 54 | (should (progn (org-babel-execute-src-block) 55 | (sleep-for 0 400) 56 | (string= (concat src-block results-after) 57 | (buffer-string))))))) 58 | 59 | (ert-deftest ob-session-async-ruby-named-value () 60 | (let ((org-babel-temporary-directory "/tmp") 61 | (org-confirm-babel-evaluate nil) 62 | (src-block "#+begin_src ruby :async :session ruby :results value\n\"Yep!\"\n#+end_src") 63 | (results-before "\n\n#+NAME: foobar\n#+RESULTS:\n: [1] 1") 64 | (results-after "\n\n#+NAME: foobar\n#+RESULTS:\n: Yep!\n")) 65 | (org-test-with-temp-text 66 | (concat src-block results-before) 67 | (should (progn (org-babel-execute-src-block) 68 | (sleep-for 0 400) 69 | (string= (concat src-block results-after) 70 | (buffer-string))))))) 71 | 72 | (ert-deftest ob-session-async-ruby-output-drawer () 73 | :expected-result ob-session-async-ruby--ert-expected-output-result 74 | (let ((org-babel-temporary-directory "/tmp") 75 | (org-confirm-babel-evaluate nil) 76 | (src-block "#+begin_src ruby :async :session ruby :results output drawer\np [1, 2, 3, 4]\n#+end_src") 77 | (result "\n\n#+RESULTS:\n:results:\n[1, 2, 3, 4]\n:end:\n")) 78 | (org-test-with-temp-text 79 | src-block 80 | (should (progn (org-babel-execute-src-block) 81 | (sleep-for 0 400) 82 | (string= (concat src-block result) 83 | (buffer-string))))))) 84 | 85 | (ert-deftest ob-session-async-ruby-value-drawer () 86 | (let ((org-babel-temporary-directory "/tmp") 87 | (org-confirm-babel-evaluate nil) 88 | (src-block "#+begin_src ruby :async :session ruby :results value drawer\n [1, 2, 3, 4]\n#+end_src") 89 | (result "\n\n#+RESULTS:\n:results:\n[1, 2, 3, 4]\n:end:\n")) 90 | (org-test-with-temp-text 91 | src-block 92 | (should (progn (org-babel-execute-src-block) 93 | (sleep-for 0 400) 94 | (string= (concat src-block result) 95 | (buffer-string))))))) 96 | 97 | ;;; ob-session-async-ruby-test.el ends here 98 | -------------------------------------------------------------------------------- /test/test-helper.el: -------------------------------------------------------------------------------- 1 | ;;; test-helper.el --- Helpers for ob-session-async-test.el 2 | 3 | (when (> emacs-major-version 26) 4 | (defalias 'ert--print-backtrace 'backtrace-to-string)) 5 | 6 | ;;; test-helper.el ends here 7 | --------------------------------------------------------------------------------