├── .ert-runner ├── .gitignore ├── Cask ├── LICENSE ├── README.org ├── elpygen.el └── test ├── elpygen-test.el └── test-helper.el /.ert-runner: -------------------------------------------------------------------------------- 1 | -L . -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # Compiled 2 | *.elc 3 | 4 | # Packaging 5 | .cask 6 | 7 | # Backup files 8 | *~ 9 | 10 | # Undo-tree save-files 11 | *.~undo-tree 12 | -------------------------------------------------------------------------------- /Cask: -------------------------------------------------------------------------------- 1 | (source gnu) 2 | (source melpa) 3 | 4 | (package "elpygen" "0.1.0" "Generate Python function/method stub for a symbol under point") 5 | 6 | (files "elpygen.el") 7 | 8 | (development 9 | (depends-on "ert-runner") 10 | (depends-on "yasnippet")) 11 | -------------------------------------------------------------------------------- /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.org: -------------------------------------------------------------------------------- 1 | * What? 2 | 3 | ~elpygen.el~ implements a single function only: ~elpygen-implement~. The function retrieves the symbol 4 | name under the point, checks that the symbol looks like a call and that it's not defined anywhere 5 | in the current file and generates a stub definition based on the name of the symbol. 6 | 7 | As the insertion is done using ~yasnippet~ the inserted function/method template will be 8 | interactive, i.e. it's possible to cycle through the typical template modification points using 9 | ~~. 10 | 11 | ~elpygen~ requires Emacs version above 25, built-in ~python.el~ and ~yasnippet~. 12 | 13 | * How to install? 14 | 15 | For manual installation checkout the repository and copy ~elpygen.el~ to your ~load-path~. Make sure 16 | ~yasnippet~ is installed, and your emacs version is at least 25. 17 | 18 | The package is also available through [[http://melpa.milkbox.net][Melpa]]. So if you have that set up - just do ~M-x 19 | package-install elpygen~, which should ensure all the dependencies are installed. 20 | 21 | Having the package installed add ~(require 'elpygen)~ to your ~.emacs~ and bind ~elpygen-implement~ to a 22 | key you like: 23 | 24 | #+BEGIN_SRC emacs-lisp 25 | (define-key python-mode-map (kbd "C-c i") 'elpygen-implement). 26 | #+END_SRC 27 | 28 | * How to use? 29 | 30 | Move the point to the ~a_function_call~ symbol given the following code: 31 | 32 | #+BEGIN_SRC python 33 | 34 | a_function_call(first_named, 2, second_named) 35 | 36 | #+END_SRC 37 | 38 | Press ~C-c i~ (or the binding you use). The following stub will be inserted, pressing ~~ will 39 | cycle through the function name, args and the body. 40 | 41 | #+BEGIN_SRC python 42 | 43 | a_function_call(first_named, 2, second_named) 44 | 45 | 46 | def a_function_call(first_named, arg1, second_named): 47 | pass 48 | 49 | #+END_SRC 50 | 51 | Notice how the constant ~2~ was replaced with a default argument name ~arg1~. 52 | 53 | The same ~elpygen-implement~ works for methods. Given the following code move the point to 54 | ~a_method_call~. 55 | 56 | #+BEGIN_SRC python 57 | 58 | class Class(): 59 | 60 | def __init__(self): 61 | self.a_method_call(arg) 62 | 63 | #+END_SRC 64 | 65 | Press ~C-c i~: 66 | 67 | #+BEGIN_SRC python 68 | class Class(): 69 | 70 | def __init__(self): 71 | self.a_method_call(arg) 72 | 73 | def a_method_call(self, arg): 74 | pass 75 | 76 | #+END_SRC 77 | 78 | That's it, basically. ~elpygen-implement~ chooses between function and method templates based on 79 | the symbol name. Methods should start with ~self.~, and can only be implemented within a class. 80 | 81 | * Why? 82 | 83 | These days I write a lot of small Python utilities, and I prefer doing that using the top-down 84 | approach. This means I write the general code structure first, and figure out the details 85 | (function/method bodies) later. This package helps to streamline the process of generating those 86 | little helper functions and methods and saves a lot of key presses. 87 | 88 | My memory isn't that good any more so I explicitly try to avoid introducing multiple entry points 89 | or key bindings, so that the cognitive load isn't too big. 90 | 91 | Originally I wanted to offer this code for inclusion to the wonderful [[https://github.com/jorgenschaefer/elpy][Elpy]] package but figured out 92 | that ~elpygen~ doesn't need any code from it and is perfectly fine as a standalone package. 93 | 94 | * Plans? 95 | 96 | - [X] if a definition already exists - just navigate to it instead of template insertion 97 | 98 | - [ ] bugs 99 | 100 | - [ ] inserting a Class template based on the symbol name should also be possible. 101 | 102 | - [ ] inserting constants based on the symbol name (if a number or a string - offer to replace?) 103 | 104 | - [ ] customisation points (insertion method, insertion point, etc) 105 | -------------------------------------------------------------------------------- /elpygen.el: -------------------------------------------------------------------------------- 1 | ;;; elpygen.el --- Generate a Python function/method using a symbol under point -*- lexical-binding: t; -*- 2 | ;; Copyright (C) 2017 Vladimir Kazanov 3 | 4 | ;; Author: Vladimir Kazanov 5 | ;; Version: 0.1.0 6 | ;; Package-Requires: ((emacs "25") (yasnippet "0.8.0")) 7 | ;; Keywords: Python, Languages, Tools 8 | ;; URL: https://github.com/vkazanov/elpygen 9 | 10 | ;; This program is free software; you can redistribute it and/or 11 | ;; modify it under the terms of the GNU General Public License 12 | ;; as published by the Free Software Foundation; either version 3 13 | ;; of the License, or (at your option) any later version. 14 | 15 | ;; This program is distributed in the hope that it will be useful, 16 | ;; but WITHOUT ANY WARRANTY; without even the implied warranty of 17 | ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 18 | ;; GNU General Public License for more details. 19 | 20 | ;; You should have received a copy of the GNU General Public License 21 | ;; along with this program. If not, see . 22 | 23 | ;;; Commentary: 24 | ;; 25 | ;; `elpygen.el' uses the symbol name and it's arguments under point to 26 | ;; insert a method or a function stub into a suitable place. It also 27 | ;; makes sure the symbol is not already defined, and the requested 28 | ;; symbol is really a function/method call. 29 | ;; 30 | ;; To use the package just bind the main function to a suitable key: 31 | ;; 32 | ;; (define-key python-mode-map (kbd "C-c i") 'elpygen-implement). 33 | ;; 34 | 35 | ;;; Code: 36 | 37 | (require 'yasnippet) 38 | (require 'python) 39 | (require 'rx) 40 | (require 'subr-x) 41 | (require 'thingatpt) 42 | (require 'cl-lib) 43 | 44 | (defvar elpygen-function-template "def ${1:`fun`}(${2:`args`}): 45 | ${0:pass} 46 | " 47 | "A Yasnippet template to be used for a function stub.") 48 | 49 | (defvar elpygen-method-template "def ${1:`fun`}(${2:`(if (not (string-empty-p args)) (concat \"self, \" args) \"self\")`}): 50 | ${0:pass} 51 | " 52 | "A Yasnippet template to be used for a method stub.") 53 | 54 | (defvar elpygen--varname-re (python-rx line-start symbol-name line-end)) 55 | 56 | (defvar elpygen--call-re (python-rx (optional "self" "\\.") symbol-name (* space) "(")) 57 | 58 | (defvar elpygen--class-re (python-rx line-start (* space) "class" (+ space) symbol-name)) 59 | 60 | ;;;###autoload 61 | (defun elpygen-implement () 62 | "Implement a function or a method using the symbol name and call arguments under the point." 63 | (interactive) 64 | (when (python-syntax-comment-or-string-p) 65 | (user-error "Cannot extract symbols in comments/strings ")) 66 | (when (not (elpygen--looking-at-call-p)) 67 | (user-error "This doesn't look like a function/method call")) 68 | (when (python-info-looking-at-beginning-of-defun) 69 | (user-error "This is a function/method/class definition, not a call")) 70 | (push-mark) 71 | (if-let (name (elpygen--get-def-name)) 72 | (if (elpygen--symbol-method-p name) 73 | (elpygen--implement-or-find-method (string-remove-prefix "self." name)) 74 | (elpygen--implement-or-find-function name)) 75 | (user-error "Failed to find a suitable symbol"))) 76 | 77 | (defun elpygen--looking-at-call-p () 78 | "Check if looking at a proper call." 79 | (save-excursion 80 | (with-syntax-table python-dotty-syntax-table 81 | (and (thing-at-point 'symbol) 82 | (beginning-of-thing 'symbol) 83 | (looking-at-p elpygen--call-re))))) 84 | 85 | (defun elpygen--symbol-method-p (symbol-name) 86 | "Check if a symbol is a method call. 87 | Argument SYMBOL-NAME the name of the symbol to check." 88 | (string-prefix-p "self." symbol-name t)) 89 | 90 | (defun elpygen--find-function-definition (name) 91 | "Find a top-level function definition or return nil. 92 | Argument NAME the name of the symbol to check." 93 | (save-excursion 94 | (goto-char (point-min)) 95 | (when (re-search-forward (elpygen--make-defun-re name t) nil t) 96 | (match-beginning 1)))) 97 | 98 | (defun elpygen--find-method-definition (name) 99 | "Find a method definition in the current class or return nil. 100 | Argument NAME the name of the symbol to check." 101 | (save-excursion 102 | (let (class-start class-end) 103 | (while (and (not (elpygen--looking-at-class-definition)) 104 | (python-nav-backward-block))) 105 | (setq class-start (point)) 106 | (python-nav-end-of-defun) 107 | (setq class-end (point)) 108 | (goto-char class-start) 109 | (when (re-search-forward (elpygen--make-defun-re name) class-end t) 110 | (match-beginning 1))))) 111 | 112 | (defun elpygen--make-defun-re (name &optional toplevel) 113 | "Build a regex that match a function definition NAME. 114 | Argument NAME is the name of the function to match. 115 | Argument TOPLEVEL should be nil when nested definitions are ok, t 116 | otherwise." 117 | (macroexpand 118 | `(python-rx 119 | ,@(if toplevel '(line-start "def" (+ space)) 120 | '(line-start (* space) "def" (+ space))) 121 | (group-n 1 ,name) (* space) "("))) 122 | 123 | (defun elpygen--looking-at-class-definition () 124 | "Check if looking at a class definition." 125 | (save-excursion 126 | (beginning-of-line 1) 127 | (looking-at elpygen--class-re))) 128 | 129 | (defun elpygen--implement-or-find-function (name) 130 | "Find a top-level function definition or insert a function stub. 131 | Argument NAME the name of the function to find or insert." 132 | (if-let (pos (elpygen--find-function-definition name)) 133 | (progn 134 | (goto-char pos) 135 | (user-error "Function already implemented")) 136 | (elpygen--implement-function name))) 137 | 138 | (defun elpygen--implement-function (name) 139 | "Find a top-level function definition or insert a function stub. 140 | Argument NAME the name of the function to insert." 141 | (let ((arglist (elpygen--get-arglist))) 142 | (elpygen--prepare-function-insert-point) 143 | (elpygen--insert-template elpygen-function-template 144 | name 145 | arglist))) 146 | 147 | (defun elpygen--implement-or-find-method (name) 148 | "Find a method in the current class or insert a method stub. 149 | Argument NAME is the name of method to find or insert." 150 | (unless (elpygen--within-method-p) 151 | (user-error "Can only implement a method from within a method of a class")) 152 | (if-let (pos (elpygen--find-method-definition name)) 153 | (progn 154 | (goto-char pos) 155 | (user-error "Method already implemented")) 156 | (elpygen--implement-method name))) 157 | 158 | (defun elpygen--implement-method (name) 159 | "Insert a method stub into the current class. 160 | Argument NAME is the name of method to insert." 161 | (let ((arglist (elpygen--get-arglist))) 162 | (elpygen--prepare-method-insert-point) 163 | (elpygen--insert-template elpygen-method-template 164 | name 165 | arglist))) 166 | 167 | (defun elpygen--within-method-p () 168 | "Check if the point is inside a method." 169 | (when-let ((defun-info (python-info-current-defun)) 170 | (defun-info-parts (split-string defun-info "\\.")) 171 | (typed-defun-info (python-info-current-defun t))) 172 | ;; Should be a method (i.e. def) and should be within a class, i.e. defun info should contain at 173 | ;; least two parts, with the first capitalised. Should work most of the time. 174 | (and (string-prefix-p "def" typed-defun-info) 175 | (>= (length defun-info-parts) 2)))) 176 | 177 | (defun elpygen--insert-template (template name arglist) 178 | "Insert a TEMPLATE into the current buffer. 179 | Argument NAME is the name of the function/method to insert. 180 | Argument ARGLIST is the argument list of the function/method." 181 | (yas-expand-snippet template nil nil 182 | `((fun ,name) 183 | (args ,(elpygen--format-args arglist))))) 184 | 185 | (defun elpygen--get-def-name () 186 | "Retrieve a symbol under the point." 187 | (with-syntax-table python-dotty-syntax-table 188 | (when-let (funname (thing-at-point 'symbol)) 189 | (substring-no-properties funname)))) 190 | 191 | (defun elpygen--get-arglist () 192 | "Retrieve the argument list of the symbol at point." 193 | (save-excursion 194 | (with-syntax-table python-dotty-syntax-table 195 | (when (symbol-at-point) 196 | (end-of-thing 'symbol) 197 | (skip-chars-forward "[:blank:]") 198 | (when (looking-at-p "(") 199 | (when-let (sexp (thing-at-point 'sexp)) 200 | (elpygen--parse-arg-str sexp))))))) 201 | 202 | (defun elpygen--parse-arg-str (arg-str) 203 | "Make a list of arguments from ARG-STR." 204 | (split-string (substring-no-properties arg-str 1 -1) 205 | "," t split-string-default-separators)) 206 | 207 | (defun elpygen--format-args (arg-list) 208 | "Build a string from the list of argument names. 209 | Argument ARG-LIST is the list of argument names." 210 | (let ((counter 0)) 211 | (cl-flet 212 | ((format-arg (arg) 213 | (if (string-match-p elpygen--varname-re arg) 214 | arg 215 | (cl-incf counter) 216 | (concat "arg" (number-to-string counter))))) 217 | (string-join (mapcar #'format-arg arg-list) ", ")))) 218 | 219 | (defun elpygen--prepare-function-insert-point () 220 | "Move the point to a place suitable for function insertion." 221 | (while (and 222 | (> (current-indentation) 0) 223 | (python-nav-backward-block))) 224 | (python-nav-end-of-block) 225 | (forward-line) 226 | (newline 2)) 227 | 228 | (defun elpygen--prepare-method-insert-point () 229 | "Move the point to a place suitable for method insertion." 230 | (let (target-indent) 231 | (save-excursion 232 | (while (and 233 | (not (python-info-looking-at-beginning-of-defun)) 234 | (python-nav-backward-block))) 235 | (setq target-indent (current-indentation))) 236 | (python-nav-end-of-defun) 237 | (newline 1) 238 | (indent-to target-indent))) 239 | 240 | 241 | (provide 'elpygen) 242 | 243 | ;;; elpygen.el ends here 244 | -------------------------------------------------------------------------------- /test/elpygen-test.el: -------------------------------------------------------------------------------- 1 | ;;; -*- lexical-binding: t; -*- 2 | ;;; elpygen-test.el --- Tests for elpygen 3 | 4 | (require 'elpygen) 5 | 6 | (ert-deftest elpygen--symbol-method-p-test () 7 | (should (elpygen--symbol-method-p "self.function_name")) 8 | (should (elpygen--symbol-method-p "self.function")) 9 | (should (not (elpygen--symbol-method-p "function_name"))) 10 | (should (not (elpygen--symbol-method-p "function")))) 11 | 12 | (ert-deftest elpygen--parse-arg-str-test () 13 | (should (equal '("1" "abc" "2") 14 | (elpygen--parse-arg-str "(1, abc, 2)")))) 15 | 16 | (ert-deftest elpygen--format-args-test () 17 | (should (equal "" 18 | (elpygen--format-args '()))) 19 | (should (equal "arg1, abc, arg2" 20 | (elpygen--format-args '("1" "abc" "\"str\""))))) 21 | 22 | (ert-deftest elpygen--insert-template-test () 23 | (elpygen-with-temp-python-buffer "" 24 | (elpygen--insert-template elpygen-function-template 25 | "funname" 26 | '("arg1" "arg2")) 27 | (let ((expected "def funname(arg1, arg2): 28 | pass 29 | ")) 30 | (should (equal expected 31 | (buffer-substring-no-properties (point-min) (point-max))))))) 32 | 33 | (ert-deftest elpygen--get-def-name-test () 34 | (elpygen-with-temp-python-buffer 35 | " 36 | function_name() 37 | 38 | self.method_name() 39 | 40 | " 41 | (elpygen-look-at "n_name") 42 | (should (equal "function_name" 43 | (elpygen--get-def-name))) 44 | 45 | (elpygen-look-at "thod") 46 | (should (equal "self.method_name" 47 | (elpygen--get-def-name))) 48 | 49 | (forward-line) 50 | (should (eq nil 51 | (elpygen--get-def-name))))) 52 | 53 | (ert-deftest elpygen--get-arglist-test () 54 | (elpygen-with-temp-python-buffer " 55 | with_empty_args() 56 | 57 | no_args 58 | 59 | something else 60 | 61 | plenty_of_args(arg1, arg2) 62 | 63 | self.method_name(marg1) 64 | 65 | " 66 | (elpygen-look-at "empty_args") 67 | (should (equal '() 68 | (elpygen--get-arglist))) 69 | 70 | (elpygen-look-at "no_args") 71 | (should (equal '() 72 | (elpygen--get-arglist))) 73 | 74 | (elpygen-look-at "of_args") 75 | (should (equal '("arg1" "arg2") 76 | (elpygen--get-arglist))) 77 | 78 | (elpygen-look-at "elf.") 79 | (should (equal '("marg1") 80 | (elpygen--get-arglist))))) 81 | 82 | (ert-deftest elpygen--within-method-p-test () 83 | (elpygen-with-temp-python-buffer " 84 | 85 | a_symbol 86 | 87 | a_funcall() 88 | 89 | bad_method_call() 90 | 91 | def definition(): 92 | in_definition() 93 | 94 | class Class: 95 | static_property 96 | 97 | def method(self, smth): 98 | self.new_method(arg1) 99 | 100 | after_class 101 | " 102 | (elpygen-look-at "_sym") 103 | (should (not (elpygen--within-method-p))) 104 | 105 | (forward-line) 106 | (should (not (elpygen--within-method-p))) 107 | 108 | (elpygen-look-at "in_definition") 109 | (should (not (elpygen--within-method-p))) 110 | 111 | (elpygen-look-at "_funcall") 112 | (should (not (elpygen--within-method-p))) 113 | 114 | (elpygen-look-at "atic_property") 115 | (should (not (elpygen--within-method-p))) 116 | 117 | (elpygen-look-at "w_meth") 118 | (should (elpygen--within-method-p)) 119 | 120 | (forward-line) 121 | (should (not (elpygen--within-method-p))) 122 | 123 | (elpygen-look-at "ter_class") 124 | (should (not (elpygen--within-method-p))))) 125 | 126 | (ert-deftest elpygen--prepare-function-insert-point-simple-test () 127 | (elpygen-with-temp-python-buffer " 128 | a_funcall() 129 | other_call() 130 | " 131 | (elpygen-look-at "_fun") 132 | (elpygen--prepare-function-insert-point) 133 | (should (= 5 (line-number-at-pos))) 134 | (should (equal " 135 | a_funcall() 136 | 137 | 138 | other_call() 139 | " 140 | (buffer-substring-no-properties (point-min) 141 | (point-max)))))) 142 | 143 | 144 | (ert-deftest elpygen--prepare-function-insert-point-block-test () 145 | (elpygen-with-temp-python-buffer " 146 | if True: 147 | a_funcall() 148 | other_call() 149 | " 150 | (elpygen-look-at "_fun") 151 | (elpygen--prepare-function-insert-point) 152 | (should (= 6 (line-number-at-pos))) 153 | (should (equal " 154 | if True: 155 | a_funcall() 156 | 157 | 158 | other_call() 159 | " 160 | (buffer-substring-no-properties (point-min) 161 | (point-max)))))) 162 | 163 | (ert-deftest elpygen--prepare-function-insert-point-function-test () 164 | (elpygen-with-temp-python-buffer " 165 | def function(arg, arg): 166 | a_funcall() 167 | pass 168 | other_call() 169 | " 170 | (elpygen-look-at "_fun") 171 | (elpygen--prepare-function-insert-point) 172 | (should (= 7 (line-number-at-pos))) 173 | (should (equal " 174 | def function(arg, arg): 175 | a_funcall() 176 | pass 177 | 178 | 179 | other_call() 180 | " 181 | (buffer-substring-no-properties (point-min) 182 | (point-max)))))) 183 | 184 | (ert-deftest elpygen--prepare-function-insert-point-method-test () 185 | (elpygen-with-temp-python-buffer " 186 | class Bla(): 187 | def function(arg, arg): 188 | a_funcall() 189 | pass 190 | other_call() 191 | " 192 | (elpygen-look-at "_funcall") 193 | (elpygen--prepare-function-insert-point) 194 | (should (= 8 (line-number-at-pos))) 195 | (should (equal " 196 | class Bla(): 197 | def function(arg, arg): 198 | a_funcall() 199 | pass 200 | 201 | 202 | other_call() 203 | " 204 | (buffer-substring-no-properties (point-min) 205 | (point-max)))))) 206 | 207 | 208 | (ert-deftest elpygen--elpygen--prepare-method-insert-point-simple-test () 209 | (elpygen-with-temp-python-buffer " 210 | class Bla(): 211 | 212 | def function(self, arg): 213 | self.other_call(arg1) 214 | if True: 215 | block_call() 216 | 217 | 218 | def next_function(self, arg): 219 | self.call(arg2) 220 | 221 | 222 | class NextClass(): 223 | pass 224 | " 225 | (elpygen-look-at "ther_call") 226 | (elpygen--prepare-method-insert-point) 227 | (should (= 9 (line-number-at-pos))) 228 | (should (= 4 (current-column))) 229 | 230 | (elpygen-look-at ".call") 231 | (elpygen--prepare-method-insert-point) 232 | (should (= 14 (line-number-at-pos))) 233 | (should (= 4 (current-column))))) 234 | 235 | 236 | 237 | ;;; elpygen-test.el ends here 238 | -------------------------------------------------------------------------------- /test/test-helper.el: -------------------------------------------------------------------------------- 1 | ;;; test-helper.el --- Helpers for elpygen-test.el 2 | 3 | ;; NOTE: A slightly modified copy from emacs/lisp/progmodes/python-tests.el 4 | (defmacro elpygen-with-temp-python-buffer (contents &rest body) 5 | "Create a `python-mode' enabled temp buffer with CONTENTS. 6 | BODY is code to be executed within the temp buffer. Point is 7 | always located at the beginning of buffer." 8 | (declare (indent 1) (debug t)) 9 | `(with-temp-buffer 10 | (let ((python-indent-guess-indent-offset nil)) 11 | (python-mode) 12 | (yas-minor-mode) 13 | (insert ,contents) 14 | (goto-char (point-min)) 15 | ,@body))) 16 | 17 | ;; NOTE: A slightly modified copy from emacs/lisp/progmodes/python-tests.el 18 | (defun elpygen-look-at (string &optional num restore-point) 19 | "Move point at beginning of STRING in the current buffer. 20 | Optional argument NUM defaults to 1 and is an integer indicating 21 | how many occurrences must be found, when positive the search is 22 | done forwards, otherwise backwards. When RESTORE-POINT is 23 | non-nil the point is not moved but the position found is still 24 | returned. When searching forward and point is already looking at 25 | STRING, it is skipped so the next STRING occurrence is selected." 26 | (let* ((num (or num 1)) 27 | (starting-point (point)) 28 | (string (regexp-quote string)) 29 | (search-fn (if (> num 0) #'re-search-forward #'re-search-backward)) 30 | (deinc-fn (if (> num 0) #'1- #'1+)) 31 | (found-point)) 32 | (prog2 33 | (catch 'exit 34 | (while (not (= num 0)) 35 | (when (and (> num 0) 36 | (looking-at string)) 37 | ;; Moving forward and already looking at STRING, skip it. 38 | (forward-char (length (match-string-no-properties 0)))) 39 | (and (not (funcall search-fn string nil t)) 40 | (throw 'exit t)) 41 | (when (> num 0) 42 | ;; `re-search-forward' leaves point at the end of the 43 | ;; occurrence, move back so point is at the beginning 44 | ;; instead. 45 | (forward-char (- (length (match-string-no-properties 0))))) 46 | (setq 47 | num (funcall deinc-fn num) 48 | found-point (point)))) 49 | found-point 50 | (and restore-point (goto-char starting-point))))) 51 | 52 | ;;; test-helper.el ends here 53 | --------------------------------------------------------------------------------