Miscellaneous utilities for dealing with filesystems, paths, projects, subprocesses, and more.
.. image:: https://img.shields.io/pypi/v/vistir.svg :target: https://pypi.python.org/pypi/vistir
.. image:: https://img.shields.io/pypi/l/vistir.svg :target: https://pypi.python.org/pypi/vistir
.. image:: https://travis-ci.com/sarugaku/vistir.svg?branch=master :target: https://travis-ci.com/sarugaku/vistir
.. image:: https://img.shields.io/pypi/pyversions/vistir.svg :target: https://pypi.python.org/pypi/vistir
.. image:: https://img.shields.io/badge/Say%20Thanks-!-1EAEDB.svg :target: https://saythanks.io/to/techalchemy
.. image:: https://readthedocs.org/projects/vistir/badge/?version=latest :target: https://vistir.readthedocs.io/en/latest/?badge=latest :alt: Documentation Status
.. image:: https://dev.azure.com/sarugaku/vistir/_apis/build/status/Vistir%20Build%20Pipeline?branchName=master :target: https://dev.azure.com/sarugaku/vistir/_build/latest?definitionId=2&branchName=master
Install from PyPI_:
::
$ pipenv install vistir
Install from Github_:
::
$ pipenv install -e git+https://github.com/sarugaku/vistir.git#egg=vistir
.. _PyPI: https://www.pypi.org/project/vistir .. _Github: https://github.com/sarugaku/vistir
.. _Summary:
vistir is a library full of utility functions designed to make life easier. Here are some of the places where these functions are used:
pipenv_requirementslib_pip-tools_passa_pythonfinder_.. _passa: https://github.com/sarugaku/passa .. _pipenv: https://github.com/pypa/pipenv .. _pip-tools: https://github.com/jazzband/pip-tools .. _requirementslib: https://github.com/sarugaku/requirementslib .. _pythonfinder: https://github.com/sarugaku/pythonfinder
.. _Usage:
You can import utilities directly from vistir:
.. code:: python
from vistir import cd
with cd('/path/to/somedir'):
do_stuff_in('somedir')
.. _Functionality:
vistir provides several categories of functionality, including:
* Compatibility Shims
* Context Managers
* Miscellaneous Utilities
* Path Utilities
vistir provides the following context managers as utility contexts:
* ``vistir.contextmanagers.atomic_open_for_write``
* ``vistir.contextmanagers.cd``
* ``vistir.contextmanagers.open_file``
* ``vistir.contextmanagers.replaced_stream``
* ``vistir.contextmanagers.replaced_streams``
* ``vistir.contextmanagers.temp_environ``
* ``vistir.contextmanagers.temp_path``
.. _atomic_open_for_write:
atomic_open_for_write ///////////////////////////
This context manager ensures that a file only gets overwritten if the contents can be successfully written in its place. If you open a file for writing and then fail in the middle under normal circumstances, your original file is already gone.
.. code:: python
>>> fn = "test_file.txt"
>>> with open(fn, "w") as fh:
fh.write("this is some test text")
>>> read_test_file()
this is some test text
>>> def raise_exception_while_writing(filename):
with vistir.contextmanagers.atomic_open_for_write(filename) as fh:
fh.write("Overwriting all the text from before with even newer text")
raise RuntimeError("But did it get overwritten now?")
>>> raise_exception_while_writing(fn)
Traceback (most recent call last):
...
RuntimeError: But did it get overwritten now?
>>> read_test_file()
this is some test text
.. _cd:
cd ///////
A context manager for temporarily changing the working directory.
.. code:: python
>>> os.path.abspath(os.curdir)
'/tmp/test'
>>> with vistir.contextmanagers.cd('/tmp/vistir_test'):
print(os.path.abspath(os.curdir))
/tmp/vistir_test
.. _open_file:
open_file ///////////////
A context manager for streaming file contents, either local or remote. It is recommended to pair this with an iterator which employs a sensible chunk size.
.. code:: python
>>> filecontents = b""
with vistir.contextmanagers.open_file("https://norvig.com/big.txt") as fp:
for chunk in iter(lambda: fp.read(16384), b""):
filecontents.append(chunk)
>>> import io
>>> import shutil
>>> filecontents = io.BytesIO(b"")
>>> with vistir.contextmanagers.open_file("https://norvig.com/big.txt") as fp:
shutil.copyfileobj(fp, filecontents)
replaced_stream ////////////////////
.. _replaced_stream:
A context manager to temporarily swap out stream_name with a stream wrapper. This will capture the stream output and prevent it from being written as normal.
.. code-block:: python
>>> orig_stdout = sys.stdout
>>> with replaced_stream("stdout") as stdout:
... sys.stdout.write("hello")
... assert stdout.getvalue() == "hello"
... assert orig_stdout.getvalue() != "hello"
>>> sys.stdout.write("hello")
'hello'
.. _replaced_streams:
replaced_streams /////////////////////
Temporarily replaces both sys.stdout and sys.stderr and captures anything written to these respective targets.
.. code-block:: python
>>> import sys
>>> with vistir.contextmanagers.replaced_streams() as streams:
>>> stdout, stderr = streams
>>> sys.stderr.write("test")
>>> sys.stdout.write("hello")
>>> assert stdout.getvalue() == "hello"
>>> assert stderr.getvalue() == "test"
>>> stdout.getvalue()
'hello'
>>> stderr.getvalue()
'test'
.. _spinner:
spinner ////////////
A context manager for wrapping some actions with a threaded, interrupt-safe spinner. The
spinner is fully compatible with all terminals (you can use bouncingBar on non-utf8
terminals) and will allow you to update the text of the spinner itself by simply setting
spinner.text or write lines to the screen above the spinner by using
spinner.write(line). Success text can be indicated using spinner.ok("Text") and
failure text can be indicated with spinner.fail("Fail text").
.. code:: python
>>> lines = ["a", "b"]
>>> with vistir.contextmanagers.spinner(spinner_name="dots", text="Running...", handler_map={}, nospin=False) as sp:
for line in lines:
sp.write(line + "\n")
while some_variable = some_queue.pop():
sp.text = "Consuming item: %s" % some_variable
if success_condition:
sp.ok("Succeeded!")
else:
sp.fail("Failed!")
.. _temp_environ:
temp_environ /////////////////
Sets a temporary environment context to freely manipulate os.environ which will
be reset upon exiting the context.
.. code:: python
>>> os.environ['MY_KEY'] = "test"
>>> os.environ['MY_KEY']
'test'
>>> with vistir.contextmanagers.temp_environ():
os.environ['MY_KEY'] = "another thing"
print("New key: %s" % os.environ['MY_KEY'])
New key: another thing
>>> os.environ['MY_KEY']
'test'
.. _temp_path:
temp_path //////////////
Sets a temporary environment context to freely manipulate sys.path which will
be reset upon exiting the context.
.. code:: python
>>> path_from_virtualenv = load_path("/path/to/venv/bin/python")
>>> print(sys.path)
['/home/user/.pyenv/versions/3.7.0/bin', '/home/user/.pyenv/versions/3.7.0/lib/python37.zip', '/home/user/.pyenv/versions/3.7.0/lib/python3.7', '/home/user/.pyenv/versions/3.7.0/lib/python3.7/lib-dynload', '/home/user/.pyenv/versions/3.7.0/lib/python3.7/site-packages']
>>> with temp_path():
sys.path = path_from_virtualenv
# Running in the context of the path above
run(["pip", "install", "stuff"])
>>> print(sys.path)
['/home/user/.pyenv/versions/3.7.0/bin', '/home/user/.pyenv/versions/3.7.0/lib/python37.zip', '/home/user/.pyenv/versions/3.7.0/lib/python3.7', '/home/user/.pyenv/versions/3.7.0/lib/python3.7/lib-dynload', '/home/user/.pyenv/versions/3.7.0/lib/python3.7/site-packages']
The following Cursor utilities are available to manipulate the console cursor:
* ``vistir.cursor.hide_cursor``
* ``vistir.cursor.show_cursor``
.. _hide_cursor:
hide_cursor /////////////////
Hide the console cursor in the given stream.
.. code:: python
>>> vistir.cursor.hide_cursor(stream=sys.stdout)
.. _show_cursor:
show_cursor /////////////////
Show the console cursor in the given stream.
.. code:: python
>>> vistir.cursor.show_cursor(stream=sys.stdout)
The following Miscellaneous utilities are available as helper methods:
* ``vistir.misc.shell_escape``
* ``vistir.misc.unnest``
* ``vistir.misc.run``
* ``vistir.misc.load_path``
* ``vistir.misc.partialclass``
* ``vistir.misc.to_text``
* ``vistir.misc.to_bytes``
* ``vistir.misc.take``
* ``vistir.misc.decode_for_output``
* ``vistir.misc.get_canonical_encoding_name``
* ``vistir.misc.get_wrapped_stream``
* ``vistir.misc.StreamWrapper``
* ``vistir.misc.get_text_stream``
* ``vistir.misc.replace_with_text_stream``
* ``vistir.misc.get_text_stdin``
* ``vistir.misc.get_text_stdout``
* ``vistir.misc.get_text_stderr``
* ``vistir.misc.echo``
.. _shell_escape:
shell_escape /////////////////
Escapes a string for use as shell input when passing shell=True to os.Popen.
.. code:: python
>>> vistir.misc.shell_escape("/tmp/test/test script.py hello")
'/tmp/test/test script.py hello'
.. _unnest:
unnest ///////////
Unnests nested iterables into a flattened one.
.. code:: python
>>> nested_iterable = (1234, (3456, 4398345, (234234)), (2396, (23895750, 9283798, 29384, (289375983275, 293759, 2347, (2098, 7987, 27599)))))
>>> list(vistir.misc.unnest(nested_iterable))
[1234, 3456, 4398345, 234234, 2396, 23895750, 9283798, 29384, 289375983275, 293759, 2347, 2098, 7987, 27599]
.. _dedup:
dedup //////////
Deduplicates an iterable (like a set, but preserving order).
.. code:: python
>>> iterable = ["repeatedval", "uniqueval", "repeatedval", "anotherval", "somethingelse"]
>>> list(vistir.misc.dedup(iterable))
['repeatedval', 'uniqueval', 'anotherval', 'somethingelse']
.. _run:
run ////////
Runs the given command using subprocess.Popen and passing sane defaults.
.. code:: python
>>> out, err = vistir.run(["cat", "/proc/version"])
>>> out
'Linux version 4.15.0-27-generic (buildd@lgw01-amd64-044) (gcc version 7.3.0 (Ubuntu 7.3.0-16ubuntu3)) #29-Ubuntu SMP Wed Jul 11 08:21:57 UTC 2018'
.. _load_path:
load_path //////////////
Load the sys.path from the given python executable's environment as json.
.. code:: python
>>> load_path("/home/user/.virtualenvs/requirementslib-5MhGuG3C/bin/python")
['', '/home/user/.virtualenvs/requirementslib-5MhGuG3C/lib/python37.zip', '/home/user/.virtualenvs/requirementslib-5MhGuG3C/lib/python3.7', '/home/user/.virtualenvs/requirementslib-5MhGuG3C/lib/python3.7/lib-dynload', '/home/user/.pyenv/versions/3.7.0/lib/python3.7', '/home/user/.virtualenvs/requirementslib-5MhGuG3C/lib/python3.7/site-packages', '/home/user/git/requirementslib/src']
.. _partialclass:
partialclass /////////////////
Create a partially instantiated class.
.. code:: python
>>> source = partialclass(Source, url="https://pypi.org/simple")
>>> new_source = source(name="pypi")
>>> new_source
<__main__.Source object at 0x7f23af189b38>
>>> new_source.__dict__
{'url': 'https://pypi.org/simple', 'verify_ssl': True, 'name': 'pypi'}
.. _to_text:
to_text ////////////
Convert arbitrary text-formattable input to text while handling errors.
.. code:: python
>>> vistir.misc.to_text(b"these are bytes")
'these are bytes'
.. _to_bytes:
to_bytes /////////////
Converts arbitrary byte-convertable input to bytes while handling errors.
.. code:: python
>>> vistir.misc.to_bytes("this is some text")
b'this is some text'
>>> vistir.misc.to_bytes(u"this is some text")
b'this is some text'
.. _chunked:
chunked ////////////
Splits an iterable up into groups of the specified length, per more itertools_. Returns an iterable.
This example will create groups of chunk size 5, which means there will be 6 groups.
.. code-block:: python
>>> chunked_iterable = vistir.misc.chunked(5, range(30))
>>> for chunk in chunked_iterable:
... add_to_some_queue(chunk)
.. _more itertools: https://more-itertools.readthedocs.io/en/latest/api.html#grouping
.. _take:
take /////////
Take elements from the supplied iterable without consuming it.
.. code-block:: python
>>> iterable = range(30)
>>> first_10 = take(10, iterable)
>>> [i for i in first_10]
[0, 1, 2, 3, 4, 5, 6, 7, 8, 9]
>>> [i for i in iterable]
[0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29]
.. _divide:
divide ////////////
Splits an iterable up into the specified number of groups, per more itertools_. Returns an iterable.
.. code-block:: python
>>> iterable = range(30)
>>> groups = []
>>> for grp in vistir.misc.divide(3, iterable):
... groups.append(grp)
>>> groups
[<tuple_iterator object at 0x7fb7966006a0>, <tuple_iterator object at 0x7fb796652780>, <tuple_iterator object at 0x7fb79650a2b0>]
.. _more itertools: https://more-itertools.readthedocs.io/en/latest/api.html#grouping
.. _decode_for_output:
decode_for_output //////////////////////
Converts an arbitrary text input to output which is encoded for printing to terminal
outputs using the system preferred locale using locale.getpreferredencoding(False)
with some additional hackery on linux systems.
.. _get_canonical_encoding_name:
get_canonical_encoding_name ////////////////////////////////
Given an encoding name, get the canonical name from a codec lookup.
.. code-block:: python
>>> vistir.misc.get_canonical_encoding_name("utf8")
"utf-8"
.. _get_wrapped_stream:
get_wrapped_stream //////////////////////
Given a stream, wrap it in a StreamWrapper instance and return the wrapped stream.
.. code-block:: python
>>> stream = sys.stdout
>>> wrapped_stream = vistir.misc.get_wrapped_stream(sys.stdout)
>>> wrapped_stream.write("unicode\u0141")
>>> wrapped_stream.seek(0)
>>> wrapped_stream.read()
"unicode\u0141"
.. _StreamWrapper:
StreamWrapper //////////////////
A stream wrapper and compatibility class for handling wrapping file-like stream objects
which may be used in place of sys.stdout and other streams.
.. code-block:: python
>>> wrapped_stream = vistir.misc.StreamWrapper(sys.stdout, encoding="utf-8", errors="replace", line_buffering=True)
>>> wrapped_stream = vistir.misc.StreamWrapper(io.StringIO(), encoding="utf-8", errors="replace", line_buffering=True)
.. _get_text_stream:
get_text_stream ////////////////////
An implementation of the StreamWrapper for the purpose of wrapping sys.stdin or sys.stdout.
On Windows, this returns the appropriate handle to the requested output stream.
.. code-block:: python
>>> text_stream = vistir.misc.get_text_stream("stdout")
>>> sys.stdout = text_stream
>>> sys.stdin = vistir.misc.get_text_stream("stdin")
>>> vistir.misc.echo(u"\0499", fg="green")
ҙ
.. _replace_with_text_stream:
replace_with_text_stream /////////////////////////////
Given a text stream name, replaces the text stream with a StreamWrapper instance.
.. code-block:: python
>>> vistir.misc.replace_with_text_stream("stdout")
Once invoked, the standard stream in question is replaced with the required wrapper,
turning it into a TextIOWrapper compatible stream (which ensures that unicode
characters can be written to it).
.. _get_text_stdin:
get_text_stdin ///////////////////
A helper function for calling get_text_stream("stdin").
.. _get_text_stdout:
get_text_stdout ////////////////////
A helper function for calling get_text_stream("stdout").
.. _get_text_stderr:
get_text_stderr ////////////////////
A helper function for calling get_text_stream("stderr").
.. _echo:
echo /////////
Writes colored, stream-compatible output to the desired handle (sys.stdout by default).
.. code-block:: python
>>> vistir.misc.echo("some text", fg="green", bg="black", style="bold", err=True) # write to stderr
some text
>>> vistir.misc.echo("some other text", fg="cyan", bg="white", style="underline") # write to stdout
some other text
vistir provides utilities for interacting with filesystem paths:
* ``vistir.path.get_converted_relative_path``
* ``vistir.path.normalize_path``
* ``vistir.path.is_in_path``
* ``vistir.path.handle_remove_readonly``
* ``vistir.path.is_file_url``
* ``vistir.path.is_readonly_path``
* ``vistir.path.is_valid_url``
* ``vistir.path.mkdir_p``
* ``vistir.path.ensure_mkdir_p``
* ``vistir.path.create_tracked_tempdir``
* ``vistir.path.create_tracked_tempfile``
* ``vistir.path.path_to_url``
* ``vistir.path.rmtree``
* ``vistir.path.safe_expandvars``
* ``vistir.path.set_write_bit``
* ``vistir.path.url_to_path``
* ``vistir.path.walk_up``
.. _normalize_path:
normalize_path //////////////////
Return a case-normalized absolute variable-expanded path.
.. code:: python
>>> vistir.path.normalize_path("~/${USER}")
/home/user/user
.. _is_in_path:
is_in_path //////////////
Determine if the provided full path is in the given parent root.
.. code:: python
>>> vistir.path.is_in_path("~/.pyenv/versions/3.7.1/bin/python", "${PYENV_ROOT}/versions")
True
.. _get_converted_relative_path:
get_converted_relative_path ////////////////////////////////
Convert the supplied path to a relative path (relative to os.curdir)
.. code:: python
>>> os.chdir('/home/user/code/myrepo/myfolder')
>>> vistir.path.get_converted_relative_path('/home/user/code/file.zip')
'./../../file.zip'
>>> vistir.path.get_converted_relative_path('/home/user/code/myrepo/myfolder/mysubfolder')
'./mysubfolder'
>>> vistir.path.get_converted_relative_path('/home/user/code/myrepo/myfolder')
'.'
.. _handle_remove_readonly:
handle_remove_readonly ///////////////////////////
Error handler for shutil.rmtree.
Windows source repo folders are read-only by default, so this error handler attempts to set them as writeable and then proceed with deletion.
This function will call check vistir.path.is_readonly_path before attempting to
call vistir.path.set_write_bit on the target path and try again.
.. _is_file_url:
is_file_url ////////////////
Checks whether the given url is a properly formatted file:// uri.
.. code:: python
>>> vistir.path.is_file_url('file:///home/user/somefile.zip')
True
>>> vistir.path.is_file_url('/home/user/somefile.zip')
False
.. _is_readonly_path:
is_readonly_path /////////////////////
Check if a provided path exists and is readonly by checking for bool(path.stat & stat.S_IREAD) and not os.access(path, os.W_OK)
.. code:: python
>>> vistir.path.is_readonly_path('/etc/passwd')
True
>>> vistir.path.is_readonly_path('/home/user/.bashrc')
False
.. _is_valid_url:
is_valid_url /////////////////
Checks whether a URL is valid and parseable by checking for the presence of a scheme and a netloc.
.. code:: python
>>> vistir.path.is_valid_url("https://google.com")
True
>>> vistir.path.is_valid_url("/home/user/somefile")
False
.. _mkdir_p:
mkdir_p /////////////
Recursively creates the target directory and all of its parents if they do not already exist. Fails silently if they do.
.. code:: python
>>> os.mkdir('/tmp/test_dir')
>>> os.listdir('/tmp/test_dir')
[]
>>> vistir.path.mkdir_p('/tmp/test_dir/child/subchild/subsubchild')
>>> os.listdir('/tmp/test_dir/child/subchild')
['subsubchild']
.. _ensure_mkdir_p:
ensure_mkdir_p ///////////////////
A decorator which ensures that the caller function's return value is created as a directory on the filesystem.
.. code:: python
>>> @ensure_mkdir_p
def return_fake_value(path):
return path
>>> return_fake_value('/tmp/test_dir')
>>> os.listdir('/tmp/test_dir')
[]
>>> return_fake_value('/tmp/test_dir/child/subchild/subsubchild')
>>> os.listdir('/tmp/test_dir/child/subchild')
['subsubchild']
.. _create_tracked_tempdir:
create_tracked_tempdir ////////////////////////////
Creates a tracked temporary directory using vistir.path.TemporaryDirectory, but does
not remove the directory when the return value goes out of scope, instead registers a
handler to cleanup on program exit.
.. code:: python
>>> temp_dir = vistir.path.create_tracked_tempdir(prefix="test_dir")
>>> assert temp_dir.startswith("test_dir")
True
>>> with vistir.path.create_tracked_tempdir(prefix="test_dir") as temp_dir:
with io.open(os.path.join(temp_dir, "test_file.txt"), "w") as fh:
fh.write("this is a test")
>>> os.listdir(temp_dir)
.. _create_tracked_tempfile:
create_tracked_tempfile ////////////////////////////
Creates a tracked temporary file using vistir.compat.NamedTemporaryFile, but creates
a weakref.finalize call which will detach on garbage collection to close and delete
the file.
.. code:: python
>>> temp_file = vistir.path.create_tracked_tempfile(prefix="requirements", suffix="txt")
>>> temp_file.write("some\nstuff")
>>> exit()
.. _path_to_url:
path_to_url ////////////////
Convert the supplied local path to a file uri.
.. code:: python
>>> path_to_url("/home/user/code/myrepo/myfile.zip")
'file:///home/user/code/myrepo/myfile.zip'
.. _rmtree:
rmtree ///////////
Stand-in for shutil.rmtree with additional error-handling.
This version of rmtree handles read-only paths, especially in the case of index files
written by certain source control systems.
.. code:: python
>>> vistir.path.rmtree('/tmp/test_dir')
>>> [d for d in os.listdir('/tmp') if 'test_dir' in d]
[]
.. note::
Setting `ignore_errors=True` may cause this to silently fail to delete the path
.. _safe_expandvars:
safe_expandvars ////////////////////
Call os.path.expandvars if value is a string, otherwise do nothing.
.. code:: python
>>> os.environ['TEST_VAR'] = "MY_TEST_VALUE"
>>> vistir.path.safe_expandvars("https://myuser:${TEST_VAR}@myfakewebsite.com")
'https://myuser:MY_TEST_VALUE@myfakewebsite.com'
.. _set_write_bit:
set_write_bit //////////////////
Set read-write permissions for the current user on the target path. Fail silently if the path doesn't exist.
.. code:: python
>>> vistir.path.set_write_bit('/path/to/some/file')
>>> with open('/path/to/some/file', 'w') as fh:
fh.write("test text!")
.. _url_to_path:
url_to_path ////////////////
Convert a valid file url to a local filesystem path. Follows logic taken from pip.
.. code:: python
>>> vistir.path.url_to_path("file:///home/user/somefile.zip")
'/home/user/somefile.zip'