├── .gitignore ├── .travis.yml ├── CHANGES.txt ├── LICENSE.txt ├── README.txt ├── django_date_extensions ├── __init__.py ├── fields.py ├── models.py ├── settings.py ├── tests.py └── widgets.py ├── example ├── __init__.py ├── forms.py ├── settings.py ├── templates │ └── form.html ├── urls.py └── views.py ├── manage.py ├── setup.cfg ├── setup.py └── tox.ini /.gitignore: -------------------------------------------------------------------------------- 1 | *.pyc 2 | /MANIFEST 3 | /dist 4 | /build 5 | /django_date_extensions.egg-info/ 6 | /.tox 7 | -------------------------------------------------------------------------------- /.travis.yml: -------------------------------------------------------------------------------- 1 | dist: xenial 2 | 3 | notifications: 4 | email: false 5 | 6 | language: python 7 | python: 3.6 8 | 9 | matrix: 10 | include: 11 | - python: 2.7 12 | env: TOXENV=py27-1.11 13 | env: 14 | matrix: 15 | - TOXENV=flake8 16 | - TOXENV=py36-1.11 17 | - TOXENV=py36-2.2 18 | - TOXENV=py36-3.0 19 | - TOXENV=py36-3.1 20 | 21 | install: 22 | - pip install tox 23 | script: 24 | - tox 25 | -------------------------------------------------------------------------------- /CHANGES.txt: -------------------------------------------------------------------------------- 1 | Version 3.1.2 2 | 3 | This version removes a warning about from_db_value, thanks swizzlevixen. 4 | Supports Django up to 3.2. 5 | 6 | Version 3.1.1 7 | 8 | This version fixes a bug with serialization, thanks jonancm. 9 | 10 | Version 3.1 11 | 12 | This version supports Django 1.11 to 3.1. 13 | 14 | It also switches to a truthy check rather than only checking for None and '', 15 | as something that may help fix e.g. situations with migrations containing 16 | bytestrings. 17 | 18 | Version 3.0 19 | 20 | This version supports Django 1.11 to 2.2, and makes ApproximateDate Unicode 21 | compatible. 22 | 23 | Thanks to Frank Sachsenheim, Mark Phillips, and Aamir Adnan, and apologies to 24 | all for the severe delay in this release. 25 | 26 | Version 2.0 27 | 28 | This includes updates to work with Django 1.10, and bring the custom field code 29 | more in line with a modern setup. This has the side effect of working filtering 30 | by python date or datetime. 31 | 32 | I've done a major version bump as the ApproximateDateField instance will now 33 | return "" rather than None for an empty date, which is much more preferable 34 | because you always had to query empty dates using "", not None. Unlikely to 35 | break anything, given this behaviour was basically buggy, but seemed safest. 36 | 37 | I've also added better testing via tox, and fixed any flake8 issues. 38 | 39 | Thanks to John Lehmann and Aamir Adnan for reporting/tests. 40 | 41 | 42 | Version 1.1 43 | 44 | This version adds support for comparing ApproximateDate & date/datetime, and 45 | factors out settings to enable them to be overridden. 46 | 47 | Thanks to Baptiste Mispelon and jellevandehaterd for their contributions. 48 | 49 | 50 | Version 1.0 51 | 52 | First release. Thanks to Edmund von der Burg, Mark Longair, and Sandro Nardi 53 | for their contributions. 54 | -------------------------------------------------------------------------------- /LICENSE.txt: -------------------------------------------------------------------------------- 1 | mySociety.org Software Licensing 2 | 3 | Most of the software in this directory is Copyright (c) 2004-2010 UK 4 | Citizens Online Democracy. 5 | 6 | Unless otherwise stated in particular files or directories, this 7 | software is free software; you can redistribute it and/or modify it 8 | under the terms of the GNU Affero General Public License as published 9 | by the Free Software Foundation, either version 3 of the License, or 10 | (at your option) any later version. 11 | 12 | Can you explain briefly what the GNU Affero GPL is? We offer the 13 | source code of our websites to our users. The GNU Affero GPL has the 14 | requirement that anyone else using that code for their own websites 15 | also does the courtesy of offering the source code to their users. 16 | 17 | Why not use the GPL? The GPL guarantees that anyone who gets a binary 18 | version of the software also gets the source code so they can modify 19 | it. Since users of websites never get the binary, just HTML pages, it 20 | is no better a license than a BSD style license would be for them. 21 | For this reason, we use the GNU Affero GPL. 22 | 23 | This program is distributed in the hope that it will be useful, but 24 | WITHOUT ANY WARRANTY; without even the implied warranty of 25 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 26 | Affero General Public License for more details. 27 | 28 | Information about the GNU Affero GPL: 29 | http://www.fsf.org/licensing/licenses/agpl-3.0.html 30 | 31 | A copy of the GNU Affero General Public License follows. 32 | 33 | ----------------------------------------------------------------------- 34 | 35 | GNU AFFERO GENERAL PUBLIC LICENSE 36 | Version 3, 19 November 2007 37 | 38 | Copyright (C) 2007 Free Software Foundation, Inc. 39 | Everyone is permitted to copy and distribute verbatim copies 40 | of this license document, but changing it is not allowed. 41 | 42 | Preamble 43 | 44 | The GNU Affero General Public License is a free, copyleft license for 45 | software and other kinds of works, specifically designed to ensure 46 | cooperation with the community in the case of network server software. 47 | 48 | The licenses for most software and other practical works are designed 49 | to take away your freedom to share and change the works. By contrast, 50 | our General Public Licenses are intended to guarantee your freedom to 51 | share and change all versions of a program--to make sure it remains free 52 | software for all its users. 53 | 54 | When we speak of free software, we are referring to freedom, not 55 | price. Our General Public Licenses are designed to make sure that you 56 | have the freedom to distribute copies of free software (and charge for 57 | them if you wish), that you receive source code or can get it if you 58 | want it, that you can change the software or use pieces of it in new 59 | free programs, and that you know you can do these things. 60 | 61 | Developers that use our General Public Licenses protect your rights 62 | with two steps: (1) assert copyright on the software, and (2) offer 63 | you this License which gives you legal permission to copy, distribute 64 | and/or modify the software. 65 | 66 | A secondary benefit of defending all users' freedom is that 67 | improvements made in alternate versions of the program, if they 68 | receive widespread use, become available for other developers to 69 | incorporate. Many developers of free software are heartened and 70 | encouraged by the resulting cooperation. However, in the case of 71 | software used on network servers, this result may fail to come about. 72 | The GNU General Public License permits making a modified version and 73 | letting the public access it on a server without ever releasing its 74 | source code to the public. 75 | 76 | The GNU Affero General Public License is designed specifically to 77 | ensure that, in such cases, the modified source code becomes available 78 | to the community. It requires the operator of a network server to 79 | provide the source code of the modified version running there to the 80 | users of that server. Therefore, public use of a modified version, on 81 | a publicly accessible server, gives the public access to the source 82 | code of the modified version. 83 | 84 | An older license, called the Affero General Public License and 85 | published by Affero, was designed to accomplish similar goals. This is 86 | a different license, not a version of the Affero GPL, but Affero has 87 | released a new version of the Affero GPL which permits relicensing under 88 | this license. 89 | 90 | The precise terms and conditions for copying, distribution and 91 | modification follow. 92 | 93 | TERMS AND CONDITIONS 94 | 95 | 0. Definitions. 96 | 97 | "This License" refers to version 3 of the GNU Affero General Public License. 98 | 99 | "Copyright" also means copyright-like laws that apply to other kinds of 100 | works, such as semiconductor masks. 101 | 102 | "The Program" refers to any copyrightable work licensed under this 103 | License. Each licensee is addressed as "you". "Licensees" and 104 | "recipients" may be individuals or organizations. 105 | 106 | To "modify" a work means to copy from or adapt all or part of the work 107 | in a fashion requiring copyright permission, other than the making of an 108 | exact copy. The resulting work is called a "modified version" of the 109 | earlier work or a work "based on" the earlier work. 110 | 111 | A "covered work" means either the unmodified Program or a work based 112 | on the Program. 113 | 114 | To "propagate" a work means to do anything with it that, without 115 | permission, would make you directly or secondarily liable for 116 | infringement under applicable copyright law, except executing it on a 117 | computer or modifying a private copy. Propagation includes copying, 118 | distribution (with or without modification), making available to the 119 | public, and in some countries other activities as well. 120 | 121 | To "convey" a work means any kind of propagation that enables other 122 | parties to make or receive copies. Mere interaction with a user through 123 | a computer network, with no transfer of a copy, is not conveying. 124 | 125 | An interactive user interface displays "Appropriate Legal Notices" 126 | to the extent that it includes a convenient and prominently visible 127 | feature that (1) displays an appropriate copyright notice, and (2) 128 | tells the user that there is no warranty for the work (except to the 129 | extent that warranties are provided), that licensees may convey the 130 | work under this License, and how to view a copy of this License. If 131 | the interface presents a list of user commands or options, such as a 132 | menu, a prominent item in the list meets this criterion. 133 | 134 | 1. Source Code. 135 | 136 | The "source code" for a work means the preferred form of the work 137 | for making modifications to it. "Object code" means any non-source 138 | form of a work. 139 | 140 | A "Standard Interface" means an interface that either is an official 141 | standard defined by a recognized standards body, or, in the case of 142 | interfaces specified for a particular programming language, one that 143 | is widely used among developers working in that language. 144 | 145 | The "System Libraries" of an executable work include anything, other 146 | than the work as a whole, that (a) is included in the normal form of 147 | packaging a Major Component, but which is not part of that Major 148 | Component, and (b) serves only to enable use of the work with that 149 | Major Component, or to implement a Standard Interface for which an 150 | implementation is available to the public in source code form. A 151 | "Major Component", in this context, means a major essential component 152 | (kernel, window system, and so on) of the specific operating system 153 | (if any) on which the executable work runs, or a compiler used to 154 | produce the work, or an object code interpreter used to run it. 155 | 156 | The "Corresponding Source" for a work in object code form means all 157 | the source code needed to generate, install, and (for an executable 158 | work) run the object code and to modify the work, including scripts to 159 | control those activities. However, it does not include the work's 160 | System Libraries, or general-purpose tools or generally available free 161 | programs which are used unmodified in performing those activities but 162 | which are not part of the work. For example, Corresponding Source 163 | includes interface definition files associated with source files for 164 | the work, and the source code for shared libraries and dynamically 165 | linked subprograms that the work is specifically designed to require, 166 | such as by intimate data communication or control flow between those 167 | subprograms and other parts of the work. 168 | 169 | The Corresponding Source need not include anything that users 170 | can regenerate automatically from other parts of the Corresponding 171 | Source. 172 | 173 | The Corresponding Source for a work in source code form is that 174 | same work. 175 | 176 | 2. Basic Permissions. 177 | 178 | All rights granted under this License are granted for the term of 179 | copyright on the Program, and are irrevocable provided the stated 180 | conditions are met. This License explicitly affirms your unlimited 181 | permission to run the unmodified Program. The output from running a 182 | covered work is covered by this License only if the output, given its 183 | content, constitutes a covered work. This License acknowledges your 184 | rights of fair use or other equivalent, as provided by copyright law. 185 | 186 | You may make, run and propagate covered works that you do not 187 | convey, without conditions so long as your license otherwise remains 188 | in force. You may convey covered works to others for the sole purpose 189 | of having them make modifications exclusively for you, or provide you 190 | with facilities for running those works, provided that you comply with 191 | the terms of this License in conveying all material for which you do 192 | not control copyright. Those thus making or running the covered works 193 | for you must do so exclusively on your behalf, under your direction 194 | and control, on terms that prohibit them from making any copies of 195 | your copyrighted material outside their relationship with you. 196 | 197 | Conveying under any other circumstances is permitted solely under 198 | the conditions stated below. Sublicensing is not allowed; section 10 199 | makes it unnecessary. 200 | 201 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 202 | 203 | No covered work shall be deemed part of an effective technological 204 | measure under any applicable law fulfilling obligations under article 205 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 206 | similar laws prohibiting or restricting circumvention of such 207 | measures. 208 | 209 | When you convey a covered work, you waive any legal power to forbid 210 | circumvention of technological measures to the extent such circumvention 211 | is effected by exercising rights under this License with respect to 212 | the covered work, and you disclaim any intention to limit operation or 213 | modification of the work as a means of enforcing, against the work's 214 | users, your or third parties' legal rights to forbid circumvention of 215 | technological measures. 216 | 217 | 4. Conveying Verbatim Copies. 218 | 219 | You may convey verbatim copies of the Program's source code as you 220 | receive it, in any medium, provided that you conspicuously and 221 | appropriately publish on each copy an appropriate copyright notice; 222 | keep intact all notices stating that this License and any 223 | non-permissive terms added in accord with section 7 apply to the code; 224 | keep intact all notices of the absence of any warranty; and give all 225 | recipients a copy of this License along with the Program. 226 | 227 | You may charge any price or no price for each copy that you convey, 228 | and you may offer support or warranty protection for a fee. 229 | 230 | 5. Conveying Modified Source Versions. 231 | 232 | You may convey a work based on the Program, or the modifications to 233 | produce it from the Program, in the form of source code under the 234 | terms of section 4, provided that you also meet all of these conditions: 235 | 236 | a) The work must carry prominent notices stating that you modified 237 | it, and giving a relevant date. 238 | 239 | b) The work must carry prominent notices stating that it is 240 | released under this License and any conditions added under section 241 | 7. This requirement modifies the requirement in section 4 to 242 | "keep intact all notices". 243 | 244 | c) You must license the entire work, as a whole, under this 245 | License to anyone who comes into possession of a copy. This 246 | License will therefore apply, along with any applicable section 7 247 | additional terms, to the whole of the work, and all its parts, 248 | regardless of how they are packaged. This License gives no 249 | permission to license the work in any other way, but it does not 250 | invalidate such permission if you have separately received it. 251 | 252 | d) If the work has interactive user interfaces, each must display 253 | Appropriate Legal Notices; however, if the Program has interactive 254 | interfaces that do not display Appropriate Legal Notices, your 255 | work need not make them do so. 256 | 257 | A compilation of a covered work with other separate and independent 258 | works, which are not by their nature extensions of the covered work, 259 | and which are not combined with it such as to form a larger program, 260 | in or on a volume of a storage or distribution medium, is called an 261 | "aggregate" if the compilation and its resulting copyright are not 262 | used to limit the access or legal rights of the compilation's users 263 | beyond what the individual works permit. Inclusion of a covered work 264 | in an aggregate does not cause this License to apply to the other 265 | parts of the aggregate. 266 | 267 | 6. Conveying Non-Source Forms. 268 | 269 | You may convey a covered work in object code form under the terms 270 | of sections 4 and 5, provided that you also convey the 271 | machine-readable Corresponding Source under the terms of this License, 272 | in one of these ways: 273 | 274 | a) Convey the object code in, or embodied in, a physical product 275 | (including a physical distribution medium), accompanied by the 276 | Corresponding Source fixed on a durable physical medium 277 | customarily used for software interchange. 278 | 279 | b) Convey the object code in, or embodied in, a physical product 280 | (including a physical distribution medium), accompanied by a 281 | written offer, valid for at least three years and valid for as 282 | long as you offer spare parts or customer support for that product 283 | model, to give anyone who possesses the object code either (1) a 284 | copy of the Corresponding Source for all the software in the 285 | product that is covered by this License, on a durable physical 286 | medium customarily used for software interchange, for a price no 287 | more than your reasonable cost of physically performing this 288 | conveying of source, or (2) access to copy the 289 | Corresponding Source from a network server at no charge. 290 | 291 | c) Convey individual copies of the object code with a copy of the 292 | written offer to provide the Corresponding Source. This 293 | alternative is allowed only occasionally and noncommercially, and 294 | only if you received the object code with such an offer, in accord 295 | with subsection 6b. 296 | 297 | d) Convey the object code by offering access from a designated 298 | place (gratis or for a charge), and offer equivalent access to the 299 | Corresponding Source in the same way through the same place at no 300 | further charge. You need not require recipients to copy the 301 | Corresponding Source along with the object code. If the place to 302 | copy the object code is a network server, the Corresponding Source 303 | may be on a different server (operated by you or a third party) 304 | that supports equivalent copying facilities, provided you maintain 305 | clear directions next to the object code saying where to find the 306 | Corresponding Source. Regardless of what server hosts the 307 | Corresponding Source, you remain obligated to ensure that it is 308 | available for as long as needed to satisfy these requirements. 309 | 310 | e) Convey the object code using peer-to-peer transmission, provided 311 | you inform other peers where the object code and Corresponding 312 | Source of the work are being offered to the general public at no 313 | charge under subsection 6d. 314 | 315 | A separable portion of the object code, whose source code is excluded 316 | from the Corresponding Source as a System Library, need not be 317 | included in conveying the object code work. 318 | 319 | A "User Product" is either (1) a "consumer product", which means any 320 | tangible personal property which is normally used for personal, family, 321 | or household purposes, or (2) anything designed or sold for incorporation 322 | into a dwelling. In determining whether a product is a consumer product, 323 | doubtful cases shall be resolved in favor of coverage. For a particular 324 | product received by a particular user, "normally used" refers to a 325 | typical or common use of that class of product, regardless of the status 326 | of the particular user or of the way in which the particular user 327 | actually uses, or expects or is expected to use, the product. A product 328 | is a consumer product regardless of whether the product has substantial 329 | commercial, industrial or non-consumer uses, unless such uses represent 330 | the only significant mode of use of the product. 331 | 332 | "Installation Information" for a User Product means any methods, 333 | procedures, authorization keys, or other information required to install 334 | and execute modified versions of a covered work in that User Product from 335 | a modified version of its Corresponding Source. The information must 336 | suffice to ensure that the continued functioning of the modified object 337 | code is in no case prevented or interfered with solely because 338 | modification has been made. 339 | 340 | If you convey an object code work under this section in, or with, or 341 | specifically for use in, a User Product, and the conveying occurs as 342 | part of a transaction in which the right of possession and use of the 343 | User Product is transferred to the recipient in perpetuity or for a 344 | fixed term (regardless of how the transaction is characterized), the 345 | Corresponding Source conveyed under this section must be accompanied 346 | by the Installation Information. But this requirement does not apply 347 | if neither you nor any third party retains the ability to install 348 | modified object code on the User Product (for example, the work has 349 | been installed in ROM). 350 | 351 | The requirement to provide Installation Information does not include a 352 | requirement to continue to provide support service, warranty, or updates 353 | for a work that has been modified or installed by the recipient, or for 354 | the User Product in which it has been modified or installed. Access to a 355 | network may be denied when the modification itself materially and 356 | adversely affects the operation of the network or violates the rules and 357 | protocols for communication across the network. 358 | 359 | Corresponding Source conveyed, and Installation Information provided, 360 | in accord with this section must be in a format that is publicly 361 | documented (and with an implementation available to the public in 362 | source code form), and must require no special password or key for 363 | unpacking, reading or copying. 364 | 365 | 7. Additional Terms. 366 | 367 | "Additional permissions" are terms that supplement the terms of this 368 | License by making exceptions from one or more of its conditions. 369 | Additional permissions that are applicable to the entire Program shall 370 | be treated as though they were included in this License, to the extent 371 | that they are valid under applicable law. If additional permissions 372 | apply only to part of the Program, that part may be used separately 373 | under those permissions, but the entire Program remains governed by 374 | this License without regard to the additional permissions. 375 | 376 | When you convey a copy of a covered work, you may at your option 377 | remove any additional permissions from that copy, or from any part of 378 | it. (Additional permissions may be written to require their own 379 | removal in certain cases when you modify the work.) You may place 380 | additional permissions on material, added by you to a covered work, 381 | for which you have or can give appropriate copyright permission. 382 | 383 | Notwithstanding any other provision of this License, for material you 384 | add to a covered work, you may (if authorized by the copyright holders of 385 | that material) supplement the terms of this License with terms: 386 | 387 | a) Disclaiming warranty or limiting liability differently from the 388 | terms of sections 15 and 16 of this License; or 389 | 390 | b) Requiring preservation of specified reasonable legal notices or 391 | author attributions in that material or in the Appropriate Legal 392 | Notices displayed by works containing it; or 393 | 394 | c) Prohibiting misrepresentation of the origin of that material, or 395 | requiring that modified versions of such material be marked in 396 | reasonable ways as different from the original version; or 397 | 398 | d) Limiting the use for publicity purposes of names of licensors or 399 | authors of the material; or 400 | 401 | e) Declining to grant rights under trademark law for use of some 402 | trade names, trademarks, or service marks; or 403 | 404 | f) Requiring indemnification of licensors and authors of that 405 | material by anyone who conveys the material (or modified versions of 406 | it) with contractual assumptions of liability to the recipient, for 407 | any liability that these contractual assumptions directly impose on 408 | those licensors and authors. 409 | 410 | All other non-permissive additional terms are considered "further 411 | restrictions" within the meaning of section 10. If the Program as you 412 | received it, or any part of it, contains a notice stating that it is 413 | governed by this License along with a term that is a further 414 | restriction, you may remove that term. If a license document contains 415 | a further restriction but permits relicensing or conveying under this 416 | License, you may add to a covered work material governed by the terms 417 | of that license document, provided that the further restriction does 418 | not survive such relicensing or conveying. 419 | 420 | If you add terms to a covered work in accord with this section, you 421 | must place, in the relevant source files, a statement of the 422 | additional terms that apply to those files, or a notice indicating 423 | where to find the applicable terms. 424 | 425 | Additional terms, permissive or non-permissive, may be stated in the 426 | form of a separately written license, or stated as exceptions; 427 | the above requirements apply either way. 428 | 429 | 8. Termination. 430 | 431 | You may not propagate or modify a covered work except as expressly 432 | provided under this License. Any attempt otherwise to propagate or 433 | modify it is void, and will automatically terminate your rights under 434 | this License (including any patent licenses granted under the third 435 | paragraph of section 11). 436 | 437 | However, if you cease all violation of this License, then your 438 | license from a particular copyright holder is reinstated (a) 439 | provisionally, unless and until the copyright holder explicitly and 440 | finally terminates your license, and (b) permanently, if the copyright 441 | holder fails to notify you of the violation by some reasonable means 442 | prior to 60 days after the cessation. 443 | 444 | Moreover, your license from a particular copyright holder is 445 | reinstated permanently if the copyright holder notifies you of the 446 | violation by some reasonable means, this is the first time you have 447 | received notice of violation of this License (for any work) from that 448 | copyright holder, and you cure the violation prior to 30 days after 449 | your receipt of the notice. 450 | 451 | Termination of your rights under this section does not terminate the 452 | licenses of parties who have received copies or rights from you under 453 | this License. If your rights have been terminated and not permanently 454 | reinstated, you do not qualify to receive new licenses for the same 455 | material under section 10. 456 | 457 | 9. Acceptance Not Required for Having Copies. 458 | 459 | You are not required to accept this License in order to receive or 460 | run a copy of the Program. Ancillary propagation of a covered work 461 | occurring solely as a consequence of using peer-to-peer transmission 462 | to receive a copy likewise does not require acceptance. However, 463 | nothing other than this License grants you permission to propagate or 464 | modify any covered work. These actions infringe copyright if you do 465 | not accept this License. Therefore, by modifying or propagating a 466 | covered work, you indicate your acceptance of this License to do so. 467 | 468 | 10. Automatic Licensing of Downstream Recipients. 469 | 470 | Each time you convey a covered work, the recipient automatically 471 | receives a license from the original licensors, to run, modify and 472 | propagate that work, subject to this License. You are not responsible 473 | for enforcing compliance by third parties with this License. 474 | 475 | An "entity transaction" is a transaction transferring control of an 476 | organization, or substantially all assets of one, or subdividing an 477 | organization, or merging organizations. If propagation of a covered 478 | work results from an entity transaction, each party to that 479 | transaction who receives a copy of the work also receives whatever 480 | licenses to the work the party's predecessor in interest had or could 481 | give under the previous paragraph, plus a right to possession of the 482 | Corresponding Source of the work from the predecessor in interest, if 483 | the predecessor has it or can get it with reasonable efforts. 484 | 485 | You may not impose any further restrictions on the exercise of the 486 | rights granted or affirmed under this License. For example, you may 487 | not impose a license fee, royalty, or other charge for exercise of 488 | rights granted under this License, and you may not initiate litigation 489 | (including a cross-claim or counterclaim in a lawsuit) alleging that 490 | any patent claim is infringed by making, using, selling, offering for 491 | sale, or importing the Program or any portion of it. 492 | 493 | 11. Patents. 494 | 495 | A "contributor" is a copyright holder who authorizes use under this 496 | License of the Program or a work on which the Program is based. The 497 | work thus licensed is called the contributor's "contributor version". 498 | 499 | A contributor's "essential patent claims" are all patent claims 500 | owned or controlled by the contributor, whether already acquired or 501 | hereafter acquired, that would be infringed by some manner, permitted 502 | by this License, of making, using, or selling its contributor version, 503 | but do not include claims that would be infringed only as a 504 | consequence of further modification of the contributor version. For 505 | purposes of this definition, "control" includes the right to grant 506 | patent sublicenses in a manner consistent with the requirements of 507 | this License. 508 | 509 | Each contributor grants you a non-exclusive, worldwide, royalty-free 510 | patent license under the contributor's essential patent claims, to 511 | make, use, sell, offer for sale, import and otherwise run, modify and 512 | propagate the contents of its contributor version. 513 | 514 | In the following three paragraphs, a "patent license" is any express 515 | agreement or commitment, however denominated, not to enforce a patent 516 | (such as an express permission to practice a patent or covenant not to 517 | sue for patent infringement). To "grant" such a patent license to a 518 | party means to make such an agreement or commitment not to enforce a 519 | patent against the party. 520 | 521 | If you convey a covered work, knowingly relying on a patent license, 522 | and the Corresponding Source of the work is not available for anyone 523 | to copy, free of charge and under the terms of this License, through a 524 | publicly available network server or other readily accessible means, 525 | then you must either (1) cause the Corresponding Source to be so 526 | available, or (2) arrange to deprive yourself of the benefit of the 527 | patent license for this particular work, or (3) arrange, in a manner 528 | consistent with the requirements of this License, to extend the patent 529 | license to downstream recipients. "Knowingly relying" means you have 530 | actual knowledge that, but for the patent license, your conveying the 531 | covered work in a country, or your recipient's use of the covered work 532 | in a country, would infringe one or more identifiable patents in that 533 | country that you have reason to believe are valid. 534 | 535 | If, pursuant to or in connection with a single transaction or 536 | arrangement, you convey, or propagate by procuring conveyance of, a 537 | covered work, and grant a patent license to some of the parties 538 | receiving the covered work authorizing them to use, propagate, modify 539 | or convey a specific copy of the covered work, then the patent license 540 | you grant is automatically extended to all recipients of the covered 541 | work and works based on it. 542 | 543 | A patent license is "discriminatory" if it does not include within 544 | the scope of its coverage, prohibits the exercise of, or is 545 | conditioned on the non-exercise of one or more of the rights that are 546 | specifically granted under this License. You may not convey a covered 547 | work if you are a party to an arrangement with a third party that is 548 | in the business of distributing software, under which you make payment 549 | to the third party based on the extent of your activity of conveying 550 | the work, and under which the third party grants, to any of the 551 | parties who would receive the covered work from you, a discriminatory 552 | patent license (a) in connection with copies of the covered work 553 | conveyed by you (or copies made from those copies), or (b) primarily 554 | for and in connection with specific products or compilations that 555 | contain the covered work, unless you entered into that arrangement, 556 | or that patent license was granted, prior to 28 March 2007. 557 | 558 | Nothing in this License shall be construed as excluding or limiting 559 | any implied license or other defenses to infringement that may 560 | otherwise be available to you under applicable patent law. 561 | 562 | 12. No Surrender of Others' Freedom. 563 | 564 | If conditions are imposed on you (whether by court order, agreement or 565 | otherwise) that contradict the conditions of this License, they do not 566 | excuse you from the conditions of this License. If you cannot convey a 567 | covered work so as to satisfy simultaneously your obligations under this 568 | License and any other pertinent obligations, then as a consequence you may 569 | not convey it at all. For example, if you agree to terms that obligate you 570 | to collect a royalty for further conveying from those to whom you convey 571 | the Program, the only way you could satisfy both those terms and this 572 | License would be to refrain entirely from conveying the Program. 573 | 574 | 13. Remote Network Interaction; Use with the GNU General Public License. 575 | 576 | Notwithstanding any other provision of this License, if you modify the 577 | Program, your modified version must prominently offer all users 578 | interacting with it remotely through a computer network (if your version 579 | supports such interaction) an opportunity to receive the Corresponding 580 | Source of your version by providing access to the Corresponding Source 581 | from a network server at no charge, through some standard or customary 582 | means of facilitating copying of software. This Corresponding Source 583 | shall include the Corresponding Source for any work covered by version 3 584 | of the GNU General Public License that is incorporated pursuant to the 585 | following paragraph. 586 | 587 | Notwithstanding any other provision of this License, you have 588 | permission to link or combine any covered work with a work licensed 589 | under version 3 of the GNU General Public License into a single 590 | combined work, and to convey the resulting work. The terms of this 591 | License will continue to apply to the part which is the covered work, 592 | but the work with which it is combined will remain governed by version 593 | 3 of the GNU General Public License. 594 | 595 | 14. Revised Versions of this License. 596 | 597 | The Free Software Foundation may publish revised and/or new versions of 598 | the GNU Affero General Public License from time to time. Such new versions 599 | will be similar in spirit to the present version, but may differ in detail to 600 | address new problems or concerns. 601 | 602 | Each version is given a distinguishing version number. If the 603 | Program specifies that a certain numbered version of the GNU Affero General 604 | Public License "or any later version" applies to it, you have the 605 | option of following the terms and conditions either of that numbered 606 | version or of any later version published by the Free Software 607 | Foundation. If the Program does not specify a version number of the 608 | GNU Affero General Public License, you may choose any version ever published 609 | by the Free Software Foundation. 610 | 611 | If the Program specifies that a proxy can decide which future 612 | versions of the GNU Affero General Public License can be used, that proxy's 613 | public statement of acceptance of a version permanently authorizes you 614 | to choose that version for the Program. 615 | 616 | Later license versions may give you additional or different 617 | permissions. However, no additional obligations are imposed on any 618 | author or copyright holder as a result of your choosing to follow a 619 | later version. 620 | 621 | 15. Disclaimer of Warranty. 622 | 623 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 624 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 625 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 626 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 627 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 628 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 629 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 630 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 631 | 632 | 16. Limitation of Liability. 633 | 634 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 635 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 636 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 637 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 638 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 639 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 640 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 641 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 642 | SUCH DAMAGES. 643 | 644 | 17. Interpretation of Sections 15 and 16. 645 | 646 | If the disclaimer of warranty and limitation of liability provided 647 | above cannot be given local legal effect according to their terms, 648 | reviewing courts shall apply local law that most closely approximates 649 | an absolute waiver of all civil liability in connection with the 650 | Program, unless a warranty or assumption of liability accompanies a 651 | copy of the Program in return for a fee. 652 | 653 | END OF TERMS AND CONDITIONS 654 | 655 | How to Apply These Terms to Your New Programs 656 | 657 | If you develop a new program, and you want it to be of the greatest 658 | possible use to the public, the best way to achieve this is to make it 659 | free software which everyone can redistribute and change under these terms. 660 | 661 | To do so, attach the following notices to the program. It is safest 662 | to attach them to the start of each source file to most effectively 663 | state the exclusion of warranty; and each file should have at least 664 | the "copyright" line and a pointer to where the full notice is found. 665 | 666 | 667 | Copyright (C) 668 | 669 | This program is free software: you can redistribute it and/or modify 670 | it under the terms of the GNU Affero General Public License as published by 671 | the Free Software Foundation, either version 3 of the License, or 672 | (at your option) any later version. 673 | 674 | This program is distributed in the hope that it will be useful, 675 | but WITHOUT ANY WARRANTY; without even the implied warranty of 676 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 677 | GNU Affero General Public License for more details. 678 | 679 | You should have received a copy of the GNU Affero General Public License 680 | along with this program. If not, see . 681 | 682 | Also add information on how to contact you by electronic and paper mail. 683 | 684 | If your software can interact with users remotely through a computer 685 | network, you should also make sure that it provides a way for users to 686 | get its source. For example, if your program is a web application, its 687 | interface could display a "Source" link that leads users to an archive 688 | of the code. There are many ways you could offer source, and different 689 | solutions will be better for different programs; see section 13 for the 690 | specific requirements. 691 | 692 | You should also get your employer (if you work as a programmer) or school, 693 | if any, to sign a "copyright disclaimer" for the program, if necessary. 694 | For more information on this, and how to apply and follow the GNU AGPL, see 695 | . 696 | 697 | -------------------------------------------------------------------------------- /README.txt: -------------------------------------------------------------------------------- 1 | django-date-extensions 2 | by Matthew Somerville 3 | 4 | This code adds a few small extensions to Django's DateField, to handle both 5 | approximate dates (e.g. "March 1963") and default year dates (e.g. assume 6 | "24th June" is the most recent such). 7 | 8 | example contains a hopefully self-contained Django project that simply shows 9 | off a form with these methods of entry. 10 | 11 | Approximate dates 12 | ================= 13 | 14 | A new object, ApproximateDate, is used to represent dates that might not have a 15 | month or a day. ApproximateDateField is the model field used to represent these 16 | objects in a Model, and ApproximateDateFormField is the field used in a Django 17 | form. Everything should work seamlessly simply by specifying a model field as 18 | ApproximateDateField rather than DateField. 19 | 20 | Default year dates 21 | ================== 22 | 23 | PrettyDateField is a form field to be used on DateField model fields. It takes 24 | one argument, future, which is a nullable boolean. If True, a date input that 25 | is missing a year will be taken to be the next possible occurrence of that date 26 | - e.g. on 24th November 2009, entering 24th December will be taken to be 27 | 2009-12-24, whilst entering 3rd March will be taken to be 2010-03-03. If future 28 | is False, the reverse occurs, with year-less dates being assumed to be the 29 | closest occurrence of that date in the past. 30 | 31 | If future is not set, then PrettyDateField acts the same as a DateField, only 32 | allows suffixes on ordinals, and assumes D/M/Y rather than M/D/Y. 33 | 34 | Testing 35 | ======= 36 | Run 'tox' with tox installed. 37 | 38 | Todo 39 | ==== 40 | 41 | Improve date parsing to take more inputs like my traintimes.org.uk PHP, such as 42 | "next Friday". 43 | 44 | 45 | Any queries or comments, do get in touch. Something's probably broken, as I tried 46 | to tidy up the code a little for public release :) 47 | 48 | Matthew Somerville. 49 | -------------------------------------------------------------------------------- /django_date_extensions/__init__.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/dracos/django-date-extensions/2694f13566b0f097bf8e31c4c6628b85b75b98eb/django_date_extensions/__init__.py -------------------------------------------------------------------------------- /django_date_extensions/fields.py: -------------------------------------------------------------------------------- 1 | import datetime 2 | import time 3 | import re 4 | from functools import total_ordering 5 | 6 | from django.db import models 7 | from django import forms 8 | from django.forms import ValidationError 9 | from django.utils import dateformat 10 | try: 11 | from django.utils.encoding import python_2_unicode_compatible 12 | except ImportError: 13 | # Django 3+, no longer present, we know wre are Python 3, so can be null 14 | def python_2_unicode_compatible(f): return f 15 | 16 | from . import settings 17 | from .widgets import PrettyDateInput 18 | 19 | 20 | @total_ordering 21 | @python_2_unicode_compatible 22 | class ApproximateDate(object): 23 | """A date object that accepts 0 for month or day to mean we don't 24 | know when it is within that month/year.""" 25 | def __init__(self, year=0, month=0, day=0, future=False, past=False): 26 | if future and past: 27 | raise ValueError("Can't be both future and past") 28 | elif future or past: 29 | if year or month or day: 30 | raise ValueError("Future or past dates can have no year, month or day") 31 | elif year and month and day: 32 | datetime.date(year, month, day) 33 | elif year and month: 34 | datetime.date(year, month, 1) 35 | elif year and day: 36 | raise ValueError("You cannot specify just a year and a day") 37 | elif year: 38 | datetime.date(year, 1, 1) 39 | else: 40 | raise ValueError("You must specify a year") 41 | 42 | self.future = future 43 | self.past = past 44 | self.year = year 45 | self.month = month 46 | self.day = day 47 | 48 | def __repr__(self): 49 | if self.future or self.past: 50 | return str(self) 51 | return "{year:04d}-{month:02d}-{day:02d}".format(year=self.year, month=self.month, day=self.day) 52 | 53 | def __str__(self): 54 | if self.future: 55 | return 'future' 56 | if self.past: 57 | return 'past' 58 | elif self.year and self.month and self.day: 59 | return dateformat.format(self, settings.OUTPUT_FORMAT_DAY_MONTH_YEAR) 60 | elif self.year and self.month: 61 | return dateformat.format(self, settings.OUTPUT_FORMAT_MONTH_YEAR) 62 | elif self.year: 63 | return dateformat.format(self, settings.OUTPUT_FORMAT_YEAR) 64 | 65 | def __eq__(self, other): 66 | if isinstance(other, (datetime.date, datetime.datetime)): 67 | return (self.year, self.month, self.day) ==\ 68 | (other.year, other.month, other.day) 69 | 70 | if not isinstance(other, ApproximateDate): 71 | return False 72 | 73 | return (self.year, self.month, self.day, self.future, self.past) ==\ 74 | (other.year, other.month, other.day, other.future, other.past) 75 | 76 | def __ne__(self, other): 77 | return not (self == other) 78 | 79 | def __lt__(self, other): 80 | if other is None: 81 | return False 82 | 83 | if isinstance(other, ApproximateDate): 84 | if self.future or other.future: 85 | return not self.future 86 | if self.past or other.past: 87 | return not other.past 88 | 89 | return (self.year, self.month, self.day) < (other.year, other.month, other.day) 90 | 91 | def __len__(self): 92 | return len(self.__repr__()) 93 | 94 | 95 | ansi_date_re = re.compile(r'^\d{4}-\d{1,2}-\d{1,2}$') 96 | 97 | 98 | class ApproximateDateField(models.CharField): 99 | """A model field to store ApproximateDate objects in the database 100 | (as a CharField because MySQLdb intercepts dates from the 101 | database and forces them to be datetime.date()s.""" 102 | 103 | description = "An approximate date" 104 | 105 | def __init__(self, *args, **kwargs): 106 | kwargs['max_length'] = 10 107 | super(ApproximateDateField, self).__init__(*args, **kwargs) 108 | 109 | def deconstruct(self): 110 | name, path, args, kwargs = super(ApproximateDateField, self).deconstruct() 111 | del kwargs['max_length'] 112 | return name, path, args, kwargs 113 | 114 | def to_python(self, value): 115 | if isinstance(value, ApproximateDate): 116 | return value 117 | 118 | return self.from_db_value(value) 119 | 120 | def from_db_value(self, value, *args, **kwarsg): 121 | if not value: 122 | return '' 123 | 124 | if value == 'future': 125 | return ApproximateDate(future=True) 126 | if value == 'past': 127 | return ApproximateDate(past=True) 128 | 129 | if not ansi_date_re.search(value): 130 | raise ValidationError('Enter a valid date in YYYY-MM-DD format.') 131 | 132 | year, month, day = map(int, value.split('-')) 133 | try: 134 | return ApproximateDate(year, month, day) 135 | except ValueError as e: 136 | msg = 'Invalid date: %s' % str(e) 137 | raise ValidationError(msg) 138 | 139 | def get_prep_value(self, value): 140 | if not value: 141 | return '' 142 | if isinstance(value, ApproximateDate): 143 | return repr(value) 144 | if isinstance(value, datetime.date): 145 | return dateformat.format(value, "Y-m-d") 146 | if value == 'future': 147 | return 'future' 148 | if value == 'past': 149 | return 'past' 150 | if not ansi_date_re.search(value): 151 | raise ValidationError('Enter a valid date in YYYY-MM-DD format.') 152 | return value 153 | 154 | def value_to_string(self, obj): 155 | value = self.value_from_object(obj) 156 | return self.get_prep_value(value) 157 | 158 | def formfield(self, **kwargs): 159 | defaults = {'form_class': ApproximateDateFormField} 160 | defaults.update(kwargs) 161 | return super(ApproximateDateField, self).formfield(**defaults) 162 | 163 | # def get_db_prep_lookup(self, lookup_type, value): 164 | # pass 165 | 166 | 167 | # TODO: Expand to work more like my PHP strtotime()-using function 168 | class ApproximateDateFormField(forms.fields.Field): 169 | def __init__(self, max_length=10, empty_value='', *args, **kwargs): 170 | super(ApproximateDateFormField, self).__init__(*args, **kwargs) 171 | 172 | def clean(self, value): 173 | super(ApproximateDateFormField, self).clean(value) 174 | if not value: 175 | return None 176 | if value == 'future': 177 | return ApproximateDate(future=True) 178 | if value == 'past': 179 | return ApproximateDate(past=True) 180 | if isinstance(value, ApproximateDate): 181 | return value 182 | value = re.sub(r'(?<=\d)(st|nd|rd|th)', '', value.strip()) 183 | for date_format in settings.DATE_INPUT_FORMATS: 184 | try: 185 | return ApproximateDate(*time.strptime(value, date_format)[:3]) 186 | except ValueError: 187 | continue 188 | for month_format in settings.MONTH_INPUT_FORMATS: 189 | try: 190 | match = time.strptime(value, month_format) 191 | return ApproximateDate(match[0], match[1], 0) 192 | except ValueError: 193 | continue 194 | for year_format in settings.YEAR_INPUT_FORMATS: 195 | try: 196 | return ApproximateDate(time.strptime(value, year_format)[0], 0, 0) 197 | except ValueError: 198 | continue 199 | raise ValidationError('Please enter a valid date.') 200 | 201 | 202 | # PrettyDateField - same as DateField but accepts slightly more input, 203 | # like ApproximateDateFormField above. If initialised with future=True, 204 | # it will assume a date without year means the current year (or the next 205 | # year if the day is before the current date). If future=False, it does 206 | # the same but in the past. 207 | class PrettyDateField(forms.fields.Field): 208 | widget = PrettyDateInput 209 | 210 | def __init__(self, future=None, *args, **kwargs): 211 | self.future = future 212 | super(PrettyDateField, self).__init__(*args, **kwargs) 213 | 214 | def clean(self, value): 215 | """ 216 | Validates that the input can be converted to a date. Returns a Python 217 | datetime.date object. 218 | """ 219 | super(PrettyDateField, self).clean(value) 220 | if not value: 221 | return None 222 | if value == 'future': 223 | return ApproximateDate(future=True) 224 | if value == 'past': 225 | return ApproximateDate(past=True) 226 | if isinstance(value, datetime.datetime): 227 | return value.date() 228 | if isinstance(value, datetime.date): 229 | return value 230 | value = re.sub(r'(?<=\d)(st|nd|rd|th)', '', value.strip()) 231 | for date_input_format in settings.DATE_INPUT_FORMATS: 232 | try: 233 | return datetime.date(*time.strptime(value, date_input_format)[:3]) 234 | except ValueError: 235 | continue 236 | 237 | if self.future is None: 238 | raise ValidationError('Please enter a valid date.') 239 | 240 | # Allow year to be omitted. Do the sensible thing, either past or future. 241 | for day_month_input_format in settings.DAY_MONTH_INPUT_FORMATS: 242 | try: 243 | t = time.strptime(value, day_month_input_format) 244 | month, day, yday = t[1], t[2], t[7] 245 | year = datetime.date.today().year 246 | if self.future and yday < int(datetime.date.today().strftime('%j')): 247 | year += 1 248 | if not self.future and yday > int(datetime.date.today().strftime('%j')): 249 | year -= 1 250 | return datetime.date(year, month, day) 251 | except ValueError: 252 | continue 253 | 254 | raise ValidationError('Please enter a valid date.') 255 | -------------------------------------------------------------------------------- /django_date_extensions/models.py: -------------------------------------------------------------------------------- 1 | # Require to run the tests using `./manage.py test ...` 2 | -------------------------------------------------------------------------------- /django_date_extensions/settings.py: -------------------------------------------------------------------------------- 1 | from django.conf import settings 2 | 3 | OUTPUT_FORMAT_DAY_MONTH_YEAR = getattr(settings, 'DATE_EXTENSIONS_OUTPUT_FORMAT_DAY_MONTH_YEAR', "jS F Y") 4 | 5 | OUTPUT_FORMAT_MONTH_YEAR = getattr(settings, 'DATE_EXTENSIONS_OUTPUT_FORMAT_MONTH_YEAR', "F Y") 6 | 7 | OUTPUT_FORMAT_YEAR = getattr(settings, 'DATE_EXTENSIONS_OUTPUT_FORMAT_YEAR', "Y") 8 | 9 | # The same as the built-in Django one, but with the d/m/y ones the right way round ;) 10 | DATE_INPUT_FORMATS = getattr(settings, 'DATE_EXTENSIONS_DATE_INPUT_FORMATS', ( 11 | '%Y-%m-%d', # '2006-10-25', 12 | '%d/%m/%Y', '%d/%m/%y', # '25/10/2006', '25/10/06' 13 | '%b %d %Y', '%b %d, %Y', # 'Oct 25 2006', 'Oct 25, 2006' 14 | '%d %b %Y', '%d %b, %Y', # '25 Oct 2006', '25 Oct, 2006' 15 | '%B %d %Y', '%B %d, %Y', # 'October 25 2006', 'October 25, 2006' 16 | '%d %B %Y', '%d %B, %Y', # '25 October 2006', '25 October, 2006' 17 | )) 18 | 19 | MONTH_INPUT_FORMATS = getattr(settings, 'DATE_EXTENSIONS_MONTH_INPUT_FORMATS', ( 20 | '%m/%Y', '%m-%Y', # '10/2006', '10-2006' 21 | '%b %Y', '%Y %b', # 'Oct 2006', '2006 Oct' 22 | '%B %Y', '%Y %B', # 'October 2006', '2006 October' 23 | )) 24 | 25 | YEAR_INPUT_FORMATS = getattr(settings, 'DATE_EXTENSIONS_YEAR_INPUT_FORMATS', ( 26 | '%Y', # '2006' 27 | )) 28 | 29 | DAY_MONTH_INPUT_FORMATS = getattr(settings, 'DATE_EXTENSIONS_DAY_MONTH_INPUT_FORMATS', ( 30 | '%m-%d', '%d/%m', # '10-25', '25/10' 31 | '%b %d', '%d %b', # 'Oct 25', '25 Oct' 32 | '%B %d', '%d %B', # 'October 25', '25 October' 33 | )) 34 | -------------------------------------------------------------------------------- /django_date_extensions/tests.py: -------------------------------------------------------------------------------- 1 | from datetime import date, datetime 2 | import os 3 | import unittest 4 | 5 | from django.db import models 6 | from django.core import serializers 7 | from django import forms 8 | from django.test import TestCase, override_settings 9 | from django import VERSION as DJANGO_VERSION 10 | from django.utils.encoding import force_text 11 | 12 | from .fields import ApproximateDate, ApproximateDateField 13 | 14 | os.environ['DJANGO_SETTINGS_MODULE'] = 'example.settings' 15 | 16 | 17 | class ApproxDateModel(models.Model): 18 | start = ApproximateDateField() 19 | can_be_null = ApproximateDateField(null=True) 20 | 21 | def __unicode__(self): 22 | return u'%s' % str(self.start) 23 | 24 | 25 | class ApproxDateForm(forms.ModelForm): 26 | class Meta: 27 | model = ApproxDateModel 28 | fields = ('start', 'can_be_null') 29 | 30 | 31 | class PastAndFuture(unittest.TestCase): 32 | 33 | def test_setting_both(self): 34 | self.assertRaises(ValueError, ApproximateDate, past=True, future=True) 35 | 36 | def test_setting_with_dates(self): 37 | self.assertRaises(ValueError, ApproximateDate, future=True, year=2000) 38 | self.assertRaises(ValueError, ApproximateDate, past=True, year=2000) 39 | 40 | def test_stringification(self): 41 | 42 | self.assertEqual(str(ApproximateDate(future=True)), 'future') 43 | self.assertEqual(str(ApproximateDate(past=True)), 'past') 44 | 45 | self.assertEqual(repr(ApproximateDate(future=True)), 'future') 46 | self.assertEqual(repr(ApproximateDate(past=True)), 'past') 47 | 48 | 49 | class CompareDates(unittest.TestCase): 50 | 51 | def test_compare(self): 52 | 53 | past = ApproximateDate(past=True) 54 | past_too = ApproximateDate(past=True) 55 | y_past = ApproximateDate(year=2000) 56 | y_future = ApproximateDate(year=2100) 57 | future = ApproximateDate(future=True) 58 | future_too = ApproximateDate(future=True) 59 | 60 | # check that we can be compared to None, '' and u'' 61 | for bad_val in ('', u'', None): 62 | self.assertFalse(y_past in (bad_val,)) 63 | self.assertFalse(y_past == bad_val) 64 | self.assertTrue(y_past != bad_val) 65 | 66 | # sanity check 67 | self.assertTrue(y_past == y_past) 68 | self.assertTrue(y_future == y_future) 69 | 70 | self.assertFalse(y_past != y_past) 71 | self.assertFalse(y_future != y_future) 72 | 73 | self.assertTrue(y_past != y_future) 74 | self.assertTrue(y_future != y_past) 75 | 76 | self.assertTrue(y_future > y_past) 77 | self.assertTrue(y_future >= y_past) 78 | self.assertFalse(y_past > y_future) 79 | self.assertFalse(y_past >= y_future) 80 | 81 | self.assertTrue(y_past < y_future) 82 | self.assertTrue(y_past <= y_future) 83 | self.assertFalse(y_future < y_past) 84 | self.assertFalse(y_future <= y_past) 85 | 86 | # Future dates are always greater 87 | self.assertTrue(y_past < future) 88 | self.assertTrue(y_past <= future) 89 | self.assertTrue(y_past != future) 90 | self.assertTrue(y_future < future) 91 | self.assertTrue(y_future <= future) 92 | self.assertTrue(y_future != future) 93 | 94 | self.assertTrue(future > y_past) 95 | self.assertTrue(future >= y_past) 96 | self.assertTrue(future != y_past) 97 | self.assertTrue(future > y_future) 98 | self.assertTrue(future >= y_future) 99 | self.assertTrue(future != y_future) 100 | 101 | # Past dates are always lesser 102 | self.assertTrue(y_past > past) 103 | self.assertTrue(y_past >= past) 104 | self.assertTrue(y_past != past) 105 | self.assertTrue(y_future > past) 106 | self.assertTrue(y_future >= past) 107 | self.assertTrue(y_future != past) 108 | 109 | self.assertTrue(past < y_past) 110 | self.assertTrue(past <= y_past) 111 | self.assertTrue(past != y_past) 112 | self.assertTrue(past < y_future) 113 | self.assertTrue(past <= y_future) 114 | self.assertTrue(past != y_future) 115 | 116 | # Past and future comparisons 117 | self.assertTrue(past < future) 118 | self.assertTrue(past <= future) 119 | self.assertTrue(past != future) 120 | 121 | self.assertTrue(future > past) 122 | self.assertTrue(future >= past) 123 | self.assertTrue(future != past) 124 | 125 | # Future and past dates are equal to themselves (so that sorting is sane) 126 | self.assertFalse(future < future) 127 | self.assertTrue(future <= future) 128 | self.assertTrue(future == future) 129 | self.assertTrue(future >= future) 130 | self.assertFalse(future > future) 131 | self.assertTrue(future == future_too) 132 | self.assertFalse(future != future_too) 133 | 134 | self.assertFalse(past < past) 135 | self.assertTrue(past <= past) 136 | self.assertTrue(past == past) 137 | self.assertTrue(past >= past) 138 | self.assertFalse(past > past) 139 | self.assertTrue(past == past_too) 140 | self.assertFalse(past != past_too) 141 | 142 | def test_compare_date(self): 143 | """ 144 | You can compare Approximate date objects to regular date ones. 145 | """ 146 | self.assertEqual(ApproximateDate(2008, 9, 3), date(2008, 9, 3)) 147 | self.assertTrue(ApproximateDate(2008, 9, 3) < date(2009, 9, 3)) 148 | self.assertTrue(ApproximateDate(2007) < date(2007, 9, 3)) 149 | 150 | 151 | class Lengths(unittest.TestCase): 152 | known_lengths = ( 153 | ({'year': 1999}, 10), 154 | ({'year': 1999, 'month': 1}, 10), 155 | ({'year': 1999, 'month': 1, 'day': 1}, 10), 156 | ({'future': True}, 6), 157 | ({'past': True}, 4), 158 | ) 159 | 160 | def test_length(self): 161 | for kwargs, length in self.known_lengths: 162 | approx = ApproximateDate(**kwargs) 163 | self.assertEqual(len(approx), length) 164 | 165 | 166 | class ApproxDateFiltering(unittest.TestCase): 167 | def setUp(self): 168 | for year in [2000, 2001, 2002, 2003, 2004]: 169 | ApproxDateModel.objects.create(start=ApproximateDate(year=year)) 170 | 171 | def test_filtering_with_python_date(self): 172 | qs = ApproxDateModel.objects.filter(start__gt=date.today()) 173 | # force evaluate queryset 174 | list(qs) 175 | 176 | def test_filtering_with_python_datetime(self): 177 | qs = ApproxDateModel.objects.filter(start__gt=datetime.now()) 178 | # force evaluate queryset 179 | list(qs) 180 | 181 | 182 | class ApproxDateI18n(unittest.TestCase): 183 | @override_settings(LANGUAGE_CODE='ru') 184 | def test_date_in_russian(self): 185 | date = ApproximateDate(year=2000, month=5) 186 | self.assertEqual(force_text(date), u'\u041c\u0430\u0439 2000') 187 | 188 | 189 | class ApproximateDateFieldTesting(TestCase): 190 | def test_deconstruction(self): 191 | f = ApproximateDateField() 192 | name, path, args, kwargs = f.deconstruct() 193 | new_instance = ApproximateDateField(*args, **kwargs) 194 | self.assertEqual(f.max_length, new_instance.max_length) 195 | 196 | def test_empty_fields(self): 197 | a1 = ApproxDateModel.objects.create(start="") 198 | 199 | if DJANGO_VERSION[0] < 2: 200 | self.assertEqual(0, ApproxDateModel.objects.filter(start=None).count()) 201 | else: 202 | self.assertEqual(1, ApproxDateModel.objects.filter(start=None).count()) 203 | self.assertEqual(1, ApproxDateModel.objects.filter(start=a1.start).count()) 204 | self.assertEqual(1, ApproxDateModel.objects.filter(start="").count()) 205 | self.assertEqual(1, ApproxDateModel.objects.filter(start=a1.start or "").count()) 206 | 207 | def test_serialization(self): 208 | a = ApproxDateModel.objects.create(start=ApproximateDate(year=2020, month=12)) 209 | data = serializers.serialize("xml", [a]) 210 | self.assertIn('2020-12-00', data) 211 | 212 | 213 | class ApproximateDateFormTesting(unittest.TestCase): 214 | def test_form(self): 215 | ApproxDateForm() 216 | 217 | 218 | if __name__ == "__main__": 219 | unittest.main() 220 | -------------------------------------------------------------------------------- /django_date_extensions/widgets.py: -------------------------------------------------------------------------------- 1 | from datetime import date 2 | 3 | from django.utils import dateformat 4 | from django.forms import widgets 5 | 6 | from . import settings 7 | 8 | 9 | class PrettyDateInput(widgets.Input): 10 | input_type = 'text' 11 | 12 | def render(self, name, value, attrs=None): 13 | if value is None: 14 | value = '' 15 | elif isinstance(value, date): 16 | value = dateformat.format(value, settings.OUTPUT_FORMAT_DAY_MONTH_YEAR) 17 | return super(PrettyDateInput, self).render(name, value, attrs) 18 | -------------------------------------------------------------------------------- /example/__init__.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/dracos/django-date-extensions/2694f13566b0f097bf8e31c4c6628b85b75b98eb/example/__init__.py -------------------------------------------------------------------------------- /example/forms.py: -------------------------------------------------------------------------------- 1 | from django import forms 2 | from django_date_extensions.fields import PrettyDateField, ApproximateDateFormField 3 | 4 | 5 | class DatesForm(forms.Form): 6 | near_future = PrettyDateField(future=True) 7 | near_past = PrettyDateField(future=False) 8 | just_a_date = PrettyDateField() 9 | approximate = ApproximateDateFormField() 10 | 11 | def clean(self): 12 | self.safe_cleaned_data = self.cleaned_data 13 | return self.cleaned_data 14 | -------------------------------------------------------------------------------- /example/settings.py: -------------------------------------------------------------------------------- 1 | 2 | # Set DEBUG to true so that we don't need to provide a 500.html template 3 | # (django's debug on will be used instead). 4 | DEBUG = True 5 | 6 | SECRET_KEY = 'x9i*)8dp_i=r1o(p%0-g*^sz@_(631+_tjr=e-t04vj2!@l$8a' 7 | ROOT_URLCONF = 'example.urls' 8 | INSTALLED_APPS = ( 9 | 'django_date_extensions', 10 | ) 11 | 12 | DATABASES = { 13 | 'default': { 14 | 'ENGINE': 'django.db.backends.sqlite3', 15 | 'NAME': '', 16 | } 17 | } 18 | -------------------------------------------------------------------------------- /example/templates/form.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | django-date-extensions 4 | 15 | 16 | 17 |

Example of DateField extensions

18 | 19 |

Prefill with some valid data 20 | 21 |

22 | 23 | {% for field in form %} 24 |
25 | {{ field.label_tag }} {{ field }} 26 | {% for error in field.errors %}{{ error }}{% endfor %} 27 | {% for key, value in form.safe_cleaned_data.items %} 28 | {% ifequal key field.html_name %} 29 | Parsed as: {{ value }} 30 | {% endifequal %} 31 | {% endfor %} 32 |
33 | {% endfor %} 34 | 35 |

36 |
37 | 38 |

Written by Matthew Somerville.

39 | 40 | 41 | 42 | -------------------------------------------------------------------------------- /example/urls.py: -------------------------------------------------------------------------------- 1 | from django.conf.urls import url 2 | from .views import view 3 | 4 | urlpatterns = [ 5 | url(r'^$', view), 6 | ] 7 | -------------------------------------------------------------------------------- /example/views.py: -------------------------------------------------------------------------------- 1 | from django.shortcuts import render 2 | from .forms import DatesForm 3 | 4 | 5 | def view(request): 6 | dates_form = DatesForm(request.GET or None) 7 | dates_form.is_valid() 8 | return render(request, 'form.html', {'form': dates_form}) 9 | -------------------------------------------------------------------------------- /manage.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python 2 | import os 3 | import sys 4 | 5 | if __name__ == "__main__": 6 | os.environ.setdefault("DJANGO_SETTINGS_MODULE", "example.settings") 7 | 8 | from django.core.management import execute_from_command_line 9 | 10 | execute_from_command_line(sys.argv) 11 | -------------------------------------------------------------------------------- /setup.cfg: -------------------------------------------------------------------------------- 1 | [flake8] 2 | max-line-length=119 3 | 4 | [bdist_wheel] 5 | universal = 1 6 | -------------------------------------------------------------------------------- /setup.py: -------------------------------------------------------------------------------- 1 | from setuptools import setup 2 | 3 | setup( 4 | name='django_date_extensions', 5 | version='3.1.2', 6 | url='https://github.com/dracos/django-date-extensions', 7 | packages=['django_date_extensions'], 8 | license='BSD', 9 | description=( 10 | "This code adds a few small extensions to Django's DateField," 11 | "to handle both approximate dates (e.g. 'March 1963') and default year dates" 12 | "(e.g. assume '24th June' is the most recent such)."), 13 | long_description=open('README.txt').read(), 14 | author='Matthew Somerville', 15 | author_email='matthew-pypi@dracos.co.uk', 16 | requires=[ 17 | 'Django', 18 | ], 19 | classifiers=[ 20 | 'Development Status :: 5 - Production/Stable', 21 | 'Environment :: Web Environment', 22 | 'Framework :: Django', 23 | 'License :: OSI Approved :: BSD License', 24 | 'Intended Audience :: Developers', 25 | 'Programming Language :: Python :: 2.7', 26 | 'Programming Language :: Python :: 3', 27 | 'Topic :: Database', 28 | 'Topic :: Internet :: WWW/HTTP', 29 | ], 30 | ) 31 | -------------------------------------------------------------------------------- /tox.ini: -------------------------------------------------------------------------------- 1 | [tox] 2 | envlist = flake8, py{27,39}-1.11, py39-{2.2,3.2} 3 | 4 | [testenv] 5 | commands = 6 | flake8: flake8 django_date_extensions example manage.py setup.py 7 | py{27,39}: python -Wall manage.py test django_date_extensions 8 | deps = 9 | flake8: flake8 10 | 1.11: Django>=1.11,<2.0 11 | 2.2: Django>=2.2,<3.0 12 | 3.2: Django>=3.2,<4.0 13 | passenv = CFLAGS 14 | setenv = 15 | PYTHONDONTWRITEBYTECODE=1 16 | 17 | [testenv:flake8] 18 | skip_install = True 19 | --------------------------------------------------------------------------------