[#38] Adding Black Formatting #39
Conversation
| @@ -538,7 +584,7 @@ def push_updates(now): | |||
| print("Removing origin") | |||
| remote_rm = run(["git", "remote", "rm", "origin"]) | |||
| if remote_rm.returncode != 0: | |||
| raise Excetion("Failed to remove origin") | |||
| raise Exception("Failed to remove origin") | |||
| import requests | ||
|
|
There was a problem hiding this comment.
I installed requests so long ago, I forgot it wasn't a builtin! Thanks for rearranging these.
There was a problem hiding this comment.
This is going to sound silly, but I'm new to requirements.in. Can you give me a quick crash course or a pointer to some documentation? How is it different from requirements.txt and when should I use one versus the other?
Also, I searched for requirements_dev.txt and requirements-dev.txt was returned: https://pypi.org/project/requirements-dev.txt/. Is the latter more conventional?
requirements_dev.txt
Outdated
| toml==0.10.1 # via black | ||
| typed-ast==1.4.1 # via black | ||
| typing-extensions==3.7.4.3 # via black | ||
| urllib3==1.25.10 # via requests |
There was a problem hiding this comment.
Silly question: these comments were autogenerated, right?
There was a problem hiding this comment.
All comment's within the requirements.txt files are autogenerated when running the corresponding pip-compile requirements.in command. As more transitive dependencies are added and more direct dependencies depending on a specific version, the direct dependency will also be added to the comment.
requirements_dev.in
Outdated
| # Shared/Runtime dependencies | ||
|
|
||
| -r requirements.in | ||
|
|
||
| # Development-only dependencies | ||
|
|
||
|
|
||
| # Lint-only dependencies | ||
|
|
||
| black==20.8b1 |
There was a problem hiding this comment.
Is this the standard requirements_dev.in template?
There was a problem hiding this comment.
Not quiet;
pip-compile --output-file=requirements-dev.txt requirements-dev.in
would produce
#
# This file is autogenerated by pip-compile
# To update, run:
#
# pip-compile --output-file=requirements-dev.txt requirements-dev.in
#
appdirs==1.4.4 # via black
black==20.8b1 # via -r requirements-dev.in
certifi==2020.6.20 # via requests
chardet==3.0.4 # via requests
click==7.1.2 # via black
idna==2.10 # via requests
mypy-extensions==0.4.3 # via black
pathspec==0.8.0 # via black
regex==2020.9.27 # via black
requests==2.24.0 # via -r requirements.in
toml==0.10.1 # via black
typed-ast==1.4.1 # via black
typing-extensions==3.7.4.3 # via black
urllib3==1.25.10 # via requests
However, adding -r requirements.in to the start of the dev dependencies avoids listing the entire contents of requirements.txt.
The comments that appear after this line are not necessary (personal preference) but it helps provide a logical grouping to identify what dependencies belong too. Useful if/when more are added.
# Development-only dependencies
# Lint-only dependencies
black==20.8b1
I'm happy to make changes around any of this if it feels inappropriate for the project.
|
I did a bit more digging (https://github.com/jazzband/pip-tools). Is the difference between |
|
yes, that's correct. I appreciate the project doesn't have very many dependencies and this approach may be more than what is necessary. I would like to know your thoughts :) |
|
@apoclyps thanks for the thoughtful responses. I think it's fine to keep this as is. There's no time like the present to adopt best practices! I'll go ahead and merge this. |
What's Changed
Apply's black formatting to the codebase
Technical Description
ExceptionCloses #38