setup.py

import os
import platform
import sys

from setuptools import setup, find_packages, Extension
from setuptools.command.test import test as TestCommand

# ORDER MATTERS
# Import this after setuptools or it will fail
from Cython.Build import cythonize  # noqa: I100
import Cython.Distutils


HERE = os.path.dirname(os.path.abspath(__file__))


def load_module_from_project_file(mod_name, fname):
    """
    Helper used to load a module from a file in this project

    DEV: Loading this way will by-pass loading all parent modules
         e.g. importing `ddtrace.vendor.psutil.setup` will load `ddtrace/__init__.py`
         which has side effects like loading the tracer
    """
    fpath = os.path.join(HERE, fname)

    if sys.version_info >= (3, 5):
        import importlib.util

        spec = importlib.util.spec_from_file_location(mod_name, fpath)
        mod = importlib.util.module_from_spec(spec)
        spec.loader.exec_module(mod)
        return mod
    elif sys.version_info >= (3, 3):
        from importlib.machinery import SourceFileLoader

        return SourceFileLoader(mod_name, fpath).load_module()
    else:
        import imp

        return imp.load_source(mod_name, fpath)


class Tox(TestCommand):

    user_options = [("tox-args=", "a", "Arguments to pass to tox")]

    def initialize_options(self):
        TestCommand.initialize_options(self)
        self.tox_args = None

    def finalize_options(self):
        TestCommand.finalize_options(self)
        self.test_args = []
        self.test_suite = True

    def run_tests(self):
        # import here, cause outside the eggs aren't loaded
        import tox
        import shlex

        args = self.tox_args
        if args:
            args = shlex.split(self.tox_args)
        errno = tox.cmdline(args=args)
        sys.exit(errno)


long_description = """
# dd-trace-py

`ddtrace` is Datadog's tracing library for Python.  It is used to trace requests
as they flow across web servers, databases and microservices so that developers
have great visiblity into bottlenecks and troublesome requests.

## Getting Started

For a basic product overview, installation and quick start, check out our
[setup documentation][setup docs].

For more advanced usage and configuration, check out our [API
documentation][api docs].

For descriptions of terminology used in APM, take a look at the [official
documentation][visualization docs].

[setup docs]: https://docs.datadoghq.com/tracing/setup/python/
[api docs]: https://ddtrace.readthedocs.io/
[visualization docs]: https://docs.datadoghq.com/tracing/visualization/
"""


def get_exts_for(name):
    try:
        mod = load_module_from_project_file(
            "ddtrace.vendor.{}.setup".format(name), "ddtrace/vendor/{}/setup.py".format(name)
        )
        return mod.get_extensions()
    except Exception as e:
        print("WARNING: Failed to load %s extensions, skipping: %s" % (name, e))
        return []


if sys.byteorder == "big":
    encoding_macros = [("__BIG_ENDIAN__", "1")]
else:
    encoding_macros = [("__LITTLE_ENDIAN__", "1")]


if platform.system() == "Windows":
    encoding_libraries = ["ws2_32"]
    extra_compile_args = []
    debug_compile_args = []
else:
    encoding_libraries = []
    extra_compile_args = ["-DPy_BUILD_CORE"]
    if "DD_COMPILE_DEBUG" in os.environ:
        if platform.system() == "Linux":
            debug_compile_args = ["-g", "-O0", "-Werror", "-Wall", "-Wextra", "-Wpedantic", "-fanalyzer"]
        else:
            debug_compile_args = [
                "-g",
                "-O0",
                "-Werror",
                "-Wall",
                "-Wextra",
                "-Wpedantic",
                "-Wno-deprecated-declarations",
            ]
    else:
        debug_compile_args = []


if sys.version_info[:2] >= (3, 4):
    ext_modules = [
        Extension(
            "ddtrace.profiling.collector._memalloc",
            sources=["ddtrace/profiling/collector/_memalloc.c", "ddtrace/profiling/collector/_memalloc_tb.c"],
            extra_compile_args=debug_compile_args,
        ),
    ]
else:
    ext_modules = []

# Base `setup()` kwargs without any C-extension registering
setup(
    **dict(
        name="ddtrace",
        description="Datadog tracing code",
        url="https://github.com/DataDog/dd-trace-py",
        author="Datadog, Inc.",
        author_email="dev@datadoghq.com",
        long_description=long_description,
        long_description_content_type="text/markdown",
        license="BSD",
        packages=find_packages(exclude=["tests*"]),
        python_requires=">=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*, !=3.4.*",
        # enum34 is an enum backport for earlier versions of python
        # funcsigs backport required for vendored debtcollector
        install_requires=[
            "enum34; python_version<'3.4'",
            "funcsigs>=1.0.0; python_version=='2.7'",
            "typing; python_version<'3.5'",
            "protobuf>=3",
            "intervaltree",
            "tenacity>=5",
        ],
        extras_require={
            # users can include opentracing by having:
            # install_requires=['ddtrace[opentracing]', ...]
            "opentracing": ["opentracing>=2.0.0"],
        },
        # plugin tox
        tests_require=["tox", "flake8"],
        cmdclass={"test": Tox, "build_ext": Cython.Distutils.build_ext},
        entry_points={
            "console_scripts": [
                "ddtrace-run = ddtrace.commands.ddtrace_run:main",
                "pyddprofile = ddtrace.profiling.__main__:main",
            ],
            "pytest11": ["ddtrace = ddtrace.contrib.pytest.plugin"],
            "gevent.plugins.monkey.did_patch_all": [
                "ddtrace.profiling.profiler = ddtrace.profiling.profiler:gevent_patch_all",
            ],
        },
        classifiers=[
            "Programming Language :: Python",
            "Programming Language :: Python :: 2.7",
            "Programming Language :: Python :: 3.5",
            "Programming Language :: Python :: 3.6",
            "Programming Language :: Python :: 3.7",
            "Programming Language :: Python :: 3.8",
            "Programming Language :: Python :: 3.9",
        ],
        use_scm_version=True,
        setup_requires=["setuptools_scm[toml]>=4", "cython"],
        ext_modules=ext_modules
        + cythonize(
            [
                Cython.Distutils.Extension(
                    "ddtrace.internal._rand",
                    sources=["ddtrace/internal/_rand.pyx"],
                    language="c",
                ),
                Extension(
                    "ddtrace.internal._encoding",
                    ["ddtrace/internal/_encoding.pyx"],
                    include_dirs=["."],
                    libraries=encoding_libraries,
                    define_macros=encoding_macros,
                ),
                Cython.Distutils.Extension(
                    "ddtrace.profiling.collector.stack",
                    sources=["ddtrace/profiling/collector/stack.pyx"],
                    language="c",
                    extra_compile_args=extra_compile_args,
                ),
                Cython.Distutils.Extension(
                    "ddtrace.profiling.collector._traceback",
                    sources=["ddtrace/profiling/collector/_traceback.pyx"],
                    language="c",
                ),
                Cython.Distutils.Extension(
                    "ddtrace.profiling.collector._threading",
                    sources=["ddtrace/profiling/collector/_threading.pyx"],
                    language="c",
                ),
                Cython.Distutils.Extension(
                    "ddtrace.profiling.exporter.pprof",
                    sources=["ddtrace/profiling/exporter/pprof.pyx"],
                    language="c",
                ),
                Cython.Distutils.Extension(
                    "ddtrace.profiling._build",
                    sources=["ddtrace/profiling/_build.pyx"],
                    language="c",
                ),
            ],
            compile_time_env={
                "PY_MAJOR_VERSION": sys.version_info.major,
                "PY_MINOR_VERSION": sys.version_info.minor,
                "PY_MICRO_VERSION": sys.version_info.micro,
            },
            force=True,
        )
        + get_exts_for("wrapt")
        + get_exts_for("psutil"),
    )
)