-
Notifications
You must be signed in to change notification settings - Fork 837
Add optional dependencies with extras for selective instrumentation #3427
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
base: main
Are you sure you want to change the base?
Changes from 1 commit
58172f5
93eaecd
af7e1be
5bc321a
e1d8859
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
| @@ -0,0 +1,247 @@ | ||||||
| <# | ||||||
| .Synopsis | ||||||
| Activate a Python virtual environment for the current PowerShell session. | ||||||
| .Description | ||||||
| Pushes the python executable for a virtual environment to the front of the | ||||||
| $Env:PATH environment variable and sets the prompt to signify that you are | ||||||
| in a Python virtual environment. Makes use of the command line switches as | ||||||
| well as the `pyvenv.cfg` file values present in the virtual environment. | ||||||
| .Parameter VenvDir | ||||||
| Path to the directory that contains the virtual environment to activate. The | ||||||
| default value for this is the parent of the directory that the Activate.ps1 | ||||||
| script is located within. | ||||||
| .Parameter Prompt | ||||||
| The prompt prefix to display when this virtual environment is activated. By | ||||||
| default, this prompt is the name of the virtual environment folder (VenvDir) | ||||||
| surrounded by parentheses and followed by a single space (ie. '(.venv) '). | ||||||
| .Example | ||||||
| Activate.ps1 | ||||||
| Activates the Python virtual environment that contains the Activate.ps1 script. | ||||||
| .Example | ||||||
| Activate.ps1 -Verbose | ||||||
| Activates the Python virtual environment that contains the Activate.ps1 script, | ||||||
| and shows extra information about the activation as it executes. | ||||||
| .Example | ||||||
| Activate.ps1 -VenvDir C:\Users\MyUser\Common\.venv | ||||||
| Activates the Python virtual environment located in the specified location. | ||||||
| .Example | ||||||
| Activate.ps1 -Prompt "MyPython" | ||||||
| Activates the Python virtual environment that contains the Activate.ps1 script, | ||||||
| and prefixes the current prompt with the specified string (surrounded in | ||||||
| parentheses) while the virtual environment is active. | ||||||
| .Notes | ||||||
| On Windows, it may be required to enable this Activate.ps1 script by setting the | ||||||
| execution policy for the user. You can do this by issuing the following PowerShell | ||||||
| command: | ||||||
| PS C:\> Set-ExecutionPolicy -ExecutionPolicy RemoteSigned -Scope CurrentUser | ||||||
| For more information on Execution Policies: | ||||||
| https://go.microsoft.com/fwlink/?LinkID=135170 | ||||||
| #> | ||||||
| Param( | ||||||
| [Parameter(Mandatory = $false)] | ||||||
| [String] | ||||||
| $VenvDir, | ||||||
| [Parameter(Mandatory = $false)] | ||||||
| [String] | ||||||
| $Prompt | ||||||
| ) | ||||||
|
|
||||||
| <# Function declarations --------------------------------------------------- #> | ||||||
|
|
||||||
| <# | ||||||
| .Synopsis | ||||||
| Remove all shell session elements added by the Activate script, including the | ||||||
| addition of the virtual environment's Python executable from the beginning of | ||||||
| the PATH variable. | ||||||
| .Parameter NonDestructive | ||||||
| If present, do not remove this function from the global namespace for the | ||||||
| session. | ||||||
| #> | ||||||
| function global:deactivate ([switch]$NonDestructive) { | ||||||
| # Revert to original values | ||||||
|
|
||||||
| # The prior prompt: | ||||||
| if (Test-Path -Path Function:_OLD_VIRTUAL_PROMPT) { | ||||||
| Copy-Item -Path Function:_OLD_VIRTUAL_PROMPT -Destination Function:prompt | ||||||
| Remove-Item -Path Function:_OLD_VIRTUAL_PROMPT | ||||||
| } | ||||||
|
|
||||||
| # The prior PYTHONHOME: | ||||||
| if (Test-Path -Path Env:_OLD_VIRTUAL_PYTHONHOME) { | ||||||
| Copy-Item -Path Env:_OLD_VIRTUAL_PYTHONHOME -Destination Env:PYTHONHOME | ||||||
| Remove-Item -Path Env:_OLD_VIRTUAL_PYTHONHOME | ||||||
| } | ||||||
|
|
||||||
| # The prior PATH: | ||||||
| if (Test-Path -Path Env:_OLD_VIRTUAL_PATH) { | ||||||
| Copy-Item -Path Env:_OLD_VIRTUAL_PATH -Destination Env:PATH | ||||||
| Remove-Item -Path Env:_OLD_VIRTUAL_PATH | ||||||
| } | ||||||
|
|
||||||
| # Just remove the VIRTUAL_ENV altogether: | ||||||
| if (Test-Path -Path Env:VIRTUAL_ENV) { | ||||||
| Remove-Item -Path env:VIRTUAL_ENV | ||||||
| } | ||||||
|
|
||||||
| # Just remove VIRTUAL_ENV_PROMPT altogether. | ||||||
| if (Test-Path -Path Env:VIRTUAL_ENV_PROMPT) { | ||||||
| Remove-Item -Path env:VIRTUAL_ENV_PROMPT | ||||||
| } | ||||||
|
|
||||||
| # Just remove the _PYTHON_VENV_PROMPT_PREFIX altogether: | ||||||
| if (Get-Variable -Name "_PYTHON_VENV_PROMPT_PREFIX" -ErrorAction SilentlyContinue) { | ||||||
| Remove-Variable -Name _PYTHON_VENV_PROMPT_PREFIX -Scope Global -Force | ||||||
| } | ||||||
|
|
||||||
| # Leave deactivate function in the global namespace if requested: | ||||||
| if (-not $NonDestructive) { | ||||||
| Remove-Item -Path function:deactivate | ||||||
| } | ||||||
| } | ||||||
|
|
||||||
| <# | ||||||
| .Description | ||||||
| Get-PyVenvConfig parses the values from the pyvenv.cfg file located in the | ||||||
| given folder, and returns them in a map. | ||||||
| For each line in the pyvenv.cfg file, if that line can be parsed into exactly | ||||||
| two strings separated by `=` (with any amount of whitespace surrounding the =) | ||||||
| then it is considered a `key = value` line. The left hand string is the key, | ||||||
| the right hand is the value. | ||||||
| If the value starts with a `'` or a `"` then the first and last character is | ||||||
| stripped from the value before being captured. | ||||||
| .Parameter ConfigDir | ||||||
| Path to the directory that contains the `pyvenv.cfg` file. | ||||||
| #> | ||||||
| function Get-PyVenvConfig( | ||||||
| [String] | ||||||
| $ConfigDir | ||||||
| ) { | ||||||
| Write-Verbose "Given ConfigDir=$ConfigDir, obtain values in pyvenv.cfg" | ||||||
|
|
||||||
| # Ensure the file exists, and issue a warning if it doesn't (but still allow the function to continue). | ||||||
| $pyvenvConfigPath = Join-Path -Resolve -Path $ConfigDir -ChildPath 'pyvenv.cfg' -ErrorAction Continue | ||||||
|
|
||||||
| # An empty map will be returned if no config file is found. | ||||||
| $pyvenvConfig = @{ } | ||||||
|
|
||||||
| if ($pyvenvConfigPath) { | ||||||
|
|
||||||
| Write-Verbose "File exists, parse `key = value` lines" | ||||||
| $pyvenvConfigContent = Get-Content -Path $pyvenvConfigPath | ||||||
|
|
||||||
| $pyvenvConfigContent | ForEach-Object { | ||||||
| $keyval = $PSItem -split "\s*=\s*", 2 | ||||||
| if ($keyval[0] -and $keyval[1]) { | ||||||
| $val = $keyval[1] | ||||||
|
|
||||||
| # Remove extraneous quotations around a string value. | ||||||
| if ("'""".Contains($val.Substring(0, 1))) { | ||||||
| $val = $val.Substring(1, $val.Length - 2) | ||||||
| } | ||||||
|
|
||||||
| $pyvenvConfig[$keyval[0]] = $val | ||||||
| Write-Verbose "Adding Key: '$($keyval[0])'='$val'" | ||||||
| } | ||||||
| } | ||||||
| } | ||||||
| return $pyvenvConfig | ||||||
| } | ||||||
|
|
||||||
|
|
||||||
| <# Begin Activate script --------------------------------------------------- #> | ||||||
|
|
||||||
| # Determine the containing directory of this script | ||||||
| $VenvExecPath = Split-Path -Parent $MyInvocation.MyCommand.Definition | ||||||
| $VenvExecDir = Get-Item -Path $VenvExecPath | ||||||
|
|
||||||
| Write-Verbose "Activation script is located in path: '$VenvExecPath'" | ||||||
| Write-Verbose "VenvExecDir Fullname: '$($VenvExecDir.FullName)" | ||||||
|
||||||
| Write-Verbose "VenvExecDir Fullname: '$($VenvExecDir.FullName)" | |
| Write-Verbose "VenvExecDir Fullname: '$($VenvExecDir.FullName)'" |
coderabbitai[bot] marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
| @@ -0,0 +1,70 @@ | ||||||
| # This file must be used with "source bin/activate" *from bash* | ||||||
| # You cannot run it directly | ||||||
|
|
||||||
| deactivate () { | ||||||
| # reset old environment variables | ||||||
| if [ -n "${_OLD_VIRTUAL_PATH:-}" ] ; then | ||||||
| PATH="${_OLD_VIRTUAL_PATH:-}" | ||||||
| export PATH | ||||||
| unset _OLD_VIRTUAL_PATH | ||||||
| fi | ||||||
| if [ -n "${_OLD_VIRTUAL_PYTHONHOME:-}" ] ; then | ||||||
| PYTHONHOME="${_OLD_VIRTUAL_PYTHONHOME:-}" | ||||||
| export PYTHONHOME | ||||||
| unset _OLD_VIRTUAL_PYTHONHOME | ||||||
| fi | ||||||
|
|
||||||
| # Call hash to forget past commands. Without forgetting | ||||||
| # past commands the $PATH changes we made may not be respected | ||||||
| hash -r 2> /dev/null | ||||||
|
|
||||||
| if [ -n "${_OLD_VIRTUAL_PS1:-}" ] ; then | ||||||
| PS1="${_OLD_VIRTUAL_PS1:-}" | ||||||
| export PS1 | ||||||
| unset _OLD_VIRTUAL_PS1 | ||||||
| fi | ||||||
|
|
||||||
| unset VIRTUAL_ENV | ||||||
| unset VIRTUAL_ENV_PROMPT | ||||||
| if [ ! "${1:-}" = "nondestructive" ] ; then | ||||||
| # Self destruct! | ||||||
| unset -f deactivate | ||||||
| fi | ||||||
| } | ||||||
|
|
||||||
| # unset irrelevant variables | ||||||
| deactivate nondestructive | ||||||
|
|
||||||
| # on Windows, a path can contain colons and backslashes and has to be converted: | ||||||
| if [ "${OSTYPE:-}" = "cygwin" ] || [ "${OSTYPE:-}" = "msys" ] ; then | ||||||
| # transform D:\path\to\venv to /d/path/to/venv on MSYS | ||||||
| # and to /cygdrive/d/path/to/venv on Cygwin | ||||||
| export VIRTUAL_ENV=$(cygpath /home/harsha08_2k6/Desktop/openllmetry/myenv) | ||||||
| else | ||||||
| # use the path as-is | ||||||
| export VIRTUAL_ENV=/home/harsha08_2k6/Desktop/openllmetry/myenv | ||||||
| fi | ||||||
|
|
||||||
| _OLD_VIRTUAL_PATH="$PATH" | ||||||
| PATH="$VIRTUAL_ENV/"bin":$PATH" | ||||||
|
||||||
| PATH="$VIRTUAL_ENV/"bin":$PATH" | |
| PATH="$VIRTUAL_ENV/bin:$PATH" |
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
| @@ -0,0 +1,27 @@ | ||||||
| # This file must be used with "source bin/activate.csh" *from csh*. | ||||||
| # You cannot run it directly. | ||||||
|
|
||||||
| # Created by Davide Di Blasi <davidedb@gmail.com>. | ||||||
| # Ported to Python 3.3 venv by Andrew Svetlov <andrew.svetlov@gmail.com> | ||||||
|
|
||||||
| alias deactivate 'test $?_OLD_VIRTUAL_PATH != 0 && setenv PATH "$_OLD_VIRTUAL_PATH" && unset _OLD_VIRTUAL_PATH; rehash; test $?_OLD_VIRTUAL_PROMPT != 0 && set prompt="$_OLD_VIRTUAL_PROMPT" && unset _OLD_VIRTUAL_PROMPT; unsetenv VIRTUAL_ENV; unsetenv VIRTUAL_ENV_PROMPT; test "\!:*" != "nondestructive" && unalias deactivate' | ||||||
|
|
||||||
| # Unset irrelevant variables. | ||||||
| deactivate nondestructive | ||||||
|
|
||||||
| setenv VIRTUAL_ENV /home/harsha08_2k6/Desktop/openllmetry/myenv | ||||||
|
|
||||||
| set _OLD_VIRTUAL_PATH="$PATH" | ||||||
| setenv PATH "$VIRTUAL_ENV/"bin":$PATH" | ||||||
|
||||||
| setenv PATH "$VIRTUAL_ENV/"bin":$PATH" | |
| setenv PATH "$VIRTUAL_ENV/bin:$PATH" |
🤖 Prompt for AI Agents
In myenv/bin/activate.csh at line 15, the PATH assignment uses incorrect quoting
which inserts a literal "bin" token; replace the current line with the canonical
virtualenv form that appends the venv's bin directory to PATH (i.e., construct
the string so $VIRTUAL_ENV and "/bin" are concatenated before :$PATH), making
the PATH entry valid in csh.
Outdated
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🧩 Analysis chain
Remove committed virtualenv; align PR with “extras” objective instead.
This file (and the whole myenv/ directory) is auto‑generated, machine‑specific, and includes absolute paths with your username. It should not be versioned and will break for other devs/CI and leaks local paths. Please drop myenv/ from the PR, add it to .gitignore, and implement optional deps via packaging extras (pyproject.toml) as per the PR title.
Add ignore rules:
+# Python venvs and artifacts
+myenv/
+.venv/
+venv/
+**/__pycache__/
+*.pycExample packaging extras (PEP 621):
[project.optional-dependencies]
instrumentation = ["opentelemetry-sdk>=1.27", "opentelemetry-instrumentation-httpx>=0.47"]
httpx = ["httpx>=0.27"]
openai = ["openai>=1.50"]
# pip install .[instrumentation,httpx]Verification script (lists venv artifacts to remove):
🏁 Script executed:
#!/bin/bash
fd -HI --type d '^(myenv|\.venv|venv)$' 2>/dev/null || true
fd -HI --type f 'pyvenv\.cfg|Activate\.ps1|/bin/activate(\.csh|\.fish)?$|/bin/activate$' 2>/dev/null || trueLength of output: 46
---
🏁 Script executed:
```shell
#!/bin/bash
# Check if .gitignore exists and whether myenv/ is already ignored
if [ -f .gitignore ]; then
echo "=== .gitignore content ==="
cat .gitignore
else
echo ".gitignore does not exist"
fi
echo ""
echo "=== Checking for pyproject.toml ==="
if [ -f pyproject.toml ]; then
echo "pyproject.toml found"
grep -A 20 "\[project" pyproject.toml || echo "No [project] section found"
grep -A 10 "optional-dependencies" pyproject.toml || echo "No optional-dependencies found"
else
echo "pyproject.toml not found"
fi
echo ""
echo "=== Checking for setup.py ==="
ls -la setup.py 2>/dev/null || echo "setup.py not found"
Length of output: 2319
🏁 Script executed:
#!/bin/bash
# Check setup.py for optional dependencies structure
echo "=== setup.py content ==="
cat setup.pyLength of output: 2814
Remove committed virtualenv directory from PR.
The myenv/ directory is auto-generated, machine-specific, and contains absolute paths with your username. It should not be versioned and will break for other developers/CI. Remove it from this PR.
Update .gitignore to explicitly include:
# Environments
.env
.venv
env/
venv/
+myenv/
ENV/
env.bak/
venv.bak/Note: The repo already has optional dependencies configured in setup.py under extras_require (full, minimal, openai, langchain), so no additional packaging configuration is needed.
Committable suggestion skipped: line range outside the PR's diff.
🤖 Prompt for AI Agents
In myenv/bin/activate.csh lines 1-27, the review points out that the committed
myenv/ virtualenv is machine-specific and must be removed from the PR; remove
the entire myenv/ directory from the repository (stop tracking and delete it
from the index/commit), add a line to .gitignore to ignore myenv/ (and verify no
other venv artifacts are committed), then commit the removal and updated
.gitignore so the virtualenv and its absolute-path files are not versioned going
forward.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Guard quote trimming to avoid Substring exceptions on short values.
If a value is only one char,
$val.Substring(1, $val.Length - 2)throws. Safer:📝 Committable suggestion
🤖 Prompt for AI Agents