openstack/neutron-lib
Code Issues Proposed changes

Add docstrings for utils.file

Browse Source 
Cleaning up a little technical debt by adding docstrings
for our public APIs.

Note: I plan to submit a patch per file as part of this bug work.
These patches won't depend on each other. The last patch of
the series will close the bug.

Change-Id: Icc65349e1d2b32cefbe0dc8472ca7f0c68c9a7f9
Partial-Bug: #1614594
This commit is contained in:
Boden R 2016-08-22 16:29:40 -06:00
parent 72c7cd2d31
commit e86df3b3f3
1 changed files with 12 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
neutron_lib/utils/file.py
View File

@ -19,7 +19,13 @@ import tempfile
def ensure_dir(dir_path):
"""Ensure a directory with 755 permissions mode."""
"""Ensure a directory with 755 permissions mode.
:param dir_path: The directory path to ensure.
:returns: None.
:raises OSError: If the underlying call to makedirs raises an OSError
other than EEXIST.
"""
try:
os.makedirs(dir_path, 0o755)
except OSError as e:
@ -35,6 +41,11 @@ def replace_file(file_name, data, file_mode=0o644):
atomic, the file is unlikely to be corrupted by competing writes.
We create the tempfile on the same device to ensure that it can be renamed.
:param file_name: Path to the file to replace.
:param data: The data to write to the file.
:param file_mode: The mode to use for the replaced file.
:returns: None.
"""
base_dir = os.path.dirname(os.path.abspath(file_name))