@autorest/python 6.41.4 → 6.42.1

package/generator/build/lib/pygen/__init__.py

@@ -3,6 +3,7 @@
 # Licensed under the MIT License. See License.txt in the project root for
 # license information.
 # --------------------------------------------------------------------------
+import shutil
 from collections.abc import ItemsView, KeysView, MutableMapping, ValuesView
 import logging
 from pathlib import Path
@@ -39,6 +40,7 @@ class OptionsDict(MutableMapping):
         "validate-versioning": True,
         "version-tolerant": True,
         "generation-subdir": None,  # subdirectory to generate the code in
+        "clear-output-folder": False,  # whether to clear the output folder before generating code
     }
 
     def __init__(self, options: Optional[dict[str, Any]] = None) -> None:
@@ -248,9 +250,23 @@ class ReaderAndWriter:
         except FileNotFoundError:
             pass
 
+    def remove_folder(self, foldername: Union[str, Path]) -> None:
+        try:
+            folder_path = self.output_folder / Path(foldername)
+            if folder_path.exists() and folder_path.is_dir():
+                shutil.rmtree(folder_path)
+        except FileNotFoundError:
+            pass
+
     def list_file(self) -> list[str]:
         return [str(f.relative_to(self.output_folder)) for f in self.output_folder.glob("**/*") if f.is_file()]
 
+    def list_file_of_folder(self, foldername: Union[str, Path]) -> list[str]:
+        folder_path = self.output_folder / Path(foldername)
+        if folder_path.exists() and folder_path.is_dir():
+            return [str(f.relative_to(self.output_folder)) for f in folder_path.glob("**/*") if f.is_file()]
+        return []
+
 
 class Plugin(ReaderAndWriter, ABC):
     """A base class for autorest plugin.

package/generator/build/lib/pygen/codegen/serializers/__init__.py

@@ -122,7 +122,21 @@ class JinjaSerializer(ReaderAndWriter):
             # If parsing the version fails, we assume the version file is not valid and overwrite.
             return False
 
+    # pylint: disable=too-many-branches
     def serialize(self) -> None:
+        # remove existing folders when generate from tsp
+        if self.code_model.is_tsp and self.code_model.options.get("clear-output-folder"):
+            # remove generated_samples and generated_tests folder
+            self.remove_folder(self._generated_tests_samples_folder("generated_samples"))
+            self.remove_folder(self._generated_tests_samples_folder("generated_tests"))
+
+            # remove generated sdk files
+            generation_path = self.code_model.get_generation_dir(self.code_model.namespace)
+            for file in self.list_file_of_folder(generation_path):
+                if file.endswith(".py") and "_patch.py" not in file:
+                    self.remove_file(file)
+
+        # serialize logic
         env = Environment(
             loader=PackageLoader("pygen.codegen", "templates"),
             keep_trailing_newline=True,
@@ -519,8 +533,11 @@ class JinjaSerializer(ReaderAndWriter):
             return Path("/".join(namespace_config.split(".")[num_of_package_namespace:]))
         return Path("")
 
+    def _generated_tests_samples_folder(self, folder_name: str) -> Path:
+        return self._root_of_sdk / folder_name
+
     def _serialize_and_write_sample(self, env: Environment):
-        out_path = self._root_of_sdk / "generated_samples"
+        out_path = self._generated_tests_samples_folder("generated_samples")
         for client in self.code_model.clients:
             for op_group in client.operation_groups:
                 for operation in op_group.operations:
@@ -549,7 +566,7 @@ class JinjaSerializer(ReaderAndWriter):
 
     def _serialize_and_write_test(self, env: Environment):
         self.code_model.for_test = True
-        out_path = self._root_of_sdk / "generated_tests"
+        out_path = self._generated_tests_samples_folder("generated_tests")
         general_serializer = TestGeneralSerializer(code_model=self.code_model, env=env)
         self.write_file(out_path / "conftest.py", general_serializer.serialize_conftest())
         if not self.code_model.options["azure-arm"]:

package/generator/build/lib/pygen/codegen/templates/macros.jinja2

@@ -2,7 +2,7 @@
 {# Check if this is a sphinx documentation line that should not have extra prefix spacing #}
 {%- set is_sphinx_doc = doc_string.strip().startswith(':ivar') or doc_string.strip().startswith(':vartype') or doc_string.strip().startswith(':param') or doc_string.strip().startswith(':type') -%}
 {# Custom handling for bullet points - normalization is now done in preprocessing #}
-{% set enable_custom_handling = "* " in doc_string %}
+{% set enable_custom_handling = "\n* " in doc_string or doc_string.startswith("* ") %}
 {%- if enable_custom_handling -%}
     {%- set lines = doc_string.split('\n') -%}
     {%- set result_lines = [] -%}

package/generator/build/lib/pygen/codegen/templates/model_dpg.py.jinja2

@@ -78,7 +78,7 @@
         if key in self.__flattened_items:
             if self.{{ flattened_property_attr }} is None:
                 self.{{ flattened_property_attr }} = self._attr_to_rest_field["{{ flattened_property_attr }}"]._class_type()
-            setattr(self.properties, key, value)
+            setattr(self.{{ flattened_property_attr }}, key, value)
         else:
             super().__setattr__(key, value)
         {% endif %}

package/generator/pygen/__init__.py

@@ -3,6 +3,7 @@
 # Licensed under the MIT License. See License.txt in the project root for
 # license information.
 # --------------------------------------------------------------------------
+import shutil
 from collections.abc import ItemsView, KeysView, MutableMapping, ValuesView
 import logging
 from pathlib import Path
@@ -39,6 +40,7 @@ class OptionsDict(MutableMapping):
         "validate-versioning": True,
         "version-tolerant": True,
         "generation-subdir": None,  # subdirectory to generate the code in
+        "clear-output-folder": False,  # whether to clear the output folder before generating code
     }
 
     def __init__(self, options: Optional[dict[str, Any]] = None) -> None:
@@ -248,9 +250,23 @@ class ReaderAndWriter:
         except FileNotFoundError:
             pass
 
+    def remove_folder(self, foldername: Union[str, Path]) -> None:
+        try:
+            folder_path = self.output_folder / Path(foldername)
+            if folder_path.exists() and folder_path.is_dir():
+                shutil.rmtree(folder_path)
+        except FileNotFoundError:
+            pass
+
     def list_file(self) -> list[str]:
         return [str(f.relative_to(self.output_folder)) for f in self.output_folder.glob("**/*") if f.is_file()]
 
+    def list_file_of_folder(self, foldername: Union[str, Path]) -> list[str]:
+        folder_path = self.output_folder / Path(foldername)
+        if folder_path.exists() and folder_path.is_dir():
+            return [str(f.relative_to(self.output_folder)) for f in folder_path.glob("**/*") if f.is_file()]
+        return []
+
 
 class Plugin(ReaderAndWriter, ABC):
     """A base class for autorest plugin.

package/generator/pygen/codegen/serializers/__init__.py

@@ -122,7 +122,21 @@ class JinjaSerializer(ReaderAndWriter):
             # If parsing the version fails, we assume the version file is not valid and overwrite.
             return False
 
+    # pylint: disable=too-many-branches
     def serialize(self) -> None:
+        # remove existing folders when generate from tsp
+        if self.code_model.is_tsp and self.code_model.options.get("clear-output-folder"):
+            # remove generated_samples and generated_tests folder
+            self.remove_folder(self._generated_tests_samples_folder("generated_samples"))
+            self.remove_folder(self._generated_tests_samples_folder("generated_tests"))
+
+            # remove generated sdk files
+            generation_path = self.code_model.get_generation_dir(self.code_model.namespace)
+            for file in self.list_file_of_folder(generation_path):
+                if file.endswith(".py") and "_patch.py" not in file:
+                    self.remove_file(file)
+
+        # serialize logic
         env = Environment(
             loader=PackageLoader("pygen.codegen", "templates"),
             keep_trailing_newline=True,
@@ -519,8 +533,11 @@ class JinjaSerializer(ReaderAndWriter):
             return Path("/".join(namespace_config.split(".")[num_of_package_namespace:]))
         return Path("")
 
+    def _generated_tests_samples_folder(self, folder_name: str) -> Path:
+        return self._root_of_sdk / folder_name
+
     def _serialize_and_write_sample(self, env: Environment):
-        out_path = self._root_of_sdk / "generated_samples"
+        out_path = self._generated_tests_samples_folder("generated_samples")
         for client in self.code_model.clients:
             for op_group in client.operation_groups:
                 for operation in op_group.operations:
@@ -549,7 +566,7 @@ class JinjaSerializer(ReaderAndWriter):
 
     def _serialize_and_write_test(self, env: Environment):
         self.code_model.for_test = True
-        out_path = self._root_of_sdk / "generated_tests"
+        out_path = self._generated_tests_samples_folder("generated_tests")
         general_serializer = TestGeneralSerializer(code_model=self.code_model, env=env)
         self.write_file(out_path / "conftest.py", general_serializer.serialize_conftest())
         if not self.code_model.options["azure-arm"]:

package/generator/pygen/codegen/templates/macros.jinja2

@@ -2,7 +2,7 @@
 {# Check if this is a sphinx documentation line that should not have extra prefix spacing #}
 {%- set is_sphinx_doc = doc_string.strip().startswith(':ivar') or doc_string.strip().startswith(':vartype') or doc_string.strip().startswith(':param') or doc_string.strip().startswith(':type') -%}
 {# Custom handling for bullet points - normalization is now done in preprocessing #}
-{% set enable_custom_handling = "* " in doc_string %}
+{% set enable_custom_handling = "\n* " in doc_string or doc_string.startswith("* ") %}
 {%- if enable_custom_handling -%}
     {%- set lines = doc_string.split('\n') -%}
     {%- set result_lines = [] -%}

package/generator/pygen/codegen/templates/model_dpg.py.jinja2

@@ -78,7 +78,7 @@
         if key in self.__flattened_items:
             if self.{{ flattened_property_attr }} is None:
                 self.{{ flattened_property_attr }} = self._attr_to_rest_field["{{ flattened_property_attr }}"]._class_type()
-            setattr(self.properties, key, value)
+            setattr(self.{{ flattened_property_attr }}, key, value)
         else:
             super().__setattr__(key, value)
         {% endif %}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@autorest/python",
-  "version": "6.41.4",
+  "version": "6.42.1",
   "description": "The Python extension for generators in AutoRest.",
   "main": "index.js",
   "repository": {
@@ -19,7 +19,7 @@
   },
   "homepage": "https://github.com/Azure/autorest.python/blob/main/README.md",
   "dependencies": {
-    "@typespec/http-client-python": "~0.19.2",
+    "@typespec/http-client-python": "~0.20.2",
     "@autorest/system-requirements": "~1.0.2",
     "fs-extra": "~11.2.0",
     "tsx": "~4.19.1"