diff --git a/dfvfs/file_io/compressed_stream_io.py b/dfvfs/file_io/compressed_stream_io.py index 99f4bc41..ab253b49 100644 --- a/dfvfs/file_io/compressed_stream_io.py +++ b/dfvfs/file_io/compressed_stream_io.py @@ -25,7 +25,7 @@ def __init__( Args: resolver_context: the resolver context (instance of resolver.Context). compression_method: optional method used to the compress the data. - file_object: optional parent file-like object. The default is None. + file_object: optional parent file-like object. Raises: ValueError: if file_object provided but compression_method is not. @@ -101,7 +101,6 @@ def _Open(self, path_spec=None, mode='rb'): Args: path_spec: optional path specification (instance of path.PathSpec). - The default is None. mode: optional file access mode. The default is 'rb' read-only binary. Raises: diff --git a/dfvfs/file_io/data_range_io.py b/dfvfs/file_io/data_range_io.py index 3fdffbec..bf3a85b7 100644 --- a/dfvfs/file_io/data_range_io.py +++ b/dfvfs/file_io/data_range_io.py @@ -25,7 +25,7 @@ def __init__(self, resolver_context, file_object=None): Args: resolver_context: the resolver context (instance of resolver.Context). - file_object: optional parent file-like object. The default is None. + file_object: optional parent file-like object. """ super(DataRange, self).__init__(resolver_context) self._file_object = file_object @@ -61,7 +61,6 @@ def _Open(self, path_spec=None, mode='rb'): Args: path_spec: optional path specification (instance of path.PathSpec). - The default is None. mode: optional file access mode. The default is 'rb' read-only binary. Raises: diff --git a/dfvfs/file_io/encoded_stream_io.py b/dfvfs/file_io/encoded_stream_io.py index 58dde546..17ea638e 100644 --- a/dfvfs/file_io/encoded_stream_io.py +++ b/dfvfs/file_io/encoded_stream_io.py @@ -25,7 +25,7 @@ def __init__( Args: resolver_context: the resolver context (instance of resolver.Context). encoding_method: optional method used to the encode the data. - file_object: optional parent file-like object. The default is None. + file_object: optional parent file-like object. Raises: ValueError: if file_object provided but encoding_method is not. @@ -99,7 +99,6 @@ def _Open(self, path_spec=None, mode='rb'): Args: path_spec: optional path specification (instance of path.PathSpec). - The default is None. mode: optional file access mode. The default is 'rb' read-only binary. Raises: diff --git a/dfvfs/file_io/ewf_file_io.py b/dfvfs/file_io/ewf_file_io.py index 4253b67a..1881aa88 100644 --- a/dfvfs/file_io/ewf_file_io.py +++ b/dfvfs/file_io/ewf_file_io.py @@ -21,7 +21,7 @@ def __init__(self, resolver_context, file_object=None): Args: resolver_context: the resolver context (instance of resolver.Context). - file_object: optional file-like object. The default is None. + file_object: optional file-like object. Raises: ValueError: when file_object is set. diff --git a/dfvfs/file_io/fake_file_io.py b/dfvfs/file_io/fake_file_io.py index 1a671d2e..5fe80908 100644 --- a/dfvfs/file_io/fake_file_io.py +++ b/dfvfs/file_io/fake_file_io.py @@ -35,7 +35,6 @@ def _Open(self, path_spec=None, mode='rb'): Args: path_spec: optional path specification (instance of path.PathSpec). - The default is None. mode: optional file access mode. The default is 'rb' read-only binary. Raises: diff --git a/dfvfs/file_io/file_io.py b/dfvfs/file_io/file_io.py index 4b923699..86ec6373 100644 --- a/dfvfs/file_io/file_io.py +++ b/dfvfs/file_io/file_io.py @@ -38,7 +38,6 @@ def _Open(self, path_spec=None, mode='rb'): Args: path_spec: optional path specification (instance of path.PathSpec). - The default is None. mode: optional file access mode. The default is 'rb' read-only binary. Raises: @@ -56,7 +55,6 @@ def open(self, path_spec=None, mode='rb'): Args: path_spec: optional path specification (instance of path.PathSpec). - The default is None. mode: optional file access mode. The default is 'rb' read-only binary. Raises: diff --git a/dfvfs/file_io/file_object_io.py b/dfvfs/file_io/file_object_io.py index b3bf0d33..2cd8415b 100644 --- a/dfvfs/file_io/file_object_io.py +++ b/dfvfs/file_io/file_object_io.py @@ -15,7 +15,7 @@ def __init__(self, resolver_context, file_object=None): Args: resolver_context: the resolver context (instance of resolver.Context). - file_object: optional file-like object. The default is None. + file_object: optional file-like object. """ super(FileObjectIO, self).__init__(resolver_context) self._file_object = file_object @@ -45,7 +45,6 @@ def _Open(self, path_spec=None, mode='rb'): Args: path_spec: optional the path specification (instance of path.PathSpec). - The default is None. mode: optional file access mode. The default is 'rb' read-only binary. Raises: diff --git a/dfvfs/file_io/gzip_file_io.py b/dfvfs/file_io/gzip_file_io.py index 53de89ef..8bfcf825 100644 --- a/dfvfs/file_io/gzip_file_io.py +++ b/dfvfs/file_io/gzip_file_io.py @@ -46,7 +46,7 @@ def __init__(self, resolver_context, file_object=None): Args: resolver_context: the resolver context (instance of resolver.Context). - file_object: optional file-like object. The default is None. + file_object: optional file-like object. Raises: ValueError: when file_object is set. @@ -137,7 +137,6 @@ def _OpenFileObject(self, path_spec): Args: path_spec: optional the path specification (instance of path.PathSpec). - The default is None. Returns: A file-like object. diff --git a/dfvfs/file_io/ntfs_file_io.py b/dfvfs/file_io/ntfs_file_io.py index 21302c76..3f195c46 100644 --- a/dfvfs/file_io/ntfs_file_io.py +++ b/dfvfs/file_io/ntfs_file_io.py @@ -42,7 +42,6 @@ def _Open(self, path_spec=None, mode='rb'): Args: path_spec: optional path specification (instance of path.PathSpec). - The default is None. mode: optional file access mode. The default is 'rb' read-only binary. Raises: diff --git a/dfvfs/file_io/os_file_io.py b/dfvfs/file_io/os_file_io.py index 391e58d4..10bdf464 100644 --- a/dfvfs/file_io/os_file_io.py +++ b/dfvfs/file_io/os_file_io.py @@ -42,7 +42,6 @@ def _Open(self, path_spec=None, mode='rb'): Args: path_spec: optional path specification (instance of path.PathSpec). - The default is None. mode: optional file access mode. The default is 'rb' read-only binary. Raises: diff --git a/dfvfs/file_io/raw_file_io.py b/dfvfs/file_io/raw_file_io.py index 5e7153f1..614d65c7 100644 --- a/dfvfs/file_io/raw_file_io.py +++ b/dfvfs/file_io/raw_file_io.py @@ -21,7 +21,7 @@ def __init__(self, resolver_context, file_object=None): Args: resolver_context: the resolver context (instance of resolver.Context). - file_object: optional file-like object. The default is None. + file_object: optional file-like object. Raises: ValueError: when file_object is set. diff --git a/dfvfs/file_io/sqlite_blob_file_io.py b/dfvfs/file_io/sqlite_blob_file_io.py index 14a49964..a16855b0 100644 --- a/dfvfs/file_io/sqlite_blob_file_io.py +++ b/dfvfs/file_io/sqlite_blob_file_io.py @@ -131,7 +131,6 @@ def _Open(self, path_spec=None, mode='rb'): Args: path_spec: optional path specification (instance of path.PathSpec). - The default is None. mode: optional file access mode. The default is 'rb' read-only binary. Raises: diff --git a/dfvfs/file_io/tar_file_io.py b/dfvfs/file_io/tar_file_io.py index 296dea65..92dce502 100644 --- a/dfvfs/file_io/tar_file_io.py +++ b/dfvfs/file_io/tar_file_io.py @@ -46,7 +46,6 @@ def _Open(self, path_spec=None, mode='rb'): Args: path_spec: optional the path specification (instance of path.PathSpec). - The default is None. mode: optional file access mode. The default is 'rb' read-only binary. Raises: diff --git a/dfvfs/file_io/tsk_file_io.py b/dfvfs/file_io/tsk_file_io.py index 755ca198..8f115e61 100644 --- a/dfvfs/file_io/tsk_file_io.py +++ b/dfvfs/file_io/tsk_file_io.py @@ -42,7 +42,6 @@ def _Open(self, path_spec=None, mode='rb'): Args: path_spec: optional path specification (instance of path.PathSpec). - The default is None. mode: optional file access mode. The default is 'rb' read-only binary. Raises: diff --git a/dfvfs/file_io/tsk_partition_file_io.py b/dfvfs/file_io/tsk_partition_file_io.py index 622a02b0..7526d5fd 100644 --- a/dfvfs/file_io/tsk_partition_file_io.py +++ b/dfvfs/file_io/tsk_partition_file_io.py @@ -33,7 +33,6 @@ def _Open(self, path_spec=None, mode='rb'): Args: path_spec: optional path specification (instance of path.PathSpec). - The default is None. mode: optional file access mode. The default is 'rb' read-only binary. Raises: diff --git a/dfvfs/file_io/vshadow_file_io.py b/dfvfs/file_io/vshadow_file_io.py index 36b2299f..700c9a21 100644 --- a/dfvfs/file_io/vshadow_file_io.py +++ b/dfvfs/file_io/vshadow_file_io.py @@ -38,7 +38,6 @@ def _Open(self, path_spec=None, mode='rb'): Args: path_spec: optional path specification (instance of path.PathSpec). - The default is None. mode: optional file access mode. The default is 'rb' read-only binary. Raises: diff --git a/dfvfs/file_io/zip_file_io.py b/dfvfs/file_io/zip_file_io.py index da8f7247..deb36d07 100644 --- a/dfvfs/file_io/zip_file_io.py +++ b/dfvfs/file_io/zip_file_io.py @@ -60,7 +60,6 @@ def _Open(self, path_spec=None, mode='rb'): Args: path_spec: optional the path specification (instance of path.PathSpec). - The default is None. mode: optional file access mode. The default is 'rb' read-only binary. Raises: diff --git a/dfvfs/helpers/file_system_searcher.py b/dfvfs/helpers/file_system_searcher.py index 1b9b8735..eb61f106 100644 --- a/dfvfs/helpers/file_system_searcher.py +++ b/dfvfs/helpers/file_system_searcher.py @@ -19,13 +19,12 @@ def __init__( Args: file_entry_types: Optional file entry types list or None to indicate - no preference. The default is None. + no preference. is_allocated: Optional boolean value to indicate the file entry should be allocated, where None represents no preference. - The default is True. location: Optional location string or list of location segments, or None to indicate no preference. The location should be defined - relative to the root of the file system. The default is None. + relative to the root of the file system. Note that the string will be split into segments based on the file system specific path segment separator. location_regex: Optional location regular expression string or list of @@ -36,7 +35,7 @@ def __init__( segments based on the file system specific path segment separator. case_sensitive: Optional boolean value to indicate string matches should - be case sensitive. The default is true. + be case sensitive. Raises: TypeError: if the location or location_regex type is not supported. diff --git a/dfvfs/helpers/windows_path_resolver.py b/dfvfs/helpers/windows_path_resolver.py index 1dc514a5..150abcef 100644 --- a/dfvfs/helpers/windows_path_resolver.py +++ b/dfvfs/helpers/windows_path_resolver.py @@ -26,7 +26,7 @@ def __init__(self, file_system, mount_point, drive_letter=u'C'): mount_point: the mount point path specification (instance of path.PathSpec). drive_letter: optional string that contains the drive letter used by - the file system. The default is C. + the file system. Raises: PathSpecError: if the mount point path specification is incorrect. @@ -111,7 +111,7 @@ def _ResolvePath(self, path, expand_variables=True): Args: path: the Windows path to resolve. expand_variables: optional value to indicate path variables should be - expanded or not. The default is to expand (True). + expanded or not. Returns: A tuple of the path in file system specific format and the matching path @@ -231,7 +231,7 @@ def ResolvePath(self, path, expand_variables=True): Args: path: the Windows path to resolve. expand_variables: optional value to indicate path variables should be - expanded or not. The default is to expand (True). + expanded or not. Returns: The path specification (instance of path.PathSpec) in file system diff --git a/dfvfs/path/bde_path_spec.py b/dfvfs/path/bde_path_spec.py index ed56629e..97625ed9 100644 --- a/dfvfs/path/bde_path_spec.py +++ b/dfvfs/path/bde_path_spec.py @@ -18,7 +18,6 @@ def __init__(self, parent=None, **kwargs): Args: parent: optional parent path specification (instance of PathSpec). - The default is None. Raises: ValueError: when parent is not set. diff --git a/dfvfs/path/compressed_stream_path_spec.py b/dfvfs/path/compressed_stream_path_spec.py index 35093620..69e13ba1 100644 --- a/dfvfs/path/compressed_stream_path_spec.py +++ b/dfvfs/path/compressed_stream_path_spec.py @@ -18,9 +18,7 @@ def __init__(self, compression_method=None, parent=None, **kwargs): Args: compression_method: optional method used to the compress the data. - The default is None. parent: optional parent path specification (instance of PathSpec). - The default is None. kwargs: a dictionary of keyword arguments dependending on the path specification. diff --git a/dfvfs/path/data_range_path_spec.py b/dfvfs/path/data_range_path_spec.py index e5533052..c7e56faf 100644 --- a/dfvfs/path/data_range_path_spec.py +++ b/dfvfs/path/data_range_path_spec.py @@ -18,11 +18,8 @@ def __init__(self, range_offset=None, range_size=None, parent=None, **kwargs): Args: range_offset: optional start offset of the data range. - The default is None. range_size: optional size of the data range. - The default is None. parent: optional parent path specification (instance of PathSpec). - The default is None. kwargs: a dictionary of keyword arguments dependending on the path specification. diff --git a/dfvfs/path/encoded_stream_path_spec.py b/dfvfs/path/encoded_stream_path_spec.py index e4006023..36d4f967 100644 --- a/dfvfs/path/encoded_stream_path_spec.py +++ b/dfvfs/path/encoded_stream_path_spec.py @@ -18,9 +18,7 @@ def __init__(self, encoding_method=None, parent=None, **kwargs): Args: encoding_method: optional method used to the encode the data. - The default is None. parent: optional parent path specification (instance of PathSpec). - The default is None. kwargs: a dictionary of keyword arguments dependending on the path specification. diff --git a/dfvfs/path/ewf_path_spec.py b/dfvfs/path/ewf_path_spec.py index 34bb3023..4977ce36 100644 --- a/dfvfs/path/ewf_path_spec.py +++ b/dfvfs/path/ewf_path_spec.py @@ -18,7 +18,6 @@ def __init__(self, parent=None, **kwargs): Args: parent: optional parent path specification (instance of PathSpec). - The default is None. kwargs: a dictionary of keyword arguments dependending on the path specification. diff --git a/dfvfs/path/fake_path_spec.py b/dfvfs/path/fake_path_spec.py index ac054d05..38f359c9 100644 --- a/dfvfs/path/fake_path_spec.py +++ b/dfvfs/path/fake_path_spec.py @@ -18,7 +18,7 @@ def __init__(self, location=None, **kwargs): Note that the fake path specification cannot have a parent. Args: - location: optional location string e.g. /opt/dfvfs. The default is None. + location: optional location string e.g. /opt/dfvfs. kwargs: a dictionary of keyword arguments dependending on the path specification. diff --git a/dfvfs/path/gzip_path_spec.py b/dfvfs/path/gzip_path_spec.py index 26a15f11..a39094f0 100644 --- a/dfvfs/path/gzip_path_spec.py +++ b/dfvfs/path/gzip_path_spec.py @@ -18,7 +18,6 @@ def __init__(self, parent=None, **kwargs): Args: parent: optional parent path specification (instance of PathSpec). - The default is None. kwargs: a dictionary of keyword arguments dependending on the path specification. diff --git a/dfvfs/path/location_path_spec.py b/dfvfs/path/location_path_spec.py index a93a0364..53296d9f 100644 --- a/dfvfs/path/location_path_spec.py +++ b/dfvfs/path/location_path_spec.py @@ -11,7 +11,7 @@ def __init__(self, location=None, parent=None, **kwargs): """Initializes the path specification object. Args: - location: optional location string. The default is None. + location: optional location string. parent: optional parent path specification (instance of PathSpec), default is None. kwargs: a dictionary of keyword arguments dependending on the path diff --git a/dfvfs/path/ntfs_path_spec.py b/dfvfs/path/ntfs_path_spec.py index c82a26aa..a69a3bf3 100644 --- a/dfvfs/path/ntfs_path_spec.py +++ b/dfvfs/path/ntfs_path_spec.py @@ -21,13 +21,11 @@ def __init__( Args: data_stream: optional data stream name. The default is None, which indicates the default data stream. - location: optional location string. The default is None. + location: optional location string. mft_attribute: optional $FILE_NAME MFT attribute index. The default is None. The first attribute is indicated by 0. - mft_entry: optional MFT entry. The default is None. The first entry - is indicated by 0. + mft_entry: optional MFT entry. The first entry is indicated by 0. parent: optional parent path specification (instance of PathSpec), - The default is None. kwargs: a dictionary of keyword arguments dependending on the path specification diff --git a/dfvfs/path/os_path_spec.py b/dfvfs/path/os_path_spec.py index 6e0cd9df..008891e7 100644 --- a/dfvfs/path/os_path_spec.py +++ b/dfvfs/path/os_path_spec.py @@ -21,7 +21,7 @@ def __init__(self, location=None, **kwargs): Args: location: optional operating specific location string e.g. /opt/dfvfs or - C:\\Opt\\dfvfs. The default is None. + C:\\Opt\\dfvfs. kwargs: a dictionary of keyword arguments dependending on the path specification. diff --git a/dfvfs/path/path_spec.py b/dfvfs/path/path_spec.py index 45c12ce4..6c2cd6c0 100644 --- a/dfvfs/path/path_spec.py +++ b/dfvfs/path/path_spec.py @@ -42,8 +42,7 @@ def _GetComparable(self, sub_comparable_string=u''): This is a convenince function for constructing comparables. Args: - sub_comparable_string: the sub comparable string. The default is - an empty string. + sub_comparable_string: the sub comparable string. Returns: A string containing the comparable. diff --git a/dfvfs/path/qcow_path_spec.py b/dfvfs/path/qcow_path_spec.py index 26506021..48a4688a 100644 --- a/dfvfs/path/qcow_path_spec.py +++ b/dfvfs/path/qcow_path_spec.py @@ -18,7 +18,6 @@ def __init__(self, parent=None, **kwargs): Args: parent: optional parent path specification (instance of PathSpec). - The default is None. kwargs: a dictionary of keyword arguments dependending on the path specification. diff --git a/dfvfs/path/raw_path_spec.py b/dfvfs/path/raw_path_spec.py index d138a5c7..e430b757 100644 --- a/dfvfs/path/raw_path_spec.py +++ b/dfvfs/path/raw_path_spec.py @@ -18,7 +18,6 @@ def __init__(self, parent=None, **kwargs): Args: parent: optional parent path specification (instance of PathSpec). - The default is None. kwargs: a dictionary of keyword arguments dependending on the path specification. diff --git a/dfvfs/path/sqlite_blob_path_spec.py b/dfvfs/path/sqlite_blob_path_spec.py index 02c4d4ab..6e4fef2a 100644 --- a/dfvfs/path/sqlite_blob_path_spec.py +++ b/dfvfs/path/sqlite_blob_path_spec.py @@ -20,18 +20,13 @@ def __init__( Args: table_name: optional name of the table in which the blob is stored. - The default is None. column_name: optional name of the column in which the blob is stored. - The default is None. row_condition: optional condition of the row in which the blob is stored. The condition is a tuple in the form: (column_name, operator, value). - The condition must yield a single result. The default is - None. + The condition must yield a single result. row_index: optional index of the row in which the blob is stored. - The default is None. parent: optional parent path specification (instance of PathSpec). - The default None. kwargs: a dictionary of keyword arguments dependending on the path specification diff --git a/dfvfs/path/tar_path_spec.py b/dfvfs/path/tar_path_spec.py index 986d4fea..e0dcbf90 100644 --- a/dfvfs/path/tar_path_spec.py +++ b/dfvfs/path/tar_path_spec.py @@ -18,9 +18,8 @@ def __init__(self, location=None, parent=None, **kwargs): Args: location: optional tar file internal location string prefixed with a path - separator character. The default is None. + separator character. parent: optional parent path specification (instance of PathSpec). - The default is None. kwargs: a dictionary of keyword arguments dependending on the path specification. diff --git a/dfvfs/path/tsk_partition_path_spec.py b/dfvfs/path/tsk_partition_path_spec.py index 5628fc6d..03e14fda 100644 --- a/dfvfs/path/tsk_partition_path_spec.py +++ b/dfvfs/path/tsk_partition_path_spec.py @@ -19,11 +19,10 @@ def __init__( Note that the TSK partition path specification must have a parent. Args: - location: optional location string. The default is None. - part_index: optional part index. The default is None. - start_offset: optional start offset. The default is None. + location: optional location string. + part_index: optional part index. + start_offset: optional start offset. parent: optional parent path specification (instance of PathSpec). - The default is None. kwargs: a dictionary of keyword arguments dependending on the path specification diff --git a/dfvfs/path/tsk_path_spec.py b/dfvfs/path/tsk_path_spec.py index 60574008..75051efb 100644 --- a/dfvfs/path/tsk_path_spec.py +++ b/dfvfs/path/tsk_path_spec.py @@ -20,10 +20,9 @@ def __init__( Args: data_stream: optional data stream name. The default is None, which indicates the default data stream. - inode: optional inode. The default is None. - location: optional location string. The default is None. + inode: optional inode. + location: optional location string. parent: optional parent path specification (instance of PathSpec), - The default is None. kwargs: a dictionary of keyword arguments dependending on the path specification diff --git a/dfvfs/path/vhdi_path_spec.py b/dfvfs/path/vhdi_path_spec.py index 2664a874..13c18c0e 100644 --- a/dfvfs/path/vhdi_path_spec.py +++ b/dfvfs/path/vhdi_path_spec.py @@ -18,7 +18,6 @@ def __init__(self, parent=None, **kwargs): Args: parent: optional parent path specification (instance of PathSpec). - The default is None. kwargs: a dictionary of keyword arguments dependending on the path specification diff --git a/dfvfs/path/vmdk_path_spec.py b/dfvfs/path/vmdk_path_spec.py index 453f5807..df7ab961 100644 --- a/dfvfs/path/vmdk_path_spec.py +++ b/dfvfs/path/vmdk_path_spec.py @@ -18,7 +18,6 @@ def __init__(self, parent=None, **kwargs): Args: parent: optional parent path specification (instance of PathSpec). - The default is None. kwargs: a dictionary of keyword arguments dependending on the path specification diff --git a/dfvfs/path/vshadow_path_spec.py b/dfvfs/path/vshadow_path_spec.py index 574465f3..eb5c6484 100644 --- a/dfvfs/path/vshadow_path_spec.py +++ b/dfvfs/path/vshadow_path_spec.py @@ -17,10 +17,9 @@ def __init__(self, location=None, store_index=None, parent=None, **kwargs): Note that the VSS path specification must have a parent. Args: - location: optional location string. The default is None. - store_index: optional store index. The default is None. + location: optional location string. + store_index: optional store index. parent: optional parent path specification (instance of PathSpec). - The default is None. Raises: ValueError: when parent is not set. diff --git a/dfvfs/path/zip_path_spec.py b/dfvfs/path/zip_path_spec.py index 33bfe6ce..ff88cf44 100644 --- a/dfvfs/path/zip_path_spec.py +++ b/dfvfs/path/zip_path_spec.py @@ -18,9 +18,8 @@ def __init__(self, location=None, parent=None, **kwargs): Args: location: optional zip file internal location string prefixed with a path - separator character. The default is None. + separator character. parent: optional parent path specification (instance of PathSpec). - The default None. kwargs: a dictionary of keyword arguments dependending on the path specification diff --git a/dfvfs/vfs/fake_file_entry.py b/dfvfs/vfs/fake_file_entry.py index e0d6d95d..f5b7a0ca 100644 --- a/dfvfs/vfs/fake_file_entry.py +++ b/dfvfs/vfs/fake_file_entry.py @@ -55,7 +55,6 @@ def __init__(self, resolver_context, file_system, path_spec, is_root=False): path_spec: the path specification object (instance of path.PathSpec). is_root: optional boolean value to indicate if the file entry is the root file entry of the corresponding file system. - The default is False. """ super(FakeFileEntry, self).__init__( resolver_context, file_system, path_spec, is_root=is_root, diff --git a/dfvfs/vfs/fake_file_system.py b/dfvfs/vfs/fake_file_system.py index ce8e7ac4..e8f82cd6 100644 --- a/dfvfs/vfs/fake_file_system.py +++ b/dfvfs/vfs/fake_file_system.py @@ -59,11 +59,8 @@ def AddFileEntry( Args: path: the path of the file entry. file_entry_type: optional type of the file entry object. - The default is file (definitions.FILE_ENTRY_TYPE_FILE). file_data: optional data of the fake file-like object. - The default is None. link_data: optional link data of the fake file entry object. - The default is None. Raises: KeyError: if the path already exists. diff --git a/dfvfs/vfs/file_entry.py b/dfvfs/vfs/file_entry.py index 5a26d8ed..08505790 100644 --- a/dfvfs/vfs/file_entry.py +++ b/dfvfs/vfs/file_entry.py @@ -82,10 +82,9 @@ def __init__( path_spec: the path specification object (instance of PathSpec). is_root: optional boolean value to indicate if the file entry is the root file entry of the corresponding file system. - The default is False. is_virtual: optional boolean value to indicate if the file entry is a virtual file entry emulated by the corresponding file - system. The default is False. + system. """ super(FileEntry, self).__init__() self._attributes = None @@ -212,7 +211,7 @@ def GetDataStream(self, name, case_sensitive=True): Args: name: the name of the data stream. case_sentitive: optional boolean value to indicate if the name is - case sensitive. The default is True. + case sensitive. Returns: A data stream (an instance of DataStream) or None. @@ -242,7 +241,7 @@ def HasDataStream(self, name, case_sensitive=True): Args: name: the name of the data stream. case_sentitive: optional boolean value to indicate if the name is - case sensitive. The default is True. + case sensitive. Returns: A boolean to indicate the file entry has the data stream. @@ -299,7 +298,7 @@ def GetSubFileEntryByName(self, name, case_sensitive=True): Args: name: the name of the file entry. case_sentitive: optional boolean value to indicate if the name is - case sensitive. The default is True. + case sensitive. Returns: A file entry (an instance of FileEntry) or None. diff --git a/dfvfs/vfs/ntfs_file_entry.py b/dfvfs/vfs/ntfs_file_entry.py index 982d87fd..e37c4031 100644 --- a/dfvfs/vfs/ntfs_file_entry.py +++ b/dfvfs/vfs/ntfs_file_entry.py @@ -232,12 +232,11 @@ def __init__( path_spec: the path specification (instance of path.PathSpec). is_root: optional boolean value to indicate if the file entry is the root file entry of the corresponding file system. - The default is False. is_virtual: optional boolean value to indicate if the file entry is a virtual file entry emulated by the corresponding file - system. The default is False. + system. fsntfs_file_entry: optional file entry object (instance of - pyfsntfs.file_entry). The default is None. + pyfsntfs.file_entry). """ super(NTFSFileEntry, self).__init__( resolver_context, file_system, path_spec, is_root=is_root, diff --git a/dfvfs/vfs/os_file_entry.py b/dfvfs/vfs/os_file_entry.py index 5fa84230..77aaacd7 100644 --- a/dfvfs/vfs/os_file_entry.py +++ b/dfvfs/vfs/os_file_entry.py @@ -69,7 +69,6 @@ def __init__(self, resolver_context, file_system, path_spec, is_root=False): path_spec: the path specification object (instance of path.PathSpec). is_root: optional boolean value to indicate if the file entry is the root file entry of the corresponding file system. - The default is False. """ super(OSFileEntry, self).__init__( resolver_context, file_system, path_spec, is_root=is_root, diff --git a/dfvfs/vfs/tar_file_entry.py b/dfvfs/vfs/tar_file_entry.py index c55fa2bb..6b495fe5 100644 --- a/dfvfs/vfs/tar_file_entry.py +++ b/dfvfs/vfs/tar_file_entry.py @@ -63,12 +63,10 @@ def __init__( path_spec: the path specification (instance of path.PathSpec). is_root: optional boolean value to indicate if the file entry is the root file entry of the corresponding file system. - The default is False. is_virtual: optional boolean value to indicate if the file entry is a virtual file entry emulated by the corresponding file - system. The default is False. + system. tar_info: optional tar info object (instance of tarfile.TarInfo). - The default is None. """ super(TarFileEntry, self).__init__( resolver_context, file_system, path_spec, is_root=is_root, diff --git a/dfvfs/vfs/tar_file_system.py b/dfvfs/vfs/tar_file_system.py index e4334cf1..00e2979f 100644 --- a/dfvfs/vfs/tar_file_system.py +++ b/dfvfs/vfs/tar_file_system.py @@ -24,7 +24,7 @@ def __init__(self, resolver_context, encoding=u'utf-8'): Args: resolver_context: the resolver context (instance of resolver.Context). - encoding: optional file entry name encoding. The default is 'utf-8'. + encoding: optional file entry name encoding. """ super(TarFileSystem, self).__init__(resolver_context) self._file_object = None diff --git a/dfvfs/vfs/tsk_file_entry.py b/dfvfs/vfs/tsk_file_entry.py index 1262b38f..ec1d654c 100644 --- a/dfvfs/vfs/tsk_file_entry.py +++ b/dfvfs/vfs/tsk_file_entry.py @@ -166,13 +166,11 @@ def __init__( path_spec: the path specification (instance of path.PathSpec). is_root: optional boolean value to indicate if the file entry is the root file entry of the corresponding file system. - The default is False. is_virtual: optional boolean value to indicate if the file entry is a virtual file entry emulated by the corresponding file - system. The default is False. + system. tsk_file: optional file object (instance of pytsk3.File). - The default is None. - parent_inode: optional parent inode number. The default is None. + parent_inode: optional parent inode number. """ super(TSKFileEntry, self).__init__( resolver_context, file_system, path_spec, is_root=is_root, diff --git a/dfvfs/vfs/tsk_partition_file_entry.py b/dfvfs/vfs/tsk_partition_file_entry.py index d247ac4f..57a17ebf 100644 --- a/dfvfs/vfs/tsk_partition_file_entry.py +++ b/dfvfs/vfs/tsk_partition_file_entry.py @@ -76,9 +76,8 @@ def __init__( path_spec: the path specification (instance of path.PathSpec). is_virtual: optional boolean value to indicate if the file entry is a virtual file entry emulated by the corresponding file - system. The default is False. + system. tar_info: optional tar info object (instance of tarfile.TarInfo). - The default is None. """ super(TSKPartitionFileEntry, self).__init__( resolver_context, file_system, path_spec, is_root=is_root, diff --git a/dfvfs/vfs/vshadow_file_entry.py b/dfvfs/vfs/vshadow_file_entry.py index 646a115f..b37e9bf4 100644 --- a/dfvfs/vfs/vshadow_file_entry.py +++ b/dfvfs/vfs/vshadow_file_entry.py @@ -55,10 +55,9 @@ def __init__( path_spec: the path specification (instance of path.PathSpec). is_root: optional boolean value to indicate if the file entry is the root file entry of the corresponding file system. - The default is False. is_virtual: optional boolean value to indicate if the file entry is a virtual file entry emulated by the corresponding file - system. The default is False. + system. """ super(VShadowFileEntry, self).__init__( resolver_context, file_system, path_spec, is_root=is_root, diff --git a/dfvfs/vfs/zip_file_entry.py b/dfvfs/vfs/zip_file_entry.py index b641fb9e..1ab02e87 100644 --- a/dfvfs/vfs/zip_file_entry.py +++ b/dfvfs/vfs/zip_file_entry.py @@ -70,12 +70,10 @@ def __init__( path_spec: the path specification (instance of path.PathSpec). is_root: optional boolean value to indicate if the file entry is the root file entry of the corresponding file system. - The default is False. is_virtual: optional boolean value to indicate if the file entry is a virtual file entry emulated by the corresponding file - system. The default is False. + system. zip_info: optional zip info object (instance of zipfile.ZipInfo). - The default is None. """ super(ZipFileEntry, self).__init__( resolver_context, file_system, path_spec, is_root=is_root,