drf-smart-nested-parser 0.1.0__py3-none-any.whl

drf_smart_nested_parser-0.1.0.dist-info/METADATA

@@ -0,0 +1,108 @@
+Metadata-Version: 2.4
+Name: drf_smart_nested_parser
+Version: 0.1.0
+Summary: Smart nested parser for DRF (JSON + multipart + files)
+Home-page: https://github.com/AmirHosseinDonyaei/drf_smart_nested_parser
+Author: AmirHosseinDonyaei
+License: MIT
+Classifier: Programming Language :: Python :: 3
+Classifier: Framework :: Django
+Classifier: Framework :: Django :: 4
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.7
+Description-Content-Type: text/markdown
+Requires-Dist: djangorestframework>=3.14
+Dynamic: author
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: license
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
+
+# DRF Smart Nested Parser
+
+A simple parser for Django REST Framework that converts `form-data` and `application/x-www-form-urlencoded` inputs into nested structures (dict / list). For JSON, it uses the default DRF JSON parser without additional conversion.
+
+## Installation
+
+If you're using this package locally, ensure it is importable from your project. If published on PyPI, install it by the package name.
+
+## Usage
+
+### Add to DRF settings
+
+```python
+# settings.py
+REST_FRAMEWORK = {
+    "DEFAULT_PARSER_CLASSES": [
+        "drf_smart_nested_parser.SmartNestedParser",
+    ]
+}
+```
+
+### Or only for a single view
+
+```python
+from rest_framework.views import APIView
+from drf_smart_nested_parser import SmartNestedParser
+
+class MyView(APIView):
+    parser_classes = [SmartNestedParser]
+```
+
+## Input and Output
+
+### Example for `multipart/form-data` or `application/x-www-form-urlencoded`
+
+Form keys with bracket notation (`[]`) are converted to nested structures:
+
+```
+user[name] = Amir
+user[age] = 30
+items[0][title] = Book
+items[0][price] = 120
+items[1][title] = Pen
+```
+
+Output:
+
+```json
+{
+  "user": {
+    "name": "Amir",
+    "age": 30
+  },
+  "items": [
+    {"title": "Book", "price": 120},
+    {"title": "Pen"}
+  ]
+}
+```
+
+Note: If a value can be converted to a number, it will be cast to `int`.
+
+## Parser Behavior
+
+- If `Content-Type` includes `application/json`, DRF's `JSONParser` is used.
+- If `Content-Type` includes `multipart/form-data`, data is parsed and keys are converted to nested structures.
+- Otherwise (e.g. `application/x-www-form-urlencoded`), `FormParser` is used and the same conversion applies.
+
+## Limitations and Notes
+
+- Keys should start with a string root (e.g. `items[0]` should be used as part of a root like `items[0][name]` or at least `items[0]` alongside a textual root). A valid example: `items[0][name]`.
+- File values in `multipart/form-data` are kept in `files` and are not modified.
+
+## Development
+
+Code layout:
+
+- `parsers.py`: `SmartNestedParser` implementation
+- `utils.py`: `parse_nested_keys` helper
+
+## License
+
+MIT

drf_smart_nested_parser-0.1.0.dist-info/RECORD

@@ -0,0 +1,4 @@
+drf_smart_nested_parser-0.1.0.dist-info/METADATA,sha256=H9sHHkaqBsRUdmor4Egm-phN2i7BQIr82GBC3VxCgnk,2822
+drf_smart_nested_parser-0.1.0.dist-info/WHEEL,sha256=YCfwYGOYMi5Jhw2fU4yNgwErybb2IX5PEwBKV4ZbdBo,91
+drf_smart_nested_parser-0.1.0.dist-info/top_level.txt,sha256=AbpHGcgLb-kRsJGnwFEktk7uzpZOCcBY74-YBdrKVGs,1
+drf_smart_nested_parser-0.1.0.dist-info/RECORD,,

drf_smart_nested_parser-0.1.0.dist-info/WHEEL

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

drf_smart_nested_parser-0.1.0.dist-info/top_level.txt

@@ -0,0 +1 @@
+