├── .gitignore ├── .travis.yml ├── LICENSE ├── README.rst ├── examples └── flask │ ├── .gitignore │ ├── README.md │ ├── flask-example.py │ ├── requirements.txt │ ├── static │ └── code.css │ └── templates │ └── index.html ├── jinja2_highlight ├── __init__.py └── highlight.py ├── setup.py └── tests ├── __init__.py └── test_highlight.py /.gitignore: -------------------------------------------------------------------------------- 1 | *.pyc 2 | *.swp 3 | build/ 4 | dist/ 5 | jinja2_highlight.egg-info/ 6 | .idea 7 | *.iml 8 | -------------------------------------------------------------------------------- /.travis.yml: -------------------------------------------------------------------------------- 1 | language: python 2 | python: 3 | - "2.7" 4 | - "3.3" 5 | install: 6 | - "python setup.py install" 7 | email: 8 | on_success: change 9 | on_failure: change 10 | branches: 11 | only: 12 | - master 13 | - development 14 | script: 15 | - "python -m unittest discover" 16 | -------------------------------------------------------------------------------- /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.rst: -------------------------------------------------------------------------------- 1 | jinja2-highlight 2 | ################ 3 | 4 | About 5 | ===== 6 | 7 | A simple Jinja2 extension that uses Pygments to highlight code blocks. 8 | 9 | 10 | .. image:: https://travis-ci.org/tlatsas/jinja2-highlight.svg?branch=master 11 | :target: https://travis-ci.org/tlatsas/jinja2-highlight 12 | 13 | 14 | Source 15 | ====== 16 | 17 | Github: https://github.com/tlatsas/jinja2-highlight 18 | 19 | Pypi: http://pypi.python.org/pypi/jinja2-highlight 20 | 21 | 22 | Requirements 23 | ============ 24 | 25 | * Jinja2 >= 2.4 26 | * Pygments >= 1.5 27 | 28 | 29 | Highlight examples 30 | ================= 31 | :: 32 | 33 | {% highlight 'language' %} 34 | your-awesome-code-here 35 | {% endhighlight %} 36 | 37 | Replace `language` with the appropriate Pygments lexer short name: http://pygments.org/docs/lexers/ 38 | 39 | Line numbering can be turned on using `lineno='inline'` or `lineno='table'` depending on the style of line numbering you want (as per Pygment's documentation: http://pygments.org/docs/formatters/#HtmlFormatter) 40 | 41 | :: 42 | 43 | {% highlight 'language', lineno='inline' %} 44 | your-awesome-code-here 45 | {% endhighlight %} 46 | 47 | This can also be used without a language setting 48 | 49 | :: 50 | 51 | {% highlight lineno='table' %} 52 | your-awesome-code-here 53 | {% endhighlight %} 54 | 55 | Optional settings 56 | ================ 57 | 58 | By default Pygments renders the code block inside a div with the class 'highlight', if you want to change the name you can set the environment variable `jinja2_highlight_cssclass` to the class name you would like. 59 | 60 | In jinja this can be done after you've created your environment; 61 | :: 62 | 63 | env = Environment(extensions=['jinja2_highlight.HighlightExtension']) 64 | # Set the css class name to 'codehilite' 65 | env.extend(jinja2_highlight_cssclass = 'codehilite') 66 | 67 | In Flask this can be done with the following (after creating your app): 68 | :: 69 | 70 | app.jinja_env.extend(jinja2_highlight_cssclass = 'codehilite') 71 | 72 | 73 | 74 | Using with Flask 75 | ================ 76 | 77 | See the example at: https://github.com/tlatsas/jinja2-highlight/tree/master/examples/flask 78 | 79 | -------------------------------------------------------------------------------- /examples/flask/.gitignore: -------------------------------------------------------------------------------- 1 | venv/ 2 | -------------------------------------------------------------------------------- /examples/flask/README.md: -------------------------------------------------------------------------------- 1 | Running the Flask example 2 | ------------------------- 3 | 4 | Navigate in `jinja2-highlight/examples/flask` and create the python virtual environment using `virtualenv`: 5 | 6 | $ virtualenv venv --distribute 7 | 8 | Then activate it: 9 | 10 | $ source venv/bin/activate 11 | 12 | Install dependencies using pip: 13 | 14 | $ pip install -r requirements.txt 15 | 16 | Run: 17 | 18 | $ python flask-example.py 19 | 20 | View: 21 | 22 | Navigate to http://0.0.0.0:8080/ 23 | 24 | -------------------------------------------------------------------------------- /examples/flask/flask-example.py: -------------------------------------------------------------------------------- 1 | # -*- coding: utf-8 -*- 2 | from flask import Flask, render_template, url_for 3 | from flask.helpers import locked_cached_property 4 | import jinja2_highlight 5 | 6 | class MyFlask(Flask): 7 | jinja_options = dict(Flask.jinja_options) 8 | jinja_options.setdefault('extensions', 9 | []).append('jinja2_highlight.HighlightExtension') 10 | 11 | # If you'd like to set the class name of the div code blocks are rendered in 12 | # Uncomment the below lines otherwise the option below can be used 13 | #@locked_cached_property 14 | #def jinja_env(self): 15 | # jinja_env = self.create_jinja_environment() 16 | # jinja_env.extend(jinja2_highlight_cssclass = 'codehilite') 17 | # return jinja_env 18 | 19 | app = MyFlask(__name__) 20 | 21 | # The second way to set the cssclass name for jinja2_highlight 22 | #app.jinja_env.extend(jinja2_highlight_cssclass = 'codehilite') 23 | 24 | @app.route('/') 25 | def index(): 26 | return render_template('index.html') 27 | 28 | if __name__ == '__main__': 29 | app.run('0.0.0.0', 8080, debug=True) 30 | -------------------------------------------------------------------------------- /examples/flask/requirements.txt: -------------------------------------------------------------------------------- 1 | Flask==0.9 2 | Jinja2==2.6 3 | Pygments==1.5 4 | Werkzeug==0.8.3 5 | distribute==0.6.24 6 | jinja2-highlight==0.2.2 7 | wsgiref==0.1.2 8 | -------------------------------------------------------------------------------- /examples/flask/static/code.css: -------------------------------------------------------------------------------- 1 | /* railcasts.css 2 | * https://github.com/uraimo/pygments-vimstyles/blob/2a99e97f6383d1b978917ff42f9ecdd6b2f021c0/railscasts.css 3 | */ 4 | 5 | .highlight { background: #2B2B2B; color: #E6E1DC} 6 | .highlight .hll { background-color: #ffffcc } 7 | .highlight .c { color: #BC9458; font-style: italic} /* Comment */ 8 | .highlight .err { color: #E6E1DC} /* Error */ 9 | .highlight .g { color: #E6E1DC} /* Generic */ 10 | .highlight .k { color: #CC7833} /* Keyword */ 11 | .highlight .l { color: #E6E1DC} /* Literal */ 12 | .highlight .n { color: #E6E1DC} /* Name */ 13 | .highlight .o { color: #E6E1DC} /* Operator */ 14 | .highlight .x { color: #E6E1DC} /* Other */ 15 | .highlight .p { color: #E6E1DC} /* Punctuation */ 16 | .highlight .cm { color: #BC9458; font-style: italic} /* Comment.Multiline */ 17 | .highlight .cp { color: #CC7833} /* Comment.Preproc */ 18 | .highlight .c1 { color: #BC9458; font-style: italic} /* Comment.Single */ 19 | .highlight .cs { color: #BC9458; font-style: italic} /* Comment.Special */ 20 | .highlight .gd { color: #E6E1DC; background-color: #660000 } /* Generic.Deleted */ 21 | .highlight .ge { color: #E6E1DC} /* Generic.Emph */ 22 | .highlight .gr { color: #FFFFFF; background-color: #990000 } /* Generic.Error */ 23 | .highlight .gh { color: #FFFFFF} /* Generic.Heading */ 24 | .highlight .gi { color: #E6E1DC; background-color: #144212 } /* Generic.Inserted */ 25 | .highlight .go { color: #E6E1DC} /* Generic.Output */ 26 | .highlight .gp { color: #E6E1DC} /* Generic.Prompt */ 27 | .highlight .gs { color: #E6E1DC} /* Generic.Strong */ 28 | .highlight .gu { color: #FFFFFF} /* Generic.Subheading */ 29 | .highlight .gt { color: #E6E1DC} /* Generic.Traceback */ 30 | .highlight .kc { color: #CC7833} /* Keyword.Constant */ 31 | .highlight .kd { color: #CC7833} /* Keyword.Declaration */ 32 | .highlight .kn { color: #CC7833} /* Keyword.Namespace */ 33 | .highlight .kp { color: #CC7833} /* Keyword.Pseudo */ 34 | .highlight .kr { color: #CC7833} /* Keyword.Reserved */ 35 | .highlight .kt { color: #DA4939} /* Keyword.Type */ 36 | .highlight .ld { color: #E6E1DC} /* Literal.Date */ 37 | .highlight .m { color: #A5C261} /* Literal.Number */ 38 | .highlight .s { color: #A5C261} /* Literal.String */ 39 | .highlight .na { color: #FFC66D} /* Name.Attribute */ 40 | .highlight .nb { color: #E6E1DC} /* Name.Builtin */ 41 | .highlight .nc { color: #E6E1DC} /* Name.Class */ 42 | .highlight .no { color: #6D9CBE} /* Name.Constant */ 43 | .highlight .nd { color: #E6E1DC} /* Name.Decorator */ 44 | .highlight .ni { color: #E6E1DC} /* Name.Entity */ 45 | .highlight .ne { color: #E6E1DC} /* Name.Exception */ 46 | .highlight .nf { color: #FFC66D} /* Name.Function */ 47 | .highlight .nl { color: #E6E1DC} /* Name.Label */ 48 | .highlight .nn { color: #E6E1DC} /* Name.Namespace */ 49 | .highlight .nx { color: #E6E1DC} /* Name.Other */ 50 | .highlight .py { color: #E6E1DC} /* Name.Property */ 51 | .highlight .nt { color: #CC7833} /* Name.Tag */ 52 | .highlight .nv { color: #D0D0FF} /* Name.Variable */ 53 | .highlight .ow { color: #E6E1DC} /* Operator.Word */ 54 | .highlight .w { color: #E6E1DC} /* Text.Whitespace */ 55 | .highlight .mf { color: #A5C261} /* Literal.Number.Float */ 56 | .highlight .mh { color: #A5C261} /* Literal.Number.Hex */ 57 | .highlight .mi { color: #A5C261} /* Literal.Number.Integer */ 58 | .highlight .mo { color: #A5C261} /* Literal.Number.Oct */ 59 | .highlight .sb { color: #A5C261} /* Literal.String.Backtick */ 60 | .highlight .sc { color: #A5C261} /* Literal.String.Char */ 61 | .highlight .sd { color: #A5C261} /* Literal.String.Doc */ 62 | .highlight .s2 { color: #A5C261} /* Literal.String.Double */ 63 | .highlight .se { color: #A5C261} /* Literal.String.Escape */ 64 | .highlight .sh { color: #A5C261} /* Literal.String.Heredoc */ 65 | .highlight .si { color: #A5C261} /* Literal.String.Interpol */ 66 | .highlight .sx { color: #A5C261} /* Literal.String.Other */ 67 | .highlight .sr { color: #A5C261} /* Literal.String.Regex */ 68 | .highlight .s1 { color: #A5C261} /* Literal.String.Single */ 69 | .highlight .ss { color: #A5C261} /* Literal.String.Symbol */ 70 | .highlight .bp { color: #E6E1DC} /* Name.Builtin.Pseudo */ 71 | .highlight .vc { color: #D0D0FF} /* Name.Variable.Class */ 72 | .highlight .vg { color: #D0D0FF} /* Name.Variable.Global */ 73 | .highlight .vi { color: #D0D0FF} /* Name.Variable.Instance */ 74 | .highlight .il { color: #A5C261} /* Literal.Number.Integer.Long */ 75 | -------------------------------------------------------------------------------- /examples/flask/templates/index.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | 7 |
8 | Hello! The following code snippet is highlighted using jinja2-pygments. 9 |
10 |
11 | {% highlight 'python' %} 12 | from fridge import Beer 13 | 14 | glass = Beer(lt=500) 15 | glass.drink() 16 | {% endhighlight %} 17 |
18 |
19 | Here's an example with inline line numbering. 20 |
21 |
22 | {% highlight 'python', lineno='inline' %} 23 | from fridge import Beer 24 | 25 | glass = Beer(lt=500) 26 | glass.drink() 27 | {% endhighlight %} 28 |
29 |
30 | Here's an example with tabled line numbering. 31 |
32 |
33 | {% highlight 'python', lineno='table' %} 34 | from fridge import Beer 35 | 36 | glass = Beer(lt=500) 37 | glass.drink() 38 | {% endhighlight %} 39 |
40 | 41 | 42 | -------------------------------------------------------------------------------- /jinja2_highlight/__init__.py: -------------------------------------------------------------------------------- 1 | # -*- coding: utf8 -*- 2 | from .highlight import HighlightExtension 3 | -------------------------------------------------------------------------------- /jinja2_highlight/highlight.py: -------------------------------------------------------------------------------- 1 | # -*- coding: utf8 -*- 2 | 3 | import sys 4 | from jinja2 import nodes 5 | from jinja2.ext import Extension, Markup 6 | 7 | from pygments import highlight 8 | from pygments.lexers import get_lexer_by_name, guess_lexer 9 | from pygments.formatters import HtmlFormatter 10 | from pygments.util import ClassNotFound 11 | 12 | class HighlightExtension(Extension): 13 | """Highlight code blocks using Pygments. 14 | 15 | Example:: 16 | 17 | {% highlight 'python' %} 18 | 19 | from fridge import Beer 20 | 21 | pint_glass = Beer() 22 | pint_glass.drink() 23 | 24 | {% endhighlight %} 25 | 26 | Line numbers can be turned on if it is assigned. Either 'inline' or 'table' 27 | settings in Pygments can be used. 28 | 29 | {% highlight 'python', lineno='inline' %} 30 | 31 | from fridge import Beer 32 | 33 | pint_glass = Beer() 34 | pint_glass.drink() 35 | 36 | {% endhighlight %} 37 | 38 | Line numbers can also be used even if no language is assigned. 39 | {% highlight lineno='table' %} 40 | 41 | from fridge import Beer 42 | 43 | pint_glass = Beer() 44 | pint_glass.drink() 45 | 46 | {% endhighlight %} 47 | """ 48 | tags = set(['highlight']) 49 | 50 | def parse(self, parser): 51 | lineno = next(parser.stream).lineno 52 | 53 | # extract the language and line numbering setting if available 54 | if not parser.stream.current.test('block_end'): 55 | # If first up we have an assignment, e.g. lineno='inline', work with that 56 | if parser.stream.current.type == 'name': 57 | name = parser.stream.expect('name') 58 | # If the assign is lineno 59 | if name.value == 'lineno': 60 | if parser.stream.skip_if('assign'): 61 | # Assume no language and then add the assigned line number setting 62 | args = [nodes.Const(None)] 63 | args.append(parser.parse_expression()) 64 | # If it's not a lineno assignment, ignore it 65 | else: 66 | if parser.stream.skip_if('assign'): 67 | next(parser.stream) 68 | # Set our language and line number setting as None 69 | args = [nodes.Const(None), nodes.Const(None)] 70 | else: 71 | # Otherwise if our first item is not a line numbering setting, 72 | # assume it's the language setting 73 | args = [parser.parse_expression()] 74 | 75 | # If we have a comma next 76 | if parser.stream.skip_if('comma'): 77 | # Check to see if we have a lineno assignment 78 | if parser.stream.current.type == 'name': 79 | name = parser.stream.expect('name') 80 | if name.value == 'lineno': 81 | if parser.stream.skip_if('assign'): 82 | args.append(parser.parse_expression()) 83 | # If the name of the variable being assigned is not lineno 84 | # ignore it 85 | else: 86 | if parser.stream.skip_if('assign'): 87 | next(parser.stream) 88 | args.append(nodes.Const(None)) 89 | # Otherwise if there's nothing after the language, set the 90 | # line number setting as None 91 | else: 92 | args.append(nodes.Const(None)) 93 | else: 94 | # Otherwise if there are no additional arguments, set lang 95 | # and line numbering to None 96 | args = [nodes.Const(None), nodes.Const(None)] 97 | 98 | # body of the block 99 | body = parser.parse_statements(['name:endhighlight'], drop_needle=True) 100 | 101 | return nodes.CallBlock(self.call_method('_highlight', args), 102 | [], [], body).set_lineno(lineno) 103 | 104 | def _highlight(self, lang, linenos, caller=None): 105 | # highlight code using Pygments 106 | body = caller() 107 | 108 | # Check the globals to see if a cssclass setting for Pygment's HtmlFormatter 109 | # has been set 110 | try: 111 | cssclass = self.environment.jinja2_highlight_cssclass 112 | except AttributeError: 113 | cssclass = None 114 | 115 | try: 116 | if lang is None: 117 | lexer = guess_lexer(body) 118 | else: 119 | lexer = get_lexer_by_name(lang, stripall=False) 120 | except ClassNotFound as e: 121 | print(e) 122 | sys.exit(1) 123 | 124 | # Set the cssclass if we have one 125 | # The linenos setting expects either 'inline' or 'table', as per Pygment's 126 | # settings, any true value except 'inline' results in 'table'. If linenos 127 | # hasn't been assigned in parse it will be None and will result in no 128 | # line numbers 129 | if cssclass is not None: 130 | formatter = HtmlFormatter(cssclass=cssclass, linenos=linenos) 131 | else: 132 | formatter = HtmlFormatter(linenos=linenos) 133 | 134 | # If you place the tag on the line under the code, like this; 135 | # pint_glass.drink() 136 | # {% endhighlight %} 137 | # The result will have an extra blank line underneath, this can cause an extra 138 | # blank line of line numbering. 139 | # Use rstrip to remove extraneous white space 140 | code = highlight(Markup(body.rstrip()).unescape(), lexer, formatter) 141 | return code 142 | 143 | -------------------------------------------------------------------------------- /setup.py: -------------------------------------------------------------------------------- 1 | from setuptools import setup 2 | 3 | setup ( 4 | name='jinja2-highlight', 5 | version='0.6.1', 6 | description='Jinja2 extension to highlight source code using Pygments', 7 | keywords = 'syntax highlighting', 8 | author='Tasos Latsas', 9 | author_email='tlatsas2000@gmail.com', 10 | url='https://github.com/tlatsas/jinja2-highlight', 11 | license='GNU GPLv3', 12 | packages=['jinja2_highlight'], 13 | install_requires=[ 14 | 'Jinja2>=2.4', 15 | 'Pygments>=1.5' 16 | ], 17 | classifiers=[ 18 | 'Development Status :: 4 - Beta', 19 | 'Environment :: Web Environment', 20 | 'Intended Audience :: Developers', 21 | 'License :: OSI Approved :: GNU General Public License v3 (GPLv3)', 22 | 'Programming Language :: Python', 23 | 'Programming Language :: Python :: 2.7', 24 | 'Programming Language :: Python :: 3', 25 | 'Topic :: Internet :: WWW/HTTP :: Dynamic Content', 26 | 'Topic :: Software Development :: Libraries :: Python Modules', 27 | 'Topic :: Text Processing :: Markup :: HTML' 28 | ], 29 | ) 30 | -------------------------------------------------------------------------------- /tests/__init__.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/tlatsas/jinja2-highlight/b8a632833464dfecefda5c837b6f35bc1cc79a15/tests/__init__.py -------------------------------------------------------------------------------- /tests/test_highlight.py: -------------------------------------------------------------------------------- 1 | import unittest 2 | import jinja2_highlight 3 | 4 | from jinja2 import Environment 5 | 6 | 7 | class HighlightExtensionTestCase(unittest.TestCase): 8 | 9 | rendered = [ 10 | u'
',
 12 |                 u'print("Hello',
 16 |                 u'world")',
 18 |                 u'
' 19 | ] 20 | 21 | def test_python_tpl(self): 22 | env = Environment(extensions=['jinja2_highlight.HighlightExtension']) 23 | tpl = env.from_string(''' 24 | {% highlight "python" %} 25 | print("Hello world") 26 | {% endhighlight %} 27 | ''') 28 | 29 | assert tpl.render().split() == self.rendered 30 | 31 | def test_python_tpl_with_autoescape(self): 32 | # See: https://github.com/tlatsas/jinja2-highlight/pull/1 33 | env = Environment(extensions=['jinja2_highlight.HighlightExtension']) 34 | env.add_extension('jinja2.ext.autoescape') 35 | tpl = env.from_string(''' 36 | {% autoescape true %} 37 | {% highlight "python" %} 38 | print("Hello world") 39 | {% endhighlight %} 40 | {% endautoescape %} 41 | ''') 42 | 43 | assert tpl.render().split() == self.rendered 44 | 45 | inline_rendered = [ 46 | u'
'
 48 |                 u'1',
 50 |                 u'print("Hello',
 54 |                 u'world")',
 56 |                 u'
' 57 | ] 58 | 59 | def test_python_tpl_with_inline(self): 60 | env = Environment(extensions=['jinja2_highlight.HighlightExtension']) 61 | tpl = env.from_string(''' 62 | {% highlight "python", lineno="inline" %} 63 | print("Hello world") 64 | {% endhighlight %} 65 | ''') 66 | 67 | assert tpl.render().split() == self.inline_rendered 68 | 69 | table_rendered = [ 70 | u'
1
',
 76 |                 u'print("Hello',
 80 |                 u'world")',
 82 |                 u'
', 83 | u'' 84 | ] 85 | 86 | def test_python_tpl_with_table(self): 87 | env = Environment(extensions=['jinja2_highlight.HighlightExtension']) 88 | tpl = env.from_string(''' 89 | {% highlight "python", lineno="table" %} 90 | print("Hello world") 91 | {% endhighlight %} 92 | ''') 93 | 94 | assert tpl.render().split() == self.table_rendered 95 | 96 | inline_no_lang_rendered = [ 97 | u'
1',
100 |                 u'print("Hello',
104 |                 u'world")',
106 |                 u'
' 107 | ] 108 | 109 | def test_python_tpl_with_inline_no_lang(self): 110 | env = Environment(extensions=['jinja2_highlight.HighlightExtension']) 111 | tpl = env.from_string(''' 112 | {% highlight lineno="inline" %} 113 | print("Hello world") 114 | {% endhighlight %} 115 | ''') 116 | 117 | assert tpl.render().split() == self.inline_no_lang_rendered 118 | 119 | table_no_lang_rendered = [ 120 | u'
1
',
126 |                 u'print("Hello',
130 |                 u'world")',
132 |                 u'
', 133 | u'' 134 | ] 135 | 136 | def test_python_tpl_with_table_no_lang(self): 137 | env = Environment(extensions=['jinja2_highlight.HighlightExtension']) 138 | tpl = env.from_string(''' 139 | {% highlight lineno="table" %} 140 | print("Hello world") 141 | {% endhighlight %} 142 | ''') 143 | 144 | assert tpl.render().split() == self.table_no_lang_rendered 145 | 146 | cssclass_rendered = [ 147 | u'
',
149 |                 u'print("Hello',
153 |                 u'world")',
155 |                 u'
' 156 | ] 157 | 158 | def test_python_tpl_with_cssclass(self): 159 | env = Environment(extensions=['jinja2_highlight.HighlightExtension']) 160 | env.extend(jinja2_highlight_cssclass = 'codehilite') 161 | #env.globals['jinja2_highlight_cssclass'] = 'codehilite' 162 | tpl = env.from_string(''' 163 | {% highlight "python" %} 164 | print("Hello world") 165 | {% endhighlight %} 166 | ''') 167 | 168 | assert tpl.render().split() == self.cssclass_rendered 169 | --------------------------------------------------------------------------------