wbreport 2.2.1__py2.py3-none-any.whl

wbreport/dynamic_preferences_registry.py

@@ -0,0 +1,15 @@
+from dynamic_preferences.preferences import Section
+from dynamic_preferences.registries import global_preferences_registry
+from dynamic_preferences.types import IntegerPreference
+
+report_section = Section("report")
+
+
+@global_preferences_registry.register
+class ReportMailTemplateIdPreference(IntegerPreference):
+    section = report_section
+    name = "report_mail_template_id"
+    default = -1
+
+    verbose_name = "Report Mail Template ID"
+    help_text = "The Template ID used to send the report by email"

wbreport/factories/__init__.py

@@ -0,0 +1,8 @@
+from .reports import (
+    ParentReportFactory,
+    ReportAssetFactory,
+    ReportCategoryFactory,
+    ReportClassFactory,
+    ReportFactory,
+    ReportVersionFactory,
+)

wbreport/factories/data_classes.py

@@ -0,0 +1,48 @@
+import datetime as dt
+from io import BytesIO
+
+from django.template import Context, Template
+from wbreport.mixins import ReportMixin
+
+
+class ReportClass(ReportMixin):
+    HTML_TEMPLATE_CONTENT = "<p>{{ title }}</p>"
+
+    @classmethod
+    def parse_parameters(cls, parameters):
+        return {
+            "iteration": parameters["iteration"],
+            "end": dt.datetime.strptime(parameters["end"], "%Y-%m-%d"),
+        }
+
+    @classmethod
+    def get_next_parameters(cls, parameters):
+        parameters = cls.parse_parameters(parameters=parameters)
+        return {
+            "iteration": parameters["iteration"] + 1,
+            "end": dt.datetime.strftime(parameters["end"] + dt.timedelta(days=1), "%Y-%m-%d"),
+        }
+
+    @classmethod
+    def get_version_title(cls, report_title, parameters=None):
+        return f'{report_title}-{parameters.get("iteration", "")}'
+
+    @classmethod
+    def get_version_date(cls, parameters):
+        return parameters.get("end", None)
+
+    @classmethod
+    def get_context(cls, version):
+        if not version.parameters:
+            raise ValueError("Parameters needs to be defined")
+        return {"title": version.title}
+
+    @classmethod
+    def generate_html(cls, context) -> str:
+        template = Template(cls.HTML_TEMPLATE_CONTENT)
+        return template.render(Context(context))
+
+    @classmethod
+    def generate_file(cls, context) -> BytesIO:
+        output = BytesIO(context["title"].encode("utf_8"))
+        return output

wbreport/factories/reports.py

@@ -0,0 +1,79 @@
+from io import BytesIO
+
+import factory
+from PIL import Image
+from wbcore.contrib.color.factories import ColorGradientFactory
+from wbreport.models import (
+    Report,
+    ReportAsset,
+    ReportCategory,
+    ReportClass,
+    ReportVersion,
+)
+
+
+def create_test_image():
+    file = BytesIO()
+    image = Image.new("RGBA", size=(50, 50), color=(155, 0, 0))
+    image.save(file, "png")
+    file.name = "test.png"
+    file.seek(0)
+    return file
+
+
+class ReportAssetFactory(factory.django.DjangoModelFactory):
+    class Meta:
+        model = ReportAsset
+
+    key = factory.Sequence(lambda n: f"Report Asset {n}")
+    description = factory.Faker("paragraph")
+    text = factory.Faker("paragraph")
+    asset = factory.django.ImageField()
+
+
+class ReportCategoryFactory(factory.django.DjangoModelFactory):
+    class Meta:
+        model = ReportCategory
+
+    title = factory.Sequence(lambda n: f"Report Category {n}")
+
+
+class ReportClassFactory(factory.django.DjangoModelFactory):
+    class Meta:
+        model = ReportClass
+
+    title = factory.Sequence(lambda n: f"Report Class {n}")
+    class_path = "wbreport.factories.data_classes"
+
+
+class ReportFactory(factory.django.DjangoModelFactory):
+    class Meta:
+        model = Report
+
+    category = factory.SubFactory(ReportCategoryFactory)
+    report_class = factory.SubFactory(ReportClassFactory)
+    is_active = factory.Faker("boolean")
+    base_color = factory.Faker("color")
+    title = factory.Sequence(lambda n: f"Report {n}")
+    logo_file = factory.django.ImageField()
+    color_palette = factory.SubFactory(ColorGradientFactory)
+    mailing_list = factory.SubFactory("wbmailing.factories.MailingListFactory")
+    parent_report = factory.SubFactory("wbreport.factories.ParentReportFactory")
+
+
+class ParentReportFactory(ReportFactory):
+    parent_report = None
+    key = factory.Sequence(lambda n: f"key-{n}")
+
+
+class ReportVersionFactory(factory.django.DjangoModelFactory):
+    class Meta:
+        model = ReportVersion
+
+    title = factory.Sequence(lambda n: f"Report Version {n}")
+    lookup = factory.Sequence(lambda n: f"lookup-{n}")
+    is_primary = True
+    disabled = False
+    report = factory.SubFactory(ReportFactory)
+    comment = factory.Faker("paragraph")
+    parameters = factory.Sequence(lambda n: {"type": f"type{n}"})

wbreport/filters.py

@@ -0,0 +1,37 @@
+from wbcore import filters as wb_filters
+from wbreport.models import Report, ReportVersion
+
+
+class ReportFilterSet(wb_filters.FilterSet):
+    is_active = wb_filters.BooleanFilter(default=True)
+
+    class Meta:
+        model = Report
+        fields = {
+            "category": ["exact"],
+            "parent_report": ["exact", "isnull"],
+            "permission_type": ["exact"],
+            "base_color": ["exact"],
+            "mailing_list": ["exact"],
+        }
+
+
+class ReportVersionFilterSet(wb_filters.FilterSet):
+    disabled = wb_filters.BooleanFilter(method="boolean_is_disabled", default=False)
+
+    def boolean_is_disabled(self, queryset, name, value):
+        if value is True:
+            return queryset.filter(disabled=True)
+        if value is False:
+            return queryset.filter(disabled=False)
+        return queryset
+
+    class Meta:
+        model = ReportVersion
+        fields = {
+            "report": ["exact"],
+            "version_date": ["gte", "exact", "lte"],
+            "creation_date": ["gte", "exact", "lte"],
+            "update_date": ["gte", "exact", "lte"],
+            "is_primary": ["exact"],
+        }

wbreport/migrations/0001_initial_squashed_squashed_0007_report_key.py

@@ -0,0 +1,238 @@
+# Generated by Django 4.1.7 on 2023-04-19 05:30
+
+import uuid
+
+import colorfield.fields
+import django.core.serializers.json
+import django.db.models.deletion
+import mptt.fields
+import picklefield.fields
+from django.conf import settings
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+    initial = True
+
+    dependencies = [
+        ("wbcore", "0001_initial_squashed_squashed_0010_preset_appliedpreset"),
+        ("wbmailing", "0001_initial_squashed_squashed_0008_alter_mail_bcc_email_alter_mail_cc_email_and_more"),
+        migrations.swappable_dependency(settings.AUTH_USER_MODEL),
+        ("contenttypes", "0002_remove_content_type_name"),
+    ]
+
+    operations = [
+        migrations.CreateModel(
+            name="Report",
+            fields=[
+                ("id", models.BigAutoField(auto_created=True, primary_key=True, serialize=False, verbose_name="ID")),
+                (
+                    "permission_type",
+                    models.CharField(
+                        choices=[("INTERNAL", "Internal"), ("PUBLIC", "Public"), ("PRIVATE", "Private")],
+                        default="PRIVATE",
+                        max_length=8,
+                    ),
+                ),
+                ("object_id", models.PositiveIntegerField(blank=True, null=True)),
+                (
+                    "key",
+                    models.CharField(
+                        default="",
+                        help_text="The key is like the family name: it represents the nature of the report.",
+                        max_length=256,
+                    ),
+                ),
+                (
+                    "file_content_type",
+                    models.CharField(
+                        choices=[("PDF", "application/pdf"), ("CSV", "text/csv")], default="PDF", max_length=64
+                    ),
+                ),
+                (
+                    "is_active",
+                    models.BooleanField(
+                        default=False, help_text="True if a report needs to be available for this product"
+                    ),
+                ),
+                (
+                    "file_disabled",
+                    models.BooleanField(default=False, help_text="True if this version file needs to be disabled"),
+                ),
+                (
+                    "base_color",
+                    colorfield.fields.ColorField(default="#FFF000", image_field=None, max_length=64, samples=None),
+                ),
+                ("title", models.CharField(max_length=256)),
+                ("namespace", models.CharField(default="", max_length=256)),
+                ("logo_file", models.FileField(blank=True, max_length=256, null=True, upload_to="report/logo")),
+                ("parameters", models.JSONField(default=dict, encoder=django.core.serializers.json.DjangoJSONEncoder)),
+                ("lft", models.PositiveIntegerField(editable=False)),
+                ("rght", models.PositiveIntegerField(editable=False)),
+                ("tree_id", models.PositiveIntegerField(db_index=True, editable=False)),
+                ("level", models.PositiveIntegerField(editable=False)),
+            ],
+            options={
+                "verbose_name": "Report",
+                "verbose_name_plural": "Reports",
+                "abstract": False,
+                "default_permissions": ("add", "change", "delete", "view", "administrate"),
+            },
+        ),
+        migrations.CreateModel(
+            name="ReportAsset",
+            fields=[
+                ("id", models.BigAutoField(auto_created=True, primary_key=True, serialize=False, verbose_name="ID")),
+                ("key", models.CharField(max_length=255, unique=True)),
+                ("description", models.TextField(blank=True, null=True)),
+                ("text", models.TextField(blank=True, null=True)),
+                ("asset", models.FileField(blank=True, max_length=256, null=True, upload_to="report/assets")),
+            ],
+            options={
+                "verbose_name": "Report Asset",
+                "verbose_name_plural": "Report Assets",
+            },
+        ),
+        migrations.CreateModel(
+            name="ReportCategory",
+            fields=[
+                ("id", models.BigAutoField(auto_created=True, primary_key=True, serialize=False, verbose_name="ID")),
+                ("title", models.CharField(max_length=128)),
+                ("order", models.IntegerField(default=0)),
+            ],
+            options={
+                "verbose_name": "Report Category",
+                "verbose_name_plural": "Report Categories",
+            },
+        ),
+        migrations.CreateModel(
+            name="ReportClass",
+            fields=[
+                ("id", models.BigAutoField(auto_created=True, primary_key=True, serialize=False, verbose_name="ID")),
+                ("title", models.CharField(max_length=256)),
+                ("class_path", models.CharField(max_length=256)),
+            ],
+            options={
+                "verbose_name": "Report Class",
+                "verbose_name_plural": "Report Classes",
+            },
+        ),
+        migrations.CreateModel(
+            name="ReportVersion",
+            fields=[
+                ("id", models.BigAutoField(auto_created=True, primary_key=True, serialize=False, verbose_name="ID")),
+                ("uuid", models.UUIDField(default=uuid.uuid4, editable=False, unique=True)),
+                ("lookup", models.CharField(default="", max_length=256, unique=True)),
+                ("title", models.CharField(max_length=256)),
+                ("parameters", models.JSONField(default=dict, encoder=django.core.serializers.json.DjangoJSONEncoder)),
+                ("context", picklefield.fields.PickledObjectField(default=dict, editable=False)),
+                ("version_date", models.DateField(blank=True, null=True)),
+                ("creation_date", models.DateTimeField(auto_now_add=True)),
+                ("update_date", models.DateTimeField(auto_now=True)),
+                ("comment", models.TextField(default="")),
+                (
+                    "is_primary",
+                    models.BooleanField(
+                        default=False,
+                        help_text="Only one Version from a report can be considered primary and is usually the last created one",
+                    ),
+                ),
+                ("disabled", models.BooleanField(default=False, help_text="True if version needs to be disabled")),
+                (
+                    "report",
+                    models.ForeignKey(
+                        on_delete=django.db.models.deletion.CASCADE,
+                        related_name="versions",
+                        to="wbreport.report",
+                        verbose_name="Report",
+                    ),
+                ),
+            ],
+            options={
+                "verbose_name": "Report Version",
+                "verbose_name_plural": "Report Versions",
+            },
+        ),
+        migrations.AddField(
+            model_name="report",
+            name="category",
+            field=models.ForeignKey(
+                blank=True,
+                help_text="The Visual Report category",
+                null=True,
+                on_delete=django.db.models.deletion.SET_NULL,
+                related_name="reports",
+                to="wbreport.reportcategory",
+                verbose_name="Report Category",
+            ),
+        ),
+        migrations.AddField(
+            model_name="report",
+            name="content_type",
+            field=models.ForeignKey(
+                blank=True, null=True, on_delete=django.db.models.deletion.CASCADE, to="contenttypes.contenttype"
+            ),
+        ),
+        migrations.AddField(
+            model_name="report",
+            name="creator",
+            field=models.ForeignKey(
+                blank=True,
+                null=True,
+                on_delete=django.db.models.deletion.SET_NULL,
+                related_name="created_%(app_label)s_%(class)s",
+                to=settings.AUTH_USER_MODEL,
+            ),
+        ),
+        migrations.AddField(
+            model_name="report",
+            name="mailing_list",
+            field=models.ForeignKey(
+                blank=True,
+                help_text="The Mailing List used to send the updated report link",
+                null=True,
+                on_delete=django.db.models.deletion.SET_NULL,
+                related_name="reports",
+                to="wbmailing.mailinglist",
+                verbose_name="Report Mailing List",
+            ),
+        ),
+        migrations.AddField(
+            model_name="report",
+            name="parent_report",
+            field=mptt.fields.TreeForeignKey(
+                blank=True,
+                help_text="The Parent Report attached to this report",
+                null=True,
+                on_delete=django.db.models.deletion.SET_NULL,
+                related_name="child_reports",
+                to="wbreport.report",
+                verbose_name="Parent Report",
+            ),
+        ),
+        migrations.AddField(
+            model_name="report",
+            name="report_class",
+            field=models.ForeignKey(
+                blank=True,
+                help_text="The method used to generate reports based on context",
+                null=True,
+                on_delete=django.db.models.deletion.SET_NULL,
+                related_name="reports",
+                to="wbreport.reportclass",
+                verbose_name="Report Class",
+            ),
+        ),
+        migrations.AddConstraint(
+            model_name="report",
+            constraint=models.UniqueConstraint(
+                fields=("parent_report", "title"), name="unique_parent_report_and_report"
+            ),
+        ),
+        migrations.AddConstraint(
+            model_name="report",
+            constraint=models.UniqueConstraint(
+                fields=("key", "content_type", "object_id"), name="unique_content_object_and_key"
+            ),
+        ),
+    ]

wbreport/migrations/0008_alter_report_file_content_type.py

@@ -0,0 +1,25 @@
+# Generated by Django 4.2.7 on 2023-11-06 13:30
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+    dependencies = [
+        ("wbreport", "0001_initial_squashed_squashed_0007_report_key"),
+    ]
+
+    operations = [
+        migrations.AlterField(
+            model_name="report",
+            name="file_content_type",
+            field=models.CharField(
+                choices=[
+                    ("PDF", "application/pdf"),
+                    ("CSV", "text/csv"),
+                    ("XLSX", "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet"),
+                ],
+                default="PDF",
+                max_length=64,
+            ),
+        ),
+    ]

wbreport/migrations/0009_alter_report_color_palette.py

@@ -0,0 +1,27 @@
+# Generated by Django 4.2.6 on 2023-11-16 14:03
+
+import django.db.models.deletion
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+    dependencies = [
+        ("color", "0001_initial"),
+        ("wbreport", "0008_alter_report_file_content_type"),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name="report",
+            name="color_palette",
+            field=models.ForeignKey(
+                blank=True,
+                help_text="The report color palette",
+                null=True,
+                on_delete=django.db.models.deletion.SET_NULL,
+                related_name="reports",
+                to="color.colorgradient",
+                verbose_name="Color Palette",
+            ),
+        )
+    ]

wbreport/migrations/0010_auto_20240103_0947.py

@@ -0,0 +1,43 @@
+# Generated by Django 4.2.8 on 2024-01-03 08:47
+
+from contextlib import suppress
+
+from django.apps import apps
+from django.contrib.contenttypes.models import ContentType
+from django.db import migrations
+
+
+def migrate_content_type(apps, schema_editor):
+    Report = apps.get_model("wbreport", "Report")
+
+    for model_name in [
+        "Classification",
+        "Instrument",
+        "ClassificationGroup",
+        "Deal",
+        "Exchange",
+        "InstrumentClassificationRelatedInstrument",
+        "InstrumentClassificationThroughModel",
+        "InstrumentFavoriteGroup",
+        "InstrumentList",
+        "InstrumentListThroughModel",
+        "InstrumentRequest",
+        "RelatedInstrumentThroughModel",
+        "InstrumentPrice",
+    ]:
+        with suppress(ContentType.DoesNotExist):
+            old_ct = ContentType.objects.get(app_label="wbportfolio", model=model_name.lower())
+            new_ct = ContentType.objects.get(app_label="wbfdm", model=model_name.lower())
+            Report.objects.filter(content_type_id=old_ct.id).update(content_type_id=new_ct.id)
+
+
+class Migration(migrations.Migration):
+    dependencies = (
+        [
+            ("wbreport", "0009_alter_report_color_palette"),
+            ("wbfdm", "0012_instrumentprice_created_instrumentprice_modified"),
+        ]
+        if apps.is_installed("wbfdm")
+        else [("wbreport", "0009_alter_report_color_palette")]
+    )
+    operations = [migrations.RunPython(migrate_content_type)]

wbreport/migrations/0011_auto_20240207_1629.py

@@ -0,0 +1,35 @@
+# Generated by Django 4.2.9 on 2024-02-07 15:29
+
+from contextlib import suppress
+
+from django.contrib.contenttypes.models import ContentType
+from django.db import migrations
+
+
+def migrate_theme_portfolio(apps, schema_editor):
+    from wbportfolio.models import Product
+    from wbreport.models import Report
+
+    PortfolioPortfolioThroughModel = apps.get_model("wbportfolio", "PortfolioPortfolioThroughModel")
+    InstrumentPortfolioThroughModel = apps.get_model("wbportfolio", "InstrumentPortfolioThroughModel")
+    for report in Report.objects.filter(content_type=ContentType.objects.get_for_model(Product)):
+        theme_portfolio_id = None
+        with suppress(InstrumentPortfolioThroughModel.DoesNotExist):
+            asset_portfolio = InstrumentPortfolioThroughModel.objects.get(
+                instrument_id=report.object_id, asset_portfolio=True
+            ).portfolio
+            if through_portfolio := PortfolioPortfolioThroughModel.objects.filter(
+                portfolio=asset_portfolio, is_theme=True
+            ).first():
+                theme_portfolio_id = through_portfolio.dependency_portfolio.id
+        report.parameters["theme_portfolio_id"] = theme_portfolio_id
+        report.save()
+
+
+class Migration(migrations.Migration):
+    run_before = [("wbportfolio", "0054_portfolioinstrumentpreferredclassificationthroughmodel_and_more")]
+    dependencies = [
+        ("wbreport", "0010_auto_20240103_0947"),
+    ]
+
+    operations = [migrations.RunPython(migrate_theme_portfolio)]

wbreport/migrations/0012_reportversion_lock.py

@@ -0,0 +1,17 @@
+# Generated by Django 5.0.6 on 2024-07-05 09:06
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+    dependencies = [
+        ("wbreport", "0011_auto_20240207_1629"),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name="reportversion",
+            name="lock",
+            field=models.BooleanField(default=False, help_text="True, the context cannot be regenerated"),
+        ),
+    ]

wbreport/migrations/0013_alter_reportversion_context.py

@@ -0,0 +1,18 @@
+# Generated by Django 5.0.7 on 2024-07-30 12:24
+
+import django.core.serializers.json
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+    dependencies = [
+        ("wbreport", "0012_reportversion_lock"),
+    ]
+
+    operations = [
+        migrations.AlterField(
+            model_name="reportversion",
+            name="context",
+            field=models.JSONField(default=dict, encoder=django.core.serializers.json.DjangoJSONEncoder),
+        ),
+    ]

wbreport/migrations/0014_alter_reportcategory_options_and_more.py

@@ -0,0 +1,25 @@
+# Generated by Django 5.0.9 on 2024-11-11 11:59
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+    dependencies = [
+        ("wbreport", "0013_alter_reportversion_context"),
+    ]
+
+    operations = [
+        migrations.AlterModelOptions(
+            name="reportcategory",
+            options={
+                "ordering": ("order",),
+                "verbose_name": "Report Category",
+                "verbose_name_plural": "Report Categories",
+            },
+        ),
+        migrations.AlterField(
+            model_name="reportcategory",
+            name="order",
+            field=models.PositiveIntegerField(db_index=True, editable=False, verbose_name="order"),
+        ),
+    ]