mpt-extension-sdk 5.6.0__py3-none-any.whl → 5.7.0__py3-none-any.whl

mpt_extension_sdk/mpt_http/mpt.py

@@ -18,21 +18,22 @@ def _has_more_pages(page):
 
 
 def _paginated(mpt_client, url, limit=10):
-    items = []
+    pages_items = []
     page = None
     offset = 0
     while _has_more_pages(page):
         response = mpt_client.get(f"{url}&limit={limit}&offset={offset}")
         response.raise_for_status()
         page = response.json()
-        items.extend(page["data"])
+        pages_items.extend(page["data"])
         offset += limit
 
-    return items
+    return pages_items
 
 
 @wrap_mpt_http_error
 def get_agreement(mpt_client, agreement_id):
+    """Retrieve an agreement by ID."""
     response = mpt_client.get(
         f"/commerce/agreements/{agreement_id}?select=seller,buyer,listing,product,subscriptions"
     )
@@ -42,6 +43,7 @@ def get_agreement(mpt_client, agreement_id):
 
 @wrap_mpt_http_error
 def get_licensee(mpt_client, licensee_id):
+    """Retrieve a licensee by ID."""
     response = mpt_client.get(f"/accounts/licensees/{licensee_id}")
     response.raise_for_status()
     return response.json()
@@ -49,6 +51,7 @@ def get_licensee(mpt_client, licensee_id):
 
 @wrap_mpt_http_error
 def update_order(mpt_client, order_id, **kwargs):
+    """Update an order."""
     response = mpt_client.put(
         f"/commerce/orders/{order_id}",
         json=kwargs,
@@ -59,6 +62,7 @@ def update_order(mpt_client, order_id, **kwargs):
 
 @wrap_mpt_http_error
 def query_order(mpt_client, order_id, **kwargs):
+    """Query an order."""
     response = mpt_client.post(
         f"/commerce/orders/{order_id}/query",
         json=kwargs,
@@ -69,6 +73,7 @@ def query_order(mpt_client, order_id, **kwargs):
 
 @wrap_mpt_http_error
 def fail_order(mpt_client, order_id, status_notes, **kwargs):
+    """Fail an order."""
     response = mpt_client.post(
         f"/commerce/orders/{order_id}/fail",
         json={
@@ -82,6 +87,7 @@ def fail_order(mpt_client, order_id, status_notes, **kwargs):
 
 @wrap_mpt_http_error
 def complete_order(mpt_client, order_id, template, **kwargs):
+    """Complete an order."""
     response = mpt_client.post(
         f"/commerce/orders/{order_id}/complete",
         json={"template": template, **kwargs},
@@ -92,6 +98,7 @@ def complete_order(mpt_client, order_id, template, **kwargs):
 
 @wrap_mpt_http_error
 def set_processing_template(mpt_client, order_id, template):
+    """Set the processing template for an order."""
     response = mpt_client.put(
         f"/commerce/orders/{order_id}",
         json={"template": template},
@@ -100,8 +107,25 @@ def set_processing_template(mpt_client, order_id, template):
     return response.json()
 
 
+@wrap_mpt_http_error
+def create_asset(mpt_client, order_id, asset):
+    """Create a new asset for an order."""
+    response = mpt_client.post(f"/commerce/orders/{order_id}/assets", json=asset)
+    response.raise_for_status()
+    return response.json()
+
+
+@wrap_mpt_http_error
+def update_asset(mpt_client, order_id, asset_id, **kwargs):
+    """Update an order asset."""
+    response = mpt_client.put(f"/commerce/orders/{order_id}/assets/{asset_id}", json=kwargs)
+    response.raise_for_status()
+    return response.json()
+
+
 @wrap_mpt_http_error
 def create_subscription(mpt_client, order_id, subscription):
+    """Create a new subscription for an order."""
     response = mpt_client.post(
         f"/commerce/orders/{order_id}/subscriptions",
         json=subscription,
@@ -112,6 +136,7 @@ def create_subscription(mpt_client, order_id, subscription):
 
 @wrap_mpt_http_error
 def update_subscription(mpt_client, order_id, subscription_id, **kwargs):
+    """Update an order subscription."""
     response = mpt_client.put(
         f"/commerce/orders/{order_id}/subscriptions/{subscription_id}",
         json=kwargs,
@@ -121,9 +146,8 @@ def update_subscription(mpt_client, order_id, subscription_id, **kwargs):
 
 
 @wrap_mpt_http_error
-def get_order_subscription_by_external_id(
-    mpt_client, order_id, subscription_external_id
-):
+def get_order_subscription_by_external_id(mpt_client, order_id, subscription_external_id):
+    """Retrieve an order subscription by its external ID."""
     response = mpt_client.get(
         f"/commerce/orders/{order_id}/subscriptions?eq(externalIds.vendor,{subscription_external_id})&limit=1",
     )
@@ -131,13 +155,14 @@ def get_order_subscription_by_external_id(
     subscriptions = response.json()
     if subscriptions["$meta"]["pagination"]["total"] == 1:
         return subscriptions["data"][0]
+    return None
 
 
 @wrap_mpt_http_error
 def get_product_items_by_skus(mpt_client, product_id, skus):
-    rql_query = (
-        f"and(eq(product.id,{product_id}),in(externalIds.vendor,({','.join(skus)})))"
-    )
+    """Retrieve product items by their SKUs."""
+    skus_str = ",".join(skus)
+    rql_query = f"and(eq(product.id,{product_id}),in(externalIds.vendor,({skus_str})))"
     url = f"/catalog/items?{rql_query}"
     return _paginated(mpt_client, url)
 
@@ -145,6 +170,7 @@ def get_product_items_by_skus(mpt_client, product_id, skus):
 @cache
 @wrap_mpt_http_error
 def get_webhook(mpt_client, webhook_id):
+    """Retrieve a webhook by ID."""
     response = mpt_client.get(f"/notifications/webhooks/{webhook_id}?select=criteria")
     response.raise_for_status()
 
@@ -153,6 +179,7 @@ def get_webhook(mpt_client, webhook_id):
 
 @wrap_mpt_http_error
 def get_product_template_or_default(mpt_client, product_id, status, name=None):
+    """Retrieve a product template by ID or return the default template."""
     name_or_default_filter = "eq(default,true)"
     if name:
         name_or_default_filter = f"or({name_or_default_filter},eq(name,{name}))"
@@ -164,8 +191,18 @@ def get_product_template_or_default(mpt_client, product_id, status, name=None):
     return templates["data"][0]
 
 
+def get_template_by_name(mpt_client, product_id, template_name):
+    """Retrieve a product template by name."""
+    url = f"/catalog/products/{product_id}/templates?eq(name,{template_name})"
+    response = mpt_client.get(url)
+    response.raise_for_status()
+    templates = response.json()
+    return templates["data"][0]
+
+
 @wrap_mpt_http_error
 def update_agreement(mpt_client, agreement_id, **kwargs):
+    """Update an agreement."""
     response = mpt_client.put(
         f"/commerce/agreements/{agreement_id}",
         json=kwargs,
@@ -176,6 +213,7 @@ def update_agreement(mpt_client, agreement_id, **kwargs):
 
 @wrap_mpt_http_error
 def get_agreements_by_query(mpt_client: MPTClient, query: str, limit: int = 10):
+    """Retrieve agreements by query."""
     url = f"/commerce/agreements?{query}"
     return _paginated(mpt_client, url, limit=limit)
 
@@ -186,12 +224,14 @@ def get_subscriptions_by_query(
     query: str,
     limit: int = 10,
 ) -> list[dict]:
+    """Retrieve subscriptions by query."""
     url = f"/commerce/subscriptions?{query}"
     return _paginated(mpt_client, url, limit=limit)
 
 
 @wrap_mpt_http_error
 def update_agreement_subscription(mpt_client, subscription_id, **kwargs):
+    """Update an agreement subscription."""
     response = mpt_client.put(
         f"/commerce/subscriptions/{subscription_id}",
         json=kwargs,
@@ -202,6 +242,7 @@ def update_agreement_subscription(mpt_client, subscription_id, **kwargs):
 
 @wrap_mpt_http_error
 def get_agreement_subscription(mpt_client, subscription_id):
+    """Retrieve an agreement subscription by ID."""
     response = mpt_client.get(
         f"/commerce/subscriptions/{subscription_id}",
     )
@@ -211,6 +252,7 @@ def get_agreement_subscription(mpt_client, subscription_id):
 
 @wrap_mpt_http_error
 def get_rendered_template(mpt_client, order_id):
+    """Retrieve the rendered template for an order."""
     response = mpt_client.get(
         f"/commerce/orders/{order_id}/template",
     )
@@ -220,8 +262,10 @@ def get_rendered_template(mpt_client, order_id):
 
 @wrap_mpt_http_error
 def get_product_onetime_items_by_ids(mpt_client, product_id, item_ids):
+    """Retrieve one-time product items by their IDs."""
+    item_ids_str = ",".join(item_ids)
     product_cond = f"eq(product.id,{product_id})"
-    items_cond = f"in(id,({','.join(item_ids)}))"
+    items_cond = f"in(id,({item_ids_str}))"
     rql_query = f"and({product_cond},{items_cond},eq(terms.period,one-time))"
     url = f"/catalog/items?{rql_query}"
 
@@ -229,8 +273,10 @@ def get_product_onetime_items_by_ids(mpt_client, product_id, item_ids):
 
 
 def get_agreements_by_ids(mpt_client, ids):
+    """Retrieve agreements by their IDs."""
+    ids_str = ",".join(ids)
     rql_query = (
-        f"and(in(id,({','.join(ids)})),eq(status,Active))"
+        f"and(in(id,({ids_str})),eq(status,Active))"
         "&select=lines,parameters,subscriptions,product,listing"
     )
     return get_agreements_by_query(mpt_client, rql_query)
@@ -239,7 +285,9 @@ def get_agreements_by_ids(mpt_client, ids):
 def get_all_agreements(
     mpt_client,
 ):
-    product_condition = f"in(product.id,({','.join(settings.MPT_PRODUCTS_IDS)}))"
+    """Retrieve all active agreements for specific products."""
+    product_ids_str = ",".join(settings.MPT_PRODUCTS_IDS)
+    product_condition = f"in(product.id,({product_ids_str}))"
 
     return get_agreements_by_query(
         mpt_client,
@@ -248,9 +296,8 @@ def get_all_agreements(
 
 
 @wrap_mpt_http_error
-def get_authorizations_by_currency_and_seller_id(
-    mpt_client, product_id, currency, owner_id
-):
+def get_authorizations_by_currency_and_seller_id(mpt_client, product_id, currency, owner_id):
+    """Retrieve authorizations by product ID, currency, and owner ID."""
     authorization_filter = (
         f"eq(product.id,{product_id})&eq(currency,{currency})&eq(owner.id,{owner_id})"
     )
@@ -261,6 +308,7 @@ def get_authorizations_by_currency_and_seller_id(
 
 @wrap_mpt_http_error
 def get_gc_price_list_by_currency(mpt_client, product_id, currency):
+    """Retrieve a GC price list by product ID and currency."""
     response = mpt_client.get(
         f"/catalog/price-lists?eq(product.id,{product_id})&eq(currency,{currency})"
     )
@@ -272,6 +320,7 @@ def get_gc_price_list_by_currency(mpt_client, product_id, currency):
 def get_listings_by_price_list_and_seller_and_authorization(
     mpt_client, product_id, price_list_id, seller_id, authorization_id
 ):
+    """Retrieve listings by price list, seller, and authorization."""
     response = mpt_client.get(
         f"/catalog/listings?eq(product.id,{product_id})&eq(priceList.id,{price_list_id})"
         f"&eq(seller.id,{seller_id})"
@@ -283,6 +332,7 @@ def get_listings_by_price_list_and_seller_and_authorization(
 
 @wrap_mpt_http_error
 def create_listing(mpt_client, listing):
+    """Create a new listing."""
     response = mpt_client.post(
         "/catalog/listings",
         json=listing,
@@ -293,6 +343,7 @@ def create_listing(mpt_client, listing):
 
 @wrap_mpt_http_error
 def create_agreement(mpt_client, agreement):
+    """Create a new agreement."""
     response = mpt_client.post(
         "/commerce/agreements",
         json=agreement,
@@ -303,6 +354,7 @@ def create_agreement(mpt_client, agreement):
 
 @wrap_mpt_http_error
 def create_agreement_subscription(mpt_client, subscription):
+    """Create a new agreement subscription."""
     response = mpt_client.post(
         "/commerce/subscriptions",
         json=subscription,
@@ -313,15 +365,15 @@ def create_agreement_subscription(mpt_client, subscription):
 
 @wrap_mpt_http_error
 def get_listing_by_id(mpt_client, listing_id):
+    """Retrieve a listing by ID."""
     response = mpt_client.get(f"/catalog/listings/{listing_id}")
     response.raise_for_status()
     return response.json()
 
 
 @wrap_mpt_http_error
-def get_agreement_subscription_by_external_id(
-    mpt_client, agreement_id, subscription_external_id
-):
+def get_agreement_subscription_by_external_id(mpt_client, agreement_id, subscription_external_id):
+    """Retrieve an agreement subscription by external ID."""
     response = mpt_client.get(
         f"/commerce/subscriptions?eq(externalIds.vendor,{subscription_external_id})"
         f"&eq(agreement.id,{agreement_id})"
@@ -336,6 +388,7 @@ def get_agreement_subscription_by_external_id(
 
 @wrap_mpt_http_error
 def get_agreements_by_external_id_values(mpt_client, external_id, display_values):
+    """Retrieve agreements by external ID and display values."""
     display_values_list = ",".join(display_values)
     rql_query = (
         f"any(parameters.fulfillment,and("
@@ -350,9 +403,8 @@ def get_agreements_by_external_id_values(mpt_client, external_id, display_values
 
 
 @wrap_mpt_http_error
-def get_agreements_by_customer_deployments(
-    mpt_client, deployment_id_parameter, deployment_ids
-):
+def get_agreements_by_customer_deployments(mpt_client, deployment_id_parameter, deployment_ids):
+    """Retrieve agreements by customer deployments."""
     deployments_list = ",".join(deployment_ids)
     rql_query = (
         f"any(parameters.fulfillment,and("
@@ -368,6 +420,7 @@ def get_agreements_by_customer_deployments(
 
 @wrap_mpt_http_error
 def get_buyer(mpt_client, buyer_id):
+    """Retrieve a buyer by ID."""
     response = mpt_client.get(f"/accounts/buyers/{buyer_id}")
     response.raise_for_status()
     return response.json()
@@ -384,6 +437,8 @@ def notify(
     limit: int = 1000,
 ) -> None:
     """
+    Sends notification to multiple recipients for a specific buyer.
+
     Sends notifications to multiple recipients in batches for a specific buyer and
     category through the MPTClient service. The function retrieves recipients,
     groups them into manageable batches, and sends notifications using the provided
@@ -414,9 +469,7 @@ def notify(
 
 
 @wrap_mpt_http_error
-def terminate_subscription(
-    mpt_client: MPTClient, subscription_id: str, reason: str
-) -> dict:
+def terminate_subscription(mpt_client: MPTClient, subscription_id: str, reason: str) -> dict:
     """
     Terminates a subscription by calling the MPT API.
 

mpt_extension_sdk/mpt_http/utils.py

@@ -1,2 +1,3 @@
 def find_first(func, iterable, default=None):
+    """Find the first item in an iterable that matches a predicate."""
     return next(filter(func, iterable), default)

mpt_extension_sdk/mpt_http/wrap_http_error.py

@@ -5,10 +5,11 @@ from requests import HTTPError, JSONDecodeError
 
 
 class MPTError(Exception):
-    pass
+    """Represents a generic MPT error."""
 
 
 class MPTHttpError(MPTError):
+    """Represents an HTTP error."""
     def __init__(self, status_code: int, content: str):
         self.status_code = status_code
         self.content = content
@@ -16,6 +17,7 @@ class MPTHttpError(MPTError):
 
 
 class MPTAPIError(MPTHttpError):
+    """Represents an API error."""
     def __init__(self, status_code, payload):
         super().__init__(status_code, json.dumps(payload))
         self.payload = payload
@@ -37,25 +39,30 @@ class MPTAPIError(MPTHttpError):
 
 
 def wrap_mpt_http_error(func):
+    """Wrap a function to catch MPT HTTP errors."""
     @wraps(func)
     def _wrapper(*args, **kwargs):
         try:
             return func(*args, **kwargs)
-        except HTTPError as e:
+        except HTTPError as err:
+            response = err.response
             try:
-                raise MPTAPIError(e.response.status_code, e.response.json())
+                payload = response.json()
             except JSONDecodeError:
-                raise MPTHttpError(e.response.status_code, e.response.content.decode())
+                raise MPTHttpError(response.status_code, response.content.decode()) from err
+            raise MPTAPIError(response.status_code, payload) from err
 
     return _wrapper
 
 
 class ValidationError:
-    def __init__(self, id, message):
-        self.id = id
+    """Represents a validation error."""
+    def __init__(self, err_id, message):
+        self.id = err_id
         self.message = message
 
     def to_dict(self, **kwargs):
+        """Convert the validation error to a dictionary."""
         return {
             "id": self.id,
             "message": self.message.format(**kwargs),

mpt_extension_sdk/runtime/__init__.py

@@ -7,4 +7,5 @@ except Exception:  # pragma: no cover
 
 
 def get_version():
+    """Get the current version of the package."""
     return __version__

mpt_extension_sdk/runtime/commands/django.py

@@ -19,9 +19,8 @@ from mpt_extension_sdk.runtime.utils import initialize_extension
 @click.argument("management_args", nargs=-1, type=click.UNPROCESSED)
 @click.pass_context
 def django(ctx, management_args):  # pragma: no cover
-    "Execute Django subcommands."
-
-    from django.conf import settings
+    """Execute Django subcommands."""
+    from django.conf import settings  # noqa: PLC0415
 
     options = {
         "group": DEFAULT_APP_CONFIG_GROUP,
@@ -40,4 +39,4 @@ def django(ctx, management_args):  # pragma: no cover
         tracer_context = nullcontext()
 
     with tracer_context:
-        execute_from_command_line(argv=[ctx.command_path] + list(management_args))
+        execute_from_command_line(argv=[ctx.command_path, *management_args])

mpt_extension_sdk/runtime/commands/run.py

@@ -19,13 +19,11 @@ from mpt_extension_sdk.runtime.master import Master
 def run(component, color, debug, reload, debug_py):
     """Run the extension.
 
-    \b
     COMPONENT is the the name of the component to run. Possible values:
         * all - run both API and Event Consumer threads (default)
         * api - run only API thread
         * consumer - run only Event Consumer thread
     """
-
     if debug_py:
         host, port = debug_py.split(":")
         debugpy.listen((host, int(port)))  # noqa

mpt_extension_sdk/runtime/djapp/apps.py

@@ -8,9 +8,11 @@ ext = Extension()
 
 
 class DjAppConfig(AppConfig):
+    """Django AppConfig for the extension."""
     name = "mpt_extension_sdk.runtime.djapp"
 
     def ready(self):
+        """Check if the extension is properly configured."""
         if not hasattr(settings, "MPT_PRODUCTS_IDS") or not settings.MPT_PRODUCTS_IDS:
             raise ImproperlyConfigured(
                 f"Extension {self.verbose_name} is not properly configured."
@@ -20,15 +22,17 @@ class DjAppConfig(AppConfig):
         self.extension_ready()
 
     def extension_ready(self):
-        pass
+        """Perform actions when the extension is ready."""
 
 
 class ExtensionConfig(DjAppConfig):
+    """Configuration for the extension."""
     name = "mpt_extension_sdk"
     verbose_name = "SWO Extension SDK"
     extension = ext
 
     def extension_ready(self):
+        """Perform actions when the extension is ready."""
         error_msgs = []
 
         for product_id in settings.MPT_PRODUCTS_IDS:

mpt_extension_sdk/runtime/djapp/conf/__init__.py

@@ -2,11 +2,10 @@ from typing import Any
 
 
 def extract_product_ids(product_ids: str) -> list[str]:
+    """Extract product IDs from a comma-separated string."""
     return product_ids.split(",")
 
 
 def get_for_product(settings, variable_name: str, product_id: str) -> Any:
-    """
-    A shortcut to return product scoped variable from the extension settings.
-    """
+    """A shortcut to return product scoped variable from the extension settings."""
     return settings.EXTENSION_CONFIG[variable_name][product_id]

mpt_extension_sdk/runtime/djapp/conf/default.py

@@ -14,9 +14,9 @@ import os
 from pathlib import Path
 
 from azure.monitor.opentelemetry.exporter import AzureMonitorLogExporter
-from opentelemetry._logs import set_logger_provider
-from opentelemetry.sdk._logs import LoggerProvider
-from opentelemetry.sdk._logs.export import BatchLogRecordProcessor
+from opentelemetry._logs import set_logger_provider  # noqa: PLC2701
+from opentelemetry.sdk._logs import LoggerProvider  # noqa: PLC2701
+from opentelemetry.sdk._logs.export import BatchLogRecordProcessor  # noqa: PLC2701
 
 # Build paths inside the project like this: BASE_DIR / 'subdir'.
 BASE_DIR = Path(__file__).resolve().parent.parent
@@ -34,12 +34,12 @@ SECRET_KEY = os.getenv(
 # SECURITY WARNING: don't run with debug turned on in production!
 DEBUG = True
 
-ALLOWED_HOSTS = ["*"]
+ALLOWED_HOSTS = ("*")
 
 
 # Application definition
 
-INSTALLED_APPS = [
+INSTALLED_APPS = (
     "django.contrib.admin",
     "django.contrib.auth",
     "django.contrib.contenttypes",
@@ -47,9 +47,9 @@ INSTALLED_APPS = [
     "django.contrib.messages",
     "django.contrib.staticfiles",
     "mpt_extension_sdk.runtime.djapp.apps.DjAppConfig",
-]
+)
 
-MIDDLEWARE = [
+MIDDLEWARE = (
     "django.middleware.security.SecurityMiddleware",
     "django.contrib.sessions.middleware.SessionMiddleware",
     "django.middleware.common.CommonMiddleware",
@@ -58,7 +58,7 @@ MIDDLEWARE = [
     "django.contrib.messages.middleware.MessageMiddleware",
     "django.middleware.clickjacking.XFrameOptionsMiddleware",
     "mpt_extension_sdk.runtime.djapp.middleware.MPTClientMiddleware",
-]
+)
 
 ROOT_URLCONF = "mpt_extension_sdk.runtime.djapp.conf.urls"
 
@@ -130,7 +130,7 @@ DEFAULT_AUTO_FIELD = "django.db.models.BigAutoField"
 APPLICATIONINSIGHTS_CONNECTION_STRING = os.getenv(
     "APPLICATIONINSIGHTS_CONNECTION_STRING", ""
 )
-USE_APPLICATIONINSIGHTS = APPLICATIONINSIGHTS_CONNECTION_STRING != ""
+USE_APPLICATIONINSIGHTS = bool(APPLICATIONINSIGHTS_CONNECTION_STRING)
 
 
 if USE_APPLICATIONINSIGHTS:  # pragma: no cover
@@ -166,7 +166,7 @@ LOGGING = {
         "rich": {
             "class": "mpt_extension_sdk.runtime.logging.RichHandler",
             "formatter": "rich",
-            "log_time_format": lambda x: x.strftime("%Y-%m-%d %H:%M:%S.%f")[:-3],
+            "log_time_format": lambda log_time: log_time.strftime("%Y-%m-%d %H:%M:%S.%f")[:-3],
             "rich_tracebacks": True,
         },
         "opentelemetry": {

mpt_extension_sdk/runtime/djapp/management/commands/consume_events.py

@@ -1,5 +1,6 @@
 import signal  # pragma: no cover
 from threading import Event  # pragma: no cover
+from typing import ClassVar  # pragma: no cover
 
 from django.core.management.base import BaseCommand  # pragma: no cover
 
@@ -11,22 +12,21 @@ from mpt_extension_sdk.runtime.events.producers import (
 
 
 class Command(BaseCommand):  # pragma: no cover
+    """Command to consume events."""
     help = CONSUME_EVENTS_HELP_TEXT
-    producer_classes = [
+    producer_classes: ClassVar[list] = [
         OrderEventProducer,
     ]
-    producers = []
+    producers: ClassVar[list] = []
 
     def handle(self, *args, **options):
+        """Handle the command."""
         self.shutdown_event = Event()
         self.dispatcher = Dispatcher()
         self.dispatcher.start()
 
-        def shutdown(signum, frame):
-            self.shutdown_event.set()
-
-        signal.signal(signal.SIGTERM, shutdown)
-        signal.signal(signal.SIGINT, shutdown)
+        signal.signal(signal.SIGTERM, self.shutdown)
+        signal.signal(signal.SIGINT, self.shutdown)
         for producer_cls in self.producer_classes:
             producer = producer_cls(self.dispatcher)
             self.producers.append(producer)
@@ -36,3 +36,7 @@ class Command(BaseCommand):  # pragma: no cover
         for producer in self.producers:
             producer.stop()
         self.dispatcher.stop()
+
+    def shutdown(self, signum, frame):
+        """Shutdown the command."""
+        self.shutdown_event.set()

mpt_extension_sdk/runtime/djapp/middleware.py

@@ -6,16 +6,17 @@ _CLIENT = None
 
 
 class MPTClientMiddleware:  # pragma: no cover
+    """Middleware to set up MPTClient for each request."""
     def __init__(self, get_response):
         self.get_response = get_response
 
     def __call__(self, request):
-        global _CLIENT
+        """Set up MPTClient for the request."""
+        global _CLIENT  # noqa: PLW0603
         if not _CLIENT:
             _CLIENT = MPTClient(
                 f"{settings.MPT_API_BASE_URL}/v1/",
                 settings.MPT_API_TOKEN,
             )
         request.client = _CLIENT
-        response = self.get_response(request)
-        return response
+        return self.get_response(request)

mpt_extension_sdk/runtime/errors.py

@@ -0,0 +1,4 @@
+# Custom exception for variable format errors
+
+class VariableNotWellFormedError(Exception):
+    """Raised when a variable is not well-formed."""