Skip to content

Typing python-dotenv: may I submit this to typeshed? #172

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

Merged
bbc2 merged 21 commits into from
Mar 30, 2019
Merged

Typing python-dotenv: may I submit this to typeshed? #172

Changes from 1 commit
Commits
Show all changes
21 commits
Select commit Hold shift + click to select a range
68ab22a
Add some type annotations.
qnighy Mar 9, 2019
a7ab3de
Use comment-based annotation.
qnighy Mar 9, 2019
134917b
Provide fallback for PathLike
qnighy Mar 9, 2019
fbfcc4b
Typecheck on 2.7.
qnighy Mar 9, 2019
d715db3
Add public stub files.
qnighy Mar 9, 2019
4fcd0b9
Add py.typed in accordance with PEP 561.
qnighy Mar 12, 2019
fa6f270
Check mypy types in testenv:lint.
qnighy Mar 16, 2019
d452173
Remove an unnecessary 'type: ignore' directive.
qnighy Mar 16, 2019
bc873a3
Use 'type: ignore' instead of complex workarounds.
qnighy Mar 16, 2019
e8114a5
Remove a type annotation for __version__.
qnighy Mar 16, 2019
36bac24
Annotate member types on initialization.
qnighy Mar 16, 2019
ff85c44
Always use NamedTuple.
qnighy Mar 16, 2019
f743880
Fix flake8 errors.
qnighy Mar 16, 2019
2981c42
Remove ./stubs
qnighy Mar 16, 2019
3665cbb
Include src/py.typed in MANIFEST.in.
qnighy Mar 16, 2019
15aa870
Add install_requires to dependencies.
qnighy Mar 17, 2019
3403de6
Also typecheck in 3.4 mode.
qnighy Mar 17, 2019
ab17c2e
Move py.typed.
qnighy Mar 17, 2019
770d7c9
Text can be reused for text_type.
qnighy Mar 17, 2019
826195a
Ignore TYPE_CHECKING code in coverage.
qnighy Mar 17, 2019
9023fa4
Always assert match is not None.
qnighy Mar 17, 2019
File filter

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Use 'type: ignore' instead of complex workarounds.
  • Loading branch information
@qnighy
qnighy committed Mar 16, 2019
commit bc873a3fb65cd7bb4fe102f241f1d166527e2c9e
18 changes: 6 additions & 12 deletions src/dotenv/main.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -136,8 +136,7 @@ def _get_stream(self):
yield stream
else:
if self.verbose:
if not TYPE_CHECKING or sys.version_info >= (3, 0):
warnings.warn("File doesn't exist {}".format(self.dotenv_path))
warnings.warn("File doesn't exist {}".format(self.dotenv_path)) # type: ignore
yield StringIO('')

def dict(self):
Expand Down Expand Up @@ -171,8 +170,7 @@ def set_as_environment_variables(self, override=False):
if isinstance(k, text_type) or isinstance(v, text_type):
k = k.encode('ascii')
v = v.encode('ascii')
if not TYPE_CHECKING or sys.version_info >= (3, 0):
os.environ[k] = v
os.environ[k] = v # type: ignore

return True

Expand All @@ -186,8 +184,7 @@ def get(self, key):
return data[key]

if self.verbose:
if not TYPE_CHECKING or sys.version_info >= (3, 0):
warnings.warn("key %s not found in %s." % (key, self.dotenv_path))
warnings.warn("key %s not found in %s." % (key, self.dotenv_path)) # type: ignore

return None # NOTE: PEP8 compliance required by mypy
Copy link
Copy Markdown
Collaborator

@bbc2 bbc2 Mar 10, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's OK to not have a comment here. PEP 8 compliance is implicit in the whole code base and removing this return None shouldn't trigger a lint error (if linting is done in CI).

Expand Down Expand Up @@ -227,8 +224,7 @@ def set_key(dotenv_path, key_to_set, value_to_set, quote_mode="always"):
"""
value_to_set = value_to_set.strip("'").strip('"')
if not os.path.exists(dotenv_path):
if not TYPE_CHECKING or sys.version_info >= (3, 0):
warnings.warn("can't write to %s - it doesn't exist." % dotenv_path)
warnings.warn("can't write to %s - it doesn't exist." % dotenv_path) # type: ignore
return None, key_to_set, value_to_set

if " " in value_to_set:
Expand Down Expand Up @@ -260,8 +256,7 @@ def unset_key(dotenv_path, key_to_unset, quote_mode="always"):
If the given key doesn't exist in the .env, fails
"""
if not os.path.exists(dotenv_path):
if not TYPE_CHECKING or sys.version_info >= (3, 0):
warnings.warn("can't delete from %s - it doesn't exist." % dotenv_path)
warnings.warn("can't delete from %s - it doesn't exist." % dotenv_path) # type: ignore
return None, key_to_unset

removed = False
Expand All @@ -273,8 +268,7 @@ def unset_key(dotenv_path, key_to_unset, quote_mode="always"):
dest.write(mapping.original)

if not removed:
if not TYPE_CHECKING or sys.version_info >= (3, 0):
warnings.warn("key %s not removed from %s - key doesn't exist." % (key_to_unset, dotenv_path))
warnings.warn("key %s not removed from %s - key doesn't exist." % (key_to_unset, dotenv_path)) # type: ignore
return None, key_to_unset

return removed, key_to_unset
Expand Down