Skip to content

filesystem

Functionality for managing the EnderChest and shulker box config files and folders

ender_chest_config(minecraft_root, check_exists=True)

Given a minecraft root directory, return the path to the EnderChest config file

Parameters:

Name Type Description Default
minecraft_root Path

The root directory that your minecraft stuff (or, at least, the one that's the parent of your EnderChest folder)

 required
check_exists bool

By default, this method will raise an error if the enderchest config file does not already exist. To disable that check, call this method with check_exists=False.

 True

Returns:

Type Description
Path

The path to the EnderChest config file

Raises:

Type Description
FileNotFoundError

If the EnderChest config file isn't where it's supposed to be (and checking hasn't been disabled)
Notes

This method does not check if the config file is valid

Source code in enderchest/filesystem.py 
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
def ender_chest_config(minecraft_root, check_exists: bool = True) -> Path:
    """Given a minecraft root directory, return the path to the EnderChest
    config file

    Parameters
    ----------
    minecraft_root : Path
        The root directory that your minecraft stuff (or, at least, the one
        that's the parent of your EnderChest folder)
    check_exists : bool, optional
        By default, this method will raise an error if the enderchest config
        file does not already exist. To disable that check, call this method
        with `check_exists=False`.

    Returns
    -------
    Path
        The path to the EnderChest config file

    Raises
    ------
    FileNotFoundError
        If the EnderChest config file isn't where it's supposed to be (and
        checking hasn't been disabled)

    Notes
    -----
    This method does not check if the config file is valid
    """
    config_path = minecraft_root / ENDER_CHEST_FOLDER_NAME / ENDER_CHEST_CONFIG_NAME

    if check_exists and not config_path.exists():
        raise FileNotFoundError(
            f"No valid EnderChest installation exists within {minecraft_root}"
        )
    return config_path

ender_chest_folder(minecraft_root, check_exists=True)

Given a minecraft root directory, return the path to the EnderChest folder

Parameters:

Name Type Description Default
minecraft_root Path

The root directory that your minecraft stuff (or, at least, the one that's the parent of your EnderChest folder)

 required
check_exists bool

By default, this method will raise an error if no EnderChest exists at that location (meaning no folder or no enderchest config file in that folder). To disable that check, call this method with check_exists=False.

 True

Returns:

Type Description
Path

The path to the EnderChest folder

Raises:

Type Description
FileNotFoundError

If no valid EnderChest installation exists within the given minecraft root (and checking hasn't been disabled)
Source code in enderchest/filesystem.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
def ender_chest_folder(minecraft_root: Path, check_exists: bool = True) -> Path:
    """Given a minecraft root directory, return the path to the EnderChest
    folder

    Parameters
    ----------
    minecraft_root : Path
        The root directory that your minecraft stuff (or, at least, the one
        that's the parent of your EnderChest folder)
    check_exists : bool, optional
        By default, this method will raise an error if no EnderChest exists
        at that location (meaning no folder or no enderchest config file in
        that folder). To disable that check, call this method with
        `check_exists=False`.

    Returns
    -------
    Path
        The path to the EnderChest folder

    Raises
    ------
    FileNotFoundError
        If no valid EnderChest installation exists within the given
        minecraft root (and checking hasn't been disabled)
    """
    return ender_chest_config(minecraft_root, check_exists=check_exists).parent

Determine whether a symlink's target is inside the EnderChest specified by the Minecraft root.

Parameters:

Name Type Description Default
minecraft_root Path

The root directory that your minecraft stuff (or, at least, the one that's the parent of your EnderChest folder)

 required
link Path

The link to check

 required
check_exists bool

By default, this method will raise an error if no EnderChest exists at that location (meaning no folder or no enderchest config file in that folder). To disable that check, call this method with check_exists=False.

 True

Returns:

Type Description
bool

True if the path is inside of the EnderChest folder. False otherwise.
Notes

This method only checks the direct target of the link as opposed to the fully resolved path.

Raises:

Type Description
FileNotFoundError

If no valid EnderChest installation exists within the given minecraft root (and checking hasn't been disabled)
OSError

If the link provided isn't actually a symbolic link
Source code in enderchest/filesystem.py 
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
def links_into_enderchest(
    minecraft_root: Path, link: Path, check_exists: bool = True
) -> bool:
    """Determine whether a symlink's target is inside the EnderChest specified
    by the Minecraft root.

    Parameters
    ----------
    minecraft_root : Path
        The root directory that your minecraft stuff (or, at least, the one
        that's the parent of your EnderChest folder)
    link : Path
        The link to check
    check_exists : bool, optional
        By default, this method will raise an error if no EnderChest exists
        at that location (meaning no folder or no enderchest config file in
        that folder). To disable that check, call this method with
        `check_exists=False`.

    Returns
    -------
    bool
        True if the path is inside of the EnderChest folder. False otherwise.

    Notes
    -----
    This method only checks the *direct target* of the link as opposed to the
    fully resolved path.

    Raises
    ------
    FileNotFoundError
        If no valid EnderChest installation exists within the given
        minecraft root (and checking hasn't been disabled)
    OSError
        If the link provided isn't actually a symbolic link
    """
    chest_folder = os.path.normpath(
        ender_chest_folder(minecraft_root, check_exists=check_exists)
        .expanduser()
        .absolute()
    )

    target = os.readlink(link)
    if not os.path.isabs(target):
        target = os.path.normpath(link.parent / target)

    # Windows shenanigans: https://bugs.python.org/issue42957
    if target.startswith(("\\\\?\\", "\\??\\")):  # pragma: no cover
        try:
            os.stat(target[4:])
            target = target[4:]
        except (OSError, FileNotFoundError):
            # then maybe this is somehow legit
            pass

    # there's probably a better way to check if a file is inside a sub-path
    try:
        common_root = os.path.commonpath([target, chest_folder])
    except ValueError:  # if they have no common root
        common_root = ""
    return common_root == chest_folder

minecraft_folders(search_path)

Find all .minecraft folders within a given search path

Parameters:

Name Type Description Default
search_path Path

The directory to search

 required

Returns:

Type Description
list-like of paths

The paths to all the .minecraft folders this method could find
Notes

This method does not check to make sure that those .minecraft folders contain valid minecraft instances, just that they exist

Source code in enderchest/filesystem.py 
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
def minecraft_folders(search_path: Path) -> Iterable[Path]:
    """Find all .minecraft folders within a given search path

    Parameters
    ----------
    search_path : Path
        The directory to search

    Returns
    -------
    list-like of paths
        The paths to all the .minecraft folders this method could find

    Notes
    -----
    This method does not check to make sure that those .minecraft folders
    contain valid minecraft instances, just that they exist
    """
    return search_path.rglob(".minecraft")

place_cache(minecraft_root)

Given a minecraft root directory, return the path to the EnderChest place cache file

Parameters:

Name Type Description Default
minecraft_root Path

The root directory that your minecraft stuff (or, at least, the one that's the parent of your EnderChest folder)

 required

Returns:

Type Description
Path

The path to the place cache file
Notes

This method does not check if the cache file is valid or if it even exists

Source code in enderchest/filesystem.py 
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
def place_cache(minecraft_root: Path) -> Path:
    """Given a minecraft root directory, return the path to the EnderChest
    place cache file

    Parameters
    ----------
    minecraft_root : Path
        The root directory that your minecraft stuff (or, at least, the one
        that's the parent of your EnderChest folder)

    Returns
    -------
    Path
        The path to the place cache file

    Notes
    -----
    This method does not check if the cache file is valid or if it even exists
    """
    return ender_chest_folder(minecraft_root) / PLACE_CACHE_NAME

shulker_box_config(minecraft_root, shulker_box_name)

Generate the path to a shulker box config file, given its name and the minecraft root directory

Parameters:

Name Type Description Default
minecraft_root Path

The root directory that your minecraft stuff (or, at least, the one that's the parent of your EnderChest folder)

 required
shulker_box_name str

The name of the shulker box to resolve

 required

Returns:

Type Description
Path

The path to the shulker box folder
Notes

This method does not check if a shulker box config exists at that location

Source code in enderchest/filesystem.py 
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
def shulker_box_config(minecraft_root: Path, shulker_box_name: str) -> Path:
    """Generate the path to a shulker box config file, given its name and
    the minecraft root directory

    Parameters
    ----------
    minecraft_root : Path
        The root directory that your minecraft stuff (or, at least, the one
        that's the parent of your EnderChest folder)
    shulker_box_name : str
        The name of the shulker box to resolve

    Returns
    -------
    Path
        The path to the shulker box folder

    Notes
    -----
    This method does not check if a shulker box config exists at that location
    """
    return shulker_box_root(minecraft_root, shulker_box_name) / SHULKER_BOX_CONFIG_NAME

shulker_box_configs(minecraft_root)

Find all shulker box configs on the system

Parameters:

Name Type Description Default
minecraft_root Path

The root directory that your minecraft stuff (or, at least, the one that's the parent of your EnderChest folder)

 required

Returns:

Type Description
list-like of paths

The paths to all the shulker box configs on the system
Notes

This method does not check to make sure those config files are valid, just that they exist

Source code in enderchest/filesystem.py 
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
def shulker_box_configs(minecraft_root: Path) -> Iterable[Path]:
    """Find all shulker box configs on the system

    Parameters
    ----------
    minecraft_root : Path
        The root directory that your minecraft stuff (or, at least, the one
        that's the parent of your EnderChest folder)

    Returns
    -------
    list-like of paths
        The paths to all the shulker box configs on the system

    Notes
    -----
    This method does not check to make sure those config files are valid,
    just that they exist
    """
    INVENTORY_LOGGER.debug(f"Searching for shulker configs within {minecraft_root}")
    return ender_chest_folder(minecraft_root).glob(f"*/{SHULKER_BOX_CONFIG_NAME}")

shulker_box_root(minecraft_root, shulker_box_name)

Generate the path to the root of a shulker box, given its name and the minecraft root directory

Parameters:

Name Type Description Default
minecraft_root Path

The root directory that your minecraft stuff (or, at least, the one that's the parent of your EnderChest folder)

 required
shulker_box_name str

The name of the shulker box to resolve

 required

Returns:

Type Description
Path

The path to the shulker box folder
Notes

This method does not check if a shulker box exists at that location

Source code in enderchest/filesystem.py 
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
def shulker_box_root(minecraft_root: Path, shulker_box_name: str) -> Path:
    """Generate the path to the root of a shulker box, given its name and the
    minecraft root directory

    Parameters
    ----------
    minecraft_root : Path
        The root directory that your minecraft stuff (or, at least, the one
        that's the parent of your EnderChest folder)
    shulker_box_name : str
        The name of the shulker box to resolve

    Returns
    -------
    Path
        The path to the shulker box folder

    Notes
    -----
    This method does not check if a shulker box exists at that location
    """
    return ender_chest_folder(minecraft_root) / shulker_box_name