Skip to content
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.

Sign up for GitHub

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

Jump to bottom

IDE setup docs gives an .env file that doesn't work #20127

Closed
huonw opened this issue Nov 1, 2023 · 0 comments · Fixed by #20144
Closed

IDE setup docs gives an .env file that doesn't work #20127

huonw opened this issue Nov 1, 2023 · 0 comments · Fixed by #20144
Labels
bug category:documentation documentation

Comments

@huonw
Copy link
Contributor

huonw commented Nov 1, 2023

Describe the bug

Per pantsbuild/scie-pants#307, the script on https://www.pantsbuild.org/docs/setting-up-an-ide#first-party-sources results in a file with quote around the env var, but this (silently) doesn't work with scie-pants:

PYTHONPATH="./path/to/root:$PYTHONPATH"

We could adjust the script to generate the same code without the quotes.

pants/docs/markdown/Using Pants/setting-up-an-ide.md

Lines 26 to 29 in 0e3523d

```shell
$ ROOTS=$(pants roots)
$ python3 -c "print('PYTHONPATH=\"./' + ':./'.join('''${ROOTS}'''.split('\n')) + ':\$PYTHONPATH\"')" > .env
```

Pants version
2.17, 2.18, main

OS
N/A

Additional info
This would also be resolved by adjusting scie-pants to handle parsing "'d env vars.
@huonw huonw mentioned this issue Nov 1, 2023
Closed
@huonw huonw changed the title IDE setup suggest gives an .env file that doesn't work IDE setup docs gives an .env file that doesn't work Nov 1, 2023
@huonw huonw mentioned this issue Nov 3, 2023
Merged
huonw added a commit that referenced this issue Nov 3, 2023
@huonw
Avoid quotes in suggested .env file for IDEs (#20144)
e91d6e7 
This fixes #20127 by avoiding double quotes in the `.env` file generated
by the code snippet in the IDE set-up docs.

Double quotes aren't supported by the `scie-pants` `.env` loader, and a
line containing them was previously silently ignored (plus all lines
after), but with scie-pants 0.11.0, will be an error. See
pantsbuild/scie-pants#307 and
pantsbuild/scie-pants#319.

The new suggestion has _no_ quotes at all, because there's no other way
to have a line that includes a substitution. To handle source roots with
spaces in their paths, this has to also manually escape them. Supporting
double quotes is effectively a new feature of `scie-pants` launcher (via
scie jump a-scie/jump#166 via `dotenvy`
allan2/dotenvy#11), but for now we can at
least stop suggesting incorrect things.

For instance, with source roots `a b/c` and `def`, this generates:

```
PYTHONPATH=./a\ b/c:./def:$PYTHONPATH
```
WorkerPants pushed a commit that referenced this issue Nov 3, 2023
@huonw @WorkerPants
Avoid quotes in suggested .env file for IDEs (#20144)
d20ad3d 
This fixes #20127 by avoiding double quotes in the `.env` file generated
by the code snippet in the IDE set-up docs.

Double quotes aren't supported by the `scie-pants` `.env` loader, and a
line containing them was previously silently ignored (plus all lines
after), but with scie-pants 0.11.0, will be an error. See
pantsbuild/scie-pants#307 and
pantsbuild/scie-pants#319.

The new suggestion has _no_ quotes at all, because there's no other way
to have a line that includes a substitution. To handle source roots with
spaces in their paths, this has to also manually escape them. Supporting
double quotes is effectively a new feature of `scie-pants` launcher (via
scie jump a-scie/jump#166 via `dotenvy`
allan2/dotenvy#11), but for now we can at
least stop suggesting incorrect things.

For instance, with source roots `a b/c` and `def`, this generates:

```
PYTHONPATH=./a\ b/c:./def:$PYTHONPATH
```
WorkerPants pushed a commit that referenced this issue Nov 3, 2023
@huonw @WorkerPants
Avoid quotes in suggested .env file for IDEs (#20144)
8a2279b 
This fixes #20127 by avoiding double quotes in the `.env` file generated
by the code snippet in the IDE set-up docs.

Double quotes aren't supported by the `scie-pants` `.env` loader, and a
line containing them was previously silently ignored (plus all lines
after), but with scie-pants 0.11.0, will be an error. See
pantsbuild/scie-pants#307 and
pantsbuild/scie-pants#319.

The new suggestion has _no_ quotes at all, because there's no other way
to have a line that includes a substitution. To handle source roots with
spaces in their paths, this has to also manually escape them. Supporting
double quotes is effectively a new feature of `scie-pants` launcher (via
scie jump a-scie/jump#166 via `dotenvy`
allan2/dotenvy#11), but for now we can at
least stop suggesting incorrect things.

For instance, with source roots `a b/c` and `def`, this generates:

```
PYTHONPATH=./a\ b/c:./def:$PYTHONPATH
```
This was referenced Nov 3, 2023
Merged
Merged
huonw added a commit that referenced this issue Nov 3, 2023
@WorkerPants @huonw
Avoid quotes in suggested .env file for IDEs (Cherry-pick of #20144) (#…
5ffae27 
…20146)

This fixes #20127 by avoiding double quotes in the `.env` file generated
by the code snippet in the IDE set-up docs.

Double quotes aren't supported by the `scie-pants` `.env` loader, and a
line containing them was previously silently ignored (plus all lines
after), but with scie-pants 0.11.0, will be an error. See
pantsbuild/scie-pants#307 and
pantsbuild/scie-pants#319.

The new suggestion has _no_ quotes at all, because there's no other way
to have a line that includes a substitution. To handle source roots with
spaces in their paths, this has to also manually escape them. Supporting
double quotes is effectively a new feature of `scie-pants` launcher (via
scie jump a-scie/jump#166 via `dotenvy`
allan2/dotenvy#11), but for now we can at
least stop suggesting incorrect things.

For instance, with source roots `a b/c` and `def`, this generates:

```
PYTHONPATH=./a\ b/c:./def:$PYTHONPATH
```

Co-authored-by: Huon Wilson <huon@exoflare.io>
huonw added a commit that referenced this issue Nov 3, 2023
@WorkerPants @huonw
Avoid quotes in suggested .env file for IDEs (Cherry-pick of #20144) (#…
71451e9 
…20145)

This fixes #20127 by avoiding double quotes in the `.env` file generated
by the code snippet in the IDE set-up docs.

Double quotes aren't supported by the `scie-pants` `.env` loader, and a
line containing them was previously silently ignored (plus all lines
after), but with scie-pants 0.11.0, will be an error. See
pantsbuild/scie-pants#307 and
pantsbuild/scie-pants#319.

The new suggestion has _no_ quotes at all, because there's no other way
to have a line that includes a substitution. To handle source roots with
spaces in their paths, this has to also manually escape them. Supporting
double quotes is effectively a new feature of `scie-pants` launcher (via
scie jump a-scie/jump#166 via `dotenvy`
allan2/dotenvy#11), but for now we can at
least stop suggesting incorrect things.

For instance, with source roots `a b/c` and `def`, this generates:

```
PYTHONPATH=./a\ b/c:./def:$PYTHONPATH
```

Co-authored-by: Huon Wilson <huon@exoflare.io>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
bug category:documentation documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Avoid quotes in suggested .env file for IDEs pantsbuild/pants
1 participant
@huonw