daylin/viv
1
0
Fork 0
mirror of https://github.com/daylinmorgan/viv.git synced 2024-12-22 10:40:44 -06:00
Code Issues Projects Releases Packages Wiki Activity

docs: add docstring to activate

Browse source
This commit is contained in:
Daylin Morgan 2022-12-20 14:49:43 -06:00
parent 69bc718490
commit f762267c4b
2 changed files with 10 additions and 9 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

1
docs/demo.tape
View file

@ -21,4 +21,3 @@ Sleep 2s
Type "python examples/cli.py goodbye 'prospective viv user!'" Type "python examples/cli.py goodbye 'prospective viv user!'"
Enter Enter
Sleep 2s Sleep 2s

18
src/viv/viv.py
View file

@ -91,7 +91,7 @@ class Spinner:
self.thread = threading.Thread(target=self.spinner_task) self.thread = threading.Thread(target=self.spinner_task)
self.thread.start() self.thread.start()
def __exit__(self, exc_type, exc_val, exc_traceback): def __exit__(self, exc_type, exc_val, exc_traceback): # noqa
if sys.stdout.isatty(): if sys.stdout.isatty():
self.busy = False self.busy = False
self.remove_spinner(cleanup=True) self.remove_spinner(cleanup=True)
@ -320,7 +320,7 @@ class ViVenv:
run( run(
cmd, cmd,
spinmsg=f"installing packages in vivenv", spinmsg="installing packages in vivenv",
clean_up_path=self.path, clean_up_path=self.path,
verbose=bool(os.getenv("VIV_VERBOSE")), verbose=bool(os.getenv("VIV_VERBOSE")),
) )
@ -344,6 +344,14 @@ class ViVenv:
def activate(*packages: str, track_exe: bool = False, name: str = "") -> None: def activate(*packages: str, track_exe: bool = False, name: str = "") -> None:
"""create a vivenv and append to sys.path
Args:
packages: package specifications with optional version specifiers
track_exe: if true make env python exe specific
name: use as vivenv name, if not provided build_id is used
"""
vivenv = ViVenv(validate_spec(packages), track_exe=track_exe, name=name) vivenv = ViVenv(validate_spec(packages), track_exe=track_exe, name=name)
if vivenv.name not in [d.name for d in c.venvcache.iterdir()] or os.getenv( if vivenv.name not in [d.name for d in c.venvcache.iterdir()] or os.getenv(
@ -539,10 +547,6 @@ class Viv:
generate_import(args.requirements, args.reqs, self.vivenvs, args.path) generate_import(args.requirements, args.reqs, self.vivenvs, args.path)
def _make_row(self, vivenv: ViVenv):
name = vivenv.name if len(vivenv.name) <= 9 else f"{vivenv.name[:6]}..."
return f" │ {name:<9} ┆ {vivenv.spec}"
def list(self, args): def list(self, args):
"""list all vivenvs""" """list all vivenvs"""
@ -569,8 +573,6 @@ class Viv:
"""run python/pip in vivenv""" """run python/pip in vivenv"""
vivenv = self._match_vivenv(args.vivenv) vivenv = self._match_vivenv(args.vivenv)
# if args.vivenv not in self.vivenvs:
# print(f"{args.vivenv}" not in self.vivenvs)
pip_path, python_path = (vivenv.path / "bin" / cmd for cmd in ("pip", "python")) pip_path, python_path = (vivenv.path / "bin" / cmd for cmd in ("pip", "python"))
# todo check for vivenv # todo check for vivenv