Merge branch 'remote-master'

* Resolve merge conflicts
** `src/dotenv/__init__.py`
** `src/dotenv/main.py`

Author: mrjng

.github/workflows/test.yml

@@ -10,7 +10,7 @@ jobs:
       matrix:
         os:
           - ubuntu-latest
-        python-version: [2.7, 3.5, 3.6, 3.7, 3.8, 3.9, pypy2, pypy3]
+        python-version: [3.5, 3.6, 3.7, 3.8, 3.9, pypy3]
     steps:
     - uses: actions/checkout@v2
     - name: Set up Python ${{ matrix.python-version }}

CHANGELOG.md

@@ -5,6 +5,18 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this
 project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [Unreleased]
+
+### Added
+
+- The `dotenv_path` argument of `set_key` and `unset_key` now has a type of `Union[str,
+  os.PathLike]` instead of just `os.PathLike` (#347 by [@bbc2]).
+
+### Changed
+
+- Require Python 3.5 or a later version.  Python 2 and 3.4 are no longer supported. (#341
+  by [@bbc2]).
+
 ## [0.18.0] - 2021-06-20
 
 ### Changed

README.md

@@ -141,8 +141,8 @@ without manually opening it.
 
 ```shell
 $ pip install "python-dotenv[cli]"
-$ dotenv set USER=foo
-$ dotenv set EMAIL=foo@example.org
+$ dotenv set USER foo
+$ dotenv set EMAIL foo@example.org
 $ dotenv list
 USER=foo
 EMAIL=foo@example.org

requirements.txt

@@ -1,5 +1,4 @@
 bumpversion
-typing; python_version<"3.5"
 click
 flake8>=2.2.3
 ipython
@@ -8,6 +7,7 @@ pytest-cov
 pytest>=3.9
 sh>=1.09
 tox
+types-mock
 wheel
 twine
 portray

setup.cfg

@@ -14,6 +14,7 @@ max-line-length = 120
 exclude = .tox,.git,docs,venv,.venv
 
 [mypy]
+check_untyped_defs = true
 ignore_missing_imports = true
 
 [metadata]

setup.py

@@ -1,4 +1,3 @@
-# -*- coding: utf-8 -*-
 import io
 from setuptools import setup
 
@@ -33,9 +32,7 @@ def read_files(files):
     package_data={
         'dotenv': ['py.typed'],
     },
-    install_requires=[
-        "typing; python_version<'3.5'",
-    ],
+    python_requires=">=3.5",
     extras_require={
         'cli': ['click>=5.0', ],
     },
@@ -47,8 +44,6 @@ def read_files(files):
     classifiers=[
         'Development Status :: 5 - Production/Stable',
         'Programming Language :: Python',
-        'Programming Language :: Python :: 2',
-        'Programming Language :: Python :: 2.7',
         'Programming Language :: Python :: 3',
         'Programming Language :: Python :: 3.5',
         'Programming Language :: Python :: 3.6',

src/dotenv/__init__.py

@@ -1,18 +1,21 @@
-from .compat import IS_TYPE_CHECKING
-from .main import load_dotenv, get_key, set_key, unset_key, find_dotenv, dotenv_values, update_dict_to_dotenv
+from typing import Any, Optional
 
-if IS_TYPE_CHECKING:
-    from typing import Any, Optional
+from .main import (dotenv_values, find_dotenv, get_key, load_dotenv, set_key,
+                   unset_key, update_dict_to_dotenv)
 
 
-def load_ipython_extension(ipython):
-    # type: (Any) -> None
+def load_ipython_extension(ipython: Any) -> None:
     from .ipython import load_ipython_extension
     load_ipython_extension(ipython)
 
 
-def get_cli_string(path=None, action=None, key=None, value=None, quote=None):
-    # type: (Optional[str], Optional[str], Optional[str], Optional[str], Optional[str]) -> str
+def get_cli_string(
+    path: Optional[str] = None,
+    action: Optional[str] = None,
+    key: Optional[str] = None,
+    value: Optional[str] = None,
+    quote: Optional[str] = None,
+):
     """Returns a string suitable for running as a shell script.
 
     Useful for converting a arguments passed to a fabric task

src/dotenv/cli.py

@@ -1,6 +1,7 @@
 import os
 import sys
 from subprocess import Popen
+from typing import Any, Dict, List
 
 try:
     import click
@@ -9,13 +10,9 @@
                      'Run pip install "python-dotenv[cli]" to fix this.')
     sys.exit(1)
 
-from .compat import IS_TYPE_CHECKING, to_env
 from .main import dotenv_values, get_key, set_key, unset_key
 from .version import __version__
 
-if IS_TYPE_CHECKING:
-    from typing import Any, List, Dict
-
 
 @click.group()
 @click.option('-f', '--file', default=os.path.join(os.getcwd(), '.env'),
@@ -29,8 +26,7 @@
               help="Whether to write the dot file as an executable bash script.")
 @click.version_option(version=__version__)
 @click.pass_context
-def cli(ctx, file, quote, export):
-    # type: (click.Context, Any, Any, Any) -> None
+def cli(ctx: click.Context, file: Any, quote: Any, export: Any) -> None:
     '''This script is used to set, get or unset values from a .env file.'''
     ctx.obj = {}
     ctx.obj['QUOTE'] = quote
@@ -40,8 +36,7 @@ def cli(ctx, file, quote, export):
 
 @cli.command()
 @click.pass_context
-def list(ctx):
-    # type: (click.Context) -> None
+def list(ctx: click.Context) -> None:
     '''Display all the stored key/value.'''
     file = ctx.obj['FILE']
     if not os.path.isfile(file):
@@ -58,8 +53,7 @@ def list(ctx):
 @click.pass_context
 @click.argument('key', required=True)
 @click.argument('value', required=True)
-def set(ctx, key, value):
-    # type: (click.Context, Any, Any) -> None
+def set(ctx: click.Context, key: Any, value: Any) -> None:
     '''Store the given key/value.'''
     file = ctx.obj['FILE']
     quote = ctx.obj['QUOTE']
@@ -74,8 +68,7 @@ def set(ctx, key, value):
 @cli.command()
 @click.pass_context
 @click.argument('key', required=True)
-def get(ctx, key):
-    # type: (click.Context, Any) -> None
+def get(ctx: click.Context, key: Any) -> None:
     '''Retrieve the value for the given key.'''
     file = ctx.obj['FILE']
     if not os.path.isfile(file):
@@ -93,8 +86,7 @@ def get(ctx, key):
 @cli.command()
 @click.pass_context
 @click.argument('key', required=True)
-def unset(ctx, key):
-    # type: (click.Context, Any) -> None
+def unset(ctx: click.Context, key: Any) -> None:
     '''Removes the given key.'''
     file = ctx.obj['FILE']
     quote = ctx.obj['QUOTE']
@@ -113,8 +105,7 @@ def unset(ctx, key):
     help="Override variables from the environment file with those from the .env file.",
 )
 @click.argument('commandline', nargs=-1, type=click.UNPROCESSED)
-def run(ctx, override, commandline):
-    # type: (click.Context, bool, List[str]) -> None
+def run(ctx: click.Context, override: bool, commandline: List[str]) -> None:
     """Run command with environment variables present."""
     file = ctx.obj['FILE']
     if not os.path.isfile(file):
@@ -123,9 +114,9 @@ def run(ctx, override, commandline):
             ctx=ctx
         )
     dotenv_as_dict = {
-        to_env(k): to_env(v)
+        k: v
         for (k, v) in dotenv_values(file).items()
-        if v is not None and (override or to_env(k) not in os.environ)
+        if v is not None and (override or k not in os.environ)
     }
 
     if not commandline:
@@ -135,8 +126,7 @@ def run(ctx, override, commandline):
     exit(ret)
 
 
-def run_command(command, env):
-    # type: (List[str], Dict[str, str]) -> int
+def run_command(command: List[str], env: Dict[str, str]) -> int:
     """Run command in sub process.
 
     Runs the command in a sub process with the variables from `env`

src/dotenv/compat.py

@@ -1,5 +1,3 @@
-from __future__ import print_function
-
 from IPython.core.magic import Magics, line_magic, magics_class  # type: ignore
 from IPython.core.magic_arguments import (argument, magic_arguments,  # type: ignore
                                           parse_argstring)  # type: ignore