wbcore 1.54.10__py2.py3-none-any.whl → 1.58.2__py2.py3-none-any.whl

wbcore/test/e2e_helpers_methods/e2e_checks.py

@@ -2,7 +2,7 @@ from selenium.common.exceptions import TimeoutException
 from selenium.webdriver.common.by import By
 from selenium.webdriver.remote.webdriver import WebDriver
 from selenium.webdriver.remote.webelement import WebElement
-from selenium.webdriver.support import expected_conditions as EC
+from selenium.webdriver.support import expected_conditions
 from selenium.webdriver.support.color import Color
 from selenium.webdriver.support.wait import WebDriverWait
 
@@ -49,7 +49,9 @@ def is_string_not_visible(driver: WebDriver, string: str) -> bool:
         bool: True if the text is not visible
     """
     try:
-        WebDriverWait(driver, 5).until(EC.invisibility_of_element_located((By.XPATH, f"//*[text()='{string}']")))
+        WebDriverWait(driver, 5).until(
+            expected_conditions.invisibility_of_element_located((By.XPATH, f"//*[text()='{string}']"))
+        )
         return True
     except TimeoutException:
         return False
@@ -82,7 +84,9 @@ def is_tag_not_visible(driver: WebDriver, tag_label: str) -> bool:
     """
     try:
         WebDriverWait(driver, 2.5).until(
-            EC.invisibility_of_element_located((By.XPATH, f"//*[@class='tag-label' and text()='{tag_label}']"))
+            expected_conditions.invisibility_of_element_located(
+                (By.XPATH, f"//*[@class='tag-label' and text()='{tag_label}']")
+            )
         )
         return True
     except TimeoutException:
@@ -103,7 +107,9 @@ def is_error_visible(driver: WebDriver):
 
     if saving_failed_hint and saving_failed_hint.is_displayed():
         WebDriverWait(driver, 10).until_not(
-            EC.invisibility_of_element_located((By.XPATH, "//div[contains(@class, 'task-dropper-content')]"))
+            expected_conditions.invisibility_of_element_located(
+                (By.XPATH, "//div[contains(@class, 'task-dropper-content')]")
+            )
         )
     return error_element is not None
 

wbcore/test/e2e_helpers_methods/e2e_helper_methods.py

@@ -4,7 +4,7 @@ from selenium.webdriver.common.action_chains import ActionChains
 from selenium.webdriver.common.by import By
 from selenium.webdriver.remote.webdriver import WebDriver
 from selenium.webdriver.remote.webelement import WebElement
-from selenium.webdriver.support import expected_conditions as EC
+from selenium.webdriver.support import expected_conditions
 from selenium.webdriver.support.wait import WebDriverWait
 from wbcore import serializers as wb_serializers
 
@@ -157,7 +157,9 @@ def click_element_by_path(driver: WebDriver, xpath: str, wait_sec=WAIT_TIME_SEC)
         xpath (str): The xpath leading to the element.
     """
     try:
-        WebDriverWait(driver, wait_sec).until(EC.presence_of_element_located((By.XPATH, xpath))).click()
+        WebDriverWait(driver, wait_sec).until(
+            expected_conditions.presence_of_element_located((By.XPATH, xpath))
+        ).click()
     except TimeoutException:
         return []
 

wbcore/test/mixins.py

@@ -173,7 +173,7 @@ class ParentViewset:
             else get_model_factory(self.model)
         )
 
-    def _get_mixins_data(self, type="GET", dump_data=False, data=None):
+    def _get_mixins_data(self, type="GET", dump_data=False, data=None):  # noqa: C901
         api_request = APIRequestFactory()
         superuser = get_or_create_superuser()
         kwargs = None

wbcore/test/tests.py

@@ -1,7 +1,6 @@
 import pytest
 from django.conf import settings
 from django.db import models
-from django.urls import get_resolver
 
 from wbcore import serializers, viewsets
 from wbcore.pandas.views import PandasAPIViewSet
@@ -24,8 +23,6 @@ This is useful mainly when running tests, or running locally without Celery work
 """
 settings.CELERY_TASK_ALWAYS_EAGER = True
 
-get_resolver().url_patterns
-
 
 def modules_condition(module):
     return not module.startswith(("wbcore", "django", "rest_framework", "dynamic_preferences", "eventtools")) or (
@@ -122,11 +119,11 @@ class GenerateTest:
         def _test_chartviewsets(_self, cvs):
             self.test_chartviewsets(cvs)
 
-        setattr(test_class, "test_models", _test_models)
-        setattr(test_class, "test_serializers", _test_serializers)
-        setattr(test_class, "test_representationviewsets", _test_representationviewsets)
-        setattr(test_class, "test_modelviewsets", _test_modelviewsets)
-        setattr(test_class, "test_pandasviews", _test_pandasviews)
-        setattr(test_class, "test_chartviewsets", _test_chartviewsets)
+        test_class.test_models = _test_models
+        test_class.test_serializers = _test_serializers
+        test_class.test_representationviewsets = _test_representationviewsets
+        test_class.test_modelviewsets = _test_modelviewsets
+        test_class.test_pandasviews = _test_pandasviews
+        test_class.test_chartviewsets = _test_chartviewsets
 
         return test_class

wbcore/test/utils.py

@@ -1,5 +1,6 @@
 import datetime
 import json
+from contextlib import suppress
 from functools import partial
 from typing import Any, Dict
 
@@ -44,7 +45,7 @@ def get_model_factory(model):
             return mfs[0]
 
 
-def get_data_from_factory(instance, viewset, delete=False, update=False, superuser=None, factory=None):
+def get_data_from_factory(instance, viewset, delete=False, update=False, superuser=None, factory=None):  # noqa: C901
     """
     Our goal here is to get the serializer dynamically based on the viewset, use this serializer to generate data for the post and update test.
     """
@@ -113,14 +114,12 @@ def get_data_from_factory(instance, viewset, delete=False, update=False, superus
                     and _field.many_to_one
                     and (_related_fields := _field.related_fields)
                 ):
-                    try:
+                    with suppress(Exception):
                         lh_field, rh_field = _related_fields[0]
                         if isinstance(lh_field, models.fields.AutoField) or isinstance(
                             rh_field, models.fields.AutoField
                         ):
                             data[key] = get_model_factory(dict_fields_models[key].related_model).id
-                    except Exception:
-                        pass
     if update or delete:
         _kwargs = {"user": superuser, "obj_factory": obj_factory}
         if delete:

wbcore/tests/e2e/test_e2e.py

@@ -11,14 +11,14 @@ USER_PASSWORD = "User_Password"
 @pytest.mark.django_db
 class TestE2ELogin:
     def test_login_success(self, live_server, selenium):
-        user: User = SuperUserFactory(plaintext_password=USER_PASSWORD)
+        user: User = SuperUserFactory(plaintext_password=USER_PASSWORD)  # noqa
         selenium.get(live_server.url)
         assert not find_element(selenium, "//div[contains(@class, 'sidebar')]")
         login(selenium, user.email, USER_PASSWORD)
         assert find_element(selenium, "//div[contains(@class, 'sidebar')]")
 
     def test_login_failure(self, live_server, selenium):
-        user: User = SuperUserFactory(plaintext_password=USER_PASSWORD)
+        user: User = SuperUserFactory(plaintext_password=USER_PASSWORD)  # noqa
         selenium.get(live_server.url)
         assert not find_element(selenium, "//p[@type='error']")
         login(selenium, user.email + "Wrong Name", USER_PASSWORD)

wbcore/tests/test_cache/test_decorators.py

@@ -19,9 +19,9 @@ def test_cache_table(timeout, key_prefix, periodic_caching_view_kwargs, periodic
     class CacheTable:
         pass
 
-    assert getattr(CacheTable, "CACHE_ENABLED") is True
-    assert getattr(CacheTable, "CACHE_TIMEOUT") == timeout
-    assert getattr(CacheTable, "CACHE_KEY_PREFIX") == key_prefix
+    assert CacheTable.CACHE_ENABLED is True
+    assert CacheTable.CACHE_TIMEOUT == timeout
+    assert CacheTable.CACHE_KEY_PREFIX == key_prefix
     cache_entry = periodic_cache_registry.classes[0]
     assert cache_entry.view_class == CacheTable
     assert cache_entry.view_kwargs == periodic_caching_view_kwargs

wbcore/tests/test_configs.py

@@ -52,7 +52,7 @@ def test_config_registry_decorator():
 
     assert not hasattr(some_callable, "_is_config")
     some_callable = register_config(some_callable)
-    assert getattr(some_callable, "_is_config")
+    assert some_callable._is_config
 
 
 def test_config_view(rf):

wbcore/tests/test_fields/test_number_fields.py

@@ -163,4 +163,4 @@ class TestYearField:
         field = YearField(label=label, precision=2)
         representation = field.get_representation(None, key)[1]
         assert representation["precision"] == 0
-        assert representation["disable_formatting"] == True
+        assert representation["disable_formatting"]

wbcore/tests/test_filters/test_mixins.py

@@ -97,13 +97,13 @@ class TestWBCoreFilterMixin:
         class Field:
             help_text = text
 
-        class dummy_parent:
-            class _meta:
+        class DummyParent:
+            class _meta:  # noqa
                 model = "tmp"
 
         mock_fct.return_value = Field
 
         filter_field = CharFilter(field_name=name, initial=initial, help_text=None)
-        filter_field.parent = dummy_parent()
+        filter_field.parent = DummyParent()
         request = rf.get("")
         assert filter_field.get_representation(request, name, view)[0]["help_text"] == text

wbcore/tests/test_models/test_mixins.py

@@ -3,7 +3,7 @@ from django.db import models
 from wbcore.models.orderable import OrderableModel
 
 
-class ForeignKeyClass(models.Model):
+class ForeignKeyClass(models.Model):  # noqa
     @classmethod
     def get_endpoint_basename(cls) -> str:
         return "wbcore:foreignkeyclass"

wbcore/tests/test_utils/test_date.py

@@ -4,7 +4,7 @@ import pytest
 from rest_framework.test import APIRequestFactory
 
 from wbcore.utils.date import get_date_interval_from_request, shortcut
-from wbcore.utils.date_builder import *
+from wbcore.utils.date_builder import Day, Now, WeekStart
 
 
 class TestGetDateInterval:

wbcore/tests/test_utils/test_date_builder.py

@@ -3,7 +3,31 @@ from operator import add, sub
 
 import pytest
 
-from wbcore.utils.date_builder import *
+from wbcore.utils.date_builder import (
+    BusinessDay,
+    Day,
+    Hour,
+    HourEnd,
+    HourStart,
+    Minute,
+    MinuteEnd,
+    MinuteStart,
+    Month,
+    MonthEnd,
+    MonthStart,
+    Quarter,
+    QuarterEnd,
+    QuarterStart,
+    Second,
+    SecondEnd,
+    SecondStart,
+    Week,
+    WeekEnd,
+    WeekStart,
+    Year,
+    YearEnd,
+    YearStart,
+)
 
 
 class TestDateBuilder:

wbcore/utils/date.py

@@ -1,5 +1,6 @@
 from collections import defaultdict
-from datetime import date, datetime, time, timedelta
+from datetime import date, datetime, time, timedelta, timezone
+from zoneinfo import ZoneInfo, available_timezones
 
 from dateutil import rrule
 from django.utils.dateparse import parse_date
@@ -153,8 +154,11 @@ def get_date_interval_from_request(
 
 
 def get_number_of_hours_between_dates(
-    d1, d2, skip_weekends=True, list_public_holidays=False, hours_range=range(0, 23), granularity=12
+    d1, d2, skip_weekends=True, list_public_holidays=False, hours_range=None, granularity=12
 ):
+    if hours_range is None:
+        hours_range = range(0, 23)
+
     def convert_days_from_hours(hours, granularity, hours_per_day):
         return int(hours / granularity) * granularity / hours_per_day
 
@@ -219,3 +223,15 @@ def get_next_day_timedelta(now: datetime | None = None) -> int:
     if not now:
         now = datetime.now()
     return (datetime.combine(now.date() + timedelta(days=1), time(0, 0, 0)) - now).seconds
+
+
+def get_timezone_choices() -> list[tuple[str, str]]:
+    now_utc = datetime.now(timezone.utc)
+    tz_tuples = []  # a list of (timezone_name, timezone_name (UTC offset))
+    for tz_name in sorted(available_timezones()):
+        tz = ZoneInfo(tz_name)
+        now_in_tz = now_utc.astimezone(tz)
+        offset_str = now_in_tz.strftime("UTC%z")  # gives UTC+HHMM
+        offset_str = offset_str[:-2] + ":" + offset_str[-2:]
+        tz_tuples.append((tz_name, f"{tz_name} ({offset_str})"))
+    return tz_tuples

wbcore/utils/figures.py

@@ -183,7 +183,7 @@ def get_horizontal_barplot(
     df,
     x_label="weighting",
     y_label="aggregated_title",
-    colors=["#B4DAFF"],
+    colors: tuple[str, ...] = ("#B4DAFF",),
     colors_label=None,
     drop_null_x_value: bool = True,
 ):
@@ -204,7 +204,7 @@ def get_horizontal_barplot(
     if colors_label:
         colors = df[colors_label]
     opacity = 1
-    for i, label in enumerate(x_label):
+    for label in x_label:
         data.append(
             go.Bar(
                 name=label,

wbcore/utils/models.py

@@ -107,7 +107,7 @@ class Status(ChoiceEnum):
     @classmethod
     def get_color_map(cls):
         colors = [WBColor.YELLOW_LIGHT.value, WBColor.RED_LIGHT.value, WBColor.GREEN_LIGHT.value]
-        return [choice for choice in zip(cls, colors)]
+        return [choice for choice in zip(cls, colors, strict=False)]
 
 
 class PrimaryMixin(models.Model):
@@ -273,7 +273,8 @@ class ResolvableModelMixin(models.Model):
     resolved = models.BooleanField(default=False, verbose_name="Resolved")
 
     def delete(self, *args, **kwargs):
-        assert not self.resolved, "Resolved Entities cannot be deleted."
+        if self.resolved:
+            raise ValueError("Resolved Entities cannot be deleted.")
         super().delete(*args, **kwargs)
 
 

wbcore/utils/reportlab.py

@@ -0,0 +1,7 @@
+from reportlab.platypus import Paragraph as BaseParagraph
+
+
+class FormattedParagraph(BaseParagraph):
+    def __init__(self, text, *args, **kwargs):
+        text = text.replace("<br>", "<br/>")  # convert the HTML line break into a compatible XML line break tag
+        super().__init__(text, *args, **kwargs)

wbcore/utils/rrules.py

@@ -48,7 +48,7 @@ def humanize_rrule(rrule_str: rrule) -> str:
     Returns:
         A humanized version of the rrule
     """
-    if not rrule_str._freq:
+    if rrule_str._freq is None:
         raise ValueError("We do no support humanization of rrule without frequency yet")
     text = "Every "
     freq = rrule.FREQNAMES[rrule_str._freq]

wbcore/utils/string_loader.py

@@ -21,7 +21,7 @@ class StringSourceLoader(importlib.abc.SourceLoader):
 
     def exec_module(self, module):
         code = self.source_to_code(self.data, self.get_filename(module.__name__))
-        exec(code, module.__dict__)
+        exec(code, module.__dict__)  # noqa: S102
 
     def get_spec(self):
         return importlib.machinery.ModuleSpec(self.MOD_NAME, self, origin=self.get_filename(self.MOD_NAME))

wbcore/utils/strings.py

@@ -15,7 +15,7 @@ def enumerated_string_join(array):
     return ""
 
 
-def format_number(number, decimal: int = 2, **kwargs) -> float | None:
+def format_number(number, decimal: int = 2, **kwargs) -> float | str:
     """
     utility function used to serialize an aggregate to a json compatible value
     Args:
@@ -28,7 +28,7 @@ def format_number(number, decimal: int = 2, **kwargs) -> float | None:
     try:
         return float(round(number, decimal))
     except TypeError:
-        return None
+        return ""
 
 
 class ReferenceIDMixin:

wbcore/viewsets/mixins.py

@@ -66,7 +66,9 @@ class WBCoreOrderingFilter(OrderingFilter):
 
         return queryset
 
-    def get_valid_fields(self, queryset, view, context={}):
+    def get_valid_fields(self, queryset, view, context: dict | None = None):
+        if context is None:
+            context = {}
         valid_fields = view.get_ordering_fields()
         if valid_fields is None:
             # Default to allowing filtering on serializer fields
@@ -90,9 +92,9 @@ class FilterMixin:
 
 class DocumentationMixin:
     def _get_documentation_url(self, detail):
-        INSTANCE_DOCUMENTATION = getattr(self, "INSTANCE_DOCUMENTATION", None)
-        LIST_DOCUMENTATION = getattr(self, "LIST_DOCUMENTATION", None)
-        doc = INSTANCE_DOCUMENTATION if detail else LIST_DOCUMENTATION
+        instance_documentation = getattr(self, "INSTANCE_DOCUMENTATION", None)
+        list_documentation = getattr(self, "LIST_DOCUMENTATION", None)
+        doc = instance_documentation if detail else list_documentation
 
         if doc and finders.find(doc):
             return static(doc)

{wbcore-1.54.10.dist-info → wbcore-1.58.2.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: wbcore
-Version: 1.54.10
+Version: 1.58.2
 Author-email: Christopher Wittlinger <c.wittlinger@stainly.com>
 Requires-Dist: boto3==1.35.*
 Requires-Dist: celery[redis]==5.*
@@ -35,6 +35,7 @@ Requires-Dist: fabric==3.2.*
 Requires-Dist: faker==25.*
 Requires-Dist: firebase-admin==6.*
 Requires-Dist: graphviz==0.*
+Requires-Dist: humanize==4.*
 Requires-Dist: ics==0.*
 Requires-Dist: igraph==0.*
 Requires-Dist: inscriptis==1.*