drf-ordering-mapper 0.0.1__tar.gz

drf_ordering_mapper-0.0.1/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2018 The Python Packaging Authority
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

drf_ordering_mapper-0.0.1/MANIFEST.in

@@ -0,0 +1,3 @@
+include README.md
+include LICENSE.md
+recursive-include drf_ordering_mapper *

drf_ordering_mapper-0.0.1/PKG-INFO

@@ -0,0 +1,114 @@
+Metadata-Version: 2.4
+Name: drf-ordering-mapper
+Version: 0.0.1
+Summary: A Django REST Framework filter to map ordering query parameters to ORM fields
+Author: Punyak Goswami
+Project-URL: Homepage, https://github.com/punyak-goswami/drf-ordering-mapper
+Project-URL: Repository, https://github.com/punyak-goswami/drf-ordering-mapper
+Keywords: django,djangorestframework,drf,ordering,filter,api
+Classifier: Framework :: Django
+Classifier: Framework :: Django :: 3
+Classifier: Framework :: Django :: 4
+Classifier: Framework :: Django :: 5
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Dynamic: license-file
+
+# drf-ordering-mapper
+
+Small utility for Django REST Framework to map ordering query params to actual ORM fields.
+
+## Why?
+
+DRF’s `OrderingFilter` works well, but you often end up exposing internal field paths like:
+
+```
+?ordering=company__commodity_name
+```
+
+That’s not great for API consumers.
+
+This package lets you do:
+
+```
+?ordering=commodity_name
+```
+
+and map it internally.
+
+---
+
+## Installation
+
+```
+pip install drf-ordering-mapper
+```
+
+---
+
+## Usage
+
+```python
+from drf_ordering_mapper.filters import OrderingMapperFilter
+
+class ProductViewSet(ModelViewSet):
+    queryset = Product.objects.all()
+    serializer_class = ProductSerializer
+
+    filter_backends = [OrderingMapperFilter]
+
+    ordering_fields = ['commodity_name', 'price']
+
+    ordering_params_mapping = {
+        'commodity_name': 'company__commodity_name'
+    }
+```
+
+---
+
+## Example
+
+Request:
+
+```
+GET /api/products?ordering=commodity_name
+```
+
+Internally becomes:
+
+```python
+queryset.order_by('company__commodity_name')
+```
+
+---
+
+Descending:
+
+```
+GET /api/products?ordering=-commodity_name
+```
+
+---
+
+Multiple fields:
+
+```
+GET /api/products?ordering=commodity_name,-price
+```
+
+---
+
+## Notes
+
+* Works as a drop-in replacement for DRF’s `OrderingFilter`
+* Respects `ordering_fields`
+* Ignores invalid fields (same behavior as DRF)

drf_ordering_mapper-0.0.1/README.md

@@ -0,0 +1,89 @@
+# drf-ordering-mapper
+
+Small utility for Django REST Framework to map ordering query params to actual ORM fields.
+
+## Why?
+
+DRF’s `OrderingFilter` works well, but you often end up exposing internal field paths like:
+
+```
+?ordering=company__commodity_name
+```
+
+That’s not great for API consumers.
+
+This package lets you do:
+
+```
+?ordering=commodity_name
+```
+
+and map it internally.
+
+---
+
+## Installation
+
+```
+pip install drf-ordering-mapper
+```
+
+---
+
+## Usage
+
+```python
+from drf_ordering_mapper.filters import OrderingMapperFilter
+
+class ProductViewSet(ModelViewSet):
+    queryset = Product.objects.all()
+    serializer_class = ProductSerializer
+
+    filter_backends = [OrderingMapperFilter]
+
+    ordering_fields = ['commodity_name', 'price']
+
+    ordering_params_mapping = {
+        'commodity_name': 'company__commodity_name'
+    }
+```
+
+---
+
+## Example
+
+Request:
+
+```
+GET /api/products?ordering=commodity_name
+```
+
+Internally becomes:
+
+```python
+queryset.order_by('company__commodity_name')
+```
+
+---
+
+Descending:
+
+```
+GET /api/products?ordering=-commodity_name
+```
+
+---
+
+Multiple fields:
+
+```
+GET /api/products?ordering=commodity_name,-price
+```
+
+---
+
+## Notes
+
+* Works as a drop-in replacement for DRF’s `OrderingFilter`
+* Respects `ordering_fields`
+* Ignores invalid fields (same behavior as DRF)

drf_ordering_mapper-0.0.1/pyproject.toml

@@ -0,0 +1,34 @@
+[build-system]
+requires = ["setuptools>=61.0", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "drf-ordering-mapper"
+version = "0.0.1"
+description = "A Django REST Framework filter to map ordering query parameters to ORM fields"
+readme = "README.md"
+requires-python = ">=3.8"
+authors = [
+    { name = "Punyak Goswami" }
+]
+
+keywords = ["django", "djangorestframework", "drf", "ordering", "filter", "api"]
+
+classifiers = [
+    "Framework :: Django",
+    "Framework :: Django :: 3",
+    "Framework :: Django :: 4",
+    "Framework :: Django :: 5",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.8",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "License :: OSI Approved :: MIT License",
+    "Operating System :: OS Independent"
+]
+
+[project.urls]
+Homepage = "https://github.com/punyak-goswami/drf-ordering-mapper"
+Repository = "https://github.com/punyak-goswami/drf-ordering-mapper"

drf_ordering_mapper-0.0.1/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

drf_ordering_mapper-0.0.1/src/drf_ordering_mapper/filters.py

@@ -0,0 +1,75 @@
+from rest_framework.filters import OrderingFilter
+
+class OrderingMapperFilter(OrderingFilter):
+    """
+    Extends DRF's OrderingFilter to support mapping of query parameter
+    fields to Django ORM field paths.
+
+    This allows exposing clean, user-friendly ordering parameters in APIs
+    while internally using complex or nested model field lookups.
+
+    Example:
+        class ProductViewSet(ModelViewSet):
+            filter_backends = [OrderingMapperFilter]
+            ordering_fields = ['commodity_name']
+
+            ordering_params_mapping = {
+                'commodity_name': 'company__commodity_name'
+            }
+
+    Request:
+        GET /api/products?ordering=commodity_name
+        GET /api/products?ordering=-commodity_name
+
+    Attributes:
+        ordering_params_mapping (dict):
+            Maps query parameter names to Django ORM field paths.
+    """
+    def get_ordering(self, request, queryset, view):
+        params = request.query_params.get(self.ordering_param)
+        ordering_params_mapping = getattr(view, 'ordering_params_mapping', {})
+        
+        if params:
+            fields = []
+            for param in params.split(','):
+                param = param.strip()
+                if param.startswith('-'):
+                    param = "-" + ordering_params_mapping.get(param[1:]) if param[1:] in ordering_params_mapping else param
+                else:
+                    param = ordering_params_mapping.get(param) if param in ordering_params_mapping else param
+                if param:
+                    fields.append(param.strip())
+            
+            ordering = self.remove_invalid_fields(queryset, fields, view, request)
+
+            if ordering:
+                return ordering
+
+        # No ordering was included, or all the ordering fields were invalid
+        return self.get_default_ordering(view)
+    
+    def get_valid_fields(self, queryset, view, context={}):
+        valid_fields = getattr(view, 'ordering_fields', self.ordering_fields)
+        ordering_params_mapping = getattr(view, 'ordering_params_mapping', {})
+        if valid_fields:
+            valid_fields = [ordering_params_mapping.get(field) if field in ordering_params_mapping else field for field in valid_fields]
+        if valid_fields is None:
+            # Default to allowing filtering on serializer fields
+            return self.get_default_valid_fields(queryset, view, context)
+
+        elif valid_fields == '__all__':
+            # View explicitly allows filtering on any model field
+            valid_fields = [
+                (field.name, field.verbose_name) for field in queryset.model._meta.fields
+            ]
+            valid_fields += [
+                (key, key.title().split('__'))
+                for key in queryset.query.annotations
+            ]
+        else:
+            valid_fields = [
+                (item, item) if isinstance(item, str) else item
+                for item in valid_fields
+            ]
+
+        return valid_fields

drf_ordering_mapper-0.0.1/src/drf_ordering_mapper.egg-info/PKG-INFO

@@ -0,0 +1,114 @@
+Metadata-Version: 2.4
+Name: drf-ordering-mapper
+Version: 0.0.1
+Summary: A Django REST Framework filter to map ordering query parameters to ORM fields
+Author: Punyak Goswami
+Project-URL: Homepage, https://github.com/punyak-goswami/drf-ordering-mapper
+Project-URL: Repository, https://github.com/punyak-goswami/drf-ordering-mapper
+Keywords: django,djangorestframework,drf,ordering,filter,api
+Classifier: Framework :: Django
+Classifier: Framework :: Django :: 3
+Classifier: Framework :: Django :: 4
+Classifier: Framework :: Django :: 5
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Dynamic: license-file
+
+# drf-ordering-mapper
+
+Small utility for Django REST Framework to map ordering query params to actual ORM fields.
+
+## Why?
+
+DRF’s `OrderingFilter` works well, but you often end up exposing internal field paths like:
+
+```
+?ordering=company__commodity_name
+```
+
+That’s not great for API consumers.
+
+This package lets you do:
+
+```
+?ordering=commodity_name
+```
+
+and map it internally.
+
+---
+
+## Installation
+
+```
+pip install drf-ordering-mapper
+```
+
+---
+
+## Usage
+
+```python
+from drf_ordering_mapper.filters import OrderingMapperFilter
+
+class ProductViewSet(ModelViewSet):
+    queryset = Product.objects.all()
+    serializer_class = ProductSerializer
+
+    filter_backends = [OrderingMapperFilter]
+
+    ordering_fields = ['commodity_name', 'price']
+
+    ordering_params_mapping = {
+        'commodity_name': 'company__commodity_name'
+    }
+```
+
+---
+
+## Example
+
+Request:
+
+```
+GET /api/products?ordering=commodity_name
+```
+
+Internally becomes:
+
+```python
+queryset.order_by('company__commodity_name')
+```
+
+---
+
+Descending:
+
+```
+GET /api/products?ordering=-commodity_name
+```
+
+---
+
+Multiple fields:
+
+```
+GET /api/products?ordering=commodity_name,-price
+```
+
+---
+
+## Notes
+
+* Works as a drop-in replacement for DRF’s `OrderingFilter`
+* Respects `ordering_fields`
+* Ignores invalid fields (same behavior as DRF)

drf_ordering_mapper-0.0.1/src/drf_ordering_mapper.egg-info/SOURCES.txt

@@ -0,0 +1,10 @@
+LICENSE
+MANIFEST.in
+README.md
+pyproject.toml
+src/drf_ordering_mapper/__init__.py
+src/drf_ordering_mapper/filters.py
+src/drf_ordering_mapper.egg-info/PKG-INFO
+src/drf_ordering_mapper.egg-info/SOURCES.txt
+src/drf_ordering_mapper.egg-info/dependency_links.txt
+src/drf_ordering_mapper.egg-info/top_level.txt

drf_ordering_mapper-0.0.1/src/drf_ordering_mapper.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

drf_ordering_mapper-0.0.1/src/drf_ordering_mapper.egg-info/top_level.txt

@@ -0,0 +1 @@
+drf_ordering_mapper