[components docs] Flesh out existing code location docs, test #27604
Conversation
![graphite-app[bot]](https://avatars.githubusercontent.com/in/158384?s=60&v=4){kind=small}
| try: | ||
| actual_output = ( | ||
| subprocess.check_output( | ||
| f'{cmd} && echo "PWD=$(pwd);"', shell=True, stderr=subprocess.STDOUT |
There was a problem hiding this comment.
Using && will only echo the PWD if the command succeeds. To ensure the PWD is always captured for proper directory tracking, this should use ; instead: f'{cmd}; echo "PWD=$(pwd);"'
Spotted by Graphite Reviewer
Is this helpful? React 👍 or 👎 to let us know.
This stack of pull requests is managed by Graphite. Learn more about stacking. |
benpankow
force-pushed
the
benpankow/existing-code-location-test
branch
from
644be30 to
43e4f0f
Compare
| except subprocess.CalledProcessError as e: | ||
| print(f"Ran command {cmd}") # noqa: T201 | ||
| print("Got output:") # noqa: T201 | ||
| print(e.output.decode("utf-8").strip()) # noqa: T201 | ||
| raise e | ||
|
|
There was a problem hiding this comment.
The actual_output variable needs to be assigned before the error handling block exits. When an exception occurs, the code will raise a NameError when trying to access actual_output in the subsequent lines. Consider assigning e.output.decode('utf-8').strip() to actual_output before printing and raising the exception.
Spotted by Graphite Reviewer
Is this helpful? React 👍 or 👎 to let us know.
...pets/docs_beta_snippets_tests/snippet_checks/guides/components/my-existing-project/README.md
Outdated
Show resolved
Hide resolved
...ppets/docs_beta_snippets_tests/snippet_checks/guides/components/my-existing-project/setup.py
Outdated
Show resolved
Hide resolved
| @@ -6,6 +6,9 @@ extend = "../pyproject.toml" | |||
| # Shorter line length for docs snippets for better browser formatting. | |||
| line-length = 88 | |||
|
|
|||
| # Ignore a specific file | |||
| extend-exclude = ["docs_beta_snippets/guides/components/existing-project/6-initial-definitions.py"] | |||
There was a problem hiding this comment.
Much prefer to ignore a file by putting:
# noqa
At the top then having this setting
There was a problem hiding this comment.
a blank noqa gets stripped out automatically from another ruff rule in the base file, since we have a rule against noqa 😞
benpankow
force-pushed
the
benpankow/existing-code-location-test
branch
from
a211d2b to
95cc4bb
Compare
…r-io#27604) ## Summary Adds a section to the 'existing project' docs about adding to `pyproject.toml` (necessary for `dg` cli to work) alongside optionally configuring a `uv` environment. This was after playing around trying to port a DOP project, I found some of these steps not immediately obvious & had a hard time setting up a new venv. Places the existing + new contents under integration test.
## Summary Adds a section to the 'existing project' docs about adding to `pyproject.toml` (necessary for `dg` cli to work) alongside optionally configuring a `uv` environment. This was after playing around trying to port a DOP project, I found some of these steps not immediately obvious & had a hard time setting up a new venv. Places the existing + new contents under integration test.
…r-io#27604) ## Summary Adds a section to the 'existing project' docs about adding to `pyproject.toml` (necessary for `dg` cli to work) alongside optionally configuring a `uv` environment. This was after playing around trying to port a DOP project, I found some of these steps not immediately obvious & had a hard time setting up a new venv. Places the existing + new contents under integration test.
Summary
Adds a section to the 'existing project' docs about adding to
pyproject.toml(necessary fordgcli to work) alongside optionally configuring auvenvironment.This was after playing around trying to port a DOP project, I found some of these steps not immediately obvious & had a hard time setting up a new venv.
Places the existing + new contents under integration test.