1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445
|
import importlib
import inspect
import json
import logging
import glob
import os
import pkgutil
from pathlib import Path
import subprocess
import sys
import types
import tempfile
import re
from typing import Dict, Any, Optional, List, ForwardRef
# Because I'm subprocessing myself, I need to do weird thing as import.
try:
# If I'm started as a module __main__
from .venvtools import create_venv_with_package
except (ModuleNotFoundError, ImportError) as e:
# If I'm started by my main directly
from venvtools import create_venv_with_package
_LOGGER = logging.getLogger(__name__)
def parse_input(input_parameter):
"""From a syntax like package_name#submodule, build a package name
and complete module name.
"""
split_package_name = input_parameter.split("#")
package_name = split_package_name[0]
module_name = package_name.replace("-", ".")
if len(split_package_name) >= 2:
module_name = ".".join([module_name, split_package_name[1]])
return package_name, module_name
def create_empty_report():
return {"client": {}, "models": {"enums": {}, "exceptions": {}, "models": {}}, "operations": {}}
def is_model(model_cls: object, is_new_model: bool) -> bool:
return hasattr(model_cls, "_is_model" if is_new_model else "_attribute_map")
def create_report(module_name: str) -> Dict[str, Any]:
module_to_generate = importlib.import_module(module_name)
client_name = getattr(module_to_generate, "__all__")
report = create_empty_report()
try:
report["client"] = client_name
except:
report["client"] = []
# Look for models first
model_names = [model_name for model_name in module_to_generate.models.__all__ if model_name[0].isupper()]
is_new_model = hasattr(module_to_generate, "_model_base")
for model_name in model_names:
model_cls = getattr(module_to_generate.models, model_name)
if is_model(model_cls, is_new_model):
report["models"]["models"][model_name] = create_model_report(model_cls, is_new_model)
elif issubclass(model_cls, Exception): # If not, might be an exception
report["models"]["exceptions"][model_name] = create_model_report(model_cls, is_new_model)
else:
report["models"]["enums"][model_name] = create_model_report(model_cls, is_new_model)
# Look for operation groups
try:
operations_classes = [op_name for op_name in module_to_generate.operations.__all__ if op_name[0].isupper()]
except AttributeError:
# This guy has no "operations", this is possible (Cognitive Services). Just skip it then.
operations_classes = []
for op_name in operations_classes:
op_content = {"name": op_name}
op_cls = getattr(module_to_generate.operations, op_name)
for op_attr_name in dir(op_cls):
op_attr = getattr(op_cls, op_attr_name)
if isinstance(op_attr, types.FunctionType) and not op_attr_name.startswith("_"):
# Keep it
func_content = create_report_from_func(op_attr)
op_content.setdefault("functions", {})[op_attr_name] = func_content
report["operations"][op_name] = op_content
return report
def get_attr_map(model_cls: object, is_new_model: bool) -> Dict[str, Any]:
if is_new_model:
return getattr(model_cls(), "_attr_to_rest_field")
return getattr(model_cls, "_attribute_map")
def get_type_annotation(model_cls: object, attribute: str) -> List[str]:
# make sure to get the annotations from the base class
mros = model_cls.__mro__[:-3][::-1]
annotations = {
k: v
for mro_class in mros
if hasattr(mro_class, "__annotations__") # pylint: disable=no-member
for k, v in mro_class.__annotations__.items() # pylint: disable=no-member
}
attr_type = annotations.get(attribute)
type_list = getattr(attr_type, "__args__", [attr_type])
return sorted(
[
item.__forward_arg__.replace("_models.", "")
if isinstance(item, ForwardRef)
else getattr(item, "__name__", str(item))
for item in type_list
]
)
def get_type(model_cls: object, attribute: str, conf: Dict[str, Any], is_new_model: bool) -> str:
if is_new_model:
return " or ".join(filter(lambda x: x != "NoneType", get_type_annotation(model_cls, attribute)))
return conf["type"]
def _get_validation(model_cls: object, attribute: str) -> Dict[str, Any]:
return getattr(model_cls, "_validation", {}).get(attribute, {})
def is_required(model_cls: object, attribute: str, is_new_model: bool) -> bool:
if is_new_model:
return "NoneType" not in get_type_annotation(model_cls, attribute)
return _get_validation(model_cls, attribute).get("required", False)
def is_readonly(model_cls: object, attribute: str, is_new_model: bool) -> bool:
if is_new_model:
return getattr(getattr(model_cls, "_attr_to_rest_field").get(attribute), "_visibility") == ["read"]
return _get_validation(model_cls, attribute).get("readonly", False)
def create_model_report(model_cls: object, is_new_model: bool):
result = {
"name": model_cls.__name__,
}
# If _attribute_map, it's a model
if is_model(model_cls, is_new_model):
result["type"] = "Model"
for attribute, conf in get_attr_map(model_cls, is_new_model).items():
result.setdefault("parameters", {})[attribute] = {
"name": attribute,
"properties": {
"type": get_type(model_cls, attribute, conf, is_new_model),
"required": is_required(model_cls, attribute, is_new_model),
"readonly": is_readonly(model_cls, attribute, is_new_model),
},
}
elif issubclass(model_cls, Exception): # If not, might be an exception
result["type"] = "Exception"
else: # If not, it's an enum
result["type"] = "Enum"
result["values"] = list(model_cls.__members__)
return result
def create_report_from_func(function_attr):
func_content = {
"name": function_attr.__name__,
"metadata": getattr(function_attr, "metadata", {}),
"parameters": [],
}
signature = inspect.signature(function_attr)
for parameter_name in signature.parameters:
if parameter_name == "self":
continue
if parameter_name == "custom_headers":
break # We reach Autorest generic
parameter = signature.parameters[parameter_name]
func_content["parameters"].append(
{
"name": parameter.name,
"has_default_value": not (parameter.default is parameter.empty),
}
)
return func_content
# given an input of a name, we need to return the appropriate relative diff between the sdk_root and the actual package directory
def resolve_package_directory(package_name):
packages = [
os.path.dirname(p)
for p in (glob.glob("{}/setup.py".format(package_name)) + glob.glob("sdk/*/{}/setup.py".format(package_name)))
]
if len(packages) > 1:
print(
"There should only be a single package matched in either repository structure. The following were found: {}".format(
packages
)
)
sys.exit(1)
return packages[0]
def merge_report(report_paths):
"""Merge report on the given paths list."""
if len(report_paths) == 1:
raise ValueError("Doesn't make sense to merge a report if there is only one report....")
merged_report = create_empty_report()
for report in sorted(report_paths):
with open(report, "r") as report_fd:
report_json = json.load(report_fd)
merged_report["models"]["enums"].update(report_json["models"]["enums"])
merged_report["models"]["exceptions"].update(report_json["models"]["exceptions"])
merged_report["models"]["models"].update(report_json["models"]["models"])
merged_report["operations"].update(report_json["operations"])
merged_report["client"] = report_json["client"]
return merged_report
# find last version or last stable version
def select_versions(versions: List[str], last_pypi_stable: bool) -> List[str]:
versions.reverse()
if last_pypi_stable:
for version in versions:
if not re.search("[a-zA-Z]", version):
return [version]
_LOGGER.info(f"Do not find stable version during {versions}")
return [versions[0]]
return [versions[0]]
def main(
input_parameter: str,
version: Optional[str] = None,
no_venv: bool = False,
pypi: bool = False,
last_pypi: bool = False,
output: Optional[str] = None,
metadata_path: Optional[str] = None,
last_pypi_stable: bool = False,
):
output_msg = output if output else "default folder"
_LOGGER.info(
f"Building code report of {input_parameter} for version {version} in {output_msg} ({no_venv}/{pypi}/{last_pypi})"
)
package_name, module_name = parse_input(input_parameter)
path_to_package = resolve_package_directory(package_name)
output_filename = ""
result = []
if (version or pypi or last_pypi) and not no_venv:
if version:
versions = [version]
else:
_LOGGER.info(f"Download versions of {package_name} on PyPI")
from pypi_tools.pypi import PyPIClient
client = PyPIClient()
versions = [str(v) for v in client.get_ordered_versions(package_name)]
_LOGGER.info(f"Got {versions}")
if last_pypi:
_LOGGER.info(f"Only keep last PyPI version")
versions = select_versions(versions, last_pypi_stable)
for version in versions:
_LOGGER.info(f"Installing version {version} of {package_name} in a venv")
with create_venv_with_package(
[f"{package_name}=={version}"]
) as venv, tempfile.TemporaryDirectory() as temp_dir:
metadata_path = str(Path(temp_dir, f"metadata_{version}.json"))
args = [
venv.env_exe,
__file__,
"--no-venv",
"--version",
version,
"--metadata",
metadata_path,
input_parameter,
]
if output is not None:
args.append("--output=" + output)
try:
subprocess.check_call(args)
except subprocess.CalledProcessError:
# If it fail, just assume this version is too old to get an Autorest report
_LOGGER.warning(
f"Version {version} seems to be too old to build a report (probably not Autorest based)"
)
# Files have been written by the subprocess
with open(metadata_path, "r") as metadata_fd:
result.extend(json.load(metadata_fd)["reports_path"])
# Files have been written by the subprocess
return result
modules = find_autorest_generated_folder(module_name)
version = version or "latest"
output_folder = Path(path_to_package) / Path("code_reports") / Path(version)
output_folder.mkdir(parents=True, exist_ok=True)
for module_name in modules:
_LOGGER.info(f"Working on {module_name}")
report = create_report(module_name)
module_for_path = get_sub_module_part(package_name, module_name)
if module_for_path:
output_filename = output_folder / Path(module_for_path + ".json")
else:
if output is not None:
output_filename = output
else:
output_filename = output_folder / Path("report.json")
with open(output_filename, "w") as fd:
json.dump(report, fd, indent=2)
_LOGGER.info(f"Report written to {output_filename}")
result.append(str(output_filename))
if len(result) > 1:
merged_report = merge_report(result)
if output is not None:
output_filename = output
else:
output_filename = output_folder / Path("merged_report.json")
with open(output_filename, "w") as fd:
json.dump(merged_report, fd, indent=2)
_LOGGER.info(f"Merged report written to {output_filename}")
result = [str(output_filename)]
if metadata_path:
metadata = {"reports_path": result} # Prepare metadata
with open(metadata_path, "w") as metadata_fd:
_LOGGER.info(f"Writing metadata: {metadata}")
json.dump(metadata, metadata_fd)
return result
def find_autorest_generated_folder(module_prefix="azure"):
"""Find all Autorest generated code in that module prefix.
This actually looks for a "models" package only (not file). We could be smarter if necessary.
"""
_LOGGER.info(f"Looking for Autorest generated package in {module_prefix}")
# Manually skip some namespaces for now
if module_prefix in [
"azure.cli",
"azure.storage",
"azure.servicemanagement",
"azure.servicebus",
]:
_LOGGER.info(f"Skip {module_prefix}")
return []
result = []
try:
_LOGGER.debug(f"Try {module_prefix}")
model_module = importlib.import_module(".models", module_prefix)
# If not exception, we MIGHT have found it, but cannot be a file.
# Keep continue to try to break it, file module have no __path__
model_module.__path__
_LOGGER.info(f"Found {module_prefix}")
result.append(module_prefix)
except (ModuleNotFoundError, AttributeError):
# No model, might dig deeper
prefix_module = importlib.import_module(module_prefix)
for _, sub_package, ispkg in pkgutil.iter_modules(prefix_module.__path__, module_prefix + "."):
if ispkg:
result += find_autorest_generated_folder(sub_package)
return result
def get_sub_module_part(package_name, module_name):
"""Assuming package is azure-mgmt-compute and module name is azure.mgmt.compute.v2018-08-01
will return v2018-08-01
"""
sub_module_from_package = package_name.replace("-", ".")
if not module_name.startswith(sub_module_from_package):
_LOGGER.warning(f"Submodule {module_name} does not start with package name {package_name}")
return
return module_name[len(sub_module_from_package) + 1 :]
if __name__ == "__main__":
import argparse
parser = argparse.ArgumentParser(
description="Code fingerprint building",
formatter_class=argparse.RawTextHelpFormatter,
)
parser.add_argument("package_name", help="Package name.")
parser.add_argument(
"--version",
"-v",
dest="version",
help="The version of the package you want. By default, latest and current branch.",
)
parser.add_argument(
"--no-venv",
dest="no_venv",
action="store_true",
help="If version is provided, this will assume the current accessible package is already this version. You should probably not use it.",
)
parser.add_argument(
"--pypi",
dest="pypi",
action="store_true",
help="If provided, build report for all versions on pypi of this package.",
)
parser.add_argument(
"--last-pypi",
dest="last_pypi",
action="store_true",
help="If provided, build report for last version on pypi of this package.",
)
parser.add_argument(
"--last-pypi-stable",
dest="last_pypi_stable",
action="store_true",
help="If provided, select last stable version on pypi",
)
parser.add_argument("--debug", dest="debug", action="store_true", help="Verbosity in DEBUG mode")
parser.add_argument("--output", dest="output", help="Override output path.")
parser.add_argument(
"--metadata-path",
dest="metadata",
help="Write a metadata file about what happen. Mostly used for automation.",
)
args = parser.parse_args()
logging.basicConfig(level=logging.DEBUG if args.debug else logging.INFO)
main(
args.package_name,
args.version,
args.no_venv,
args.pypi,
args.last_pypi,
args.output,
args.metadata,
)
|