From 0b167aaa2cf607adddf4fe96c3da55b160b95602 Mon Sep 17 00:00:00 2001 From: Raphael Michel Date: Thu, 3 Nov 2016 11:33:00 +0100 Subject: [PATCH] Deprecate PluginType --- doc/development/api/plugins.rst | 20 ++++++------------- src/pretix/base/plugins.py | 5 +++++ src/pretix/plugins/banktransfer/__init__.py | 2 -- src/pretix/plugins/checkinlists/__init__.py | 2 -- src/pretix/plugins/paypal/__init__.py | 2 -- src/pretix/plugins/pretixdroid/__init__.py | 2 -- src/pretix/plugins/reports/__init__.py | 2 -- src/pretix/plugins/sendmail/__init__.py | 2 -- src/pretix/plugins/statistics/__init__.py | 2 -- src/pretix/plugins/stripe/__init__.py | 2 -- .../plugins/ticketoutputpdf/__init__.py | 2 -- src/tests/testdummy/__init__.py | 3 --- 12 files changed, 11 insertions(+), 35 deletions(-) diff --git a/doc/development/api/plugins.rst b/doc/development/api/plugins.rst index a9268583e1..f64973e2bd 100644 --- a/doc/development/api/plugins.rst +++ b/doc/development/api/plugins.rst @@ -30,10 +30,6 @@ Plugin metadata The plugin metadata lives inside a ``PretixPluginMeta`` class inside your app's configuration class. The metadata class must define the following attributes: -``type`` (``pretix.base.plugins.PluginType``): - The type of plugin. Currently available: ``RESTRICTION``, ``PAYMENT``, - ``ADMINFEATURE`` - ``name`` (``str``): The human-readable name of your plugin @@ -51,24 +47,20 @@ A working example would be:: # file: pretix/plugins/timerestriction/__init__.py from django.apps import AppConfig from django.utils.translation import ugettext_lazy as _ - from pretix.base.plugins import PluginType - class TimeRestrictionApp(AppConfig): - name = 'pretix.plugins.timerestriction' - verbose_name = _("Time restriction") + class PaypalApp(AppConfig): + name = 'pretix.plugins.paypal' + verbose_name = _("Stripe") class PretixPluginMeta: - type = PluginType.RESTRICTION - name = _("Restriciton by time") + name = _("PayPal") author = _("the pretix team") version = '1.0.0' - description = _("This plugin adds the possibility to restrict the sale " + - "of a given item or variation to a certain timeframe " + - "or change its price during a certain period.") + description = _("This plugin allows you to receive payments via PayPal") - default_app_config = 'pretix.plugins.timerestriction.TimeRestrictionApp' + default_app_config = 'pretix.plugins.paypal.PaypalApp' The ``AppConfig`` class may implement a property ``compatiblity_errors``, that checks diff --git a/src/pretix/base/plugins.py b/src/pretix/base/plugins.py index 29b40e39d5..f2a80dfc2d 100644 --- a/src/pretix/base/plugins.py +++ b/src/pretix/base/plugins.py @@ -5,6 +5,11 @@ from django.apps import apps class PluginType(Enum): + """ + Plugin type classification. THIS IS DEPRECATED, DO NOT USE ANY MORE. + This is only not removed yet as external plugins might have references + to this enum. + """ RESTRICTION = 1 PAYMENT = 2 ADMINFEATURE = 3 diff --git a/src/pretix/plugins/banktransfer/__init__.py b/src/pretix/plugins/banktransfer/__init__.py index abb40d57b2..f7be956018 100644 --- a/src/pretix/plugins/banktransfer/__init__.py +++ b/src/pretix/plugins/banktransfer/__init__.py @@ -3,7 +3,6 @@ from django.utils.functional import cached_property from django.utils.translation import ugettext_lazy as _ from pretix import __version__ as version -from pretix.base.plugins import PluginType class BankTransferApp(AppConfig): @@ -11,7 +10,6 @@ class BankTransferApp(AppConfig): verbose_name = _("Bank transfer") class PretixPluginMeta: - type = PluginType.PAYMENT name = _("Bank transfer") author = _("the pretix team") version = version diff --git a/src/pretix/plugins/checkinlists/__init__.py b/src/pretix/plugins/checkinlists/__init__.py index d199fa1377..e017d7a986 100644 --- a/src/pretix/plugins/checkinlists/__init__.py +++ b/src/pretix/plugins/checkinlists/__init__.py @@ -3,7 +3,6 @@ from django.utils.functional import cached_property from django.utils.translation import ugettext_lazy as _ from pretix import __version__ as version -from pretix.base.plugins import PluginType class CheckinlistsApp(AppConfig): @@ -11,7 +10,6 @@ class CheckinlistsApp(AppConfig): verbose_name = _("Check-in lists") class PretixPluginMeta: - type = PluginType.PAYMENT name = _("Check-in list exporter") author = _("the pretix team") version = version diff --git a/src/pretix/plugins/paypal/__init__.py b/src/pretix/plugins/paypal/__init__.py index 7baae5252c..5c73ac7d88 100644 --- a/src/pretix/plugins/paypal/__init__.py +++ b/src/pretix/plugins/paypal/__init__.py @@ -3,7 +3,6 @@ from django.utils.functional import cached_property from django.utils.translation import ugettext_lazy as _ from pretix import __version__ as version -from pretix.base.plugins import PluginType class PaypalApp(AppConfig): @@ -11,7 +10,6 @@ class PaypalApp(AppConfig): verbose_name = _("Stripe") class PretixPluginMeta: - type = PluginType.PAYMENT name = _("PayPal") author = _("the pretix team") version = version diff --git a/src/pretix/plugins/pretixdroid/__init__.py b/src/pretix/plugins/pretixdroid/__init__.py index 053e46cb35..a1b4bf9f90 100644 --- a/src/pretix/plugins/pretixdroid/__init__.py +++ b/src/pretix/plugins/pretixdroid/__init__.py @@ -2,7 +2,6 @@ from django.apps import AppConfig from django.utils.translation import ugettext_lazy as _ from pretix import __version__ as version -from pretix.base.plugins import PluginType class PretixdroidApp(AppConfig): @@ -10,7 +9,6 @@ class PretixdroidApp(AppConfig): verbose_name = _("pretixdroid API") class PretixPluginMeta: - type = PluginType.ADMINFEATURE name = _("pretixdroid API") author = _("the pretix team") version = version diff --git a/src/pretix/plugins/reports/__init__.py b/src/pretix/plugins/reports/__init__.py index 9c98792dc8..ffb4de6c82 100644 --- a/src/pretix/plugins/reports/__init__.py +++ b/src/pretix/plugins/reports/__init__.py @@ -3,7 +3,6 @@ from django.utils.functional import cached_property from django.utils.translation import ugettext_lazy as _ from pretix import __version__ as version -from pretix.base.plugins import PluginType class ReportsApp(AppConfig): @@ -11,7 +10,6 @@ class ReportsApp(AppConfig): verbose_name = _("Report exporter") class PretixPluginMeta: - type = PluginType.PAYMENT name = _("Report exporter") author = _("the pretix team") version = version diff --git a/src/pretix/plugins/sendmail/__init__.py b/src/pretix/plugins/sendmail/__init__.py index fdaa222a10..4ece00263b 100644 --- a/src/pretix/plugins/sendmail/__init__.py +++ b/src/pretix/plugins/sendmail/__init__.py @@ -2,7 +2,6 @@ from django.apps import AppConfig from django.utils.translation import ugettext_lazy as _ from pretix import __version__ as version -from pretix.base.plugins import PluginType class SendMailApp(AppConfig): @@ -10,7 +9,6 @@ class SendMailApp(AppConfig): verbose_name = _("Send out emails") class PretixPluginMeta: - type = PluginType.ADMINFEATURE name = _("Send out emails") author = _("the pretix team") version = version diff --git a/src/pretix/plugins/statistics/__init__.py b/src/pretix/plugins/statistics/__init__.py index 902f92253e..c0aa494971 100644 --- a/src/pretix/plugins/statistics/__init__.py +++ b/src/pretix/plugins/statistics/__init__.py @@ -2,7 +2,6 @@ from django.apps import AppConfig from django.utils.translation import ugettext_lazy as _ from pretix import __version__ as version -from pretix.base.plugins import PluginType class StatisticsApp(AppConfig): @@ -10,7 +9,6 @@ class StatisticsApp(AppConfig): verbose_name = _("Statistics") class PretixPluginMeta: - type = PluginType.ADMINFEATURE name = _("Statistics") author = _("the pretix team") version = version diff --git a/src/pretix/plugins/stripe/__init__.py b/src/pretix/plugins/stripe/__init__.py index 845831f49c..215ac28532 100644 --- a/src/pretix/plugins/stripe/__init__.py +++ b/src/pretix/plugins/stripe/__init__.py @@ -3,7 +3,6 @@ from django.utils.functional import cached_property from django.utils.translation import ugettext_lazy as _ from pretix import __version__ as version -from pretix.base.plugins import PluginType class StripeApp(AppConfig): @@ -11,7 +10,6 @@ class StripeApp(AppConfig): verbose_name = _("Stripe") class PretixPluginMeta: - type = PluginType.PAYMENT name = _("Stripe") author = _("the pretix team") version = version diff --git a/src/pretix/plugins/ticketoutputpdf/__init__.py b/src/pretix/plugins/ticketoutputpdf/__init__.py index c72e784355..3a133d918d 100644 --- a/src/pretix/plugins/ticketoutputpdf/__init__.py +++ b/src/pretix/plugins/ticketoutputpdf/__init__.py @@ -3,7 +3,6 @@ from django.utils.functional import cached_property from django.utils.translation import ugettext_lazy as _ from pretix import __version__ as version -from pretix.base.plugins import PluginType class TicketOutputPdfApp(AppConfig): @@ -11,7 +10,6 @@ class TicketOutputPdfApp(AppConfig): verbose_name = _("PDF ticket output") class PretixPluginMeta: - type = PluginType.PAYMENT name = _("PDF ticket output") author = _("the pretix team") version = version diff --git a/src/tests/testdummy/__init__.py b/src/tests/testdummy/__init__.py index 36e1199dd5..9af640c51d 100644 --- a/src/tests/testdummy/__init__.py +++ b/src/tests/testdummy/__init__.py @@ -1,14 +1,11 @@ from django.apps import AppConfig -from pretix.base.plugins import PluginType - class TestDummyApp(AppConfig): name = 'tests.testdummy' verbose_name = '.testdummy' class PretixPluginMeta: - type = PluginType.RESTRICTION name = '.testdummy' version = '1.0.0'