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 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835
|
import os
import ast
import textwrap
import re
import fnmatch
import logging
try:
# py 311 adds this library natively
import tomllib as toml
except:
# otherwise fall back to pypi package tomli
import tomli as toml
from typing import Dict, List, Tuple, Any, Optional, Union
# this assumes the presence of "packaging"
from packaging.requirements import Requirement
from setuptools import Extension
from ci_tools.variables import str_to_bool
VERSION_PY = "_version.py"
# Auto generated code has version maintained in version.py.
# We need to handle this old file name until generated code creates _version.py for all packages
OLD_VERSION_PY = "version.py"
VERSION_REGEX = r'^VERSION\s*=\s*[\'"]([^\'"]*)[\'"]'
NEW_REQ_PACKAGES = ["azure-core", "azure-mgmt-core"]
INIT_PY_FILE = "__init__.py"
INIT_EXTENSION_SUBSTRING = ".extend_path(__path__, __name__)"
# Directories to exclude from searches to avoid finding files in wrong places
EXCLUDE = {
"venv",
"__pycache__",
"tests",
"test",
"generated_samples",
"generated_tests",
"samples",
"swagger",
"stress",
"docs",
"doc",
"local",
"scripts",
"images",
".tox",
}
def extract_package_metadata(package_path: str) -> Dict[str, Any]:
"""Extract package metadata from a built package or source directory with comprehensive PEP 566/621 normalization."""
from pkginfo import get_metadata
try:
# Note: metadata may be different between source directory and built packages since
# some metadata may be normalized/transformed during build process
pkg_info = get_metadata(package_path)
if not pkg_info:
return {}
# Convert pkginfo object to dictionary with normalized keys
metadata: Dict[str, Any] = {}
# Core metadata fields (always normalized to same key names)
if pkg_info.name:
metadata["name"] = pkg_info.name
if pkg_info.version:
metadata["version"] = pkg_info.version
if pkg_info.keywords:
metadata["keywords"] = pkg_info.keywords
# Summary/Description normalization
if pkg_info.summary:
metadata["summary"] = pkg_info.summary
if pkg_info.description:
metadata["description"] = pkg_info.description
# Classifiers (consistent across PEPs)
if pkg_info.classifiers:
metadata["classifiers"] = pkg_info.classifiers
# Python version requirements
if pkg_info.requires_python:
metadata["requires_python"] = pkg_info.requires_python
# Dependencies normalization
if pkg_info.requires_dist:
metadata["requires_dist"] = pkg_info.requires_dist
# Author/Maintainer normalization - handle both simple and complex formats
_normalize_person_fields(pkg_info, metadata, "author")
_normalize_person_fields(pkg_info, metadata, "maintainer")
# License normalization - handle both PEP 566 and PEP 621 formats
_normalize_license_field(pkg_info, metadata)
# URL normalization - handle both home_page and project_urls
_normalize_url_fields(pkg_info, metadata)
# Additional optional fields
_add_optional_fields(pkg_info, metadata)
return metadata
except Exception as e:
logging.warning(f"Error extracting metadata from {package_path}: {e}")
return {}
def _normalize_person_fields(pkg_info, metadata: Dict[str, Any], role: str) -> None:
"""Normalize author/maintainer fields from both PEP 566 and PEP 621 formats."""
name_attr = getattr(pkg_info, role, None)
email_attr = getattr(pkg_info, f"{role}_email", None)
# Handle PEP 566 style (separate fields)
if name_attr and email_attr:
metadata[role] = name_attr
metadata[f"{role}_email"] = email_attr
# Handle PEP 621 style where name might be embedded in email field
elif email_attr:
# Check if email contains name in format "Name <email>"
if "<" in email_attr and ">" in email_attr:
# Extract name and email from "Name <email>" format
match = re.match(r"^(.+?)\s*<(.+?)>$", email_attr.strip())
if match:
name_part = match.group(1).strip()
email_part = match.group(2).strip()
metadata[role] = name_part
metadata[f"{role}_email"] = email_part
else:
metadata[f"{role}_email"] = email_attr
else:
metadata[f"{role}_email"] = email_attr
# Handle case where only name is provided
elif name_attr:
metadata[f"{role}"] = name_attr
def _normalize_license_field(pkg_info, metadata: Dict[str, Any]) -> None:
"""Normalize license field from both PEP 566 and PEP 621 formats."""
if pkg_info.license:
metadata["license"] = pkg_info.license
# Handle license expression (PEP 639) if available
if hasattr(pkg_info, "license_expression") and getattr(pkg_info, "license_expression", None):
metadata["license"] = pkg_info.license_expression
# Handle license file references if available
if hasattr(pkg_info, "license_file") and getattr(pkg_info, "license_file", None):
metadata["license"] = pkg_info.license_file
def _normalize_url_fields(pkg_info, metadata: Dict[str, Any]) -> None:
"""Normalize URL fields from both PEP 566 and PEP 621 formats."""
# Homepage from PEP 566 style
if pkg_info.home_page:
metadata["homepage"] = pkg_info.home_page
elif pkg_info.project_urls: # If homepage not found, try to extract from project_urls
if isinstance(pkg_info.project_urls, (list, tuple)):
for url_entry in pkg_info.project_urls:
if isinstance(url_entry, str) and "," in url_entry:
# Format: "Label, https://example.com"
label, url_value = url_entry.split(",", 1)
label_lower = label.strip().lower()
url_value = url_value.strip()
if label_lower in ["homepage", "home-page", "home"]:
metadata["homepage"] = url_value
elif label_lower == "repository":
metadata["repository"] = url_value
elif isinstance(pkg_info.project_urls, dict):
for key, value in pkg_info.project_urls.items():
key_lower = key.lower()
if key_lower in ["homepage", "home-page", "home"]:
metadata["homepage"] = value
elif key_lower == "repository":
metadata["repository"] = value
# Download URL
if hasattr(pkg_info, "download_url") and getattr(pkg_info, "download_url", None):
metadata["download_url"] = pkg_info.download_url
def _add_optional_fields(pkg_info, metadata: Dict[str, Any]) -> None:
"""Add optional metadata fields that may be present."""
optional_fields = ["obsoletes_dist", "provides_dist", "requires_external", "platform", "supported_platform"]
for field in optional_fields:
if hasattr(pkg_info, field):
value = getattr(pkg_info, field, None)
if value:
metadata[field] = value
def discover_namespace(package_root_path: str) -> Optional[str]:
"""
Discover the true namespace of a package by walking through its directory structure
and finding the first __init__.py that contains actual content (not just namespace extension).
:param str package_root_path: Root path of the package directory
:rtype: str or None
:return: The discovered namespace string, or None if no suitable namespace found
"""
if not os.path.exists(package_root_path):
return None
namespace = None
for root, subdirs, files in os.walk(package_root_path):
# Ignore any modules with name starts with "_"
# For e.g. _generated, _shared etc
# Ignore build, which is created when installing a package from source.
# Ignore tests, which may have an __init__.py but is not part of the package.
dirs_to_skip = [x for x in subdirs if x.startswith(("_", ".", "test", "build")) or x in EXCLUDE]
for d in dirs_to_skip:
logging.debug("Dirs to skip: {}".format(dirs_to_skip))
subdirs.remove(d)
if INIT_PY_FILE in files:
module_name = os.path.relpath(root, package_root_path).replace(os.path.sep, ".")
# If namespace has not been set yet, try to find the first __init__.py that's not purely for extension.
if not namespace:
namespace = _set_root_namespace(os.path.join(root, INIT_PY_FILE), module_name)
return namespace
def _set_root_namespace(init_file_path: str, module_name: str) -> Optional[str]:
"""
Examine an __init__.py file to determine if it represents a substantial namespace
or is just a namespace extension file.
:param str init_file_path: Path to the __init__.py file
:param str module_name: The module name corresponding to this __init__.py
:rtype: str or None
:return: The namespace if this file contains substantial content, None otherwise
"""
try:
with open(init_file_path, "r", encoding="utf-8") as f:
in_docstring = False
content = []
for line in f:
stripped_line = line.strip()
# If in multi-line docstring, skip following lines until end of docstring.
# If single-line docstring, skip the docstring line.
if stripped_line.startswith(('"""', "'''")) and not stripped_line.endswith(('"""', "'''")):
in_docstring = not in_docstring
# If comment, skip line. Otherwise, add to content.
if not in_docstring and not stripped_line.startswith("#"):
content.append(line)
# If there's more than one line of content, or if there's one line that's not just namespace extension
if len(content) > 1 or (len(content) == 1 and INIT_EXTENSION_SUBSTRING not in content[0]):
return module_name
except Exception as e:
logging.error(f"Error reading {init_file_path}: {e}")
return None
class ParsedSetup:
"""
Used to represent a parsed setup.py or pyproject.toml file. One should use `ParsedSetup.from_path` to create new instances.
"""
def __init__(
self,
name: str,
version: str,
python_requires: str,
requires: List[str],
is_new_sdk: bool,
setup_filename: str,
name_space: str,
package_data: Dict[str, Any],
include_package_data: bool,
classifiers: List[str],
keywords: List[str],
ext_package: str,
ext_modules: List[Extension],
metapackage: bool,
):
self.name: str = name
self.version: str = version
self.python_requires: str = python_requires
self.requires: List[str] = requires
self.is_new_sdk: bool = is_new_sdk
self.setup_filename: str = setup_filename
self.namespace: str = name_space
self.package_data: Dict[str, Any] = package_data
self.include_package_data: bool = include_package_data
self.classifiers: List[str] = classifiers
self.keywords: List[str] = keywords
self.ext_package = ext_package
self.ext_modules = ext_modules
self.is_metapackage = metapackage
self.is_pyproject = self.setup_filename.endswith(".toml")
self.folder = os.path.dirname(self.setup_filename)
@classmethod
def from_path(cls, parse_directory_or_file: str):
"""
Creates a new ParsedSetup instance from a path to a setup.py, pyproject.toml (with [project] member),
or a directory containing either of those files.
"""
(
name,
version,
python_requires,
requires,
is_new_sdk,
setup_filename,
name_space,
package_data,
include_package_data,
classifiers,
keywords,
ext_package,
ext_modules,
metapackage,
) = parse_setup(parse_directory_or_file)
return cls(
name,
version,
python_requires,
requires,
is_new_sdk,
setup_filename,
name_space,
package_data,
include_package_data,
classifiers,
keywords,
ext_package,
ext_modules,
metapackage,
)
def get_build_config(self) -> Optional[Dict[str, Any]]:
return get_build_config(self.folder)
def get_config_setting(self, setting: str, default: Any = True) -> Any:
return get_config_setting(self.folder, setting, default)
def is_reporting_suppressed(self, setting: str) -> bool:
return compare_string_to_glob_array(setting, self.get_config_setting("suppressed_skip_warnings", []))
def __str__(self):
lines = [f"ParsedSetup from {self.folder}"]
for attr in [
"name",
"version",
"python_requires",
"requires",
"is_new_sdk",
"setup_filename",
"namespace",
"package_data",
"include_package_data",
"classifiers",
"keywords",
"ext_package",
"ext_modules",
"is_metapackage",
"is_pyproject",
]:
value = getattr(self, attr)
lines.append(f"\t{attr}={value}")
return "\n".join(lines)
def update_build_config(package_path: str, new_build_config: Dict[str, Any]) -> Dict[str, Any]:
"""
Attempts to update a pyproject.toml's [tools.azure-sdk-tools] section with a new check configuration.
This function can only append or override existing check values. It cannot delete them.
"""
if os.path.isfile(package_path):
package_path = os.path.dirname(package_path)
toml_file = os.path.join(package_path, "pyproject.toml")
if os.path.exists(toml_file):
with open(toml_file, "rb") as f:
toml_dict = toml.load(f)
if "tool" in toml_dict:
tool_configs = toml_dict["tool"]
if "azure-sdk-build" in tool_configs:
tool_configs["azure-sdk-build"] = new_build_config
else:
toml_dict = {"tool": {"azure-sdk-build": new_build_config}}
with open(toml_file, "wb") as f:
import tomli_w
tomli_w.dump(toml_dict, f)
return new_build_config
def get_config_setting(package_path: str, setting: str, default: Any = True) -> Any:
"""
Attempts to retrieve a specific setting within the [tools.azure-sdk-tools] section of a discovered
pyproject.toml. If the input 'setting' does NOT exist, the provided default value will be returned.
"""
# we should always take the override if one is present
override_value = os.getenv(f"{os.path.basename(package_path).upper().replace('-','_')}_{setting.upper()}", None)
if override_value:
return str_to_bool(override_value)
# if no override, check for the config setting in the pyproject.toml
config = get_build_config(package_path)
if config:
if setting.lower() in config:
return config[setting.lower()]
return default
def get_build_config(package_path: str) -> Optional[Dict[str, Any]]:
"""
Attempts to retrieve all values within [tools.azure-sdk-build] section of a pyproject.toml.
If passed an actual file in package_path arg, the pyproject.toml will be found alongside the targeted file.
"""
if os.path.isfile(package_path):
package_path = os.path.dirname(package_path)
toml_file = os.path.join(package_path, "pyproject.toml")
if os.path.exists(toml_file):
try:
with open(toml_file, "rb") as f:
toml_dict = toml.load(f)
if "tool" in toml_dict:
tool_configs = toml_dict["tool"]
if "azure-sdk-build" in tool_configs:
return tool_configs["azure-sdk-build"]
except:
return {}
def get_ci_config(package_path: str) -> Optional[Dict[str, Any]]:
"""
Attempts to retrieve the parsed toml content of a CI.yml associated with this package.
"""
if os.path.isfile(package_path):
package_path = os.path.dirname(package_path)
# this checks exactly one directory up
# for sdk/core/azure-core
# sdk/core/ci.yml is checked only
ci_file = os.path.join(os.path.dirname(package_path), "ci.yml")
if os.path.exists(ci_file):
import yaml
try:
with open(ci_file, "r") as f:
return yaml.safe_load(f)
except Exception as e:
logging.error(f"Failed to load ci.yml at {ci_file} due to exception {e}")
return None
def read_setup_py_content(setup_filename: str) -> str:
"""
Get setup.py content, returns a string.
"""
with open(setup_filename, "r", encoding="utf-8-sig") as setup_file:
content = setup_file.read()
return content
def parse_setup_py(
setup_filename: str,
) -> Tuple[
str, str, str, List[str], bool, str, str, Dict[str, Any], bool, List[str], List[str], str, List[Extension], bool
]:
"""
Used to evaluate a setup.py (or a directory containing a setup.py) and return a tuple containing:
(
<package-name>,
<package_version>,
<python_requires>,
<requires>,
<boolean indicating track1 vs track2>,
<parsed setup.py location>,
<namespace>,
<package_data dict>,
<include_package_data bool>,
<classifiers>,
<keywords>,
<ext_packages>,
<ext_modules>,
<is_metapackage>
)
"""
mock_setup = textwrap.dedent(
"""\
def setup(*args, **kwargs):
__setup_calls__.append((args, kwargs))
"""
)
parsed_mock_setup = ast.parse(mock_setup, filename=setup_filename)
content = read_setup_py_content(setup_filename)
parsed = ast.parse(content)
for index, node in enumerate(parsed.body[:]):
if (
not isinstance(node, ast.Expr)
or not isinstance(node.value, ast.Call)
or not hasattr(node.value.func, "id")
or node.value.func.id != "setup" # type: ignore
):
continue
parsed.body[index:index] = parsed_mock_setup.body
break
fixed = ast.fix_missing_locations(parsed)
codeobj = compile(fixed, setup_filename, "exec")
local_vars: Dict[str, Any] = {}
kwargs = {}
global_vars: Dict[str, Any] = {"__setup_calls__": []}
current_dir = os.getcwd()
working_dir = os.path.dirname(setup_filename)
os.chdir(working_dir)
try:
exec(codeobj, global_vars, local_vars)
_, kwargs = global_vars["__setup_calls__"][0]
finally:
os.chdir(current_dir)
try:
python_requires = kwargs["python_requires"]
# most do not define this, fall back to what we define as universal
except KeyError as e:
python_requires = ">=2.7"
version = kwargs.get("version")
name = kwargs.get("name")
name_space = name.replace("-", ".") if name else ""
packages = kwargs.get("packages", [])
if packages:
name_space = packages[0]
metapackage = False
else:
metapackage = True
requires = kwargs.get("install_requires", [])
package_data = kwargs.get("package_data", None)
include_package_data = kwargs.get("include_package_data", None)
classifiers = kwargs.get("classifiers", [])
keywords = kwargs.get("keywords", [])
is_new_sdk = name in NEW_REQ_PACKAGES or any(map(lambda x: (parse_require(x).name in NEW_REQ_PACKAGES), requires))
ext_package = kwargs.get("ext_package", None)
ext_modules = kwargs.get("ext_modules", [])
# fmt: off
return (
name, # str
version, # str
python_requires, # str
requires, # List[str]
is_new_sdk, # bool
setup_filename, # str
name_space, # str,
package_data, # Dict[str, Any],
include_package_data, # bool,
classifiers, # List[str],
keywords, # List[str] ADJUSTED
ext_package, # str
ext_modules, # List[Extension],
metapackage # bool
)
# fmt: on
def parse_pyproject(
pyproject_filename: str,
) -> Tuple[
str, str, str, List[str], bool, str, str, Dict[str, Any], bool, List[str], List[str], str, List[Extension], bool
]:
"""
Used to evaluate a pyproject (or a directory containing a pyproject.toml) with a [project] configuration within.
Returns a tuple containing:
(
<package-name>,
<package_version>,
<python_requires>,
<requires>,
<boolean indicating track1 vs track2>,
<parsed setup.py location>,
<namespace>,
<package_data dict>,
<include_package_data bool>,
<classifiers>,
<keywords>,
<ext_packages>,
<ext_modules>,
<is_metapackage>
)
"""
toml_dict = get_pyproject_dict(pyproject_filename)
project_config = toml_dict.get("project", None)
assert (
project_config is not None
), f"Unable to find [project] section in {pyproject_filename}. Please ensure it is present."
# to pull a version from pyproject.toml, we need to get a dynamic version out. We can ask
# setuptools to give us the metadata for a package, but that will involve _partially building_ the package
# to create an egginfo folder. This is a very expensive operation goes against the entire point of
# "give me the package metadata for this folder."
# We can avoid this expensive operation if we parse the version out of the _version or version file directly.
parsed_version = project_config.get("version", None)
if not parsed_version:
parsed_version_py = get_version_py(pyproject_filename)
if parsed_version_py:
with open(parsed_version_py, "r") as f:
parsed_version = re.search(VERSION_REGEX, f.read(), re.MULTILINE)
if parsed_version:
parsed_version = parsed_version.group(1)
else:
parsed_version = "0.0.0"
else:
raise ValueError(
f'Unable to find a version value directly set in "{pyproject_filename}", nor is it available in a "version.py" or "_version.py."'
)
name = project_config.get("name")
version = parsed_version
python_requires = project_config.get("requires-python")
requires = project_config.get("dependencies")
is_new_sdk = name in NEW_REQ_PACKAGES or any(map(lambda x: (parse_require(x).name in NEW_REQ_PACKAGES), requires))
# Discover the actual namespace by walking the package directory
package_directory = os.path.dirname(pyproject_filename)
discovered_namespace = discover_namespace(package_directory)
name_space = discovered_namespace if discovered_namespace else name.replace("-", ".")
package_data = get_value_from_dict(toml_dict, "tool.setuptools.package-data", None)
include_package_data = get_value_from_dict(toml_dict, "tool.setuptools.include-package-data", True)
classifiers = project_config.get("classifiers", [])
keywords = project_config.get("keywords", [])
metapackage = False
# as of setuptools 74.1 ext_packages and ext_modules are now present in tool.setuptools config namespace
ext_package = get_value_from_dict(toml_dict, "tool.setuptools.ext-package", None)
ext_modules = get_value_from_dict(toml_dict, "tool.setuptools.ext-modules", [])
ext_modules = [Extension(**moduleArgDict) for moduleArgDict in ext_modules]
# fmt: off
return (
name, # str
version, # str
python_requires, # str
requires, # List[str]
is_new_sdk, # bool
pyproject_filename, # str
name_space, # str,
package_data, # Dict[str, Any],
include_package_data, # bool,
classifiers, # List[str],
keywords, # List[str] ADJUSTED
ext_package, # str
ext_modules, # List[Extension]
metapackage # bool
)
# fmt: on
def get_version_py(setup_path: str) -> Optional[str]:
"""
Given the path to pyproject.toml or setup.py, attempts to find a (_)version.py file and return its location.
"""
file_path, _ = os.path.split(setup_path)
# Find path to _version.py recursively
for root, dirs, files in os.walk(file_path):
dirs[:] = [d for d in dirs if d not in EXCLUDE and not d.endswith(".egg-info") and not d.startswith(".")]
if VERSION_PY in files:
return os.path.join(root, VERSION_PY)
elif OLD_VERSION_PY in files:
return os.path.join(root, OLD_VERSION_PY)
return None
def get_pyproject(folder: str) -> Optional[str]:
"""
Given a folder, attempts to find a pyproject.toml file with a "project" configuration and return its location.
"""
pyproject_filename = os.path.join(folder, "pyproject.toml")
if os.path.exists(pyproject_filename):
project_config = get_value_from_dict(get_pyproject_dict(pyproject_filename), "project", None)
if project_config:
return pyproject_filename
return None
def get_setup_py(folder: str) -> Optional[str]:
"""
Given a folder, attempts to find a setup.py file and return its location.
"""
setup_filename = os.path.join(folder, "setup.py")
if os.path.exists(setup_filename):
return setup_filename
return None
def parse_setup(
setup_filename_or_folder: str,
):
"""
Used to evaluate a pyproject.toml or setup.py (or a directory containing either) and return a tuple containing:
(
<package-name>,
<package_version>,
<python_requires>,
<requires>,
<boolean indicating track1 vs track2>,
<parsed setup.py location>,
<namespace>,
<package_data dict>,
<include_package_data bool>,
<classifiers>,
<keywords>,
<ext_packages>,
<ext_modules>,
<is_metapackage>,
)
If a pyproject.toml (containing [project]) or a setup.py is NOT found, a ValueError will be raised.
"""
targeted_path = setup_filename_or_folder
if os.path.isfile(setup_filename_or_folder):
targeted_path = os.path.dirname(setup_filename_or_folder)
resolved_filename = get_pyproject(targeted_path) or get_setup_py(targeted_path)
if not resolved_filename:
raise ValueError(f"Unable to find a setup.py or pyproject.toml in {setup_filename_or_folder}")
if resolved_filename.endswith(".toml"):
result = parse_pyproject(resolved_filename)
else:
result = parse_setup_py(resolved_filename)
return result
def get_pyproject_dict(pyproject_file: str) -> Dict[str, Any]:
"""
Given a pyproject.toml file, returns a dictionary of a target section. Defaults to `project` section.
"""
with open(pyproject_file, "rb") as f:
pyproject_dict = toml.load(f)
return pyproject_dict
def get_value_from_dict(pyproject_dict: Dict[str, Any], keystring: str, default_if_not_present: Any = None) -> Any:
"""
Given a dictionary, offers an easy interface for nested objects via `.` notation.
Example usage -> get_value_from_dict(pyproject_dict, "tool.setuptools.include-package-data", True)
"""
keys = keystring.split(".")
current_selection = pyproject_dict
for index, key in enumerate(keys):
if index == len(keys) - 1:
return current_selection.get(key, default_if_not_present)
if key in current_selection:
current_selection = current_selection[key]
else:
return default_if_not_present
return default_if_not_present
def get_install_requires(setup_path: str) -> List[str]:
"""
Simple helper function to just directly get the installation requirements given a python package.
"""
return ParsedSetup.from_path(setup_path).requires
def parse_require(req: str) -> Requirement:
"""
Parses a PEP 508 requirement string into a Requirement object.
Example: "azure-core<2.0.0,>=1.11.0"
"""
return Requirement(req)
def get_name_from_specifier(version: str) -> str:
"""
Given a specifier string of format of <package-name><comparison><versionNumber>, returns the package name.
"azure-core<2.0.0,>=1.11.0" -> azure-core
"""
return re.split(r"[><=]", version)[0]
def compare_string_to_glob_array(string: str, glob_array: List[str]) -> bool:
"""
This function is used to easily compare a string to a set of glob strings, if it matches any of them, returns True.
"""
return any([fnmatch.fnmatch(string, glob) for glob in glob_array])
|