etorres/rbackup
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update docstrings for hierarchy module

Browse Source
This commit is contained in:
Eric Torres 2019-03-17 09:34:51 -07:00
parent f70a4c96a1
commit c527367d76
1 changed files with 8 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
rbackup/hierarchy/hierarchy.py
View File

@ -3,11 +3,14 @@
.. module:: rbackup.hierarchy.hierarchy .. module:: rbackup.hierarchy.hierarchy
:synopsis: Classes for creating the backup hierarchy. :synopsis: Classes for creating the backup hierarchy.
""" """
# ========== Classes ========== # ========== Classes ==========
class Hierarchy: class Hierarchy:
"""A class for organizing the backup root hierarchy.""" """A class for organizing the backup root hierarchy.
Upon creation of a Hierarchy object, it is up to the caller
to call either shutil.mkdir() or a related method to create
the directory structure it emulates.
"""
def __init__(self, dest): def __init__(self, dest):
"""Default constructor for the Hierarchy class. """Default constructor for the Hierarchy class.
@ -21,7 +24,7 @@ class Hierarchy:
:param dest: the root directory of the backup hierarchy :param dest: the root directory of the backup hierarchy
:type dest: str, bytes :type dest: str, bytes
""" """
self.dest = dest self._dest = dest
@property @property
def path(self): def path(self):
@ -35,7 +38,7 @@ class Hierarchy:
:rtype: str :rtype: str
""" """
return self.dest return self._dest
# ========== Functions ========== # ========== Functions ==========