├── .gitattributes ├── .gitignore ├── LICENSE ├── MANIFEST.in ├── README.md ├── README.rst ├── pystata-kernel ├── __init__.py ├── __main__.py ├── config.py ├── css │ └── _StataKernelHelpDefault.css ├── helpers.py ├── install.py ├── kernel.py ├── logo-64x64.png ├── magics.py └── utils.py ├── setup.py └── tests └── helpers.py /.gitattributes: -------------------------------------------------------------------------------- 1 | # Auto detect text files and perform LF normalization 2 | * text=auto 3 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | __pycache__/ 2 | *.pyc 3 | /dist/ 4 | /build/ 5 | /MANIFEST 6 | /pystata_kernel.egg-info 7 | /pystata-kernel-* -------------------------------------------------------------------------------- /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 | . -------------------------------------------------------------------------------- /MANIFEST.in: -------------------------------------------------------------------------------- 1 | include README.md 2 | include pystata-kernel/logo-64x64.png 3 | include pystata-kernel/css/* -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # pystata-kernel 2 | 3 | A simple Jupyter kernel for Stata based on [pystata](https://www.stata.com/python/pystata/). 4 | Requires Stata 17 or above. 5 | Consider [stata_kernel](https://github.com/kylebarron/stata_kernel) instead if you have an 6 | older version of Stata. 7 | 8 | **Note: Starting with version 0.3.0, `pystata-kernel` will be updated once every six months. 9 | If new features and timely updates are important to you, 10 | please consider using [`nbstata`](https://github.com/hugetim/nbstata), 11 | which is further along in development.** 12 | 13 | ### Installation 14 | To install `pystata-kernel`: 15 | 16 | ```python 17 | pip install pystata-kernel 18 | python -m pystata-kernel.install [--sys-prefix] [--prefix] [--conf-file] 19 | ``` 20 | 21 | Include `--sys-prefix` if you are installing `pystata-kernel` in a multi-user environment, 22 | or `--prefix` if you want to specify a path yourself. 23 | 24 | The kernel will try to determine the location of your Stata installation at startup. 25 | You can create a configuration file to preempt this detection with the `--conf-file` option. 26 | Even if you do not include this option, the configuration file will still be created if the 27 | installer cannot find any Stata installation. 28 | 29 | The location of the configuration file is: 30 | 31 | - `[prefix]/etc/pystata-kernel.conf` if `--sys-prefix` is specified. 32 | - `~/.pystata-kernel.conf` otherwise. 33 | 34 | If a configuration file exists in both locations, the user version takes precedent. 35 | 36 | Syntax highlighting is the same as `stata_kernel`: 37 | 38 | ```sh 39 | conda install nodejs -c conda-forge --repodata-fn=repodata.json 40 | jupyter labextension install jupyterlab-stata-highlight 41 | ``` 42 | 43 | ### Configuration 44 | 45 | The following settings are permitted inside the configuration file: 46 | 47 | - `stata_dir`: Stata installation directory. 48 | - `edition`: Stata edition. Acceptable values are 'be', 'se' and 'mp'. 49 | Default is 'be'. 50 | - `graph_format`: Graph format. Acceptable values are 'png', 'pdf', 'svg' and 'pystata'. 51 | Specify the last option if you want to use `pystata`'s setting. Default is 'png'. 52 | - `echo`: controls the echo of commands: 53 | - 'True': the kernel will echo all commands. 54 | - 'False': the kernel will not echo single commands. 55 | - 'None': the kernel will not echo any command. 56 | 57 | Default is 'False'. 58 | - `splash`: controls display of the splash message during Stata startup. Default is 'True'. 59 | - `missing`: What should be displayed in the output of the `*%browse` magic for a missing value. Default is '.', following Stata. To defer to pandas' format for `NA`, specify 'pandas'. 60 | 61 | Settings must be under the title `[pystata-kernel]`. Example: 62 | 63 | ``` 64 | [pystata-kernel] 65 | stata_dir = /opt/stata 66 | edition = mp 67 | graph_format = svg 68 | echo = True 69 | splash = False 70 | ``` 71 | 72 | ### Default Graph Format 73 | 74 | Both `pystata` and `stata_kernel` default to the SVG image format. 75 | `pystata-kernel` defaults to the PNG image format instead for several reasons: 76 | 77 | - Jupyter does not show SVG images from untrusted notebooks ([link 1](https://stackoverflow.com/questions/68398033/svg-figures-hidden-in-jupyterlab-after-some-time)). 78 | - Notebooks with empty cells are untrusted ([link 2](https://github.com/jupyterlab/jupyterlab/issues/9765)). 79 | - SVG images cannot be copied and pasted directly into Word or PowerPoint. 80 | 81 | These issues make the SVG format unsuitable for use in a pedagogical setting, 82 | which is my primary use of a Jupyter kernel for Stata. 83 | 84 | ### Magics 85 | 86 | Magics are commands that only work in `pystata-kernel` and are not part of 87 | Stata's syntax. 88 | Magics normally start with `%`, but this will cause errors when the notebook 89 | is exported and run as a Stata script. As an alternative, you can prefix the 90 | magic name with `*%`, which will simply be treated by Stata as a single-line comment. 91 | 92 | `pystata-kernel` currently supports the following magics: 93 | 94 | | Magic | Description | Full Syntax | 95 | | :-- | :-- | :-- | 96 | | `*%browse` | View dataset | `*%browse [-h] [N] [varlist] [if] [in]` | 97 | | `*%help` | Display a help file in rich text| `*%help [-h] command_or_topic_name` | 98 | | `*%noecho` | Suppress echo in current cell | `*%noecho` | 99 | | `*%quietly` | Suppress all output from current cell | `*%quietly` | 100 | -------------------------------------------------------------------------------- /README.rst: -------------------------------------------------------------------------------- 1 | ============== 2 | pystata-kernel 3 | ============== 4 | 5 | A simple Jupyter kernel for Stata based on *pystata* (https://www.stata.com/python/pystata/). Requires Stata 17 or above. 6 | Consider *stata_kernel* (https://github.com/kylebarron/stata_kernel) instead if you have an older version of Stata. 7 | 8 | Installation 9 | ------------ 10 | 11 | See https://github.com/ticoneva/pystata-kernel for instructions. 12 | -------------------------------------------------------------------------------- /pystata-kernel/__init__.py: -------------------------------------------------------------------------------- 1 | __version__ = '0.3.2' 2 | 3 | from .kernel import PyStataKernel 4 | -------------------------------------------------------------------------------- /pystata-kernel/__main__.py: -------------------------------------------------------------------------------- 1 | from ipykernel.kernelapp import IPKernelApp 2 | from . import PyStataKernel 3 | 4 | IPKernelApp.launch_instance(kernel_class=PyStataKernel) 5 | -------------------------------------------------------------------------------- /pystata-kernel/config.py: -------------------------------------------------------------------------------- 1 | import os 2 | import sys 3 | from pathlib import Path 4 | from configparser import ConfigParser, NoSectionError 5 | from .utils import find_dir_edition 6 | 7 | def get_config(): 8 | """ 9 | Version 1.10: 10 | First check if a configuration file exists, if not, query the system. 11 | """ 12 | global_config_path = Path(os.path.join(sys.prefix,'etc','pystata-kernel.conf')) 13 | user_config_path = Path('~/.pystata-kernel.conf').expanduser() 14 | 15 | env = {'stata_dir': None, 16 | 'edition': None, 17 | 'graph_format': 'png', 18 | 'echo': 'False', 19 | 'splash': 'True', 20 | 'missing': '.' 21 | } 22 | 23 | for cpath in (global_config_path,user_config_path): 24 | try: 25 | if cpath.is_file(): 26 | config = ConfigParser() 27 | config.read(str(cpath)) 28 | env.update(dict(config.items('pystata-kernel'))) 29 | except: 30 | pass 31 | 32 | if env['stata_dir']==None or env['edition']==None: 33 | stata_dir,stata_ed = find_dir_edition() 34 | default_env = {'stata_dir': stata_dir, 'edition': stata_ed} 35 | env.update(default_env) 36 | return env -------------------------------------------------------------------------------- /pystata-kernel/css/_StataKernelHelpDefault.css: -------------------------------------------------------------------------------- 1 | h2 { 2 | font-family: Arial,Helvetica,Helv,sans-serif; 3 | color: #000000; 4 | } 5 | 6 | pre { 7 | margin: 10px; 8 | } 9 | 10 | table { 11 | background-color: transparent; 12 | border-color: transparent; 13 | bgcolor: transparent; 14 | } 15 | 16 | tr { 17 | background-color: transparent; 18 | border-color: transparent; 19 | bgcolor: transparent; 20 | } 21 | 22 | body { 23 | background-color: transparent; 24 | border-color: transparent; 25 | margin: 0px; 26 | } 27 | 28 | div { 29 | background-color: transparent; 30 | border-color: transparent; 31 | } 32 | -------------------------------------------------------------------------------- /pystata-kernel/helpers.py: -------------------------------------------------------------------------------- 1 | # Helper functions that requires Stata running or works on Stata code 2 | # but does not depend on the Jupyter kernel. 3 | 4 | import pandas as pd 5 | import numpy as np 6 | import pystata 7 | import sfi 8 | import re 9 | 10 | def count(): 11 | """ 12 | Count the number of observations 13 | """ 14 | return sfi.Data.getObsTotal() 15 | 16 | def resolve_macro(macro): 17 | macro = macro.strip() 18 | if macro.startswith("`") and macro.endswith("'"): 19 | macro = sfi.Macro.getLocal(macro[1:-1]) 20 | elif macro.startswith("$_"): 21 | macro = sfi.Macro.getLocal(macro[2:]) 22 | elif macro.startswith("$"): 23 | macro = sfi.Macro.getGlobal(macro[1:]) 24 | return macro 25 | 26 | def InVar(code): 27 | """ 28 | Return in-statement range 29 | """ 30 | code = code.replace('in ','').strip() 31 | slash_pos = code.find('/') 32 | if slash_pos == -1: 33 | return (None, None) 34 | start = code[:slash_pos] 35 | end = code[slash_pos+1:] 36 | if start.strip() == 'f': start = 1 37 | if end.strip() == 'l': end = count() 38 | return (int(start)-1, int(end)) 39 | 40 | class SelVar(): 41 | """ 42 | Class for generating selection var in Stata 43 | """ 44 | def __init__(self,condition): 45 | condition = condition.replace('if ','',1).strip() 46 | if condition == '': 47 | self.varname = None 48 | else: 49 | cmd = f"tempvar __selectionVar\ngenerate `__selectionVar' = cond({condition},1,0)" 50 | pystata.stata.run(cmd, quietly=True) 51 | self.varname = sfi.Macro.getLocal("__selectionVar") 52 | 53 | def clear(self): 54 | if self.varname != None: 55 | pystata.stata.run(f"capture drop {self.varname}", quietly=True) 56 | 57 | # Regex for parse_code_if_in 58 | code_regex = re.compile( 59 | r'\A(?P(?!if\s)(?!\sif)(?!in\s)(?!\sin).+?)?(?P\s*if\s+.+?)?(?P\s*in\s.+?)?\Z', flags=re.DOTALL + re.MULTILINE) 60 | 61 | def parse_code_if_in(code): 62 | """ 63 | Parse code into code if in 64 | """ 65 | match = code_regex.match(code.strip()) 66 | if match: 67 | args = match.groupdict() 68 | for k in args: 69 | args[k] = args[k] if isinstance(args[k],str) else '' 70 | else: 71 | args = {'code':code, 72 | 'if':'', 73 | 'in':''} 74 | 75 | return args 76 | 77 | ### Regex's for clean_code() ### 78 | # Detect delimiter. This would detect valid delimiters plus macros: 79 | # delimit_regex = re.compile(r'#delimit( |\t)+(;|cr|`.+\'|\$_.+|\$.+)') 80 | # but it's unnecessary, since Stata's #delimit x interprets any x other 81 | # than 'cr' as switching the delimiter to ';'. 82 | delimit_regex = re.compile(r'#delimit(.*$)', flags=re.MULTILINE) 83 | # Detect comments spanning multiple lines 84 | comment_regex = re.compile(r'((\/\/\/)(.)*(\n|\r)|(\/\*)(.|\s)*?(\*\/))') 85 | # Detect left Whitespace 86 | left_regex = re.compile(r'\n +') 87 | # Detect Multiple whitespace 88 | multi_regex = re.compile(r' +') 89 | 90 | def clean_code(code): 91 | """ 92 | Remove comments spanning multiple lines and replace custom delimiters 93 | """ 94 | 95 | def _replace_delimiter(code,delimiter=None): 96 | # Recursively replace custom delimiter with newline 97 | 98 | split = delimit_regex.split(code.strip(),maxsplit=1) 99 | 100 | if len(split) == 3: 101 | before = split[0] 102 | after = _replace_delimiter(split[2],split[1].strip()) 103 | else: 104 | before = code 105 | after = '' 106 | 107 | if delimiter != 'cr' and delimiter != None: 108 | before = before.replace('\r', '').replace('\n', '') 109 | before = before.replace(';','\n') 110 | 111 | return before + after 112 | 113 | # Apply custom delimiter 114 | code = _replace_delimiter(code) 115 | 116 | # Delete comments spanning multiple lines 117 | code = comment_regex.sub(' ',code) 118 | 119 | # Delete whitespace at start of line 120 | code = left_regex.sub('\n',code) 121 | 122 | # Replace multiple whitespace with one 123 | code = multi_regex.sub(' ',code) 124 | 125 | return code 126 | 127 | 128 | def noecho_run(code): 129 | """ 130 | Split code into program and non-program blocks, running each block noecho 131 | """ 132 | 133 | def _startswith_stata_abbrev(string, full_command, shortest_abbrev): 134 | for j in range(len(shortest_abbrev), len(full_command)+1): 135 | if string.startswith(full_command[0:j] + ' '): 136 | return True 137 | return False 138 | 139 | def _remove_prog_prefixes(cs): 140 | if (_startswith_stata_abbrev(cs, 'quietly', 'qui') 141 | or cs.startswith('capture ') 142 | or _startswith_stata_abbrev(cs, 'noisily', 'n')): 143 | return _remove_prog_prefixes(cs.split(None, maxsplit=1)[1]) 144 | else: 145 | return cs 146 | 147 | def _is_start_of_program_block(clean_code_line_stripped): 148 | cs = _remove_prog_prefixes(clean_code_line_stripped) 149 | _starts_program = (_startswith_stata_abbrev(cs, 'program', 'pr') 150 | and not (cs == 'program di' 151 | or cs == 'program dir' 152 | or cs.startswith('program drop ') 153 | or _startswith_stata_abbrev(cs, 'program list', 'program l'))) 154 | return (_starts_program 155 | or (cs in ['mata', 'mata:']) 156 | or (cs in ['python', 'python:'])) 157 | 158 | def _run_as_program(clean_non_prog_code): 159 | _program_name = "temp_pystata_kernel_program_name" 160 | _program_drop_code = f"capture program drop {_program_name}" 161 | _program_define_code = f"program {_program_name}\n{clean_non_prog_code}\nend\n" 162 | pystata.stata.run(_program_drop_code,quietly=True) 163 | pystata.stata.run(_program_define_code, quietly=True) 164 | pystata.stata.run(_program_name, quietly=False, inline=True, echo=False) 165 | pystata.stata.run(f"program drop {_program_name}", quietly=True) 166 | 167 | def _run_lines_noecho(co): 168 | clean_non_prog_code = '\n'.join(co) 169 | if len(co) == 1: # to avoid outputting extra blank lines 170 | pystata.stata.run(clean_non_prog_code, quietly=False, inline=True, echo=False) 171 | else: 172 | _run_as_program(clean_non_prog_code) 173 | 174 | cl = clean_code(code).splitlines() 175 | co = [] 176 | for c in cl: 177 | cs = c.strip() 178 | 179 | # Are we starting a program definition? 180 | if _is_start_of_program_block(cs): 181 | if co: 182 | _run_lines_noecho(co) 183 | co = [] 184 | 185 | co.append(c) 186 | 187 | # Are we ending a program definition? 188 | if cs == 'end': 189 | clean_prog_code = '\n'.join(co) 190 | if co[0] in ['mata', 'mata:']: # b/c 'quietly' blocks all mata output 191 | pystata.stata.run(clean_prog_code, quietly=False, inline=True, echo=False) 192 | else: 193 | pystata.stata.run(clean_prog_code, quietly=True, inline=True, echo=False) 194 | co = [] 195 | 196 | if co: 197 | _run_lines_noecho(co) 198 | 199 | 200 | def better_pdataframe_from_data(var=None, obs=None, selectvar=None, valuelabel=False, missingval=np.NaN): 201 | pystata.config.check_initialized() 202 | 203 | return better_dataframe_from_stata(None, var, obs, selectvar, valuelabel, missingval) 204 | 205 | 206 | def better_pdataframe_from_frame(stfr, var=None, obs=None, selectvar=None, valuelabel=False, missingval=np.NaN): 207 | pystata.config.check_initialized() 208 | 209 | return better_dataframe_from_stata(stfr, var, obs, selectvar, valuelabel, missingval) 210 | 211 | 212 | def better_dataframe_from_stata(stfr, var, obs, selectvar, valuelabel, missingval): 213 | hdl = sfi.Data if stfr is None else sfi.Frame.connect(stfr) 214 | 215 | if hdl.getObsTotal() <= 0: 216 | return None 217 | 218 | pystata.stata.run("""tempvar indexvar 219 | generate `indexvar' = _n""", quietly=True) 220 | idx_var = sfi.Macro.getLocal('indexvar') 221 | 222 | data = hdl.getAsDict(var, obs, selectvar, valuelabel, missingval) 223 | if idx_var in data: 224 | idx = data.pop(idx_var) 225 | else: 226 | idx = hdl.getAsDict(idx_var, obs, selectvar, valuelabel, missingval).pop(idx_var) 227 | 228 | idx = pd.array(idx, dtype='Int64') 229 | 230 | pystata.stata.run("drop `indexvar'") 231 | 232 | return pd.DataFrame(data=data, index=idx).convert_dtypes() 233 | 234 | 235 | -------------------------------------------------------------------------------- /pystata-kernel/install.py: -------------------------------------------------------------------------------- 1 | import argparse 2 | import json 3 | import os 4 | import sys 5 | 6 | from jupyter_client.kernelspec import KernelSpecManager 7 | from IPython.utils.tempdir import TemporaryDirectory 8 | from pkg_resources import resource_filename 9 | from shutil import copyfile 10 | from pathlib import Path 11 | from textwrap import dedent 12 | 13 | 14 | 15 | kernel_json = { 16 | "argv": [sys.executable, "-m", "pystata-kernel", "-f", "{connection_file}"], 17 | "display_name": "Stata", 18 | "language": "stata", 19 | } 20 | 21 | def install_my_kernel_spec(user=True, prefix=None): 22 | with TemporaryDirectory() as td: 23 | os.chmod(td, 0o755) # Starts off as 700, not user readable 24 | with open(os.path.join(td, 'kernel.json'), 'w') as f: 25 | json.dump(kernel_json, f, sort_keys=True) 26 | 27 | # Copy logo to tempdir to be installed with kernelspec 28 | logo_path = resource_filename('pystata-kernel', 'logo-64x64.png') 29 | copyfile(logo_path, os.path.join(td, 'logo-64x64.png')) 30 | 31 | print('Installing Jupyter kernel spec') 32 | KernelSpecManager().install_kernel_spec(td, 'pystata', user=user, prefix=prefix) 33 | 34 | def install_conf(conf_file,gen_file=False): 35 | """ 36 | From stata_kernel, but the conf here is much simplier. 37 | """ 38 | 39 | # By avoiding an import of .utils until we need it, we can 40 | # complete the installation process in virtual environments 41 | # without needing this submodule nor its downstream imports. 42 | from .utils import find_dir_edition 43 | stata_dir,stata_ed = find_dir_edition() 44 | if not stata_dir: 45 | gen_file = True 46 | msg = """\ 47 | WARNING: Could not find Stata path. 48 | Please specify it manually in configuration file. 49 | """ 50 | print(dedent(msg)) 51 | 52 | conf_default = dedent( 53 | """\ 54 | [pystata-kernel] 55 | stata_dir = {} 56 | edition = {} 57 | graph_format = png 58 | echo = False 59 | splash = True 60 | """.format(stata_dir,stata_ed)) 61 | 62 | if gen_file: 63 | print("Creating configuration file at:") 64 | print(str(conf_file)) 65 | try: 66 | with conf_file.open('w') as f: 67 | f.write(conf_default) 68 | print("Success!") 69 | except: 70 | print("Failed!") 71 | 72 | def _is_root(): 73 | try: 74 | return os.geteuid() == 0 75 | except AttributeError: 76 | return False # assume not an admin on non-Unix platforms 77 | 78 | def main(argv=None): 79 | ap = argparse.ArgumentParser() 80 | ap.add_argument('--user', action='store_true', 81 | help="Install to the per-user kernels registry. Default if not root.") 82 | ap.add_argument('--sys-prefix', action='store_true', 83 | help="Install to sys.prefix (e.g. a virtualenv or conda env)") 84 | ap.add_argument('--prefix', 85 | help="Install to the given prefix. " 86 | "Kernelspec will be installed in {PREFIX}/share/jupyter/kernels/") 87 | ap.add_argument( 88 | '--conf-file', action='store_true', 89 | help="Create a configuration file.") 90 | args = ap.parse_args(argv) 91 | 92 | if args.sys_prefix: 93 | args.prefix = sys.prefix 94 | if not args.prefix and not _is_root(): 95 | args.user = True 96 | 97 | install_my_kernel_spec(user=args.user, prefix=args.prefix) 98 | 99 | # Install configuration file to either sys prefix or user home directory 100 | if args.sys_prefix: 101 | conf_dir = os.path.join(args.prefix,'etc') 102 | if not Path(os.path.join(args.prefix,'etc')).is_dir(): 103 | os.mkdir(conf_dir) 104 | conf_file = Path(os.path.join(conf_dir,'pystata-kernel.conf')) 105 | else: 106 | conf_file = Path('~/.pystata-kernel.conf').expanduser() 107 | 108 | if not conf_file.is_file(): 109 | install_conf(conf_file,args.conf_file) 110 | 111 | if __name__ == '__main__': 112 | main() 113 | -------------------------------------------------------------------------------- /pystata-kernel/kernel.py: -------------------------------------------------------------------------------- 1 | ''' 2 | pystata-kernel 3 | Version: 0.3.2 4 | A simple Jupyter kernel based on pystata. 5 | Requires Stata 17 and stata_setup. 6 | ''' 7 | 8 | from ipykernel.ipkernel import IPythonKernel 9 | from .config import get_config 10 | import os 11 | import sys 12 | from packaging import version 13 | 14 | class PyStataKernel(IPythonKernel): 15 | implementation = 'pystata-kernel' 16 | implementation_version = '0.3.2' 17 | language = 'stata' 18 | language_version = '17' 19 | language_info = { 20 | 'name': 'stata', 21 | 'mimetype': 'text/x-stata', 22 | 'codemirror_mode': 'stata', 23 | 'file_extension': '.do', 24 | } 25 | banner = "pystata-kernel: a Jupyter kernel for Stata based on pystata" 26 | 27 | def __init__(self, **kwargs): 28 | super().__init__(**kwargs) 29 | self.stata_ready = False 30 | self.shell.execution_count = 0 31 | self.echo = False 32 | self.noecho = False 33 | self.quietly = False 34 | self.magic_handler = None 35 | self.env = None 36 | 37 | def launch_stata(self, path, edition, splash=True): 38 | """ 39 | We modify stata_setup to make splash screen optional 40 | """ 41 | if not os.path.isdir(path): 42 | raise OSError(path + ' is invalid') 43 | 44 | if not os.path.isdir(os.path.join(path, 'utilities')): 45 | raise OSError(path + " is not Stata's installation path") 46 | 47 | sys.path.append(os.path.join(path, 'utilities')) 48 | import pystata 49 | if version.parse(pystata.__version__) >= version.parse("0.1.1"): 50 | # Splash message control is a new feature of pystata-0.1.1 51 | pystata.config.init(edition,splash=splash) 52 | else: 53 | pystata.config.init(edition) 54 | 55 | def do_execute(self, code, silent, store_history=True, user_expressions=None, 56 | allow_stdin=False): 57 | 58 | # Launch Stata if it has not been launched yet 59 | if not self.stata_ready: 60 | env = self.env = get_config() 61 | self.launch_stata(env['stata_dir'],env['edition'], 62 | False if env['splash']=='False' else True) 63 | 64 | # This can only be imported after locating Stata 65 | import pystata 66 | 67 | if env['echo'] not in ('True','False','None'): 68 | raise OSError("'" + env['echo'] + "' is not an acceptable value for 'echo'.") 69 | 70 | # Set graph format 71 | if env['graph_format'] == 'pystata': 72 | pass 73 | else: 74 | from pystata.config import set_graph_format 75 | set_graph_format(env['graph_format']) 76 | 77 | # Magics 78 | from .magics import StataMagics 79 | self.magic_handler = StataMagics() 80 | 81 | self.stata_ready = True 82 | 83 | # Read settings from env dict every time so that these can be modified by magics 84 | # for each cell. 85 | if self.env['echo'] == 'None': 86 | self.noecho = True 87 | self.echo = False 88 | elif self.env['echo'] == 'True': 89 | self.noecho = False 90 | self.echo = True 91 | else: 92 | self.noecho = False 93 | self.echo = False 94 | self.quietly = False 95 | 96 | try: 97 | # Process magics 98 | code = self.magic_handler.magic(code,self) 99 | 100 | # Execute Stata code after magics 101 | if code != '': 102 | # Supress echo? 103 | if self.noecho and not self.quietly: 104 | from .helpers import noecho_run 105 | noecho_run(code) 106 | else: 107 | from pystata.stata import run 108 | run(code, quietly=self.quietly, inline=True, echo=self.echo) 109 | 110 | 111 | self.shell.execution_count += 1 112 | 113 | return {'status': 'ok', 114 | 'execution_count': self.execution_count, 115 | 'payload': [], 116 | 'user_expressions': {}, 117 | } 118 | 119 | except SystemError as err: 120 | return _handle_stata_error(err, silent, self.execution_count) 121 | 122 | def print_red(text): 123 | print(f"\x1b[31m{text}\x1b[0m") 124 | 125 | def print_stata_error(text): 126 | lines = text.splitlines() 127 | if len(lines) > 2: 128 | print("\n".join(lines[:-2])) 129 | print_red("\n".join(lines[-2:])) 130 | 131 | def _handle_stata_error(err, silent, execution_count): 132 | reply_content = { 133 | "traceback": [], 134 | "ename": "Stata error", 135 | "evalue": str(err), 136 | } 137 | if not silent: 138 | print_stata_error(reply_content['evalue']) 139 | reply_content.update({ 140 | 'status': "error", 141 | 'execution_count': execution_count, 142 | }) 143 | return reply_content -------------------------------------------------------------------------------- /pystata-kernel/logo-64x64.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/ticoneva/pystata-kernel/02c580cd0babf744474b97075e32b5660c8528ad/pystata-kernel/logo-64x64.png -------------------------------------------------------------------------------- /pystata-kernel/magics.py: -------------------------------------------------------------------------------- 1 | import sys 2 | import re 3 | import urllib 4 | import pandas as pd 5 | from textwrap import dedent 6 | from bs4 import BeautifulSoup as bs 7 | from argparse import ArgumentParser, SUPPRESS 8 | from pkg_resources import resource_filename 9 | from .helpers import * 10 | from .config import get_config 11 | 12 | import pystata 13 | import sfi 14 | import random 15 | import numpy as np 16 | 17 | def print_kernel(msg, kernel): 18 | msg = re.sub(r'$', r'\r\n', msg, flags=re.MULTILINE) 19 | msg = re.sub(r'[\r\n]{1,2}[\r\n]{1,2}', r'\r\n', msg, flags=re.MULTILINE) 20 | stream_content = {'text': msg, 'name': 'stdout'} 21 | kernel.send_response(kernel.iopub_socket, 'stream', stream_content) 22 | 23 | class StataMagics(): 24 | html_base = "https://www.stata.com" 25 | html_help = urllib.parse.urljoin(html_base, "help.cgi?{}") 26 | 27 | magic_regex = re.compile( 28 | r'\A(%|\*%)(?P.+?)(?P\s+(.|\s)+?)?\Z', flags=re.DOTALL + re.MULTILINE) 29 | 30 | # This is the original regex that splits into magic code if in 31 | #magic_regex = re.compile( 32 | # r'\A(%|\*%)(?P.+?)(?P\s+(?!if\s)(?!\sif)(?!in\s)(?!\sin).+?)?(?P\s+if\s+.+?)?(?P\s+in\s+.+?)?\Z', flags=re.DOTALL + re.MULTILINE) 33 | 34 | # Format: magic_name: help_content 35 | available_magics = { 36 | 'browse': '{} [-h] [N] [varlist] [if] [in]', 37 | 'help': '{} [-h] command_or_topic_name', 38 | 'quietly': '', 39 | 'noecho': '' 40 | } 41 | 42 | csshelp_default = resource_filename( 43 | 'pystata-kernel', 'css/_StataKernelHelpDefault.css') 44 | 45 | def magic(self, code, kernel): 46 | match = self.magic_regex.match(code.strip()) 47 | if match: 48 | v = match.groupdict() 49 | for k in v: 50 | v[k] = v[k] if isinstance(v[k],str) else '' 51 | 52 | name = v['magic'].strip() 53 | code = v['code'].strip() 54 | 55 | if name in self.available_magics: 56 | if code.find('-h') >= 0: 57 | print_kernel(self.available_magics[name].format(name), kernel) 58 | code = '' 59 | else: 60 | code = getattr(self, "magic_" + name)(code, kernel) 61 | else: 62 | print_kernel("Unknown magic %{0}.".format(name), kernel) 63 | 64 | return code 65 | 66 | def magic_quietly(self,code,kernel): 67 | """ 68 | Supress all display for the current cell. 69 | """ 70 | kernel.quietly = True 71 | return code 72 | 73 | def magic_noecho(self,code,kernel): 74 | """ 75 | Supress echo for the current cell. 76 | """ 77 | kernel.noecho = True 78 | return code 79 | 80 | def magic_browse(self,code,kernel): 81 | """ 82 | Display data in a nicely-formatted table. 83 | """ 84 | env = kernel.env 85 | N_max = 200 86 | 87 | args = parse_code_if_in(code) 88 | 89 | # If and in statements 90 | sel_var = SelVar(args['if']) 91 | start,end = InVar(args['in']) 92 | 93 | vargs = [c.strip() for c in args['code'].split(' ') if c] 94 | 95 | if len(vargs) >= 1: 96 | if vargs[0].isnumeric(): 97 | # 1st argument is obs count 98 | N_max = int(vargs[0]) 99 | del vargs[0] 100 | 101 | # Specified variables? 102 | vars = vargs if len(vargs) >= 1 else None 103 | 104 | # Obs range 105 | if start != None and end != None: 106 | obs_range = range(start,end) 107 | else: 108 | obs_range = range(0,min(count(),N_max)) 109 | 110 | # Missing value display format 111 | missingval = env['missing'] if env['missing'] != 'pandas' else np.NaN 112 | 113 | try: 114 | df = better_pdataframe_from_data(obs=obs_range, 115 | var=vars, 116 | selectvar=sel_var.varname, 117 | missingval=missingval) 118 | if vars == None and sel_var.varname != None: 119 | df = df.drop([sel_var.varname],axis=1) 120 | 121 | html = df.to_html(notebook=True) 122 | 123 | content = { 124 | 'data': { 125 | 'text/html': html}, 126 | 'metadata': {}} 127 | kernel.send_response(kernel.iopub_socket, 'display_data', content) 128 | except Exception as e: 129 | msg = "Failed to browse data.\r\n{0}" 130 | print_kernel(msg.format(e), kernel) 131 | 132 | if sel_var != None: 133 | # Drop selection var in Stata. We put this outside of try to ensure 134 | # the temp variable gets deleted even when there is an error. 135 | sel_var.clear() 136 | 137 | return '' 138 | 139 | def magic_help(self,code,kernel): 140 | """ 141 | Show help file from stata.com. 142 | """ 143 | 144 | try: 145 | reply = urllib.request.urlopen(self.html_help.format(code)) 146 | html = reply.read().decode("utf-8") 147 | soup = bs(html, 'html.parser') 148 | 149 | # Set root for links to https://ww.stata.com 150 | for a in soup.find_all('a', href=True): 151 | href = a.get('href') 152 | match = re.search(r'{}(.*?)#'.format(code), href) 153 | if match: 154 | hrelative = href.find('#') 155 | a['href'] = href[hrelative:] 156 | elif not href.startswith('http'): 157 | link = a['href'] 158 | match = re.search(r'/help.cgi\?(.+)$', link) 159 | # URL encode bad characters like % 160 | if match: 161 | link = '/help.cgi?' 162 | link += urllib.parse.quote_plus(match.group(1)) 163 | a['href'] = urllib.parse.urljoin(self.html_base, link) 164 | a['target'] = '_blank' 165 | 166 | # Remove header 'Stata 15 help for ...' 167 | soup.find('h2').decompose() 168 | 169 | # Remove Stata help menu 170 | soup.find('div', id='menu').decompose() 171 | 172 | # Remove Copyright notice 173 | tags = ['a', 'font'] 174 | for tag in tags: 175 | copyright = soup.find(tag, text='Copyright') 176 | if copyright: 177 | copyright.find_parent("table").decompose() 178 | break 179 | 180 | # Remove last hrule 181 | soup.find_all('hr')[-1].decompose() 182 | 183 | # Set all the backgrounds to transparent 184 | for color in ['#ffffff', '#FFFFFF']: 185 | for bg in ['bgcolor', 'background', 'background-color']: 186 | for tag in soup.find_all(attrs={bg: color}): 187 | if tag.get(bg): 188 | tag[bg] = 'transparent' 189 | 190 | # Set html 191 | css = soup.find('style', {'type': 'text/css'}) 192 | with open(self.csshelp_default, 'r') as default: 193 | css.string = default.read() 194 | 195 | fallback = 'This front-end cannot display HTML help.' 196 | resp = { 197 | 'data': { 198 | 'text/html': str(soup), 199 | 'text/plain': fallback}, 200 | 'metadata': {}} 201 | kernel.send_response(kernel.iopub_socket, 'display_data', resp) 202 | except (urllib.error.HTTPError, urllib.error.URLError) as e: 203 | msg = "Failed to fetch HTML help.\r\n{0}" 204 | print_kernel(msg.format(e), kernel) 205 | 206 | return '' 207 | 208 | -------------------------------------------------------------------------------- /pystata-kernel/utils.py: -------------------------------------------------------------------------------- 1 | # Utility functions that does not require Stata running 2 | # From stata_kernel 1.12 3 | 4 | import os 5 | import re 6 | import platform 7 | 8 | from shutil import which 9 | from pathlib import Path 10 | 11 | def find_dir_edition(): 12 | stata_path = find_path() 13 | stata_dir = str(os.path.dirname(stata_path)) 14 | stata_exe = str(os.path.basename(stata_path)).lower() 15 | 16 | edition = 'be' 17 | for e in ('se','mp'): 18 | if stata_exe.find(e) > -1: 19 | edition = e 20 | return (stata_dir,edition) 21 | 22 | def find_path(): 23 | if os.getenv('CONTINUOUS_INTEGRATION'): 24 | print('WARNING: Running as CI; Stata path not set correctly') 25 | return 'stata' 26 | if platform.system() == 'Windows': 27 | return win_find_path() 28 | elif platform.system() == 'Darwin': 29 | return mac_find_path() 30 | else: 31 | for i in ['stata-mp', 'stata-se', 'stata']: 32 | stata_path = which(i) 33 | if stata_path: 34 | break 35 | 36 | return stata_path 37 | 38 | def win_find_path(): 39 | import winreg 40 | reg = winreg.ConnectRegistry(None, winreg.HKEY_CLASSES_ROOT) 41 | subkeys = [r'Stata17Do\shell\do\command', 42 | r'Stata18Do\shell\do\command', 43 | r'Stata19Do\shell\do\command'] 44 | 45 | fpath = '' 46 | for subkey in subkeys: 47 | try: 48 | key = winreg.OpenKey(reg, subkey) 49 | fpath = winreg.QueryValue(key, None).split('"')[1] 50 | except FileNotFoundError: 51 | pass 52 | if fpath: 53 | break 54 | 55 | return fpath 56 | 57 | 58 | def mac_find_path(): 59 | """ 60 | Attempt to find Stata path on macOS when not on user's PATH. 61 | Modified from stata_kernel's original to only location "Applications/Stata". 62 | 63 | Returns: 64 | (str): Path to Stata. Empty string if not found. 65 | """ 66 | path = Path('/Applications/Stata') 67 | if not path.exists(): 68 | return '' 69 | else: 70 | return str(path) 71 | 72 | 73 | -------------------------------------------------------------------------------- /setup.py: -------------------------------------------------------------------------------- 1 | from distutils.core import setup 2 | 3 | with open('README.rst') as f: 4 | readme = f.read() 5 | 6 | setup( 7 | name='pystata-kernel', 8 | version='0.3.2', 9 | packages=['pystata-kernel'], 10 | package_data={'pystata-kernel': ['logo-64x64.png']}, 11 | description='A simple Jupyter kernel for Stata based on pystata', 12 | long_description=readme, 13 | author='Vinci Chow', 14 | author_email='ticoneva@gmail.com', 15 | url='https://github.com/ticoneva/pystata-kernel', 16 | install_requires=[ 17 | 'jupyter-client', 18 | 'ipython', 19 | 'ipykernel', 20 | 'packaging', 21 | 'pandas', 22 | 'numpy', 23 | 'beautifulsoup4' 24 | ], 25 | include_package_data=True, 26 | classifiers=[ 27 | 'Intended Audience :: Developers', 28 | 'License :: OSI Approved :: BSD License', 29 | 'Programming Language :: Python :: 3', 30 | ], 31 | ) 32 | -------------------------------------------------------------------------------- /tests/helpers.py: -------------------------------------------------------------------------------- 1 | import unittest 2 | from pystata-kernel.helpers import clean_code 3 | 4 | class Test_clean_code(unittest.TestCase): 5 | 6 | def test_forvalues(self): 7 | raw = """forvalues i=1/10 { 8 | sum a 9 | } 10 | """ 11 | out = """noisily forvalues i=1/10 { 12 | noisily sum a 13 | }""" 14 | self.assertEqual(clean_code(raw), out) 15 | --------------------------------------------------------------------------------