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

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