You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

v1.0.rst 30KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738
  1. =======================
  2. Oscar 1.0 release notes
  3. =======================
  4. :release: 2014-11-07
  5. Welcome to Oscar 1.0! It's been 7 months and some 800 commits since 0.7 and
  6. lots of work has gone into 1.0. This release makes quite a few changes,
  7. especially around supporting Django 1.7 with its app refactor and new migrations
  8. support.
  9. Also, `as you might have seen`_, the repositories for Oscar and most of its
  10. extensions have moved to a new `Github organisation`_. This marks a change for
  11. Oscar from being a Tangent-sponsored project to a more community-driven one,
  12. similar to Django itself. The core team is growing too to accommodate new
  13. contributors from outside Tangent. This is an exciting change and we're hopeful
  14. that Oscar can continue to grow and prosper. To mark this departure, this
  15. release has been renamed from 0.8 (under which we released three beta versions)
  16. to 1.0.
  17. .. _`as you might have seen`: https://groups.google.com/forum/#!searchin/django-oscar/organisation/django-oscar/6H7ByzRAkRY/6055EDottBAJ
  18. .. _`Github organisation`: https://github.com/django-oscar/django-oscar
  19. Table of contents:
  20. .. contents::
  21. :local:
  22. :depth: 1
  23. .. _compatibility_of_1.0:
  24. Compatibility
  25. -------------
  26. This release adds support for Django 1.7. Per our policy of always supporting
  27. two versions of Django, support for Django 1.5 has been dropped.
  28. This release also adds full Python 3.3 and 3.4 support.
  29. If you're using ``pysolr`` for search, you'll need to upgrade to version 3.2 or
  30. later.
  31. .. _new_in_1.0:
  32. What's new in Oscar 1.0?
  33. ------------------------
  34. Explicit differentiation of child, parent and stand-alone products
  35. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  36. In some edge cases, it was difficult to determine the 'type' of a product. For
  37. example, whether a product is a parent (or "group") product without children or
  38. stand-alone product (which never has children). To make that distinction
  39. easier, a ``structure`` field has been introduced on the ``AbstractProduct``
  40. class. In that process, naming for the three different product structures
  41. has been altered to be:
  42. *stand-alone product*
  43. A regular product (like a book)
  44. *parent product*
  45. A product that represents a set of *child* products (eg a T-shirt, where the set is
  46. the various color and size permutations). These were previously referred to
  47. as "group" products.
  48. *child product*
  49. All child products have a parent product. They're a specific version of the
  50. parent. Previously known as product variant.
  51. Some properties and method names have also been updated to the new naming. The
  52. old ones will throw a deprecation warning.
  53. Better handling of child products in product dashboard
  54. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  55. Together with the changes above, the dashboard experience for child products
  56. has been improved. The difference between a parent product and a stand-alone
  57. product is hidden from the user; a user can now add and remove child products
  58. on any suitable product. When the first child product is added, a stand-alone
  59. product becomes a parent product; and vice versa.
  60. In the front-end, the old name of "product variants" has been kept.
  61. Customisation just got easier!
  62. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  63. * Oscar's views are now dynamically imported. This means that they can be
  64. overridden like most other classes in Oscar; overriding the related
  65. Application instance is not necessary any more which simplifies the process of
  66. replacing or customising a view.
  67. * A new management command, ``oscar_fork_app``, has been introduced to make it
  68. easy to fork an Oscar app in order to override one of its classes.
  69. The documentation around :doc:`/topics/customisation` has been given an
  70. overhaul to incorporate the changes.
  71. Django 1.7 support
  72. ~~~~~~~~~~~~~~~~~~
  73. Oscar 1.0 comes with support for Django 1.7 out of the box. The app refactor
  74. and the new migration framework are both great improvements to Django. Oscar
  75. now ships with sets of migrations both for South and the new native
  76. migrations framework.
  77. Unfortunately, the changes in Django required a few breaking changes when
  78. upgrading Oscar both for users staying on Django 1.6 and for users upgrading to
  79. Django 1.7 at the same time. These are detailed in the section for
  80. backwards-incompatible changes.
  81. The changes in Django 1.7 meant quite a bit of effort to support both versions
  82. of Django, so it's very probable that Django 1.6 support will be removed in
  83. the next release of Oscar. Django 1.7 has notable improvements, so with that
  84. in mind, we can only recommend upgrading now.
  85. Billing addresses explicitly passed around checkout
  86. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  87. The ``build_submission`` method used in checkout now has a ``billing_address``
  88. key and the signatures for the ``submit`` and ``handle_order_placement`` methods
  89. have been extended to include it as a keyword argument. While this change should
  90. be backwards compatible, it's worth being aware of the method signature changes
  91. in case it affects your checkout implementation.
  92. Dashboard for weight-based shipping methods
  93. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  94. There is a new dashboard for weight-based shipping methods. It isn't enabled by
  95. default as weight-based shipping methods are themselves not enabled by default.
  96. To add it to the dashboard menu, include this snippet in your
  97. ``OSCAR_DASHBOARD_NAVIGATION`` setting:
  98. .. code-block:: python
  99. OSCAR_DASHBOARD_NAVIGATION = [
  100. ...
  101. {
  102. 'label': _('Shipping charges'),
  103. 'url_name': 'dashboard:shipping-method-list',
  104. },
  105. ...
  106. ]
  107. You'll also need to modify your shipping repository class to return weight-based
  108. shipping methods.
  109. US demo site
  110. ~~~~~~~~~~~~
  111. To help developers building sites for the US, a new example Oscar site has been
  112. included in the repo. This customises core Oscar to treat all prices as
  113. excluding tax and then calculate and apply taxes once the shipping address is
  114. known.
  115. Faceting for category browsing
  116. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  117. If Oscar is running with a Solr-powered search backend, the category browsing
  118. now shows facets (e.g. filter by price range, or product type). This is
  119. implemented via a new ``SearchHandler`` interface, which will eventually replace
  120. the tight coupling between Haystack and Oscar. It therefore paves the way for
  121. better support for other search engines.
  122. Reworked shipping app
  123. ~~~~~~~~~~~~~~~~~~~~~
  124. Several parts of the shipping app have been altered. The most important change
  125. is a change to the API of shipping methods to avoid a potential thread safety
  126. issue. Any existing Oscar sites with custom shipping methods will need to
  127. adjust them to confirm to the new API. The new API and the other changes are
  128. detailed below.
  129. See the
  130. :ref:`backwards incompatible changes <incompatible_shipping_changes_in_1.0>`
  131. for the shipping app and the
  132. :doc:`guide to configuring shipping </howto/how_to_configure_shipping>`
  133. for more information.
  134. Basket additions clean-up
  135. ~~~~~~~~~~~~~~~~~~~~~~~~~
  136. The forms and views around adding things to your basket have been vigorously
  137. reworked. This cleans up some very old code there and ensures variant products
  138. are handled in a consistent way.
  139. The changes do require changing the constructor signature of the
  140. ``AddToBasketForm`` - the details are documented in the
  141. :ref:`basket_app_changes`.
  142. Checkout improvements
  143. ~~~~~~~~~~~~~~~~~~~~~
  144. The checkout process now skips payment if the order total is zero (e.g. when
  145. ordering free products or using a voucher). As part of that, checkout views
  146. now evaluate *pre-conditions* (as before) and newly introduced
  147. *skip conditions*. This should make customising the checkout flow easier.
  148. Out with the old, in with the new
  149. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  150. Lots of methods deprecated in the 0.6 release have now been removed.
  151. Specifically, the partner "wrapper" functionality is now gone. All price and
  152. availability logic now needs to be handled with strategies.
  153. .. _minor_changes_in_1.0:
  154. Minor changes
  155. ~~~~~~~~~~~~~
  156. * The ``OSCAR_CURRENCY_LOCALE`` setting has been removed. The locale is now
  157. automatically determined from the current language. This ensures prices are
  158. always shown in the correct format when switching languages.
  159. * The login and registration view now redirects staff users to the dashboard
  160. after logging in. It also employs flash messages to welcome returning and
  161. newly registered users.
  162. * The basket middleware now assigns a ``basket_hash`` attribute to the
  163. ``request`` instance. This provides a hook for basket caching.
  164. * The tracking pixel now also reports the Oscar version in use. This was
  165. forgotten when adding tracking of the Python and Django version in 0.7.
  166. Total information collected now is the versions of Django, Python and Oscar.
  167. * The tracking pixel is now served by a server run by the new Oscar
  168. organisation, rather than by Tangent.
  169. * The ``OSCAR_SLUG_FUNCTION`` now accepts both string notation and a callable.
  170. * The default templates now allow the order status to be changed on the
  171. dashboard order detail page.
  172. * The forms for the order dashboard views are now loaded dynamically so they
  173. can be overridden.
  174. * An ``OSCAR_DELETE_IMAGE_FILES`` setting has been introduced which makes deleting
  175. image files and thumbnails after deleting a model with an ``ImageField``
  176. optional. It usually is desired behaviour, but can slow down an app when
  177. using a remote storage.
  178. * Oscar now ships with a ``oscar_populate_countries`` management command to
  179. populate the country databases. It replaces the ``countries.json`` fixture.
  180. The command relies on the ``pycountry`` library being installed.
  181. * It is now possible to use product attributes to add a relation to arbitrary
  182. model instances. There was some (presumably broken) support for it before,
  183. but you should now be able to use product attributes of type ``entity`` as
  184. expected. There's currently no frontend or dashboard support for it, as there
  185. is no good default behaviour.
  186. * Payment extensions can now raise a ``UserCancelled`` payment exception to
  187. differentiate between the intended user action and any other errors.
  188. * Oscar has a new dependency, django-tables2_. It's a handy library that helps
  189. when displaying tabular data, allowing sorting, etc. It also makes it easier
  190. to adapt e.g. the product list view in the dashboard to additional fields.
  191. * ``jquery-ui-datepicker`` has been replaced in the dashboard by
  192. bootstrap-datetimepicker_. We still ship with ``jquery-ui-datepicker`` and
  193. ``JQuery UI`` as it's in use in the frontend.
  194. * ... and dozens of bugs fixed!
  195. .. _django-tables2: https://django-tables2.readthedocs.io/en/latest/
  196. .. _bootstrap-datetimepicker: http://www.malot.fr/bootstrap-datetimepicker/
  197. .. _incompatible_changes_in_1.0:
  198. Backwards incompatible changes in 1.0
  199. -------------------------------------
  200. .. _product_structure_changes_in_1.0:
  201. Product structure
  202. ~~~~~~~~~~~~~~~~~
  203. Generally, backwards compatibility has been preserved. Be aware of the following
  204. points though:
  205. * You now need to explicitly set product structure when creating a product;
  206. the default is a stand-alone product.
  207. * The ``related_name`` for child products was altered from ``variants`` to
  208. ``children``. A ``variants`` property has been provided (and will throw a
  209. deprecation warning), but if you used the old related name in a query lookup
  210. (e.g. ``products.filter(variants__title='foo')``, you will have to change it
  211. to ``children``.
  212. * Template blocks and CSS classes have been renamed.
  213. The following methods and properties have been deprecated:
  214. * ``Product.is_parent`` - Use ``is_group`` instead.
  215. * ``Product.is_variant`` - Use ``is_child`` instead.
  216. * ``Product.is_top_level`` - Test for ``is_standalone`` and/or ``is_parent`` instead.
  217. * ``Strategy.fetch_for_group`` - Use ``fetch_for_parent`` instead.
  218. * ``Strategy.group_[pricing|availability]_policy`` - Use
  219. ``parent_[pricing|availability]_policy`` instead.
  220. * ``Strategy.select_variant_stockrecords`` - Use
  221. ``select_children_stockrecords`` instead.
  222. Furthermore, CSS classes and template blocks have been updated. Please follow
  223. the following renaming pattern:
  224. * ``variant-product`` becomes ``child-product``
  225. * ``product_variants`` becomes ``child_products``
  226. * ``variants`` becomes ``children``
  227. * ``variant`` becomes ``child``
  228. Product editing
  229. ~~~~~~~~~~~~~~~
  230. The dashboard improvements for child products meant slight changes to both
  231. ``ProductCreateUpdateView`` and ``ProductForm``. Notably ``ProductForm`` now
  232. gets a ``parent`` kwarg. Please review your customisations for compatibility
  233. with the updated code.
  234. .. _incompatible_shipping_changes_in_1.0:
  235. Shipping
  236. ~~~~~~~~
  237. The shipping method API has been altered to avoid potential thread-safety
  238. issues. Prior to v1.0, shipping methods had a ``set_basket`` method which
  239. allowed a basket instance to be assigned. This was really a crutch to allow
  240. templates to have easy access to shipping charges (as they could be read
  241. straight off the shipping method instance). However, it was also a
  242. design problem as shipping methods could be instantiated at compile-time
  243. leading to a thread safety issue where multiple threads could assign a basket
  244. to the same shipping method instance.
  245. In Oscar 1.0, shipping methods are stateless services that have a method
  246. :func:`~oscar.apps.shipping.methods.Base.calculate` that takes a basket and
  247. returns a ``Price`` instance. New :doc:`template tags </ref/templatetags/>` are
  248. provided that allow these shipping charges to be accessed from templates.
  249. This API change does require quite a few changes as both the shipping method
  250. and shipping charge now need to be passed around separately:
  251. * Shipping methods no longer have ``charge_excl_tax``,
  252. ``charge_incl_tax`` and ``is_tax_known`` properties.
  253. * The :class:`~oscar.apps.order.utils.OrderCreator` class now requires the
  254. ``shipping_charge`` to be passed to ``place_order``.
  255. * The signature of the :class:`~oscar.apps.checkout.calculators.OrderTotalCalculator`
  256. class has changed to accept ``shipping_charge`` rather than a
  257. ``shipping_method`` instance.
  258. * The signature of the
  259. :func:`~oscar.apps.checkout.session.CheckoutSessionMixin.get_order_totals`
  260. method has changed to accept the ``shipping_charge`` rather than a
  261. ``shipping_method`` instance.
  262. Another key change is in the shipping repository object. The
  263. ``get_shipping_methods`` method has been split in two to simplify the exercise
  264. of providing new shipping methods. The best practice for Oscar 1.0 is to
  265. override the ``methods`` attribute if the same set of shipping methods is
  266. available to everyone:
  267. .. code-block:: python
  268. from oscar.apps.shipping import repository, methods
  269. class Standard(methods.FixedPrice):
  270. code = "standard"
  271. name = "Standard"
  272. charge_excl_tax = D('10.00')
  273. class Express(methods.FixedPrice):
  274. code = "express"
  275. name = "Express"
  276. charge_excl_tax = D('20.00')
  277. class Repository(repository.Repository):
  278. methods = [Standard(), Express()]
  279. or to override ``get_available_shipping_methods`` if the available shipping
  280. methods if only available conditionally:
  281. .. code-block:: python
  282. from oscar.apps.shipping import repository
  283. class Repository(repository.Repository):
  284. def get_available_shipping_methods(
  285. self, basket, shipping_addr=None, **kwargs):
  286. methods = [Standard()]
  287. if shipping_addr.country.code == 'US':
  288. # Express only available in the US
  289. methods.append(Express())
  290. return methods
  291. Note that shipping address should be passed around as instances not classes.
  292. Email address handling
  293. ~~~~~~~~~~~~~~~~~~~~~~
  294. In theory, the local part of an email is case-sensitive. In practice, many
  295. users don't know about this and most email servers don't consider the
  296. capitalisation. Because of this, Oscar now disregards capitalisation when
  297. looking up emails (e.g. when a user logs in).
  298. Storing behaviour is unaltered: When a user's email address is stored (e.g.
  299. when registering or checking out), the local part is unaltered and
  300. the host portion is lowercased.
  301. .. warning::
  302. Those changes mean you might now have multiple users with email addresses
  303. that Oscar considers identical. Please use the new
  304. ``oscar_find_duplicate_emails`` management command to check your database
  305. and deal with any conflicts accordingly.
  306. Django 1.7 support
  307. ~~~~~~~~~~~~~~~~~~
  308. If you have any plans to upgrade to Django 1.7, more changes beyond
  309. addressing migrations are necessary:
  310. * You should be aware that Django 1.7 now enforces uniqueness of app labels.
  311. Oscar dashboard apps now ship with app configs that set their app label
  312. to ``{oldname}_dashboard``.
  313. * If you have forked any Oscar apps, you must add app configs to them, and
  314. have them inherit from the Oscar one. See the appropriate section in
  315. :doc:`/topics/fork_app` for an example.
  316. * Double-check that you address migrations as detailed below.
  317. * Django now enforces that no calls happen to the model registry during
  318. app startup. This mostly means that you should avoid module-level calls to
  319. ``get_model``, as that only works with a fully initialised model registry.
  320. Basket line stockrecords
  321. ~~~~~~~~~~~~~~~~~~~~~~~~
  322. The basket line model got a reference to the stockrecord in Oscar 0.6. The
  323. basket middleware since then updated basket lines to have stockrecords if
  324. one was missing. If any lines are still missing a stockrecord, we'd expect them
  325. to be from from submitted baskets or from old, abandoned baskets.
  326. This updating of basket lines has been removed for 1.0 as it incurs additional
  327. database queries. Oscar 1.0 now also enforces the stockrecord by making it
  328. the ``stockrecord`` field of basket ``Line`` model no longer nullable.
  329. There is a migration that makes the appropriate schema change but, before that
  330. runs, you may need to clean up your ``basket_line`` table to ensure that all
  331. existing null values are replaced or removed.
  332. Here's a simple script you could run before upgrading which should ensure there
  333. are no nulls in your ``basket_line`` table:
  334. .. code-block:: python
  335. from oscar.apps.basket import models
  336. from oscar.apps.partner.strategy import Selector
  337. strategy = Selector().strategy()
  338. lines = models.Line.objects.filter(stockrecord__isnull=True):
  339. for line in lines:
  340. info = strategy.fetch_for_product(line.product)
  341. if line.stockrecord:
  342. line.stockrecord = info.stockrecord
  343. line.save()
  344. else:
  345. line.delete()
  346. * The ``reload_page_response`` method of
  347. :class:`~oscar.apps.dashboard.orders.views.OrderDetailView`
  348. has been renamed to ``reload_page``.
  349. .. _basket_app_changes:
  350. Basket app changes
  351. ~~~~~~~~~~~~~~~~~~
  352. - The ``basket:add`` URL now required the primary key of the "base" product to
  353. be included. This allows the same form to be used for both GET and POST
  354. requests for variant products.
  355. - The ``ProductSelectionForm`` is no longer used and has been removed.
  356. - The constructor of the :class:`~oscar.apps.basket.forms.AddToBasketForm` has
  357. been adjusted to take the basket and the purchase info tuple as parameters
  358. instead of the request instance (c74f57bf_ and 8ba283e8_).
  359. .. _c74f57bf: https://github.com/django-oscar/django-oscar/commit/c74f57bf434661877f4d2d2259e7e7eb18b34951#diff-d200ac8746274e0307f512af886e1f3eR148
  360. .. _8ba283e8: https://github.com/django-oscar/django-oscar/commit/8ba283e8c4239e4eff95da5e8097a17ecfadf5f5
  361. Misc
  362. ~~~~
  363. * The ``oscar_calculate_scores`` command has been `rewritten`_ to use the ORM
  364. instead of raw SQL. That exposed a bug in the previous calculations,
  365. where purchases got weighed less than any other event. When you upgrade,
  366. your total scores will be change. If you rely on the old behaviour,
  367. just extend the ``Calculator`` class and adjust the weights.
  368. * ``Order.order_number`` now has ``unique=True`` set. If order numbers are
  369. not unique in your database, you need to remedy that before migrating. By
  370. default, Oscar creates unique order numbers.
  371. * ``Product.score`` was just duplicating ``ProductRecord.score`` and has been
  372. removed. Use ``Product.stats.score`` instead.
  373. * Oscar has child products to model tightly coupled products, and
  374. ``Product.recommended_products`` to model products that are loosely related
  375. (e.g. used for upselling). ``Product.related_products`` was a
  376. third option that sat somewhere in between, and which was not well supported.
  377. We fear it adds confusion, and in the spirit of keeping Oscar core lean,
  378. has been removed. If you're using it, switch to
  379. ``Product.recommended_products`` or just add the field back to your
  380. custom Product instance and ``ProductForm`` when migrating.
  381. * The ``basket_form`` template tag code has been greatly simplified. Because of
  382. that, the syntax needed to change slightly.
  383. Before: ``{% basket_form request product as basket_form single %}``
  384. After: ``{% basket_form request product 'single' as basket_form %}``
  385. * Product attribute validation has been cleaned up. As part of that, the
  386. trivial ``ProductAttribute.get_validator`` and the unused
  387. ``ProductAttribute.is_value_valid`` methods have been removed.
  388. * The ``RangeProductFileUpload`` model has been moved from the ranges
  389. dashboard app to the offers app. The migrations that have been naively
  390. drop and re-create the model; any data is lost! This is probably not an
  391. issue, as the model is only used while an range upload is in progress. If
  392. you need to keep the data, ensure you migrate it across.
  393. * ``oscar.core.loading.get_model`` now raises a ``LookupError`` instead of an
  394. ``ImportError`` if a model can't be found. That brings it more in line with
  395. what Django does since the app refactor.
  396. * ``CommunicationEventType.category`` was storing a localised string, which
  397. breaks when switching locale. It now uses ``choices`` to map between the
  398. value and a localised string. Unfortunately, if you're using this feature
  399. and not running an English locale, you will need to migrate the existing
  400. data to the English values.
  401. * Support for the ``OSCAR_OFFER_BLACKLIST_PRODUCT`` setting has been removed.
  402. It was only partially supported: it prevented products from being
  403. added to a range, but offers could be applied to the products nonetheless.
  404. To prevent an offer being applied to a product, use ``is_discountable`` or
  405. override ``get_is_discountable`` on your product instances.
  406. * ``Category.get_ancestors`` used to return a list of ancestors and would
  407. default to include itself. For consistency with get_descendants and to avoid
  408. having to slice the results in templates, it now returns a queryset of the
  409. ancestors; use ``Category.get_ancestors_and_self`` for the old behaviour.
  410. * Weight based shipping methods used to have an ``upper_charge`` field which was
  411. returned if no weight band matched. That doesn't work very well in practice,
  412. and has been removed. Instead, charges from bands are now added together to
  413. match the weight of the basket.
  414. * The :class:`~oscar.apps.order.utils.OrderCreator` class no longer defaults to
  415. free shipping: a shipping method and charge have to be explicitly passed in.
  416. * The ``Base`` shipping method class now lives in ``oscar.apps.shipping.methods``.
  417. * The ``find_by_code`` method of the shipping ``Repository`` class has been
  418. removed as it is no longer used.
  419. * The parameters for
  420. :func:`oscar.apps.shipping.repository.Repository.get_shipping_methods`
  421. have been re-ordered to reflect which are the most important.
  422. * The legacy ``ShippingMethod`` name of the interface of the shipping app has
  423. been removed. Inherit from ``shipping.base.Base`` for the class instead, and
  424. inherit from ``shipping.abstract_models.AbstractBase`` for model-based
  425. shipping methods.
  426. * ``oscar.apps.shipping.Scales`` has been renamed and moved to
  427. ``oscar.apps.shipping.scales.Scale``, and is now overridable.
  428. * The models of the shipping app now have abstract base classes, similar to
  429. the rest of Oscar.
  430. * The legacy ``ShippingMethod`` name of the interface of the shipping app has
  431. been removed. Inherit from ``shipping.base.Base`` for the class instead, and
  432. inherit from ``shipping.abstract_models.AbstractBase`` for model-based
  433. shipping methods.
  434. * Oscar's ``models.py`` files now define ``__all__``, and it's dynamically
  435. set to only expose unregistered models (which should be what you want) to
  436. the namespace. This is important to keep the namespace clean while doing
  437. star imports like ``from oscar.apps.catalogue.models import *``. You will
  438. have to check your imports to ensure you're not accidentally relying on
  439. e.g. a ``datetime`` import that's pulled in via the star import. Any such
  440. import errors will cause a loud failure and should be easy to spot and fix.
  441. .. _rewritten: https://github.com/django-oscar/django-oscar/commit/d8b4dbfed17be90846ea4bc47b5f7b39ad944c24
  442. Migrations
  443. ~~~~~~~~~~
  444. * South is no longer a dependency. This means it won't get installed
  445. automatically when you install Oscar. If you are on Django 1.6 and want to
  446. use South, you will need to explicitly install it and add it to your
  447. requirements.
  448. * Only South >= 1.0 is supported: South 1.0 is a backwards compatible release
  449. explicitly released to help with the upgrade path to Django 1.7. Please make
  450. sure you update accordingly if you intend to keep using South. Older versions
  451. of South will look in the wrong directories and will break with this Oscar
  452. release.
  453. * Rename your South ``migrations`` directories. To avoid
  454. clashes between Django's and South's migrations, you should rename
  455. all your South migrations directories (including those of forked Oscar apps)
  456. to ``south_migrations``. South 1.0 will check those first before falling back
  457. to ``migrations``.
  458. * If you're upgrading to Django 1.7, you
  459. will need to follow the `instructions to upgrade from South`_ for your own
  460. apps. For any forked Oscar apps, you will need to copy Oscar's initial
  461. migrations into your emptied ``migrations`` directory first, because Oscar's
  462. set of migrations depend on each other. You can then create migrations for
  463. your changes by calling ``./manage.py makemigrations``. Django should
  464. detect that the database layout already matches the state of migrations; so
  465. a call to ``migrate`` should fake the migrations.
  466. .. _instructions to upgrade from South: https://docs.djangoproject.com/en/1.7/topics/migrations/#upgrading-from-south
  467. .. warning::
  468. The catalogue app has a data migration to determine the product structure.
  469. Please double-check it's outcome and make sure to do something similar
  470. if you have forked the catalogue app.
  471. .. note::
  472. The migration numbers below refer to the numbers of the South migrations.
  473. Oscar 1.0 ships with a set of new initial migrations for Django's new
  474. native migrations framework. They include all the changes detailed below.
  475. .. note::
  476. Be sure to read the detailed instructions for
  477. :doc:`handling migrations </topics/upgrading>`.
  478. * Address:
  479. - ``0011`` - ``AbstractAddress.search_text`` turned into a ``TextField``.
  480. - ``0012`` - ``AbstractCountry``: Removed two unused indexes & turns numeric code into ``CharField``
  481. * Catalogue:
  482. - ``0021`` - Add ``unique_together`` to ``ProductAttributeValue``,
  483. ``ProductRecommendation`` and ``ProductCategory``
  484. - ``0022`` - Remove ``Product.score`` field.
  485. - ``0023`` - Drop ``Product.related_products``.
  486. - ``0024`` - Change ``ProductAttributeValue.value_text`` to a ``TextField``
  487. and do entity attribute changes and model deletions.
  488. - ``0025`` & ``0026`` - Schema & data migration to determine and save Product structure.
  489. * Offer:
  490. - ``0033`` - Use an ``AutoSlug`` field for ``Range`` models
  491. - ``0034`` - Add moved ``RangedProductFileUpload`` model.
  492. * Order:
  493. - ``0029`` - Add ``unique_together`` to ``PaymentEventQuantity`` and ``ShippingEventQuantity``
  494. - ``0030`` - Set ``unique=True`` for ``Order.order_number``
  495. - ``0031`` - ``AbstractAddress.search_text`` turned into a ``TextField``.
  496. * Partner:
  497. - ``0014`` - ``AbstractAddress.search_text`` turned into a ``TextField``.
  498. * Promotions:
  499. - ``0006`` - Add ``unique_together`` to ``OrderedProduct``
  500. * Ranges dashboard:
  501. - ``0003`` - Drop ``RangeProductFileUpload`` from ``ranges`` app. This is
  502. a destructive change!
  503. * Shipping:
  504. - ``0007`` - Change ``WeightBand.upper_limit`` from ``FloatField`` to ``DecimalField``
  505. - ``0008`` - Drop ``WeightBased.upper_charge`` field.
  506. .. _deprecated_features_in_1.0:
  507. Deprecated features
  508. ~~~~~~~~~~~~~~~~~~~
  509. The following features have been deprecated in this release:
  510. * Many attributes concerning product structure. Please see the
  511. `product structure changes <product_structure_changes_in_1.0>`_ for details.
  512. Removal of deprecated features
  513. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  514. These methods have been removed:
  515. * ``oscar.apps.catalogue.abstract_models.AbstractProduct.has_stockrecord``
  516. * ``oscar.apps.catalogue.abstract_models.AbstractProduct.stockrecord``
  517. * ``oscar.apps.catalogue.abstract_models.AbstractProduct.is_available_to_buy``
  518. * ``oscar.apps.catalogue.abstract_models.AbstractProduct.is_purchase_permitted``
  519. * ``oscar.apps.catalogue.views.get_product_base_queryset``
  520. * ``oscar.apps.partner.abstract_models.AbstractStockRecord.is_available_to_buy``
  521. * ``oscar.apps.partner.abstract_models.AbstractStockRecord.is_purchase_permitted``
  522. * ``oscar.apps.partner.abstract_models.AbstractStockRecord.availability_code``
  523. * ``oscar.apps.partner.abstract_models.AbstractStockRecord.availability``
  524. * ``oscar.apps.partner.abstract_models.AbstractStockRecord.max_purchase_quantity``
  525. * ``oscar.apps.partner.abstract_models.AbstractStockRecord.dispatch_date``
  526. * ``oscar.apps.partner.abstract_models.AbstractStockRecord.lead_time``
  527. * ``oscar.apps.partner.abstract_models.AbstractStockRecord.price_incl_tax``
  528. * ``oscar.apps.partner.abstract_models.AbstractStockRecord.price_tax``
  529. * ``oscar.apps.payment.abstract_models.AbstractBankcard.card_number``
  530. These classes have been removed:
  531. * ``oscar.apps.partner.prices.DelegateToStockRecord``
  532. * ``oscar.apps.partner.availability.DelegateToStockRecord``
  533. * ``oscar.apps.payment.utils.Bankcard``
  534. Known issues
  535. ------------
  536. * ``models.py`` dynamically sets ``__all__`` to control what models are
  537. importable through the star import. A bug in the ``models.py`` for the
  538. ``partner`` app means you'll have to explicitly import them. More info in
  539. `#1553`_.
  540. .. _#1553: https://github.com/django-oscar/django-oscar/issues/1553