Remove "filthy magic stack backtracking" in favor of BASE_DIR #252
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
PR was closed by mistake. Reopened it. |
The read_env documentation currently states: > If not given a path to a dotenv path, does filthy magic stack > backtracking to find manage.py and then find the dotenv. Based on joke2k#88, it appears that this behavior is rather fragile. To improve this, I think the package should document that read_env expects you to provide a path. If one is not provided, it will attempt to use the BASE_DIR constant from the django settings module. If an ImportError is encountered while it attempts to do this, read_env will assume there's no .env file to be found, log an info message to that effect, and continue on. fixes: joke2k#88
The django.conf.settings module could be successfully imported but the BASE_DIR constant could not be defined, which would raise a NameError. This small edit ensures that we're catching both potential failures.
birdcar
force-pushed
the
@nickcannariato-refactor-blank-read-env-import-and-docs
branch
from
279be8a to
05de258
Compare
sergeyklay
approved these changes
Sep 6, 2021
sergeyklay
requested changes
Sep 6, 2021
| @@ -18,15 +18,9 @@ | |||
| import sys | |||
There was a problem hiding this comment.
'sys' imported but unused
| urlparse, | ||
| urlunparse, | ||
| ) | ||
| from urllib.parse import ParseResult, parse_qs, unquote_plus, urlparse, urlunparse |
There was a problem hiding this comment.
Imported names are in the wrong order
Suggested change
| from urllib.parse import ParseResult, parse_qs, unquote_plus, urlparse, urlunparse | |
| from urllib.parse import parse_qs, ParseResult, unquote_plus, urlparse, urlunparse |
There was a problem hiding this comment.
Also this line too long (82 > 79 characters)
|
|
||
| from .compat import DJANGO_POSTGRES, ImproperlyConfigured, json, REDIS_DRIVER | ||
| from .compat import DJANGO_POSTGRES, REDIS_DRIVER, ImproperlyConfigured, json |
There was a problem hiding this comment.
Imported names are in the wrong order
Suggested change
| from .compat import DJANGO_POSTGRES, REDIS_DRIVER, ImproperlyConfigured, json | |
| from .compat import DJANGO_POSTGRES, ImproperlyConfigured, json, REDIS_DRIVER |
| (True, True) | ||
| >>> root('dev', 'not_existing_dir', required=True) | ||
| Traceback (most recent call last): | ||
| environ.environ.ImproperlyConfigured: Create required path: /home/not_existing_dir |
There was a problem hiding this comment.
E501 line too long (90 > 79 characters)
| >>> public = root.path('public') | ||
| >>> public, public.root, public('styles') | ||
| (<Path:/home/public>, '/home/public', '/home/public/styles') | ||
| >>> assets, scripts = public.path('assets'), public.path('assets', 'scripts') |
There was a problem hiding this comment.
line too long (85 > 79 characters)
| >>> assets.root, scripts.root | ||
| ('/home/public/assets', '/home/public/assets/scripts') | ||
| >>> assets + 'styles', str(assets + 'styles'), ~assets | ||
| (<Path:/home/public/assets/styles>, '/home/public/assets/styles', <Path:/home/public>) |
There was a problem hiding this comment.
line too long (94 > 79 characters)
sergeyklay
reviewed
Sep 6, 2021
| try: | ||
| from django.conf import settings | ||
| env_file = os.path.join(settings.BASE_DIR, '.env') | ||
| except (ImportError, NameError): |
There was a problem hiding this comment.
What about AttributeError?
|
@sergeyklay is it possible to change the merge target of this PR to be |
|
@jayvdb Usually we merge changes to the |
|
No worries. At the time I wrote that, there was no |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The
read_envdocumentation currently states:Based on #88, it appears that this behavior is rather fragile.
To improve this, I think the package should document that read_env expects you to provide a path. If one is not provided, it will attempt to use the BASE_DIR constant from the django settings module. If an ImportError is encountered while it attempts to do this, read_env will assume there's no .env file to be found, log an info message to that effect, and continue on.
fixes: #88