azdev 0.1.95__tar.gz → 0.1.97__tar.gz

{azdev-0.1.95 → azdev-0.1.97}/HISTORY.rst

@@ -2,6 +2,17 @@
 
 Release History
 ===============
+0.1.97
+++++++
+* `azdev generate-breaking-change-report`: Add `--include-whl-extensions` to support extensions installed through wheel.
+* `azdev command-change tree-export`: Add `--include-whl-extensions` to support extensions installed through wheel.
+* `azdev generate-breaking-change-report`: Support collecting Breaking Change items from CLI core.
+* `azdev generate-breaking-change-report`: Support trim the last newline in output with `--no-tail`.
+
+0.1.96
+++++++
+* `azdev generate-breaking-change-report`: Add `--no-head` and `--no-tail` to support trim header and tail in markdown report.
+
 0.1.95
 ++++++
 * `azdev generate-breaking-change-report`: Extracts upcoming breaking changes in extensions, regardless of the target version set

{azdev-0.1.95/azdev.egg-info → azdev-0.1.97}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.2
+Metadata-Version: 2.4
 Name: azdev
-Version: 0.1.95
+Version: 0.1.97
 Summary: Microsoft Azure CLI Developer Tools
 Home-page: https://github.com/Azure/azure-cli-dev-tools
 Author: Microsoft Corporation
@@ -40,7 +40,7 @@ Requires-Dist: azure-cli-diff-tool~=0.0.6
 Requires-Dist: packaging
 Requires-Dist: tqdm
 Requires-Dist: wheel==0.30.0
-Requires-Dist: microsoft-security-utilities-secret-masker~=1.0.0b2
+Requires-Dist: microsoft-security-utilities-secret-masker~=1.0.0b4
 Dynamic: author
 Dynamic: author-email
 Dynamic: classifier
@@ -48,6 +48,7 @@ Dynamic: description
 Dynamic: home-page
 Dynamic: keywords
 Dynamic: license
+Dynamic: license-file
 Dynamic: requires-dist
 Dynamic: requires-python
 Dynamic: summary
@@ -158,6 +159,17 @@ License
 
 Release History
 ===============
+0.1.97
+++++++
+* `azdev generate-breaking-change-report`: Add `--include-whl-extensions` to support extensions installed through wheel.
+* `azdev command-change tree-export`: Add `--include-whl-extensions` to support extensions installed through wheel.
+* `azdev generate-breaking-change-report`: Support collecting Breaking Change items from CLI core.
+* `azdev generate-breaking-change-report`: Support trim the last newline in output with `--no-tail`.
+
+0.1.96
+++++++
+* `azdev generate-breaking-change-report`: Add `--no-head` and `--no-tail` to support trim header and tail in markdown report.
+
 0.1.95
 ++++++
 * `azdev generate-breaking-change-report`: Extracts upcoming breaking changes in extensions, regardless of the target version set

{azdev-0.1.95 → azdev-0.1.97}/azdev/__init__.py

@@ -4,4 +4,4 @@
 # license information.
 # -----------------------------------------------------------------------------
 
-__VERSION__ = '0.1.95'
+__VERSION__ = '0.1.97'

{azdev-0.1.95 → azdev-0.1.97}/azdev/operations/breaking_change/__init__.py

@@ -224,10 +224,12 @@ def _handle_module(module, loader, source):
     start = time.time()
 
     for command, command_info in loader.command_table.items():
-        yield from _handle_command_breaking_changes(module, command, command_info, source)
+        if command:
+            yield from _handle_command_breaking_changes(module, command, command_info, source)
 
     for command_group_name, command_group in loader.command_group_table.items():
-        yield from _handle_command_group_breaking_changes(module, command_group_name, command_group, source)
+        if command_group_name:
+            yield from _handle_command_group_breaking_changes(module, command_group_name, command_group, source)
 
     stop = time.time()
     logger.info('Module %s finished in %i sec', module, stop - start)
@@ -244,7 +246,8 @@ def _handle_core(source):
         except ImportError:
             pass
 
-        yield from _handle_custom_breaking_changes('core', 'core')
+        yield from _handle_custom_breaking_changes('core', '')
+        yield from _handle_custom_breaking_changes('core', '_core')
 
     stop = time.time()
     logger.info('Core finished in %i sec', stop - start)
@@ -304,7 +307,8 @@ def _group_breaking_change_items(iterator, group_by_version=False):
 
 
 def collect_upcoming_breaking_changes(modules=None, target_version='NextWindow', source=None, group_by_version=None,
-                                      output_format='structure'):
+                                      output_format='structure', no_head=False, no_tail=False,
+                                      include_whl_extensions=False):
     if target_version == 'NextWindow':
         from azure.cli.core.breaking_change import NEXT_BREAKING_CHANGE_RELEASE
         target_version = NEXT_BREAKING_CHANGE_RELEASE
@@ -313,7 +317,7 @@ def collect_upcoming_breaking_changes(modules=None, target_version='NextWindow',
 
     require_azure_cli()
 
-    selected_modules = calc_selected_modules(modules)
+    selected_modules = calc_selected_modules(modules, include_whl_extensions=include_whl_extensions)
     cli_mod_names = list(selected_modules['core'].keys()) + list(selected_modules['mod'].keys())
     ext_mod_names = list(selected_modules['ext'].keys())
 
@@ -339,5 +343,9 @@ def collect_upcoming_breaking_changes(modules=None, target_version='NextWindow',
         env = Environment(loader=PackageLoader('azdev', 'operations/breaking_change'),
                           trim_blocks=True)
         template = env.get_template('markdown_template.jinja2')
-        output(template.render({'module_bc': breaking_changes}))
+        output(template.render({
+            'module_bc': breaking_changes,
+            'no_head': no_head,
+            'no_tail': no_tail,
+        }), end='' if no_tail else '\n')
     return None

{azdev-0.1.95 → azdev-0.1.97}/azdev/operations/breaking_change/markdown_template.jinja2

@@ -1,12 +1,14 @@
+{% if not no_head -%}
 # Upcoming breaking changes in Azure CLI
 
 The breaking changes listed in this article are planned for the next major release of the Azure CLI unless otherwise noted. Per our [Support lifecycle](./azure-cli-support-lifecycle.md), breaking changes in Azure CLI Core reference groups occur twice a year.
 
+{% endif -%}
 {% for module, command_bc in module_bc.items() -%}
 ## {{ module }}
 
 {% for command, multi_version_bcs in command_bc.items() -%}
-{% if not (module == 'core' and command == 'core') -%}
+{% if not module == 'core' -%}
 ### `{{ command }}`
 
 {% endif -%}
@@ -16,7 +18,7 @@ The breaking changes listed in this article are planned for the next major relea
 {% endif -%}
 {% if multi_version_bcs['items'] is mapping -%}
 {% for version, bcs in multi_version_bcs['items'] | dictsort -%}
-###{%- if not (module == 'core' and command == 'core') -%}#{%- endif %} Deprecated in {{ version }}
+###{%- if not module == 'core' -%}#{%- endif %} Deprecated in {{ version }}
 
 {% for bc in bcs -%}
 - {{ bc.detail }}
@@ -32,6 +34,7 @@ The breaking changes listed in this article are planned for the next major relea
 {% endif -%}
 {% endfor -%}
 {% endfor -%}
-
+{% if not no_tail %}
 > [!NOTE]
-> This article provides information on upcoming breaking changes. For previously published breaking changes, see [Azure CLI release notes](./release-notes-azure-cli.md).
+> This article provides information on upcoming breaking changes. For previously published breaking changes, see [Azure CLI release notes](./release-notes-azure-cli.md).
+{%- endif -%}

{azdev-0.1.95 → azdev-0.1.97}/azdev/operations/command_change/__init__.py

@@ -143,10 +143,10 @@ def cmp_command_meta(base_meta_file, diff_meta_file, only_break=False, output_ty
     return azure_cli_diff_tool.meta_diff(base_meta_file, diff_meta_file, only_break, output_type, output_file)
 
 
-def export_command_tree(modules, output_file=None):
+def export_command_tree(modules, output_file=None, include_whl_extensions=False):
     require_azure_cli()
 
-    selected_mod_names = calc_selected_mod_names(modules)
+    selected_mod_names = calc_selected_mod_names(modules, include_whl_extensions=include_whl_extensions)
 
     if selected_mod_names:
         display('Modules selected: {}\n'.format(', '.join(selected_mod_names)))

{azdev-0.1.95 → azdev-0.1.97}/azdev/operations/linter/rules/command_group_rules.py

@@ -54,12 +54,16 @@ def disallowed_html_tag_from_command_group(linter, command_group_name):
                                                                              linter.diffed_lines)):
         raise RuleError("Disallowed html tags {} in short summary. "
                         "If the content is a placeholder, please remove <> or wrap it with backtick. "
+                        "For example: 1) <Name>-res.yaml -> `<Name>-res.yaml`; "
+                        "2) http://<URL>:<PORT> -> `http://<URL>:<PORT>`. "
                         "For more info please refer to: {}".format(disallowed_tags,
                                                                    DISALLOWED_HTML_TAG_RULE_LINK))
     if help_entry.long_summary and (disallowed_tags := has_illegal_html_tag(help_entry.long_summary,
                                                                             linter.diffed_lines)):
         raise RuleError("Disallowed html tags {} in long summary. "
                         "If content is a placeholder, please remove <> or wrap it with backtick. "
+                        "For example: 1) <Name>-res.yaml -> `<Name>-res.yaml`; "
+                        "2) http://<URL>:<PORT> -> `http://<URL>:<PORT>`. "
                         "For more info please refer to: {}".format(disallowed_tags,
                                                                    DISALLOWED_HTML_TAG_RULE_LINK))
 

{azdev-0.1.95 → azdev-0.1.97}/azdev/operations/linter/rules/command_rules.py

@@ -49,12 +49,16 @@ def disallowed_html_tag_from_command(linter, command_name):
                                                                              linter.diffed_lines)):
         raise RuleError("Disallowed html tags {} in short summary. "
                         "If the content is a placeholder, please remove <> or wrap it with backtick. "
+                        "For example: 1) <Name>-res.yaml -> `<Name>-res.yaml`; "
+                        "2) http://<URL>:<PORT> -> `http://<URL>:<PORT>`. "
                         "For more info please refer to: {}".format(disallowed_tags,
                                                                    DISALLOWED_HTML_TAG_RULE_LINK))
     if help_entry.long_summary and (disallowed_tags := has_illegal_html_tag(help_entry.long_summary,
                                                                             linter.diffed_lines)):
         raise RuleError("Disallowed html tags {} in long summary. "
                         "If content is a placeholder, please remove <> or wrap it with backtick. "
+                        "For example: 1) <Name>-res.yaml -> `<Name>-res.yaml`; "
+                        "2) http://<URL>:<PORT> -> `http://<URL>:<PORT>`. "
                         "For more info please refer to: {}".format(disallowed_tags,
                                                                    DISALLOWED_HTML_TAG_RULE_LINK))
 

{azdev-0.1.95 → azdev-0.1.97}/azdev/operations/linter/rules/parameter_rules.py

@@ -183,6 +183,8 @@ def disallowed_html_tag_from_parameter(linter, command_name, parameter_name):
                                                                              linter.diffed_lines)):
         raise RuleError("Disallowed html tags {} in short summary. "
                         "If the content is a placeholder, please remove <> or wrap it with backtick. "
+                        "For example: 1) <Name>-res.yaml -> `<Name>-res.yaml`; "
+                        "2) http://<URL>:<PORT> -> `http://<URL>:<PORT>`. "
                         "For more info please refer to: {}".format(disallowed_tags,
                                                                    DISALLOWED_HTML_TAG_RULE_LINK))
 
@@ -190,6 +192,8 @@ def disallowed_html_tag_from_parameter(linter, command_name, parameter_name):
                                                                             linter.diffed_lines)):
         raise RuleError("Disallowed html tags {} in long summary. "
                         "If content is a placeholder, please remove <> or wrap it with backtick. "
+                        "For example: 1) <Name>-res.yaml -> `<Name>-res.yaml`; "
+                        "2) http://<URL>:<PORT> -> `http://<URL>:<PORT>`. "
                         "For more info please refer to: {}".format(disallowed_tags,
                                                                    DISALLOWED_HTML_TAG_RULE_LINK))
 

{azdev-0.1.95 → azdev-0.1.97}/azdev/params.py

@@ -178,6 +178,8 @@ def load_arguments(self, _):
 
     with ArgumentsContext(self, 'command-change tree-export') as c:
         c.positional('modules', modules_type)
+        c.argument('include_whl_extensions', action='store_true',
+                   help="Allow running cmd loader on extensions installed by `az extension add --source xxx.whl`.")
         c.argument('output_file', help='command tree json file path to store')
 
     # region cmdcov
@@ -271,8 +273,12 @@ def load_arguments(self, _):
         c.argument('source', choices=['deprecate_info', 'pre_announce'], default='pre_announce',
                    help='The source of pre-announced breaking changes. `deprecate_info` represents all breaking changes '
                         'marked through `deprecation_info`; `pre_announce` represents the breaking changes announced in '
-                        '`breaking_change.py` file.')
+                        '`_breaking_change.py` file.')
         c.argument('group_by_version', action='store_true',
                    help='If specified, breaking changes would be grouped by their target version as well.')
         c.argument('output_format', choices=['structure', 'markdown'], default='structure',
                    help='Output format of the collected breaking changes.')
+        c.argument('no_head', action='store_true', help='Skip head when displaying as markdown.')
+        c.argument('no_tail', action='store_true', help='Skip tail when displaying as markdown.')
+        c.argument('include_whl_extensions', action='store_true',
+                   help="Allow scanning on extensions installed by `az extension add --source xxx.whl`.")

{azdev-0.1.95 → azdev-0.1.97}/azdev/utilities/display.py

@@ -12,9 +12,9 @@ def display(txt):
     print(txt, file=sys.stderr)
 
 
-def output(txt):
+def output(txt, **kwargs):
     """ Output to stdout """
-    print(txt, file=sys.stdout)
+    print(txt, file=sys.stdout, **kwargs)
 
 
 def heading(txt):

{azdev-0.1.95 → azdev-0.1.97}/azdev/utilities/path.py

@@ -265,14 +265,14 @@ def get_path_table(include_only=None, include_whl_extensions=False):
     return table
 
 
-def calc_selected_modules(modules=None):
+def calc_selected_modules(modules=None, include_whl_extensions=False):
     # allow user to run only on CLI or extensions
     cli_only = modules == ['CLI']
     ext_only = modules == ['EXT']
     if cli_only or ext_only:
         modules = None
 
-    selected_modules = get_path_table(include_only=modules)
+    selected_modules = get_path_table(include_only=modules, include_whl_extensions=include_whl_extensions)
 
     if cli_only:
         selected_modules['ext'] = {}
@@ -283,8 +283,8 @@ def calc_selected_modules(modules=None):
     return selected_modules
 
 
-def calc_selected_mod_names(modules=None):
-    selected_modules = calc_selected_modules(modules)
+def calc_selected_mod_names(modules=None, include_whl_extensions=False):
+    selected_modules = calc_selected_modules(modules, include_whl_extensions=include_whl_extensions)
 
     if not any(selected_modules.values()):
         logger.warning('No commands selected to check.')

{azdev-0.1.95 → azdev-0.1.97/azdev.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.2
+Metadata-Version: 2.4
 Name: azdev
-Version: 0.1.95
+Version: 0.1.97
 Summary: Microsoft Azure CLI Developer Tools
 Home-page: https://github.com/Azure/azure-cli-dev-tools
 Author: Microsoft Corporation
@@ -40,7 +40,7 @@ Requires-Dist: azure-cli-diff-tool~=0.0.6
 Requires-Dist: packaging
 Requires-Dist: tqdm
 Requires-Dist: wheel==0.30.0
-Requires-Dist: microsoft-security-utilities-secret-masker~=1.0.0b2
+Requires-Dist: microsoft-security-utilities-secret-masker~=1.0.0b4
 Dynamic: author
 Dynamic: author-email
 Dynamic: classifier
@@ -48,6 +48,7 @@ Dynamic: description
 Dynamic: home-page
 Dynamic: keywords
 Dynamic: license
+Dynamic: license-file
 Dynamic: requires-dist
 Dynamic: requires-python
 Dynamic: summary
@@ -158,6 +159,17 @@ License
 
 Release History
 ===============
+0.1.97
+++++++
+* `azdev generate-breaking-change-report`: Add `--include-whl-extensions` to support extensions installed through wheel.
+* `azdev command-change tree-export`: Add `--include-whl-extensions` to support extensions installed through wheel.
+* `azdev generate-breaking-change-report`: Support collecting Breaking Change items from CLI core.
+* `azdev generate-breaking-change-report`: Support trim the last newline in output with `--no-tail`.
+
+0.1.96
+++++++
+* `azdev generate-breaking-change-report`: Add `--no-head` and `--no-tail` to support trim header and tail in markdown report.
+
 0.1.95
 ++++++
 * `azdev generate-breaking-change-report`: Extracts upcoming breaking changes in extensions, regardless of the target version set

{azdev-0.1.95 → azdev-0.1.97}/azdev.egg-info/requires.txt

@@ -18,4 +18,4 @@ azure-cli-diff-tool~=0.0.6
 packaging
 tqdm
 wheel==0.30.0
-microsoft-security-utilities-secret-masker~=1.0.0b2
+microsoft-security-utilities-secret-masker~=1.0.0b4

{azdev-0.1.95 → azdev-0.1.97}/setup.py

@@ -87,7 +87,7 @@ setup(
         'packaging',
         'tqdm',
         'wheel==0.30.0',
-        'microsoft-security-utilities-secret-masker~=1.0.0b2'
+        'microsoft-security-utilities-secret-masker~=1.0.0b4'
     ],
     package_data={
         'azdev.config': ['*.*', 'cli_pylintrc', 'ext_pylintrc'],