edx-enterprise-data 7.0.0__py3-none-any.whl → 8.2.0__py3-none-any.whl

enterprise_data/utils.py

@@ -1,9 +1,14 @@
 """
 Utility functions for Enterprise Data app.
 """
-
 import hashlib
 import random
+import time
+from datetime import timedelta
+from functools import wraps
+from logging import getLogger
+
+LOGGER = getLogger(__name__)
 
 
 def get_cache_key(**kwargs):
@@ -35,3 +40,45 @@ def get_unique_id():
     Return a unique 32 bit integer.
     """
     return random.getrandbits(32)
+
+
+def subtract_one_month(original_date):
+    """
+    Return a date exactly one month prior to the passed in date.
+    """
+    one_day = timedelta(days=1)
+    one_month_earlier = original_date - one_day
+    while one_month_earlier.month == original_date.month or one_month_earlier.day > original_date.day:
+        one_month_earlier -= one_day
+    return one_month_earlier
+
+
+def timeit(func):
+    """
+    Measure time taken by a function.
+    """
+    @wraps(func)
+    def wrapper(*args, **kwargs):
+        start = time.time()
+        result = func(*args, **kwargs)
+        end = time.time()
+        LOGGER.info(f'Time taken by {func.__name__}: {end - start} seconds')
+        return result
+
+    return wrapper
+
+
+def date_filter(start, end, data_frame, date_column):
+    """
+    Filter a pandas DataFrame by date range.
+
+    Arguments:
+        start (DatetimeScalar | NaTType | None): The start date.
+        end (DatetimeScalar | NaTType | None): The end date.
+        data_frame (pandas.DataFrame): The DataFrame to filter.
+        date_column (str): The name of the date column.
+
+    Returns:
+        (pandas.DataFrame): The filtered DataFrame.
+    """
+    return data_frame[(start <= data_frame[date_column]) & (data_frame[date_column] <= end)]

enterprise_reporting/clients/__init__.py

@@ -2,18 +2,17 @@
 Clients used to access third party systems.
 """
 
+import logging
 import os
 from datetime import datetime, timedelta
 from functools import wraps
 from urllib.parse import parse_qs, urljoin, urlparse
-from edx_rest_api_client.client import get_oauth_access_token
 
-import logging
 import requests
+from edx_rest_api_client.client import get_oauth_access_token
 
 from enterprise_reporting.utils import retry_on_exception
 
-
 LOGGER = logging.getLogger(__name__)
 
 

enterprise_reporting/external_resource_link_report.py

@@ -3,13 +3,13 @@ External Resource Link Report Generation Code.
 """
 
 
-from collections import Counter
-from datetime import date
-import operator
 import logging
+import operator
 import os
 import re
 import sys
+from collections import Counter
+from datetime import date
 from urllib.parse import urlparse
 
 from py2neo import Graph

enterprise_reporting/tests/test_clients.py

@@ -1,9 +1,9 @@
 """
 Tests for clients in enterprise_reporting.
 """
+from datetime import datetime, timedelta
 from unittest.mock import Mock, patch
 from urllib.parse import urljoin
-from datetime import datetime, timedelta
 
 import responses
 

enterprise_reporting/tests/test_enterprise_client.py

@@ -2,14 +2,11 @@
 Test Enterprise client.
 """
 
+import json
 import os
 import unittest
 
-import json
-
-from enterprise_reporting.utils import (
-    extract_catalog_uuids_from_reporting_config,
-)
+from enterprise_reporting.utils import extract_catalog_uuids_from_reporting_config
 
 REPO_DIR = os.getcwd()
 FIXTURE_DIR = os.path.join(REPO_DIR, 'enterprise_reporting/fixtures')

enterprise_reporting/tests/test_external_link_report.py

@@ -2,13 +2,13 @@
 Test utils for external link reports.
 """
 
-from collections import OrderedDict
 import unittest
+from collections import OrderedDict
 
 from enterprise_reporting.external_resource_link_report import (
     AGGREGATE_REPORT_CSV_HEADER_ROW,
-    create_csv_string,
     create_columns_for_aggregate_report,
+    create_csv_string,
     process_coursegraph_results,
     split_up_results,
 )

enterprise_reporting/tests/test_utils.py

@@ -3,12 +3,15 @@ Test utilities.
 """
 
 
+import datetime
 import os
 import tempfile
 import unittest
 from collections import OrderedDict
+
 import ddt
 import pgpy
+import pytz
 from pgpy.constants import CompressionAlgorithm, HashAlgorithm, KeyFlags, PubKeyAlgorithm, SymmetricKeyAlgorithm
 from pgpy.errors import PGPError
 
@@ -16,9 +19,6 @@ from enterprise_reporting import utils
 
 from .utils import create_files, verify_compressed
 
-import pytz
-import datetime
-
 
 @ddt.ddt
 class TestUtilities(unittest.TestCase):

enterprise_reporting/utils.py

@@ -11,6 +11,7 @@ from collections import OrderedDict
 from email.mime.application import MIMEApplication
 from email.mime.multipart import MIMEMultipart
 from email.mime.text import MIMEText
+from urllib.parse import parse_qs, urlparse
 
 import boto3
 import pgpy
@@ -18,7 +19,6 @@ import pyminizip
 import pytz
 from cryptography.fernet import Fernet
 from fernet_fields.hkdf import derive_fernet_key
-from urllib.parse import parse_qs, urlparse
 
 from django.utils.encoding import force_str