NTFSAttributes Class

Valid set of attributes to set for file or directory.

To set attribute for directory, 'Directory' should always be enabled except setting 'None' for directory.

Inheritance
builtins.object
NTFSAttributes

Constructor

NTFSAttributes(read_only: bool = False, hidden: bool = False, system: bool = False, none: bool = False, directory: bool = False, archive: bool = False, temporary: bool = False, offline: bool = False, not_content_indexed: bool = False, no_scrub_data: bool = False)

Parameters

Name Description
read_only
Default value: False
hidden
Default value: False
system
Default value: False
none
Default value: False
directory
Default value: False
archive
Default value: False
temporary
Default value: False
offline
Default value: False
not_content_indexed
Default value: False
no_scrub_data
Default value: False

Methods

from_string

Create a NTFSAttributes from a string.

To specify permissions you can pass in a string with the desired permissions, e.g. "ReadOnly|Hidden|System"

from_string

Create a NTFSAttributes from a string.

To specify permissions you can pass in a string with the desired permissions, e.g. "ReadOnly|Hidden|System"

from_string(string: str) -> Self

Parameters

Name Description
string
Required
str

The string which dictates the permissions.

Returns

Type Description

A NTFSAttributes object

Attributes

archive

Enable/disable 'Archive' attribute for DIRECTORY.

archive: bool = False

directory

Enable/disable 'Directory' attribute for DIRECTORY.

directory: bool = False

hidden

Enable/disable 'Hidden' attribute for DIRECTORY or FILE.

hidden: bool = False

no_scrub_data

Enable/disable 'NoScrubData' attribute for DIRECTORY.

no_scrub_data: bool = False

none

Enable/disable 'None' attribute for DIRECTORY or FILE to clear all attributes of FILE/DIRECTORY.

none: bool = False

not_content_indexed

Enable/disable 'NotContentIndexed' attribute for DIRECTORY.

not_content_indexed: bool = False

offline

Enable/disable 'Offline' attribute for DIRECTORY.

offline: bool = False

read_only

Enable/disable 'ReadOnly' attribute for DIRECTORY or FILE.

read_only: bool = False

system

Enable/disable 'System' attribute for DIRECTORY or FILE.

system: bool = False

temporary

Enable/disable 'Temporary' attribute for DIRECTORY.

temporary: bool = False