Title: Regression: `venv` virtual environments not providing `pydoc` · Issue #117871 · python/cpython · GitHub
Open Graph Title: Regression: `venv` virtual environments not providing `pydoc` · Issue #117871 · python/cpython
X Title: Regression: `venv` virtual environments not providing `pydoc` · Issue #117871 · python/cpython
Description: Bug report Bug description: I started a new python project today and naturally did this within a venv virtual environment. Hitting some frustration on not seeing any documentation on the web pages for the modules I was utilising I turned...
Open Graph Description: Bug report Bug description: I started a new python project today and naturally did this within a venv virtual environment. Hitting some frustration on not seeing any documentation on the web pages ...
X Description: Bug report Bug description: I started a new python project today and naturally did this within a venv virtual environment. Hitting some frustration on not seeing any documentation on the web pages ...
Opengraph URL: https://github.com/python/cpython/issues/117871
X: @github
Domain: github.com
{"@context":"https://schema.org","@type":"DiscussionForumPosting","headline":"Regression: `venv` virtual environments not providing `pydoc`","articleBody":"# Bug report\n\n### Bug description:\n\nI started a new python project today and naturally did this within a `venv` virtual environment. Hitting some frustration on not seeing any documentation on the web pages for the modules I was utilising I turned to `pydoc`, but it found nothing. On checking the actual installed files for the modules they did have docstrings.\n\n`python -m pydoc ...` worked properly.\n\nUpon checking `which pydoc` pointed out I was still using the system `pydoc`, which would of course have no knowledge of the `venv` library path in order to look inside it for relevant documentation.\n\nI found https://github.com/python/cpython/issues/59362 from 2012, which claims to have address this, so this is clearly a regression, but I've no idea when it was introduced.\n\nI'm doing all of this on a Debian bookwork 12.5 system which is up to date. I've rested using a `pyenv` installed Python 3.12.3. I also have no pydoc in `\u003cvenv>/Scripts` on Windows (with Python from python.org installers) `venv`s.\n\n1. Set up `pyenv` using latest from https://github.com/pyenv/pyenv.git\n2. Ensure it's active, i.e. setting PATH and PYENV_ROOT, then performing shell initialisation.\n3. `pyenv install 3.12.3`\n4. `pyenv local 3.12.3` and confirm with `which python` and `python --version` that it's using it.\n5. `python -m venv venv-no-pydoc`\n\nThese are the contents:\n```bash\n15:27:36 0$ ls -al venv-no-pydoc/bin/\ntotal 44\ndrwx------ 2 athan athan 4096 Apr 14 15:27 ./\ndrwx------ 5 athan athan 4096 Apr 14 15:27 ../\n-rw-r--r-- 1 athan athan 9033 Apr 14 15:27 Activate.ps1\n-rw-r--r-- 1 athan athan 2064 Apr 14 15:27 activate\n-rw-r--r-- 1 athan athan 941 Apr 14 15:27 activate.csh\n-rw-r--r-- 1 athan athan 2220 Apr 14 15:27 activate.fish\n-rwxr-xr-x 1 athan athan 245 Apr 14 15:27 pip*\n-rwxr-xr-x 1 athan athan 245 Apr 14 15:27 pip3*\n-rwxr-xr-x 1 athan athan 245 Apr 14 15:27 pip3.12*\nlrwxrwxrwx 1 athan athan 43 Apr 14 15:27 python -> /usr/local/pyenv/versions/3.12.3/bin/python*\nlrwxrwxrwx 1 athan athan 6 Apr 14 15:27 python3 -> python*\nlrwxrwxrwx 1 athan athan 6 Apr 14 15:27 python3.12 -> python*\n```\nI've worked around the issue in my project `venv` by setting up `.venv/bin/pydoc` with contents:\n```python\n#!/usr/local/src/fysh-geoip-country/maxmind-geoip-country/.venv/bin/python\n# -*- coding: utf-8 -*-\n\nimport pydoc\nimport sys\n\nsys.path.append('/usr/local/src/fysh-geoip-country/maxmind-geoip-country/.venv/lib')\nif __name__ == '__main__':\n pydoc.cli()\n```\nUsing the full path on the `#!` line is how the provided `pip` script is set up, so there's no reason that the same code that achieves that couldn't also include the `sys.path.append(...)` line, or other equivalent to ensure `pydoc` knows about the path.\n\n### CPython versions tested on:\n\n3.12\n\n### Operating systems tested on:\n\nLinux","author":{"url":"https://github.com/Athanasius","@type":"Person","name":"Athanasius"},"datePublished":"2024-04-14T14:39:32Z","url":"https://github.com/python/cpython/issues/117871"}
| react-profiling | 0 |
| react-import-map | react,react-dom,react-dom/client,react-dom/profiling,react-is,react/compiler-runtime,react/jsx-dev-runtime,react/jsx-runtime,scheduler@b8488ee2c322 |
| route-pattern | /_view_fragments/issues/show/:user_id/:repository/:id/issue_layout(.:format) |
| route-controller | voltron_issues_fragments |
| route-action | issue_layout |
| fetch-nonce | v2:4f6cde50-3288-cd8c-5e94-834b4fceb986 |
| current-catalog-service-hash | 81bb79d38c15960b92d99bca9288a9108c7a47b18f2423d0f6438c5b7bcd2114 |
| request-id | 80C2:3DD488:45A17F7:5857B0F:6B023F38 |
| html-safe-nonce | 6a257b35ac0fb011390e034efdf6340f9f98a2cf5c0b7fca85ac7ba5c7fa1d35 |
| visitor-payload | eyJyZWZlcnJlciI6IiIsInJlcXVlc3RfaWQiOiI4MEMyOjNERDQ4ODo0NUExN0Y3OjU4NTdCMEY6NkIwMjNGMzgiLCJ2aXNpdG9yX2lkIjoiODU3NTg5MzkxNjIwNzk1NTc2OCIsInJlZ2lvbl9lZGdlIjoiaWFkIiwicmVnaW9uX3JlbmRlciI6ImlhZCJ9 |
| visitor-hmac | ec4b6860462b7ed077a12532a57b85ceec1a9b47648732726626a73e03b9da0b |
| hovercard-subject-tag | issue:2242200222 |
| github-keyboard-shortcuts | repository,issues,copilot |
| google-site-verification | Apib7-x98H0j5cPqHWwSMm6dNU4GmODRoqxLiDzdx9I |
| octolytics-url | https://collector.github.com/github/collect |
| analytics-location | / |
| fb:app_id | 1401488693436528 |
| apple-itunes-app | app-id=1477376905, app-argument=https://github.com/_view_fragments/issues/show/python/cpython/117871/issue_layout |
| twitter:image | https://opengraph.githubassets.com/2644c1a3b82cdf2053073781c04fe54e990fc3603655844bdb92f12e7d1cd5af/python/cpython/issues/117871 |
| twitter:card | summary_large_image |
| og:image | https://opengraph.githubassets.com/2644c1a3b82cdf2053073781c04fe54e990fc3603655844bdb92f12e7d1cd5af/python/cpython/issues/117871 |
| og:image:alt | Bug report Bug description: I started a new python project today and naturally did this within a venv virtual environment. Hitting some frustration on not seeing any documentation on the web pages ... |
| og:image:width | 1200 |
| og:image:height | 600 |
| og:site_name | GitHub |
| og:type | object |
| og:author:username | Athanasius |
| hostname | github.com |
| expected-hostname | github.com |
| None | 87e774ee7c6b3bee0490394e4d3e57ec9dbc956f74b87ea685dc8996c1676456 |
| turbo-cache-control | no-preview |
| go-import | github.com/python/cpython git https://github.com/python/cpython.git |
| octolytics-dimension-user_id | 1525981 |
| octolytics-dimension-user_login | python |
| octolytics-dimension-repository_id | 81598961 |
| octolytics-dimension-repository_nwo | python/cpython |
| octolytics-dimension-repository_public | true |
| octolytics-dimension-repository_is_fork | false |
| octolytics-dimension-repository_network_root_id | 81598961 |
| octolytics-dimension-repository_network_root_nwo | python/cpython |
| turbo-body-classes | logged-out env-production page-responsive |
| disable-turbo | false |
| browser-stats-url | https://api.github.com/_private/browser/stats |
| browser-errors-url | https://api.github.com/_private/browser/errors |
| release | 423dbb54c5e7bfecc838eb387c1435eb3d0e760d |
| ui-target | full |
| theme-color | #1e2327 |
| color-scheme | light dark |
| react-app-name | issues |
Links:
Viewport: width=device-width