-
Notifications
You must be signed in to change notification settings - Fork 430
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Gracefully handle code which has been imported from a zipfile (#456)
- Loading branch information
Showing
2 changed files
with
104 additions
and
1 deletion.
There are no files selected for viewing
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
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,101 @@ | ||
import os | ||
import sys | ||
import sh | ||
import textwrap | ||
from typing import List | ||
from unittest import mock | ||
from zipfile import ZipFile | ||
|
||
|
||
def walk_to_root(path: str): | ||
last_dir = None | ||
current_dir = path | ||
while last_dir != current_dir: | ||
yield current_dir | ||
(parent_dir, _) = os.path.split(current_dir) | ||
last_dir, current_dir = current_dir, parent_dir | ||
|
||
|
||
class FileToAdd: | ||
def __init__(self, content: str, path: str): | ||
self.content = content | ||
self.path = path | ||
|
||
|
||
def setup_zipfile(path, files: List[FileToAdd]): | ||
zip_file_path = path / "test.zip" | ||
dirs_init_py_added_to = set() | ||
with ZipFile(zip_file_path, "w") as zip: | ||
for f in files: | ||
zip.writestr(data=f.content, zinfo_or_arcname=f.path) | ||
for dir in walk_to_root(os.path.dirname(f.path)): | ||
if dir not in dirs_init_py_added_to: | ||
print(os.path.join(dir, "__init__.py")) | ||
zip.writestr( | ||
data="", zinfo_or_arcname=os.path.join(dir, "__init__.py") | ||
) | ||
dirs_init_py_added_to.add(dir) | ||
return zip_file_path | ||
|
||
|
||
@mock.patch.object(sys, "path", list(sys.path)) | ||
def test_load_dotenv_gracefully_handles_zip_imports_when_no_env_file(tmp_path): | ||
zip_file_path = setup_zipfile( | ||
tmp_path, | ||
[ | ||
FileToAdd( | ||
content=textwrap.dedent( | ||
""" | ||
from dotenv import load_dotenv | ||
load_dotenv() | ||
""" | ||
), | ||
path="child1/child2/test.py", | ||
), | ||
], | ||
) | ||
|
||
# Should run without an error | ||
sys.path.append(str(zip_file_path)) | ||
import child1.child2.test # noqa | ||
|
||
|
||
def test_load_dotenv_outside_zip_file_when_called_in_zipfile(tmp_path): | ||
zip_file_path = setup_zipfile( | ||
tmp_path, | ||
[ | ||
FileToAdd( | ||
content=textwrap.dedent( | ||
""" | ||
from dotenv import load_dotenv | ||
load_dotenv() | ||
""" | ||
), | ||
path="child1/child2/test.py", | ||
), | ||
], | ||
) | ||
dotenv_path = tmp_path / ".env" | ||
dotenv_path.write_bytes(b"a=b") | ||
code_path = tmp_path / "code.py" | ||
code_path.write_text( | ||
textwrap.dedent( | ||
f""" | ||
import os | ||
import sys | ||
sys.path.append("{zip_file_path}") | ||
import child1.child2.test | ||
print(os.environ['a']) | ||
""" | ||
) | ||
) | ||
os.chdir(str(tmp_path)) | ||
|
||
result = sh.Command(sys.executable)(code_path) | ||
|
||
assert result == "b\n" |