Is pipenv.core.inline_activate_virtual_environment() Supported as an API?

Issue description

Being able to activate you application virtual environment with just

import pipenv.core
pipenv.core.inline_activate_virtual_environment()

In you applications start script would be be useful feature, is it was long term supported; or a similiar
api publiccally exposed . Currently it is available but not documented. (as far as I can tell)

Expected result

I'd would expect pipenv.core.inline_activate_virtual_environment to have a non-empty docstring.,
and to silently activate the environment in all cases.

Actual result

Under windows; and when running in a IIS FastCgi module; importing pipenv.core fails to loas
asthe expression to evaluate SESSION_INTERACTIVE fails, as in the case sys.stderr, and sys.stdout have don't support getting the fileno attribute.

Traceback (most recent call last):
  File &quot;C:\python36\lib\site-packages\wfastcgi.py&quot;, line 791, in main
    env, handler = read_wsgi_handler(response.physical_path)
  File &quot;C:\python36\lib\site-packages\wfastcgi.py&quot;, line 633, in read_wsgi_handler
    handler = get_wsgi_handler(os.getenv(&quot;WSGI_HANDLER&quot;))
  File &quot;C:\python36\lib\site-packages\wfastcgi.py&quot;, line 600, in get_wsgi_handler
    handler = __import__(module_name, fromlist=[name_list[0][0]])
  File &quot;c:\users\administrator\documents\website\CoolerMovement\CoolerMovement\wsgi2.py&quot;, line 4, in &lt;module&gt;
    import pipenv.core
  File &quot;C:\python36\lib\site-packages\pipenv\__init__.py&quot;, line 23, in &lt;module&gt;
    from .cli import cli
  File &quot;C:\python36\lib\site-packages\pipenv\cli\__init__.py&quot;, line 3, in &lt;module&gt;
    from .command import cli
  File &quot;C:\python36\lib\site-packages\pipenv\cli\command.py&quot;, line 18, in &lt;module&gt;
    from .. import environments
  File &quot;C:\python36\lib\site-packages\pipenv\environments.py&quot;, line 226, in &lt;module&gt;
    SESSION_IS_INTERACTIVE = bool(os.isatty(sys.stdout.fileno()))
io.UnsupportedOperation: fileno

$ pipenv --support

Pipenv version: '2018.10.13'

Pipenv location: 'c:\\python36\\lib\\site-packages\\pipenv'

Python location: 'c:\\python36\\python.exe'

Python installations found:

3.6.6: C:\Python36\python.exe

PEP 508 Information:

{'implementation_name': 'cpython',
 'implementation_version': '3.6.6',
 'os_name': 'nt',
 'platform_machine': 'AMD64',
 'platform_python_implementation': 'CPython',
 'platform_release': '10',
 'platform_system': 'Windows',
 'platform_version': '10.0.14393',
 'python_full_version': '3.6.6',
 'python_version': '3.6',
 'sys_platform': 'win32'}

System environment variables:

ALLUSERSPROFILE
APPDATA
CHOCOLATEYINSTALL
CHOCOLATEYLASTPATHUPDATE
COMMONPROGRAMFILES
COMMONPROGRAMFILES(X86)
COMMONPROGRAMW6432
COMPUTERNAME
COMSPEC
HOMEDRIVE
HOMEPATH
LOCALAPPDATA
LOGONSERVER
NUMBER_OF_PROCESSORS
OS
PATH
PATHEXT
PROCESSOR_ARCHITECTURE
PROCESSOR_IDENTIFIER
PROCESSOR_LEVEL
PROCESSOR_REVISION
PROGRAMDATA
PROGRAMFILES
PROGRAMFILES(X86)
PROGRAMW6432
PSMODULEPATH
PUBLIC
SESSIONNAME
SYSTEMDRIVE
SYSTEMROOT
TEMP
TMP
USERDOMAIN
USERDOMAIN_ROAMINGPROFILE
USERNAME
USERPROFILE
WINDIR
PYTHONDONTWRITEBYTECODE
PIP_SHIMS_BASE_MODULE
PIP_PYTHON_PATH

Pipenvûspecific environment variables:

Debugûspecific environment variables:

PATH: C:\Python36\Scripts\;C:\Python36\;C:\Windows\system32;C:\Windows;C:\Windows\System32\Wbem;C:\Windows\System32\WindowsPowerShell\v1.0\;C:\ProgramData\chocolatey\bin;C:\Program Files\Git\cmd;C:\Users\Administrator\AppData\Local\Microsoft\WindowsApps;

Contents of Pipfile ('C:\Users\Administrator\Documents\website\Pipfile'):

[[source]]
verify_ssl = true
url = "https://pypi.org/simple"
name = "pypi"

[packages]
django = "*"
django-autocomplete-light = "*"
django-rest-auth = "*"
djangorestframework = "*"
django-filter = "*"

[dev-packages]

[requires]
python_version = "3.6"

Contents of Pipfile.lock ('C:\Users\Administrator\Documents\website\Pipfile.lock'):

{
    "_meta": {
        "hash": {
            "sha256": "f58428e831d95c883bb5a893384aab834ec55c1620e919896a499af9d08d1d56"
        },
        "pipfile-spec": 6,
        "requires": {
            "python_version": "3.5"
        },
        "sources": [
            {
                "name": "pypi",
                "url": "https://pypi.org/simple",
                "verify_ssl": true
            }
        ]
    },
    "default": {
        "django": {
            "hashes": [
                "sha256:acdcc1f61fdb0a0c82a1d3bf1879a414e7732ea894a7632af7f6d66ec7ab5bb3",
                "sha256:efbcad7ebb47daafbcead109b38a5bd519a3c3cd92c6ed0f691ff97fcdd16b45"
            ],
            "index": "pypi",
            "version": "==2.1.2"
        },
        "django-autocomplete-light": {
            "hashes": [
                "sha256:996cc62519a6e2e9cd1c26e57ddc5f14541209a93e62e83d7b3df3ba65c1f458"
            ],
            "index": "pypi",
            "version": "==3.3.2"
        },
        "django-filter": {
            "hashes": [
                "sha256:6f4e4bc1a11151178520567b50320e5c32f8edb552139d93ea3e30613b886f56",
                "sha256:86c3925020c27d072cdae7b828aaa5d165c2032a629abbe3c3a1be1edae61c58"
            ],
            "index": "pypi",
            "version": "==2.0.0"
        },
        "django-rest-auth": {
            "hashes": [
                "sha256:ad155a0ed1061b32e3e46c9b25686e397644fd6acfd35d5c03bc6b9d2fc6c82a"
            ],
            "index": "pypi",
            "version": "==0.9.3"
        },
        "djangorestframework": {
            "hashes": [
                "sha256:b6714c3e4b0f8d524f193c91ecf5f5450092c2145439ac2769711f7eba89a9d9",
                "sha256:c375e4f95a3a64fccac412e36fb42ba36881e52313ec021ef410b40f67cddca4"
            ],
            "index": "pypi",
            "version": "==3.8.2"
        },
        "pytz": {
            "hashes": [
                "sha256:a061aa0a9e06881eb8b3b2b43f05b9439d6583c206d0a6c340ff72a7b6669053",
                "sha256:ffb9ef1de172603304d9d2819af6f5ece76f2e85ec10692a524dd876e72bf277"
            ],
            "version": "==2018.5"
        },
        "six": {
            "hashes": [
                "sha256:70e8a77beed4562e7f14fe23a786b54f6296e34344c23bc42f07b15018ff98e9",
                "sha256:832dc0e10feb1aa2c68dcc57dbb658f1c7e65b9b61af69048abc87a2db00a0eb"
            ],
            "version": "==1.11.0"
        }
    },
    "develop": {}
}

No. Pipenv is intended to only be used as an application, nothing in it is supported as Python API.

For the general request of re-using Pipenv code, I feel it is out of the scope at the moment. A better approach would be to directly invoke the virtual environment. Virtual environment activation is actually a fairly well-documented and standard behaviour; you can confidently just copy what inline_activate_virtual_environment() does, it is extremenly unlikely for it to ever change (and if it does, it will cause a big splash in the community and you can’t help but to notice).

The thing is I'm struggling to find a way of discovering the path the virtual environment ( Can't even get Popen working - which might be a Cpython bug.)

@rgammans

@rgammans there is no bug in cpython as far as I'm aware, but if you want the path you can set PIPENV_PIPFILE to the pipfile path and run pipenv --venv or you can os.chdir to the project root directory and (this is not guaranteed to work -- we may change it in the future) use the project construct:

import os
pipfile_path = "/path/to/Pipfile"
os.environ["PIPENV_PIPFILE"] = pipfile_path
start_dir = os.path.abspath(os.curdir)
os.chdir(os.path.dirname(pipfile_path))
from pipenv.project import Project
project = Project(chdir=False)
venv_path = project.virtualenv_location
os.chdir(start_dir)

So 'import pipenv.core' or 'import pipenv.project' should not throw an exception ?

Becuase that was my original problem.

Navigation Menu

Repository navigation

Is pipenv.core.inline_activate_virtual_environment() Supported as an API? #3089

Issue description

Expected result

Actual result

Metadata

Assignees

Labels

Projects

Milestone

Relationships

Development

Is pipenv.core.inline_activate_virtual_environment() Supported as an API? #3089

Description

Issue description

Expected result

Actual result

Activity

uranusjr commented on Oct 23, 2018

uranusjr commented on Oct 23, 2018

rgammans commented on Oct 24, 2018

techalchemy commented on Nov 6, 2018

rgammans commented on Nov 16, 2018

Metadata

Metadata

Assignees

Labels

Projects

Milestone

Relationships

Development

Issue actions