Add __all__ to models module of overridable apps

Since the recommended way to override models within an app is to add
‘from oscar.apps.order.models import *’ we need to limit what is 
exported otherwise subtle bugs may occur in the users code.

Simply defining __all__ [‘Model1’, ‘Model2’] doesn’t work since Django
will raise an AppRegistryNotReady exception for all models listed in
the __all__ list but are not available. Dynamically building the list
solves this.

oscar/apps/address/models.py

@@ -2,12 +2,18 @@ from oscar.core.loading import is_model_registered
 from oscar.apps.address.abstract_models import (
     AbstractUserAddress, AbstractCountry)
 
+__all__ = []
+
 
 if not is_model_registered('address', 'UserAddress'):
     class UserAddress(AbstractUserAddress):
         pass
 
+    __all__.append('UserAddress')
+
 
 if not is_model_registered('address', 'Country'):
     class Country(AbstractCountry):
         pass
+
+    __all__.append('Country')

oscar/apps/analytics/models.py

@@ -5,26 +5,36 @@ from oscar.apps.analytics.abstract_models import (
     AbstractProductRecord, AbstractUserRecord,
     AbstractUserProductView, AbstractUserSearch)
 
+__all__ = []
+
 
 if not is_model_registered('analytics', 'ProductRecord'):
     class ProductRecord(AbstractProductRecord):
         pass
 
+    __all__.append('ProductRecord')
+
 
 if not is_model_registered('analytics', 'UserRecord'):
     class UserRecord(AbstractUserRecord):
         pass
 
+    __all__.append('UserRecord')
+
 
 if not is_model_registered('analytics', 'UserProductView'):
     class UserProductView(AbstractUserProductView):
         pass
 
+    __all__.append('UserProductView')
+
 
 if not is_model_registered('analytics', 'UserSearch'):
     class UserSearch(AbstractUserSearch):
         pass
 
+    __all__.append('UserSearch')
+
 
 if django.VERSION < (1, 7):
     from . import receivers  # noqa

oscar/apps/basket/models.py

@@ -2,6 +2,10 @@ from oscar.core.loading import is_model_registered
 from oscar.apps.basket.abstract_models import (
     AbstractBasket, AbstractLine, AbstractLineAttribute)
 
+__all__ = [
+    'InvalidBasketLineError',
+]
+
 
 class InvalidBasketLineError(Exception):
     pass
@@ -11,12 +15,18 @@ if not is_model_registered('basket', 'Basket'):
     class Basket(AbstractBasket):
         pass
 
+    __all__.append('Basket')
+
 
 if not is_model_registered('basket', 'Line'):
     class Line(AbstractLine):
         pass
 
+    __all__.append('Line')
+
 
 if not is_model_registered('basket', 'LineAttribute'):
     class LineAttribute(AbstractLineAttribute):
         pass
+
+    __all__.append('LineAttribute')

oscar/apps/catalogue/models.py

@@ -6,61 +6,85 @@ Vanilla product models
 from oscar.core.loading import is_model_registered
 from oscar.apps.catalogue.abstract_models import *  # noqa
 
+__all__ = []
+
 
 if not is_model_registered('catalogue', 'ProductClass'):
     class ProductClass(AbstractProductClass):
         pass
 
+    __all__.append('ProductClass')
+
 
 if not is_model_registered('catalogue', 'Category'):
     class Category(AbstractCategory):
         pass
 
+    __all__.append('Category')
+
 
 if not is_model_registered('catalogue', 'ProductCategory'):
     class ProductCategory(AbstractProductCategory):
         pass
 
+    __all__.append('ProductCategory')
+
 
 if not is_model_registered('catalogue', 'Product'):
     class Product(AbstractProduct):
         pass
 
+    __all__.append('Product')
+
 
 if not is_model_registered('catalogue', 'ProductRecommendation'):
     class ProductRecommendation(AbstractProductRecommendation):
         pass
 
+    __all__.append('ProductRecommendation')
+
 
 if not is_model_registered('catalogue', 'ProductAttribute'):
     class ProductAttribute(AbstractProductAttribute):
         pass
 
+    __all__.append('ProductAttribute')
+
 
 if not is_model_registered('catalogue', 'ProductAttributeValue'):
     class ProductAttributeValue(AbstractProductAttributeValue):
         pass
 
+    __all__.append('ProductAttributeValue')
+
 
 if not is_model_registered('catalogue', 'AttributeOptionGroup'):
     class AttributeOptionGroup(AbstractAttributeOptionGroup):
         pass
 
+    __all__.append('AttributeOptionGroup')
+
 
 if not is_model_registered('catalogue', 'AttributeOption'):
     class AttributeOption(AbstractAttributeOption):
         pass
 
+    __all__.append('AttributeOption')
+
 
 if not is_model_registered('catalogue', 'Option'):
     class Option(AbstractOption):
         pass
 
+    __all__.append('Option')
+
 
 if not is_model_registered('catalogue', 'ProductImage'):
     class ProductImage(AbstractProductImage):
         pass
 
+    __all__.append('ProductImage')
+
 
 if django.VERSION < (1, 7):
     from . import receivers  # noqa

oscar/apps/customer/models.py

@@ -3,27 +3,37 @@ import django
 from oscar.core.loading import is_model_registered
 from oscar.apps.customer import abstract_models
 
+__all__ = []
+
 
 if not is_model_registered('customer', 'Email'):
     class Email(abstract_models.AbstractEmail):
         pass
 
+    __all__.append('Email')
+
 
 if not is_model_registered('customer', 'CommunicationEventType'):
     class CommunicationEventType(
             abstract_models.AbstractCommunicationEventType):
         pass
 
+    __all__.append('CommunicationEventType')
+
 
 if not is_model_registered('customer', 'Notification'):
     class Notification(abstract_models.AbstractNotification):
         pass
 
+    __all__.append('Notification')
+
 
 if not is_model_registered('customer', 'ProductAlert'):
     class ProductAlert(abstract_models.AbstractProductAlert):
         pass
 
+    __all__.append('ProductAlert')
+
 
 if django.VERSION < (1, 7):
     from .receivers import *  # noqa

oscar/apps/order/models.py

@@ -3,66 +3,95 @@ from oscar.apps.order.abstract_models import *  # noqa
 from oscar.apps.address.abstract_models import (AbstractShippingAddress,
                                                 AbstractBillingAddress)
 
+__all__ = []
+
+
 if not is_model_registered('order', 'Order'):
     class Order(AbstractOrder):
         pass
 
+    __all__.append('Order')
+
 
 if not is_model_registered('order', 'OrderNote'):
     class OrderNote(AbstractOrderNote):
         pass
 
+    __all__.append('OrderNote')
+
 
 if not is_model_registered('order', 'CommunicationEvent'):
     class CommunicationEvent(AbstractCommunicationEvent):
         pass
 
+    __all__.append('CommunicationEvent')
+
 
 if not is_model_registered('order', 'ShippingAddress'):
     class ShippingAddress(AbstractShippingAddress):
         pass
 
+    __all__.append('ShippingAddress')
+
 
 if not is_model_registered('order', 'BillingAddress'):
     class BillingAddress(AbstractBillingAddress):
         pass
 
+    __all__.append('BillingAddress')
+
 
 if not is_model_registered('order', 'Line'):
     class Line(AbstractLine):
         pass
 
+    __all__.append('Line')
+
 
 if not is_model_registered('order', 'LinePrice'):
     class LinePrice(AbstractLinePrice):
         pass
 
+    __all__.append('LinePrice')
+
 
 if not is_model_registered('order', 'LineAttribute'):
     class LineAttribute(AbstractLineAttribute):
         pass
 
+    __all__.append('LineAttribute')
+
 
 if not is_model_registered('order', 'ShippingEvent'):
     class ShippingEvent(AbstractShippingEvent):
         pass
 
+    __all__.append('ShippingEvent')
+
 
 if not is_model_registered('order', 'ShippingEventType'):
     class ShippingEventType(AbstractShippingEventType):
         pass
 
+    __all__.append('ShippingEventType')
+
 
 if not is_model_registered('order', 'PaymentEvent'):
     class PaymentEvent(AbstractPaymentEvent):
         pass
 
+    __all__.append('PaymentEvent')
+
 
 if not is_model_registered('order', 'PaymentEventType'):
     class PaymentEventType(AbstractPaymentEventType):
         pass
 
+    __all__.append('PaymentEventType')
+
 
 if not is_model_registered('order', 'OrderDiscount'):
     class OrderDiscount(AbstractOrderDiscount):
         pass
+
+    __all__.append('OrderDiscount')

oscar/apps/partner/models.py

@@ -5,26 +5,36 @@ from oscar.apps.address.abstract_models import AbstractPartnerAddress
 from oscar.apps.partner.abstract_models import (
     AbstractPartner, AbstractStockRecord, AbstractStockAlert)
 
+__all__ = []
+
 
 if not is_model_registered('partner', 'Partner'):
     class Partner(AbstractPartner):
         pass
 
+    __all__.append('PartnerAddress')
+
 
 if not is_model_registered('partner', 'PartnerAddress'):
     class PartnerAddress(AbstractPartnerAddress):
         pass
 
+    __all__.append('PartnerAddress')
+
 
 if not is_model_registered('partner', 'StockRecord'):
     class StockRecord(AbstractStockRecord):
         pass
 
+    __all__.append('StockRecord')
+
 
 if not is_model_registered('partner', 'StockAlert'):
     class StockAlert(AbstractStockAlert):
         pass
 
+    __all__.append('StockAlert')
+
 
 if django.VERSION < (1, 7):
     from . import receivers  # noqa

oscar/apps/payment/models.py

@@ -2,22 +2,32 @@ from oscar.core.loading import is_model_registered
 
 from . import abstract_models
 
+__all__ = []
+
 
 if not is_model_registered('payment', 'Transaction'):
     class Transaction(abstract_models.AbstractTransaction):
         pass
 
+    __all__.append('Transaction')
+
 
 if not is_model_registered('payment', 'Source'):
     class Source(abstract_models.AbstractSource):
         pass
 
+    __all__.append('Source')
+
 
 if not is_model_registered('payment', 'SourceType'):
     class SourceType(abstract_models.AbstractSourceType):
         pass
 
+    __all__.append('SourceType')
+
 
 if not is_model_registered('payment', 'Bankcard'):
     class Bankcard(abstract_models.AbstractBankcard):
         pass
+
+    __all__.append('Bankcard')

oscar/apps/shipping/models.py

@@ -1,17 +1,25 @@
 from oscar.core.loading import is_model_registered
 from oscar.apps.shipping import abstract_models
 
+__all__ = []
+
 
 if not is_model_registered('shipping', 'OrderAndItemCharges'):
     class OrderAndItemCharges(abstract_models.AbstractOrderAndItemCharges):
         pass
 
+    __all__.append('OrderAndItemCharges')
+
 
 if not is_model_registered('shipping', 'WeightBased'):
     class WeightBased(abstract_models.AbstractWeightBased):
         pass
 
+    __all__.append('WeightBased')
+
 
 if not is_model_registered('shipping', 'WeightBand'):
     class WeightBand(abstract_models.AbstractWeightBand):
         pass
+
+    __all__.append('WeightBand')

oscar/apps/voucher/models.py

@@ -4,16 +4,22 @@ from oscar.core.loading import is_model_registered
 from oscar.apps.voucher.abstract_models import (
     AbstractVoucher, AbstractVoucherApplication)
 
+__all__ = []
+
 
 if not is_model_registered('voucher', 'Voucher'):
     class Voucher(AbstractVoucher):
         pass
 
+    __all__.append('Voucher')
+
 
 if not is_model_registered('voucher', 'VoucherApplication'):
     class VoucherApplication(AbstractVoucherApplication):
         pass
 
+    __all__.append('VoucherApplication')
+
 
 if django.VERSION < (1, 7):
     from . import receivers  # noqa

oscar/apps/wishlists/models.py

@@ -3,12 +3,18 @@ from oscar.core.loading import is_model_registered
 
 from .abstract_models import *  # noqa
 
+__all__ = []
+
 
 if not is_model_registered('wishlists', 'WishList'):
     class WishList(AbstractWishList):
         pass
 
+    __all__.append('WishList')
+
 
 if not is_model_registered('wishlists', 'Line'):
     class Line(AbstractLine):
         pass
+
+    __all__.append('Line')