rename to dict instead of json

fastapi · Jan 10, 2025 · 240d614 · 240d614
1 parent 71ca8e3
commit 240d614
Show file tree

Hide file tree

Showing 5 changed files with 7 additions and 10 deletions.
diff --git a/docs/tutorial/parameter-types/json.md → docs/tutorial/parameter-types/dict.md b/docs/tutorial/parameter-types/json.md → docs/tutorial/parameter-types/dict.md
@@ -2,18 +2,18 @@
 
 You can declare a *CLI parameter* to be a standard Python `dict`:
 
-{* docs_src/parameter_types/json/tutorial001.py hl[5] *}
+{* docs_src/parameter_types/dict/tutorial001.py hl[5] *}
 
 Check it:
 
 <div class="termy">
 
 ```console
 // Run your program
-$ python main.py --user-info '{"name": "Camila", "age": 15, "height_meters": 1.7, "female": true}'
+$ python main.py --user-info '{"name": "Camila", "age": 15, "height": 1.7, "female": true}'
 
 Name: Camila
-User attributes: ['age', 'female', 'height_meters', 'name']
+User attributes: ['age', 'female', 'height', 'name']
 
 ```
 

diff --git a/docs_src/parameter_types/json/__init__.py → docs_src/parameter_types/dict/__init__.py b/docs_src/parameter_types/json/__init__.py → docs_src/parameter_types/dict/__init__.py
diff --git a/docs_src/parameter_types/json/tutorial001.py → docs_src/parameter_types/dict/tutorial001.py b/docs_src/parameter_types/json/tutorial001.py → docs_src/parameter_types/dict/tutorial001.py
diff --git a/...est_parameter_types/test_json/__init__.py → ...est_parameter_types/test_dict/__init__.py b/...est_parameter_types/test_json/__init__.py → ...est_parameter_types/test_dict/__init__.py
diff --git a/...meter_types/test_json/test_tutorial001.py → ...meter_types/test_dict/test_tutorial001.py b/...meter_types/test_json/test_tutorial001.py → ...meter_types/test_dict/test_tutorial001.py
@@ -5,7 +5,7 @@
 import typer
 from typer.testing import CliRunner
 
-from docs_src.parameter_types.json import tutorial001 as mod
+from docs_src.parameter_types.dict import tutorial001 as mod
 
 runner = CliRunner()
 
@@ -21,7 +21,7 @@ def test_help():
 
 
 def test_params():
-    data = {"name": "Camila", "age": 15, "height_meters": 1.7, "female": True}
+    data = {"name": "Camila", "age": 15, "height": 1.7, "female": True}
     result = runner.invoke(
         app,
         [
@@ -30,11 +30,8 @@ def test_params():
         ],
     )
     assert result.exit_code == 0
-    assert "Name: Camila" in result.output.strip()
-    assert (
-        f"User attributes: {['age', 'female', 'height_meters', 'name']}"
-        in result.output.strip()
-    )
+    assert "Name: Camila" in result.output
+    assert "User attributes: ['age', 'female', 'height', 'name']" in result.output
 
 
 def test_invalid():