Skip to content

file_system

BucketFileSystemLocator dataclass

Source code in zendriver/cdp/file_system.py 
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
@dataclass
class BucketFileSystemLocator:
    #: Storage key
    storage_key: storage.SerializedStorageKey

    #: Path to the directory using each path component as an array item.
    path_components: typing.List[str]

    #: Bucket name. Not passing a ``bucketName`` will retrieve the default Bucket. (https://developer.mozilla.org/en-US/docs/Web/API/Storage_API#storage_buckets)
    bucket_name: typing.Optional[str] = None

    def to_json(self) -> T_JSON_DICT:
        json: T_JSON_DICT = dict()
        json["storageKey"] = self.storage_key.to_json()
        json["pathComponents"] = [i for i in self.path_components]
        if self.bucket_name is not None:
            json["bucketName"] = self.bucket_name
        return json

    @classmethod
    def from_json(cls, json: T_JSON_DICT) -> BucketFileSystemLocator:
        return cls(
            storage_key=storage.SerializedStorageKey.from_json(json["storageKey"]),
            path_components=[str(i) for i in json["pathComponents"]],
            bucket_name=str(json["bucketName"])
            if json.get("bucketName", None) is not None
            else None,
        )

bucket_name: typing.Optional[str] = None class-attribute instance-attribute

path_components: typing.List[str] instance-attribute

storage_key: storage.SerializedStorageKey instance-attribute

__init__(storage_key, path_components, bucket_name=None)

from_json(json) classmethod

Source code in zendriver/cdp/file_system.py 
 92
 93
 94
 95
 96
 97
 98
 99
100
@classmethod
def from_json(cls, json: T_JSON_DICT) -> BucketFileSystemLocator:
    return cls(
        storage_key=storage.SerializedStorageKey.from_json(json["storageKey"]),
        path_components=[str(i) for i in json["pathComponents"]],
        bucket_name=str(json["bucketName"])
        if json.get("bucketName", None) is not None
        else None,
    )

to_json()

Source code in zendriver/cdp/file_system.py 
84
85
86
87
88
89
90
def to_json(self) -> T_JSON_DICT:
    json: T_JSON_DICT = dict()
    json["storageKey"] = self.storage_key.to_json()
    json["pathComponents"] = [i for i in self.path_components]
    if self.bucket_name is not None:
        json["bucketName"] = self.bucket_name
    return json

Directory dataclass

Source code in zendriver/cdp/file_system.py 
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
@dataclass
class Directory:
    name: str

    nested_directories: typing.List[str]

    #: Files that are directly nested under this directory.
    nested_files: typing.List[File]

    def to_json(self) -> T_JSON_DICT:
        json: T_JSON_DICT = dict()
        json["name"] = self.name
        json["nestedDirectories"] = [i for i in self.nested_directories]
        json["nestedFiles"] = [i.to_json() for i in self.nested_files]
        return json

    @classmethod
    def from_json(cls, json: T_JSON_DICT) -> Directory:
        return cls(
            name=str(json["name"]),
            nested_directories=[str(i) for i in json["nestedDirectories"]],
            nested_files=[File.from_json(i) for i in json["nestedFiles"]],
        )

name: str instance-attribute

nested_directories: typing.List[str] instance-attribute

nested_files: typing.List[File] instance-attribute

__init__(name, nested_directories, nested_files)

from_json(json) classmethod

Source code in zendriver/cdp/file_system.py 
64
65
66
67
68
69
70
@classmethod
def from_json(cls, json: T_JSON_DICT) -> Directory:
    return cls(
        name=str(json["name"]),
        nested_directories=[str(i) for i in json["nestedDirectories"]],
        nested_files=[File.from_json(i) for i in json["nestedFiles"]],
    )

to_json()

Source code in zendriver/cdp/file_system.py 
57
58
59
60
61
62
def to_json(self) -> T_JSON_DICT:
    json: T_JSON_DICT = dict()
    json["name"] = self.name
    json["nestedDirectories"] = [i for i in self.nested_directories]
    json["nestedFiles"] = [i.to_json() for i in self.nested_files]
    return json

File dataclass

Source code in zendriver/cdp/file_system.py 
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
@dataclass
class File:
    name: str

    #: Timestamp
    last_modified: network.TimeSinceEpoch

    #: Size in bytes
    size: float

    type_: str

    def to_json(self) -> T_JSON_DICT:
        json: T_JSON_DICT = dict()
        json["name"] = self.name
        json["lastModified"] = self.last_modified.to_json()
        json["size"] = self.size
        json["type"] = self.type_
        return json

    @classmethod
    def from_json(cls, json: T_JSON_DICT) -> File:
        return cls(
            name=str(json["name"]),
            last_modified=network.TimeSinceEpoch.from_json(json["lastModified"]),
            size=float(json["size"]),
            type_=str(json["type"]),
        )

last_modified: network.TimeSinceEpoch instance-attribute

name: str instance-attribute

size: float instance-attribute

type_: str instance-attribute

__init__(name, last_modified, size, type_)

from_json(json) classmethod

Source code in zendriver/cdp/file_system.py 
38
39
40
41
42
43
44
45
@classmethod
def from_json(cls, json: T_JSON_DICT) -> File:
    return cls(
        name=str(json["name"]),
        last_modified=network.TimeSinceEpoch.from_json(json["lastModified"]),
        size=float(json["size"]),
        type_=str(json["type"]),
    )

to_json()

Source code in zendriver/cdp/file_system.py 
30
31
32
33
34
35
36
def to_json(self) -> T_JSON_DICT:
    json: T_JSON_DICT = dict()
    json["name"] = self.name
    json["lastModified"] = self.last_modified.to_json()
    json["size"] = self.size
    json["type"] = self.type_
    return json

get_directory(bucket_file_system_locator)

Parameters:

Name Type Description Default
bucket_file_system_locator BucketFileSystemLocator
required

Returns:

Type Description
Generator[T_JSON_DICT, T_JSON_DICT, Directory]

Returns the directory object at the path.
Source code in zendriver/cdp/file_system.py 
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
def get_directory(
    bucket_file_system_locator: BucketFileSystemLocator,
) -> typing.Generator[T_JSON_DICT, T_JSON_DICT, Directory]:
    """
    :param bucket_file_system_locator:
    :returns: Returns the directory object at the path.
    """
    params: T_JSON_DICT = dict()
    params["bucketFileSystemLocator"] = bucket_file_system_locator.to_json()
    cmd_dict: T_JSON_DICT = {
        "method": "FileSystem.getDirectory",
        "params": params,
    }
    json = yield cmd_dict
    return Directory.from_json(json["directory"])