django-ormql 0.0.0__py3-none-any.whl

django_ormql/tables.py

@@ -0,0 +1,265 @@
+import copy
+
+from django.core.exceptions import ImproperlyConfigured
+from django.db import models
+from django.utils.functional import cached_property
+
+from . import model_utils
+from .columns import (
+    BaseColumn,
+    get_column_kwargs,
+    ModelColumn,
+    BooleanColumn,
+    DateColumn,
+    DateTimeColumn,
+    DecimalColumn,
+    DurationColumn,
+    TimeColumn,
+    TextColumn,
+    IntColumn,
+    FloatColumn,
+    JsonColumn,
+)
+from .exceptions import QueryError
+
+
+class BaseTable:
+    pass
+
+
+class TableMetaclass(type):
+    """
+    This metaclass sets a dictionary named `_declared_columns` on the class.
+
+    Any instances of `Field` included as attributes on either the class
+    or on any of its superclasses will be included in the `_declared_columns` dictionary.
+    """
+
+    @classmethod
+    def _get_declared_columns(cls, bases, attrs):
+        columns = [
+            (column_name, attrs.pop(column_name))
+            for column_name, obj in list(attrs.items())
+            if isinstance(obj, BaseColumn)
+        ]
+        # Ensures a base class column doesn't override cls attrs, and maintains
+        # column precedence when inheriting multiple parents. e.g. if there is a
+        # class C(A, B), and A and B both define 'column', use 'column' from A.
+        known = set(attrs)
+
+        def visit(name):
+            known.add(name)
+            return name
+
+        base_columns = [
+            (visit(name), f)
+            for base in bases
+            if hasattr(base, "_declared_columns")
+            for name, f in base._declared_columns.items()
+            if name not in known
+        ]
+
+        return dict(base_columns + columns)
+
+    def __new__(cls, name, bases, attrs):
+        attrs["_declared_columns"] = cls._get_declared_columns(bases, attrs)
+        return super().__new__(cls, name, bases, attrs)
+
+
+class Table(BaseTable, metaclass=TableMetaclass):
+    pass
+
+
+class ModelTable(Table):
+    field_column_mapping = {
+        models.AutoField: IntColumn,
+        models.BigIntegerField: IntColumn,
+        models.BooleanField: BooleanColumn,
+        models.CharField: TextColumn,
+        models.CommaSeparatedIntegerField: TextColumn,
+        models.DateField: DateColumn,
+        models.DateTimeField: DateTimeColumn,
+        models.DecimalField: DecimalColumn,
+        models.DurationField: DurationColumn,
+        models.EmailField: TextColumn,
+        models.Field: ModelColumn,
+        models.FileField: NotImplementedError,
+        models.FloatField: FloatColumn,
+        models.ImageField: NotImplementedError,
+        models.IntegerField: IntColumn,
+        models.NullBooleanField: BooleanColumn,
+        models.PositiveIntegerField: IntColumn,
+        models.PositiveSmallIntegerField: IntColumn,
+        models.SlugField: TextColumn,
+        models.SmallIntegerField: IntColumn,
+        models.TextField: TextColumn,
+        models.TimeField: TimeColumn,
+        models.URLField: TextColumn,
+        models.UUIDField: TextColumn,
+        models.GenericIPAddressField: TextColumn,
+        models.FilePathField: NotImplementedError,
+        models.JSONField: JsonColumn,
+    }
+
+    def __init__(self, *, base_qs=None, is_related=False):
+        if base_qs is None:
+            self.base_qs = self.Meta.model._default_manager.all()
+        else:
+            self.base_qs = base_qs
+        self.is_related = is_related
+
+    @cached_property
+    def columns(self):
+        """
+        A dictionary of {column_name: column_instance}.
+        """
+        fields = model_utils.BindingDict(self)
+        exclude_if_related = getattr(self.Meta, "exclude_if_related", [])
+        for key, value in self.get_columns().items():
+            if self.is_related and key in exclude_if_related:
+                continue
+            fields[key] = value
+        return fields
+
+    def get_columns(self):
+        assert hasattr(self, "Meta"), (
+            'Class {table_class} missing "Meta" attribute'.format(
+                table_class=self.__class__.__name__
+            )
+        )
+        assert hasattr(self.Meta, "model"), (
+            'Class {table_class} missing "Meta.model" attribute'.format(
+                table_class=self.__class__.__name__
+            )
+        )
+        if model_utils.is_abstract_model(self.Meta.model):
+            raise ValueError("Cannot use ModelSerializer with Abstract Models.")
+
+        declared_columns = copy.deepcopy(self._declared_columns)
+        model = getattr(self.Meta, "model")
+
+        # Retrieve metadata about columns & relationships on the model class.
+        info = model_utils.get_field_info(model)
+        column_names = self.get_column_names(declared_columns, info)
+
+        # Determine the columns that should be included on the table.
+        columns = {}
+
+        for column_name in column_names:
+            # If the column is explicitly declared on the class then use that.
+            if column_name in declared_columns:
+                columns[column_name] = declared_columns[column_name]
+                if (
+                    columns[column_name].nullable is None
+                    and column_name in info.forward_relations
+                ):
+                    columns[column_name].nullable = info.forward_relations[
+                        column_name
+                    ].model_field.null
+                elif (
+                    columns[column_name].nullable is None
+                    and column_name in info.fields_and_pk
+                ):
+                    columns[column_name].nullable = info.fields_and_pk[column_name].null
+                continue
+
+            column_class, column_kwargs = self.build_column(
+                column_name,
+                info,
+                model,
+            )
+            columns[column_name] = column_class(**column_kwargs)
+        return columns
+
+    def get_column_names(self, declared_columns, info):
+        """
+        Returns the list of all column names that should be created when
+        instantiating this table class. This is based on the default
+        set of columns, but also takes into account the `Meta.columns` or
+        `Meta.exclude` options if they have been specified.
+        """
+        columns = getattr(self.Meta, "columns", None)
+        if not isinstance(columns, (list, tuple)):
+            raise TypeError(
+                'The `columns` option must be a list or tuple or "__all__". '
+                "Got %s." % type(columns).__name__
+            )
+
+        # Ensure that all declared columns have also been included in the
+        # `Meta.columns` option.
+
+        # Do not require any columns that are declared in a parent class,
+        # in order to allow table subclasses to only include
+        # a subset of columns.
+        required_column_names = set(declared_columns)
+        for cls in self.__class__.__bases__:
+            required_column_names -= set(getattr(cls, "_declared_columns", []))
+
+        for column_name in required_column_names:
+            assert column_name in columns, (
+                "The column '{column_name}' was declared on table "
+                "{table_class}, but has not been included in the "
+                "'columns' option.".format(
+                    column_name=column_name, table_class=self.__class__.__name__
+                )
+            )
+        return columns
+
+    def build_column(self, column_name, info, model_class):
+        """
+        Return a two tuple of (cls, kwargs) to build a table column with.
+        """
+        if column_name in info.fields_and_pk:
+            model_column = info.fields_and_pk[column_name]
+            return self.build_standard_column(column_name, model_column)
+
+        elif column_name in info.relations:
+            raise ImproperlyConfigured(
+                f"Relational column '{column_name}' needs to be defined explicitly."
+            )
+
+        raise ImproperlyConfigured(
+            "Field name `%s` is not valid for model `%s` in `%s.%s`."
+            % (
+                column_name,
+                model_class.__name__,
+                self.__class__.__module__,
+                self.__class__.__name__,
+            )
+        )
+
+    def build_standard_column(self, column_name, model_column):
+        column_mapping = model_utils.ClassLookupDict(self.field_column_mapping)
+
+        column_class = column_mapping[model_column]
+        column_kwargs = get_column_kwargs(model_column)
+
+        # Special case to handle when a OneToOneField is also the primary key
+        if model_column.one_to_one and model_column.primary_key:
+            raise NotImplementedError(
+                "Case of a OneToOneField as primary key not handled"
+            )
+
+        column_kwargs["nullable"] = model_column.null
+        if model_column.choices:
+            column_kwargs["enum_options"] = model_column.choices
+
+        return column_class, column_kwargs
+
+    def resolve_column_path(self, column_path):
+        for c in column_path:
+            if "__" in c:
+                raise QueryError("Cannot use __ in column path")
+        column_name = column_path[0]
+        exclude_if_related = getattr(self.Meta, "exclude_if_related", [])
+        if column_name not in self.columns:
+            if column_name in exclude_if_related:
+                raise QueryError(
+                    f"Column '{column_path[0]}' cannot be queried on related tables."
+                )
+            raise QueryError(
+                f"Column '{column_path[0]}' does not exist in table '{self.Meta.name}'."
+            )
+
+        column = self.columns[column_name]
+        return column.resolve_column_path(column_path[1:])

django_ormql-0.0.0.dist-info/METADATA

@@ -0,0 +1,56 @@
+Metadata-Version: 2.4
+Name: django-ormql
+Version: 0.0.0
+Summary: ORMQL is a library that allows adding a reporting DSL (that is loosely based on SQL) to your Django project.
+Author-email: Raphael Michel <mail@raphaelmichel.de>
+License-Expression: Apache-2.0
+Project-URL: Homepage, https://github.com/pretix/django-ormql
+Keywords: django,sql
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Other Audience
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: sqlglot[c]==29.0.1
+Provides-Extra: dev
+Requires-Dist: pytest==9.*; extra == "dev"
+Requires-Dist: pytest-cov; extra == "dev"
+Requires-Dist: pytest-django; extra == "dev"
+Requires-Dist: django<6.1; extra == "dev"
+Requires-Dist: factory_boy==3.*; extra == "dev"
+Requires-Dist: freezegun; extra == "dev"
+Requires-Dist: ruff; extra == "dev"
+Requires-Dist: check-manifest; extra == "dev"
+Dynamic: license-file
+
+ORMQL
+=====
+
+ORMQL is a library that allows adding a reporting DSL (that is loosely based on SQL) to your Django project.
+
+See [Design](doc/design.md) for more background.
+
+Compatibility
+-------------
+
+- Django 4.2, 5.2, 6.0
+- Python versions supported by Django 4.2 through 5.2
+- SQLite and PostgreSQL
+
+Security
+--------
+
+If you discover a security issue, please contact us at security@pretix.eu and see our [Responsible Disclosure Policy](https://docs.pretix.eu/trust/security/disclosure/) further information.
+
+License
+-------
+The code in this repository is published under the terms of the Apache License. 
+See the LICENSE file for the complete license text.
+
+This project is maintained by Raphael Michel <mail@raphaelmichel.de>.

django_ormql-0.0.0.dist-info/RECORD

@@ -0,0 +1,13 @@
+django_ormql/__init__.py,sha256=AyPfNb7fM8mOMxvEg1gJ8sQggKMU-w224KBkcbjAwuE,18
+django_ormql/columns.py,sha256=ixrfDVH5iV2WooBlT6OWcp3bfsG7wRM5KNFzg3rkQxQ,5646
+django_ormql/db_func.py,sha256=odT98-UCtYXQLYPXydwlr2-s--_iEgAuUBi-vbrR6PE,4011
+django_ormql/engine.py,sha256=IhcPdUNhGAn9kzoNiEjGt0AsoDCdy6LuTsM5s2vQl2c,504
+django_ormql/exceptions.py,sha256=ZG12zdmSBgid8aHguHmCW35yvH_AR1Kbw08zbhILtVs,86
+django_ormql/model_utils.py,sha256=LgDL09X0c_3r9p3TnBU30_MKr95Dy1fUCYEYOIzINkg,8351
+django_ormql/query.py,sha256=sMvsIsH_0jzL-7cqibCK6IAYncM0cWob2MYesLC2vB4,35886
+django_ormql/tables.py,sha256=uXGN7iUVqZCdgT6lozfRhj8-Hje-Lqfp6zIGe1Jlh9U,9585
+django_ormql-0.0.0.dist-info/licenses/LICENSE,sha256=ogy1snSUQL0pyabDEqJYbndUxDm0Dxs70WEH-kYjZSc,11344
+django_ormql-0.0.0.dist-info/METADATA,sha256=0Fy_zX4rzVwaOITeJotWCS7e09LWbdY6rxR7_sU3p9s,1971
+django_ormql-0.0.0.dist-info/WHEEL,sha256=aeYiig01lYGDzBgS8HxWXOg3uV61G9ijOsup-k9o1sk,91
+django_ormql-0.0.0.dist-info/top_level.txt,sha256=Btg7Tz3c85nNOEZsjDEKCgdqiVmVyzfvo2YuPBOkk7w,13
+django_ormql-0.0.0.dist-info/RECORD,,

django_ormql-0.0.0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (82.0.1)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

django_ormql-0.0.0.dist-info/licenses/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2026 Raphael Michel
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

django_ormql-0.0.0.dist-info/top_level.txt

@@ -0,0 +1 @@
+django_ormql