Skip to content

Support dotenv .env files using export as in export VAR=value #17182

Closed

Description

Discussed in #16553

Originally posted by tiangolo June 23, 2021

I know VS Code with Pylance supports loading environment variables from a .env (dotenv file), which is great. It allows me to, for example, easily run or debug tests right from the editor, using all the environment variables needed.

Here's the example from the docs:

# API endpoint
MYPROJECT_APIENDPOINT=https://my.domain.com/api/dev/

# Variables for the database
MYPROJECT_DBURL=https://my.domain.com/db/dev
MYPROJECT_DBUSER=devadmin
MYPROJECT_DBPASSWORD=!dfka**213=

Feature Request

I would like VS Code / Pylance to also support defining the variables with export, as in:

# API endpoint
export MYPROJECT_APIENDPOINT=https://my.domain.com/api/dev/

# Variables for the database
export MYPROJECT_DBURL=https://my.domain.com/db/dev
export MYPROJECT_DBUSER=devadmin
export MYPROJECT_DBPASSWORD=!dfka**213=

This would allow me to use the same set of environment variables from the command line by sourcing that file.

For example I could load the environment:

$ source .env

And then run other commands that would use the same environment variables, for example, to run the tests usingcoverage:

$ coverage run --source ./app/ -m pytest

Current behavior

As Currently VS Code / Pylance doesn't support having export in these .env files, I have to manually add the export before each variable before using it on the command line, and then I have to manually remove those exports manually to run again the tests from inside VS Code.

Apart from the double effort of adding and removing those exports, you can imagine that I often forget I had to do that, and I end up spending a long time debugging "why it's not working" in one place or the other, while it was just that I forgot to add or remove those exports. 😅

Activity

  1. brettcannon commented on Sep 1, 2021

    @brettcannon
    MemberAuthor

    Thanks for the feature request! We are going to give the community 60 days from when this issue was created to provide 5 👍 upvotes on the opening comment to gauge general interest in this idea. If there's enough upvotes then we will consider this feature request in our future planning. If there's unfortunately not enough upvotes then we will close this issue.

  2. mjpieters commented on Oct 13, 2021

    @mjpieters

    I rather dislike the voting requirements on these issues as the issue list is huge, and there is little visibility on what FRs might require voting feedback.

    It took me a while to figure out that this was the issue I was experiencing; I was assuming export in .env would just work because dotenv and other tools support this so I was searching for other keywords (pytest .env being a prominent one, since I was running into this trying to get pyenv to complete test discovery).

  3. brettcannon commented on Oct 15, 2021

    @brettcannon
    MemberAuthor

    Martijn Pieters (@mjpieters) we are following VS Code for the voting practice where their issue tracker is over 5x larger than ours and they require 20 votes to keep something open.

    And plenty of issues have met the threshold so we don't view it as an unreasonable way to gauge community interest. At worst someone opens a duplicate issue and we simply ask them to go upvote the original issue.

    As for visibility, needs community feedback Awaiting community feedback is a dedicated label on this topic and is mentioned in the issue management page in our wiki.

  4. brettcannon commented on Nov 1, 2021

    @brettcannon
    MemberAuthor

    Thank you for submitting your feature request and everyone who considered it! Unfortunately this issue did not receive enough votes over the allotted time, and so we are closing the issue.

  5. locked as resolved and limited conversation to collaborators on Dec 2, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions