@autorest/python 5.14.0 → 5.17.0

package/ChangeLog.md

@@ -1,5 +1,94 @@
 # Change Log
 
+### 2022-06-02 - 5.17.0
+
+| Library                                                                 | Min Version |
+| ----------------------------------------------------------------------- | ----------- |
+| `@autorest/core`                                                        | `3.8.1`     |
+| `@autorest/modelerfour`                                                 | `4.23.5`    |
+| `azure-core` dep of generated code                                      | `1.23.0`    |
+| `msrest` dep of generated code                                          | `0.6.21`    |
+| `azure-mgmt-core` dep of generated code (If generating mgmt plane code) | `1.3.0`     |
+
+**New Features**
+
+- Hide `api_version` in doc string for singleapi SDK even if contains multi api versions  #1239
+- Add overloads for operations with different body types. We now sniff bodies and assign content type based off of body type.  #1230
+- Add flag `--postprocess`. Run this after doing customizations for full mypy support
+
+**Breaking Changes in Version Tolerant**
+
+- Have stream responses directly return an iterator of bytes, so you don't need to call `.iter_bytes()` on the response object.  #1254
+- If generating with `--models-mode=msrest` in version tolerant, we hide paging models  #1259
+
+**Breaking Changes in Request Builders**
+
+- Request builders for LRO operations have the `_initial` suffix removed from their name  #1241
+- Request builders from groups with reserved words will now be padded with the word "Operations" instead of "Builders"  #1243
+
+**Bug Fixes**
+
+- Make sure `any-object` schemas from swagger are typed with `MutableMapping`s  #1243
+- Make typing for parameters `Optional` only if `None` is a valid input, not only if it is specified as `optional` in swagger  #1244
+- Fix for render failure of `README.md` when `--package-mode==dataplane` #1247
+- Fix typing for stream responses to iterators of bytes.  #1254
+- Additional linting support  #1265
+- Fix Sphinx documentation for raised exception #1264
+- Use `api_version` in `_config` as default value for operation function  #1268
+
+**Other Changes**
+
+- Update template files for `--package-mode` # 1248
+
+### 2022-04-18 - 5.16.0
+
+| Library                                                                 | Min Version |
+| ----------------------------------------------------------------------- | ----------- |
+| `@autorest/core`                                                        | `3.6.2`     |
+| `@autorest/modelerfour`                                                 | `4.19.1`    |
+| `azure-core` dep of generated code                                      | `1.23.0`    |
+| `msrest` dep of generated code                                          | `0.6.21`    |
+| `azure-mgmt-core` dep of generated code (If generating mgmt plane code) | `1.3.0`     |
+
+**Breaking Changes in Version Tolerant Generation**
+
+- We no longer generate operations for operations with multipart or urlencoded bodies. SDK writers must implement these operations in their customized patch file. See https://aka.ms/azsdk/python/dpcodegen/python/customize for how to customize generated code #1223
+
+**Bug Fixes**
+
+- Drop package dependency on "@azure-tools/extension", switch to "@autorest/system-requirements" #1229
+- Fix `content_type` generation in multiapi SDKs with multiple content types for bodies #1232
+
+### 2022-04-07 - 5.15.0
+
+| Library                                                                 | Min Version |
+| ----------------------------------------------------------------------- | ----------- |
+| `@autorest/core`                                                        | `3.6.2`     |
+| `@autorest/modelerfour`                                                 | `4.19.1`    |
+| `azure-core` dep of generated code                                      | `1.23.0`    |
+| `msrest` dep of generated code                                          | `0.6.21`    |
+| `azure-mgmt-core` dep of generated code (If generating mgmt plane code) | `1.3.0`     |
+
+**New Features**
+
+- Add support for security configurations in the swagger. For more information, see https://github.com/Azure/autorest/blob/main/docs/generate/authentication.md #1161
+- Add support for handwritten customizations of generated code. For more information, see https://aka.ms/azsdk/python/dpcodegen/python/customize #1153
+- Allow `header` and `params` as kwargs in operation and request-build function to hand over REST Header and Query parameters case insensitively #1183
+- Typing operation parameters as JSON, Primitives or Any for `--version-tolerant` #1210
+
+**Bug Fixes**
+
+- Make `--version-tolerant` generated code mypy compatible in the `azure-sdk-for-python` repo. Tested only with the `--black` flag #1185
+- Remove unnecessary vendored code in the `_vendor` file if the SDK has no operations #1196
+- Fix the generation of the root `__init__` files for packages with only models #1195
+- Add pylint and mypy support for `--version-tolerant` generations with `--models-mode=msrest` #1202
+
+**Breaking Changes in Version Tolerant Generation**
+
+- Change client filenames to `_client.py` #1206
+- Change the models filename from `_models_py3.py` to `_models.py` #1204
+- Change the enums filename to `_enums.py` #1204
+
 ### 2022-03-08 - 5.14.0
 
 | Library                                                                 | Min Version |
@@ -667,7 +756,7 @@ Modelerfour version: 4.13.351
 **Bug Fixes**
 
 - Corrected ordering of summary and description in generated methods #640
-- Have `IOSchema` call super init to get all of the properties shared in `BaseSchema` #642
+- Have `IOSchema` call super init to get all of the properties shared in `BaseType` #642
 
 ### 2020-05-15 - 5.0.0-preview.7
 
@@ -812,7 +901,7 @@ Modelerfour version: 4.12.276
 
 - Will no longer permit generated enums and models to have the same name #504
 - No longer exposing models from operation groups without importing them #486
-- Now correctly deserializes error's that have an empty object (AnySchema) as a model #516
+- Now correctly deserializes error's that have an empty object (AnyType) as a model #516
 - Added a list of parameter names to reserved parameter words, so there won't be clashes #525
 - If a property's schema is readonly, we will show that property as being readonly (taken from m4 update #234)
 - Remove `"azure-"` prefix from user agent name #523

package/README.md

@@ -30,13 +30,17 @@ modelerfour:
   flatten-payloads: true
 ```
 
+```yaml $(postprocess)
+allow-no-input: true
+```
+
 ```yaml !$(multiapiscript)
 pass-thru:
   - model-deduplicator
   - subset-reducer
-version: ~3.6.2
+version: ~3.8.1
 use-extension:
-  "@autorest/modelerfour": ~4.19.1
+  "@autorest/modelerfour": ~4.23.5
 
 modelerfour:
   resolve-schema-name-collisons: true
@@ -69,11 +73,14 @@ pipeline:
   python/m2r:
     input: python
 
-  python/namer:
+  python/m4reformatter:
     input: python/m2r
 
+  python/preprocess:
+    input: python/m4reformatter
+
   python/codegen:
-    input: python/namer
+    input: python/preprocess
     output-artifact: python-files
 
   python/codegen/emitter:
@@ -126,6 +133,25 @@ scope-black/emitter:
 output-artifact: python-files
 ```
 
+# Post-process customized code for mypy pipeline
+
+```yaml $(postprocess)
+pipeline:
+  python/postprocess:
+    scope: postprocess
+    output-artifact: python-files
+
+  python/postprocess/emitter:
+    input: postprocess
+    scope: scope-postprocess/emitter
+
+scope-postprocess/emitter:
+  input-artifact: python-files
+  output-uri-expr: $key
+
+output-artifact: python-files
+```
+
 # Help
 
 ```yaml

package/autorest/__init__.py

@@ -38,8 +38,7 @@ class Plugin(ABC):
 
 
 class YamlUpdatePlugin(Plugin):
-    """A plugin that update the YAML as input.
-    """
+    """A plugin that update the YAML as input."""
 
     def process(self) -> bool:
         # List the input file, should be only one
@@ -62,7 +61,7 @@ class YamlUpdatePlugin(Plugin):
     def update_yaml(self, yaml_data: Dict[str, Any]) -> None:
         """The code-model-v4-no-tags yaml model tree.
 
-        :rtype: None
+        :rtype: updated yaml
         :raises Exception: Could raise any exception, stacktrace will be sent to autorest API
         """
         raise NotImplementedError()

package/autorest/black/__init__.py

@@ -15,20 +15,25 @@ _LOGGER = logging.getLogger(__name__)
 _BLACK_MODE = black.Mode()
 _BLACK_MODE.line_length = 120
 
-class BlackScriptPlugin(Plugin):
 
+class BlackScriptPlugin(Plugin):
     def __init__(self, autorestapi):
-        super(BlackScriptPlugin, self).__init__(autorestapi)
+        super().__init__(autorestapi)
         output_folder_uri = self._autorestapi.get_value("outputFolderUri")
         if output_folder_uri.startswith("file:"):
             output_folder_uri = output_folder_uri[5:]
-        if os.name == 'nt' and output_folder_uri.startswith("///"):
+        if os.name == "nt" and output_folder_uri.startswith("///"):
             output_folder_uri = output_folder_uri[3:]
         self.output_folder = Path(output_folder_uri)
 
     def process(self) -> bool:
         # apply format_file on every file in the output folder
-        list(map(self.format_file, [f for f in self.output_folder.glob('**/*') if f.is_file()]))
+        list(
+            map(
+                self.format_file,
+                [f for f in self.output_folder.glob("**/*") if f.is_file()],
+            )
+        )
         return True
 
     def format_file(self, full_path) -> None:
@@ -38,7 +43,9 @@ class BlackScriptPlugin(Plugin):
             self._autorestapi.write_file(file, file_content)
             return
         try:
-            file_content = black.format_file_contents(file_content, fast=True, mode=_BLACK_MODE)
+            file_content = black.format_file_contents(
+                file_content, fast=True, mode=_BLACK_MODE
+            )
         except black.NothingChanged:
             pass
         self._autorestapi.write_file(file, file_content)