Update license header comments block for PEP8 (Azure#1333)

* Remove UTF-8 BOM

* Update comment blocks for license headers

bin/extract-loc.py

@@ -1,8 +1,8 @@
 #! /usr/bin/env python3
-#---------------------------------------------------------------------------------------------
+# --------------------------------------------------------------------------------------------
 # Copyright (c) Microsoft Corporation. All rights reserved.
 # Licensed under the MIT License. See License.txt in the project root for license information.
-#---------------------------------------------------------------------------------------------
+# --------------------------------------------------------------------------------------------
 
 import os
 import re

doc/authoring_command_modules/example_module_template/azure/__init__.py

@@ -1,6 +1,6 @@
-#---------------------------------------------------------------------------------------------
+# --------------------------------------------------------------------------------------------
 # Copyright (c) Microsoft Corporation. All rights reserved.
 # Licensed under the MIT License. See License.txt in the project root for license information.
-#---------------------------------------------------------------------------------------------
+# --------------------------------------------------------------------------------------------
 import pkg_resources
 pkg_resources.declare_namespace(__name__)

doc/authoring_command_modules/example_module_template/azure/cli/__init__.py

@@ -1,6 +1,6 @@
-#---------------------------------------------------------------------------------------------
+# --------------------------------------------------------------------------------------------
 # Copyright (c) Microsoft Corporation. All rights reserved.
 # Licensed under the MIT License. See License.txt in the project root for license information.
-#---------------------------------------------------------------------------------------------
+# --------------------------------------------------------------------------------------------
 import pkg_resources
 pkg_resources.declare_namespace(__name__)

doc/authoring_command_modules/example_module_template/azure/cli/command_modules/__init__.py

@@ -1,6 +1,6 @@
-#---------------------------------------------------------------------------------------------
+# --------------------------------------------------------------------------------------------
 # Copyright (c) Microsoft Corporation. All rights reserved.
 # Licensed under the MIT License. See License.txt in the project root for license information.
-#---------------------------------------------------------------------------------------------
+# --------------------------------------------------------------------------------------------
 import pkg_resources
 pkg_resources.declare_namespace(__name__)

doc/authoring_command_modules/example_module_template/azure/cli/command_modules/example/__init__.py

@@ -1,7 +1,7 @@
-#---------------------------------------------------------------------------------------------
+# --------------------------------------------------------------------------------------------
 # Copyright (c) Microsoft Corporation. All rights reserved.
 # Licensed under the MIT License. See License.txt in the project root for license information.
-#---------------------------------------------------------------------------------------------
+# --------------------------------------------------------------------------------------------
 # Add command module logic to this package.
 
 from azure.cli.commands import cli_command

doc/authoring_command_modules/example_module_template/setup.py

@@ -1,8 +1,8 @@
 #!/usr/bin/env python
-#---------------------------------------------------------------------------------------------
+# --------------------------------------------------------------------------------------------
 # Copyright (c) Microsoft Corporation. All rights reserved.
 # Licensed under the MIT License. See License.txt in the project root for license information.
-#---------------------------------------------------------------------------------------------
+# --------------------------------------------------------------------------------------------
 
 from codecs import open
 from setuptools import setup

doc/sphinx/azhelpgen/__init__.py

@@ -1,6 +1,6 @@
-#---------------------------------------------------------------------------------------------
+# --------------------------------------------------------------------------------------------
 # Copyright (c) Microsoft Corporation. All rights reserved.
 # Licensed under the MIT License. See License.txt in the project root for license information.
-#---------------------------------------------------------------------------------------------
+# --------------------------------------------------------------------------------------------
 import pkg_resources
 pkg_resources.declare_namespace(__name__)

doc/sphinx/azhelpgen/azhelpgen.py

@@ -1,7 +1,7 @@
-#---------------------------------------------------------------------------------------------
+# --------------------------------------------------------------------------------------------
 # Copyright (c) Microsoft Corporation. All rights reserved.
 # Licensed under the MIT License. See License.txt in the project root for license information.
-#---------------------------------------------------------------------------------------------
+# --------------------------------------------------------------------------------------------
 
 import argparse
 import json

doc/sphinx/cligroup/__init__.py

@@ -1,6 +1,6 @@
-#---------------------------------------------------------------------------------------------
+# --------------------------------------------------------------------------------------------
 # Copyright (c) Microsoft Corporation. All rights reserved.
 # Licensed under the MIT License. See License.txt in the project root for license information.
-#---------------------------------------------------------------------------------------------
+# --------------------------------------------------------------------------------------------
 import pkg_resources
 pkg_resources.declare_namespace(__name__)

doc/sphinx/cligroup/cligroup.py

@@ -1,7 +1,7 @@
-#---------------------------------------------------------------------------------------------
+# --------------------------------------------------------------------------------------------
 # Copyright (c) Microsoft Corporation. All rights reserved.
 # Licensed under the MIT License. See License.txt in the project root for license information.
-#---------------------------------------------------------------------------------------------
+# --------------------------------------------------------------------------------------------
 import copy
 from docutils import nodes
 from sphinx import addnodes

doc/sphinx/conf.py

@@ -1,8 +1,8 @@
 #!/usr/bin/env python3
-#---------------------------------------------------------------------------------------------
+# --------------------------------------------------------------------------------------------
 # Copyright (c) Microsoft Corporation. All rights reserved.
 # Licensed under the MIT License. See License.txt in the project root for license information.
-#---------------------------------------------------------------------------------------------
+# --------------------------------------------------------------------------------------------
 # -*- coding: utf-8 -*-
 #
 # az documentation build configuration file, created by

scripts/_common.py

@@ -0,0 +1,28 @@
+#!/usr/bin/env python
+
+# --------------------------------------------------------------------------------------------
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License. See License.txt in the project root for license information.
+# --------------------------------------------------------------------------------------------
+
+# common utilities for scripts
+
+from __future__ import print_function
+
+
+def get_repo_root():
+    """
+    Returns the root path to this repository. The root is where .git folder is.
+    """
+    import os.path
+    here = os.path.dirname(os.path.realpath(__file__))
+
+    while not os.path.exists(os.path.join(here, '.git')):
+        here = os.path.dirname(here)
+
+    return here
+
+
+if __name__ == '__main__':
+    print(get_repo_root())
+

scripts/command_coverage.py

@@ -1,7 +1,7 @@
-#---------------------------------------------------------------------------------------------
+# --------------------------------------------------------------------------------------------
 # Copyright (c) Microsoft Corporation. All rights reserved.
 # Licensed under the MIT License. See License.txt in the project root for license information.
-#---------------------------------------------------------------------------------------------
+# --------------------------------------------------------------------------------------------
 
 from __future__ import print_function
 import os

scripts/command_modules/_common.py

@@ -1,7 +1,7 @@
-#---------------------------------------------------------------------------------------------
+# --------------------------------------------------------------------------------------------
 # Copyright (c) Microsoft Corporation. All rights reserved.
 # Licensed under the MIT License. See License.txt in the project root for license information.
-#---------------------------------------------------------------------------------------------
+# --------------------------------------------------------------------------------------------
 
 from __future__ import print_function
 import os

scripts/command_modules/_task.py

@@ -1,7 +1,7 @@
-#---------------------------------------------------------------------------------------------
+# --------------------------------------------------------------------------------------------
 # Copyright (c) Microsoft Corporation. All rights reserved.
 # Licensed under the MIT License. See License.txt in the project root for license information.
-#---------------------------------------------------------------------------------------------
+# --------------------------------------------------------------------------------------------
 
 from __future__ import print_function
 

scripts/command_modules/install.py

@@ -1,7 +1,7 @@
-#---------------------------------------------------------------------------------------------
+# --------------------------------------------------------------------------------------------
 # Copyright (c) Microsoft Corporation. All rights reserved.
 # Licensed under the MIT License. See License.txt in the project root for license information.
-#---------------------------------------------------------------------------------------------
+# --------------------------------------------------------------------------------------------
 
 ## Install the command modules using pip ##
 from __future__ import print_function

scripts/command_modules/package_verify.py

@@ -1,7 +1,7 @@
-#---------------------------------------------------------------------------------------------
+# --------------------------------------------------------------------------------------------
 # Copyright (c) Microsoft Corporation. All rights reserved.
 # Licensed under the MIT License. See License.txt in the project root for license information.
-#---------------------------------------------------------------------------------------------
+# --------------------------------------------------------------------------------------------
 
 ## Install the command modules using pip ##
 from __future__ import print_function

scripts/command_modules/test.py

@@ -1,7 +1,7 @@
-#---------------------------------------------------------------------------------------------
+# --------------------------------------------------------------------------------------------
 # Copyright (c) Microsoft Corporation. All rights reserved.
 # Licensed under the MIT License. See License.txt in the project root for license information.
-#---------------------------------------------------------------------------------------------
+# --------------------------------------------------------------------------------------------
 
 ## Run the tests for each command module ##
 

scripts/curl_install_pypi/install.py

@@ -1,9 +1,9 @@
 #!/usr/bin/env python
 
-#---------------------------------------------------------------------------------------------
+# --------------------------------------------------------------------------------------------
 # Copyright (c) Microsoft Corporation. All rights reserved.
 # Licensed under the MIT License. See License.txt in the project root for license information.
-#---------------------------------------------------------------------------------------------
+# --------------------------------------------------------------------------------------------
 
 #
 # This script will install the CLI into a directory and create an executable

scripts/curl_install_pypi/setup_completion.py

@@ -1,9 +1,9 @@
 #!/usr/bin/env python
 
-#---------------------------------------------------------------------------------------------
+# --------------------------------------------------------------------------------------------
 # Copyright (c) Microsoft Corporation. All rights reserved.
 # Licensed under the MIT License. See License.txt in the project root for license information.
-#---------------------------------------------------------------------------------------------
+# --------------------------------------------------------------------------------------------
 
 #
 # This script will set up tab completion for the Azure CLI.

scripts/dev_setup.py

@@ -1,9 +1,9 @@
 #!/usr/bin/env python
 
-#---------------------------------------------------------------------------------------------
+# --------------------------------------------------------------------------------------------
 # Copyright (c) Microsoft Corporation. All rights reserved.
 # Licensed under the MIT License. See License.txt in the project root for license information.
-#---------------------------------------------------------------------------------------------
+# --------------------------------------------------------------------------------------------
 
 from __future__ import print_function
 

scripts/dump_command_table.py

@@ -1,7 +1,7 @@
-#---------------------------------------------------------------------------------------------
+# --------------------------------------------------------------------------------------------
 # Copyright (c) Microsoft Corporation. All rights reserved.
 # Licensed under the MIT License. See License.txt in the project root for license information.
-#---------------------------------------------------------------------------------------------
+# --------------------------------------------------------------------------------------------
 
 from __future__ import print_function
 
@@ -131,4 +131,4 @@ def _dashed_to_camel(string):
 IGNORE_ARGS = ['help', 'help_file', 'base_type']
 
 APPLICATION.register(Application.COMMAND_PARSER_LOADED, _dump_command_table)
-APPLICATION.execute([])
+APPLICATION.execute([])

scripts/dump_help.py

@@ -1,7 +1,7 @@
-#---------------------------------------------------------------------------------------------
+# --------------------------------------------------------------------------------------------
 # Copyright (c) Microsoft Corporation. All rights reserved.
 # Licensed under the MIT License. See License.txt in the project root for license information.
-#---------------------------------------------------------------------------------------------
+# --------------------------------------------------------------------------------------------
 
 import argparse
 import json

scripts/generate_command_inventory.py

@@ -1,7 +1,7 @@
-#---------------------------------------------------------------------------------------------
+# --------------------------------------------------------------------------------------------
 # Copyright (c) Microsoft Corporation. All rights reserved.
 # Licensed under the MIT License. See License.txt in the project root for license information.
-#---------------------------------------------------------------------------------------------
+# --------------------------------------------------------------------------------------------
 
 import argparse
 import json
@@ -50,4 +50,4 @@ def default(self, o):#pylint: disable=method-hidden
 heading = '=== COMMANDS IN {} PACKAGE(S) WITH {} PARAMETERS ==='.format(
     cmd_set_names or 'ANY', param_names or 'ANY')
 print('\n{}\n'.format(heading))
-print('\n'.join(results))
+print('\n'.join(results))

scripts/license/_common.py

@@ -1,19 +1,24 @@
-#---------------------------------------------------------------------------------------------
+# --------------------------------------------------------------------------------------------
 # Copyright (c) Microsoft Corporation. All rights reserved.
 # Licensed under the MIT License. See License.txt in the project root for license information.
-#---------------------------------------------------------------------------------------------
+# --------------------------------------------------------------------------------------------
 
 import os
 
 ROOT_DIR = os.path.abspath(os.path.join(os.path.dirname(os.path.realpath(__file__)), '..', '..'))
 
 PY_LICENSE_HEADER = \
-"""#---------------------------------------------------------------------------------------------
+"""# --------------------------------------------------------------------------------------------
 # Copyright (c) Microsoft Corporation. All rights reserved.
 # Licensed under the MIT License. See License.txt in the project root for license information.
-#---------------------------------------------------------------------------------------------
+# --------------------------------------------------------------------------------------------
 """
 
+env_folders = [
+    os.path.join(ROOT_DIR, 'env'),
+    os.path.join(ROOT_DIR, 'package-verify-env')
+]
+
 def contains_header(text):
     return PY_LICENSE_HEADER in text
 
@@ -23,6 +28,10 @@ def has_shebang(text):
 def get_files_without_header():
     files_without_header = []
     for current_dir, _, files in os.walk(ROOT_DIR):
+        # skip folders generated by virtual env
+        if any(d for d in env_folders if d in current_dir):
+            continue
+
         for a_file in files:
             if a_file.endswith('.py'):
                 cur_file_path = os.path.join(current_dir, a_file)

scripts/license/add.py

@@ -1,7 +1,7 @@
-#---------------------------------------------------------------------------------------------
+# --------------------------------------------------------------------------------------------
 # Copyright (c) Microsoft Corporation. All rights reserved.
 # Licensed under the MIT License. See License.txt in the project root for license information.
-#---------------------------------------------------------------------------------------------
+# --------------------------------------------------------------------------------------------
 
 # Add license header to every *.py file in the repo.  Can be run multiple times without duplicating the headers.
 

scripts/license/verify.py

@@ -1,7 +1,7 @@
-#---------------------------------------------------------------------------------------------
+# --------------------------------------------------------------------------------------------
 # Copyright (c) Microsoft Corporation. All rights reserved.
 # Licensed under the MIT License. See License.txt in the project root for license information.
-#---------------------------------------------------------------------------------------------
+# --------------------------------------------------------------------------------------------
 
 # Verify that all *.py files have a license header in the file.
 

scripts/nightly/nightly-build.py

@@ -1,7 +1,7 @@
-#---------------------------------------------------------------------------------------------
+# --------------------------------------------------------------------------------------------
 # Copyright (c) Microsoft Corporation. All rights reserved.
 # Licensed under the MIT License. See License.txt in the project root for license information.
-#---------------------------------------------------------------------------------------------
+# --------------------------------------------------------------------------------------------
 
 ## Install the command modules using pip ##
 from __future__ import print_function