Skip to content

docs: upgrade pip command to install build system dependencies #13244

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

smola
Copy link
Member

@smola smola commented Apr 21, 2025

Upgrade pip command to install build system dependencies. Option --no-install is not a valid option since pip 7 (release notes).

Checklist

  • PR author has checked that all the criteria below are met
  • The PR description includes an overview of the change
  • The PR description articulates the motivation for the change
  • The change includes tests OR the PR description describes a testing strategy
  • The PR description notes risks associated with the change, if any
  • Newly-added code is easy to change
  • The change follows the library release note guidelines
  • The change includes or references documentation updates if necessary
  • Backport labels are set (if applicable)

Reviewer Checklist

  • Reviewer has checked that all the criteria below are met
  • Title is accurate
  • All changes are related to the pull request's stated goal
  • Avoids breaking API changes
  • Testing strategy adequately addresses listed risks
  • Newly-added code is easy to change
  • Release note makes sense to a user of the library
  • If necessary, author has acknowledged and discussed the performance implications of this PR as reported in the benchmarks PR comment
  • Backport labels are set in a manner that is consistent with the release branch maintenance policy

@smola smola added changelog/no-changelog A changelog entry is not required for this PR. Installation Issues related to installing or building dd-trace-py labels Apr 21, 2025
@smola smola requested a review from a team as a code owner April 21, 2025 14:50
@smola smola requested a review from P403n1x87 April 21, 2025 14:50
Copy link
Contributor

CODEOWNERS have been resolved as:

docs/build_system.rst                                                   @DataDog/python-guild

Copy link
Contributor

Bootstrap import analysis

Comparison of import times between this PR and base.

Summary

The average import time from this PR is: 229 ± 2 ms.

The average import time from base is: 232 ± 1 ms.

The import time difference between this PR and base is: -2.56 ± 0.07 ms.

Import time breakdown

The following import paths have shrunk:

ddtrace.auto 2.028 ms (0.88%)
ddtrace.bootstrap.sitecustomize 1.326 ms (0.58%)
ddtrace.bootstrap.preload 1.326 ms (0.58%)
ddtrace.internal.products 1.326 ms (0.58%)
ddtrace.internal.remoteconfig.client 0.629 ms (0.27%)
ddtrace 0.701 ms (0.31%)
ddtrace._logger 0.030 ms (0.01%)
logging 0.030 ms (0.01%)
traceback 0.030 ms (0.01%)
contextlib 0.030 ms (0.01%)

@pr-commenter
Copy link

pr-commenter bot commented Apr 21, 2025

Benchmarks

Benchmark execution time: 2025-04-21 18:35:11

Comparing candidate commit b2d78ce in PR branch smola/update-docs-build-system with baseline commit 997a12e in branch main.

Found 0 performance improvements and 1 performance regressions! Performance is the same for 500 metrics, 7 unstable metrics.

scenario:iast_aspects-replace_aspect

  • 🟥 execution_time [+453.794ns; +591.506ns] or [+9.712%; +12.660%]

@@ -47,7 +47,7 @@ To install all dependencies in one step, use:

.. code-block:: bash

pip install . --no-build-isolation --no-install
pip install 'setuptools_scm[toml]>=4' 'cython' 'cmake>=3.24.2,<3.28' 'setuptools-rust<2'
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This could be simplified with pip install '.[build-system]'

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@emmettbutler The command appears to work but I see the following warning:

WARNING: ddtrace 3.6.0.dev16+gb2d78cefb does not provide the extra 'build-system'

Also the point of the command seemed to be installed deps without building the project, but that actually builds it.

@smola smola enabled auto-merge (squash) April 23, 2025 10:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
changelog/no-changelog A changelog entry is not required for this PR. Installation Issues related to installing or building dd-trace-py
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants