├── .gitignore ├── LICENSE ├── README.md └── pydoc.el /.gitignore: -------------------------------------------------------------------------------- 1 | #* 2 | *~ 3 | /__pycache__/test.cpython-35.pyc 4 | -------------------------------------------------------------------------------- /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 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | #Pydoc, the Python documentation navigation package using pydoc 2 | [![MELPA](http://melpa.org/packages/pydoc-badge.svg)](http://melpa.org/#/pydoc) 3 | ## Documentation 4 | 5 | If you want the documentation for a Python object, simply 6 | type: 7 | 8 | ``` 9 | M-x pydoc 10 | ``` 11 | 12 | Example in Python 3: 13 | 14 | ``` 15 | M-x pydoc datetime.datetime.now 16 | ``` 17 | 18 | Getting the Python object under the cursor (at point) is also supported. 19 | 20 | ## License 21 | 22 | This project is free software: You can redistribute it and/or modify 23 | it under the terms of the [GNU General Public 24 | License](https://github.com/statmobile/pydoc/blob/master/gpl.txt), 25 | either version 3 of the License, or (at your option) any later 26 | version. 27 | -------------------------------------------------------------------------------- /pydoc.el: -------------------------------------------------------------------------------- 1 | ;;; pydoc.el --- functional, syntax highlighted pydoc navigation 2 | 3 | ;; Copyright (C) 2015 John Kitchin 4 | 5 | ;; Author: John Kitchin 6 | ;; Maintainer: Brian J. Lopes 7 | ;; Contributions from Kyle Meyer 8 | ;; Created: 8 Mar 2015 9 | ;; Version: 0.2 10 | ;; Keywords: pydoc, python 11 | ;; Homepage: https://github.com/statmobile/pydoc 12 | 13 | ;;; Commentary: 14 | 15 | ;; This module runs pydoc on an argument, inserts the output into a help buffer, 16 | ;; and then linkifies and colorizes the buffer. For example, some things are 17 | ;; linked to open the source code, or to run pydoc on them. Some things are 18 | ;; colorized for readability, e.g. environment variables and strings, function 19 | ;; names and arguments. 20 | ;; 21 | ;; https://github.com/statmobile/pydoc 22 | ;; 23 | ;; pydoc.el provides the following functions. 24 | ;; `pydoc' Run this anywhere, and enter the module/class/function you want documentation for 25 | ;; `pydoc-at-point' Run this in a Python script to see what doc jedi can find for the point 26 | ;; `pydoc-browse' Launches a web browser with documentation. 27 | ;; `pydoc-browse-kill' kills the pydoc web server. 28 | ;; 29 | ;; `pydoc' renders some Sphinx markup as links. Images are shown as overlays. 30 | ;; Most org-links should be active. 31 | ;; 32 | ;; LaTeX fragments are shown with org-rendered overlays. ;; Note you need to 33 | ;; escape some things in the python docstrings, e.g. \\f, \\b, \\\\, \\r, \\n or 34 | ;; they will not render correctly. 35 | 36 | ;;; Changelog: 37 | ;; 38 | ;; Updated license and headers for release. 39 | ;; March 2016: Major rewrite by Kyle Meyer to use help-buffers 40 | 41 | ;;; Code: 42 | 43 | (require 'cl-lib) 44 | (require 'goto-addr) 45 | (require 'help-mode) 46 | ;; we use org-mode for python fontification 47 | (require 'org) 48 | 49 | 50 | ;;* Options 51 | 52 | (defgroup pydoc nil 53 | "Help buffer for pydoc." 54 | :prefix "pydoc" 55 | :group 'external 56 | :group 'help) 57 | 58 | 59 | (defcustom pydoc-python-command "python" 60 | "The command to use to execute python code." 61 | :type 'string 62 | :group 'pydoc) 63 | 64 | 65 | (defcustom pydoc-pip-version-command "pip --version" 66 | "The command to use to get the pip version." 67 | :type 'string 68 | :group 'pydoc) 69 | 70 | 71 | (defcustom pydoc-command (concat pydoc-python-command " -m pydoc") 72 | "The command to use to run pydoc." 73 | :type 'string 74 | :group 'pydoc) 75 | 76 | 77 | (defcustom pydoc-make-method-buttons t 78 | "If non-nil, create buttons for methods." 79 | :type 'boolean 80 | :group 'pydoc) 81 | 82 | 83 | (defcustom pydoc-after-finish-hook nil 84 | "Hook run by after pydoc buffer is prepared." 85 | :type 'hook 86 | :group 'pydoc) 87 | 88 | 89 | (defface pydoc-example-leader-face 90 | '((t (:inherit font-lock-doc-face))) 91 | "Face used to highlight code example leader (e.g., \">>>\").") 92 | 93 | 94 | ;;* Buttons 95 | (defun pydoc-find-file-other-window (fname) 96 | "Open FNAME in other window. 97 | FNAME may end in ::line-number, in which case it also goes to the 98 | line." 99 | (if (not (string-match "::" fname)) 100 | (find-file-other-window fname) 101 | (let ((fields (split-string fname "::"))) 102 | (find-file-other-window (car fields)) 103 | (goto-line (string-to-number (nth 1 fields)))))) 104 | 105 | (define-button-type 'pydoc-source 106 | :supertype 'help-xref 107 | ;; 'help-function 'find-file-other-window 108 | 'help-function 'pydoc-find-file-other-window 109 | 'help-echo (purecopy "mouse-2, RET: visit file")) 110 | 111 | 112 | (define-button-type 'pydoc-source-search 113 | :supertype 'help-xref 114 | 'help-function (lambda (file search) 115 | (find-file-other-window file) 116 | (goto-char (point-min)) 117 | (re-search-forward search nil t) 118 | (beginning-of-line)) 119 | 'help-echo (purecopy "mouse-2, RET: view in source")) 120 | 121 | 122 | (define-button-type 'pydoc-help 123 | :supertype 'help-xref 124 | 'help-function (lambda (pkg) (pydoc pkg)) 125 | 'help-echo (purecopy "mouse-2, RET: view pydoc help")) 126 | 127 | 128 | ;;* Buffer information 129 | 130 | (defconst pydoc-sections-re 131 | (rx line-start 132 | (group 133 | (one-or-more (any upper)) 134 | (zero-or-more (and (any space) (one-or-more (any upper))))) 135 | line-end) 136 | "Regular expression matching top level pydoc sections.") 137 | 138 | 139 | (defvar pydoc-file nil 140 | "File associated with the current pydoc buffer. 141 | The help for modules and packages has a \"FILE\" section (unless 142 | they are built-in module like `sys`).") 143 | (put 'pydoc-file 'permanent-local t) 144 | (make-variable-buffer-local 'pydoc-file) 145 | 146 | 147 | (defvar pydoc-info nil 148 | "Plist with information about the current pydoc buffer. 149 | 150 | Keys include 151 | 152 | type 153 | The type of object. This will always be non-nil. Possible values 154 | are 155 | 156 | py-package 157 | py-module 158 | 159 | py-function 160 | py-class 161 | 162 | py-topic-list (from \"pydoc topics\") 163 | py-keyword-list (from \"pydoc keywords\") 164 | py-module-list (from \"pydoc modules\") 165 | 166 | py-topic 167 | py-keyword 168 | 169 | not-found 170 | unknown 171 | 172 | name 173 | The name of the object for the current help buffer. This will be 174 | nil for help on topics as well as topic, keyword, and modules 175 | lists. 176 | 177 | in 178 | The name object, if any, that conains the object display in the 179 | current help buffer. 180 | 181 | sections 182 | An alist of section names and positions (if the object has 183 | sections).") 184 | (put 'pydoc-info'permanent-local t) 185 | (make-variable-buffer-local 'pydoc-info) 186 | 187 | 188 | (defun pydoc-set-info () 189 | "Set up `pydoc-info'for the current pydoc buffer." 190 | (setq pydoc-info (pydoc-get-info)) 191 | (setq pydoc-info 192 | (plist-put pydoc-info 193 | :sections (pydoc-get-sections)))) 194 | 195 | 196 | (defun pydoc-get-info () 197 | "Return help name and type for the current pydoc buffer. 198 | 199 | Return a plist with the keywords :name, :type, and :in. All 200 | return values will have a :type property. 201 | 202 | See `pydoc-info' for more details on the keys." 203 | (save-excursion 204 | (goto-char (point-min)) 205 | (cond 206 | ((looking-at "Help on package \\(.+\\) in \\(.+\\):") 207 | (list :name (match-string-no-properties 1) :type 'py-package 208 | :in (match-string-no-properties 2))) 209 | ((looking-at "Help on package \\(.+\\):") 210 | (list :name (match-string-no-properties 1) :type 'py-package)) 211 | ((looking-at "Help on \\(?:built-in \\)?module \\(.+\\) in \\(.+\\):") 212 | (list :name (match-string-no-properties 1) :type 'py-module 213 | :in (match-string-no-properties 2))) 214 | ((looking-at "Help on \\(?:built-in \\)?module \\(.+\\):") 215 | (list :name (match-string-no-properties 1) :type 'py-module)) 216 | ((looking-at (concat "Help on \\(?:built-in \\)?function \\(.+\\)" 217 | " in \\(?:module \\)?\\(.+\\):")) 218 | (list :name (match-string-no-properties 1) :type 'py-function 219 | :in (match-string-no-properties 2))) 220 | ((looking-at "Help on class \\(.+\\) in \\(.+\\):") 221 | (list :name (match-string-no-properties 1) :type 'py-class 222 | :in (match-string-no-properties 2))) 223 | ((looking-at "The \"\\(.+\\)\" statement") 224 | (list :name (match-string-no-properties 1) :type 'py-keyword)) 225 | ((looking-at "no Python documentation found for") 226 | (list :type 'not-found)) 227 | ((looking-at "\\w+.*\n\\*+") 228 | (list :type 'py-topic)) 229 | ((looking-at (concat "\nHere is a list of available topics." 230 | " Enter any topic name to get more help.$")) 231 | (list :type 'py-topic-list :start (match-end 0))) 232 | ((looking-at (concat "\nHere is a list of the Python keywords." 233 | " Enter any keyword to get more help.$")) 234 | (list :type 'py-keyword-list :start (match-end 0))) 235 | ;; This should be the last branch before t because it doesn't 236 | ;; restore point back to the beginning of the buffer. 237 | ((re-search-forward 238 | "Please wait a moment while I gather a list of all available modules...$" 239 | nil t) 240 | ;; ^ This may not be at a predictable line due to import 241 | ;; messages, so search for it. 242 | (let ((start (point))) 243 | (re-search-forward "Enter any module name to get more help.") 244 | (list :type 'py-module-list :start start :end (match-beginning 0)))) 245 | (t 246 | (list :type 'unknown))))) 247 | 248 | 249 | (defun pydoc-get-sections () 250 | "Return sections of the current pydoc buffer. 251 | An alist of (section . position) cells is returned, where 252 | \"section\" the lower case version of the section title." 253 | (save-excursion 254 | (goto-char (point-min)) 255 | (let (case-fold-search 256 | sections name start next-start) 257 | (while (re-search-forward pydoc-sections-re nil t) 258 | (setq next-start (match-beginning 0)) 259 | (when name 260 | (push (cons name (cons start (1- next-start))) 261 | sections)) 262 | (setq name (downcase (match-string-no-properties 1)) 263 | start next-start)) 264 | (when name 265 | (push (cons name (cons start (point-max))) 266 | sections)) 267 | sections))) 268 | 269 | 270 | (defun pydoc-jump-to-section (section) 271 | "Jump to pydoc SECTION." 272 | (interactive 273 | (list (completing-read "Section: " 274 | (mapcar #'car (plist-get pydoc-info :sections))))) 275 | (let ((start (pydoc--section-start section))) 276 | (when start 277 | (goto-char start)))) 278 | 279 | 280 | (defun pydoc--section-start (section) 281 | "Return start position for SECTION. 282 | Value is obtained from buffer-local `pydoc-info'." 283 | (car (cdr (assoc section (plist-get pydoc-info :sections))))) 284 | 285 | 286 | (defmacro pydoc--with-section (section regexp &rest body) 287 | "Within SECTION gerform REGEXP search. 288 | Execute BODY for each sucessful search." 289 | (declare (indent 2)) 290 | `(let* ((section-pos (cdr (assoc ,section (plist-get pydoc-info :sections)))) 291 | (case-fold-search nil)) 292 | (when section-pos 293 | (save-excursion 294 | (goto-char (car section-pos)) 295 | (while (re-search-forward ,regexp (cdr section-pos) t) 296 | ,@body))))) 297 | 298 | 299 | (defun pydoc-make-xrefs (&optional buffer) 300 | "This is the pydoc version of `help-make-xrefs'. 301 | Optional argument BUFFER which is used if provided." 302 | (with-current-buffer (or buffer (current-buffer)) 303 | (save-excursion 304 | (goto-char (point-min)) 305 | (let ((old-modified (buffer-modified-p)) 306 | (case-fold-search nil) 307 | (inhibit-read-only t)) 308 | (cl-case (plist-get pydoc-info :type) 309 | ((not-found py-function py-class)) 310 | ((py-topic py-keyword) 311 | (pydoc--buttonize-related-topics)) 312 | ((py-keyword-list py-topic-list py-module-list) 313 | (goto-char (plist-get pydoc-info :start)) 314 | (pydoc--buttonize-help-list (plist-get pydoc-info :end))) 315 | (py-module 316 | (pydoc--buttonize-file) 317 | (when pydoc-file 318 | (pydoc--buttonize-functions pydoc-file) 319 | (pydoc--buttonize-classes pydoc-file) 320 | (when pydoc-make-method-buttons 321 | (pydoc--buttonize-methods pydoc-file)) 322 | (pydoc--buttonize-data pydoc-file))) 323 | (py-package 324 | (pydoc--buttonize-package-contents (plist-get pydoc-info :name)) 325 | (pydoc--buttonize-file) 326 | (when pydoc-file 327 | (pydoc--buttonize-functions pydoc-file) 328 | (pydoc--buttonize-classes pydoc-file) 329 | (when pydoc-make-method-buttons 330 | (pydoc--buttonize-methods pydoc-file)) 331 | (pydoc--buttonize-data pydoc-file))) 332 | ;; When I use `pydoc-at-point' the type here is unknown. 333 | (unknown 334 | (pydoc--buttonize-file) 335 | (pydoc--buttonize-other))) 336 | (pydoc--buttonize-urls) 337 | (pydoc--buttonize-sphinx) 338 | ;; Delete extraneous newlines at the end of the docstring 339 | (goto-char (point-max)) 340 | (while (and (not (bobp)) (bolp)) 341 | (delete-char -1)) 342 | (insert "\n") 343 | (pydoc--insert-navigation-links) 344 | (set-buffer-modified-p old-modified))))) 345 | 346 | 347 | ;;** Buttonize functions 348 | (defun pydoc--buttonize-help-list (&optional limit) 349 | "Buttonize the help list up to LIMIT." 350 | (save-excursion 351 | (while (re-search-forward "\\b\\w+\\b" limit t) 352 | (help-xref-button 0 'pydoc-help (match-string 0))))) 353 | 354 | 355 | (defun pydoc--buttonize-related-topics () 356 | "Buttonize related topics." 357 | (save-excursion 358 | (when (re-search-forward "^Related help topics: \\(\\w+\\)" 359 | nil t) 360 | (help-xref-button 1 'pydoc-help (match-string 1)) 361 | (let ((line-end (point-at-eol))) 362 | (while (re-search-forward ",\\s-*\\(\\w+\\)" line-end t) 363 | (help-xref-button 1 'pydoc-help (match-string 1))))))) 364 | 365 | 366 | (defun pydoc--buttonize-other () 367 | "Buttonize the OTHER section. 368 | This section is unique to `pydoc-at-point' output." 369 | (save-excursion 370 | (goto-char (point-min)) 371 | (when (re-search-forward "^OTHER MODULES IN THIS FILE" (point-max) t) 372 | (while (re-search-forward " \\(.*\\)$" nil t) 373 | (help-xref-button 1 'pydoc-help (match-string 1)))))) 374 | 375 | 376 | (defun pydoc--insert-navigation-links () 377 | "Insert navigation links. 378 | Adapted from `help-make-xrefs'." 379 | (when (or help-xref-stack help-xref-forward-stack) 380 | (insert "\n")) 381 | ;; Make a back-reference in this buffer if appropriate. 382 | (when help-xref-stack 383 | (help-insert-xref-button help-back-label 'help-back 384 | (current-buffer))) 385 | ;; Make a forward-reference in this buffer if appropriate. 386 | (when help-xref-forward-stack 387 | (when help-xref-stack 388 | (insert "\t")) 389 | (help-insert-xref-button help-forward-label 'help-forward 390 | (current-buffer))) 391 | (when (or help-xref-stack help-xref-forward-stack) 392 | (insert "\n"))) 393 | 394 | 395 | (defun pydoc--buttonize-file () 396 | "Buttonize the file section." 397 | (let ((file-pos (pydoc--section-start "file"))) 398 | (when file-pos 399 | (save-excursion 400 | (goto-char file-pos) 401 | (looking-at "^FILE\n \\(.+\\)$") 402 | (let ((file (match-string-no-properties 1))) 403 | (setq pydoc-file file) 404 | (help-xref-button 1 'pydoc-source pydoc-file)))))) 405 | 406 | 407 | (defun pydoc--buttonize-urls () 408 | "Buttonize URLs." 409 | (save-excursion 410 | (while (re-search-forward goto-address-url-regexp nil t) 411 | (help-xref-button 0 'help-url (match-string 0))))) 412 | 413 | 414 | (defun pydoc--buttonize-functions (file) 415 | "Buttonize functions for FILE." 416 | (pydoc--with-section "functions" 417 | "^\\s-+\\([_a-zA-z0-9]+\\)(" 418 | (let* ((func (match-string 1)) 419 | (search (format "def %s(" func))) 420 | (help-xref-button 1 'pydoc-source-search file search)))) 421 | 422 | 423 | (defun pydoc--buttonize-classes (file) 424 | "Buttonize classes for FILE." 425 | (pydoc--with-section "classes" 426 | " class \\([_A-z0-9]+\\)\\(?:(\\(.*\\))\\)*" 427 | (let* ((class (match-string 1)) 428 | (search (format "^class %s\\b" class)) 429 | ;; TODO Sometimes this doesn't have full path. 430 | (superclass (match-string 2))) 431 | (help-xref-button 1 'pydoc-source-search file search) 432 | (when superclass 433 | (help-xref-button 2 'pydoc-help superclass))))) 434 | 435 | 436 | (defun pydoc--buttonize-methods (file) 437 | "Buttonize methods in the class section for FILE." 438 | (pydoc--with-section "classes" 439 | "^ | \\([a-zA-Z0-9_]*\\)(\\(.*\\))$" 440 | ;; TODO This is not specific for the class it is under. 441 | (let* ((meth (match-string 1)) 442 | (search (format "def %s(" meth))) 443 | (help-xref-button 1 'pydoc-source-search file search)))) 444 | 445 | 446 | (defun pydoc--buttonize-data (file) 447 | "Buttonize python data for FILE." 448 | (pydoc--with-section "data" 449 | "^ \\([_A-Za-z0-9]+\\) =" 450 | (help-xref-button 1 'pydoc-source-search file (match-string 1)))) 451 | 452 | 453 | (defun pydoc--buttonize-sphinx () 454 | "Buttonize Sphinx markup." 455 | (save-excursion 456 | ;; TODO Add method? 457 | (while (re-search-forward ":\\(class\\|func\\|mod\\):`~?\\([^`]*\\)`" nil t) 458 | (let ((name (match-string 2))) 459 | (help-xref-button 2 'pydoc-help name))))) 460 | 461 | 462 | (defun pydoc--buttonize-package-contents (pkg-name) 463 | "Buttonize package contents for PKG-NAME." 464 | (pydoc--with-section "package contents" 465 | "^ \\([a-zA-Z0-9_-]*\\)[ ]?\\((package)\\)?$" 466 | (let ((package (concat pkg-name "." (match-string 1)))) 467 | (help-xref-button 1 'pydoc-help package)))) 468 | 469 | 470 | ;;* Python information 471 | (defun pydoc-builtin-modules () 472 | "Return list of built in python modules." 473 | (mapcar 474 | 'symbol-name 475 | (read (shell-command-to-string (concat pydoc-python-command " -c \"import sys; print('({})'.format(' '.join(['\"{}\"'.format(x) for x in sys.builtin_module_names])))\""))))) 476 | 477 | 478 | (defun pydoc-pip-version () 479 | "Return a list of (major minor revision) for the pip version." 480 | (let* ((output (shell-command-to-string pydoc-pip-version-command)) 481 | (string-version (nth 1 (split-string output " " t))) 482 | (string-major-minor-rev (split-string string-version "\\."))) 483 | (mapcar 484 | 'string-to-number 485 | string-major-minor-rev))) 486 | 487 | 488 | (defun pydoc-user-modules () 489 | "Return a list of strings for user-installed modules." 490 | (mapcar 491 | 'symbol-name 492 | (read 493 | (shell-command-to-string 494 | ;; Use either importlib_metadata (a backport of importlib.metadata) or 495 | ;; importlib.metadata itself if it is available. 496 | (concat python-shell-interpreter " -c \"implib_meta_backport = None\nimplib_meta_python = None\ntry: import importlib_metadata;implib_meta_backport = importlib_metadata\nexcept: pass\ntry: import importlib.metadata;implib_meta_python = importlib.metadata\nexcept: pass\nimplib_meta = implib_meta_python or implib_meta_backport\nmods = sorted([i for i in map(lambda x: x.metadata['name'], implib_meta.distributions()) if i]); print('({})'.format(' '.join(['\"{}\"'.format(x) for x in mods]))) \"") 497 | ;; For older versions of Python. 498 | ;; (concat python-shell-interpreter " -c \"import pip; mods = sorted([i.key for i in pip.get_installed_distributions()]); print('({})'.format(' '.join(['\"{}\"'.format(x) for x in mods]))) \"") 499 | )))) 500 | 501 | 502 | (defun pydoc-pkg-modules () 503 | "Return list of built in python modules." 504 | (mapcar 505 | 'symbol-name 506 | (read (shell-command-to-string (concat pydoc-python-command " -c \"import pkgutil; print('({})'.format(' '.join(['\"{}\"'.format(x[1]) for x in pkgutil.iter_modules()])))\""))))) 507 | 508 | 509 | (defun pydoc-topics () 510 | "List of topics from the shell command `pydoc topics`." 511 | (apply 512 | 'append 513 | (mapcar (lambda (x) (split-string x " " t " ")) 514 | (cdr (split-string (shell-command-to-string (concat pydoc-command " topics")) "\n" t " "))))) 515 | 516 | 517 | (defun pydoc-keywords () 518 | "List of topics from the shell command `pydoc keywords`." 519 | (apply 520 | 'append 521 | (mapcar (lambda (x) (split-string x " " t " ")) 522 | (cdr (split-string (shell-command-to-string (concat pydoc-command " keywords")) "\n" t " "))))) 523 | 524 | 525 | (defvar *pydoc-all-modules* 526 | nil 527 | "Cached value of all modules.") 528 | 529 | 530 | (defun pydoc-all-modules (&optional reload) 531 | "Alphabetically sorted list of all modules. 532 | Value is cached to speed up subsequent calls. 533 | Optional RELOAD rereads the cache." 534 | (if (and (not reload) *pydoc-all-modules*) 535 | *pydoc-all-modules* 536 | (setq *pydoc-all-modules* 537 | (delete-dups 538 | (sort 539 | (append 540 | (pydoc-topics) 541 | (pydoc-keywords) 542 | (pydoc-builtin-modules) 543 | (pydoc-user-modules) 544 | (pydoc-pkg-modules)) 545 | 'string<))))) 546 | 547 | 548 | ;;* Fontification functions 549 | ;;** Fontifying code 550 | (defconst pydoc-example-code-leader-re 551 | (rx line-start 552 | (zero-or-one " |") ; Within a class 553 | (zero-or-more space) 554 | (group (or ">>>" "..." 555 | (and "In [" (one-or-more digit) "]:"))) 556 | " " 557 | (group (one-or-more not-newline)) 558 | line-end) 559 | "Regular expression matching leader for Python code snippet. 560 | This will be use to highlight line with Python syntax 561 | highlightling.") 562 | 563 | 564 | (defun pydoc-fontify-inline-code (limit) 565 | "Fontify example blocks up to LIMIT. 566 | These are lines marked by `pydoc-example-code-leader-re'." 567 | (when (re-search-forward pydoc-example-code-leader-re limit t) 568 | (set-text-properties (match-beginning 1) (match-end 1) 569 | '(font-lock-face pydoc-example-leader-face)) 570 | (org-src-font-lock-fontify-block 571 | "python" (match-beginning 2) (match-end 2)) 572 | t)) 573 | 574 | 575 | ;;** Overlay images on LaTeX fragments. 576 | ;; Note you need to escape some things in the 577 | ;; python docstrings, e.g. \\f, \\b, \\\\, \\r, \\n 578 | 579 | (defun pydoc-latex-overlays-1 (limit) 580 | "Overlay images on \(eqn\) up to LIMIT." 581 | (while (re-search-forward "\\\\([^]*?\\\\)" limit t) 582 | (save-restriction 583 | (save-excursion 584 | (narrow-to-region (match-beginning 0) (match-end 0)) 585 | (goto-char (point-min)) 586 | (org-format-latex 587 | (concat temporary-file-directory org-latex-preview-ltxpng-directory "pydoc") 588 | default-directory 'overlays "" '() 'forbuffer 589 | org-latex-create-formula-image-program))))) 590 | 591 | 592 | (defun pydoc-latex-overlays-2 (limit) 593 | "Overlay images on \[eqn\] up to LIMIT." 594 | (while (re-search-forward "\\\\\\[[^]*?\\\\\\]" limit t) 595 | (save-restriction 596 | (save-excursion 597 | (narrow-to-region (match-beginning 0) (match-end 0)) 598 | (goto-char (point-min)) 599 | (org-format-latex 600 | (concat temporary-file-directory org-latex-preview-ltxpng-directory "pydoc") 601 | default-directory 'overlays "" '() 'forbuffer 602 | org-latex-create-formula-image-program))))) 603 | 604 | 605 | (defun pydoc-latex-overlays-3 (limit) 606 | "Overlay images on $$eqn$$ up to LIMIT." 607 | (while (re-search-forward "\\$\\$[^]*?\\$\\$" limit t) 608 | (save-restriction 609 | (save-excursion 610 | (narrow-to-region (match-beginning 0) (match-end 0)) 611 | (goto-char (point-min)) 612 | (org-format-latex 613 | (concat temporary-file-directory org-latex-preview-ltxpng-directory "pydoc") 614 | default-directory 'overlays "" '() 'forbuffer 615 | org-latex-create-formula-image-program))))) 616 | 617 | 618 | (defun pydoc-latex-overlays-4 (limit) 619 | "Overlay images on $eqn$ up to LIMIT. 620 | this is less robust than useing \(\)" 621 | (while (re-search-forward "\\([^$]\\|^\\)\\(\\(\\$\\([^ \n,;.$][^$\n ]*?\\(\n[^$\n ]*?\\)\\{0,2\\}[^ \n,.$]\\)\\$\\)\\)\\([- .,?;:'\")]\\|$\\)" limit t) 622 | (save-restriction 623 | (save-excursion 624 | (narrow-to-region (match-beginning 0) (match-end 0)) 625 | (goto-char (point-min)) 626 | (org-format-latex 627 | (concat temporary-file-directory org-latex-preview-ltxpng-directory "pydoc") 628 | default-directory 'overlays "" '() 'forbuffer 629 | org-latex-create-formula-image-program))))) 630 | 631 | 632 | (defun pydoc-latex-overlays-5 (limit) 633 | "Overlay images on latex math environments up to LIMIT." 634 | (while (re-search-forward 635 | "^[ \\t]*\\(\\\\begin{\\([a-zA-Z0-9\\*]+\\)[^\\000]+?\\\\end{\\2}\\)" 636 | limit t) 637 | (save-restriction 638 | (save-excursion 639 | (narrow-to-region (match-beginning 1) (match-end 1)) 640 | (goto-char (point-min)) 641 | (org-format-latex 642 | (concat temporary-file-directory org-latex-preview-ltxpng-directory "pydoc") 643 | default-directory 'overlays "" '() 'forbuffer 644 | org-latex-create-formula-image-program))))) 645 | 646 | ;;** font-lock keywords 647 | (defvar pydoc-font-lock-keywords 648 | `((pydoc-fontify-inline-code) 649 | (org-activate-plain-links) 650 | (org-activate-bracket-links) 651 | (org-do-emphasis-faces) 652 | (,pydoc-sections-re 0 'bold) 653 | ("\\$[A-z0-9_]+" 0 font-lock-builtin-face) 654 | ("``.+?``" 0 font-lock-builtin-face) 655 | ("`.+?`" 0 font-lock-builtin-face) 656 | ("\".+?\"" 0 font-lock-string-face) 657 | ("'.+?'" 0 font-lock-string-face) 658 | (,(regexp-opt (list "True" "False" "None") 'words) 659 | 1 font-lock-constant-face)) 660 | "Font-lock keywords for pydoc.") 661 | 662 | 663 | ;;* pydoc buffer setup 664 | (defmacro pydoc-with-help-window (buffer-name &rest body) 665 | "Display buffer named BUFFER-NAME in a pydoc help window. 666 | Execute BODY in the buffer. This is the same as 667 | `with-help-window', except `pydoc-mode-setup' and 668 | `pydoc-mode-finish' are used instead of `help-mode-setup' and 669 | `help-mode-finish'." 670 | (declare (indent 1) (debug t)) 671 | `(progn 672 | ;; Make `help-window-point-marker' point nowhere. The only place 673 | ;; where this should be set to a buffer position is within BODY. 674 | (set-marker help-window-point-marker nil) 675 | (let ((temp-buffer-window-setup-hook 676 | (cons 'pydoc-mode-setup temp-buffer-window-setup-hook)) 677 | (temp-buffer-window-show-hook 678 | (cons 'pydoc-mode-finish temp-buffer-window-show-hook))) 679 | (with-temp-buffer-window 680 | ,buffer-name nil 'help-window-setup (progn ,@body))))) 681 | 682 | 683 | (defun pydoc-buffer () 684 | "Like `help-buffer', but for pydoc help buffers." 685 | (buffer-name 686 | (if (not help-xref-following) 687 | (get-buffer-create "*pydoc*") 688 | (unless (derived-mode-p 'help-mode) 689 | (error "Current buffer is not in Pydoc mode")) 690 | (current-buffer)))) 691 | 692 | 693 | (defun pydoc-setup-xref (item interactive-p) 694 | "Like `help-setup-xref', but for pydoc help buffers. 695 | See `help-setup-xref' for ITEM and INTERACTIVE-P documentation." 696 | (with-current-buffer (pydoc-buffer) 697 | (when help-xref-stack-item 698 | (push (cons (point) help-xref-stack-item) help-xref-stack) 699 | (setq help-xref-forward-stack nil)) 700 | (when interactive-p 701 | (let ((tail (nthcdr 10 help-xref-stack))) 702 | ;; Truncate the stack. 703 | (if tail (setcdr tail nil)))) 704 | (setq help-xref-stack-item item))) 705 | 706 | ;;* The main major mode definition 707 | (defvar pydoc-mode-map 708 | (let ((map (make-sparse-keymap))) 709 | (define-key map "n" 'next-line) 710 | (define-key map "N" 'forward-page) 711 | (define-key map "p" 'previous-line) 712 | (define-key map "P" 'backward-page) 713 | (define-key map "f" 'forward-char) 714 | (define-key map "b" 'backward-char) 715 | (define-key map "F" 'forward-word) 716 | (define-key map "B" 'backward-word) 717 | (define-key map "o" 'occur) 718 | (define-key map "s" 'isearch-forward) 719 | (define-key map "j" 'pydoc-jump-to-section) 720 | (define-key map "," (lambda () (interactive) (help-xref-go-back (current-buffer)))) 721 | (define-key map "." (lambda () (interactive) (help-xref-go-forward (current-buffer)))) 722 | map) 723 | "Keymap for Pydoc mode.") 724 | 725 | 726 | ;;;###autoload 727 | (define-derived-mode pydoc-mode help-mode "Pydoc" 728 | "Major mode for viewing pydoc output. 729 | Commands: 730 | \\{pydoc-mode-map}" 731 | (set (make-local-variable 'font-lock-defaults) 732 | '((pydoc-font-lock-keywords) t nil)) 733 | :keymap pydoc-mode-map) 734 | 735 | 736 | (defun pydoc-mode-setup () 737 | "Used in place of `help-mode-setup' in `pydoc-with-help-window'." 738 | (pydoc-mode) 739 | (setq buffer-read-only nil)) 740 | 741 | 742 | (defun pydoc-mode-finish () 743 | "Used in place of `help-mode-finish' in `pydoc-with-help-window'." 744 | (when (derived-mode-p 'pydoc-mode) 745 | (pydoc-set-info) 746 | (pydoc-make-xrefs (current-buffer)) 747 | (setq buffer-read-only nil) 748 | ;; When the following functions are in font-lock, emacs tends to crash. So I 749 | ;; put it here. 750 | (save-excursion 751 | (dolist (f '( ;; pydoc-image-overlays 752 | pydoc-latex-overlays-1 753 | pydoc-latex-overlays-2 754 | pydoc-latex-overlays-3 755 | pydoc-latex-overlays-4 756 | pydoc-latex-overlays-5 757 | org-display-inline-images)) 758 | (goto-char (point-min)) 759 | (funcall f nil))) 760 | (setq buffer-read-only t) 761 | (run-hooks 'pydoc-after-finish-hook))) 762 | 763 | ;;* The pydoc functions 764 | ;;;###autoload 765 | (defun pydoc (name) 766 | "Display pydoc information for NAME in `pydoc-buffer'. 767 | Completion is provided with candidates from `pydoc-all-modules'. 768 | This is cached for speed. Use a prefix arg to refresh it." 769 | (interactive 770 | (list (completing-read 771 | "Name of function or module: " 772 | (pydoc-all-modules current-prefix-arg)))) 773 | (pydoc-setup-xref (list #'pydoc name) 774 | (called-interactively-p 'interactive)) 775 | (pydoc-with-help-window (pydoc-buffer) 776 | (call-process-shell-command (concat pydoc-command " " name) 777 | nil standard-output))) 778 | 779 | ;;* The pydoc functions 780 | ;;;###autoload 781 | (defun pydoc-at-point-no-jedi (&optional prompt) 782 | "Try to get help for thing at point without python-jedi. 783 | With non-nil PROMPT or without a thing, prompt for the function or module." 784 | (interactive "P") 785 | (let ((name-of-symbol-at-point (if (symbol-at-point) 786 | (symbol-name (symbol-at-point)) 787 | ""))) 788 | (if (or prompt 789 | (not (symbol-at-point))) 790 | (pydoc (completing-read 791 | "Name of function or module: " 792 | (pydoc-all-modules current-prefix-arg) 793 | nil nil 794 | name-of-symbol-at-point)) 795 | (pydoc name-of-symbol-at-point))) ) 796 | 797 | 798 | ;;;###autoload 799 | (defun pydoc-at-point () 800 | "Try to get help for thing at point. 801 | Requires the python package jedi to be installed. 802 | 803 | There is no way right now to get to the full module path. This is a known limitation in jedi." 804 | (interactive) 805 | (let* ((script (buffer-string)) 806 | (line (line-number-at-pos)) 807 | (column (current-column)) 808 | (tfile (make-temp-file "py-")) 809 | (python-script 810 | (format 811 | "import jedi 812 | 813 | version = [int(x) for x in jedi.__version__.split('.')] 814 | 815 | if version[1] < 18: 816 | raise Exception('Please install jedi 0.18:\\npip install --upgrade jedi') 817 | 818 | s = jedi.Script(code=\"\"\"%s\"\"\") 819 | 820 | # This is a list 821 | gd = s.infer(line=%s, column=%s) 822 | 823 | 824 | if len(gd) > 0: 825 | print(f'''Help on {gd[0].full_name}: 826 | 827 | NAME 828 | {gd[0].name} 829 | 830 | {gd[0].docstring()} 831 | 832 | FILE 833 | {gd[0].module_path}::{gd[0].line} 834 | ''')" 835 | ;; I found I need to quote double quotes so they 836 | ;; work in the script above. 837 | (replace-regexp-in-string "\"" "\\\\\"" (replace-regexp-in-string "\\\\" "\\\\\\\\" script)) 838 | line 839 | column 840 | tfile))) 841 | 842 | (pydoc-setup-xref (list #'pydoc (thing-at-point 'word)) 843 | (called-interactively-p 'interactive)) 844 | 845 | (pydoc-with-help-window (pydoc-buffer) 846 | (with-temp-file tfile 847 | (insert python-script)) 848 | (call-process-shell-command (concat pydoc-python-command " " tfile) 849 | nil standard-output) 850 | (delete-file tfile)))) 851 | 852 | 853 | ;;** pydoc browser 854 | (defvar *pydoc-browser-process* 855 | nil 856 | "Process for the pydoc browser.") 857 | 858 | 859 | (defvar *pydoc-browser-port* 860 | nil 861 | "Port the pydoc browser is on.") 862 | 863 | 864 | ;;;###autoload 865 | (defun pydoc-browse () 866 | "Open a browser to pydoc. 867 | Attempts to find an open port, and to reuse the process." 868 | (interactive) 869 | (unless *pydoc-browser-process* 870 | ;; find an open port 871 | (if (executable-find "lsof") 872 | (cl-loop for port from 1025 873 | if (string= "" (shell-command-to-string (format "lsof -i :%s" port))) 874 | return (setq *pydoc-browser-port* (number-to-string port))) 875 | ;; Windows may not have an lsof command. 876 | (setq *pydoc-browser-port* "1234")) 877 | 878 | (setq *pydoc-browser-process* 879 | (apply 880 | #'start-process 881 | "pydoc-browser" 882 | "*pydoc-browser*" 883 | (append (split-string pydoc-command) `("-p" ,*pydoc-browser-port*))))) 884 | (browse-url (format "http://localhost:%s" *pydoc-browser-port*))) 885 | 886 | ;;;###autoload 887 | (defun pydoc-browse-kill () 888 | "Kill the pydoc browser." 889 | (when *pydoc-browser-process* 890 | (kill-process *pydoc-browser-process*) 891 | (setq *pydoc-browser-process* nil 892 | *pydoc-browser-port* nil))) 893 | 894 | 895 | (provide 'pydoc) 896 | 897 | ;;; pydoc.el ends here 898 | --------------------------------------------------------------------------------