rez 3.3.0__tar.gz → 3.4.0__tar.gz

rez-3.4.0/PKG-INFO

@@ -0,0 +1,270 @@
+Metadata-Version: 2.4
+Name: rez
+Version: 3.4.0
+Summary: A cross-platform packaging system that can build and install multiple version of packages, and dynamically configure resolved environments at runtime.
+Home-page: https://github.com/AcademySoftwareFoundation/rez
+Author: Allan Johns
+Author-email: nerdvegas@gmail.com
+Maintainer: Contributors to the rez project
+Maintainer-email: rez-discussion@lists.aswf.io
+License: Apache-2.0
+Keywords: package resolve version build install software management
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Software Development
+Classifier: Topic :: System :: Software Distribution
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: keywords
+Dynamic: license
+Dynamic: license-file
+Dynamic: maintainer
+Dynamic: maintainer-email
+Dynamic: requires-python
+Dynamic: summary
+
+[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://github.com/AcademySoftwareFoundation/rez/blob/main/LICENSE)<br>
+[![Release](https://shields.io/github/v/release/AcademySoftwareFoundation/rez)](https://github.com/AcademySoftwareFoundation/rez/releases)
+[![PyPI Release](https://shields.io/pypi/v/rez)](https://pypi.org/project/rez)<br>
+[![Mailing List](https://img.shields.io/badge/rez--discussion-lists.aswf.io-003366?style=flat-square&logo=linuxfoundation)](https://lists.aswf.io/g/rez-discussion)
+[![Slack](https://img.shields.io/badge/Slack-ASWF_%23rez-7a6800?style=flat-square&logo=slack)](https://slack.aswf.io/)
+[![Contributing Guidelines](https://img.shields.io/badge/rez-Contributing%20Guidelines-0b610e?style=flat-square&logo=github)](https://github.com/AcademySoftwareFoundation/rez/blob/main/CONTRIBUTING.md)<br>
+[![Tests](https://github.com/AcademySoftwareFoundation/rez/actions/workflows/tests.yaml/badge.svg)](https://github.com/AcademySoftwareFoundation/rez/actions/workflows/tests.yaml)
+[![Installation](https://github.com/AcademySoftwareFoundation/rez/actions/workflows/installation.yaml/badge.svg)](https://github.com/AcademySoftwareFoundation/rez/actions/workflows/installation.yaml)
+[![Flake8](https://github.com/AcademySoftwareFoundation/rez/actions/workflows/flake8.yaml/badge.svg)](https://github.com/AcademySoftwareFoundation/rez/actions/workflows/flake8.yaml)
+[![Docs](https://readthedocs.org/projects/rez/badge/?version=stable)](https://rez.readthedocs.io/en/stable)
+[![PyPI](https://github.com/AcademySoftwareFoundation/rez/workflows/pypi/badge.svg)](https://github.com/AcademySoftwareFoundation/rez/actions?query=workflow%3Apypi+event%3Arelease)
+[![Benchmark](https://github.com/AcademySoftwareFoundation/rez/workflows/benchmark/badge.svg)](https://github.com/AcademySoftwareFoundation/rez/actions?query=workflow%3Abenchmark+event%3Arelease)<br>
+[![Coverage](https://codecov.io/gh/AcademySoftwareFoundation/rez/graph/badge.svg?token=FLYggQOE7W)](https://codecov.io/gh/AcademySoftwareFoundation/rez)
+[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=AcademySoftwareFoundation_rez&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=AcademySoftwareFoundation_rez)
+[![Bugs](https://sonarcloud.io/api/project_badges/measure?project=AcademySoftwareFoundation_rez&metric=bugs)](https://sonarcloud.io/summary/new_code?id=AcademySoftwareFoundation_rez)
+[![Vulnerabilities](https://sonarcloud.io/api/project_badges/measure?project=AcademySoftwareFoundation_rez&metric=vulnerabilities)](https://sonarcloud.io/summary/new_code?id=AcademySoftwareFoundation_rez)
+[![Maintainability Rating](https://sonarcloud.io/api/project_badges/measure?project=AcademySoftwareFoundation_rez&metric=sqale_rating)](https://sonarcloud.io/summary/new_code?id=AcademySoftwareFoundation_rez)
+[![Reliability Rating](https://sonarcloud.io/api/project_badges/measure?project=AcademySoftwareFoundation_rez&metric=reliability_rating)](https://sonarcloud.io/summary/new_code?id=AcademySoftwareFoundation_rez)
+[![Security Rating](https://sonarcloud.io/api/project_badges/measure?project=AcademySoftwareFoundation_rez&metric=security_rating)](https://sonarcloud.io/summary/new_code?id=AcademySoftwareFoundation_rez)<br>
+[![OpenSSF Best Practices](https://www.bestpractices.dev/projects/8389/badge)](https://www.bestpractices.dev/projects/8389)
+
+
+- [What Is Rez?](#what-is-rez)
+- [The Basics](#the-basics)
+- [Examples](#examples)
+- [Quickstart](#quickstart)
+- [Building Your First Package](#building-your-first-package)
+- [Features](#features)
+
+
+## What Is Rez?
+
+Rez is a cross-platform package manager with a difference. Using Rez you can create
+standalone environments configured for a given set of packages. However, unlike many
+other package managers, packages are not installed into these standalone environments.
+Instead, all package versions are installed into a central repository, and standalone
+environments reference these existing packages. This means that configured environments
+are lightweight, and very fast to create, often taking just a few seconds to configure
+despite containing hundreds of packages.
+
+See [the wiki](https://rez.readthedocs.io) for full documentation.
+
+<p align="center">
+<a href="https://github.com/AcademySoftwareFoundation/rez/raw/main/docs/source/_static/other_pkg_mgr.png">
+<img src="https://github.com/AcademySoftwareFoundation/rez/raw/main/docs/source/_static/other_pkg_mgr.png"></a>
+<br><i>Typical package managers install packages into an environment</i>
+</p>
+
+<br>
+<p align="center">
+<a href="https://github.com/AcademySoftwareFoundation/rez/raw/main/docs/source/_static/rez_pkg_mgr.png">
+<img src="https://github.com/AcademySoftwareFoundation/rez/raw/main/docs/source/_static/rez_pkg_mgr.png"></a>
+<br><i>Rez installs packages once, and configures environments dynamically</i>
+</p>
+
+<br>
+Rez takes a list of package requests, and constructs the target environment, resolving
+all the necessary package dependencies. Any type of software package is supported -
+compiled, python, applications and libraries.
+
+
+## The Basics
+
+Packages are stored in repositories on disk. Each package has a single concise
+definition file (*package.py*) that defines its dependencies, its commands (how it
+configures the environment containing it), and other metadata. For example, the
+following is the package definition file for the popular *requests* python module:
+
+    name = "requests"
+
+    version = "2.8.1"
+
+    authors = ["Kenneth Reitz"]
+
+    requires = [
+        "python-2.7+"
+    ]
+
+    def commands():
+        env.PYTHONPATH.append("{root}/python")
+
+This package requires python-2.7 or greater. When used, the 'python' subdirectory
+within its install location is appended to the PYTHONPATH environment variable.
+
+When an environment is created with the rez API or *rez-env* tool, a dependency
+resolution algorithm tracks package requirements and resolves to a list of needed
+packages. The commands from these packages are concatenated and evaluated, resulting
+in a configured environment. Rez is able to configure environments containing
+hundreds of packages, often within a few seconds. Resolves can also be saved to file,
+and when re-evaluated later will reconstruct the same environment once more.
+
+
+## Examples
+
+This example places the user into a resolved shell containing the requested packages,
+using the [rez-env](https://rez.readthedocs.io/en/stable/commands/rez-env.html) tool:
+
+    ]$ rez-env requests-2.2+ python-2.6 'pymongo-0+<2.7'
+
+    You are now in a rez-configured environment.
+
+    resolved by ajohns@nn188.somewhere.com, on Wed Feb 26 15:56:20 2014, using Rez v2.0.0
+
+    requested packages:
+    requests-2.2+
+    python-2.6
+    pymongo-0+<2.7
+
+    resolved packages:
+    python-2.6.8    /software/ext/python/2.6.8
+    platform-linux  /software/ext/platform/linux
+    requests-2.2.1  /software/ext/requests/2.2.1/python-2.6
+    pymongo-2.6.3   /software/ext/pymongo/2.6.3
+    arch-x86_64     /software/ext/arch/x86_64
+
+    > ]$ _
+
+This example creates an environment containing the package 'houdini' version 12.5
+or greater, and runs the command 'hescape -h' inside that environment:
+
+    ]$ rez-env houdini-12.5+ -- hescape -h
+    Usage: hescape [-foreground] [-s editor] [filename ...]
+    -h: output this usage message
+    -s: specify starting desktop by name
+    -foreground: starts process in foreground
+
+Resolved environments can also be created via the API:
+
+    >>> import subprocess
+    >>> from rez.resolved_context import ResolvedContext
+    >>>
+    >>> r = ResolvedContext(["houdini-12.5+", "houdini-0+<13", "java", "!java-1.8+"])
+    >>> p = r.execute_shell(command='which hescape', stdout=subprocess.PIPE)
+    >>> out, err = p.communicate()
+    >>>
+    >>> print(out)
+    '/software/ext/houdini/12.5.562/bin/hescape'
+
+
+## Quickstart
+
+First, install Rez using Python 3.8+. Download the source, and from the source directory, run
+(with DEST_DIR replaced with your install location):
+
+    ]$ python3 ./install.py -v DEST_DIR
+
+This installs the Rez command line tools. It will print a message at the end
+telling you how to use Rez when the installation has completed. Rez is not a
+normal Python package and so you do not typically install it with pip or setup.py.
+Do *not* move the installation - re-install to a new location if you want to
+change the install path. If you want to install rez for multiple operating
+systems, perform separate installs for each of those systems.
+
+Next, you need to create some essential Rez packages. The *rez-bind* tool creates
+Rez packages that are based on software already installed on your system. Try
+binding the following list of packages (note that for Python, you may need
+administrative privileges):
+
+    ]$ rez-bind platform
+    ]$ rez-bind arch
+    ]$ rez-bind os
+    ]$ rez-bind python
+
+Now you should be able to create an environment containing Python. Try this:
+
+    ]$ rez-env python -- which python
+    /home/ajohns/packages/python-2.7.8/platform-linux/arch-x86_64/os-Ubuntu-12.04/bin/python
+
+
+## Building Your First Package
+
+The *rez-build* tool is used to build packages and install them locally (typically
+to *$HOME/packages*). Once you've done that, you can use them via *rez-env*, just
+like any other package:
+
+    ]$ cd example_packages/hello_world
+    ]$ rez-build --install
+    ...
+    ]$ rez-env hello_world -- hello
+    Hello world!
+
+
+## Features
+
+* Supports Linux, OSX and Windows;
+* Allows for a fast and efficient build-install-test cycle;
+* Creates shells of type: bash, tcsh, other (shells can be added as plugins);
+* Contains a deployment system supporting git, mercurial and svn (as plugins);
+* Environment resolves can be saved to disk and reused at a later date (a bit
+  like VirtualEnv);
+* Highly pluggable, supports five different plugin types to do things from
+  adding new shell types, to adding new build systems;
+* Contains a version resolving algorithm, for avoiding version clashes;
+* Visualises resolved environments in a rendered dot-graph;
+* Packages are found in a search path, so different packages can be deployed
+  to different locations;
+* Supports alphanumeric version numbers;
+* Has a powerful version requirements syntax, able to describe any version
+  range, and a conflict operator for rejecting version ranges;
+* Package 'variants' - a way to define different flavors of the same package
+  version, for example a plugin built for multiple versions of the host app;
+* Custom release hooks (such as post-release operations) can be added as plugins;
+* Has a time lock feature, which allows old resolves to be recreated (newer
+  packages are ignored);
+* Package definitions are a single, succinct file;
+* Packages define their effect on the environment (adding to PATH etc) in a
+  platform- and shell- agnostic way, using a dedicated python API;
+* Has a memcached-based caching system, for caching environment resolves;
+* Has a package filtering feature, allowing for staged package releases such as
+  alpha and beta packages.
+
+## You have a problem or want to talk to us?
+
+If you find a bug, need help, or want to talk to the developers, here is a list of the different
+ways to get in touch with us:
+
+* [Report an issue](https://github.com/AcademySoftwareFoundation/rez/issues)
+* [Chat room](https://slack.aswf.io): Join the ``#rez`` channel
+* [Start a discussion](https://github.com/AcademySoftwareFoundation/rez/discussions)
+* [Mailing list](mail:main@lists.aswf.io): Note that are way less active on the mailing
+  list than on any other communication channel.
+
+## Known issues and limitations
+
+* Currently CMake builds do not function on Windows with Rez and
+  the related tests are skipped. A fix requires multiple changes that are on
+  the roadmap. Users have successfully implemented workarounds to utilize
+  CMake with Rez under Windows, but the goal is to provide a seamless experience
+  on any platform in the future. For details see this [issue](/../../issues/703)

rez-3.4.0/pyproject.toml

@@ -0,0 +1,30 @@
+[build-system]
+requires = ["setuptools"]
+build-backend = "setuptools.build_meta"
+
+[tool.mypy]
+python_version = "3.8"
+files = ["src/rez/", "src/rezplugins/"]
+exclude = [
+    '.*/rez/data/.*',
+    '.*/rez/vendor/.*',
+    '.*/rez/tests/.*',
+    '.*/rez/utils/lint_helper.py',
+]
+disable_error_code = ["var-annotated", "import-not-found"]
+check_untyped_defs = true
+# allow this for now:
+allow_redefinition = true
+follow_imports = "silent"
+
+[[tool.mypy.overrides]]
+module = 'rez.utils.lint_helper'
+follow_imports = "skip"
+
+[[tool.mypy.overrides]]
+module = "rez.version._version"
+disallow_untyped_defs = true
+
+[[tool.mypy.overrides]]
+module = "rez.version._requirement"
+disallow_untyped_defs = true

rez-3.4.0/setup.py

@@ -0,0 +1,104 @@
+# SPDX-License-Identifier: Apache-2.0
+# Copyright Contributors to the Rez Project
+
+
+import fnmatch
+import os
+import os.path
+import sys
+
+
+try:
+    from setuptools import setup, find_packages
+except ImportError:
+    print("install failed - requires setuptools", file=sys.stderr)
+    sys.exit(1)
+
+# carefully import some sourcefiles that are standalone
+source_path = os.path.dirname(os.path.realpath(__file__))
+src_path = os.path.join(source_path, "src")
+sys.path.insert(0, src_path)
+
+from rez.utils._version import _rez_version
+from rez.cli._entry_points import get_specifications
+
+
+def find_files(pattern, path=None, root="rez"):
+    paths = []
+    basepath = os.path.realpath(os.path.join("src", root))
+    path_ = basepath
+    if path:
+        path_ = os.path.join(path_, path)
+
+    for root, _, files in os.walk(path_):
+        files = [x for x in files if fnmatch.fnmatch(x, pattern)]
+        files = [os.path.join(root, x) for x in files]
+        paths += [x[len(basepath):].lstrip(os.path.sep) for x in files]
+
+    return paths
+
+
+this_directory = os.path.abspath(os.path.dirname(__file__))
+with open(os.path.join(this_directory, 'README.md')) as f:
+    long_description = f.read()
+
+
+setup(
+    name="rez",
+    version=_rez_version,
+    description=("A cross-platform packaging system that can build and "
+                 "install multiple version of packages, and dynamically "
+                 "configure resolved environments at runtime."),
+    keywords="package resolve version build install software management",
+    long_description=long_description,
+    long_description_content_type='text/markdown',
+    url="https://github.com/AcademySoftwareFoundation/rez",
+    author="Allan Johns",
+    author_email="nerdvegas@gmail.com",
+    maintainer="Contributors to the rez project",
+    maintainer_email="rez-discussion@lists.aswf.io",
+    license="Apache-2.0",
+    license_files=["LICENSE"],
+    entry_points={
+        "console_scripts": get_specifications().values()
+    },
+    include_package_data=False,
+    zip_safe=False,
+    package_dir={'': 'src'},
+    packages=find_packages('src', exclude=["build_utils",
+                                           "build_utils.*",
+                                           "tests"]),
+    install_requires=[],
+    package_data={
+        'rez':
+            ['utils/logging.conf'] +
+            ['README*'] +
+            ["py.typed"] +
+            find_files('*', 'completion') +
+            find_files('*', 'data') +
+            find_files('*.exe', 'vendor/distlib'),
+        'rezplugins':
+            ["py.typed"] +
+            find_files('*.cmake', 'build_system', root='rezplugins') +
+            find_files('*', 'build_system/template_files', root='rezplugins'),
+        'rezgui':
+            find_files('rezguiconfig', root='rezgui') +
+            find_files('*', 'icons', root='rezgui')
+    },
+    classifiers=[
+        "Development Status :: 5 - Production/Stable",
+        "License :: OSI Approved :: Apache Software License",
+        "Intended Audience :: Developers",
+        "Operating System :: OS Independent",
+        "Programming Language :: Python",
+        "Programming Language :: Python :: 3.8",
+        "Programming Language :: Python :: 3.9",
+        "Programming Language :: Python :: 3.10",
+        "Programming Language :: Python :: 3.11",
+        "Programming Language :: Python :: 3.12",
+        "Programming Language :: Python :: 3.13",
+        "Topic :: Software Development",
+        "Topic :: System :: Software Distribution"
+    ],
+    python_requires=">=3.8",
+)

rez-3.4.0/src/rez/__init__.py

@@ -0,0 +1,74 @@
+# SPDX-License-Identifier: Apache-2.0
+# Copyright Contributors to the Rez Project
+
+
+from rez.utils._version import _rez_version
+import rez.deprecations
+import sys
+import os
+import warnings
+
+
+__version__ = _rez_version
+__author__ = "Allan Johns"
+__license__ = "Apache-2.0"
+
+
+module_root_path = __path__[0]  # noqa
+
+
+# TODO: Revamp logging. For now, this is here for backwards compatibility
+def _init_logging() -> None:
+    import logging
+    logging_conf = os.getenv("REZ_LOGGING_CONF")
+    if logging_conf:
+        import logging.config
+        logging.config.fileConfig(logging_conf, disable_existing_loggers=False)
+        return
+
+    from rez.utils.colorize import ColorizedStreamHandler
+
+    formatter = logging.Formatter(
+        fmt="%(asctime)s %(levelname)-8s %(message)s",
+        datefmt="%X"
+    )
+    handler = ColorizedStreamHandler(sys.stderr)
+    handler.setFormatter(formatter)
+    logger = logging.getLogger("rez")
+    logger.propagate = False
+    logger.setLevel(logging.DEBUG)
+    logger.addHandler(handler)
+
+    # Suppress pika vendor library logs unless context_tracking debug is on.
+    # set_pika_log_level() in amqp.py will override this to DEBUG if needed.
+    logging.getLogger("rez.vendor.pika").setLevel(logging.CRITICAL)
+
+
+_init_logging()
+
+
+# actions registered on SIGUSR1
+action = os.getenv("REZ_SIGUSR1_ACTION")
+if action:
+    import signal
+    import traceback
+
+    if action == "print_stack":
+        def callback(sig, frame) -> None:
+            txt = ''.join(traceback.format_stack(frame))
+            print()
+            print(txt)
+    else:
+        callback = None
+
+    if callback:
+        signal.signal(signal.SIGUSR1, callback)  # Register handler
+
+
+# Log all rez warnings, ignoring possible user defined warning filters.
+# We can't tell users to use something like PYTHONWARNINGS=default::rez.deprecations.RezDeprecationWarning
+# because python reads PYTHONWARNINGS before it actually can import modules. So it
+# basically can't import rez when PYTHONWARNINGS is read.
+# This means we have to rely on a custom environment variable.
+if os.getenv("REZ_LOG_DEPRECATION_WARNINGS"):
+    warnings.filterwarnings("default", category=rez.deprecations.RezDeprecationWarning)

rez-3.4.0/src/rez/bind/_pymodule.py

@@ -0,0 +1,120 @@
+# SPDX-License-Identifier: Apache-2.0
+# Copyright Contributors to the Rez Project
+
+
+"""
+Binds a python module to rez.
+
+Note that we subproc out to python at various points here because we can't use
+the current python interpreter - this is rez's, inside its installation
+virtualenv.
+"""
+from rez.bind._utils import check_version, find_exe, make_dirs, \
+    get_version_in_python, run_python_command, log
+from rez.package_maker import make_package
+from rez.exceptions import RezBindError
+from rez.system import system
+from rez.utils.logging_ import print_warning
+import shutil
+import sys
+import os.path
+
+
+def commands() -> None:
+    env.PYTHONPATH.append('{this.root}/python')
+
+
+def commands_with_bin() -> None:
+    env.PYTHONPATH.append('{this.root}/python')
+    env.PATH.append('{this.root}/bin')
+
+
+def copy_module(name, destpath):
+    success, out, err = run_python_command(
+        ["import %s" % name,
+         "print(%s.__path__[0] if hasattr(%s, '__path__') else '')" % (name, name)])
+
+    if out:
+        srcpath = out
+        shutil.copytree(srcpath, os.path.join(destpath, name))
+    else:
+        success, out, err = run_python_command(
+            ["import %s" % name,
+             "print(%s.__file__)" % name])
+        if not success:
+            raise RezBindError("Couldn't locate module %s: %s" % (name, err))
+
+        srcfile = out
+        dirpart, ext = os.path.splitext(srcfile)
+
+        if ext == ".pyc":
+            pyfile = dirpart + ".py"
+            if os.path.exists(pyfile):
+                srcfile = pyfile
+
+        destfile = os.path.join(destpath, os.path.basename(srcfile))
+        shutil.copy2(srcfile, destfile)
+
+
+def bind(name, path, import_name=None, version_range=None, version=None,
+         requires=None, pure_python=None, tools=None, extra_module_names=[],
+         extra_attrs={}):
+    import_name = import_name or name
+
+    if version is None:
+        version = get_version_in_python(
+            name,
+            ["import %s" % import_name,
+             "print(%s.__version__)" % import_name])
+
+    check_version(version, version_range)
+
+    py_major_minor = '.'.join(str(x) for x in sys.version_info[:2])
+    py_req = "python-%s" % py_major_minor
+    found_tools = {}
+
+    if pure_python is None:
+        raise NotImplementedError  # detect
+    elif pure_python:
+        variant = [py_req]
+    else:
+        variant = system.variant + [py_req]
+
+    for tool in (tools or []):
+        try:
+            src = find_exe(tool)
+            found_tools[tool] = src
+            log("found tool '%s': %s" % (tool, src))
+        except RezBindError as e:
+            print_warning(str(e))
+
+    def make_root(variant, root) -> None:
+        pypath = make_dirs(root, "python")
+        copy_module(import_name, pypath)
+
+        if found_tools:
+            binpath = make_dirs(root, "bin")
+            for tool, src in sorted(found_tools.items()):
+                dest = os.path.join(binpath, tool)
+                shutil.copy2(src, dest)
+
+        for name_ in extra_module_names:
+            copy_module(name_, pypath)
+
+    with make_package(name, path, make_root=make_root) as pkg:
+        pkg.version = version
+        pkg.variants = [variant]
+
+        if requires:
+            pkg.requires = requires
+
+        if found_tools:
+            pkg.tools = list(found_tools)
+            pkg.commands = commands_with_bin
+        else:
+            pkg.commands = commands
+
+        for key, value in extra_attrs.items():
+            pkg[key] = value
+
+    return pkg.installed_variants