├── .github └── workflows │ └── main.yml ├── .gitignore ├── Dockerfile ├── LICENSE ├── README.md ├── docker-compose.yml ├── setup.py ├── src └── cs50 │ ├── __init__.py │ ├── cs50.py │ ├── flask.py │ └── sql.py └── tests ├── flask ├── application.py ├── requirements.txt └── templates │ ├── error.html │ └── index.html ├── foo.py ├── mysql.py ├── python.py ├── redirect ├── application.py └── templates │ └── foo.html ├── sql.py ├── sqlite.py └── tb.py /.github/workflows/main.yml: -------------------------------------------------------------------------------- 1 | on: push 2 | jobs: 3 | deploy: 4 | runs-on: ubuntu-latest 5 | services: 6 | mysql: 7 | image: mysql 8 | env: 9 | MYSQL_DATABASE: test 10 | MYSQL_ALLOW_EMPTY_PASSWORD: yes 11 | options: --health-cmd="mysqladmin ping" --health-interval=10s --health-timeout=5s --health-retries=3 12 | ports: 13 | - 3306:3306 14 | postgres: 15 | image: postgres 16 | env: 17 | POSTGRES_USER: postgres 18 | POSTGRES_PASSWORD: postgres 19 | POSTGRES_DB: test 20 | ports: 21 | - 5432:5432 22 | steps: 23 | - uses: actions/checkout@v4 24 | - uses: actions/setup-python@v5 25 | with: 26 | python-version: "3.13" 27 | check-latest: true 28 | - name: Setup databases 29 | run: | 30 | pip install . 31 | pip install mysqlclient psycopg2-binary SQLAlchemy 32 | 33 | - name: Run tests 34 | run: python tests/sql.py 35 | env: 36 | MYSQL_HOST: 127.0.0.1 37 | POSTGRESQL_HOST: 127.0.0.1 38 | 39 | - name: Install pypa/build 40 | run: python -m pip install build --user 41 | 42 | - name: Build a binary wheel and a source tarball 43 | run: python -m build --sdist --wheel --outdir dist/ . 44 | 45 | - name: Deploy to PyPI 46 | if: ${{ github.ref == 'refs/heads/main' }} 47 | uses: pypa/gh-action-pypi-publish@release/v1 48 | with: 49 | user: __token__ 50 | password: ${{ secrets.PYPI_API_TOKEN }} 51 | 52 | - name: Get Version 53 | id: py_version 54 | run: | 55 | echo ::set-output name=version::$(python3 setup.py --version) 56 | 57 | - name: Create Release 58 | if: ${{ github.ref == 'refs/heads/main' }} 59 | uses: actions/github-script@v7 60 | with: 61 | github-token: ${{ github.token }} 62 | script: | 63 | github.rest.repos.createRelease({ 64 | owner: context.repo.owner, 65 | repo: context.repo.repo, 66 | tag_name: "v${{ steps.py_version.outputs.version }}", 67 | tag_commitish: "${{ github.sha }}" 68 | }) 69 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | .* 2 | !/.github/ 3 | !.gitignore 4 | build/ 5 | *.db 6 | *.egg-info/ 7 | *.pyc 8 | -------------------------------------------------------------------------------- /Dockerfile: -------------------------------------------------------------------------------- 1 | FROM cs50/cli 2 | 3 | RUN sudo apt update && sudo apt install --yes libmysqlclient-dev pgloader pkg-config postgresql 4 | RUN sudo pip3 install mysqlclient psycopg2-binary 5 | 6 | WORKDIR /mnt 7 | -------------------------------------------------------------------------------- /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 | # CS50 Library for Python 2 | 3 | ## Installation 4 | 5 | ``` 6 | pip3 install cs50 7 | ``` 8 | 9 | ## Usage 10 | 11 | ``` 12 | import cs50 13 | 14 | ... 15 | 16 | f = cs50.get_float(); 17 | i = cs50.get_int(); 18 | s = cs50.get_string(); 19 | ``` 20 | 21 | ## Testing 22 | 23 | 1. In one terminal, execute: 24 | 25 | ``` 26 | cd python-cs50 27 | docker compose build 28 | docker compose up 29 | ``` 30 | 31 | 1. In another terminal, execute: 32 | 33 | ``` 34 | docker exec -it python-cs50 bash -l 35 | ``` 36 | 37 | And then execute, e.g.: 38 | 39 | ``` 40 | python tests/sql.py 41 | ``` 42 | -------------------------------------------------------------------------------- /docker-compose.yml: -------------------------------------------------------------------------------- 1 | services: 2 | cli: 3 | build: . 4 | container_name: python-cs50 5 | depends_on: 6 | - mysql 7 | - postgres 8 | environment: 9 | MYSQL_HOST: mysql 10 | POSTGRESQL_HOST: postgres 11 | links: 12 | - mysql 13 | - postgres 14 | tty: true 15 | volumes: 16 | - .:/mnt 17 | mysql: 18 | environment: 19 | MYSQL_DATABASE: test 20 | MYSQL_ALLOW_EMPTY_PASSWORD: yes 21 | healthcheck: 22 | test: ["CMD", "mysqladmin", "-uroot", "ping"] 23 | image: cs50/mysql 24 | ports: 25 | - 3306:3306 26 | postgres: 27 | image: postgres:12 28 | environment: 29 | POSTGRES_USER: postgres 30 | POSTGRES_PASSWORD: postgres 31 | POSTGRES_DB: test 32 | ports: 33 | - 5432:5432 34 | -------------------------------------------------------------------------------- /setup.py: -------------------------------------------------------------------------------- 1 | from setuptools import setup 2 | 3 | setup( 4 | author="CS50", 5 | author_email="sysadmins@cs50.harvard.edu", 6 | classifiers=[ 7 | "Intended Audience :: Developers", 8 | "Programming Language :: Python", 9 | "Programming Language :: Python :: 3", 10 | "Topic :: Software Development :: Libraries :: Python Modules" 11 | ], 12 | description="CS50 library for Python", 13 | install_requires=["Flask>=1.0", "packaging", "SQLAlchemy>=2,<3", "sqlparse", "termcolor", "wheel"], 14 | keywords="cs50", 15 | license="GPLv3", 16 | long_description_content_type="text/markdown", 17 | name="cs50", 18 | package_dir={"": "src"}, 19 | packages=["cs50"], 20 | url="https://github.com/cs50/python-cs50", 21 | version="9.4.0" 22 | ) 23 | -------------------------------------------------------------------------------- /src/cs50/__init__.py: -------------------------------------------------------------------------------- 1 | import logging 2 | import os 3 | import sys 4 | 5 | 6 | # Disable cs50 logger by default 7 | logging.getLogger("cs50").disabled = True 8 | 9 | # Import cs50_* 10 | from .cs50 import get_char, get_float, get_int, get_string 11 | 12 | try: 13 | from .cs50 import get_long 14 | except ImportError: 15 | pass 16 | 17 | # Hook into flask importing 18 | from . import flask 19 | 20 | # Wrap SQLAlchemy 21 | from .sql import SQL 22 | -------------------------------------------------------------------------------- /src/cs50/cs50.py: -------------------------------------------------------------------------------- 1 | from __future__ import print_function 2 | 3 | import inspect 4 | import logging 5 | import os 6 | import re 7 | import sys 8 | 9 | from os.path import abspath, join 10 | from termcolor import colored 11 | from traceback import format_exception 12 | 13 | 14 | # Configure default logging handler and formatter 15 | # Prevent flask, werkzeug, etc from adding default handler 16 | logging.basicConfig(format="%(levelname)s: %(message)s", level=logging.DEBUG) 17 | 18 | try: 19 | # Patch formatException 20 | logging.root.handlers[ 21 | 0 22 | ].formatter.formatException = lambda exc_info: _formatException(*exc_info) 23 | except IndexError: 24 | pass 25 | 26 | # Configure cs50 logger 27 | _logger = logging.getLogger("cs50") 28 | _logger.setLevel(logging.DEBUG) 29 | 30 | # Log messages once 31 | _logger.propagate = False 32 | 33 | handler = logging.StreamHandler() 34 | handler.setLevel(logging.DEBUG) 35 | 36 | formatter = logging.Formatter("%(levelname)s: %(message)s") 37 | formatter.formatException = lambda exc_info: _formatException(*exc_info) 38 | handler.setFormatter(formatter) 39 | _logger.addHandler(handler) 40 | 41 | 42 | class _Unbuffered: 43 | """ 44 | Disable buffering for standard output and standard error. 45 | 46 | https://stackoverflow.com/a/107717 47 | https://docs.python.org/3/library/io.html 48 | """ 49 | 50 | def __init__(self, stream): 51 | self.stream = stream 52 | 53 | def __getattr__(self, attr): 54 | return getattr(self.stream, attr) 55 | 56 | def write(self, b): 57 | self.stream.write(b) 58 | self.stream.flush() 59 | 60 | def writelines(self, lines): 61 | self.stream.writelines(lines) 62 | self.stream.flush() 63 | 64 | 65 | sys.stderr = _Unbuffered(sys.stderr) 66 | sys.stdout = _Unbuffered(sys.stdout) 67 | 68 | 69 | def _formatException(type, value, tb): 70 | """ 71 | Format traceback, darkening entries from global site-packages directories 72 | and user-specific site-packages directory. 73 | 74 | https://stackoverflow.com/a/46071447/5156190 75 | """ 76 | 77 | # Absolute paths to site-packages 78 | packages = tuple(join(abspath(p), "") for p in sys.path[1:]) 79 | 80 | # Highlight lines not referring to files in site-packages 81 | lines = [] 82 | for line in format_exception(type, value, tb): 83 | matches = re.search(r"^ File \"([^\"]+)\", line \d+, in .+", line) 84 | if matches and matches.group(1).startswith(packages): 85 | lines += line 86 | else: 87 | matches = re.search(r"^(\s*)(.*?)(\s*)$", line, re.DOTALL) 88 | lines.append( 89 | matches.group(1) 90 | + colored(matches.group(2), "yellow") 91 | + matches.group(3) 92 | ) 93 | return "".join(lines).rstrip() 94 | 95 | 96 | sys.excepthook = lambda type, value, tb: print( 97 | _formatException(type, value, tb), file=sys.stderr 98 | ) 99 | 100 | 101 | def eprint(*args, **kwargs): 102 | raise RuntimeError( 103 | "The CS50 Library for Python no longer supports eprint, but you can use print instead!" 104 | ) 105 | 106 | 107 | def get_char(prompt): 108 | raise RuntimeError( 109 | "The CS50 Library for Python no longer supports get_char, but you can use get_string instead!" 110 | ) 111 | 112 | 113 | def get_float(prompt): 114 | """ 115 | Read a line of text from standard input and return the equivalent float 116 | as precisely as possible; if text does not represent a double, user is 117 | prompted to retry. If line can't be read, return None. 118 | """ 119 | while True: 120 | s = get_string(prompt) 121 | if s is None: 122 | return None 123 | if len(s) > 0 and re.search(r"^[+-]?\d*(?:\.\d*)?$", s): 124 | try: 125 | return float(s) 126 | except (OverflowError, ValueError): 127 | pass 128 | 129 | 130 | def get_int(prompt): 131 | """ 132 | Read a line of text from standard input and return the equivalent int; 133 | if text does not represent an int, user is prompted to retry. If line 134 | can't be read, return None. 135 | """ 136 | while True: 137 | s = get_string(prompt) 138 | if s is None: 139 | return None 140 | if re.search(r"^[+-]?\d+$", s): 141 | try: 142 | return int(s, 10) 143 | except ValueError: 144 | pass 145 | 146 | 147 | def get_string(prompt): 148 | """ 149 | Read a line of text from standard input and return it as a string, 150 | sans trailing line ending. Supports CR (\r), LF (\n), and CRLF (\r\n) 151 | as line endings. If user inputs only a line ending, returns "", not None. 152 | Returns None upon error or no input whatsoever (i.e., just EOF). 153 | """ 154 | if not isinstance(prompt, str): 155 | raise TypeError("prompt must be of type str") 156 | try: 157 | return input(prompt) 158 | except EOFError: 159 | return None 160 | -------------------------------------------------------------------------------- /src/cs50/flask.py: -------------------------------------------------------------------------------- 1 | import os 2 | import pkgutil 3 | import sys 4 | 5 | 6 | def _wrap_flask(f): 7 | if f is None: 8 | return 9 | 10 | from packaging.version import Version, InvalidVersion 11 | from .cs50 import _formatException 12 | 13 | try: 14 | if Version(f.__version__) < Version("1.0"): 15 | return 16 | except InvalidVersion: 17 | return 18 | 19 | if os.getenv("CS50_IDE_TYPE") == "online": 20 | from werkzeug.middleware.proxy_fix import ProxyFix 21 | 22 | _flask_init_before = f.Flask.__init__ 23 | 24 | def _flask_init_after(self, *args, **kwargs): 25 | _flask_init_before(self, *args, **kwargs) 26 | self.wsgi_app = ProxyFix( 27 | self.wsgi_app, x_proto=1 28 | ) # For HTTPS-to-HTTP proxy 29 | 30 | f.Flask.__init__ = _flask_init_after 31 | 32 | 33 | # If Flask was imported before cs50 34 | if "flask" in sys.modules: 35 | _wrap_flask(sys.modules["flask"]) 36 | 37 | # If Flask wasn't imported 38 | else: 39 | flask_loader = pkgutil.get_loader("flask") 40 | if flask_loader: 41 | _exec_module_before = flask_loader.exec_module 42 | 43 | def _exec_module_after(*args, **kwargs): 44 | _exec_module_before(*args, **kwargs) 45 | _wrap_flask(sys.modules["flask"]) 46 | 47 | flask_loader.exec_module = _exec_module_after 48 | -------------------------------------------------------------------------------- /src/cs50/sql.py: -------------------------------------------------------------------------------- 1 | import sys 2 | import threading 3 | 4 | # Thread-local data 5 | _data = threading.local() 6 | 7 | 8 | def _enable_logging(f): 9 | """Enable logging of SQL statements when Flask is in use.""" 10 | 11 | import logging 12 | import functools 13 | import os 14 | 15 | @functools.wraps(f) 16 | def decorator(*args, **kwargs): 17 | # Infer whether Flask is installed 18 | try: 19 | import flask 20 | except ModuleNotFoundError: 21 | return f(*args, **kwargs) 22 | 23 | # Enable logging in development mode 24 | disabled = logging.getLogger("cs50").disabled 25 | if flask.current_app and os.getenv("FLASK_ENV") == "development": 26 | logging.getLogger("cs50").disabled = False 27 | try: 28 | return f(*args, **kwargs) 29 | finally: 30 | logging.getLogger("cs50").disabled = disabled 31 | 32 | return decorator 33 | 34 | 35 | class SQL(object): 36 | """Wrap SQLAlchemy to provide a simple SQL API.""" 37 | 38 | def __init__(self, url, **kwargs): 39 | """ 40 | Create instance of sqlalchemy.engine.Engine. 41 | 42 | URL should be a string that indicates database dialect and connection arguments. 43 | 44 | http://docs.sqlalchemy.org/en/latest/core/engines.html#sqlalchemy.create_engine 45 | http://docs.sqlalchemy.org/en/latest/dialects/index.html 46 | """ 47 | 48 | # Lazily import 49 | import logging 50 | import os 51 | import re 52 | import sqlalchemy 53 | import sqlalchemy.orm 54 | import threading 55 | 56 | # Temporary fix for missing sqlite3 module on the buildpack stack 57 | try: 58 | import sqlite3 59 | except: 60 | pass 61 | 62 | # Require that file already exist for SQLite 63 | matches = re.search(r"^sqlite:///(.+)$", url) 64 | if matches: 65 | if not os.path.exists(matches.group(1)): 66 | raise RuntimeError("does not exist: {}".format(matches.group(1))) 67 | if not os.path.isfile(matches.group(1)): 68 | raise RuntimeError("not a file: {}".format(matches.group(1))) 69 | 70 | # Create engine, disabling SQLAlchemy's own autocommit mode raising exception if back end's module not installed; 71 | # without isolation_level, PostgreSQL warns with "there is already a transaction in progress" for our own BEGIN and 72 | # "there is no transaction in progress" for our own COMMIT 73 | self._engine = sqlalchemy.create_engine(url, **kwargs).execution_options( 74 | autocommit=False, isolation_level="AUTOCOMMIT", no_parameters=True 75 | ) 76 | 77 | # Avoid doubly escaping percent signs, since no_parameters=True anyway 78 | # https://github.com/cs50/python-cs50/issues/171 79 | self._engine.dialect.identifier_preparer._double_percents = False 80 | 81 | # Get logger 82 | self._logger = logging.getLogger("cs50") 83 | 84 | # Listener for connections 85 | def connect(dbapi_connection, connection_record): 86 | # Enable foreign key constraints 87 | try: 88 | if isinstance( 89 | dbapi_connection, sqlite3.Connection 90 | ): # If back end is sqlite 91 | cursor = dbapi_connection.cursor() 92 | cursor.execute("PRAGMA foreign_keys=ON") 93 | cursor.close() 94 | except: 95 | # Temporary fix for missing sqlite3 module on the buildpack stack 96 | pass 97 | 98 | # Register listener 99 | sqlalchemy.event.listen(self._engine, "connect", connect) 100 | 101 | # Autocommit by default 102 | self._autocommit = True 103 | 104 | # Test database 105 | disabled = self._logger.disabled 106 | self._logger.disabled = True 107 | try: 108 | connection = self._engine.connect() 109 | connection.execute(sqlalchemy.text("SELECT 1")) 110 | connection.close() 111 | except sqlalchemy.exc.OperationalError as e: 112 | e = RuntimeError(_parse_exception(e)) 113 | e.__cause__ = None 114 | raise e 115 | finally: 116 | self._logger.disabled = disabled 117 | 118 | def __del__(self): 119 | """Disconnect from database.""" 120 | self._disconnect() 121 | 122 | def _disconnect(self): 123 | """Close database connection.""" 124 | if hasattr(_data, self._name()): 125 | getattr(_data, self._name()).close() 126 | delattr(_data, self._name()) 127 | 128 | def _name(self): 129 | """Return object's hash as a str.""" 130 | return str(hash(self)) 131 | 132 | @_enable_logging 133 | def execute(self, sql, *args, **kwargs): 134 | """Execute a SQL statement.""" 135 | 136 | # Lazily import 137 | import decimal 138 | import re 139 | import sqlalchemy 140 | import sqlparse 141 | import termcolor 142 | import warnings 143 | 144 | # Parse statement, stripping comments and then leading/trailing whitespace 145 | statements = sqlparse.parse(sqlparse.format(sql, strip_comments=True).strip()) 146 | 147 | # Allow only one statement at a time, since SQLite doesn't support multiple 148 | # https://docs.python.org/3/library/sqlite3.html#sqlite3.Cursor.execute 149 | if len(statements) > 1: 150 | raise RuntimeError("too many statements at once") 151 | elif len(statements) == 0: 152 | raise RuntimeError("missing statement") 153 | 154 | # Ensure named and positional parameters are mutually exclusive 155 | if len(args) > 0 and len(kwargs) > 0: 156 | raise RuntimeError("cannot pass both positional and named parameters") 157 | 158 | # Infer command from flattened statement to a single string separated by spaces 159 | full_statement = " ".join( 160 | str(token) 161 | for token in statements[0].tokens 162 | if token.ttype 163 | in [ 164 | sqlparse.tokens.Keyword, 165 | sqlparse.tokens.Keyword.DDL, 166 | sqlparse.tokens.Keyword.DML, 167 | ] 168 | ) 169 | full_statement = full_statement.upper() 170 | 171 | # Set of possible commands 172 | commands = { 173 | "BEGIN", 174 | "CREATE VIEW", 175 | "DELETE", 176 | "INSERT", 177 | "SELECT", 178 | "START", 179 | "UPDATE", 180 | "VACUUM", 181 | } 182 | 183 | # Check if the full_statement starts with any command 184 | command = next( 185 | (cmd for cmd in commands if full_statement.startswith(cmd)), None 186 | ) 187 | 188 | # Flatten statement 189 | tokens = list(statements[0].flatten()) 190 | 191 | # Validate paramstyle 192 | placeholders = {} 193 | paramstyle = None 194 | for index, token in enumerate(tokens): 195 | # If token is a placeholder 196 | if token.ttype == sqlparse.tokens.Name.Placeholder: 197 | # Determine paramstyle, name 198 | _paramstyle, name = _parse_placeholder(token) 199 | 200 | # Remember paramstyle 201 | if not paramstyle: 202 | paramstyle = _paramstyle 203 | 204 | # Ensure paramstyle is consistent 205 | elif _paramstyle != paramstyle: 206 | raise RuntimeError("inconsistent paramstyle") 207 | 208 | # Remember placeholder's index, name 209 | placeholders[index] = name 210 | 211 | # If no placeholders 212 | if not paramstyle: 213 | # Error-check like qmark if args 214 | if args: 215 | paramstyle = "qmark" 216 | 217 | # Error-check like named if kwargs 218 | elif kwargs: 219 | paramstyle = "named" 220 | 221 | # In case of errors 222 | _placeholders = ", ".join([str(tokens[index]) for index in placeholders]) 223 | _args = ", ".join([str(self._escape(arg)) for arg in args]) 224 | 225 | # qmark 226 | if paramstyle == "qmark": 227 | # Validate number of placeholders 228 | if len(placeholders) != len(args): 229 | if len(placeholders) < len(args): 230 | raise RuntimeError( 231 | "fewer placeholders ({}) than values ({})".format( 232 | _placeholders, _args 233 | ) 234 | ) 235 | else: 236 | raise RuntimeError( 237 | "more placeholders ({}) than values ({})".format( 238 | _placeholders, _args 239 | ) 240 | ) 241 | 242 | # Escape values 243 | for i, index in enumerate(placeholders.keys()): 244 | tokens[index] = self._escape(args[i]) 245 | 246 | # numeric 247 | elif paramstyle == "numeric": 248 | # Escape values 249 | for index, i in placeholders.items(): 250 | if i >= len(args): 251 | raise RuntimeError( 252 | "missing value for placeholder (:{})".format(i + 1, len(args)) 253 | ) 254 | tokens[index] = self._escape(args[i]) 255 | 256 | # Check if any values unused 257 | indices = set(range(len(args))) - set(placeholders.values()) 258 | if indices: 259 | raise RuntimeError( 260 | "unused {} ({})".format( 261 | "value" if len(indices) == 1 else "values", 262 | ", ".join( 263 | [str(self._escape(args[index])) for index in indices] 264 | ), 265 | ) 266 | ) 267 | 268 | # named 269 | elif paramstyle == "named": 270 | # Escape values 271 | for index, name in placeholders.items(): 272 | if name not in kwargs: 273 | raise RuntimeError( 274 | "missing value for placeholder (:{})".format(name) 275 | ) 276 | tokens[index] = self._escape(kwargs[name]) 277 | 278 | # Check if any keys unused 279 | keys = kwargs.keys() - placeholders.values() 280 | if keys: 281 | raise RuntimeError("unused values ({})".format(", ".join(keys))) 282 | 283 | # format 284 | elif paramstyle == "format": 285 | # Validate number of placeholders 286 | if len(placeholders) != len(args): 287 | if len(placeholders) < len(args): 288 | raise RuntimeError( 289 | "fewer placeholders ({}) than values ({})".format( 290 | _placeholders, _args 291 | ) 292 | ) 293 | else: 294 | raise RuntimeError( 295 | "more placeholders ({}) than values ({})".format( 296 | _placeholders, _args 297 | ) 298 | ) 299 | 300 | # Escape values 301 | for i, index in enumerate(placeholders.keys()): 302 | tokens[index] = self._escape(args[i]) 303 | 304 | # pyformat 305 | elif paramstyle == "pyformat": 306 | # Escape values 307 | for index, name in placeholders.items(): 308 | if name not in kwargs: 309 | raise RuntimeError( 310 | "missing value for placeholder (%{}s)".format(name) 311 | ) 312 | tokens[index] = self._escape(kwargs[name]) 313 | 314 | # Check if any keys unused 315 | keys = kwargs.keys() - placeholders.values() 316 | if keys: 317 | raise RuntimeError( 318 | "unused {} ({})".format( 319 | "value" if len(keys) == 1 else "values", ", ".join(keys) 320 | ) 321 | ) 322 | 323 | # For SQL statements where a colon is required verbatim, as within an inline string, use a backslash to escape 324 | # https://docs.sqlalchemy.org/en/13/core/sqlelement.html?highlight=text#sqlalchemy.sql.expression.text 325 | for index, token in enumerate(tokens): 326 | # In string literal 327 | # https://www.sqlite.org/lang_keywords.html 328 | if token.ttype in [ 329 | sqlparse.tokens.Literal.String, 330 | sqlparse.tokens.Literal.String.Single, 331 | ]: 332 | token.value = re.sub(r"(^'|\s+):", r"\1\:", token.value) 333 | 334 | # In identifier 335 | # https://www.sqlite.org/lang_keywords.html 336 | elif token.ttype == sqlparse.tokens.Literal.String.Symbol: 337 | token.value = re.sub(r'(^"|\s+):', r"\1\:", token.value) 338 | 339 | # Join tokens into statement 340 | statement = "".join([str(token) for token in tokens]) 341 | 342 | # If no connection yet 343 | if not hasattr(_data, self._name()): 344 | # Connect to database 345 | setattr(_data, self._name(), self._engine.connect()) 346 | 347 | # Use this connection 348 | connection = getattr(_data, self._name()) 349 | 350 | # Disconnect if/when a Flask app is torn down 351 | try: 352 | import flask 353 | 354 | assert flask.current_app 355 | 356 | def teardown_appcontext(exception): 357 | self._disconnect() 358 | 359 | if teardown_appcontext not in flask.current_app.teardown_appcontext_funcs: 360 | flask.current_app.teardown_appcontext(teardown_appcontext) 361 | except (ModuleNotFoundError, AssertionError): 362 | pass 363 | 364 | # Catch SQLAlchemy warnings 365 | with warnings.catch_warnings(): 366 | # Raise exceptions for warnings 367 | warnings.simplefilter("error") 368 | 369 | # Prepare, execute statement 370 | try: 371 | # Join tokens into statement, abbreviating binary data as 372 | _statement = "".join( 373 | [ 374 | str(bytes) 375 | if token.ttype == sqlparse.tokens.Other 376 | else str(token) 377 | for token in tokens 378 | ] 379 | ) 380 | 381 | # Check for start of transaction 382 | if command in ["BEGIN", "START", "VACUUM"]: # cannot VACUUM from within a transaction 383 | self._autocommit = False 384 | 385 | # Execute statement 386 | if self._autocommit: 387 | connection.execute(sqlalchemy.text("BEGIN")) 388 | result = connection.execute(sqlalchemy.text(statement)) 389 | if self._autocommit: 390 | connection.execute(sqlalchemy.text("COMMIT")) 391 | 392 | # Check for end of transaction 393 | if command in ["COMMIT", "ROLLBACK", "VACUUM"]: # cannot VACUUM from within a transaction 394 | self._autocommit = True 395 | 396 | # Return value 397 | ret = True 398 | 399 | # If SELECT, return result set as list of dict objects 400 | if command == "SELECT": 401 | # Coerce types 402 | rows = [dict(row) for row in result.mappings().all()] 403 | for row in rows: 404 | for column in row: 405 | # Coerce decimal.Decimal objects to float objects 406 | # https://groups.google.com/d/msg/sqlalchemy/0qXMYJvq8SA/oqtvMD9Uw-kJ 407 | if isinstance(row[column], decimal.Decimal): 408 | row[column] = float(row[column]) 409 | 410 | # Coerce memoryview objects (as from PostgreSQL's bytea columns) to bytes 411 | elif isinstance(row[column], memoryview): 412 | row[column] = bytes(row[column]) 413 | 414 | # Rows to be returned 415 | ret = rows 416 | 417 | # If INSERT, return primary key value for a newly inserted row (or None if none) 418 | elif command == "INSERT": 419 | # If PostgreSQL 420 | if self._engine.url.get_backend_name() == "postgresql": 421 | # Return LASTVAL() or NULL, avoiding 422 | # "(psycopg2.errors.ObjectNotInPrerequisiteState) lastval is not yet defined in this session", 423 | # a la https://stackoverflow.com/a/24186770/5156190; 424 | # cf. https://www.psycopg.org/docs/errors.html re 55000 425 | result = connection.execute( 426 | sqlalchemy.text( 427 | """ 428 | CREATE OR REPLACE FUNCTION _LASTVAL() 429 | RETURNS integer LANGUAGE plpgsql 430 | AS $$ 431 | BEGIN 432 | BEGIN 433 | RETURN (SELECT LASTVAL()); 434 | EXCEPTION 435 | WHEN SQLSTATE '55000' THEN RETURN NULL; 436 | END; 437 | END $$; 438 | SELECT _LASTVAL(); 439 | """ 440 | ) 441 | ) 442 | ret = result.first()[0] 443 | 444 | # If not PostgreSQL 445 | else: 446 | ret = result.lastrowid if result.rowcount == 1 else None 447 | 448 | # If DELETE or UPDATE, return number of rows matched 449 | elif command in ["DELETE", "UPDATE"]: 450 | ret = result.rowcount 451 | 452 | # If CREATE VIEW, return True 453 | elif command == "CREATE VIEW": 454 | ret = True 455 | 456 | # If constraint violated 457 | except sqlalchemy.exc.IntegrityError as e: 458 | if self._autocommit: 459 | connection.execute(sqlalchemy.text("ROLLBACK")) 460 | self._logger.error(termcolor.colored(_statement, "red")) 461 | e = ValueError(e.orig) 462 | e.__cause__ = None 463 | raise e 464 | 465 | # If user error 466 | except ( 467 | sqlalchemy.exc.OperationalError, 468 | sqlalchemy.exc.ProgrammingError, 469 | ) as e: 470 | self._disconnect() 471 | self._logger.error(termcolor.colored(_statement, "red")) 472 | e = RuntimeError(e.orig) 473 | e.__cause__ = None 474 | raise e 475 | 476 | # Return value 477 | else: 478 | self._logger.info(termcolor.colored(_statement, "green")) 479 | if self._autocommit: # Don't stay connected unnecessarily 480 | self._disconnect() 481 | return ret 482 | 483 | def _escape(self, value): 484 | """ 485 | Escapes value using engine's conversion function. 486 | 487 | https://docs.sqlalchemy.org/en/latest/core/type_api.html#sqlalchemy.types.TypeEngine.literal_processor 488 | """ 489 | 490 | # Lazily import 491 | import sqlparse 492 | 493 | def __escape(value): 494 | # Lazily import 495 | import datetime 496 | import sqlalchemy 497 | 498 | # bool 499 | if isinstance(value, bool): 500 | return sqlparse.sql.Token( 501 | sqlparse.tokens.Number, 502 | sqlalchemy.types.Boolean().literal_processor(self._engine.dialect)( 503 | value 504 | ), 505 | ) 506 | 507 | # bytes 508 | elif isinstance(value, bytes): 509 | if self._engine.url.get_backend_name() in ["mysql", "sqlite"]: 510 | return sqlparse.sql.Token( 511 | sqlparse.tokens.Other, f"x'{value.hex()}'" 512 | ) # https://dev.mysql.com/doc/refman/8.0/en/hexadecimal-literals.html 513 | elif self._engine.url.get_backend_name() == "postgresql": 514 | return sqlparse.sql.Token( 515 | sqlparse.tokens.Other, f"'\\x{value.hex()}'" 516 | ) # https://dba.stackexchange.com/a/203359 517 | else: 518 | raise RuntimeError("unsupported value: {}".format(value)) 519 | 520 | # datetime.datetime 521 | elif isinstance(value, datetime.datetime): 522 | return sqlparse.sql.Token( 523 | sqlparse.tokens.String, 524 | sqlalchemy.types.String().literal_processor(self._engine.dialect)( 525 | value.strftime("%Y-%m-%d %H:%M:%S") 526 | ), 527 | ) 528 | 529 | # datetime.date 530 | elif isinstance(value, datetime.date): 531 | return sqlparse.sql.Token( 532 | sqlparse.tokens.String, 533 | sqlalchemy.types.String().literal_processor(self._engine.dialect)( 534 | value.strftime("%Y-%m-%d") 535 | ), 536 | ) 537 | 538 | # datetime.time 539 | elif isinstance(value, datetime.time): 540 | return sqlparse.sql.Token( 541 | sqlparse.tokens.String, 542 | sqlalchemy.types.String().literal_processor(self._engine.dialect)( 543 | value.strftime("%H:%M:%S") 544 | ), 545 | ) 546 | 547 | # float 548 | elif isinstance(value, float): 549 | return sqlparse.sql.Token( 550 | sqlparse.tokens.Number, 551 | sqlalchemy.types.Float().literal_processor(self._engine.dialect)( 552 | value 553 | ), 554 | ) 555 | 556 | # int 557 | elif isinstance(value, int): 558 | return sqlparse.sql.Token( 559 | sqlparse.tokens.Number, 560 | sqlalchemy.types.Integer().literal_processor(self._engine.dialect)( 561 | value 562 | ), 563 | ) 564 | 565 | # str 566 | elif isinstance(value, str): 567 | return sqlparse.sql.Token( 568 | sqlparse.tokens.String, 569 | sqlalchemy.types.String().literal_processor(self._engine.dialect)( 570 | value 571 | ), 572 | ) 573 | 574 | # None 575 | elif value is None: 576 | return sqlparse.sql.Token(sqlparse.tokens.Keyword, sqlalchemy.null()) 577 | 578 | # Unsupported value 579 | else: 580 | raise RuntimeError("unsupported value: {}".format(value)) 581 | 582 | # Escape value(s), separating with commas as needed 583 | if isinstance(value, (list, tuple)): 584 | return sqlparse.sql.TokenList( 585 | sqlparse.parse(", ".join([str(__escape(v)) for v in value])) 586 | ) 587 | else: 588 | return __escape(value) 589 | 590 | 591 | def _parse_exception(e): 592 | """Parses an exception, returns its message.""" 593 | 594 | # Lazily import 595 | import re 596 | 597 | # MySQL 598 | matches = re.search( 599 | r"^\(_mysql_exceptions\.OperationalError\) \(\d+, \"(.+)\"\)$", str(e) 600 | ) 601 | if matches: 602 | return matches.group(1) 603 | 604 | # PostgreSQL 605 | matches = re.search(r"^\(psycopg2\.OperationalError\) (.+)$", str(e)) 606 | if matches: 607 | return matches.group(1) 608 | 609 | # SQLite 610 | matches = re.search(r"^\(sqlite3\.OperationalError\) (.+)$", str(e)) 611 | if matches: 612 | return matches.group(1) 613 | 614 | # Default 615 | return str(e) 616 | 617 | 618 | def _parse_placeholder(token): 619 | """Infers paramstyle, name from sqlparse.tokens.Name.Placeholder.""" 620 | 621 | # Lazily load 622 | import re 623 | import sqlparse 624 | 625 | # Validate token 626 | if ( 627 | not isinstance(token, sqlparse.sql.Token) 628 | or token.ttype != sqlparse.tokens.Name.Placeholder 629 | ): 630 | raise TypeError() 631 | 632 | # qmark 633 | if token.value == "?": 634 | return "qmark", None 635 | 636 | # numeric 637 | matches = re.search(r"^:([1-9]\d*)$", token.value) 638 | if matches: 639 | return "numeric", int(matches.group(1)) - 1 640 | 641 | # named 642 | matches = re.search(r"^:([a-zA-Z]\w*)$", token.value) 643 | if matches: 644 | return "named", matches.group(1) 645 | 646 | # format 647 | if token.value == "%s": 648 | return "format", None 649 | 650 | # pyformat 651 | matches = re.search(r"%\((\w+)\)s$", token.value) 652 | if matches: 653 | return "pyformat", matches.group(1) 654 | 655 | # Invalid 656 | raise RuntimeError("{}: invalid placeholder".format(token.value)) 657 | -------------------------------------------------------------------------------- /tests/flask/application.py: -------------------------------------------------------------------------------- 1 | import requests 2 | import sys 3 | from flask import Flask, render_template 4 | 5 | sys.path.insert(0, "../../src") 6 | 7 | import cs50 8 | import cs50.flask 9 | 10 | app = Flask(__name__) 11 | 12 | db = cs50.SQL("sqlite:///../sqlite.db") 13 | 14 | @app.route("/") 15 | def index(): 16 | db.execute("SELECT 1") 17 | """ 18 | def f(): 19 | res = requests.get("cs50.harvard.edu") 20 | f() 21 | """ 22 | return render_template("index.html") 23 | -------------------------------------------------------------------------------- /tests/flask/requirements.txt: -------------------------------------------------------------------------------- 1 | cs50 2 | Flask 3 | -------------------------------------------------------------------------------- /tests/flask/templates/error.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | error 6 | 7 | 8 | error 9 | 10 | 11 | -------------------------------------------------------------------------------- /tests/flask/templates/index.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | flask 6 | 7 | 8 | flask 9 | 10 | 11 | -------------------------------------------------------------------------------- /tests/foo.py: -------------------------------------------------------------------------------- 1 | import logging 2 | import sys 3 | 4 | sys.path.insert(0, "../src") 5 | 6 | import cs50 7 | 8 | db = cs50.SQL("sqlite:///foo.db") 9 | 10 | logging.getLogger("cs50").disabled = False 11 | logging.getLogger("cs50").setLevel(logging.ERROR) 12 | 13 | db.execute("DROP TABLE IF EXISTS bar") 14 | db.execute("CREATE TABLE bar (firstname STRING UNIQUE)") 15 | 16 | db.execute("INSERT INTO bar VALUES (?)", None) 17 | db.execute("INSERT INTO bar VALUES (?)", "baz") 18 | db.execute("INSERT INTO bar VALUES (?)", "qux") 19 | db.execute("SELECT * FROM bar WHERE firstname IN (?)", ("baz", "qux")) 20 | print(db.execute("SELECT * FROM bar")) 21 | #db.execute("DELETE FROM bar") 22 | 23 | """ 24 | 25 | db = cs50.SQL("postgresql://postgres@localhost/test") 26 | 27 | print(db.execute("DROP TABLE IF EXISTS cs50")) 28 | print(db.execute("CREATE TABLE cs50 (id SERIAL PRIMARY KEY, val VARCHAR(16), bin BYTEA)")) 29 | print(db.execute("INSERT INTO cs50 (val) VALUES('foo')")) 30 | print(db.execute("SELECT * FROM cs50")) 31 | 32 | print(db.execute("DROP TABLE IF EXISTS cs50")) 33 | print(db.execute("CREATE TABLE cs50 (val VARCHAR(16), bin BYTEA)")) 34 | print(db.execute("INSERT INTO cs50 (val) VALUES('foo')")) 35 | print(db.execute("SELECT * FROM cs50")) 36 | 37 | print(db.execute("DROP TABLE IF EXISTS cs50")) 38 | print(db.execute("CREATE TABLE cs50 (id SERIAL PRIMARY KEY, val VARCHAR(16), bin BYTEA)")) 39 | print(db.execute("INSERT INTO cs50 (val) VALUES('foo')")) 40 | print(db.execute("INSERT INTO cs50 (val) VALUES('bar')")) 41 | print(db.execute("INSERT INTO cs50 (val) VALUES('baz')")) 42 | print(db.execute("SELECT * FROM cs50")) 43 | try: 44 | print(db.execute("INSERT INTO cs50 (id, val) VALUES(1, 'bar')")) 45 | except Exception as e: 46 | print(e) 47 | pass 48 | print(db.execute("INSERT INTO cs50 (val) VALUES('qux')")) 49 | #print(db.execute("DELETE FROM cs50")) 50 | 51 | """ 52 | -------------------------------------------------------------------------------- /tests/mysql.py: -------------------------------------------------------------------------------- 1 | import sys 2 | 3 | sys.path.insert(0, "../src") 4 | 5 | from cs50 import SQL 6 | 7 | db = SQL("mysql://root@localhost/test") 8 | db.execute("SELECT 1") 9 | -------------------------------------------------------------------------------- /tests/python.py: -------------------------------------------------------------------------------- 1 | import sys 2 | 3 | sys.path.insert(0, "../src") 4 | 5 | import cs50 6 | 7 | i = cs50.get_int("Input: ") 8 | print(f"Output: {i}") 9 | -------------------------------------------------------------------------------- /tests/redirect/application.py: -------------------------------------------------------------------------------- 1 | import cs50 2 | from flask import Flask, redirect, render_template 3 | 4 | app = Flask(__name__) 5 | 6 | @app.route("/") 7 | def index(): 8 | return redirect("/foo") 9 | 10 | @app.route("/foo") 11 | def foo(): 12 | return render_template("foo.html") 13 | -------------------------------------------------------------------------------- /tests/redirect/templates/foo.html: -------------------------------------------------------------------------------- 1 | foo 2 | -------------------------------------------------------------------------------- /tests/sql.py: -------------------------------------------------------------------------------- 1 | import logging 2 | import os 3 | import sys 4 | import unittest 5 | import warnings 6 | 7 | sys.path.insert(0, "../src") 8 | 9 | from cs50.sql import SQL 10 | 11 | 12 | class SQLTests(unittest.TestCase): 13 | 14 | def test_multiple_statements(self): 15 | self.assertRaises(RuntimeError, self.db.execute, "INSERT INTO cs50(val) VALUES('baz'); INSERT INTO cs50(val) VALUES('qux')") 16 | 17 | def test_delete_returns_affected_rows(self): 18 | rows = [ 19 | {"id": 1, "val": "foo"}, 20 | {"id": 2, "val": "bar"}, 21 | {"id": 3, "val": "baz"} 22 | ] 23 | for row in rows: 24 | self.db.execute("INSERT INTO cs50(val) VALUES(:val);", val=row["val"]) 25 | self.assertEqual(self.db.execute("DELETE FROM cs50 WHERE id = :id", id=rows[0]["id"]), 1) 26 | self.assertEqual(self.db.execute("DELETE FROM cs50 WHERE id = :a or id = :b", a=rows[1]["id"], b=rows[2]["id"]), 2) 27 | self.assertEqual(self.db.execute("DELETE FROM cs50 WHERE id = -50"), 0) 28 | 29 | def test_insert_returns_last_row_id(self): 30 | self.assertEqual(self.db.execute("INSERT INTO cs50(val) VALUES('foo')"), 1) 31 | self.assertEqual(self.db.execute("INSERT INTO cs50(val) VALUES('bar')"), 2) 32 | 33 | def test_select_all(self): 34 | self.assertEqual(self.db.execute("SELECT * FROM cs50"), []) 35 | 36 | rows = [ 37 | {"id": 1, "val": "foo", "bin": None}, 38 | {"id": 2, "val": "bar", "bin": None}, 39 | {"id": 3, "val": "baz", "bin": None} 40 | ] 41 | for row in rows: 42 | self.db.execute("INSERT INTO cs50(val) VALUES(:val)", val=row["val"]) 43 | 44 | self.assertEqual(self.db.execute("SELECT * FROM cs50"), rows) 45 | 46 | def test_select_cols(self): 47 | rows = [ 48 | {"val": "foo"}, 49 | {"val": "bar"}, 50 | {"val": "baz"} 51 | ] 52 | for row in rows: 53 | self.db.execute("INSERT INTO cs50(val) VALUES(:val)", val=row["val"]) 54 | 55 | self.assertEqual(self.db.execute("SELECT val FROM cs50"), rows) 56 | 57 | def test_select_where(self): 58 | rows = [ 59 | {"id": 1, "val": "foo"}, 60 | {"id": 2, "val": "bar"}, 61 | {"id": 3, "val": "baz"} 62 | ] 63 | for row in rows: 64 | self.db.execute("INSERT INTO cs50(val) VALUES(:val)", val=row["val"]) 65 | 66 | self.assertEqual(self.db.execute("SELECT id, val FROM cs50 WHERE id = :id OR val = :val", id=rows[1]["id"], val=rows[2]["val"]), rows[1:3]) 67 | 68 | def test_select_with_comments(self): 69 | self.assertEqual(self.db.execute("--comment\nSELECT * FROM cs50;\n--comment"), []) 70 | 71 | def test_select_with_semicolon(self): 72 | self.assertEqual(self.db.execute("SELECT * FROM cs50;\n--comment"), []) 73 | 74 | def test_select_with_comments(self): 75 | self.assertEqual(self.db.execute("--comment\nSELECT * FROM cs50;\n--comment"), []) 76 | 77 | def test_select_with_semicolon(self): 78 | self.assertEqual(self.db.execute("SELECT * FROM cs50;\n--comment"), []) 79 | 80 | def test_update_returns_affected_rows(self): 81 | rows = [ 82 | {"id": 1, "val": "foo"}, 83 | {"id": 2, "val": "bar"}, 84 | {"id": 3, "val": "baz"} 85 | ] 86 | for row in rows: 87 | self.db.execute("INSERT INTO cs50(val) VALUES(:val)", val=row["val"]) 88 | 89 | self.assertEqual(self.db.execute("UPDATE cs50 SET val = 'foo' WHERE id > 1"), 2) 90 | self.assertEqual(self.db.execute("UPDATE cs50 SET val = 'foo' WHERE id = -50"), 0) 91 | 92 | def test_string_literal_with_colon(self): 93 | rows = [ 94 | {"id": 1, "val": ":foo"}, 95 | {"id": 2, "val": "foo:bar"}, 96 | {"id": 3, "val": " :baz"}, 97 | {"id": 3, "val": ":bar :baz"}, 98 | {"id": 3, "val": " :bar :baz"} 99 | ] 100 | for row in rows: 101 | self.db.execute("INSERT INTO cs50(val) VALUES(:val)", val=row["val"]) 102 | 103 | self.assertEqual(self.db.execute("SELECT val FROM cs50 WHERE val = ':foo'"), [{"val": ":foo"}]) 104 | self.assertEqual(self.db.execute("SELECT val FROM cs50 WHERE val = ':bar'"), []) 105 | self.assertEqual(self.db.execute("SELECT val FROM cs50 WHERE val = 'foo:bar'"), [{"val": "foo:bar"}]) 106 | self.assertEqual(self.db.execute("SELECT val FROM cs50 WHERE val = ' :baz'"), [{"val": " :baz"}]) 107 | self.assertEqual(self.db.execute("SELECT val FROM cs50 WHERE val = ':bar :baz'"), [{"val": ":bar :baz"}]) 108 | self.assertEqual(self.db.execute("SELECT val FROM cs50 WHERE val = ' :bar :baz'"), [{"val": " :bar :baz"}]) 109 | 110 | def test_blob(self): 111 | rows = [ 112 | {"id": 1, "bin": b"\0"}, 113 | {"id": 2, "bin": b"\1"}, 114 | {"id": 3, "bin": b"\2"} 115 | ] 116 | for row in rows: 117 | self.db.execute("INSERT INTO cs50(bin) VALUES(:bin)", bin=row["bin"]) 118 | self.assertEqual(self.db.execute("SELECT id, bin FROM cs50"), rows) 119 | 120 | def test_commit(self): 121 | self.db.execute("BEGIN") 122 | self.db.execute("INSERT INTO cs50 (val) VALUES('foo')") 123 | self.db.execute("COMMIT") 124 | self.assertEqual(self.db.execute("SELECT val FROM cs50"), [{"val": "foo"}]) 125 | 126 | def test_rollback(self): 127 | self.db.execute("BEGIN") 128 | self.db.execute("INSERT INTO cs50 (val) VALUES('foo')") 129 | self.db.execute("INSERT INTO cs50 (val) VALUES('bar')") 130 | self.db.execute("ROLLBACK") 131 | self.assertEqual(self.db.execute("SELECT val FROM cs50"), []) 132 | 133 | def test_identifier_case(self): 134 | self.assertIn("count", self.db.execute("SELECT 1 AS count")[0]) 135 | 136 | def test_lastrowid(self): 137 | self.db.execute("CREATE TABLE foo(id SERIAL PRIMARY KEY, firstname TEXT, lastname TEXT)") 138 | self.assertEqual(self.db.execute("INSERT INTO foo (firstname, lastname) VALUES('firstname', 'lastname')"), 1) 139 | self.assertRaises(ValueError, self.db.execute, "INSERT INTO foo (id, firstname, lastname) VALUES(1, 'firstname', 'lastname')") 140 | 141 | def test_url(self): 142 | url = "https://www.amazon.es/Desesperaci%C3%B3n-BEST-SELLER-Stephen-King/dp/8497595890" 143 | self.db.execute("CREATE TABLE foo(id SERIAL PRIMARY KEY, url TEXT)") 144 | self.db.execute("INSERT INTO foo (url) VALUES(?)", url) 145 | self.assertEqual(self.db.execute("SELECT url FROM foo")[0]["url"], url) 146 | 147 | def tearDown(self): 148 | self.db.execute("DROP TABLE cs50") 149 | self.db.execute("DROP TABLE IF EXISTS foo") 150 | self.db.execute("DROP TABLE IF EXISTS bar") 151 | 152 | @classmethod 153 | def tearDownClass(self): 154 | try: 155 | self.db.execute("DROP TABLE IF EXISTS cs50") 156 | except Warning as e: 157 | # suppress "unknown table" 158 | if not str(e).startswith("(1051"): 159 | raise e 160 | 161 | 162 | class MySQLTests(SQLTests): 163 | @classmethod 164 | def setUpClass(self): 165 | self.db = SQL(f"mysql://root@{os.getenv('MYSQL_HOST')}/test") 166 | 167 | def setUp(self): 168 | self.db.execute("CREATE TABLE IF NOT EXISTS cs50 (id INTEGER NOT NULL AUTO_INCREMENT, val VARCHAR(16), bin BLOB, PRIMARY KEY (id))") 169 | self.db.execute("DELETE FROM cs50") 170 | 171 | 172 | class PostgresTests(SQLTests): 173 | @classmethod 174 | def setUpClass(self): 175 | self.db = SQL(f"postgresql://postgres:postgres@{os.getenv('POSTGRESQL_HOST')}/test") 176 | 177 | def setUp(self): 178 | self.db.execute("CREATE TABLE IF NOT EXISTS cs50 (id SERIAL PRIMARY KEY, val VARCHAR(16), bin BYTEA)") 179 | self.db.execute("DELETE FROM cs50") 180 | 181 | 182 | def test_cte(self): 183 | self.assertEqual(self.db.execute("WITH foo AS ( SELECT 1 AS bar ) SELECT bar FROM foo"), [{"bar": 1}]) 184 | 185 | 186 | class SQLiteTests(SQLTests): 187 | 188 | @classmethod 189 | def setUpClass(self): 190 | open("test.db", "w").close() 191 | self.db = SQL("sqlite:///test.db") 192 | 193 | def setUp(self): 194 | self.db.execute("CREATE TABLE IF NOT EXISTS cs50 (id INTEGER PRIMARY KEY, val TEXT, bin BLOB)") 195 | self.db.execute("DELETE FROM cs50") 196 | 197 | def test_lastrowid(self): 198 | self.db.execute("CREATE TABLE foo(id INTEGER PRIMARY KEY AUTOINCREMENT, firstname TEXT, lastname TEXT)") 199 | self.assertEqual(self.db.execute("INSERT INTO foo (firstname, lastname) VALUES('firstname', 'lastname')"), 1) 200 | self.assertRaises(ValueError, self.db.execute, "INSERT INTO foo (id, firstname, lastname) VALUES(1, 'firstname', 'lastname')") 201 | self.assertEqual(self.db.execute("INSERT OR IGNORE INTO foo (id, firstname, lastname) VALUES(1, 'firstname', 'lastname')"), None) 202 | 203 | def test_integrity_constraints(self): 204 | self.db.execute("CREATE TABLE foo(id INTEGER PRIMARY KEY)") 205 | self.assertEqual(self.db.execute("INSERT INTO foo VALUES(1)"), 1) 206 | self.assertRaises(ValueError, self.db.execute, "INSERT INTO foo VALUES(1)") 207 | 208 | def test_foreign_key_support(self): 209 | self.db.execute("CREATE TABLE foo(id INTEGER PRIMARY KEY)") 210 | self.db.execute("CREATE TABLE bar(foo_id INTEGER, FOREIGN KEY (foo_id) REFERENCES foo(id))") 211 | self.assertRaises(ValueError, self.db.execute, "INSERT INTO bar VALUES(50)") 212 | 213 | def test_qmark(self): 214 | self.db.execute("CREATE TABLE foo (firstname STRING, lastname STRING)") 215 | 216 | self.db.execute("INSERT INTO foo VALUES (?, 'bar')", "baz") 217 | self.assertEqual(self.db.execute("SELECT * FROM foo"), [{"firstname": "baz", "lastname": "bar"}]) 218 | self.db.execute("DELETE FROM foo") 219 | 220 | self.db.execute("INSERT INTO foo VALUES ('bar', ?)", "baz") 221 | self.assertEqual(self.db.execute("SELECT * FROM foo"), [{"firstname": "bar", "lastname": "baz"}]) 222 | self.db.execute("DELETE FROM foo") 223 | 224 | self.db.execute("INSERT INTO foo VALUES (?, ?)", "bar", "baz") 225 | self.assertEqual(self.db.execute("SELECT * FROM foo"), [{"firstname": "bar", "lastname": "baz"}]) 226 | 227 | self.db.execute("INSERT INTO foo VALUES ('qux', 'quux')") 228 | self.assertEqual(self.db.execute("SELECT * FROM foo WHERE firstname = ?", 'qux'), [{"firstname": "qux", "lastname": "quux"}]) 229 | self.assertEqual(self.db.execute("SELECT * FROM foo WHERE firstname = ? AND lastname = ?", "qux", "quux"), [{"firstname": "qux", "lastname": "quux"}]) 230 | self.db.execute("DELETE FROM foo") 231 | 232 | self.db.execute("INSERT INTO foo VALUES (?)", ("bar", "baz")) 233 | self.assertEqual(self.db.execute("SELECT * FROM foo"), [{"firstname": "bar", "lastname": "baz"}]) 234 | self.db.execute("DELETE FROM foo") 235 | 236 | self.db.execute("INSERT INTO foo VALUES (?)", ["bar", "baz"]) 237 | self.assertEqual(self.db.execute("SELECT * FROM foo"), [{"firstname": "bar", "lastname": "baz"}]) 238 | self.db.execute("DELETE FROM foo") 239 | 240 | self.db.execute("INSERT INTO foo VALUES (?,?)", "bar", "baz") 241 | self.assertEqual(self.db.execute("SELECT * FROM foo"), [{"firstname": "bar", "lastname": "baz"}]) 242 | self.db.execute("DELETE FROM foo") 243 | 244 | self.db.execute("CREATE TABLE bar (firstname STRING)") 245 | 246 | self.db.execute("INSERT INTO bar VALUES (?)", "baz") 247 | self.assertEqual(self.db.execute("SELECT * FROM bar"), [{"firstname": "baz"}]) 248 | self.db.execute("DELETE FROM bar") 249 | 250 | self.db.execute("INSERT INTO bar VALUES (?)", "baz") 251 | self.db.execute("INSERT INTO bar VALUES (?)", "qux") 252 | self.assertEqual(self.db.execute("SELECT * FROM bar WHERE firstname IN (?)", ("baz", "qux")), [{"firstname": "baz"}, {"firstname": "qux"}]) 253 | self.db.execute("DELETE FROM bar") 254 | 255 | self.db.execute("INSERT INTO bar VALUES (?)", "baz") 256 | self.db.execute("INSERT INTO bar VALUES (?)", "qux") 257 | self.assertEqual(self.db.execute("SELECT * FROM bar WHERE firstname IN (?)", ["baz", "qux"]), [{"firstname": "baz"}, {"firstname": "qux"}]) 258 | self.db.execute("DELETE FROM bar") 259 | 260 | self.assertRaises(RuntimeError, self.db.execute, "INSERT INTO foo VALUES (?)") 261 | self.assertRaises(RuntimeError, self.db.execute, "INSERT INTO foo VALUES (?, ?)") 262 | self.assertRaises(RuntimeError, self.db.execute, "INSERT INTO foo VALUES (?, ?)", 'bar', 'baz', 'qux') 263 | self.assertRaises(RuntimeError, self.db.execute, "INSERT INTO foo VALUES (?, ?)", ('bar', 'baz', 'qux')) 264 | self.assertRaises(RuntimeError, self.db.execute, "INSERT INTO foo VALUES (?, ?)", ['bar', 'baz', 'qux']) 265 | self.assertRaises(RuntimeError, self.db.execute, "INSERT INTO foo VALUES (?, ?)", 'bar', baz='baz') 266 | 267 | def test_named(self): 268 | self.db.execute("CREATE TABLE foo (firstname STRING, lastname STRING)") 269 | 270 | self.db.execute("INSERT INTO foo VALUES (:baz, 'bar')", baz="baz") 271 | self.assertEqual(self.db.execute("SELECT * FROM foo"), [{"firstname": "baz", "lastname": "bar"}]) 272 | self.db.execute("DELETE FROM foo") 273 | 274 | self.db.execute("INSERT INTO foo VALUES ('bar', :baz)", baz="baz") 275 | self.assertEqual(self.db.execute("SELECT * FROM foo"), [{"firstname": "bar", "lastname": "baz"}]) 276 | self.db.execute("DELETE FROM foo") 277 | 278 | self.db.execute("INSERT INTO foo VALUES (:bar, :baz)", bar="bar", baz="baz") 279 | self.assertEqual(self.db.execute("SELECT * FROM foo"), [{"firstname": "bar", "lastname": "baz"}]) 280 | 281 | self.db.execute("INSERT INTO foo VALUES ('qux', 'quux')") 282 | self.assertEqual(self.db.execute("SELECT * FROM foo WHERE firstname = :qux", qux='qux'), [{"firstname": "qux", "lastname": "quux"}]) 283 | self.assertEqual(self.db.execute("SELECT * FROM foo WHERE firstname = :qux AND lastname = :quux", qux="qux", quux="quux"), [{"firstname": "qux", "lastname": "quux"}]) 284 | self.db.execute("DELETE FROM foo") 285 | 286 | self.db.execute("INSERT INTO foo VALUES (:bar,:baz)", bar="bar", baz="baz") 287 | self.assertEqual(self.db.execute("SELECT * FROM foo"), [{"firstname": "bar", "lastname": "baz"}]) 288 | self.db.execute("DELETE FROM foo") 289 | 290 | self.db.execute("CREATE TABLE bar (firstname STRING)") 291 | self.db.execute("INSERT INTO bar VALUES (:baz)", baz="baz") 292 | self.assertEqual(self.db.execute("SELECT * FROM bar"), [{"firstname": "baz"}]) 293 | 294 | self.assertRaises(RuntimeError, self.db.execute, "INSERT INTO foo VALUES (:bar)") 295 | self.assertRaises(RuntimeError, self.db.execute, "INSERT INTO foo VALUES (:bar, :baz)") 296 | self.assertRaises(RuntimeError, self.db.execute, "INSERT INTO foo VALUES (:bar, :baz)", bar='bar', baz='baz', qux='qux') 297 | self.assertRaises(RuntimeError, self.db.execute, "INSERT INTO foo VALUES (:bar, :baz)", 'baz', bar='bar') 298 | 299 | 300 | def test_numeric(self): 301 | self.db.execute("CREATE TABLE foo (firstname STRING, lastname STRING)") 302 | 303 | self.db.execute("INSERT INTO foo VALUES (:1, 'bar')", "baz") 304 | self.assertEqual(self.db.execute("SELECT * FROM foo"), [{"firstname": "baz", "lastname": "bar"}]) 305 | self.db.execute("DELETE FROM foo") 306 | 307 | self.db.execute("INSERT INTO foo VALUES ('bar', :1)", "baz") 308 | self.assertEqual(self.db.execute("SELECT * FROM foo"), [{"firstname": "bar", "lastname": "baz"}]) 309 | self.db.execute("DELETE FROM foo") 310 | 311 | self.db.execute("INSERT INTO foo VALUES (:1, :2)", "bar", "baz") 312 | self.assertEqual(self.db.execute("SELECT * FROM foo"), [{"firstname": "bar", "lastname": "baz"}]) 313 | 314 | self.db.execute("INSERT INTO foo VALUES ('qux', 'quux')") 315 | self.assertEqual(self.db.execute("SELECT * FROM foo WHERE firstname = :1", 'qux'), [{"firstname": "qux", "lastname": "quux"}]) 316 | self.assertEqual(self.db.execute("SELECT * FROM foo WHERE firstname = :1 AND lastname = :2", "qux", "quux"), [{"firstname": "qux", "lastname": "quux"}]) 317 | self.db.execute("DELETE FROM foo") 318 | 319 | self.db.execute("INSERT INTO foo VALUES (:1,:2)", "bar", "baz") 320 | self.assertEqual(self.db.execute("SELECT * FROM foo"), [{"firstname": "bar", "lastname": "baz"}]) 321 | self.db.execute("DELETE FROM foo") 322 | 323 | self.db.execute("CREATE TABLE bar (firstname STRING)") 324 | self.db.execute("INSERT INTO bar VALUES (:1)", "baz") 325 | self.assertEqual(self.db.execute("SELECT * FROM bar"), [{"firstname": "baz"}]) 326 | 327 | self.assertRaises(RuntimeError, self.db.execute, "INSERT INTO foo VALUES (:1)") 328 | self.assertRaises(RuntimeError, self.db.execute, "INSERT INTO foo VALUES (:1, :2)") 329 | self.assertRaises(RuntimeError, self.db.execute, "INSERT INTO foo VALUES (:1, :2)", 'bar', 'baz', 'qux') 330 | self.assertRaises(RuntimeError, self.db.execute, "INSERT INTO foo VALUES (:1, :2)", 'bar', baz='baz') 331 | 332 | def test_cte(self): 333 | self.assertEqual(self.db.execute("WITH foo AS ( SELECT 1 AS bar ) SELECT bar FROM foo"), [{"bar": 1}]) 334 | 335 | 336 | if __name__ == "__main__": 337 | suite = unittest.TestSuite([ 338 | unittest.TestLoader().loadTestsFromTestCase(SQLiteTests), 339 | unittest.TestLoader().loadTestsFromTestCase(MySQLTests), 340 | unittest.TestLoader().loadTestsFromTestCase(PostgresTests) 341 | ]) 342 | 343 | logging.getLogger("cs50").disabled = True 344 | sys.exit(not unittest.TextTestRunner(verbosity=2).run(suite).wasSuccessful()) 345 | -------------------------------------------------------------------------------- /tests/sqlite.py: -------------------------------------------------------------------------------- 1 | import logging 2 | import sys 3 | 4 | sys.path.insert(0, "../src") 5 | 6 | from cs50 import SQL 7 | 8 | logging.getLogger("cs50").disabled = False 9 | 10 | db = SQL("sqlite:///sqlite.db") 11 | db.execute("SELECT 1") 12 | 13 | # TODO 14 | #db.execute("SELECT * FROM Employee WHERE FirstName = ?", b'\x00') 15 | 16 | db.execute("SELECT * FROM Employee WHERE FirstName = ?", "' OR 1 = 1") 17 | 18 | db.execute("SELECT * FROM Employee WHERE FirstName IN (?)", "Andrew") 19 | db.execute("SELECT * FROM Employee WHERE FirstName IN (?)", ["Andrew"]) 20 | db.execute("SELECT * FROM Employee WHERE FirstName IN (?)", ("Andrew",)) 21 | db.execute("SELECT * FROM Employee WHERE FirstName IN (?)", ["Andrew", "Nancy"]) 22 | db.execute("SELECT * FROM Employee WHERE FirstName IN (?)", ("Andrew", "Nancy")) 23 | db.execute("SELECT * FROM Employee WHERE FirstName IN (?)", []) 24 | db.execute("SELECT * FROM Employee WHERE FirstName IN (?)", ()) 25 | 26 | db.execute("SELECT * FROM Employee WHERE FirstName = ? AND LastName = ?", "Andrew", "Adams") 27 | db.execute("SELECT * FROM Employee WHERE FirstName = ? AND LastName = ?", ["Andrew", "Adams"]) 28 | db.execute("SELECT * FROM Employee WHERE FirstName = ? AND LastName = ?", ("Andrew", "Adams")) 29 | 30 | db.execute("SELECT * FROM Employee WHERE FirstName = :1 AND LastName = :2", "Andrew", "Adams") 31 | db.execute("SELECT * FROM Employee WHERE FirstName = :1 AND LastName = :2", ["Andrew", "Adams"]) 32 | db.execute("SELECT * FROM Employee WHERE FirstName = :1 AND LastName = :2", ("Andrew", "Adams")) 33 | 34 | db.execute("SELECT * FROM Employee WHERE FirstName = ':Andrew :Adams'") 35 | 36 | db.execute("SELECT * FROM Employee WHERE FirstName = :first AND LastName = :last", first="Andrew", last="Adams") 37 | db.execute("SELECT * FROM Employee WHERE FirstName = :first AND LastName = :last", {"first": "Andrew", "last": "Adams"}) 38 | 39 | db.execute("SELECT * FROM Employee WHERE FirstName = %s AND LastName = %s", "Andrew", "Adams") 40 | db.execute("SELECT * FROM Employee WHERE FirstName = %s AND LastName = %s", ["Andrew", "Adams"]) 41 | db.execute("SELECT * FROM Employee WHERE FirstName = %s AND LastName = %s", ("Andrew", "Adams")) 42 | 43 | db.execute("SELECT * FROM Employee WHERE FirstName = %(first)s AND LastName = %(last)s", first="Andrew", last="Adams") 44 | db.execute("SELECT * FROM Employee WHERE FirstName = %(first)s AND LastName = %(last)s", {"first": "Andrew", "last": "Adams"}) 45 | -------------------------------------------------------------------------------- /tests/tb.py: -------------------------------------------------------------------------------- 1 | import sys 2 | 3 | sys.path.insert(0, "../src") 4 | 5 | import cs50 6 | import requests 7 | 8 | def f(): 9 | res = requests.get("cs50.harvard.edu") 10 | f() 11 | --------------------------------------------------------------------------------