Use importlib to get sidekick version

praekeltfoundation · Oct 8, 2024 · bb3e03b · bb3e03b
1 parent 3142569
commit bb3e03b
Show file tree

Hide file tree

Showing 5 changed files with 12 additions and 19 deletions.
diff --git a/rp_transferto/models.py b/rp_transferto/models.py
@@ -1,7 +1,6 @@
+import importlib.metadata
 import json
 
-import pkg_resources
-import importlib.metadata
 from django.db import models
 from django.db.models import JSONField
 from django.utils import timezone

diff --git a/rp_transferto/tasks.py b/rp_transferto/tasks.py
@@ -1,6 +1,6 @@
+import importlib.metadata
 import json
 
-import pkg_resources
 from celery.utils.log import get_task_logger
 from django.conf import settings
 from django.core.exceptions import ObjectDoesNotExist
@@ -131,7 +131,7 @@ def buy_product_take_action(
  log.info(
  json.dumps(
  dict(
- sidekick_version=pkg_resources.get_distribution("rp-sidekick").version,
+ sidekick_version=importlib.metadata.version("rp-sidekick"),
  name=name,
  org_id=org_id,
  msisdn=msisdn,

diff --git a/rp_transferto/tests/test_models.py b/rp_transferto/tests/test_models.py
@@ -1,7 +1,7 @@
+import importlib.metadata
 import json
 from unittest.mock import patch
 
-import pkg_resources
 from django.test import TestCase
 from freezegun import freeze_time
 
@@ -29,9 +29,7 @@ def test_string_1(self):
  json.loads(topup_attempt.__str__()),
  {
  "id": topup_attempt.id,
- "sidekick_version": pkg_resources.get_distribution(
- "rp-sidekick"
- ).version,
+ "sidekick_version": importlib.metadata.version("rp-sidekick"),
  "msisdn": clean_msisdn(msisdn),
  "from_string": "",
  "amount": airtime_amount,
@@ -62,9 +60,7 @@ def test_string_2(self):
  json.loads(topup_attempt.__str__()),
  {
  "id": topup_attempt.id,
- "sidekick_version": pkg_resources.get_distribution(
- "rp-sidekick"
- ).version,
+ "sidekick_version": importlib.metadata.version("rp-sidekick"),
  "msisdn": clean_msisdn(msisdn),
  "from_string": from_string,
  "amount": airtime_amount,

diff --git a/sidekick/tests/test_utils.py b/sidekick/tests/test_utils.py
@@ -1,7 +1,7 @@
+import importlib.metadata
 import json
 from unittest.mock import Mock, patch
 
-import pkg_resources
 import responses
 from django.test import TestCase
 from django.utils import timezone
@@ -33,14 +33,12 @@ def test_clean_message_punctuation(self):
  )
 
  def test_build_turn_headers(self):
- distribution = pkg_resources.get_distribution("rp-sidekick")
+ version = importlib.metadata.version("rp-sidekick")
 
  headers = utils.build_turn_headers("FAKE_TOKEN")
 
  self.assertEqual(headers["Authorization"], "Bearer FAKE_TOKEN")
- self.assertEqual(
- headers["User-Agent"], "rp-sidekick/{}".format(distribution.version)
- )
+ self.assertEqual(headers["User-Agent"], "rp-sidekick/{}".format(version))
  self.assertEqual(headers["Content-Type"], "application/json")
 
  @responses.activate

diff --git a/sidekick/utils.py b/sidekick/utils.py
@@ -1,7 +1,7 @@
+import importlib.metadata
 import json
 from urllib.parse import urljoin
 
-import pkg_resources
 import requests
 from django.utils import timezone
 from requests.adapters import HTTPAdapter
@@ -33,10 +33,10 @@ def clean_msisdn(msisdn):
 
 
 def build_turn_headers(token, api_extensions=False):
- distribution = pkg_resources.get_distribution("rp-sidekick")
+ version = importlib.metadata.version("rp-sidekick")
  headers = {
  "Authorization": "Bearer {}".format(token),
- "User-Agent": "rp-sidekick/{}".format(distribution.version),
+ "User-Agent": "rp-sidekick/{}".format(version),
  "Content-Type": "application/json",
  }
  if api_extensions: