├── .github └── workflows │ └── pythonpublish.yml ├── LICENSE ├── README.md ├── README.zh-cn.md ├── misc └── pylane_show.gif ├── pylane ├── __init__.py ├── core │ ├── __init__.py │ ├── exception.py │ └── injector.py ├── entry.py └── shell │ ├── __init__.py │ ├── help_functions.py │ ├── inject.py │ ├── ipython_embed.py │ ├── proxy.py │ ├── remote_shell.py │ ├── shell.py │ └── sock.py ├── setup.cfg └── setup.py /.github/workflows/pythonpublish.yml: -------------------------------------------------------------------------------- 1 | # This workflows will upload a Python Package using Twine when a release is created 2 | # For more information see: https://help.github.com/en/actions/language-and-framework-guides/using-python-with-github-actions#publishing-to-package-registries 3 | 4 | name: Upload Python Package 5 | 6 | on: 7 | release: 8 | types: [created] 9 | 10 | jobs: 11 | deploy: 12 | 13 | runs-on: ubuntu-latest 14 | 15 | steps: 16 | - uses: actions/checkout@v2 17 | - name: Set up Python 18 | uses: actions/setup-python@v1 19 | with: 20 | python-version: '3.x' 21 | - name: Install dependencies 22 | run: | 23 | python -m pip install --upgrade pip 24 | pip install setuptools wheel twine 25 | - name: Build and publish 26 | env: 27 | TWINE_USERNAME: ${{ secrets.PYPI_USERNAME }} 28 | TWINE_PASSWORD: ${{ secrets.PYPI_PASSWORD }} 29 | run: | 30 | python setup.py sdist 31 | python setup.py bdist_wheel --universal 32 | twine upload dist/* 33 | -------------------------------------------------------------------------------- /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 | # pylane 2 | 3 | [![PyPI version](https://badge.fury.io/py/pylane.svg)](https://badge.fury.io/py/pylane) 4 | 5 | 6 | [简体中文](README.zh-cn.md) 7 | 8 | Pylane is a python vm injector with debug tools, based on gdb and ptrace. 9 | Pylane uses gdb to trace python process, inject and run some code in its python vm. 10 | 11 | ## Usage 12 | 13 | ![pylane_show](misc/pylane_show.gif) 14 | 15 | use inject command to inject a python script in an process: 16 | 17 | ``` 18 | pylane inject 19 | ``` 20 | 21 | use shell command to inject an interactive shell: 22 | 23 | ``` 24 | pylane shell 25 | ``` 26 | 27 | Pylane shell features: 28 | 29 | * use IPython as its interactive interface, support magic functions like ? and % 30 | * support remote automatic completion 31 | * provide debug toolkit functions, such as: 32 | * lookup class or instance by name 33 | * get source code of an object 34 | * print all threads' stack and locals 35 | 36 | ## Install 37 | 38 | ``` 39 | pip install pylane 40 | ``` 41 | 42 | pylane should be installed in virtualenv the target process uses or in os python lib. 43 | 44 | ## Compatibility 45 | 46 | Support Linux and BSD 47 | -------------------------------------------------------------------------------- /README.zh-cn.md: -------------------------------------------------------------------------------- 1 | # pylane 2 | 3 | [![PyPI version](https://badge.fury.io/py/pylane.svg)](https://badge.fury.io/py/pylane) 4 | 5 | [English](README.md) 6 | 7 | Pylane 是一个基于gdb的python进程注入和调试工具, 8 | 通过gdb trace python进程，然后在该进程的python vm中动态地注入一段python代码， 9 | 从而对一个运行中的python进程执行一段任意的逻辑。 10 | 11 | ## 用法 12 | 13 | ![pylane_show](misc/pylane_show.gif) 14 | 15 | 使用inject命令把一个python脚本注入到目标进程： 16 | 17 | ``` 18 | pylane inject 19 | ``` 20 | 21 | 使用shell命令对目标进程注入一个交互式的shell： 22 | 23 | ``` 24 | pylane shell 25 | ``` 26 | 27 | Pylane shell特性： 28 | 29 | * 使用IPython作为交互接口，支持 ? % 等魔术方法 30 | * 支持完整的远程自动补全 31 | * 提供常用工具函数，例如: 32 | * 按名字搜索类或实例 33 | * 获取对象源代码 34 | * 打印所有线程栈和局部变量 35 | 36 | ## 安装 37 | 38 | ``` 39 | pip install pylane 40 | ``` 41 | 42 | 如果使用virtualenv，需要pylane安装在被attach进程所用的env或系统库. 43 | 44 | ## 兼容性 45 | 46 | 兼容 Linux 和 BSD 47 | -------------------------------------------------------------------------------- /misc/pylane_show.gif: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/NtesEyes/pylane/d5e9b9c613fb7c550e062f271824e36033d6a28b/misc/pylane_show.gif -------------------------------------------------------------------------------- /pylane/__init__.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/NtesEyes/pylane/d5e9b9c613fb7c550e062f271824e36033d6a28b/pylane/__init__.py -------------------------------------------------------------------------------- /pylane/core/__init__.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/NtesEyes/pylane/d5e9b9c613fb7c550e062f271824e36033d6a28b/pylane/core/__init__.py -------------------------------------------------------------------------------- /pylane/core/exception.py: -------------------------------------------------------------------------------- 1 | # -*- coding: utf-8 -*- 2 | 3 | 4 | import traceback 5 | 6 | 7 | class PylaneException(Exception): 8 | pass 9 | 10 | 11 | class RequirementsInvalid(PylaneException): 12 | pass 13 | 14 | 15 | def PylaneExceptionHandler(func): 16 | def wrapper(*args, **kwargs): 17 | try: 18 | return func(*args, **kwargs) 19 | except PylaneException as e: 20 | for arg in e.args: 21 | print(arg) 22 | # TODO 23 | except Exception as e: 24 | print('Internal error occured, contact author if u need help.') 25 | for arg in e.args: 26 | print(arg) 27 | print(traceback.format_exc()) 28 | exit(1) 29 | return wrapper 30 | -------------------------------------------------------------------------------- /pylane/core/injector.py: -------------------------------------------------------------------------------- 1 | # -*- coding: utf-8 -*- 2 | 3 | import os 4 | import sys 5 | import signal 6 | import time 7 | import tempfile 8 | import platform 9 | import re 10 | import subprocess 11 | import stat 12 | import atexit 13 | from threading import Timer 14 | from .exception import ( 15 | RequirementsInvalid, 16 | PylaneExceptionHandler 17 | ) 18 | 19 | try: 20 | # py3 21 | from subprocess import getoutput 22 | except ImportError: 23 | # py2 24 | from commands import getoutput 25 | 26 | 27 | class Injector(object): 28 | """Inject a python process, run some code inside the vm.""" 29 | 30 | def __init__(self, 31 | pid=None, 32 | code=None, 33 | file_path=None, 34 | gdb_path='gdb', 35 | timeout=10, 36 | verbose=0, 37 | **ignore): 38 | """Init injector by args. 39 | Args: 40 | pid (int): target python process's pid. 41 | code (str): raw code. 42 | file_path (str): file path of the python code file. 43 | gdb_path (str): executable gdb path. 44 | timeout (int): timeout seconds. 45 | verbose (int): verbose level. 46 | 47 | Returns: 48 | """ 49 | 50 | self.gdb = gdb_path 51 | self.timeout = timeout 52 | self.verbose = verbose 53 | 54 | self.env_detect() 55 | self.ensure_pid(pid) 56 | self.temp_file = None 57 | self.code_file = None 58 | self.ensure_code_file(code, file_path) 59 | 60 | atexit.register(self.cleanup) 61 | 62 | def env_detect(self): 63 | """""" 64 | # check platform 65 | self.env = env = {} 66 | if 'BSD' in platform.platform(): 67 | env['bsd'] = True 68 | self.run = self._bsd_run 69 | 70 | try: 71 | with open('/etc/lsb-release', 'rb') as f: 72 | lsb_release = f.read() 73 | distrib = re.search(b'DISTRIB_ID=(.+)', lsb_release, re.MULTILINE).groups()[0] 74 | if distrib == b'Ubuntu': 75 | env['ubuntu'] = True 76 | except Exception: 77 | pass 78 | 79 | # check gdb 80 | if not os.access(self.gdb, os.X_OK): 81 | raise RequirementsInvalid( 82 | 'gdb is not exist or not executable.' 83 | ) 84 | # check ptrace 85 | ptrace_scope = '/proc/sys/kernel/yama/ptrace_scope' 86 | ptrace_req_msg = ('ptrace is disabled, enable it by:' 87 | 'echo 0 | sudo tee /proc/sys/kernel/yama/ptrace_scope . ' 88 | 'arg --privileged may be also needed for docker ' 89 | 'exec/run command to override ptrace_scope.') 90 | if os.path.exists(ptrace_scope): 91 | with open(ptrace_scope, 'r') as f: 92 | value = int(f.read().strip()) 93 | if value == 1: 94 | raise RequirementsInvalid(ptrace_req_msg) 95 | else: 96 | getsebool = '/usr/sbin/getsebool' 97 | if os.path.exists(getsebool): 98 | p = subprocess.Popen( 99 | [getsebool, 'deny_ptrace'], 100 | stdout=subprocess.PIPE, stderr=subprocess.PIPE) 101 | out, err = p.communicate() 102 | if 'deny_ptrace --> on' in out: 103 | raise RequirementsInvalid(ptrace_req_msg) 104 | 105 | def cleanup(self): 106 | """""" 107 | if self.temp_file and os.path.exists(self.temp_file): 108 | try: 109 | os.unlink(self.temp_file) 110 | except: 111 | pass 112 | 113 | def ensure_code_file(self, code, file_path): 114 | """""" 115 | if file_path: 116 | file_path = os.path.abspath(file_path) 117 | if not os.path.isfile(file_path): 118 | raise RequirementsInvalid( 119 | 'Arg file_path is not a valid file.' 120 | ) 121 | self.code_file = file_path 122 | else: 123 | if code: 124 | (fd, temp_file_path) = tempfile.mkstemp() 125 | with os.fdopen(fd, 'w') as f: 126 | f.write(code) 127 | self.code_file = self.temp_file = temp_file_path 128 | else: 129 | raise RequirementsInvalid( 130 | 'Neither code nor code file_path specified.' 131 | ) 132 | st = os.stat(self.code_file) 133 | os.chmod(self.code_file, 134 | st.st_mode | stat.S_IREAD | stat.S_IRGRP | stat.S_IROTH) 135 | 136 | def ensure_pid(self, pid): 137 | """""" 138 | ps_cmd = "ps ax | awk '{print $1}' | grep -w %s" % pid 139 | if not pid or not getoutput(ps_cmd): 140 | raise RequirementsInvalid('Process %s not exist.' % pid) 141 | self.pid = pid 142 | 143 | def generate_gdb_codes(self): 144 | """Generate gdb command codes 145 | Args: 146 | Returns: 147 | list: gdb command code lines 148 | """ 149 | 150 | lib_path = os.path.abspath( 151 | os.path.join(os.path.abspath(__file__), '../..') 152 | ) 153 | inject_paths = [ 154 | # TODO to support injected code file's path 155 | # cannot support docker container 156 | # os.path.dirname(self.code_file), 157 | # current path, not used 158 | os.getcwd(), 159 | lib_path 160 | ] 161 | temp_sys_name = '_pylane_sys' 162 | prepare_code = ' '.join([ 163 | 'import sys as %s;' % temp_sys_name, 164 | '%s.path.extend([%s]);' % ( 165 | temp_sys_name, 166 | ','.join(['\\\"%s\\\"' % p for p in inject_paths]) 167 | ) 168 | ]) 169 | # deprecated, cause its hard to pass python code in shell args 170 | # exec code is passed by shell command line, so add \\\" and \\\\n 171 | # run_code = 'exec(\\\"%s\\\")' % (self.code.replace('\n', '\\\\n')) 172 | if sys.version_info.major == 2: 173 | run_code = ' '.join([ 174 | '__code_file = open(\\\"%s\\\");' % self.code_file, 175 | '__raw_code = __code_file.read();', 176 | '__code_file.close();', 177 | # python 2 donot support exec as Thread's target param 178 | 'exec(__raw_code);', 179 | 'del __code_file;', 180 | 'del __raw_code;' 181 | ]) 182 | else: 183 | run_code = ' '.join([ 184 | '__code_file = open(\\\"%s\\\");' % self.code_file, 185 | '__raw_code = __code_file.read();', 186 | '__code_file.close();', 187 | # run code async and stop injection early to keep target process safe 188 | 'from threading import Thread as __Thread;' 189 | '__thread = __Thread(target=exec, args=(__raw_code,));' 190 | '__thread.daemon = True;' 191 | '__thread.start();' 192 | 'del __code_file;' 193 | 'del __raw_code;' 194 | 'del __Thread;' 195 | 'del __thread;' 196 | ]) 197 | # TODO injected code may change path as well 198 | cleanup_code = ' '.join([ 199 | '%s.path = %s.path[:-%s];' % ( 200 | temp_sys_name, 201 | temp_sys_name, 202 | len(inject_paths) 203 | ) 204 | ]) 205 | return [ 206 | # use char in case of symbol PyGilState_STATE not found 207 | 'call $gil_state = (char) PyGILState_Ensure()', 208 | 'call (void) PyRun_SimpleString("%s")' % prepare_code, 209 | 'call (void) PyRun_SimpleString("%s")' % run_code, 210 | 'call (void) PyRun_SimpleString("%s")' % cleanup_code, 211 | # make sure previous codes are safe. 212 | # gdb exit without GIL release is a disaster for target process. 213 | 'call (void) PyGILState_Release($gil_state)', 214 | ] 215 | 216 | def timeout_exit(self, process): 217 | print("timeout in %s secs, exit." % self.timeout) 218 | os.kill(process.pid, signal.SIGTERM) 219 | 220 | def inject(self): 221 | """Run inject""" 222 | codes = self.generate_gdb_codes() 223 | process = self.run(codes) 224 | timer = Timer(self.timeout, self.timeout_exit, (process,)) 225 | out = b'' 226 | err = b'' 227 | try: 228 | timer.start() 229 | out, err = process.communicate() 230 | finally: 231 | timer.cancel() 232 | self.cleanup() 233 | if self.verbose: 234 | print('stdout:', out) 235 | print('stderr:', err) 236 | print(err) 237 | if b'Operation not permitted' in err: 238 | print('Cannot attach a process without perm.') 239 | if self.env.get('ubuntu'): 240 | print('You may need root perm to use ptrace in Ubuntu.') 241 | exit(1) 242 | return True 243 | 244 | def _bsd_run(self, codes): 245 | """gdb under bsd can only run command in a file""" 246 | 247 | (fd, gdb_file_name) = tempfile.mkstemp() 248 | with os.fdopen(fd, 'w') as f: 249 | f.write('\n'.join(codes) + '\nquit') 250 | 251 | command = "%s --command=%s --pid=%s --exec=python" % ( 252 | self.gdb, gdb_file_name, self.pid) 253 | 254 | p = self._popen(command) 255 | # sleep 0.5 seconds to avoid removing gdb_file too fast 256 | time.sleep(0.5) 257 | os.remove(gdb_file_name) 258 | return p 259 | 260 | def _run(self, codes): 261 | """gdb under linux""" 262 | 263 | batch_commands = ' '.join( 264 | ["-eval-command='%s'" % code for code in codes] 265 | ) 266 | command = '%s -p %d -batch %s' % (self.gdb, self.pid, batch_commands) 267 | 268 | return self._popen(command) 269 | 270 | run = _run 271 | 272 | def _popen(self, command): 273 | """shell popen with pipe std""" 274 | return subprocess.Popen( 275 | command, 276 | shell=True, 277 | stdout=subprocess.PIPE, 278 | stderr=subprocess.PIPE 279 | ) 280 | 281 | 282 | @PylaneExceptionHandler 283 | def inject(*args, **kwargs): 284 | return Injector(*args, **kwargs).inject() 285 | -------------------------------------------------------------------------------- /pylane/entry.py: -------------------------------------------------------------------------------- 1 | # -*- coding: utf-8 -*- 2 | 3 | """ 4 | Entry of Pylane 5 | """ 6 | 7 | import click 8 | from pylane.core.injector import inject as _inject 9 | from pylane.shell.shell import shell as _shell 10 | 11 | 12 | @click.command() 13 | @click.argument('pid', type=int) 14 | @click.argument('file_path', type=click.Path(exists=True, readable=True)) 15 | @click.pass_context 16 | def inject(ctx, pid, file_path): 17 | """Inject a python process, run some code inside the vm.""" 18 | _inject(pid=pid, file_path=file_path, **ctx.obj) 19 | 20 | 21 | @click.command() 22 | @click.argument('pid', type=int) 23 | @click.pass_context 24 | def shell(ctx, pid): 25 | """Create a remote python shell on a process.""" 26 | _shell(pid=pid, **ctx.obj) 27 | 28 | 29 | @click.group() 30 | @click.option('-g', '--gdb_path', type=click.Path(exists=True), default='/usr/bin/gdb') 31 | @click.option('-v', '--verbose', count=True) 32 | @click.option('-t', '--timeout', type=int, default=10) 33 | @click.option('-e', '--encoding', type=str, default='utf-8') 34 | @click.pass_context 35 | def main_entry(ctx, **kwargs): 36 | ctx.obj = kwargs 37 | 38 | 39 | main_entry.add_command(inject) 40 | main_entry.add_command(shell) 41 | 42 | 43 | def main(): 44 | main_entry() 45 | 46 | 47 | if __name__ == '__main__': 48 | main() 49 | -------------------------------------------------------------------------------- /pylane/shell/__init__.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/NtesEyes/pylane/d5e9b9c613fb7c550e062f271824e36033d6a28b/pylane/shell/__init__.py -------------------------------------------------------------------------------- /pylane/shell/help_functions.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python 2 | # encoding: utf-8 3 | 4 | ''' 5 | All functions here must be written with function doc. 6 | And all exceptions must be handled in this module.... 7 | Don't Import Any Unnecessary things. 8 | Use remote ipc to inject, don't import them in remote process in case of reload. 9 | ''' 10 | 11 | from __future__ import print_function 12 | 13 | 14 | def get_insts(class_name): 15 | """get_insts(class_name) -> instance_list""" 16 | ins_list = [] 17 | import gc 18 | for obj in gc.get_objects(): 19 | try: 20 | if getattr(obj, "__class__", None): 21 | if obj.__class__.__name__ == class_name: 22 | ins_list.append(obj) 23 | # weak ref items will raise an exc here 24 | except ReferenceError: 25 | continue 26 | return ins_list 27 | 28 | 29 | def get_classes(class_name): 30 | """get_classes(class_name) -> class_object_list : cast new type class only""" 31 | cls_list = [] 32 | import gc 33 | import inspect 34 | for obj in gc.get_objects(): 35 | try: 36 | if getattr(obj, "__class__", None): 37 | if inspect.isclass(obj) and obj.__name__ == class_name: 38 | cls_list.append(obj) 39 | # weak ref items will raise an exc here 40 | except ReferenceError: 41 | continue 42 | return cls_list 43 | 44 | 45 | def cast_id(object_id): 46 | """cast_id(object_id) -> object""" 47 | if not getattr(cast_id, 'ensured', False): 48 | print("""Warning: If you provide an invalid or expired id, this call will cause a segment fault, 49 | the attached process will be killed. 50 | cast_id will do nothing this time. If you know whats going on, recall this function to execute.""") 51 | setattr(cast_id, 'ensured', True) 52 | return 53 | import ctypes 54 | return ctypes.cast(object_id, ctypes.py_object).value 55 | 56 | 57 | def get_source_code(obj): 58 | """get_source_code(obj) -> source_code_string : print it for pretty format""" 59 | import inspect 60 | try: 61 | return ''.join(inspect.getsourcelines(obj)[0]) 62 | except Exception as e: 63 | print('failed, error:', e) 64 | 65 | 66 | def print_source_code(obj): 67 | """print_source_code(obj) -> None : print source code.""" 68 | print(get_source_code(obj)) 69 | 70 | 71 | def inspect_threads(thread_names=[]): 72 | """inspect_threads() -> {thread_name: {"locals": {}, "stack": ""}} : return threads' locals and stack""" 73 | import threading 74 | import sys 75 | import traceback 76 | pylane_thread_name = "pylane-shell-thread" 77 | stacks = {} 78 | frames = sys._current_frames() 79 | threads = threading.enumerate() 80 | for thread in threads: 81 | if thread.name == pylane_thread_name: 82 | continue 83 | if thread_names and thread.name not in thread_names: 84 | continue 85 | frame = frames.get(thread.ident) 86 | stack = ''.join(traceback.format_stack(frame)) if frame else '' 87 | stacks[thread.name] = { 88 | "locals": frame.f_locals, 89 | "stack": stack 90 | } 91 | return stacks 92 | 93 | 94 | def print_threads(thread_names=[]): 95 | """print_threads() -> None : print threads' stack and locals""" 96 | stacks = inspect_threads(thread_names) 97 | for name, thread_info in stacks.items(): 98 | print("\nThread:", name) 99 | print("Stack:\n", thread_info['stack']) 100 | print("Locals:\n", thread_info['locals']) 101 | 102 | 103 | def log_it(func): 104 | """log_it(func) -> decoratored_func : a decorator to print func input and output in log""" 105 | import logging 106 | import time 107 | 108 | def wrapper(*args, **kwargs): 109 | start = time.time() 110 | ret = func(*args, **kwargs) 111 | duration = time.time() - start 112 | logging.warning("func: %s sec_cost: %s input: %s output %s" % ( 113 | func.__name__, round(duration, 4), repr((args, kwargs)), repr(ret) 114 | )) 115 | return ret 116 | return wrapper 117 | -------------------------------------------------------------------------------- /pylane/shell/inject.py: -------------------------------------------------------------------------------- 1 | # -*- coding: utf-8 -*- 2 | 3 | import os 4 | from pylane.core.injector import inject as _inject 5 | 6 | 7 | def inject(module, entrance, host, port, inject_args): 8 | """ 9 | inject process with module.entrance 10 | """ 11 | encoding = inject_args.get('encoding', 'utf-8') 12 | code = create_payload(module, entrance, host, port, encoding) 13 | inject_args['code'] = code 14 | success = _inject(**inject_args) 15 | if not success: 16 | exit(1) 17 | 18 | 19 | def create_payload(module, entrance, host, port, encoding): 20 | """ 21 | generate inject payload code for an exist file 22 | """ 23 | base_path = os.path.dirname(os.path.abspath(__file__)) 24 | file_path = base_path + '/%s.py' % module 25 | 26 | payload = "def start_remote_shell():\n" 27 | with open(file_path) as f: 28 | for line in f.readlines(): 29 | if line.startswith('#'): 30 | continue 31 | payload += ' ' + line 32 | payload += "\n {entrance}(host='{host}', port={port}, encoding='{encoding}').start()\n".format( 33 | entrance=entrance, 34 | host=host, 35 | port=port, 36 | encoding=encoding 37 | ) 38 | payload += '\nstart_remote_shell()' 39 | return payload 40 | -------------------------------------------------------------------------------- /pylane/shell/ipython_embed.py: -------------------------------------------------------------------------------- 1 | # -*- coding: utf-8 -*- 2 | 3 | import json 4 | from IPython.terminal.embed import InteractiveShellEmbed 5 | from IPython.core.interactiveshell import ExecutionResult 6 | 7 | 8 | class IPythonShell(InteractiveShellEmbed): 9 | """use an ipython interface to provide shell""" 10 | 11 | ENCODING = 'utf-8' 12 | 13 | def __init__(self, encoding='utf-8'): 14 | InteractiveShellEmbed.__init__(self) 15 | self.set_custom_completer(self.remote_completer, pos=0) 16 | self.encoding = encoding or self.ENCODING 17 | 18 | def ipython_pre_works(self, result, raw_cell, store_history, 19 | silent=False, shell_futures=True, 20 | ): 21 | if silent: 22 | store_history = False 23 | 24 | if store_history: 25 | result.execution_count = self.execution_count 26 | 27 | def error_before_exec(value): 28 | result.error_before_exec = value 29 | return result 30 | 31 | self.events.trigger('pre_execute') 32 | if not silent: 33 | self.events.trigger('pre_run_cell') 34 | 35 | preprocessing_exc_tuple = None 36 | cell = raw_cell 37 | 38 | if store_history: 39 | self.history_manager.store_inputs(self.execution_count, 40 | cell, raw_cell) 41 | if not silent: 42 | self.logger.log(cell, raw_cell) 43 | 44 | if preprocessing_exc_tuple is not None: 45 | self.showtraceback(preprocessing_exc_tuple) 46 | if store_history: 47 | self.execution_count += 1 48 | return error_before_exec(preprocessing_exc_tuple[2]) 49 | 50 | return cell 51 | 52 | def ipython_post_works(self, result, store_history): 53 | if store_history: 54 | self.history_manager.store_output(self.execution_count) 55 | self.execution_count += 1 56 | result.execution_count = self.execution_count 57 | 58 | def redirect_to_ipython(self, raw_cell): 59 | """ 60 | to be finished 61 | """ 62 | if raw_cell == '?\n': 63 | return True 64 | if raw_cell.startswith('%'): 65 | return True 66 | 67 | return False 68 | 69 | def run_cell(self, raw_cell, store_history=True, 70 | silent=False, shell_futures=True 71 | ): 72 | """ 73 | run ipython code in ipython run_cell, 74 | run python console code in remoute console 75 | """ 76 | if self.redirect_to_ipython(raw_cell): 77 | return InteractiveShellEmbed.run_cell( 78 | self, raw_cell, store_history, silent, shell_futures 79 | ) 80 | 81 | result = ExecutionResult(None) 82 | self.displayhook.exec_result = result 83 | 84 | if (not raw_cell) or raw_cell.isspace(): 85 | return result 86 | 87 | cell = self.ipython_pre_works( 88 | result, raw_cell, store_history, silent, shell_futures 89 | ) 90 | 91 | output = self._runsource(cell) 92 | if output: 93 | result.result = output 94 | self._output(output) 95 | # self.write(output) 96 | self.ipython_post_works(result, store_history) 97 | 98 | return result 99 | 100 | def _output(self, output): 101 | """ 102 | try to display evaled object 103 | if failed, write raw string 104 | """ 105 | try: 106 | output = eval(output) 107 | try: 108 | output = output.decode(self.encoding) 109 | except: 110 | pass 111 | self.displayhook(output) 112 | return 113 | except: 114 | pass 115 | if not output.endswith('\n\n'): 116 | output += '\n' 117 | self.displayhook.start_displayhook() 118 | self.displayhook.write_output_prompt() 119 | self.write('\n' + output) 120 | self.displayhook.finish_displayhook() 121 | 122 | def runsource(self, source): 123 | self.write(self._runsource(source)) 124 | 125 | def _runsource(self, source, *args, **kwargs): 126 | self.sock.send(source) 127 | raw = self.sock.recv() 128 | if raw == '' or raw is None: 129 | exit(0) 130 | flag, op = raw[0], raw[1:] 131 | # TODO old interface which is not used, going to be deprecated. 132 | flag == '0' 133 | return op 134 | 135 | def remote_completer(self, ipcompleter, text, line=None, cursor_pos=None): 136 | source = 'complete$%s' % text 137 | op = self._runsource(source) 138 | try: 139 | # ignore those cases like obj not exists 140 | return json.loads(op) 141 | except: 142 | return [] 143 | -------------------------------------------------------------------------------- /pylane/shell/proxy.py: -------------------------------------------------------------------------------- 1 | # -*- coding: utf-8 -*- 2 | 3 | 4 | import time 5 | from threading import Thread 6 | from .sock import SockServer 7 | from .inject import inject 8 | from .ipython_embed import IPythonShell 9 | 10 | 11 | class AsyncServer(object): 12 | """ 13 | """ 14 | LISTEN_TIMEOUT = 30 15 | 16 | def start_server(self, encoding, timeout): 17 | """start sock server and wait for client""" 18 | self.sock_server = SockServer( 19 | listen_timeout=self.LISTEN_TIMEOUT, 20 | transport_timeout=timeout or 0, 21 | encoding=encoding) 22 | self.sock_server.listen() 23 | self.async_accept() 24 | return (self.sock_server.host, self.sock_server.port) 25 | 26 | def async_accept(self): 27 | """start a thread to wait for sock server accept""" 28 | thread = Thread( 29 | target=self.sock_server.accept, name="sock_server_async_accept") 30 | thread.daemon = True 31 | self.async_accept_thread = thread 32 | thread.start() 33 | 34 | def wait(self): 35 | """wait for remote client to connet""" 36 | while self.async_accept_thread and self.async_accept_thread.is_alive(): 37 | time.sleep(0.1) 38 | if not self.sock_server.connected(): 39 | raise NoConnectedClient( 40 | "No client connected in %s seconds" % self.LISTEN_TIMEOUT 41 | ) 42 | self.sock = self.sock_server 43 | 44 | 45 | class NoConnectedClient(Exception): 46 | pass 47 | 48 | 49 | class SimpleRemoteProxy(object): 50 | MODULE = 'remote_shell' 51 | ENTRANCE = 'RemoteShellThread' 52 | 53 | 54 | class BaseProxy(AsyncServer, SimpleRemoteProxy): 55 | """""" 56 | 57 | def __init__(self, inject_args): 58 | """""" 59 | self.inject_args = inject_args 60 | 61 | def run(self): 62 | """""" 63 | host, port = self.start_server( 64 | encoding=self.inject_args.get('encoding'), 65 | timeout=self.inject_args.get('timeout') 66 | ) 67 | inject( 68 | module=self.MODULE, 69 | entrance=self.ENTRANCE, 70 | host=host, 71 | port=port, 72 | inject_args=self.inject_args) 73 | self.wait() 74 | 75 | 76 | class IPythonShellProxy(BaseProxy, IPythonShell): 77 | """""" 78 | 79 | def __init__(self, inject_args): 80 | BaseProxy.__init__(self, inject_args) 81 | IPythonShell.__init__(self, inject_args.get('encode')) 82 | -------------------------------------------------------------------------------- /pylane/shell/remote_shell.py: -------------------------------------------------------------------------------- 1 | # -*- coding: utf-8 -*- 2 | 3 | import sys 4 | import traceback 5 | import threading 6 | import code 7 | import json 8 | 9 | from pylane.shell.sock import SockClient 10 | 11 | if sys.version_info[0] == 3: 12 | from io import StringIO 13 | else: 14 | from io import BytesIO as StringIO 15 | 16 | 17 | class OutputHookContext(object): 18 | """ 19 | Hook sys std with string io 20 | """ 21 | 22 | def __enter__(self): 23 | self.sys_stdout = sys.stdout 24 | sys.stdout = self.stdout = StringIO() 25 | 26 | self.sys_stderr = sys.stderr 27 | sys.stderr = self.stderr = StringIO() 28 | 29 | def __exit__(self, *args, **kwargs): 30 | sys.stdout = self.sys_stdout 31 | sys.stderr = self.sys_stderr 32 | 33 | def truncate(self): 34 | for io in (sys.stdout, sys.stderr): 35 | io.seek(0) 36 | io.truncate() 37 | 38 | def getvalue(self): 39 | return (self.stdout.getvalue(), self.stderr.getvalue()) 40 | 41 | def getvalue_truncate(self): 42 | value = (self.stdout.getvalue(), self.stderr.getvalue()) 43 | self.truncate() 44 | return value 45 | 46 | 47 | class RemoteShellThread(threading.Thread): 48 | """ 49 | Start a thread in target process, run an interpreter 50 | """ 51 | 52 | host = 'localhost' 53 | port = 9594 54 | debug = False 55 | 56 | def __init__(self, host=None, port=None, encoding='utf-8'): 57 | """ 58 | """ 59 | if host: 60 | self.host = host 61 | if port: 62 | self.port = port 63 | 64 | self.encoding = encoding 65 | self.lock = threading.RLock() 66 | self.stdio_hook = OutputHookContext() 67 | 68 | import __main__ as main 69 | self.user_defined_executor = getattr( 70 | main, '_user_defined_executor', None) 71 | self.in_user_defined_executor = False 72 | self.user_defined_executor_local = {} 73 | 74 | self._interpreter = code.InteractiveInterpreter(locals=locals()) 75 | self.runsource('import sys') 76 | self.runsource('import __main__ as main') 77 | 78 | self.sock = SockClient(self.host, self.port, encoding) 79 | super(RemoteShellThread, self).__init__() 80 | 81 | def handle(self): 82 | """ 83 | handle io 84 | """ 85 | while True: 86 | cmd = self.sock.recv() 87 | # recv of sock closed returns '' in py2 and None in py3 88 | if cmd == '' or cmd is None: 89 | break 90 | flag = '0' 91 | self.sock.send(flag + self.runsource(cmd)) 92 | 93 | def runsource(self, source, filename="", symbol="single"): 94 | """ 95 | run code in interpreter 96 | """ 97 | with self.lock: 98 | source_strip = source.strip() 99 | if source_strip == '$enter_executor': 100 | if self.user_defined_executor: 101 | self.in_user_defined_executor = True 102 | return 'True' 103 | else: 104 | return 'False, _user_defined_executor not found' 105 | if source_strip == '$exit_executor': 106 | self.in_user_defined_executor = False 107 | return 'True' 108 | 109 | if self.in_user_defined_executor and self.user_defined_executor: 110 | with self.stdio_hook: 111 | return repr(self.user_defined_executor( 112 | source_strip, 113 | self.user_defined_executor_local 114 | )) 115 | 116 | extend_function = self.get_extend_function(source_strip) 117 | if extend_function: 118 | with self.stdio_hook: 119 | try: 120 | return extend_function(self, source_strip) 121 | except Exception as e: 122 | print("Failed to run source", source, "err:", e) 123 | 124 | with self.stdio_hook: 125 | state, op = self._runsource(source) 126 | if not state: 127 | print("Failed to run source", source) 128 | return op 129 | 130 | def get_output(self): 131 | """ 132 | """ 133 | out, err = self.stdio_hook.getvalue_truncate() 134 | try: 135 | out = out.decode(self.encoding) 136 | err = err.decode(self.encoding) 137 | except: 138 | # TODO 139 | pass 140 | return out, err 141 | 142 | def _runsource(self, source): 143 | # add \n in case of incomplete section code. 144 | ret = self._interpreter.runsource( 145 | source + "\n", filename="", symbol="single") 146 | out, err = self.get_output() 147 | if ret is True: 148 | err += "error: cmd not completed." 149 | if err: 150 | ret = False, err 151 | else: 152 | ret = True, out 153 | if self.debug: 154 | open('/tmp/pmx-shell-log', 'w').write("%s\n%s" % ( 155 | source, ret)) 156 | return ret 157 | 158 | def run_help_doc(self, source): 159 | """ 160 | support object? 161 | TODO more info when object?? 162 | """ 163 | item = source.replace('??', '').replace('?', '') 164 | state, doc = self._runsource('%s.__doc__' % item) 165 | if not state: 166 | return doc 167 | state, type_ = self._runsource('type(%s).__name__' % item) 168 | state, type_ = self._runsource('type(%s).__name__' % item) 169 | if not state: 170 | return type_ 171 | op = "Type: %sDocstring: %s" % (type_, doc) 172 | return op 173 | 174 | def complete(self, source): 175 | """ 176 | """ 177 | text = source.split('$', 2)[1] 178 | suggs = [] 179 | # for obj.\t 180 | if text.endswith('.'): 181 | item = text[:-1] 182 | state, op = self._runsource('dir(%s)' % item) 183 | if not state: 184 | return op 185 | dir_list = eval(op) 186 | suggs = [item + '.' + t for t in dir_list] 187 | # for obj.prefix\t 188 | elif '.' in text: 189 | item, sub_text = text.rsplit('.', 1) 190 | state, op = self._runsource('dir(%s)' % item) 191 | if not state: 192 | return op 193 | dir_list = eval(op) 194 | for t in dir_list: 195 | if t.startswith(sub_text): 196 | suggs.append(item + '.' + t) 197 | # for prefix\t 198 | else: 199 | state, op = self._runsource('dir()') 200 | if not state: 201 | return op 202 | dir_list = eval(op) 203 | for t in dir_list: 204 | if t.startswith(text): 205 | suggs.append(t) 206 | 207 | return json.dumps(suggs) 208 | 209 | def user_defined_function(self, source): 210 | import __main__ as main 211 | handler = getattr(main, '_user_defined_handler', None)\ 212 | or getattr(main, '_telnet_handler', None) 213 | if not handler: 214 | return 'User defined handler not found' 215 | source = "main.%s('%s')" % (handler.__name__, source.replace('\n', '')) 216 | state, op = self._runsource(source) 217 | if not isinstance(op, str): 218 | op = repr(op) 219 | return op 220 | 221 | def get_extend_function(self, source): 222 | """ 223 | """ 224 | if source.endswith('?'): 225 | return self.extend_functions['help_doc'] 226 | if source.startswith('$'): 227 | return self.extend_functions['udf'] 228 | return self.extend_functions.get( 229 | source.split('$')[0] 230 | ) 231 | 232 | extend_functions = { 233 | 'help_doc': run_help_doc, 234 | 'udf': user_defined_function, 235 | 'complete': complete 236 | } 237 | 238 | def run(self): 239 | """ 240 | main run entrance 241 | """ 242 | self.name = "pylane-shell-thread" 243 | try: 244 | self.sock.connect() 245 | self.handle() 246 | except SystemExit: 247 | pass 248 | except: 249 | traceback.print_exc(file=sys.__stderr__) 250 | finally: 251 | if self.sock: 252 | self.sock.close() 253 | -------------------------------------------------------------------------------- /pylane/shell/shell.py: -------------------------------------------------------------------------------- 1 | # -*- coding: utf-8 -*- 2 | 3 | """ 4 | """ 5 | 6 | from .proxy import IPythonShellProxy as ShellProxy 7 | 8 | 9 | class Shell(object): 10 | """Shell server""" 11 | 12 | # pre_codes defined to run before shell is available 13 | pre_codes = [ 14 | """ 15 | print('Command: %s %s %s' % ( 16 | sys.executable, 17 | getattr(main, '__file__', '__main__'), 18 | ' '.join([ 19 | '"%s"' % ( 20 | arg.replace('\\\\', '\\\\\\\\').replace('"', '\\\\"'), 21 | ) 22 | for arg in sys.argv[1:] 23 | ]), 24 | )) 25 | """, 26 | "import pylane.shell.help_functions as tools", 27 | # "from imp import reload", 28 | # "tools = reload(tools)", 29 | ] 30 | 31 | # extend help infos followed by ipython help info 32 | extend_help = """Welcome to pylane shell. Features below are avaliable: 33 | Use TAB to get remote auto completion. 34 | Use 'main' to access remote process's __main__ object. 35 | Use 'tools' to get pylane toolkit functions. 36 | Example: tools.get_insts(YOUR_CLASS_NAME). 37 | Use 'a_object?' for more usage info. 38 | """ 39 | udf_help = """ 40 | User Defined Executor: 41 | Put a _user_defined_executor(input, local) function in __main__ global, 42 | then use $enter_executor to enter, $exit_executor to exit. 43 | When in executor, all input will be handled by executor. 44 | Arg local is an empty dict. 45 | User Defined Functions: 46 | Put a _user_defined_handler($cmd) function in __main__ global, 47 | then use $cmd to call them. 48 | """ 49 | 50 | def __init__(self, 51 | **inject_args): 52 | """Init injector by args. 53 | Args: 54 | encoding (str): encoding used when shell transporting 55 | 56 | Returns: 57 | """ 58 | self.inject_args = inject_args 59 | self.encoding = inject_args.get('encoding') 60 | 61 | def run(self): 62 | """run shell server and connect""" 63 | shell_proxy = ShellProxy(self.inject_args) 64 | shell_proxy.run() 65 | shell_proxy.runsource("print('''%s''')" % self.extend_help) 66 | for pre_code in self.pre_codes: 67 | code = self.raw_code(pre_code) 68 | shell_proxy.runsource(code) 69 | shell_proxy.interact() 70 | 71 | def raw_code(self, code): 72 | """parse code in docstring""" 73 | lines = code.split('\n') 74 | for start_line in lines: 75 | if start_line: 76 | break 77 | blanks = len(start_line) - len(start_line.lstrip()) 78 | code = '\n'.join([ 79 | line[blanks:] 80 | for line in lines 81 | ]) 82 | if not code.endswith('\n'): 83 | code += '\n' 84 | return code 85 | 86 | 87 | def shell(*args, **kwargs): 88 | return Shell(*args, **kwargs).run() 89 | -------------------------------------------------------------------------------- /pylane/shell/sock.py: -------------------------------------------------------------------------------- 1 | # -*- coding: utf-8 -*- 2 | 3 | 4 | import socket 5 | import struct 6 | import traceback 7 | import random 8 | import time 9 | 10 | 11 | class Transport(object): 12 | """ 13 | """ 14 | 15 | sock = None 16 | encoding = 'utf-8' 17 | 18 | def send(self, data): 19 | """ 20 | send data with length in 4 bytes header 21 | """ 22 | data = data.encode(self.encoding) 23 | header = struct.pack('=7.2,<8.0;python_version>="3.4"', 39 | "Click==7.0", 40 | ], 41 | keywords=['debug', 'attach', 'gdb', 'shell'] 42 | ) 43 | --------------------------------------------------------------------------------