readme and fix rewrite value

Author: remigermain

.gitignore

@@ -143,3 +143,5 @@ dmypy.json
 cython_debug/
 
 # End of https://www.toptal.com/developers/gitignore/api/python
+
+debug.py

README.md

@@ -1,28 +1,185 @@
-# nested-multi-dimentional-parser
+# Nested-multipart-parser
 
-Parser for nested data in multipart form
+Parser for nested data in multipart form, you can use it anyways, and you have a django rest framework integration
+
+# Installation
+
+```bash
+pip install nested-multipart-parser
+```
 
 # Usage
 
+## What is doing
+
+the parser take the request data and transform to dictionary
+
+exemple:
+
 ```python
-from nested_multipart_parser import parser
-...
+# input
+{
+	'title': 'title',
+	'date': "time",
+	'simple_object[my_key]': 'title'
+	'simple_object[my_list][0]': True
+	'langs[0][id]': 666,
+	'langs[0][title]': 'title',
+	'langs[0][description]': 'description',
+	'langs[0][language]': "language",
+	'langs[1][id]': 4566,
+	'langs[1][title]': 'title1',
+	'langs[1][description]': 'description1',
+	'langs[1][language]': "language1"
+}
 
-class YourViewSet(viewsets.ViewSet):
-	parser_classes = (NestedMultipartParser,)
+# results are:
+ {
+	'title': 'title',
+	'date': "time",
+	'simple_object': {
+		'my_key': 'title',
+		'my_list': [
+			True
+		]
+	},
+	'langs': [
+		{
+			'id': 666,
+			'title': 'title',
+			'description': 'description',
+			'language': 'language'
+		},
+		{
+			'id': 4566,
+			'title': 'title1',
+			'description': 'description1',
+			'language': 'language1'
+		}
+	]
+}
 ```
 
-To enable JSON and multipart
+## How is work
+
+for this working perfectly you need to follow this rules:
+
+- a first key need to be set ex: 'title[0]' or 'title', in both the first key is 'title'
+- each sub key need to enclose by brackets "[--your-key--]"
+- if sub key are a full number, is converted to list
+- if sub key is Not a number is converted to dictionary
+- the key can't be rewite
+  ex:
 
 ```python
-from drf_nested_field_multipart import NestedMultipartParser
-from rest_framework.parsers import JSONParser
-from rest_framework import viewsets
+	data = {
+		'title[0]': 'my-value'
+	}
+	# output
+	output = {
+		'title': [
+			'my-value'
+		]
+	}
 
-class YourViewSet(viewsets.ViewSet):
-	parser_classes = (JSONParser, NestedMultipartParser)
+	# invalid key
+	data = {
+		'title[688]': 'my-value'
+	}
+	# ERROR , you set a number is upper thans actual list
+
+
+	# wrong format
+	data = {
+		'title[0]]]': 'my-value',
+		'title[0': 'my-value',
+		'title[': 'my-value',
+		'title[]': 'my-value',
+		'[]': 'my-value',
+	}
+
+	data = {
+		'title': 42,
+		'title[object]': 42
+	}
+	# Error , title as alerady set by primitive value (int, boolean or string)
+
+	# many element in list
+	data = {
+		'title[0]': 'my-value',
+		'title[1]': 'my-second-value'
+	}
+	# output
+	output = {
+		'title': [
+			'my-value',
+			'my-second-value'
+		]
+	}
+
+	# converted to object
+	data = {
+		'title[key0]': 'my-value',
+		'title[key7]': 'my-second-value'
+	}
+	# output
+	output = {
+		'title': {
+			'key0': 'my-value',
+			'key7': 'my-second-value'
+		}
+	}
+
+	# you have no limit for chained key
+	data = {
+		'the[0][chained][key][0][are][awesome][0][0]': 'im here !!'
+	}
+	# output
+	output: {
+		'the': [
+			{
+				'chained':{
+					'key': [
+						{
+							'are': {
+								'awesome':
+								[
+									[
+										'im here !!'
+									]
+								]
+							}
+						}
+					]
+				}
+			}
+		]
+	}
 ```
 
-# Installation
+# How to use it
+
+## for every framwork
 
-`pip install drf-nested-field-multipart`
+```python
+from nested_multipart_parser import NestedParser
+
+def my_view():
+	parser = NestedParser(data)
+	if parser.is_valid():
+		validate_data = parser.validate_data
+		...
+	else:
+		print(parser.errors)
+
+```
+
+## for django rest framwork
+
+```python
+from nested_multipart_parser.drf import DrfNestedParser
+...
+
+class YourViewSet(viewsets.ViewSet):
+	parser_classes = (DrfNestedParser,)
+```

nested_multipart_parser/parser.py

@@ -27,16 +27,20 @@ def split_key(self, key):
         return results
 
     def set_type(self, dtc, key, value, full_keys):
-        if key.isdigit():
+        if isinstance(dtc, list):
             key = int(key)
             if len(dtc) < key:
-                raise Exception(
+                raise ValueError(
                     f"key \"{full_keys}\" is upper than actual list")
             if len(dtc) == key:
                 dtc.append(value)
                 return key
-        elif key not in dtc:
-            dtc[key] = value
+        elif isinstance(dtc, dict):
+            if key not in dtc:
+                dtc[key] = value
+        else:
+            raise ValueError(
+                f"invalid rewrite key from \"{full_keys}\" to \"{dtc}\"")
         return key
 
     def construct(self, data):

setup.py

@@ -6,7 +6,7 @@
 
 setuptools.setup(
     name="nested-multipart-parser",
-    version="0.0.2",
+    version="0.0.3",
     author="Example Author",
     license='MIT',
     author_email='[email protected]',

tests/test_parser.py

@@ -279,3 +279,19 @@ def test_real(self):
             ]
         }
         self.assertDictEqual(parser.validate_data, expected)
+
+    def test_parser_rewrite_key_list(self):
+        data = {
+            'title': 'lalal',
+            'title[0]': 'lalal',
+        }
+        parser = NestedParser(data)
+        self.assertFalse(parser.is_valid())
+
+    def test_parser_rewrite_key_boject(self):
+        data = {
+            'title': 'lalal',
+            'title[object]': 'lalal',
+        }
+        parser = NestedParser(data)
+        self.assertFalse(parser.is_valid())