├── LICENSE ├── README.rst ├── ics_compare.py ├── remind.py ├── remind └── py.typed ├── setup.py └── test └── test_compare.py /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 | -------------------------------------------------------------------------------- /README.rst: -------------------------------------------------------------------------------- 1 | Python Remind library 2 | ===================== 3 | 4 | Python library to convert between `Remind `_ and iCalendar. 5 | Can be used stand alone (provided rem2ics and ics2rem tools) as well as integrated as a CalDAV client or server. 6 | 7 | Installation 8 | ------------ 9 | 10 | You need to have the Remind command line tool in version 04.00.00 or higher installed. 11 | For Debian/Ubuntu use:: 12 | 13 | $ sudo apt-get install remind 14 | 15 | Using pip 16 | ~~~~~~~~~ 17 | 18 | :: 19 | 20 | $ pip install remind 21 | 22 | This will install all Python dependencies as well. 23 | 24 | Using python-setuptools 25 | ~~~~~~~~~~~~~~~~~~~~~~~ 26 | 27 | :: 28 | 29 | $ python3 setup.py install 30 | 31 | Set up a Remind CalDAV server 32 | ----------------------------- 33 | 34 | Have a look at `radicale-remind `_ 35 | 36 | Sync to an external iCalendar server (http; cron) 37 | ------------------------------------------------- 38 | 39 | :: 40 | 41 | curl URL | ics2rem >> ~/.reminders 42 | 43 | Sync to an external CalDAV server 44 | --------------------------------- 45 | 46 | Have a look at `remind-caldav `_ 47 | 48 | Share your calendar using http 49 | ------------------------------ 50 | 51 | :: 52 | 53 | rem2ics > /var/www/html/my.ics 54 | 55 | Publish the URL and use these guides to integrate it into other calendar software: 56 | 57 | * `Thunderbird/Lightning `_ (Section: On the Network) 58 | * `Google Calendar `_ 59 | * `Apple Calendar `_ 60 | 61 | Format of the Remind MSG body 62 | ----------------------------- 63 | 64 | :: 65 | 66 | %"summary at location%" description 67 | 68 | The ``%"`` is omitted, if there is no description in the iCalendar. 69 | 70 | Support events in UTC 71 | --------------------- 72 | 73 | Remind always uses the local timezone. 74 | Use something like this to export events in UTC: 75 | 76 | :: 77 | 78 | REM Tue AT [9:00 + $MinsFromUTC] TAG rem2ics_utc MSG Event 79 | 80 | Known limitations 81 | ----------------- 82 | 83 | iCalendar -> Remind 84 | ~~~~~~~~~~~~~~~~~~~ 85 | 86 | * RECURRENCE-ID is not supported at the moment. This is a limitation of the used python-vobject library, see http://lists.skyhouseconsulting.com/pipermail/vobject/2009-September/000204.html. 87 | * Creating new calendars by adding includes to a main Remind file is not supported. 88 | 89 | Remind -> iCalendar 90 | ~~~~~~~~~~~~~~~~~~~ 91 | 92 | * Events are only evaluated in the given time frame, so events extending it, are cut of (birthday reminders for example). 93 | * Complex reminders are only preserved in their evaluated form (PUSH-OMIT-CONTEXT, OMIT, TRIGGER, BEFORE, SKIP). 94 | Same holds true for function evaluation in MSG. For example having the age in a birthday reminder results in the same string for every year. 95 | This could result in old data being provided as the internal state (cache) is only invalidated if one of the remind files change (last time stamp). 96 | * Periodic reminders other then daily, weekly or monthly are not preserved. 97 | * Two entries with the same content are only exported once. 98 | -------------------------------------------------------------------------------- /ics_compare.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python3 2 | # 3 | # Python tool to compare two iCalendar files (specifically for python-remind) 4 | # 5 | # Copyright (C) 2014-2021 Jochen Sprickerhof 6 | # 7 | # This program is free software: you can redistribute it and/or modify 8 | # it under the terms of the GNU General Public License as published by 9 | # the Free Software Foundation, either version 3 of the License, or 10 | # (at your option) any later version. 11 | # 12 | # This program is distributed in the hope that it will be useful, 13 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 14 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 15 | # GNU General Public License for more details. 16 | # 17 | # You should have received a copy of the GNU General Public License 18 | # along with this program. If not, see . 19 | 20 | from argparse import ArgumentParser 21 | from datetime import datetime 22 | 23 | from vobject import iCalendar 24 | from vobject.base import Component, readComponents 25 | 26 | 27 | def compare(first_in: Component, second_in: Component, second_out: Component) -> None: 28 | for (j, second) in enumerate(second_in.vevent_list): 29 | found = False 30 | for (i, first) in enumerate(first_in.vevent_list): 31 | wrong = False 32 | for attr in ( 33 | "summary", 34 | "location", 35 | "description", 36 | "recurrence_id", 37 | ): 38 | if ( 39 | hasattr(first, attr) 40 | and first.contents.get(attr) 41 | and first.contents.get(attr)[0].value 42 | and not ( 43 | hasattr(second, attr) 44 | and second.contents.get(attr) 45 | and second.contents.get(attr)[0].value 46 | and first.contents.get(attr)[0].value 47 | == second.contents.get(attr)[0].value 48 | ) 49 | ): 50 | wrong = True 51 | break 52 | 53 | # ignore timezone when comparing dates (not supported by remind) 54 | if hasattr(first, "dtstart") and not ( 55 | hasattr(second, "dtstart") 56 | and ( 57 | ( 58 | isinstance(first.dtstart.value, datetime) 59 | and isinstance(second.dtstart.value, datetime) 60 | and first.dtstart.value.timestamp() 61 | == second.dtstart.value.timestamp() 62 | ) 63 | or first.dtstart.value == second.dtstart.value 64 | ) 65 | ): 66 | wrong = True 67 | 68 | if hasattr(first, "dtend"): 69 | if hasattr(second, "dtend") and ( 70 | ( 71 | isinstance(first.dtend.value, datetime) 72 | and isinstance(second.dtend.value, datetime) 73 | and first.dtend.value.timestamp() 74 | != second.dtend.value.timestamp() 75 | ) 76 | or first.dtend.value != second.dtend.value 77 | ): 78 | wrong = True 79 | elif ( 80 | hasattr(second, "duration") 81 | and first.dtend.value 82 | != second.dtstart.value + second.duration.value 83 | ): 84 | wrong = True 85 | elif not (hasattr(second, "dtend") or hasattr(second, "duration")): 86 | wrong = True 87 | 88 | if hasattr(first, "duration"): 89 | if ( 90 | hasattr(second, "duration") 91 | and first.duration.value != second.duration.value 92 | ): 93 | wrong = True 94 | elif ( 95 | hasattr(second, "dtend") 96 | and first.duration.value 97 | != second.dtend.value - second.dtstart.value 98 | ): 99 | wrong = True 100 | elif not (hasattr(second, "dtend") or hasattr(second, "duration")): 101 | wrong = True 102 | 103 | if hasattr(first, "rruleset") and first.rruleset: 104 | if ( 105 | hasattr(second, "rruleset") 106 | and second.rruleset 107 | and list(first.rruleset) != list(second.rruleset) 108 | ): 109 | wrong = True 110 | elif ( 111 | hasattr(second, "rdate") 112 | and second.rdate.value 113 | and list(first.rruleset) != second.rdate.value 114 | ): 115 | wrong = True 116 | elif not (hasattr(second, "rruleset") or hasattr(second, "rdate")): 117 | wrong = True 118 | 119 | if hasattr(first, "rdate") and first.rdate.value: 120 | if ( 121 | hasattr(second, "rdate") 122 | and second.rdate.value 123 | and first.rdate.value != second.rdate.value 124 | ): 125 | wrong = True 126 | elif ( 127 | hasattr(second, "rruleset") 128 | and second.rruleset 129 | and first.rdate.value != list(second.rruleset) 130 | ): 131 | wrong = True 132 | elif not (hasattr(second, "rruleset") or hasattr(second, "rdate")): 133 | wrong = True 134 | 135 | if wrong: 136 | continue 137 | 138 | found = True 139 | first_in.remove(first) 140 | print(f"matching {i} to {j}") 141 | if not found: 142 | second_out.add(second) 143 | 144 | 145 | def main() -> None: 146 | parser = ArgumentParser(description="Compare two iCalendar files semantically") 147 | parser.add_argument("first_input", help="First iCalendar file input") 148 | parser.add_argument("second_input", help="Second iCalendar file input") 149 | parser.add_argument("first_output", help="First iCalendar file output") 150 | parser.add_argument("second_output", help="Second iCalendar file output") 151 | args = parser.parse_args() 152 | with open(args.first_input, encoding="utf-8") as infile: 153 | first_cal = next(readComponents(infile)) 154 | with open(args.second_input, encoding="utf-8") as infile: 155 | second_cal = next(readComponents(infile)) 156 | second_out = iCalendar() 157 | 158 | compare(first_cal, second_cal, second_out) 159 | 160 | with open(args.first_output, "w", encoding="utf-8") as outfile: 161 | outfile.write(first_cal.serialize()) 162 | with open(args.second_output, "w", encoding="utf-8") as outfile: 163 | outfile.write(second_out.serialize()) 164 | 165 | 166 | if __name__ == "__main__": 167 | main() 168 | -------------------------------------------------------------------------------- /remind.py: -------------------------------------------------------------------------------- 1 | # Python library to convert between Remind and iCalendar 2 | # 3 | # Copyright (C) 2013-2024 Jochen Sprickerhof 4 | # 5 | # This program is free software: you can redistribute it and/or modify 6 | # it under the terms of the GNU General Public License as published by 7 | # the Free Software Foundation, either version 3 of the License, or 8 | # (at your option) any later version. 9 | # 10 | # This program is distributed in the hope that it will be useful, 11 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 12 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 13 | # GNU General Public License for more details. 14 | # 15 | # You should have received a copy of the GNU General Public License 16 | # along with this program. If not, see . 17 | """Python library to convert between Remind and iCalendar.""" 18 | 19 | from collections.abc import Iterable 20 | from datetime import date, datetime, timedelta 21 | from hashlib import md5 22 | from json import JSONDecodeError, loads 23 | from os.path import expanduser, getmtime, isfile 24 | from re import DOTALL, findall, match 25 | from socket import getfqdn 26 | from subprocess import run 27 | from threading import Lock 28 | from time import time 29 | from typing import Any 30 | from zoneinfo import ZoneInfo 31 | 32 | from dateutil import rrule, tz 33 | from vobject import iCalendar 34 | from vobject.base import Component, readOne 35 | 36 | 37 | class Remind: 38 | """Represents a collection of Remind files.""" 39 | 40 | def __init__( 41 | self, 42 | filename: str | None = None, 43 | localtz: ZoneInfo | None = None, 44 | startdate: date | None = None, 45 | month: int = 15, 46 | alarm: timedelta | None = None, 47 | fqdn: str | None = None, 48 | ) -> None: 49 | """Constructor. 50 | 51 | filename -- the remind file (included files will be used as well) 52 | localtz -- the timezone of the remind file 53 | startdate -- the date to start parsing, will be passed to remind 54 | month -- how many month to parse, will be passed to remind -s 55 | """ 56 | self._filename = filename or expanduser("~/.reminders") 57 | self._localtz = localtz or tz.gettz() 58 | self._startdate = startdate or date.today() - timedelta(weeks=12) 59 | self._month = month 60 | self._alarm = alarm or timedelta(minutes=-10) 61 | self._lock = Lock() 62 | self._reminders: dict[str, dict[str, Any]] = {} 63 | self._mtime = 0.0 64 | self._fqdn = fqdn or getfqdn() 65 | 66 | def _parse_remind(self, filename: str, lines: str = "") -> dict[str, dict[str, Any]]: 67 | """Call remind and parse output into a dict. 68 | 69 | filename -- the remind file (included files will be used as well) 70 | lines -- used as stdin to remind (filename will be set to -) 71 | """ 72 | cmd = [ 73 | "remind", 74 | f"-pppq{self._month}", 75 | "-b2", 76 | "-y", 77 | "-df", 78 | filename, 79 | str(self._startdate), 80 | ] 81 | try: 82 | process = run(cmd, input=lines, capture_output=True, check=False, text=True) 83 | except FileNotFoundError as error: 84 | raise FileNotFoundError("remind command not found, please install it") from error 85 | 86 | if "Unknown option" in process.stderr: 87 | raise OSError(f'Error running: {" ".join(cmd)}, maybe old remind version') 88 | 89 | if ( 90 | f"Can't open file: {filename}" in process.stderr 91 | or f"Error reading {filename}: Can't open file" in process.stderr 92 | ): 93 | return {filename: {}} 94 | 95 | if "): Parse error" in process.stderr: 96 | return {filename: {}} 97 | 98 | err = list(set(findall(r"Can't open file: (.*)", process.stderr))) 99 | if err: 100 | raise FileNotFoundError(f'include file(s): {", ".join(err)} not found (please use absolute paths)') 101 | 102 | reminders: dict[str, dict[str, Any]] = {} 103 | for source in list(set(findall(r"Caching file `(.*)' in memory", process.stderr))): 104 | reminders[source] = {} 105 | if isfile(source): 106 | # There is a race condition with the remind call above here. 107 | mtime = getmtime(source) 108 | if mtime > self._mtime: 109 | self._mtime = mtime 110 | 111 | try: 112 | months = loads(process.stdout) 113 | except JSONDecodeError as exc: 114 | raise OSError(f'Error parsing: {" ".join(cmd)}, maybe old remind version') from exc 115 | 116 | for month in months: 117 | for entry in month["entries"]: 118 | # man remind: 119 | # If you use the sequence %"%" in a MSG or CAL-type reminder, 120 | # then no calendar entry is produced for that reminder. 121 | if '%"%"' in entry["body"] and entry["calendar_body"] == "": 122 | continue 123 | if "passthru" in entry: 124 | if entry["passthru"] == "COLOR": 125 | groups = match(r"^\d* \d* \d* (.*)$", entry["body"]) 126 | if groups: 127 | entry["body"] = groups[1] 128 | else: 129 | continue 130 | 131 | entry["uid"] = f"{entry['tags'].split(',')[-1][7:]}@{self._fqdn}" 132 | 133 | if "eventstart" in entry: 134 | dtstart: datetime | date = datetime.strptime(entry["eventstart"], "%Y-%m-%dT%H:%M").replace( 135 | tzinfo=self._localtz 136 | ) 137 | if "rem2ics_utc" in entry["tags"]: 138 | utcoffset = datetime( 139 | self._startdate.year, self._startdate.month, self._startdate.day, tzinfo=self._localtz 140 | ).utcoffset() 141 | dtstart = (dtstart - utcoffset).replace(tzinfo=ZoneInfo("UTC")) # type: ignore 142 | else: 143 | dtstart = datetime.strptime(entry["date"], "%Y-%m-%d").date() 144 | 145 | if entry["uid"] in reminders[entry["filename"]]: 146 | if dtstart not in reminders[entry["filename"]][entry["uid"]]["dtstart"]: 147 | reminders[entry["filename"]][entry["uid"]]["dtstart"].append(dtstart) 148 | else: 149 | entry["dtstart"] = [dtstart] 150 | reminders[entry["filename"]][entry["uid"]] = entry 151 | 152 | return reminders 153 | 154 | @staticmethod 155 | def _interval(dates: list[date]) -> int: 156 | """Return the distance between all dates and 0 if they are different.""" 157 | interval = (dates[1] - dates[0]).days 158 | last = dates[0] 159 | for dat in dates[1:]: 160 | if (dat - last).days != interval: 161 | return 0 162 | last = dat 163 | return interval 164 | 165 | @staticmethod 166 | def _gen_dtend_rrule(dtstarts: list[date], vevent: Component) -> None: 167 | """Generate an rdate or rrule from a list of dates and add it to the vevent.""" 168 | interval = Remind._interval(dtstarts) 169 | if interval > 0 and interval % 7 == 0: 170 | rset = rrule.rruleset() 171 | rset.rrule(rrule.rrule(freq=rrule.WEEKLY, interval=interval // 7, count=len(dtstarts))) 172 | vevent.rruleset = rset 173 | elif interval > 1: 174 | rset = rrule.rruleset() 175 | rset.rrule(rrule.rrule(freq=rrule.DAILY, interval=interval, count=len(dtstarts))) 176 | vevent.rruleset = rset 177 | elif interval > 0: 178 | if isinstance(dtstarts[0], datetime): 179 | rset = rrule.rruleset() 180 | rset.rrule(rrule.rrule(freq=rrule.DAILY, count=len(dtstarts))) 181 | vevent.rruleset = rset 182 | else: 183 | vevent.add("dtend").value = dtstarts[-1] + timedelta(days=1) 184 | else: 185 | rset = rrule.rruleset() 186 | if isinstance(dtstarts[0], datetime): 187 | for dat in dtstarts: 188 | rset.rdate(dat) 189 | else: 190 | for dat in dtstarts: 191 | rset.rdate(datetime(dat.year, dat.month, dat.day)) 192 | # temporary set dtstart to a different date, so it's not 193 | # removed from rset by python-vobject works around bug in 194 | # Android: 195 | # https://github.com/rfc2822/davdroid/issues/340 196 | vevent.dtstart.value = dtstarts[0] - timedelta(days=1) 197 | vevent.rruleset = rset 198 | vevent.dtstart.value = dtstarts[0] 199 | if not isinstance(dtstarts[0], datetime): 200 | vevent.add("dtend").value = dtstarts[0] + timedelta(days=1) 201 | 202 | def _gen_vevent(self, event: dict[str, Any], vevent: Component) -> None: 203 | """Generate vevent from given event.""" 204 | vevent.add("dtstart").value = event["dtstart"][0] 205 | 206 | msg = event["body"].strip().replace('["["]', "[") 207 | groups = match(r'%"(.*)%"(\n| |)(.*)', msg, DOTALL) 208 | if groups: 209 | msg = groups[1] 210 | vevent.add("description").value = groups[3] 211 | 212 | groups = match(r"^(.*) at (.*)$", msg) 213 | if groups: 214 | msg = groups[1] 215 | vevent.add("location").value = groups[2] 216 | 217 | vevent.add("dtstamp").value = datetime.fromtimestamp(self._mtime) 218 | vevent.add("summary").value = msg 219 | vevent.add("uid").value = event["uid"] 220 | 221 | if "tags" in event: 222 | tags = event["tags"].split(",")[:-1] 223 | 224 | classes = ["PUBLIC", "PRIVATE", "CONFIDENTIAL"] 225 | 226 | tag_class = [tag for tag in tags if tag in classes] 227 | if tag_class: 228 | vevent.add("class").value = tag_class[0] 229 | 230 | statuses = ["TENTATIVE", "CONFIRMED", "CANCELLED"] 231 | tag_status = [status for status in tags if status in statuses] 232 | if tag_status: 233 | vevent.add("status").value = tag_status[0] 234 | 235 | categories = [tag for tag in tags if tag not in classes and tag not in statuses] 236 | 237 | if categories: 238 | vevent.add("categories").value = categories 239 | 240 | if isinstance(event["dtstart"][0], datetime): 241 | if self._alarm != timedelta(): 242 | valarm = vevent.add("valarm") 243 | valarm.add("trigger").value = self._alarm 244 | valarm.add("action").value = "DISPLAY" 245 | valarm.add("description").value = msg 246 | 247 | if "eventduration" in event: 248 | vevent.add("duration").value = timedelta(minutes=event["eventduration"]) 249 | else: 250 | vevent.add("dtend").value = event["dtstart"][0] 251 | 252 | elif len(event["dtstart"]) == 1: 253 | vevent.add("dtend").value = event["dtstart"][0] + timedelta(days=1) 254 | 255 | if len(event["dtstart"]) > 1: 256 | Remind._gen_dtend_rrule(event["dtstart"], vevent) 257 | 258 | def _update(self) -> None: 259 | """Reload Remind files if the mtime is newer.""" 260 | update = not self._reminders 261 | 262 | now = time() 263 | if self._mtime > 0 and datetime.fromtimestamp(self._mtime).date() < datetime.fromtimestamp(now).date(): 264 | update = True 265 | self._mtime = now 266 | 267 | with self._lock: 268 | for fname in self._reminders: 269 | if not isfile(fname) or getmtime(fname) > self._mtime: 270 | update = True 271 | break 272 | 273 | if update: 274 | self._reminders = self._parse_remind(self._filename) 275 | 276 | def get_filesnames(self) -> list[str]: 277 | """All filenames parsed by remind (including included files).""" 278 | self._update() 279 | return sorted(self._reminders.keys()) 280 | 281 | def _get_uid(self, line: str) -> str: 282 | """UID of a remind line.""" 283 | return f"{md5(line.strip().encode('utf-8')).hexdigest()}@{self._fqdn}" 284 | 285 | def get_uids(self, filename: str = "") -> list[str]: 286 | """UIDs of all reminders in the file excluding included files. 287 | 288 | If a filename is specified, only it's UIDs are return, otherwise all. 289 | 290 | filename -- the remind file 291 | """ 292 | self._update() 293 | 294 | if filename: 295 | if filename not in self._reminders: 296 | return [] 297 | return list(self._reminders[filename].keys()) 298 | return [uid for uids in self._reminders.values() for uid in uids] 299 | 300 | def _vobject_etag(self, filename: str, uid: str) -> tuple[str, Component, str]: 301 | """Return iCal object and etag of one Remind entry. 302 | 303 | filename -- the remind file 304 | uid -- the UID of the Remind line 305 | """ 306 | cal = iCalendar() 307 | self._gen_vevent(self._reminders[filename][uid], cal.add("vevent")) 308 | return uid, cal, self.get_etag(cal) 309 | 310 | def to_vobject_etag(self, filename: str, uid: str) -> tuple[Component, str]: 311 | """Return iCal object and etag of one Remind entry. 312 | 313 | filename -- the remind file 314 | uid -- the UID of the Remind line 315 | """ 316 | self._update() 317 | 318 | return self._vobject_etag(filename, uid)[1:3] 319 | 320 | def to_vobjects(self, filename: str, uids: Iterable[str] | None = None) -> list[tuple[str, Component, str]]: 321 | """Return iCal objects and etags of all Remind entries in uids. 322 | 323 | filename -- the remind file 324 | uids -- the UIDs of the Remind lines (all if None) 325 | """ 326 | self._update() 327 | 328 | if not uids: 329 | uids = list(self._reminders[filename].keys()) 330 | 331 | return [self._vobject_etag(filename, uid) for uid in uids] 332 | 333 | def to_vobject(self, filename: str = "", uid: str = "") -> Component: 334 | """Return iCal object of Remind lines. 335 | 336 | If filename and UID are specified, the vObject only contains that event. 337 | If only a filename is specified, the vObject contains all events in the file. 338 | Otherwise the vObject contains all all objects of all files associated 339 | with the Remind object. 340 | 341 | filename -- the remind file 342 | uid -- the UID of the Remind line 343 | """ 344 | self._update() 345 | 346 | cal = iCalendar() 347 | if uid: 348 | self._gen_vevent(self._reminders[filename][uid], cal.add("vevent")) 349 | elif filename: 350 | for event in self._reminders[filename].values(): 351 | self._gen_vevent(event, cal.add("vevent")) 352 | else: 353 | for events in self._reminders.values(): 354 | for event in events.values(): 355 | self._gen_vevent(event, cal.add("vevent")) 356 | return cal 357 | 358 | def stdin_to_vobject(self, lines: str) -> Component: 359 | """Return iCal object of the Remind commands in lines.""" 360 | cal = iCalendar() 361 | for event in self._parse_remind("-", lines)["-"].values(): 362 | self._gen_vevent(event, cal.add("vevent")) 363 | return cal 364 | 365 | @staticmethod 366 | def _parse_rdate(rdates: list[date], repeat: int = 1) -> str: 367 | """Convert from iCal rdate to Remind trigdate syntax.""" 368 | rdates = sorted(rdates) 369 | if len(rdates) == 1 and repeat == 1: 370 | return rdates[0].strftime("%Y-%m-%d") 371 | start = rdates[0].strftime("FROM %Y-%m-%d") 372 | trigdates = [(rdate + timedelta(days=d)).strftime("$T=='%Y-%m-%d'") for rdate in rdates for d in range(repeat)] 373 | end = (rdates[-1] + timedelta(days=repeat - 1)).strftime("UNTIL %Y-%m-%d") 374 | return f"{start} {end} SATISFY [{'||'.join(trigdates)}]" 375 | 376 | @staticmethod 377 | def _parse_rruleset(rruleset: Any, duration: timedelta) -> str | list[str]: 378 | """Convert from iCal rrule to Remind recurrence syntax.""" 379 | # pylint: disable=protected-access 380 | 381 | if duration.days > 1: 382 | return Remind._parse_rdate(rruleset._rrule[0], duration.days) 383 | 384 | if rruleset._rrule[0]._freq == 0: 385 | return [] 386 | 387 | weekdays = ["Mon", "Tue", "Wed", "Thu", "Fri", "Sat", "Sun"] 388 | rep = [] 389 | if rruleset._rrule[0]._byweekday and len(rruleset._rrule[0]._byweekday) > 1: 390 | rep.append("*1") 391 | elif rruleset._rrule[0]._freq == rrule.DAILY: 392 | rep.append(f"*{rruleset._rrule[0]._interval}") 393 | elif rruleset._rrule[0]._freq == rrule.WEEKLY: 394 | rep.append(f"*{(7 * rruleset._rrule[0]._interval)}") 395 | elif rruleset._rrule[0]._freq == rrule.MONTHLY and rruleset._rrule[0]._bymonthday: 396 | rep.append(str(rruleset._rrule[0]._bymonthday[0])) 397 | elif rruleset._rrule[0]._freq == rrule.MONTHLY and rruleset._rrule[0]._bynweekday: 398 | daynum, week = rruleset._rrule[0]._bynweekday[0] 399 | weekday = weekdays[daynum] 400 | rep.append(f"{weekday} {week * 7 - 6}") 401 | else: 402 | return Remind._parse_rdate(rruleset._rrule[0]) 403 | 404 | if rruleset._rrule[0]._byweekday and len(rruleset._rrule[0]._byweekday) > 1: 405 | daynums = set(range(7)) - set(rruleset._rrule[0]._byweekday) 406 | days = [weekdays[day] for day in daynums] 407 | rep.append(f"SKIP OMIT {' '.join(days)}") 408 | 409 | if rruleset._rrule[0]._until: 410 | rep.append(rruleset._rrule[0]._until.strftime("UNTIL %b %d %Y").replace(" 0", " ")) 411 | elif rruleset._rrule[0]._count: 412 | rep.append(rruleset[-1].strftime("UNTIL %b %d %Y").replace(" 0", " ")) 413 | 414 | return rep 415 | 416 | @staticmethod 417 | def _event_duration(vevent: Component) -> timedelta: 418 | """Unify dtend and duration to the duration of the given vevent.""" 419 | if hasattr(vevent, "dtend"): 420 | return vevent.dtend.value - vevent.dtstart.value 421 | if hasattr(vevent, "duration") and vevent.duration.value: 422 | return vevent.duration.value 423 | return timedelta(0) 424 | 425 | @staticmethod 426 | def _gen_msg(vevent: Component, label: str, tail: str, sep: str, locations: bool) -> str: 427 | """Generate a Remind MSG from the given vevent.""" 428 | rem = ["MSG"] 429 | msg = [] 430 | if label: 431 | msg.append(label) 432 | 433 | if hasattr(vevent, "summary") and vevent.summary.value: 434 | msg.append(Remind._rem_clean(vevent.summary.value)) 435 | else: 436 | msg.append("empty reminder") 437 | 438 | if hasattr(vevent, "location") and vevent.location.value and locations: 439 | msg.append(f"at {Remind._rem_clean(vevent.location.value)}") 440 | 441 | has_desc = hasattr(vevent, "description") and vevent.description.value.strip() 442 | 443 | if tail or has_desc: 444 | rem.append(f'%"{" ".join(msg)}%"') 445 | else: 446 | rem.append(" ".join(msg)) 447 | 448 | if tail: 449 | rem.append(tail) 450 | 451 | if has_desc: 452 | rem[-1] += sep + Remind._rem_clean(vevent.description.value).strip() 453 | 454 | return " ".join(rem) 455 | 456 | @staticmethod 457 | def _rem_clean(rem: str) -> str: 458 | """Cleanup string for Remind. 459 | 460 | Strip, transform newlines, and escape '[' in string so it's acceptable 461 | as a remind entry. 462 | """ 463 | return rem.strip().replace("%", "%%").replace("\n", "%_").replace("[", "[[") 464 | 465 | @staticmethod 466 | def _abbr_tag(tag: str) -> str: 467 | """Transform a string so it's acceptable as a remind tag.""" 468 | return tag.replace(" ", "")[:48] 469 | 470 | def to_remind( 471 | self, 472 | vevent: Component, 473 | label: str = "", 474 | priority: str = "", 475 | tags: str = "", 476 | tail: str = "", 477 | sep: str = "%_", 478 | postdate: str = "", 479 | posttime: str = "", 480 | locations: bool = True, 481 | ) -> str: 482 | """Generate a Remind command from the given vevent.""" 483 | remind = ["REM"] 484 | 485 | duration = Remind._event_duration(vevent) 486 | 487 | trigdates = None 488 | if hasattr(vevent, "rrule"): 489 | trigdates = Remind._parse_rruleset(vevent.rruleset, duration) 490 | 491 | dtstart = vevent.dtstart.value 492 | # If we don't get timezone information, handle it as a naive datetime. 493 | # See https://github.com/jspricke/python-remind/issues/2 for reference. 494 | if isinstance(dtstart, datetime) and dtstart.tzinfo: 495 | dtstart = dtstart.astimezone(self._localtz) 496 | 497 | dtend = None 498 | if hasattr(vevent, "dtend"): 499 | dtend = vevent.dtend.value 500 | if isinstance(dtend, datetime) and dtend.tzinfo: 501 | dtend = dtend.astimezone(self._localtz) 502 | 503 | if not hasattr(vevent, "rdate") and not isinstance(trigdates, str): 504 | if not hasattr(vevent, "rrule") or vevent.rruleset._rrule[0]._freq != rrule.MONTHLY: 505 | remind.append(dtstart.strftime("%b %d %Y").replace(" 0", " ")) 506 | elif hasattr(vevent, "rrule") and vevent.rruleset._rrule[0]._freq == rrule.MONTHLY and trigdates: 507 | remind.extend(trigdates) 508 | trigdates = dtstart.strftime("SATISFY [$T>='%Y-%m-%d']") 509 | 510 | if postdate: 511 | remind.append(postdate) 512 | 513 | if priority: 514 | remind.append(f"PRIORITY {priority}") 515 | 516 | if isinstance(trigdates, list): 517 | remind.extend(trigdates) 518 | 519 | if type(dtstart) is date and duration.days > 1 and not hasattr(vevent, "rrule"): 520 | remind.append("*1") 521 | if dtend is not None: 522 | dtend -= timedelta(days=1) 523 | remind.append(dtend.strftime("UNTIL %b %d %Y").replace(" 0", " ")) 524 | 525 | if isinstance(dtstart, datetime): 526 | remind.append(dtstart.strftime("AT %H:%M").replace(" 0", " ")) 527 | 528 | if posttime: 529 | remind.append(posttime) 530 | 531 | if duration.total_seconds() > 0: 532 | hours, minutes = divmod(duration.total_seconds() / 60, 60) 533 | remind.append(f"DURATION {hours:.0f}:{minutes:02.0f}") 534 | 535 | if hasattr(vevent, "rdate"): 536 | rdates = {rdate for rdate in vevent.rdate.value} 537 | rdates.add(dtstart) 538 | remind.append(Remind._parse_rdate(list(rdates))) 539 | 540 | if hasattr(vevent, "class"): 541 | remind.append(f"TAG {Remind._abbr_tag(vevent.getChildValue('class'))}") 542 | 543 | if hasattr(vevent, "status"): 544 | remind.append(f"TAG {Remind._abbr_tag(vevent.getChildValue('status'))}") 545 | 546 | if isinstance(trigdates, str): 547 | remind.append(trigdates) 548 | 549 | if tags: 550 | remind.extend([f"TAG {Remind._abbr_tag(tag)}" for tag in tags]) 551 | 552 | if hasattr(vevent, "categories_list"): 553 | for categories in vevent.categories_list: 554 | for category in categories.value: 555 | remind.append(f"TAG {Remind._abbr_tag(category)}") 556 | 557 | remind.append(Remind._gen_msg(vevent, label, tail, sep, locations)) 558 | 559 | return " ".join(remind) + "\n" 560 | 561 | def to_reminders( 562 | self, 563 | ical: Component, 564 | label: str = "", 565 | priority: str = "", 566 | tags: str = "", 567 | tail: str = "", 568 | sep: str = "%_", 569 | postdate: str = "", 570 | posttime: str = "", 571 | locations: bool = True, 572 | ) -> str: 573 | """Return Remind commands for all events of a iCalendar.""" 574 | if not hasattr(ical, "vevent_list"): 575 | return "" 576 | 577 | reminders = [ 578 | self.to_remind(vevent, label, priority, tags, tail, sep, postdate, posttime, locations) 579 | for vevent in ical.vevent_list 580 | ] 581 | return "".join(reminders) 582 | 583 | def append_vobject(self, ical: Component, filename: str = "") -> str: 584 | """Append a Remind command generated from the iCalendar to the file.""" 585 | if not filename: 586 | filename = self._filename 587 | 588 | with self._lock: 589 | outdat = self.to_reminders(ical) 590 | with open(filename, "a", encoding="utf-8") as outfile: 591 | outfile.write(outdat) 592 | 593 | return self._get_uid(outdat) 594 | 595 | def remove(self, uid: str, filename: str = "") -> None: 596 | """Remove the Remind command with the uid from the file.""" 597 | if not filename: 598 | filename = self._filename 599 | 600 | uid = uid.split("@")[0] 601 | 602 | with self._lock: 603 | with open(filename, encoding="utf-8") as infile: 604 | rem = infile.readlines() 605 | for index, line in enumerate(rem): 606 | if uid == md5(line.strip().encode("utf-8")).hexdigest(): 607 | del rem[index] 608 | with open(filename, "w", encoding="utf-8") as outfile: 609 | outfile.writelines(rem) 610 | break 611 | 612 | def replace_vobject(self, uid: str, ical: Component, filename: str = "") -> str: 613 | """Update the Remind command with the uid in the file with the new iCalendar.""" 614 | if not filename: 615 | filename = self._filename 616 | 617 | uid = uid.split("@")[0] 618 | 619 | with self._lock: 620 | with open(filename, encoding="utf-8") as infile: 621 | rem = infile.readlines() 622 | for index, line in enumerate(rem): 623 | if uid == md5(line.strip().encode("utf-8")).hexdigest(): 624 | rem[index] = self.to_reminders(ical) 625 | new_uid = self._get_uid(rem[index]) 626 | with open(filename, "w", encoding="utf-8") as outfile: 627 | outfile.writelines(rem) 628 | return new_uid 629 | raise ValueError(f"Failed to find uid {uid} in {filename}") 630 | 631 | def move_vobject(self, uid: str, from_file: str, to_file: str) -> None: 632 | """Move the Remind command with the uid from from_file to to_file.""" 633 | uid = uid.split("@")[0] 634 | 635 | with self._lock: 636 | with open(from_file, encoding="utf-8") as infile: 637 | rem = infile.readlines() 638 | for index, line in enumerate(rem): 639 | if uid == md5(line.strip().encode("utf-8")).hexdigest(): 640 | del rem[index] 641 | with open(from_file, "w", encoding="utf-8") as outfile: 642 | outfile.writelines(rem) 643 | with open(to_file, "a", encoding="utf-8") as outfile: 644 | outfile.writelines(rem) 645 | break 646 | 647 | @staticmethod 648 | def get_meta() -> dict[str, str]: 649 | """Meta tags of the vObject collection.""" 650 | return {"tag": "VCALENDAR", "C:supported-calendar-component-set": "VEVENT"} 651 | 652 | def last_modified(self) -> float: 653 | """Last time the Remind files where parsed.""" 654 | self._update() 655 | return self._mtime 656 | 657 | @staticmethod 658 | def get_etag(vobject: Component) -> str: 659 | """Generate an etag for the given vobject. 660 | 661 | This sets the dtstamp to epoch 0 to generate a deterministic result as 662 | Remind doesn't save a dtstamp for every entry. And etag should only 663 | change if the other values actually change. 664 | 665 | """ 666 | vobject_copy = iCalendar() 667 | vobject_copy.copy(vobject) 668 | 669 | for vevent in vobject_copy.vevent_list: 670 | vevent.dtstamp.value = datetime.fromtimestamp(0) 671 | etag = md5() 672 | etag.update(vobject_copy.serialize().encode("utf-8")) 673 | return f'"{etag.hexdigest()}"' 674 | 675 | 676 | def rem2ics() -> None: 677 | """Command line tool to convert from Remind to iCalendar.""" 678 | # pylint: disable=maybe-no-member 679 | from argparse import ArgumentParser, FileType 680 | from sys import stdin, stdout 681 | 682 | from dateutil.parser import parse 683 | 684 | parser = ArgumentParser(description="Converter from Remind to iCalendar syntax.") 685 | parser.add_argument( 686 | "-s", 687 | "--startdate", 688 | type=lambda s: parse(s).date(), 689 | default=date.today() - timedelta(weeks=12), 690 | help="Start offset for remind call (default: -12 weeks)", 691 | ) 692 | parser.add_argument( 693 | "-m", 694 | "--month", 695 | type=int, 696 | default=15, 697 | help="Number of month to generate calendar beginning wit startdate (default: 15)", 698 | ) 699 | parser.add_argument( 700 | "-a", 701 | "--alarm", 702 | type=int, 703 | default=-10, 704 | help="Trigger time for the alarm before the event in minutes (default: -10)", 705 | ) 706 | parser.add_argument("-z", "--zone", help="Timezone of Remind file (default: local timezone)") 707 | parser.add_argument( 708 | "infile", 709 | nargs="?", 710 | default=expanduser("~/.reminders"), 711 | help="The Remind file to process (default: ~/.reminders)", 712 | ) 713 | parser.add_argument( 714 | "outfile", 715 | nargs="?", 716 | type=FileType("w", encoding="utf-8"), 717 | default=stdout, 718 | help="Output iCalendar file (default: stdout)", 719 | ) 720 | args = parser.parse_args() 721 | 722 | if args.infile and args.infile != "-" and not isfile(args.infile) and not args.outfile: 723 | args.outfile = open(args.infile, "w", encoding="utf-8") 724 | args.infile = None 725 | 726 | zone = ZoneInfo(args.zone) if args.zone else None 727 | 728 | if args.infile == "-": 729 | remind = Remind(args.infile, zone, args.startdate, args.month, timedelta(minutes=args.alarm)) 730 | vobject = remind.stdin_to_vobject(stdin.read()) 731 | if vobject: 732 | args.outfile.write(vobject.serialize()) 733 | else: 734 | remind = Remind(args.infile, zone, args.startdate, args.month, timedelta(minutes=args.alarm)) 735 | args.outfile.write(remind.to_vobject().serialize()) 736 | 737 | 738 | def ics2rem() -> None: 739 | """Command line tool to convert from iCalendar to Remind.""" 740 | from argparse import ArgumentParser, BooleanOptionalAction, FileType 741 | from sys import stdin, stdout 742 | 743 | parser = ArgumentParser(description="Converter from iCalendar to Remind syntax.") 744 | parser.add_argument("-l", "--label", help="Label for every Remind entry") 745 | parser.add_argument( 746 | "--locations", 747 | action=BooleanOptionalAction, 748 | default=True, 749 | help="Include the location in the message (the default) or not", 750 | ) 751 | parser.add_argument("-p", "--priority", type=int, help="Priority for every Remind entry (0..9999)") 752 | parser.add_argument("-t", "--tag", action="append", help="Tag(s) for every Remind entry") 753 | parser.add_argument("--tail", help='Text to append to every remind summary, following final %%"') 754 | parser.add_argument( 755 | "--sep", 756 | default="%_", 757 | help="String to separate summary (and tail) from description", 758 | ) 759 | parser.add_argument( 760 | "--postdate", 761 | help="String to follow the date in every Remind entry. " 762 | 'Useful for entering "back" and "delta" fields (see man remind).', 763 | ) 764 | parser.add_argument( 765 | "--posttime", 766 | help="String to follow the time in every timed Remind entry. " 767 | 'Useful for entering "tdelta" and "trepeat" fields (see man remind).', 768 | ) 769 | parser.add_argument("-z", "--zone", help="Timezone of Remind file (default: local timezone)") 770 | parser.add_argument( 771 | "infile", 772 | nargs="?", 773 | type=FileType("r", encoding="utf-8"), 774 | default=stdin, 775 | help="Input iCalendar file (default: stdin)", 776 | ) 777 | parser.add_argument( 778 | "outfile", 779 | nargs="?", 780 | type=FileType("w", encoding="utf-8"), 781 | default=stdout, 782 | help="Output Remind file (default: stdout)", 783 | ) 784 | args = parser.parse_args() 785 | 786 | zone = ZoneInfo(args.zone) if args.zone else None 787 | 788 | vobject = readOne(args.infile.read()) 789 | rem = Remind(localtz=zone).to_reminders( 790 | vobject, 791 | args.label, 792 | args.priority, 793 | args.tag, 794 | args.tail, 795 | args.sep, 796 | args.postdate, 797 | args.posttime, 798 | args.locations, 799 | ) 800 | args.outfile.write(rem) 801 | -------------------------------------------------------------------------------- /remind/py.typed: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/jspricke/python-remind/019ef6cda736a1abf8d18520482e97f5d2a59ae0/remind/py.typed -------------------------------------------------------------------------------- /setup.py: -------------------------------------------------------------------------------- 1 | from setuptools import setup 2 | 3 | setup( 4 | name="remind", 5 | version="0.19.2", 6 | description="Remind Python library", 7 | long_description=open("README.rst").read(), 8 | author="Jochen Sprickerhof", 9 | author_email="remind@jochen.sprickerhof.de", 10 | license="GPLv3+", 11 | url="https://github.com/jspricke/python-remind", 12 | keywords=["Remind"], 13 | classifiers=[ 14 | "Programming Language :: Python", 15 | "Development Status :: 4 - Beta", 16 | "Environment :: Console", 17 | "License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)", 18 | "Topic :: Office/Business :: Scheduling", 19 | "Topic :: Software Development :: Libraries :: Python Modules", 20 | ], 21 | install_requires=["python-dateutil", "vobject"], 22 | py_modules=["remind", "ics_compare"], 23 | entry_points={ 24 | "console_scripts": [ 25 | "rem2ics = remind:rem2ics", 26 | "ics2rem = remind:ics2rem", 27 | ] 28 | }, 29 | ) 30 | -------------------------------------------------------------------------------- /test/test_compare.py: -------------------------------------------------------------------------------- 1 | # Unit tests for ics_compare.py 2 | # 3 | # Copyright (C) 2014-2021 Jochen Sprickerhof 4 | # 5 | # This program is free software: you can redistribute it and/or modify 6 | # it under the terms of the GNU General Public License as published by 7 | # the Free Software Foundation, either version 3 of the License, or 8 | # (at your option) any later version. 9 | # 10 | # This program is distributed in the hope that it will be useful, 11 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 12 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 13 | # GNU General Public License for more details. 14 | # 15 | # You should have received a copy of the GNU General Public License 16 | # along with this program. If not, see . 17 | 18 | from datetime import datetime, timedelta 19 | 20 | from dateutil import rrule 21 | from vobject import iCalendar 22 | 23 | from ics_compare import compare 24 | 25 | 26 | def test_compare_simple() -> None: 27 | first = iCalendar() 28 | first.add("vevent") 29 | 30 | second = iCalendar() 31 | second.add("vevent") 32 | 33 | second_out = iCalendar() 34 | 35 | compare(first, second, second_out) 36 | assert len(first.contents) == 0 37 | assert len(second_out.contents) == 0 38 | 39 | 40 | def test_compare_vevent_summary() -> None: 41 | first = iCalendar() 42 | first_vevent = first.add("vevent") 43 | first_vevent.add("summary").value = "Foo" 44 | 45 | second = iCalendar() 46 | second_vevent = second.add("vevent") 47 | second_vevent.add("summary").value = "Foo" 48 | second_out = iCalendar() 49 | 50 | compare(first, second, second_out) 51 | assert len(first.contents) == 0 52 | assert len(second_out.contents) == 0 53 | 54 | 55 | def test_compare_summary_diff1() -> None: 56 | first = iCalendar() 57 | first_vevent = first.add("vevent") 58 | first_vevent.add("summary").value = "Foo" 59 | 60 | second = iCalendar() 61 | second.add("vevent") 62 | second_out = iCalendar() 63 | 64 | compare(first, second, second_out) 65 | assert len(first.contents) == 1 66 | assert len(second_out.contents) == 1 67 | 68 | 69 | def test_compare_summary_diff2() -> None: 70 | first = iCalendar() 71 | first_vevent = first.add("vevent") 72 | first_vevent.add("summary").value = "Foo" 73 | 74 | second = iCalendar() 75 | second.add("vevent") 76 | second_out = iCalendar() 77 | 78 | compare(first, second, second_out) 79 | assert len(first.contents) == 1 80 | assert len(second_out.contents) == 1 81 | 82 | 83 | def test_compare_summary_diff3() -> None: 84 | first = iCalendar() 85 | first_vevent = first.add("vevent") 86 | first_vevent.add("summary").value = "Foo" 87 | 88 | second = iCalendar() 89 | second_vevent = second.add("vevent") 90 | second_vevent.add("summary").value = "Bar" 91 | second_out = iCalendar() 92 | 93 | compare(first, second, second_out) 94 | assert len(first.contents) == 1 95 | assert len(second_out.contents) == 1 96 | 97 | 98 | def test_compare_dtend() -> None: 99 | first = iCalendar() 100 | first_vevent = first.add("vevent") 101 | first_vevent.add("dtstart").value = datetime(2001, 1, 1, 10, 0) 102 | first_vevent.add("dtend").value = datetime(2001, 1, 1, 11, 0) 103 | 104 | second = iCalendar() 105 | second_vevent = second.add("vevent") 106 | second_vevent.add("dtstart").value = datetime(2001, 1, 1, 10, 0) 107 | second_vevent.add("dtend").value = datetime(2001, 1, 1, 11, 0) 108 | second_out = iCalendar() 109 | 110 | compare(first, second, second_out) 111 | assert len(first.contents) == 0 112 | assert len(second_out.contents) == 0 113 | 114 | 115 | def test_compare_dtend_duration() -> None: 116 | first = iCalendar() 117 | first_vevent = first.add("vevent") 118 | first_vevent.add("dtstart").value = datetime(2001, 1, 1, 10, 0) 119 | first_vevent.add("dtend").value = datetime(2001, 1, 1, 11, 0) 120 | 121 | second = iCalendar() 122 | second_vevent = second.add("vevent") 123 | second_vevent.add("dtstart").value = datetime(2001, 1, 1, 10, 0) 124 | second_vevent.add("duration").value = timedelta(hours=1) 125 | second_out = iCalendar() 126 | 127 | compare(first, second, second_out) 128 | assert len(first.contents) == 0 129 | assert len(second_out.contents) == 0 130 | 131 | 132 | def test_compare_dtend_duration_diff() -> None: 133 | first = iCalendar() 134 | first_vevent = first.add("vevent") 135 | first_vevent.add("dtstart").value = datetime(2001, 1, 1, 10, 0) 136 | first_vevent.add("dtend").value = datetime(2001, 1, 1, 11, 0) 137 | 138 | second = iCalendar() 139 | second_vevent = second.add("vevent") 140 | second_vevent.add("dtstart").value = datetime(2001, 1, 1, 10, 0) 141 | second_vevent.add("duration").value = timedelta(hours=2) 142 | second_out = iCalendar() 143 | 144 | compare(first, second, second_out) 145 | assert len(first.contents) == 1 146 | assert len(second_out.contents) == 1 147 | 148 | 149 | def test_compare_rrule() -> None: 150 | first = iCalendar() 151 | first_vevent = first.add("vevent") 152 | first_vevent.add("dtstart").value = datetime(2001, 1, 1, 10, 0) 153 | rset = rrule.rruleset() 154 | rset.rrule(rrule.rrule(freq=rrule.DAILY, count=3)) 155 | first_vevent.rruleset = rset 156 | 157 | second = iCalendar() 158 | second_vevent = second.add("vevent") 159 | second_vevent.add("dtstart").value = datetime(2001, 1, 1, 10, 0) 160 | second_out = iCalendar() 161 | rset = rrule.rruleset() 162 | rset.rrule(rrule.rrule(freq=rrule.DAILY, count=3)) 163 | second_vevent.rruleset = rset 164 | 165 | compare(first, second, second_out) 166 | assert len(first.contents) == 0 167 | assert len(second_out.contents) == 0 168 | 169 | 170 | def test_compare_rrule_diff() -> None: 171 | first = iCalendar() 172 | first_vevent = first.add("vevent") 173 | first_vevent.add("dtstart").value = datetime(2001, 1, 1, 10, 0) 174 | rset = rrule.rruleset() 175 | rset.rrule(rrule.rrule(freq=rrule.DAILY, count=3)) 176 | first_vevent.rruleset = rset 177 | 178 | second = iCalendar() 179 | second_vevent = second.add("vevent") 180 | second_vevent.add("dtstart").value = datetime(2001, 1, 1, 10, 0) 181 | second_out = iCalendar() 182 | rset = rrule.rruleset() 183 | rset.rrule(rrule.rrule(freq=rrule.DAILY, count=4)) 184 | second_vevent.rruleset = rset 185 | 186 | compare(first, second, second_out) 187 | assert len(first.contents) == 1 188 | assert len(second_out.contents) == 1 189 | --------------------------------------------------------------------------------