Expand Up @@ -3,16 +3,18 @@ import shlex import sys from contextlib import contextmanager from typing import Any, Dict, IO, Iterator, List, Optional from typing import IO, Any, Dict, Iterator, List, Optional
if sys.platform == 'win32': if sys.platform == "win32": from subprocess import Popen
try: import click except ImportError: sys.stderr.write('It seems python-dotenv is not installed with cli option. \n' 'Run pip install "python-dotenv[cli]" to fix this.') sys.stderr.write( "It seems python-dotenv is not installed with cli option. \n" 'Run pip install "python-dotenv[cli]" to fix this.' ) sys.exit(1)
from .main import dotenv_values, set_key, unset_key Expand All @@ -29,25 +31,37 @@ def enumerate_env() -> Optional[str]: cwd = os.getcwd() except FileNotFoundError: return None path = os.path.join(cwd, '.env') path = os.path.join(cwd, ".env") return path

@click.group() @click.option('-f', '--file', default=enumerate_env(), 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', type=click.Choice(['always', 'never', 'auto']), help="Whether to quote or not the variable values. Default mode is always. This does not affect parsing.") @click.option('-e', '--export', default=False, type=click.BOOL, help="Whether to write the dot file as an executable bash script.") @click.option( "-f", "--file", default=enumerate_env(), 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", type=click.Choice(["always", "never", "auto"]), help="Whether to quote or not the variable values. Default mode is always. This does not affect parsing.", ) @click.option( "-e", "--export", default=False, type=click.BOOL, help="Whether to write the dot file as an executable bash script.", ) @click.version_option(version=__version__) @click.pass_context 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 = {'QUOTE': quote, 'EXPORT': export, 'FILE': file} ctx.obj = {"QUOTE": quote, "EXPORT": export, "FILE": file}

@contextmanager Expand All @@ -66,53 +80,57 @@ def stream_file(path: os.PathLike) -> Iterator[IO[str]]: exit(2)

@cli.command() @cli.command(name="list") @click.pass_context @click.option('--format', default='simple', type=click.Choice(['simple', 'json', 'shell', 'export']), help="The format in which to display the list. Default format is simple, " "which displays name=value without quotes.") def list(ctx: click.Context, format: bool) -> None: @click.option( "--format", "output_format", default="simple", type=click.Choice(["simple", "json", "shell", "export"]), help="The format in which to display the list. Default format is simple, " "which displays name=value without quotes.", ) def list_values(ctx: click.Context, output_format: str) -> None: """Display all the stored key/value.""" file = ctx.obj['FILE'] file = ctx.obj["FILE"]
with stream_file(file) as stream: values = dotenv_values(stream=stream)
if format == 'json': if output_format == "json": click.echo(json.dumps(values, indent=2, sort_keys=True)) else: prefix = 'export ' if format == 'export' else '' prefix = "export " if output_format == "export" else "" for k in sorted(values): v = values[k] if v is not None: if format in ('export', 'shell'): if output_format in ("export", "shell"): v = shlex.quote(v) click.echo(f'{prefix}{k}={v}') click.echo(f"{prefix}{k}={v}")

@cli.command() @cli.command(name="set") @click.pass_context @click.argument('key', required=True) @click.argument('value', required=True) def set(ctx: click.Context, key: Any, value: Any) -> None: @click.argument("key", required=True) @click.argument("value", required=True) def set_value(ctx: click.Context, key: Any, value: Any) -> None: """Store the given key/value.""" file = ctx.obj['FILE'] quote = ctx.obj['QUOTE'] export = ctx.obj['EXPORT'] file = ctx.obj["FILE"] quote = ctx.obj["QUOTE"] export = ctx.obj["EXPORT"] success, key, value = set_key(file, key, value, quote, export) if success: click.echo(f'{key}={value}') click.echo(f"{key}={value}") else: exit(1)

@cli.command() @click.pass_context @click.argument('key', required=True) @click.argument("key", required=True) def get(ctx: click.Context, key: Any) -> None: """Retrieve the value for the given key.""" file = ctx.obj['FILE'] file = ctx.obj["FILE"]
with stream_file(file) as stream: values = dotenv_values(stream=stream) Expand All @@ -126,33 +144,32 @@ def get(ctx: click.Context, key: Any) -> None:
@cli.command() @click.pass_context @click.argument('key', required=True) @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'] file = ctx.obj["FILE"] quote = ctx.obj["QUOTE"] success, key = unset_key(file, key, quote) if success: click.echo(f"Successfully removed {key}") else: exit(1)

@cli.command(context_settings={'ignore_unknown_options': True}) @cli.command(context_settings={"ignore_unknown_options": True}) @click.pass_context @click.option( "--override/--no-override", default=True, help="Override variables from the environment file with those from the .env file.", ) @click.argument('commandline', nargs=-1, type=click.UNPROCESSED) @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'] file = ctx.obj["FILE"] if not os.path.isfile(file): raise click.BadParameter( f'Invalid value for \'-f\' "{file}" does not exist.', ctx=ctx f"Invalid value for '-f' \"{file}\" does not exist.", ctx=ctx ) dotenv_as_dict = { k: v Expand All @@ -161,7 +178,7 @@ def run(ctx: click.Context, override: bool, commandline: List[str]) -> None: }
if not commandline: click.echo('No command given.') click.echo("No command given.") exit(1) run_command(commandline, dotenv_as_dict)
Expand Down Expand Up @@ -190,14 +207,10 @@ def run_command(command: List[str], env: Dict[str, str]) -> None: cmd_env = os.environ.copy() cmd_env.update(env)
if sys.platform == 'win32': if sys.platform == "win32": # execvpe on Windows returns control immediately # rather than once the command has finished. p = Popen(command, universal_newlines=True, bufsize=0, shell=False, env=cmd_env) p = Popen(command, universal_newlines=True, bufsize=0, shell=False, env=cmd_env) _, _ = p.communicate()
exit(p.returncode) Expand Down