feat: support reading/loading multiple .env files

src/dotenv/cli.py

@@ -1,4 +1,5 @@
 import json
+import logging
 import os
 import shlex
 import sys
@@ -15,9 +16,12 @@
 from .main import dotenv_values, get_key, set_key, unset_key
 from .version import __version__
 
+logger = logging.getLogger(__name__)
+
 
 @click.group()
-@click.option('-f', '--file', default=os.path.join(os.getcwd(), '.env'),
+@click.option('-f', '--file', default=[os.path.join(os.getcwd(), '.env')],
+              multiple=True,
               type=click.Path(file_okay=True),
               help="Location of the .env file, defaults to .env file in current working directory.")
 @click.option('-q', '--quote', default='always',
@@ -33,7 +37,7 @@ def cli(ctx: click.Context, file: Any, quote: Any, export: Any) -> None:
     ctx.obj = {}
     ctx.obj['QUOTE'] = quote
     ctx.obj['EXPORT'] = export
-    ctx.obj['FILE'] = file
+    ctx.obj['FILES'] = file
 
 
 @cli.command()
@@ -44,13 +48,14 @@ def cli(ctx: click.Context, file: Any, quote: Any, export: Any) -> None:
                    "which displays name=value without quotes.")
 def list(ctx: click.Context, format: bool) -> None:
     '''Display all the stored key/value.'''
-    file = ctx.obj['FILE']
-    if not os.path.isfile(file):
-        raise click.BadParameter(
-            'Path "%s" does not exist.' % (file),
-            ctx=ctx
-        )
-    dotenv_as_dict = dotenv_values(file)
+    dotenv_as_dict = {}
+    for file in ctx.obj['FILES']:
+        if not os.path.isfile(file):
+            raise click.BadParameter(
+                'Path "%s" does not exist.' % (file),
+                ctx=ctx
+            )
+        dotenv_as_dict.update(dotenv_values(file))
     if format == 'json':
         click.echo(json.dumps(dotenv_as_dict, indent=2, sort_keys=True))
     else:
@@ -69,31 +74,37 @@ def list(ctx: click.Context, format: bool) -> None:
 @click.argument('value', required=True)
 def set(ctx: click.Context, key: Any, value: Any) -> None:
     '''Store the given key/value.'''
-    file = ctx.obj['FILE']
+    file = ctx.obj['FILES']
     quote = ctx.obj['QUOTE']
     export = ctx.obj['EXPORT']
-    success, key, value = set_key(file, key, value, quote, export)
-    if success:
-        click.echo('%s=%s' % (key, value))
-    else:
-        exit(1)
+    for file in ctx.obj['FILES']:
+        success, key, value = set_key(file, key, value, quote, export)
+        if success:
+            click.echo('%s=%s' % (key, value))
+        else:
+            exit(1)
 
 
 @cli.command()
 @click.pass_context
 @click.argument('key', required=True)
 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):
-        raise click.BadParameter(
-            'Path "%s" does not exist.' % (file),
-            ctx=ctx
-        )
-    stored_value = get_key(file, key)
-    if stored_value:
-        click.echo(stored_value)
+    value, set = None, False
+    files = ctx.obj['FILES']
+    for file in files:
+        if not os.path.isfile(file):
+            raise click.BadParameter(
+                'Path "%s" does not exist.' % (file),
+                ctx=ctx
+            )
+        stored_value = get_key(file, key)
+        if stored_value:
+            value, set = stored_value, True
+    if set:
+        click.echo(value)
     else:
+        logger.warning(f"Key {key} not found in {files[0] if len(files) == 1 else files}.")
         exit(1)
 
 
@@ -102,11 +113,17 @@ def get(ctx: click.Context, key: Any) -> None:
 @click.argument('key', required=True)
 def unset(ctx: click.Context, key: Any) -> None:
     '''Removes the given key.'''
-    file = ctx.obj['FILE']
     quote = ctx.obj['QUOTE']
-    success, key = unset_key(file, key, quote)
-    if success:
-        click.echo("Successfully removed %s" % key)
+
+    global_success = False
+    success_files = []
+    for file in ctx.obj['FILES']:
+        success, key = unset_key(file, key, quote)
+        if success:
+            global_success = True
+            success_files.append(file)
+    if global_success:
+        click.echo("Successfully removed %s from %s" % (key, success_files[0] if len(success_files) == 1 else success_files))
     else:
         exit(1)
 
@@ -121,18 +138,18 @@ def unset(ctx: click.Context, key: Any) -> None:
 @click.argument('commandline', nargs=-1, type=click.UNPROCESSED)
 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):
-        raise click.BadParameter(
-            'Invalid value for \'-f\' "%s" does not exist.' % (file),
-            ctx=ctx
-        )
-    dotenv_as_dict = {
-        k: v
-        for (k, v) in dotenv_values(file).items()
-        if v is not None and (override or k not in os.environ)
-    }
-
+    dotenv_as_dict = {}
+    for file in ctx.obj['FILES']:
+        if not os.path.isfile(file):
+            raise click.BadParameter(
+                'Invalid value for \'-f\' "%s" does not exist.' % (file),
+                ctx=ctx
+            )
+        dotenv_as_dict.update({
+            k: v
+            for (k, v) in dotenv_values(file).items()
+            if v is not None and (override or k not in os.environ)
+        })
     if not commandline:
         click.echo('No command given.')
         exit(1)

tests/test_cli.py

@@ -77,7 +77,7 @@ def test_unset_existing_value(cli, dotenv_file):
 
     result = cli.invoke(dotenv_cli, ['--file', dotenv_file, 'unset', 'a'])
 
-    assert (result.exit_code, result.output) == (0, "Successfully removed a\n")
+    assert (result.exit_code, result.output) == (0, "Successfully removed a from %s\n" % dotenv_file)
     assert open(dotenv_file, "r").read() == ""
 
 

tests/test_main.py

@@ -95,13 +95,9 @@ def test_get_key_no_file(tmp_path):
 
 
 def test_get_key_not_found(dotenv_file):
-    logger = logging.getLogger("dotenv.main")
-
-    with mock.patch.object(logger, "warning") as mock_warning:
-        result = dotenv.get_key(dotenv_file, "foo")
+    result = dotenv.get_key(dotenv_file, "foo")
 
     assert result is None
-    mock_warning.assert_called_once_with("Key %s not found in %s.", "foo", dotenv_file)
 
 
 def test_get_key_ok(dotenv_file):