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
|
import argparse, sys, os, logging, glob, shutil
from subprocess import run
from typing import List, Optional
from ci_tools.functions import discover_targeted_packages, process_requires, get_pip_list_output
from ci_tools.parsing import ParsedSetup, parse_require
from ci_tools.variables import DEFAULT_BUILD_ID, str_to_bool, discover_repo_root, get_artifact_directory
from ci_tools.versioning.version_shared import set_version_py, set_dev_classifier
from ci_tools.versioning.version_set_dev import get_dev_version, format_build_id
from ci_tools.logging import logger, configure_logging, run_logged
def build_package() -> None:
parser = argparse.ArgumentParser(
description="""This is a secondary entrypoint for the "build" action. This command is used to install dependencies and build a specific package within the azure-sdk-for-python repository.""",
)
parser.add_argument(
"-d",
"--distribution-directory",
dest="distribution_directory",
help="The path to the distribution directory. Should be passed $(Build.ArtifactStagingDirectory) from the devops yaml definition."
+ "If that is not provided, will default to env variable SDK_ARTIFACT_DIRECTORY -> <calculated_repo_root>/.artifacts.",
)
parser.add_argument(
"--package_folder",
dest="package_folder",
required=True,
help="The target that should be assembled",
)
parser.add_argument(
"--package_type",
dest="package_type",
choices=["sdist", "whl", "all"],
default="all",
help="The type of package to build: sdist (source distribution only), whl (wheel only), or all (both)",
)
args = parser.parse_args()
configure_logging(args)
target_package = ParsedSetup.from_path(args.package_folder)
artifact_directory = get_artifact_directory(args.distribution_directory)
enable_sdist = True
enable_wheel = True
if args.package_type == "sdist":
enable_wheel = False
if args.package_type == "whl":
enable_sdist = False
build_packages([target_package.folder], artifact_directory, False, DEFAULT_BUILD_ID, enable_wheel, enable_sdist)
def build() -> None:
parser = argparse.ArgumentParser(
description="""This is the primary entrypoint for the "build" action. This command is used to build any package within the azure-sdk-for-python repository.""",
)
parser.add_argument(
"glob_string",
nargs="?",
default="azure*",
help=(
"A comma separated list of glob strings that will target the top level directories that contain packages. "
'Examples: All == "azure-*", Single = "azure-keyvault"'
),
)
parser.add_argument(
"-d",
"--distribution-directory",
dest="distribution_directory",
help="The path to the distribution directory. Should be passed $(Build.ArtifactStagingDirectory) from the devops yaml definition."
+ "If that is not provided, will default to env variable SDK_ARTIFACT_DIRECTORY -> <calculated_repo_root>/.artifacts.",
)
parser.add_argument(
"--service",
help=("Name of service directory (under sdk/) to build." "Example: --service applicationinsights"),
)
parser.add_argument(
"--pkgfilter",
default="",
dest="package_filter_string",
help=(
"An additional string used to filter the set of artifacts by a simple CONTAINS clause. This filters packages AFTER the set is built with compatibility and omission lists accounted."
),
)
parser.add_argument(
"--devbuild",
default=False,
dest="is_dev_build",
help=(
"Set build type to dev build so package requirements will be updated if required package is not available on PyPI"
),
)
parser.add_argument(
"--inactive",
default=False,
dest="inactive",
action="store_true",
help=(
"Include inactive packages when assembling artifacts. CI builds will include inactive packages as a way to ensure that the yml"
+ " controlled artifacts can be associated with a wheel/sdist."
),
)
parser.add_argument(
"--produce_apiview_artifact",
default=False,
dest="apiview_closure",
action="store_true",
help=(
"Should an additional build artifact that contains the targeted package + its direct dependencies be produced?"
),
)
parser.add_argument(
"--repo",
default=None,
dest="repo",
help=(
"Where is the start directory that we are building against? If not provided, the current working directory will be used. Please ensure you are within the azure-sdk-for-python repository."
),
)
parser.add_argument(
"--build_id",
default=None,
dest="build_id",
help="The current build id. It not provided, will default through environment variables in the following order: GITHUB_RUN_ID -> BUILD_BUILDID -> SDK_BUILD_ID -> default value.",
)
args = parser.parse_args()
configure_logging(args)
repo_root = discover_repo_root(args.repo)
if args.service and args.service != "auto":
service_dir = os.path.join("sdk", args.service)
target_dir = os.path.join(repo_root, service_dir)
else:
target_dir = repo_root
logger.debug(
f"Searching for packages starting from {target_dir} with glob string {args.glob_string} and package filter {args.package_filter_string}"
)
targeted_packages = discover_targeted_packages(
args.glob_string,
target_dir,
args.package_filter_string,
filter_type="Build",
compatibility_filter=True,
include_inactive=args.inactive,
)
artifact_directory = get_artifact_directory(args.distribution_directory)
build_id = format_build_id(args.build_id or DEFAULT_BUILD_ID)
build_packages(targeted_packages, artifact_directory, str_to_bool(args.is_dev_build), build_id, True, True)
def cleanup_build_artifacts(build_folder):
# clean up egginfo
results = glob.glob(os.path.join(build_folder, "*.egg-info"))
if results:
shutil.rmtree(results[0])
# clean up build results
build_path = os.path.join(build_folder, "build")
if os.path.exists(build_path):
shutil.rmtree(build_path)
def build_packages(
targeted_packages: List[str],
distribution_directory: Optional[str] = None,
is_dev_build: bool = False,
build_id: str = "",
enable_wheel: bool = True,
enable_sdist: bool = True,
):
logger.info(f"Generating {targeted_packages} using python{sys.version}")
for package_root in targeted_packages:
setup_parsed = ParsedSetup.from_path(package_root)
package_name_in_artifacts = os.path.join(os.path.basename(package_root))
if distribution_directory:
dist_dir = os.path.join(distribution_directory, package_name_in_artifacts)
else:
dist_dir = package_name_in_artifacts
if is_dev_build:
process_requires(package_root, True)
new_version = get_dev_version(setup_parsed.version, build_id)
logger.debug(f"{setup_parsed.name}: {setup_parsed.version} -> {new_version}")
set_version_py(setup_parsed.setup_filename, new_version)
set_dev_classifier(setup_parsed.setup_filename, new_version)
create_package(package_root, dist_dir, enable_wheel, enable_sdist)
def create_package(
setup_directory_or_file: str, dest_folder: str, enable_wheel: bool = True, enable_sdist: bool = True
):
"""
Uses the invoking python executable to build a wheel and sdist file given a setup.py or setup.py directory. Outputs
into a distribution directory and defaults to the value of get_artifact_directory().
"""
dist = get_artifact_directory(dest_folder)
setup_parsed = ParsedSetup.from_path(setup_directory_or_file)
should_log_build_output = logger.getEffectiveLevel() <= logging.DEBUG
if setup_parsed.is_pyproject:
# when building with pyproject, we will use `python -m build` to build the package
# -n argument will not use an isolated environment, which means the current environment must have all the dependencies of the package installed, to successfully
# pull in the dynamic `__version__` attribute. This is because setuptools is actually walking the __init__.py to get that attribute, which will fail
# if the imports within the setup.py don't work. Perhaps an isolated environment is better, pulling all the "dependencies" into the [build-system].requires list
# given the additional requirements of the package, we should install them in the current environment before attempting to build the package
# we assume the presence of `wheel`, `build`, `setuptools>=61.0.0`
pip_output = get_pip_list_output(sys.executable)
necessary_install_requirements = [
req for req in setup_parsed.requires if parse_require(req).name not in pip_output.keys()
]
run_logged(
[sys.executable, "-m", "pip", "install", *necessary_install_requirements],
cwd=setup_parsed.folder,
check=False,
should_stream_to_console=should_log_build_output,
)
run_logged(
[
sys.executable,
"-m",
"build",
f"-n{'s' if enable_sdist else ''}{'w' if enable_wheel else ''}",
"-o",
dist,
],
cwd=setup_parsed.folder,
check=True,
should_stream_to_console=should_log_build_output,
)
else:
if enable_wheel:
if setup_parsed.ext_modules:
run_logged(
[sys.executable, "-m", "cibuildwheel", "--output-dir", dist],
cwd=setup_parsed.folder,
check=True,
should_stream_to_console=should_log_build_output,
)
else:
run_logged(
[sys.executable, "setup.py", "bdist_wheel", "-d", dist],
cwd=setup_parsed.folder,
check=True,
should_stream_to_console=should_log_build_output,
)
if enable_sdist:
run_logged(
[sys.executable, "setup.py", "sdist", "-d", dist],
cwd=setup_parsed.folder,
check=True,
should_stream_to_console=should_log_build_output,
)
|