mirror of
https://github.com/django/django.git
synced 2025-10-26 15:16:09 +00:00
http://code.djangoproject.com/svn/django/trunk ........ r5626 | russellm | 2007-07-07 10:16:23 +0800 (Sat, 07 Jul 2007) | 2 lines Added some uncredited authors that worked on the Oracle branch. ........ r5629 | mtredinnick | 2007-07-08 01:15:54 +0800 (Sun, 08 Jul 2007) | 8 lines Changed HttpRequest.path to be a Unicode object. It has already been URL-decoded by the time we see it anyway, so keeping it as a UTF-8 bytestring was causing unnecessary problems. Also added handling for non-ASCII URL fragments in feed creation (the portion that was outside the control of the Feed class was messed up). ........ r5630 | mtredinnick | 2007-07-08 02:24:27 +0800 (Sun, 08 Jul 2007) | 4 lines Fixed #4772 -- Fixed reverse URL creation to work with non-ASCII arguments. Also included a test for non-ASCII strings in URL patterns, although that already worked correctly. ........ r5631 | mtredinnick | 2007-07-08 02:39:23 +0800 (Sun, 08 Jul 2007) | 3 lines Corrected misleading comment from [5619]. Not sure what I was smoking at the time. ........ r5632 | mtredinnick | 2007-07-08 08:39:32 +0800 (Sun, 08 Jul 2007) | 5 lines Fixed reverse URL lookup using functions when the original URL pattern was a string. This is now just as fragile as it was prior to [5609], but works in a few cases that people were relying on, apparently. ........ r5636 | mtredinnick | 2007-07-08 19:22:53 +0800 (Sun, 08 Jul 2007) | 4 lines Fixed #4798-- Made sure that function keyword arguments are strings (for the keywords themselves) when using Unicode URL patterns. ........ r5638 | gwilson | 2007-07-10 10:34:42 +0800 (Tue, 10 Jul 2007) | 2 lines Fixed #4817 -- Removed leading forward slashes from some urlconf examples in the documentation. ........ r5639 | gwilson | 2007-07-10 10:45:11 +0800 (Tue, 10 Jul 2007) | 2 lines Fixed #4814 -- Fixed some whitespace issues in tutorial01, thanks John Shaffer. ........ r5640 | gwilson | 2007-07-10 11:26:26 +0800 (Tue, 10 Jul 2007) | 2 lines Fixed #4812 -- Fixed an octal escape in regular expression that is used in the `isValidEmail` validator, thanks batchman@free.fr. ........ r5641 | mtredinnick | 2007-07-10 20:02:06 +0800 (Tue, 10 Jul 2007) | 3 lines Fixed #4823 -- Fixed a Python 2.3 incompatibility from [5636] (it was even demonstrated by existing tests, so I really screwed this up). ........ r5642 | mtredinnick | 2007-07-10 20:03:36 +0800 (Tue, 10 Jul 2007) | 3 lines Fixed #4804 -- Fixed a problem when validating choice lists with non-ASCII data. Thanks, django@vonposer.de. ........ r5643 | mtredinnick | 2007-07-10 20:33:55 +0800 (Tue, 10 Jul 2007) | 4 lines Fixed #3760 -- Added the ability to manually set feed- and item-level id elements in Atom feeds. This is fully backwards compatible. Based on a patch from spark343@cs.ubc.ca. ........ r5644 | mtredinnick | 2007-07-11 14:55:12 +0800 (Wed, 11 Jul 2007) | 3 lines Fixed #4815 -- Fixed decoding of request parameters when the input encoding is not UTF-8. Thanks, Jordan Dimov. ........ r5645 | mtredinnick | 2007-07-11 15:00:27 +0800 (Wed, 11 Jul 2007) | 3 lines Fixed #4802 -- Updated French translation. Combined contribution from baptiste.goupil@gmail.com and rocherl@club-internet.fr. ........ r5646 | mtredinnick | 2007-07-11 15:12:50 +0800 (Wed, 11 Jul 2007) | 2 lines Fixed #4753 -- Small update to Spanish translation from Mario Gonzalez. ........ r5649 | jacob | 2007-07-12 08:33:44 +0800 (Thu, 12 Jul 2007) | 1 line Fixed #4615: corrected reverse URL resolution examples in tutorial 4. Thanks for the patch, simeonf. ........ r5650 | adrian | 2007-07-12 12:43:29 +0800 (Thu, 12 Jul 2007) | 1 line Added 'New in Django development version' note to docs/syndication_feeds.txt changes from [5643] ........ r5651 | adrian | 2007-07-12 12:44:45 +0800 (Thu, 12 Jul 2007) | 1 line Edited changes to docs/tutorial04.txt from [5649] ........ r5652 | adrian | 2007-07-12 13:23:47 +0800 (Thu, 12 Jul 2007) | 1 line Added helpful error message to SiteManager.get_current() if the user hasn't set SITE_ID ........ r5653 | adrian | 2007-07-12 13:28:04 +0800 (Thu, 12 Jul 2007) | 1 line Added RequestSite class to sites framework ........ r5654 | adrian | 2007-07-12 13:29:32 +0800 (Thu, 12 Jul 2007) | 1 line Improved syndication feed framework to use RequestSite if the sites framework is not installed -- i.e., the sites framework is no longer required to use the syndication feed framework. This is backwards incompatible if anybody has subclassed Feed and overridden __init__(), because the second parameter is now expected to be an HttpRequest object instead of request.path ........ r5658 | russellm | 2007-07-12 15:45:35 +0800 (Thu, 12 Jul 2007) | 2 lines Fixed #4459 -- Added 'raw' argument to save method, to override any pre-save processing, and modified serializers to use a raw-save. This enables serialization of DateFields with auto_now/auto_now_add. Also modified serializers to invoke save() directly on the model baseclass, to avoid any (potentially order-dependent, data modifying) behavior in a custom save() method. ........ r5659 | russellm | 2007-07-12 19:24:16 +0800 (Thu, 12 Jul 2007) | 2 lines Fixed #3770 -- Remove null=True tag from OneToOne serialization test. OneToOne fields can't have a value of null. ........ r5660 | russellm | 2007-07-12 19:27:38 +0800 (Thu, 12 Jul 2007) | 2 lines Fixed #3768 -- Disabled NullBooleanField PK serialization test. We can't and don't test null PK values. ........ r5662 | russellm | 2007-07-12 20:33:24 +0800 (Thu, 12 Jul 2007) | 2 lines Fixed #4837 -- Updated Debian packaging details. Thanks for the suggestion, Yasushi Masuda <whosaysni@gmail.com>. ........ r5663 | russellm | 2007-07-12 20:44:05 +0800 (Thu, 12 Jul 2007) | 2 lines Fixed #4808 -- Added Chilean regions in localflavor. Thanks, Marijn Vriens <marijn@metronomo.cl>. ........ r5664 | russellm | 2007-07-12 20:48:27 +0800 (Thu, 12 Jul 2007) | 2 lines Fixed #4745 -- Updated docs to point out that 0 is not a valid SITE_ID when running the tests. Thanks for the suggestion, Lars Stavholm <stava@telcotec.se>. ........ r5665 | russellm | 2007-07-12 20:50:02 +0800 (Thu, 12 Jul 2007) | 2 lines Fixed #4763 -- Minor typo in cache documentations. Thanks, dan@coffeecode.net. ........ r5666 | russellm | 2007-07-12 20:55:28 +0800 (Thu, 12 Jul 2007) | 2 lines Fixed #4627 -- Added details on MacPorts packaging of Django. Thanks, Paul Bissex. ........ r5667 | russellm | 2007-07-12 21:23:11 +0800 (Thu, 12 Jul 2007) | 2 lines Fixed #4640 -- Fixed import to stringfilter in docs. Proposed solution to move stringfilter into django.template.__init__ introduces a circular import problem. ........ r5668 | russellm | 2007-07-12 21:32:00 +0800 (Thu, 12 Jul 2007) | 2 lines Fixed #4722 -- Clarified discussion about PYTHONPATH in modpython docs. Thanks for the suggestion, Collin Grady <cgrady@the-magi.us>. ........ r5669 | russellm | 2007-07-12 21:37:59 +0800 (Thu, 12 Jul 2007) | 2 lines Fixed #4755 -- Modified newforms MultipleChoiceField to use list comprehension, rather than iteration. ........ r5670 | russellm | 2007-07-12 21:41:27 +0800 (Thu, 12 Jul 2007) | 2 lines Fixed #4764 -- Added reference to Locale middleware in middleware docs. Thanks, dan@coffeecode.net. ........ r5671 | russellm | 2007-07-12 21:55:19 +0800 (Thu, 12 Jul 2007) | 2 lines Fixed #4768 -- Converted timesince and dateformat to use explicit floor division (pre-emptive avoidance of Python 3000 compatibility problem), and removed a redundant millisecond check. Thanks, John Shaffer <jshaffer2112@gmail.com>. ........ r5672 | russellm | 2007-07-12 22:00:13 +0800 (Thu, 12 Jul 2007) | 2 lines Fixed #4775 -- Added some missing Hungarian accents to the urlify.js LATIN_MAP. Thanks, Pistahh <szekeres@iii.hu>. ........ r5673 | russellm | 2007-07-12 22:05:16 +0800 (Thu, 12 Jul 2007) | 2 lines Fixed #4502 -- Clarified reference to view in tutorial. Thanks for the suggestion, Carl Karsten <carl@personnelware.com>. ........ r5674 | russellm | 2007-07-12 22:11:41 +0800 (Thu, 12 Jul 2007) | 2 lines Fixed #4522 -- Clarified the allowed filter arguments on the time and date filters. Thanks for the suggestion, admackin@gmail.com. ........ r5675 | russellm | 2007-07-12 22:21:51 +0800 (Thu, 12 Jul 2007) | 2 lines Fixed #4525 -- Fixed mistaken documentation on arguments to runfcgi. Thanks, Johan Bergstrom <bugs@bergstroem.nu>. ........ r5676 | russellm | 2007-07-12 22:41:32 +0800 (Thu, 12 Jul 2007) | 2 lines Fixed #4538 -- Split the installation instructions to differentiate between installing a distribution package and installing an official release. Thanks to Carl Karsten for the idea, and Paul Bissex for the patch. ........ r5677 | russellm | 2007-07-12 23:26:37 +0800 (Thu, 12 Jul 2007) | 2 lines Fixed #4526 -- Modified the test Client login method to fail when a user is inactive. Thanks, marcin@elksoft.pl. ........ r5678 | russellm | 2007-07-13 13:03:33 +0800 (Fri, 13 Jul 2007) | 2 lines Fixed #3505 -- Added handling for the error raised when the user forgets the comma in a single element tuple when defining AUTHENTICATION_BACKENDS. Thanks for the help identifying this problem, Mario Gonzalez <gonzalemario@gmail.com>. ........ r5679 | mtredinnick | 2007-07-13 16:52:07 +0800 (Fri, 13 Jul 2007) | 3 lines Fixed #2591 -- Fixed a problem with inspectdb with psycopg2 (only). Patch from Gary Wilson. ........ r5680 | mtredinnick | 2007-07-13 17:09:59 +0800 (Fri, 13 Jul 2007) | 3 lines Fixed #4807 -- Fixed a couple of corner cases in decimal form input validation. Based on a suggestion from Chriss Moffit. ........ r5681 | mtredinnick | 2007-07-13 17:14:51 +0800 (Fri, 13 Jul 2007) | 3 lines Fixed #4839 -- Added __repr__ methods to URL classes that show the pattern they contain. Thanks, Thomas G?\195?\188ttler. ........ r5682 | mtredinnick | 2007-07-13 18:56:30 +0800 (Fri, 13 Jul 2007) | 3 lines Fixed #4842 -- Added slightly more robust error reporting. Thanks, Thomas G?\195?\188ttler. ........ r5683 | mtredinnick | 2007-07-13 19:05:01 +0800 (Fri, 13 Jul 2007) | 3 lines Fixed #4846 -- Fixed some Python 2.3 encoding problems in the admin interface. Based on a patch from daybreaker12@gmail.com. ........ r5684 | mtredinnick | 2007-07-13 20:03:20 +0800 (Fri, 13 Jul 2007) | 3 lines Fixed #4861 -- Removed some duplicated logic from the newforms RegexField by making it a subclass of CharField. Thanks, Collin Grady. ........ r5685 | mtredinnick | 2007-07-13 21:15:35 +0800 (Fri, 13 Jul 2007) | 3 lines Fixed #4865 -- Replaced a stray generator comprehension with a list comprehension so that we don't break Python 2.3. ........ r5686 | mtredinnick | 2007-07-13 22:13:35 +0800 (Fri, 13 Jul 2007) | 3 lines Fixed #4469 -- Added slightly more informative error messages to max- and min-length newform validation. Based on a patch from A. Murat Eren. ........ r5687 | mtredinnick | 2007-07-13 22:14:47 +0800 (Fri, 13 Jul 2007) | 2 lines Added author credit for [5686]. Refs #4469. ........ r5688 | mtredinnick | 2007-07-13 22:33:46 +0800 (Fri, 13 Jul 2007) | 3 lines Fixed #4484 -- Fixed APPEND_SLASH handling to handle an empty path value. Thanks, VesselinK. ........ r5689 | mtredinnick | 2007-07-13 22:40:39 +0800 (Fri, 13 Jul 2007) | 2 lines Fixed #4556 -- Stylistic changes to [5500]. Thanks, glin@seznam.cz. ........ r5690 | gwilson | 2007-07-14 04:36:01 +0800 (Sat, 14 Jul 2007) | 2 lines Refs #2591 -- Removed int conversion and try/except since the value in the single-item list is already an int. I overlooked this in my original patch, which was applied in [5679]. ........ r5691 | adrian | 2007-07-14 05:20:07 +0800 (Sat, 14 Jul 2007) | 1 line Documented the 'commit' argument to save() methods on forms created via form_for_model() or form_for_instance() ........ r5692 | mtredinnick | 2007-07-14 13:27:22 +0800 (Sat, 14 Jul 2007) | 3 lines Fixed #4869 -- Added a note that syncdb does not alter existing tables. Thanks, James Bennett. ........ r5693 | mtredinnick | 2007-07-14 20:48:24 +0800 (Sat, 14 Jul 2007) | 3 lines Fixed #4863 -- Removed comment references to a no-longer present link. Pointed out by Thomas G?\195?\188ttler. ........ r5694 | mtredinnick | 2007-07-14 21:14:28 +0800 (Sat, 14 Jul 2007) | 2 lines Fixed #4862 -- Fixed invalid Javascript creation in popup windows in admin. ........ r5695 | mtredinnick | 2007-07-14 21:39:41 +0800 (Sat, 14 Jul 2007) | 2 lines Fixed a problem with translatable strings from [5686]. ........ r5696 | mtredinnick | 2007-07-14 22:47:14 +0800 (Sat, 14 Jul 2007) | 3 lines Fixed #4731 -- Changed management.setup_environ() so that it no longer assumes the settings module is called "settings". Patch from SmileyChris. ........ r5697 | mtredinnick | 2007-07-14 22:50:35 +0800 (Sat, 14 Jul 2007) | 3 lines Fixed #4870 -- Removed unneeded import and fixed a docstring in an example. Thanks, Collin Grady. ........ r5698 | adrian | 2007-07-15 00:58:54 +0800 (Sun, 15 Jul 2007) | 1 line Edited docs/db-api.txt changes from [5658] ........ r5699 | adrian | 2007-07-15 01:04:30 +0800 (Sun, 15 Jul 2007) | 1 line Negligible capitalization fix in test/client.py docstring ........ r5700 | russellm | 2007-07-15 12:41:59 +0800 (Sun, 15 Jul 2007) | 2 lines Clarified the documentation on the steps that happen during a save, and how raw save affects those steps. ........ r5701 | gwilson | 2007-07-15 13:03:28 +0800 (Sun, 15 Jul 2007) | 2 lines Fixed #4310 -- Fixed a regular expression bug in `strip_entities` function and added tests for several `django.utils.html` functions. Based on patch from Brian Harring. ........ r5702 | gwilson | 2007-07-15 13:11:06 +0800 (Sun, 15 Jul 2007) | 2 lines Fixed #4877 -- Fixed typo in testing documentation, patch from John Shaffer. ........ r5703 | gwilson | 2007-07-15 14:24:54 +0800 (Sun, 15 Jul 2007) | 2 lines Fixed #3012 -- Changed the locmem cache backend to use pickle instead of deepcopy to make it compatible with iterators (which cannot be copied). Patch from Sundance. ........ r5704 | gwilson | 2007-07-15 14:29:45 +0800 (Sun, 15 Jul 2007) | 2 lines Changed imports to adhere to PEP 8. ........ r5705 | mtredinnick | 2007-07-15 17:39:13 +0800 (Sun, 15 Jul 2007) | 3 lines Fixed #4880 -- Updated Spanish translation (includes re-encoding to UTF-8). Thanks, Jorge Gajon. ........ r5706 | mtredinnick | 2007-07-15 17:46:42 +0800 (Sun, 15 Jul 2007) | 3 lines Fixed #4882 -- Updated Argentinean Spanish translation (includes re-encoding to UTF-8). Thanks, Ramiro Morales. ........ r5707 | mtredinnick | 2007-07-15 18:08:05 +0800 (Sun, 15 Jul 2007) | 3 lines Re-encoded djangojs.po for French and German locales to UTF-8. These were the last two non-UTF-8 PO files. ........ r5708 | mtredinnick | 2007-07-15 18:10:44 +0800 (Sun, 15 Jul 2007) | 6 lines Fixed #4734 -- Changed message extraction to permit non-ACSII msgid strings. Thanks, krzysiek.pawlik@silvermedia.pl. This is slightly backwards-incompatible for translators: PO files are now assumed to be in UTF-8 encoding. ........ r5709 | adrian | 2007-07-16 03:34:21 +0800 (Mon, 16 Jul 2007) | 1 line Edited docs/db-api.txt changes from [5700] ........ r5710 | adrian | 2007-07-16 05:16:32 +0800 (Mon, 16 Jul 2007) | 1 line Improved docs/templates.txt section on the 'regroup' tag ........ r5711 | mtredinnick | 2007-07-16 11:48:03 +0800 (Mon, 16 Jul 2007) | 2 lines Updated AUTHORS for [5708]. ........ r5712 | mtredinnick | 2007-07-16 11:50:22 +0800 (Mon, 16 Jul 2007) | 3 lines Fixed #4199 -- Changed date formatting in HTTP expires header to be spec compliant. Thanks, Chris Bennett. ........ r5713 | mtredinnick | 2007-07-16 12:45:45 +0800 (Mon, 16 Jul 2007) | 3 lines Fixed #4884 -- Fixed an initialisation problem when assigned to settings before accessing them. Thanks, Noam Raphael. ........ r5714 | mtredinnick | 2007-07-16 12:47:52 +0800 (Mon, 16 Jul 2007) | 2 lines Fixed #4806 -- Updated Simplified Chinese translation. Thanks, limodou. ........ r5715 | mtredinnick | 2007-07-16 12:54:49 +0800 (Mon, 16 Jul 2007) | 3 lines Fixed #4887 -- Fixed another place where template tag arguments are used directly as function keyword args. Thanks, Brian Rosner. ........ r5716 | gwilson | 2007-07-16 13:00:18 +0800 (Mon, 16 Jul 2007) | 2 lines Refs #3012 -- Removed iterator from `test_data_types` cache test that I added in [5703]. Iterators cannot be pickled either. Left the rest of [5703] there though since it fixed another issue that was causing the `test_data_types` cache test to fail with the `locmem` cache backend, the fact that functions cannot be copied. ........ r5717 | gwilson | 2007-07-16 13:28:13 +0800 (Mon, 16 Jul 2007) | 2 lines Cleaned up a couple unused imports and fixed docstrings to follow Python Style Guide. ........ r5718 | mtredinnick | 2007-07-16 17:36:10 +0800 (Mon, 16 Jul 2007) | 3 lines Fixed #4845 -- Fixed some problems with Unicode usage and caching. Thanks, Jeremy Dunck. ........ r5719 | gwilson | 2007-07-16 21:47:43 +0800 (Mon, 16 Jul 2007) | 2 lines Removed unused variable and changed comments about `permalink` decorator into a docstring. ........ r5720 | gwilson | 2007-07-17 06:29:09 +0800 (Tue, 17 Jul 2007) | 2 lines Fixed #4851 -- Fixed description of an example query in `db-api` docs. ........ r5721 | mtredinnick | 2007-07-17 12:22:11 +0800 (Tue, 17 Jul 2007) | 2 lines Fixed #4898 -- Fixed a precendence problem when constructing HTTP Date header. ........ r5722 | mtredinnick | 2007-07-17 18:25:43 +0800 (Tue, 17 Jul 2007) | 3 lines Fixed #4899 -- Fixed a problem with PO file header generation caused by [5708]. Thanks, Ramiro Morales. ........ r5723 | mtredinnick | 2007-07-19 17:23:45 +0800 (Thu, 19 Jul 2007) | 2 lines Fixed #4917 -- Updated Swedish translation. Thanks, Pilip Lindborg. ........ r5724 | mtredinnick | 2007-07-19 17:24:36 +0800 (Thu, 19 Jul 2007) | 2 lines Fixed #3925 -- Added Slovak localflavor items. Thanks, Martin Kos?\195?\173r. ........ r5725 | adrian | 2007-07-20 14:28:56 +0800 (Fri, 20 Jul 2007) | 1 line Added a db_type() method to the database Field class. This is a hook for calculating the database column type for a given Field. Also converted all management.py CREATE TABLE statements to use db_type(), which made that code cleaner. The Field.get_internal_type() hook still exists, but we should consider removing it at some point, because db_type() is more general. Also added docs -- the beginnings of docs on how to create custom database Field classes. This is backwards-compatible. ........ r5726 | adrian | 2007-07-20 14:34:26 +0800 (Fri, 20 Jul 2007) | 1 line Simplified the indent level in management.py _get_sql_model_create() by using a 'continue' statement rather than nesting everything in an 'if' ........ r5727 | russellm | 2007-07-20 20:07:58 +0800 (Fri, 20 Jul 2007) | 2 lines Fixed #4558 -- Modified XML serializer to handle whitespace better around None tags. Thanks to Bill Fenner <fenner@gmail.com> for the report and fix. ........ r5728 | russellm | 2007-07-20 20:15:02 +0800 (Fri, 20 Jul 2007) | 2 lines Fixed #4897 -- Fixed minor typo in doctest comment. ........ r5729 | russellm | 2007-07-20 21:57:49 +0800 (Fri, 20 Jul 2007) | 2 lines Fixed #3782 -- Added support for the suite() method recommended by the Python unittest docs. Thanks for the suggestion, rene.puls@repro-mayr.de. ........ r5730 | russellm | 2007-07-20 22:07:54 +0800 (Fri, 20 Jul 2007) | 2 lines Refs #3782 -- Added documentation note that suite() handling is only in development version. ........ r5731 | russellm | 2007-07-20 22:32:20 +0800 (Fri, 20 Jul 2007) | 2 lines Fixed #4901 -- Modified assertContains to provide a default check of 'any instances of text in content'. Thanks for the suggestion, nis@superlativ.dk. ........ r5732 | russellm | 2007-07-20 22:42:57 +0800 (Fri, 20 Jul 2007) | 2 lines Fixed #4738 -- Modified the prompt that is displayed when a test database cannot be created. The existing prompt was misleading if the issue wasn't a pre-existing database. Thanks for the suggestion, John Shaffer <jshaffer2112@gmail.com>. ........ r5733 | adrian | 2007-07-20 23:40:54 +0800 (Fri, 20 Jul 2007) | 1 line Fixed negligible typo in docstring in tests/regressiontests/test_client_regress/models.py from [5731] ........ r5736 | adrian | 2007-07-21 05:24:30 +0800 (Sat, 21 Jul 2007) | 1 line Added some additional docs to docs/model-api.txt db_type() section ........ r5738 | russellm | 2007-07-21 11:30:38 +0800 (Sat, 21 Jul 2007) | 2 lines Fixed #4304 -- Modified sys.exit to os._exit to make sure development server quits when an error occurs attempting to bind to the requested port (e.g., if another server is already running). Thanks, Mario Gonzalez <gonzalemario@gmail.com>. ........ r5739 | russellm | 2007-07-21 12:36:28 +0800 (Sat, 21 Jul 2007) | 2 lines Minor fix to allow for count=0 in assertContains. ........ r5740 | russellm | 2007-07-21 13:15:19 +0800 (Sat, 21 Jul 2007) | 2 lines Added test cases for change [5739]. ........ r5741 | russellm | 2007-07-21 13:17:20 +0800 (Sat, 21 Jul 2007) | 2 lines Fixed #4402 -- Modified test client to allow multi-valued inputs on GET requests. Thanks for the suggestion, eddymul@gmail.com. ........ r5743 | gwilson | 2007-07-22 10:18:36 +0800 (Sun, 22 Jul 2007) | 2 lines Fixed #4945 -- Removed unused `GET_ITERATOR_CHUNK_SIZE` definition from manager.py. `GET_ITERATOR_CHUNK_SIZE` is already defined in query.py. Thanks zigiDev@mac.com. ........ r5744 | gwilson | 2007-07-22 11:09:24 +0800 (Sun, 22 Jul 2007) | 2 lines Added docstrings to shortcuts module and functions. ........ r5745 | gwilson | 2007-07-22 11:12:50 +0800 (Sun, 22 Jul 2007) | 2 lines Shortcut functions do not accept `QuerySet` objects, yet :) ........ r5746 | gwilson | 2007-07-22 11:41:11 +0800 (Sun, 22 Jul 2007) | 2 lines Fixed #4373 -- Modified the get_object_or_404/get_list_or_404 shortcuts to also accept `QuerySet`s. Thanks SuperJared. ........ r5747 | gwilson | 2007-07-22 11:45:03 +0800 (Sun, 22 Jul 2007) | 2 lines Corrected typo in [5746]. ........ r5750 | gwilson | 2007-07-23 12:45:01 +0800 (Mon, 23 Jul 2007) | 2 lines Fixed #4952 -- Fixed the `get_template_sources` functions of the `app_directories` and `filesystem` template loaders to not return paths outside of given template directories. Both functions now make use of a new `safe_join` utility function. Thanks to SmileyChris for help with the patch. ........ r5752 | russellm | 2007-07-23 20:14:32 +0800 (Mon, 23 Jul 2007) | 2 lines Fixed #3771 -- Modified the test runner to observe the --noinput argument controlling script interactivity. This means that test scripts can now be put in a buildbot environment. This is a backwards incompatible change for anyone that has written a custom test runner. Thanks for the suggestion, moof@metamoof.net. ........ r5753 | russellm | 2007-07-23 21:52:59 +0800 (Mon, 23 Jul 2007) | 2 lines Added documentation for a test runner argument that has always been present, but was undocumented. ........ r5756 | adrian | 2007-07-25 11:12:31 +0800 (Wed, 25 Jul 2007) | 1 line Changed docstring additions from [5744] to use active verbs ('returns' instead of 'return') ........ r5757 | adrian | 2007-07-25 11:15:05 +0800 (Wed, 25 Jul 2007) | 1 line Added 'New in Django development version' to docs/db-api.txt change from [5746] ........ r5758 | adrian | 2007-07-25 11:18:17 +0800 (Wed, 25 Jul 2007) | 1 line Changed safe_join() docstring from [5750] to use active verbs. See also [5756] ........ r5764 | gwilson | 2007-07-26 13:01:53 +0800 (Thu, 26 Jul 2007) | 2 lines Fixed #4971 -- Fixed some escaping and quoting problems in the databrowse contrib app. Based on patch from Johann Queuniet. ........ r5765 | adrian | 2007-07-27 01:16:34 +0800 (Fri, 27 Jul 2007) | 1 line Added section to docs/contributing.txt about docstring coding style ........ r5766 | mtredinnick | 2007-07-27 06:59:34 +0800 (Fri, 27 Jul 2007) | 2 lines Added support for database cache table in test database. ........ r5767 | adrian | 2007-07-28 05:53:02 +0800 (Sat, 28 Jul 2007) | 1 line Added unit test that confirms a bug in ValuesQuerySets that have extra(select) specified. If the select dictionary has several fields, Django assigns the wrong values to the select-field names ........ r5768 | adrian | 2007-07-28 06:07:42 +0800 (Sat, 28 Jul 2007) | 1 line Fixed bug with using values() and extra(select) in the same QuerySet, with a select dictionary containing more than a few elements. This bug was identified in unit test from [5767]. The problem was that we were relying on the dictionary's .items() ordering, which is undefined ........ r5769 | russellm | 2007-07-28 12:02:52 +0800 (Sat, 28 Jul 2007) | 2 lines Fixed #4460 -- Added the ability to be more specific in the test cases that are executed. This is a backwards incompatible change for any user with a custom test runner. See the wiki for details. ........ r5770 | russellm | 2007-07-28 15:27:53 +0800 (Sat, 28 Jul 2007) | 2 lines Fixed #4995 -- Fixed some problems in documentation ReST formatting. Thanks, Simon G. ........ r5771 | simon | 2007-07-29 02:30:40 +0800 (Sun, 29 Jul 2007) | 1 line After discussing with Malcolm, added set_unusable_password() and has_usable_password() methods to the User object, plus tests and updated documentation ........ r5774 | adrian | 2007-07-30 02:21:16 +0800 (Mon, 30 Jul 2007) | 1 line Added 'New in Django development version' to changes in docs/authentication.txt from [5771] ........ r5778 | gwilson | 2007-07-31 01:25:35 +0800 (Tue, 31 Jul 2007) | 4 lines Fixed call to `ugettext`, which is imported as `_`. Changed raise to conform to PEP 3109 and wrapped the long line. Added beginnings of tests for model fields. ........ r5782 | gwilson | 2007-08-01 13:41:32 +0800 (Wed, 01 Aug 2007) | 2 lines Fixed #4228 -- Removed hardcoding of `RadioFieldRenderer` in the `RadioSelect` Widget so that the display of `RadioSelect`s can be more easily customized. `BoundField.__unicode__` also no longer special cases `RadioSelect` since `RadioSelect.render()` now returns a string like every other Widget. ........ r5783 | gwilson | 2007-08-01 13:52:18 +0800 (Wed, 01 Aug 2007) | 2 lines Fixed #5037 -- Fixed use of wrong field type in a db-api docs example, thanks ubernostrum. ........ r5796 | gwilson | 2007-08-04 11:19:14 +0800 (Sat, 04 Aug 2007) | 2 lines Fixed #5078 -- Fixed several broken links to the syndication documentation. ........ r5797 | gwilson | 2007-08-04 11:36:58 +0800 (Sat, 04 Aug 2007) | 2 lines Changed the 0.95 release notes to point to the 0.95 documentation index. ........ r5798 | gwilson | 2007-08-04 11:39:24 +0800 (Sat, 04 Aug 2007) | 2 lines Changed several documentation links to be relative. ........ r5799 | gwilson | 2007-08-04 22:41:49 +0800 (Sat, 04 Aug 2007) | 2 lines Refs #3397 -- Corrected the Exception that is caught when ordering by non-fields (added in [4596]), thanks glin@seznam.cz. ........ r5800 | gwilson | 2007-08-04 22:52:13 +0800 (Sat, 04 Aug 2007) | 2 lines Fixed #5083 -- Fixed typo in newforms documentation, thanks Rik. ........ r5801 | gwilson | 2007-08-05 12:39:52 +0800 (Sun, 05 Aug 2007) | 2 lines Refs #5089 -- Added file name to poll detail template examples in the tutorial. ........ r5802 | gwilson | 2007-08-05 12:42:26 +0800 (Sun, 05 Aug 2007) | 2 lines Changed some more links to be relative in the documentation. I had a couple unsaved files that didn't get in with [5798]. ........ r5803 | gwilson | 2007-08-05 13:14:46 +0800 (Sun, 05 Aug 2007) | 2 lines Fixed #2101 -- Renamed `maxlength` argument to `max_length` for oldforms `FormField`s and db model `Field`s. This is fully backwards compatible at the moment since the legacy `maxlength` argument is still supported. Using `maxlength` will, however, issue a `PendingDeprecationWarning` when used. ........ r5804 | russellm | 2007-08-05 15:39:36 +0800 (Sun, 05 Aug 2007) | 2 lines Fixed #4001 -- Added dynamic save_m2m method() to forms created with form_for_model and form_for_instance on save(commit=False). ........ r5807 | adrian | 2007-08-06 12:36:43 +0800 (Mon, 06 Aug 2007) | 1 line Fixed #5074 -- Added link to audio clip of 'Django' pronunciation ........ r5808 | adrian | 2007-08-06 12:52:14 +0800 (Mon, 06 Aug 2007) | 1 line Edited docs/newforms.txt changes from [5804] ........ r5809 | adrian | 2007-08-06 13:04:27 +0800 (Mon, 06 Aug 2007) | 1 line Fixed #5082 -- Enabled tab completion in 'django-admin.py shell' for objects that were imported into the global namespace at runtime. Thanks, dusk@woofle.net ........ r5810 | adrian | 2007-08-06 13:06:15 +0800 (Mon, 06 Aug 2007) | 1 line Fixed #5077 -- django/utils/encoding.py no longer imports settings, as it doesn't use that module. Thanks, Collin Grady ........ r5811 | adrian | 2007-08-06 13:07:38 +0800 (Mon, 06 Aug 2007) | 1 line Fixed #5071 -- Fixed 'global name ugettext is not defined' error in django.core.validators. Thanks, Marco Bonetti ........ r5812 | adrian | 2007-08-06 13:13:06 +0800 (Mon, 06 Aug 2007) | 1 line Fixed #5064 -- Fixed potentially confusing sentence in docs/authentication.txt. Thanks, Collin Grady ........ r5813 | adrian | 2007-08-06 13:16:35 +0800 (Mon, 06 Aug 2007) | 1 line Fixed #5053 -- Added 'action' attribute to <form> tags that didn't have that attribute in docs/newforms.txt examples. Perfectionism appreciated, trickyb ........ r5814 | adrian | 2007-08-06 13:27:58 +0800 (Mon, 06 Aug 2007) | 1 line Added a closing </p>' to a code example in docs/email.txt ........ r5815 | adrian | 2007-08-06 13:28:45 +0800 (Mon, 06 Aug 2007) | 1 line Fixed #5006 -- Fixed incorrect/outdated docstring for the 'if' template tag. Thanks, Thomas Petazzoni ........ r5816 | adrian | 2007-08-06 13:33:18 +0800 (Mon, 06 Aug 2007) | 1 line Added note to docs/model-api.txt about help_text not being escaped in the admin interface ........ r5817 | adrian | 2007-08-06 13:34:45 +0800 (Mon, 06 Aug 2007) | 1 line Fixed #4985 -- Clarified location of HttpResponse in docs/request_response.txt. Thanks for raising the issue, rainer.mansfeld@romulo.de ........ r5818 | adrian | 2007-08-06 13:37:17 +0800 (Mon, 06 Aug 2007) | 1 line Fixed #4980 -- Removed 'forms' from the 'not considered stable and will be rewritten' section of docs/api_stability.txt. They've already been rewritten. ........ r5819 | russellm | 2007-08-06 21:58:56 +0800 (Mon, 06 Aug 2007) | 2 lines Fixed #3297 -- Implemented FileField and ImageField for newforms. Thanks to the many users that contributed to and tested this patch. ........ r5820 | russellm | 2007-08-06 22:17:10 +0800 (Mon, 06 Aug 2007) | 2 lines Added note that FileField and ImageField are only in development version. There are also some minor backwards compatibility issues with the changes introduced in [5819] - see the wiki for details. ........ r5823 | adrian | 2007-08-07 04:27:04 +0800 (Tue, 07 Aug 2007) | 1 line Fixed British spelling of 'customize' and 'behavior' in Manager.get_query_set() docstring ........ r5824 | adrian | 2007-08-07 10:18:36 +0800 (Tue, 07 Aug 2007) | 1 line Fixed #5105 -- Fixed two ReST errors in docs/newforms.txt. Thanks, Ramiro Morales ........ r5825 | adrian | 2007-08-07 10:33:11 +0800 (Tue, 07 Aug 2007) | 1 line Fixed #5097 -- Made various updates and corrections to the documentation. Thanks, Nicola Larosa ........ r5826 | russellm | 2007-08-07 19:20:15 +0800 (Tue, 07 Aug 2007) | 2 lines Removed a redundant directory join during FileField form saving. Thanks to David Danier's eagle eyes for picking up this one. ........ git-svn-id: http://code.djangoproject.com/svn/django/branches/newforms-admin@5828 bcc190cf-cafb-0310-a4f2-bffc1f526a37
803 lines
32 KiB
Plaintext
803 lines
32 KiB
Plaintext
======================
|
|
Contributing to Django
|
|
======================
|
|
|
|
If you think working *with* Django is fun, wait until you start working *on* it.
|
|
We're passionate about helping Django users make the jump to contributing members
|
|
of the community, so there are many ways you can help Django's development:
|
|
|
|
* Blog about Django. We syndicate all the Django blogs we know about on
|
|
the `community page`_; contact jacob@jacobian.org if you've got a blog
|
|
you'd like to see on that page.
|
|
|
|
* Report bugs and request features in our `ticket tracker`_. Please read
|
|
`Reporting bugs`_, below, for the details on how we like our bug reports
|
|
served up.
|
|
|
|
* Submit patches for new and/or fixed behavior. Please read `Submitting
|
|
patches`_, below, for details on how to submit a patch.
|
|
|
|
* Join the `django-developers`_ mailing list and share your ideas for how
|
|
to improve Django. We're always open to suggestions, although we're
|
|
likely to be skeptical of large-scale suggestions without some code to
|
|
back it up.
|
|
|
|
* Triage patches that have been submitted by other users. Please read
|
|
`Ticket triage`_ below, for details on the triage process.
|
|
|
|
That's all you need to know if you'd like to join the Django development
|
|
community. The rest of this document describes the details of how our community
|
|
works and how it handles bugs, mailing lists, and all the other minutiae of
|
|
Django development.
|
|
|
|
Reporting bugs
|
|
==============
|
|
|
|
Well-written bug reports are *incredibly* helpful. However, there's a certain
|
|
amount of overhead involved in working with any bug tracking system, so your
|
|
help in keeping our ticket tracker as useful as possible is appreciated. In
|
|
particular:
|
|
|
|
* **Do** read the FAQ_ to see if your issue might be a well-known question.
|
|
|
|
* **Do** `search the tracker`_ to see if your issue has already been filed.
|
|
|
|
* **Do** ask on `django-users`_ *first* if you're not sure if what you're
|
|
seeing is a bug.
|
|
|
|
* **Do** write complete, reproducible, specific bug reports. Include as
|
|
much information as you possibly can, complete with code snippets, test
|
|
cases, etc. This means including a clear, concise description of the
|
|
problem, and a clear set of instructions for replicating the problem.
|
|
A minimal example that illustrates the bug in a nice small test case
|
|
is the best possible bug report.
|
|
|
|
* **Don't** use the ticket system to ask support questions. Use the
|
|
`django-users`_ list, or the `#django`_ IRC channel for that.
|
|
|
|
* **Don't** use the ticket system to make large-scale feature requests.
|
|
We like to discuss any big changes to Django's core on the `django-developers`_
|
|
list before actually working on them.
|
|
|
|
* **Don't** reopen issues that have been marked "wontfix". This mark means
|
|
that the decision has been made that we can't or won't fix this particular
|
|
issue. If you're not sure why, please ask on `django-developers`_.
|
|
|
|
* **Don't** use the ticket tracker for lengthy discussions, because they're
|
|
likely to get lost. If a particular ticket is controversial, please move
|
|
discussion to `django-developers`_.
|
|
|
|
Reporting security issues
|
|
=========================
|
|
|
|
Report security issues to security@djangoproject.com. This is a private list
|
|
only open to long-time, highly trusted Django developers, and its archives are
|
|
not publicly readable.
|
|
|
|
In the event of a confirmed vulnerability in Django itself, we will take the
|
|
following actions:
|
|
|
|
* Acknowledge to the reporter that we've received the report and that a fix
|
|
is forthcoming. We'll give a rough timeline and ask the reporter to keep
|
|
the issue confidential until we announce it.
|
|
|
|
* Halt all other development as long as is needed to develop a fix, including
|
|
patches against the current and two previous releases.
|
|
|
|
* Determine a go-public date for announcing the vulnerability and the fix.
|
|
To try to mitigate a possible "arms race" between those applying the patch
|
|
and those trying to exploit the hole, we will not announce security
|
|
problems immediately.
|
|
|
|
* Pre-notify everyone we know to be running the affected version(s) of
|
|
Django. We will send these notifications through private e-mail which will
|
|
include documentation of the vulnerability, links to the relevant patch(es),
|
|
and a request to keep the vulnerability confidential until the official
|
|
go-public date.
|
|
|
|
* Publicly announce the vulnerability and the fix on the pre-determined
|
|
go-public date. This will probably mean a new release of Django, but
|
|
in some cases it may simply be patches against current releases.
|
|
|
|
Submitting patches
|
|
==================
|
|
|
|
We're always grateful for patches to Django's code. Indeed, bug reports with
|
|
associated patches will get fixed *far* more quickly than those without patches.
|
|
|
|
Patch style
|
|
-----------
|
|
|
|
* Make sure your code matches our `coding style`_.
|
|
|
|
* Submit patches in the format returned by the ``svn diff`` command.
|
|
An exception is for code changes that are described more clearly in plain
|
|
English than in code. Indentation is the most common example; it's hard to
|
|
read patches when the only difference in code is that it's indented.
|
|
|
|
* Attach patches to a ticket in the `ticket tracker`_, using the "attach file"
|
|
button. Please *don't* put the patch in the ticket description or comment
|
|
unless it's a single line patch.
|
|
|
|
* Name the patch file with a ``.diff`` extension; this will let the ticket
|
|
tracker apply correct syntax highlighting, which is quite helpful.
|
|
|
|
* Check the "Has patch" box on the ticket details. This will make it
|
|
obvious that the ticket includes a patch, and it will add the ticket to
|
|
the `list of tickets with patches`_.
|
|
|
|
* The code required to fix a problem or add a feature is an essential part
|
|
of a patch, but it is not the only part. A good patch should also include
|
|
a regression test to validate the behavior that has been fixed (and prevent
|
|
the problem from arising again).
|
|
|
|
* If the code associated with a patch adds a new feature, or modifies behavior
|
|
of an existing feature, the patch should also contain documentation.
|
|
|
|
Non-trivial patches
|
|
-------------------
|
|
|
|
A "non-trivial" patch is one that is more than a simple bug fix. It's a patch
|
|
that introduces Django functionality and makes some sort of design decision.
|
|
|
|
If you provide a non-trivial patch, include evidence that alternatives have
|
|
been discussed on `django-developers`_. If you're not sure whether your patch
|
|
should be considered non-trivial, just ask.
|
|
|
|
Ticket triage
|
|
=============
|
|
|
|
Unfortunately, not all bug reports in the `ticket tracker`_ provide all
|
|
the `required details`_. A number of tickets have patches, but those patches
|
|
don't meet all the requirements of a `good patch`_.
|
|
|
|
One way to help out is to *triage* bugs that have been reported by other
|
|
users. A couple of dedicated volunteers work on this regularly, but more help
|
|
is always appreciated.
|
|
|
|
Most of the workflow is based around the concept of a ticket's "triage stage".
|
|
This stage describes where in its lifetime a given ticket is at any time.
|
|
Along with a handful of flags, this field easily tells us what and who each
|
|
ticket is waiting on.
|
|
|
|
Since a picture is worth a thousand words, let's start there:
|
|
|
|
.. image:: http://media.djangoproject.com/img/doc/djangotickets.png
|
|
:height: 451
|
|
:width: 590
|
|
:alt: Django's ticket workflow
|
|
|
|
We've got two roles here:
|
|
|
|
* Core developers: people with commit access who make the decisions and
|
|
write the bulk of the code.
|
|
|
|
* Ticket triagers: community members who keep track of tickets, making
|
|
sure the tickets are always categorized correctly.
|
|
|
|
Second, note the four triage stages:
|
|
|
|
1. A ticket starts as "Unreviewed", meaning that a triager has yet to
|
|
examine the ticket and move it along.
|
|
|
|
2. "Design decision needed" means "this concept requires a design
|
|
decision," which should be discussed either in the ticket comments or on
|
|
django-developers.
|
|
|
|
3. Once a ticket is ruled to be approved for fixing, it's moved into the
|
|
"Accepted" stage. This stage is where all the real work gets done.
|
|
|
|
4. If a ticket has an associated patch (see below), a triager will review the
|
|
patch. If the patch is complete, it'll be marked as "ready for checkin" so
|
|
that a core developer knows to review and check in the patches.
|
|
|
|
The second part of this workflow involves a set of flags the describe what the
|
|
ticket has or needs in order to be "ready for checkin":
|
|
|
|
"Has patch"
|
|
This means the ticket has an associated patch_. These will be
|
|
reviewed to see if the patch is "good".
|
|
|
|
"Needs documentation"
|
|
This flag is used for tickets with patches that need associated
|
|
documentation. Complete documentation of features is a prerequisite
|
|
before we can check a fix into the codebase.
|
|
|
|
"Needs tests"
|
|
This flags the patch as needing associated unit tests. Again, this is a
|
|
required part of a valid patch.
|
|
|
|
"Patch needs improvement"
|
|
This flag means that although the ticket *has* a patch, it's not quite
|
|
ready for checkin. This could mean the patch no longer applies
|
|
cleanly, or that the code doesn't live up to our standards.
|
|
|
|
A ticket can be resolved in a number of ways:
|
|
|
|
"fixed"
|
|
Used by one of the core developers once a patch has been rolled into
|
|
Django and the issue is fixed.
|
|
|
|
"invalid"
|
|
Used if the ticket is found to be incorrect or a user error.
|
|
|
|
"wontfix"
|
|
Used when a core developer decides that this request is not
|
|
appropriate for consideration in Django. This is usually chosen after
|
|
discussion in the ``django-developers`` mailing list, and you should
|
|
feel free to join in when it's something you care about.
|
|
|
|
"duplicate"
|
|
Used when another ticket covers the same issue. By closing duplicate
|
|
tickets, we keep all the discussion in one place, which helps everyone.
|
|
|
|
"worksforme"
|
|
Used when the triage team is unable to replicate the original bug.
|
|
|
|
If you believe that the ticket was closed in error -- because you're
|
|
still having the issue, or it's popped up somewhere else, or the triagers have
|
|
-- made a mistake, please reopen the ticket and tell us why. Please do not
|
|
reopen tickets that have been marked as "wontfix" by core developers.
|
|
|
|
.. _required details: `Reporting bugs`_
|
|
.. _good patch: `Patch style`_
|
|
.. _patch: `Submitting patches`_
|
|
|
|
Submitting and maintaining translations
|
|
=======================================
|
|
|
|
Various parts of Django, such as the admin site and validator error messages,
|
|
are internationalized. This means they display different text depending on a
|
|
user's language setting.
|
|
|
|
These translations are contributed by Django users worldwide. If you find an
|
|
incorrect translation, or if you'd like to add a language that isn't yet
|
|
translated, here's what to do:
|
|
|
|
* Join the `Django i18n mailing list`_ and introduce yourself.
|
|
* Create and submit translations using the methods described in the
|
|
`i18n documentation`_.
|
|
|
|
.. _Django i18n mailing list: http://groups.google.com/group/django-i18n/
|
|
.. _i18n documentation: ../i18n/
|
|
|
|
Coding style
|
|
============
|
|
|
|
Please follow these coding standards when writing code for inclusion in Django:
|
|
|
|
* Unless otherwise specified, follow `PEP 8`_.
|
|
|
|
* Use four spaces for indentation.
|
|
|
|
* Use underscores, not camelCase, for variable, function and method names
|
|
(i.e. ``poll.get_unique_voters()``, not ``poll.getUniqueVoters``).
|
|
|
|
* Use ``InitialCaps`` for class names (or for factory functions that
|
|
return classes).
|
|
|
|
* Mark all strings for internationalization; see the `i18n documentation`_
|
|
for details.
|
|
|
|
* In docstrings, use "action words," like so::
|
|
|
|
def foo():
|
|
"""
|
|
Calculates something and returns the result.
|
|
"""
|
|
pass
|
|
|
|
Here's an example of what not to do::
|
|
|
|
def foo():
|
|
"""
|
|
Calculate something and return the result.
|
|
"""
|
|
pass
|
|
|
|
* Please don't put your name in the code you contribute. Our policy is to
|
|
keep contributors' names in the ``AUTHORS`` file distributed with Django
|
|
-- not scattered throughout the codebase itself. Feel free to include a
|
|
change to the ``AUTHORS`` file in your patch if you make more than a
|
|
single trivial change.
|
|
|
|
Template style
|
|
--------------
|
|
|
|
* In Django template code, put one (and only one) space between the curly
|
|
brackets and the tag contents.
|
|
|
|
Do this::
|
|
|
|
{{ foo }}
|
|
|
|
Don't do this::
|
|
|
|
{{foo}}
|
|
|
|
View style
|
|
----------
|
|
|
|
* In Django views, the first parameter in a view function should be called
|
|
``request``.
|
|
|
|
Do this::
|
|
|
|
def my_view(request, foo):
|
|
# ...
|
|
|
|
Don't do this::
|
|
|
|
def my_view(req, foo):
|
|
# ...
|
|
|
|
Model style
|
|
-----------
|
|
|
|
* Field names should be all lowercase, using underscores instead of
|
|
camelCase.
|
|
|
|
Do this::
|
|
|
|
class Person(models.Model):
|
|
first_name = models.CharField(max_length=20)
|
|
last_name = models.CharField(max_length=40)
|
|
|
|
Don't do this::
|
|
|
|
class Person(models.Model):
|
|
FirstName = models.CharField(max_length=20)
|
|
Last_Name = models.CharField(max_length=40)
|
|
|
|
* The ``class Meta`` should appear *after* the fields are defined, with
|
|
a single blank line separating the fields and the class definition.
|
|
|
|
Do this::
|
|
|
|
class Person(models.Model):
|
|
first_name = models.CharField(max_length=20)
|
|
last_name = models.CharField(max_length=40)
|
|
|
|
class Meta:
|
|
verbose_name_plural = 'people'
|
|
|
|
Don't do this::
|
|
|
|
class Person(models.Model):
|
|
first_name = models.CharField(max_length=20)
|
|
last_name = models.CharField(max_length=40)
|
|
class Meta:
|
|
verbose_name_plural = 'people'
|
|
|
|
Don't do this, either::
|
|
|
|
class Person(models.Model):
|
|
class Meta:
|
|
verbose_name_plural = 'people'
|
|
|
|
first_name = models.CharField(max_length=20)
|
|
last_name = models.CharField(max_length=40)
|
|
|
|
* The order of model inner classes and standard methods should be as
|
|
follows (noting that these are not all required):
|
|
|
|
* All database fields
|
|
* ``class Meta``
|
|
* ``class Admin``
|
|
* ``def __unicode__()``
|
|
* ``def __str__()``
|
|
* ``def save()``
|
|
* ``def get_absolute_url()``
|
|
* Any custom methods
|
|
|
|
* If ``choices`` is defined for a given model field, define the choices as
|
|
a tuple of tuples, with an all-uppercase name, either near the top of the
|
|
model module or just above the model class. Example::
|
|
|
|
GENDER_CHOICES = (
|
|
('M', 'Male'),
|
|
('F', 'Female'),
|
|
)
|
|
|
|
Documentation style
|
|
===================
|
|
|
|
We place a high importance on consistency and readability of documentation.
|
|
(After all, Django was created in a journalism environment!)
|
|
|
|
Guidelines for ReST files
|
|
-------------------------
|
|
|
|
These guidelines regulate the format of our ReST documentation:
|
|
|
|
* In section titles, capitalize only initial words and proper nouns.
|
|
|
|
* Wrap the documentation at 80 characters wide, unless a code example
|
|
is significantly less readable when split over two lines, or for another
|
|
good reason.
|
|
|
|
Commonly used terms
|
|
-------------------
|
|
|
|
Here are some style guidelines on commonly used terms throughout the
|
|
documentation:
|
|
|
|
* **Django** -- when referring to the framework, capitalize Django. It is
|
|
lowercase only in Python code and in the djangoproject.com logo.
|
|
|
|
* **e-mail** -- it has a hyphen.
|
|
|
|
* **MySQL**
|
|
|
|
* **PostgreSQL**
|
|
|
|
* **Python** -- when referring to the language, capitalize Python.
|
|
|
|
* **realize**, **customize**, **initialize**, etc. -- use the American
|
|
"ize" suffix, not "ise."
|
|
|
|
* **SQLite**
|
|
|
|
* **subclass** -- it's a single word without a hyphen, both as a verb
|
|
("subclass that model") and as a noun ("create a subclass").
|
|
|
|
* **Web**, **World Wide Web**, **the Web** -- note Web is always
|
|
capitalized when referring to the World Wide Web.
|
|
|
|
* **Web site** -- use two words, with Web capitalized.
|
|
|
|
Django-specific terminology
|
|
---------------------------
|
|
|
|
* **model** -- it's not capitalized.
|
|
|
|
* **template** -- it's not capitalized.
|
|
|
|
* **URLconf** -- use three capitalized letters, with no space before
|
|
"conf."
|
|
|
|
* **view** -- it's not capitalized.
|
|
|
|
Committing code
|
|
===============
|
|
|
|
Please follow these guidelines when committing code to Django's Subversion
|
|
repository:
|
|
|
|
* For any medium-to-big changes, where "medium-to-big" is according to your
|
|
judgment, please bring things up on the `django-developers`_ mailing list
|
|
before making the change.
|
|
|
|
If you bring something up on `django-developers`_ and nobody responds,
|
|
please don't take that to mean your idea is great and should be
|
|
implemented immediately because nobody contested it. Django's lead
|
|
developers don't have a lot of time to read mailing-list discussions
|
|
immediately, so you may have to wait a couple of days before getting a
|
|
response.
|
|
|
|
* Write detailed commit messages in the past tense, not present tense.
|
|
|
|
* Good: "Fixed Unicode bug in RSS API."
|
|
* Bad: "Fixes Unicode bug in RSS API."
|
|
* Bad: "Fixing Unicode bug in RSS API."
|
|
|
|
* For commits to a branch, prefix the commit message with the branch name.
|
|
For example: "magic-removal: Added support for mind reading."
|
|
|
|
* Limit commits to the most granular change that makes sense. This means,
|
|
use frequent small commits rather than infrequent large commits. For
|
|
example, if implementing feature X requires a small change to library Y,
|
|
first commit the change to library Y, then commit feature X in a separate
|
|
commit. This goes a *long way* in helping all core Django developers
|
|
follow your changes.
|
|
|
|
* If your commit closes a ticket in the Django `ticket tracker`_, begin
|
|
your commit message with the text "Fixed #abc", where "abc" is the number
|
|
of the ticket your commit fixes. Example: "Fixed #123 -- Added support
|
|
for foo". We've rigged Subversion and Trac so that any commit message
|
|
in that format will automatically close the referenced ticket and post a
|
|
comment to it with the full commit message.
|
|
|
|
If your commit closes a ticket and is in a branch, use the branch name
|
|
first, then the "Fixed #abc." For example:
|
|
"magic-removal: Fixed #123 -- Added whizbang feature."
|
|
|
|
For the curious: We're using a `Trac post-commit hook`_ for this.
|
|
|
|
.. _Trac post-commit hook: http://trac.edgewall.org/browser/trunk/contrib/trac-post-commit-hook
|
|
|
|
* If your commit references a ticket in the Django `ticket tracker`_ but
|
|
does *not* close the ticket, include the phrase "Refs #abc", where "abc"
|
|
is the number of the ticket your commit references. We've rigged
|
|
Subversion and Trac so that any commit message in that format will
|
|
automatically post a comment to the appropriate ticket.
|
|
|
|
Unit tests
|
|
==========
|
|
|
|
Django comes with a test suite of its own, in the ``tests`` directory of the
|
|
Django tarball. It's our policy to make sure all tests pass at all times.
|
|
|
|
The tests cover:
|
|
|
|
* Models and the database API (``tests/modeltests/``).
|
|
* The cache system (``tests/regressiontests/cache.py``).
|
|
* The ``django.utils.dateformat`` module (``tests/regressiontests/dateformat/``).
|
|
* Database typecasts (``tests/regressiontests/db_typecasts/``).
|
|
* The template system (``tests/regressiontests/templates/`` and
|
|
``tests/regressiontests/defaultfilters/``).
|
|
* ``QueryDict`` objects (``tests/regressiontests/httpwrappers/``).
|
|
* Markup template tags (``tests/regressiontests/markup/``).
|
|
|
|
We appreciate any and all contributions to the test suite!
|
|
|
|
The Django tests all use the testing infrastructure that ships with Django for
|
|
testing applications. See `Testing Django applications`_ for an explanation of
|
|
how to write new tests.
|
|
|
|
.. _Testing Django applications: ../testing/
|
|
|
|
Running the unit tests
|
|
----------------------
|
|
|
|
To run the tests, ``cd`` to the ``tests/`` directory and type::
|
|
|
|
./runtests.py --settings=path.to.django.settings
|
|
|
|
Yes, the unit tests need a settings module, but only for database connection
|
|
info, with the ``DATABASE_ENGINE`` setting. You will also need a ``ROOT_URLCONF``
|
|
setting (its value is ignored; it just needs to be present) and a ``SITE_ID``
|
|
setting (any non-zero integer value will do) in order for all the tests to pass.
|
|
|
|
The unit tests will not touch your existing databases; they create a new
|
|
database, called ``django_test_db``, which is deleted when the tests are
|
|
finished. This means your user account needs permission to execute ``CREATE
|
|
DATABASE``.
|
|
|
|
Requesting features
|
|
===================
|
|
|
|
We're always trying to make Django better, and your feature requests are a key
|
|
part of that. Here are some tips on how to most effectively make a request:
|
|
|
|
* Request the feature on `django-developers`_, not in the ticket tracker;
|
|
it'll get read more closely if it's on the mailing list.
|
|
|
|
* Describe clearly and concisely what the missing feature is and how you'd
|
|
like to see it implemented. Include example code (non-functional is OK)
|
|
if possible.
|
|
|
|
* Explain *why* you'd like the feature. In some cases this is obvious, but
|
|
since Django is designed to help real developers get real work done,
|
|
you'll need to explain it, if it isn't obvious why the feature would be
|
|
useful.
|
|
|
|
As with most open-source projects, code talks. If you are willing to write the
|
|
code for the feature yourself or if (even better) you've already written it,
|
|
it's much more likely to be accepted. If it's a large feature that might need
|
|
multiple developers we're always happy to give you an experimental branch in
|
|
our repository; see below.
|
|
|
|
Branch policy
|
|
=============
|
|
|
|
In general, most development is confined to the trunk, and the trunk
|
|
is kept stable. People should be able to run production sites against the
|
|
trunk at any time.
|
|
|
|
Thus, large architectural changes -- that is, changes too large to be
|
|
encapsulated in a single patch, or changes that need multiple eyes on them --
|
|
will have dedicated branches. See, for example, the `i18n branch`_. If you
|
|
have a change of this nature that you'd like to work on, ask on
|
|
`django-developers`_ for a branch to be created for you. We'll create a branch
|
|
for pretty much any kind of experimenting you'd like to do.
|
|
|
|
We will only branch entire copies of the Django tree, even if work is only
|
|
happening on part of that tree. This makes it painless to switch to a branch.
|
|
|
|
Developers working on a branch should periodically merge changes from the trunk
|
|
into the branch. Please merge at least once a week. Every time you merge from
|
|
the trunk, note the merge and revision numbers in the commit message.
|
|
|
|
Once the branch is stable and ready to be merged into the trunk, alert
|
|
`django-developers`_.
|
|
|
|
After a branch has been merged, it should be considered "dead"; write access to
|
|
it will be disabled, and old branches will be periodically "trimmed." To keep
|
|
our SVN wrangling to a minimum, we won't be merging from a given branch into the
|
|
trunk more than once.
|
|
|
|
Using branches
|
|
--------------
|
|
|
|
To use a branch, you'll need to do two things:
|
|
|
|
* Get the branch's code through Subversion.
|
|
|
|
* Point your Python ``site-packages`` directory at the branch's version of
|
|
the ``django`` package rather than the version you already have
|
|
installed.
|
|
|
|
Getting the code from Subversion
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
|
To get the latest version of a branch's code, check it out using Subversion::
|
|
|
|
svn co http://code.djangoproject.com/svn/django/branches/<branch>/
|
|
|
|
...where ``<branch>`` is the branch's name. See the `list of branch names`_.
|
|
|
|
Alternatively, you can automatically convert an existing directory of the
|
|
Django source code as long as you've checked it out via Subversion. To do the
|
|
conversion, execute this command from within your ``django`` directory::
|
|
|
|
svn switch http://code.djangoproject.com/svn/django/branches/<branch>/
|
|
|
|
The advantage of using ``svn switch`` instead of ``svn co`` is that the
|
|
``switch`` command retains any changes you might have made to your local copy
|
|
of the code. It attempts to merge those changes into the "switched" code. The
|
|
disadvantage is that it may cause conflicts with your local changes if the
|
|
"switched" code has altered the same lines of code.
|
|
|
|
(Note that if you use ``svn switch``, you don't need to point Python at the new
|
|
version, as explained in the next section.)
|
|
|
|
.. _list of branch names: http://code.djangoproject.com/browser/django/branches
|
|
|
|
Pointing Python at the new Django version
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
|
Once you've retrieved the branch's code, you'll need to change your Python
|
|
``site-packages`` directory so that it points to the branch version of the
|
|
``django`` directory. (The ``site-packages`` directory is somewhere such as
|
|
``/usr/lib/python2.4/site-packages`` or
|
|
``/usr/local/lib/python2.4/site-packages`` or ``C:\Python\site-packages``.)
|
|
|
|
The simplest way to do this is by renaming the old ``django`` directory to
|
|
``django.OLD`` and moving the trunk version of the code into the directory
|
|
and calling it ``django``.
|
|
|
|
Alternatively, you can use a symlink called ``django`` that points to the
|
|
location of the branch's ``django`` package. If you want to switch back, just
|
|
change the symlink to point to the old code.
|
|
|
|
A third option is to use a `path file`_ (``<something>.pth``) which should
|
|
work on all systems (including Windows, which doesn't have symlinks
|
|
available). First, make sure there are no files, directories or symlinks named
|
|
``django`` in your ``site-packages`` directory. Then create a text file named
|
|
``django.pth`` and save it to your ``site-packages`` directory. That file
|
|
should contain a path to your copy of Django on a single line and optional
|
|
comments. Here is an example that points to multiple branches. Just uncomment
|
|
the line for the branch you want to use ('Trunk' in this example) and make
|
|
sure all other lines are commented::
|
|
|
|
# Trunk is a svn checkout of:
|
|
# http://code.djangoproject.com/svn/django/trunk/
|
|
#
|
|
/path/to/trunk
|
|
|
|
# <branch> is a svn checkout of:
|
|
# http://code.djangoproject.com/svn/django/branches/<branch>/
|
|
#
|
|
#/path/to/<branch>
|
|
|
|
# On windows a path may look like this:
|
|
# C:/path/to/<branch>
|
|
|
|
If you're using Django 0.95 or earlier and installed it using
|
|
``python setup.py install``, you'll have a directory called something like
|
|
``Django-0.95-py2.4.egg`` instead of ``django``. In this case, edit the file
|
|
``setuptools.pth`` and remove the line that references the Django ``.egg``
|
|
file. Then copy the branch's version of the ``django`` directory into
|
|
``site-packages``.
|
|
|
|
.. _path file: http://docs.python.org/lib/module-site.html
|
|
|
|
Official releases
|
|
=================
|
|
|
|
Django's release numbering works as follows:
|
|
|
|
* Versions are numbered in the form ``A.B`` or ``A.B.C``.
|
|
|
|
* ``A`` is the major version number, which is only incremented for major
|
|
changes to Django, and these changes are not necessarily
|
|
backwards-compatible. That is, code you wrote for Django 6.0 may break
|
|
when we release Django 7.0.
|
|
|
|
* ``B`` is the minor version number, which is incremented for large yet
|
|
backwards compatible changes. Code written for Django 6.4 will continue
|
|
to work under Django 6.5.
|
|
|
|
A minor release may deprecate certain features in previous releases. If a
|
|
feature in version ``A.B`` is deprecated, it will continue to work in
|
|
version ``A.B+1``. In version ``A.B+2``, use of the feature will raise a
|
|
``PendingDeprecationWarning`` but will continue to work. Version
|
|
``A.B+3`` will remove the feature entirely. Major point releases will
|
|
always remove deprecated features immediately.
|
|
|
|
* ``C`` is the micro version number which, is incremented for bug and
|
|
security fixes. A new micro-release will always be 100%
|
|
backwards-compatible with the previous micro-release.
|
|
|
|
* In some cases, we'll make release candidate releases. These are of the
|
|
form ``A.BrcN``, which means the ``Nth`` candidate release of version
|
|
``A.B``.
|
|
|
|
An exception to this version numbering scheme is the pre-1.0 Django code.
|
|
There's no guarantee of backwards-compatibility until the 1.0 release.
|
|
|
|
In Subversion, each Django release will be tagged under `tags/releases`_. If
|
|
it's necessary to release a bug fix release or a security release that doesn't
|
|
come from the trunk, we'll copy that tag to ``branches/releases`` to make the
|
|
bug fix release.
|
|
|
|
Deciding on features
|
|
====================
|
|
|
|
Once a feature's been requested and discussed, eventually we'll have a decision
|
|
about whether to include the feature or drop it.
|
|
|
|
Whenever possible, we strive for a rough consensus. To that end, we'll often
|
|
have informal votes on `django-developers`_ about a feature. In these votes we
|
|
follow the voting style invented by Apache and used on Python itself, where
|
|
votes are given as +1, +0, -0, or -1. Roughly translated, these votes mean:
|
|
|
|
* +1: "I love the idea and I'm strongly committed to it."
|
|
|
|
* +0: "Sounds OK to me."
|
|
|
|
* -0: "I'm not thrilled, but I won't stand in the way."
|
|
|
|
* -1: "I strongly disagree and would be very unhappy to see the idea turn
|
|
into reality."
|
|
|
|
Although these votes on django-developers are informal, they'll be taken very
|
|
seriously. After a suitable voting period, if an obvious consensus arises
|
|
we'll follow the votes.
|
|
|
|
However, consensus is not always possible. Tough decisions will be discussed by
|
|
all full committers and finally decided by the Benevolent Dictators for Life,
|
|
Adrian and Jacob.
|
|
|
|
Commit access
|
|
=============
|
|
|
|
Django has two types of committers:
|
|
|
|
Full committers
|
|
These are people who have a long history of contributions to Django's
|
|
codebase, a solid track record of being polite and helpful on the mailing
|
|
lists, and a proven desire to dedicate serious time to Django's development.
|
|
|
|
The bar is very high for full commit access. It will only be granted by
|
|
unanimous approval of all existing full committers, and the decision will err
|
|
on the side of rejection.
|
|
|
|
Partial committers
|
|
These are people who are "domain experts." They have direct check-in access
|
|
to the subsystems that fall under their jurisdiction, and they're given a
|
|
formal vote in questions that involve their subsystems. This type of access
|
|
is likely to be given to someone who contributes a large subframework to
|
|
Django and wants to continue to maintain it.
|
|
|
|
Like full committers, partial commit access is by unanimous approval of all
|
|
full committers (and any other partial committers in the same area).
|
|
However, the bar is set lower; proven expertise in the area in question is
|
|
likely to be sufficient.
|
|
|
|
To request commit access, please contact an existing committer privately. Public
|
|
requests for commit access are potential flame-war starters, and will be ignored.
|
|
|
|
.. _community page: http://www.djangoproject.com/community/
|
|
.. _ticket tracker: http://code.djangoproject.com/newticket
|
|
.. _django-developers: http://groups.google.com/group/django-developers
|
|
.. _FAQ: http://www.djangoproject.com/documentation/faq/
|
|
.. _search the tracker: http://code.djangoproject.com/search
|
|
.. _django-users: http://groups.google.com/group/django-users
|
|
.. _`#django`: irc://irc.freenode.net/django
|
|
.. _list of tickets with patches: http://code.djangoproject.com/query?status=new&status=assigned&status=reopened&has_patch=1&order=priority
|
|
.. _PEP 8: http://www.python.org/peps/pep-0008.html
|
|
.. _i18n branch: http://code.djangoproject.com/browser/django/branches/i18n
|
|
.. _`tags/releases`: http://code.djangoproject.com/browser/django/tags/releases
|