2010-08-06 01:40:54 +00:00
|
|
|
# ##### BEGIN GPL LICENSE BLOCK #####
|
|
|
|
#
|
|
|
|
# This program is free software; you can redistribute it and/or
|
|
|
|
# modify it under the terms of the GNU General Public License
|
|
|
|
# as published by the Free Software Foundation; either version 2
|
|
|
|
# of the License, or (at your option) any later version.
|
|
|
|
#
|
|
|
|
# This program is distributed in the hope that it will be useful,
|
|
|
|
# but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
|
|
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
|
|
# GNU General Public License for more details.
|
|
|
|
#
|
|
|
|
# You should have received a copy of the GNU General Public License
|
|
|
|
# along with this program; if not, write to the Free Software Foundation,
|
|
|
|
# Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
|
|
|
|
#
|
|
|
|
# ##### END GPL LICENSE BLOCK #####
|
|
|
|
|
2011-07-31 03:15:37 +00:00
|
|
|
# <pep8-80 compliant>
|
2010-08-06 03:11:19 +00:00
|
|
|
|
2010-08-06 01:40:54 +00:00
|
|
|
"""
|
|
|
|
This module has a similar scope to os.path, containing utility
|
|
|
|
functions for dealing with paths in Blender.
|
|
|
|
"""
|
|
|
|
|
2011-07-31 03:15:37 +00:00
|
|
|
__all__ = (
|
|
|
|
"abspath",
|
|
|
|
"basename",
|
|
|
|
"clean_name",
|
|
|
|
"display_name",
|
|
|
|
"display_name_from_filepath",
|
|
|
|
"ensure_ext",
|
2013-01-04 03:47:37 +00:00
|
|
|
"extensions_image",
|
|
|
|
"extensions_movie",
|
|
|
|
"extensions_audio",
|
2011-07-31 03:15:37 +00:00
|
|
|
"is_subdir",
|
|
|
|
"module_names",
|
2013-08-12 07:44:38 +00:00
|
|
|
"reduce_dirs",
|
2011-07-31 03:15:37 +00:00
|
|
|
"relpath",
|
|
|
|
"resolve_ncase",
|
|
|
|
)
|
|
|
|
|
2010-08-06 01:40:54 +00:00
|
|
|
import bpy as _bpy
|
2010-08-06 13:06:13 +00:00
|
|
|
import os as _os
|
2010-08-06 01:40:54 +00:00
|
|
|
|
2015-01-27 06:46:07 +00:00
|
|
|
from _bpy_path import (
|
|
|
|
extensions_audio,
|
|
|
|
extensions_movie,
|
|
|
|
extensions_image,
|
|
|
|
)
|
2010-09-07 15:17:42 +00:00
|
|
|
|
2013-01-15 23:15:32 +00:00
|
|
|
|
2013-04-05 00:30:32 +00:00
|
|
|
def _getattr_bytes(var, attr):
|
|
|
|
return var.path_resolve(attr, False).as_bytes()
|
|
|
|
|
|
|
|
|
2011-10-11 04:09:11 +00:00
|
|
|
def abspath(path, start=None, library=None):
|
2010-08-06 01:40:54 +00:00
|
|
|
"""
|
2011-07-31 03:15:37 +00:00
|
|
|
Returns the absolute path relative to the current blend file
|
|
|
|
using the "//" prefix.
|
2011-01-15 20:35:31 +00:00
|
|
|
|
2011-07-31 03:15:37 +00:00
|
|
|
:arg start: Relative to this path,
|
|
|
|
when not set the current filename is used.
|
2015-08-04 14:21:50 +00:00
|
|
|
:type start: string or bytes
|
2011-10-11 04:09:11 +00:00
|
|
|
:arg library: The library this path is from. This is only included for
|
|
|
|
convenience, when the library is not None its path replaces *start*.
|
|
|
|
:type library: :class:`bpy.types.Library`
|
2010-08-06 01:40:54 +00:00
|
|
|
"""
|
2013-04-05 00:30:32 +00:00
|
|
|
if isinstance(path, bytes):
|
|
|
|
if path.startswith(b"//"):
|
|
|
|
if library:
|
2016-01-31 13:47:10 +00:00
|
|
|
start = _os.path.dirname(
|
|
|
|
abspath(_getattr_bytes(library, "filepath")))
|
|
|
|
return _os.path.join(
|
|
|
|
_os.path.dirname(_getattr_bytes(_bpy.data, "filepath"))
|
|
|
|
if start is None else start,
|
|
|
|
path[2:],
|
|
|
|
)
|
2013-04-05 00:30:32 +00:00
|
|
|
else:
|
|
|
|
if path.startswith("//"):
|
|
|
|
if library:
|
2016-01-31 13:47:10 +00:00
|
|
|
start = _os.path.dirname(
|
|
|
|
abspath(library.filepath))
|
|
|
|
return _os.path.join(
|
|
|
|
_os.path.dirname(_bpy.data.filepath)
|
|
|
|
if start is None else start,
|
|
|
|
path[2:],
|
|
|
|
)
|
2010-08-06 01:40:54 +00:00
|
|
|
|
|
|
|
return path
|
|
|
|
|
|
|
|
|
|
|
|
def relpath(path, start=None):
|
|
|
|
"""
|
|
|
|
Returns the path relative to the current blend file using the "//" prefix.
|
|
|
|
|
2015-08-04 14:21:50 +00:00
|
|
|
:arg path: An absolute path.
|
|
|
|
:type path: string or bytes
|
2011-07-31 03:15:37 +00:00
|
|
|
:arg start: Relative to this path,
|
|
|
|
when not set the current filename is used.
|
2015-08-04 14:21:50 +00:00
|
|
|
:type start: string or bytes
|
2010-08-06 01:40:54 +00:00
|
|
|
"""
|
2013-04-05 00:30:32 +00:00
|
|
|
if isinstance(path, bytes):
|
|
|
|
if not path.startswith(b"//"):
|
|
|
|
if start is None:
|
|
|
|
start = _os.path.dirname(_getattr_bytes(_bpy.data, "filepath"))
|
|
|
|
return b"//" + _os.path.relpath(path, start)
|
|
|
|
else:
|
|
|
|
if not path.startswith("//"):
|
|
|
|
if start is None:
|
|
|
|
start = _os.path.dirname(_bpy.data.filepath)
|
|
|
|
return "//" + _os.path.relpath(path, start)
|
2010-08-06 01:40:54 +00:00
|
|
|
|
|
|
|
return path
|
|
|
|
|
|
|
|
|
2010-10-01 05:19:40 +00:00
|
|
|
def is_subdir(path, directory):
|
|
|
|
"""
|
|
|
|
Returns true if *path* in a subdirectory of *directory*.
|
|
|
|
Both paths must be absolute.
|
2015-08-04 14:21:50 +00:00
|
|
|
|
|
|
|
:arg path: An absolute path.
|
|
|
|
:type path: string or bytes
|
2010-10-01 05:19:40 +00:00
|
|
|
"""
|
2016-01-12 15:58:53 +00:00
|
|
|
from os.path import normpath, normcase, sep
|
2010-10-01 05:19:40 +00:00
|
|
|
path = normpath(normcase(path))
|
|
|
|
directory = normpath(normcase(directory))
|
2015-03-26 05:29:14 +00:00
|
|
|
if len(path) > len(directory):
|
2016-01-12 15:58:53 +00:00
|
|
|
sep = sep.encode('ascii') if isinstance(directory, bytes) else sep
|
|
|
|
if path.startswith(directory.rstrip(sep) + sep):
|
|
|
|
return True
|
2015-03-26 05:29:14 +00:00
|
|
|
return False
|
2010-10-01 05:19:40 +00:00
|
|
|
|
|
|
|
|
2010-08-06 01:40:54 +00:00
|
|
|
def clean_name(name, replace="_"):
|
|
|
|
"""
|
2011-07-31 03:15:37 +00:00
|
|
|
Returns a name with characters replaced that
|
2013-09-18 05:20:43 +00:00
|
|
|
may cause problems under various circumstances,
|
2011-07-31 03:15:37 +00:00
|
|
|
such as writing to a file.
|
2010-08-06 01:40:54 +00:00
|
|
|
All characters besides A-Z/a-z, 0-9 are replaced with "_"
|
2015-08-04 14:21:50 +00:00
|
|
|
or the *replace* argument if defined.
|
2010-08-06 01:40:54 +00:00
|
|
|
"""
|
|
|
|
|
2015-06-13 09:45:53 +00:00
|
|
|
if replace != "_":
|
|
|
|
if len(replace) != 1 or ord(replace) > 255:
|
|
|
|
raise ValueError("Value must be a single ascii character")
|
|
|
|
|
|
|
|
def maketrans_init():
|
|
|
|
trans_cache = clean_name._trans_cache
|
|
|
|
trans = trans_cache.get(replace)
|
|
|
|
if trans is None:
|
|
|
|
bad_chars = (
|
|
|
|
0x00, 0x01, 0x02, 0x03, 0x04, 0x05, 0x06, 0x07,
|
|
|
|
0x08, 0x09, 0x0a, 0x0b, 0x0c, 0x0d, 0x0e, 0x0f,
|
|
|
|
0x10, 0x11, 0x12, 0x13, 0x14, 0x15, 0x16, 0x17,
|
|
|
|
0x18, 0x19, 0x1a, 0x1b, 0x1c, 0x1d, 0x1e, 0x1f,
|
|
|
|
0x20, 0x21, 0x22, 0x23, 0x24, 0x25, 0x26, 0x27,
|
|
|
|
0x28, 0x29, 0x2a, 0x2b, 0x2c, 0x2e, 0x2f, 0x3a,
|
|
|
|
0x3b, 0x3c, 0x3d, 0x3e, 0x3f, 0x40, 0x5b, 0x5c,
|
|
|
|
0x5d, 0x5e, 0x60, 0x7b, 0x7c, 0x7d, 0x7e, 0x7f,
|
|
|
|
0x80, 0x81, 0x82, 0x83, 0x84, 0x85, 0x86, 0x87,
|
|
|
|
0x88, 0x89, 0x8a, 0x8b, 0x8c, 0x8d, 0x8e, 0x8f,
|
|
|
|
0x90, 0x91, 0x92, 0x93, 0x94, 0x95, 0x96, 0x97,
|
|
|
|
0x98, 0x99, 0x9a, 0x9b, 0x9c, 0x9d, 0x9e, 0x9f,
|
|
|
|
0xa0, 0xa1, 0xa2, 0xa3, 0xa4, 0xa5, 0xa6, 0xa7,
|
|
|
|
0xa8, 0xa9, 0xaa, 0xab, 0xac, 0xad, 0xae, 0xaf,
|
|
|
|
0xb0, 0xb1, 0xb2, 0xb3, 0xb4, 0xb5, 0xb6, 0xb7,
|
|
|
|
0xb8, 0xb9, 0xba, 0xbb, 0xbc, 0xbd, 0xbe, 0xbf,
|
|
|
|
0xc0, 0xc1, 0xc2, 0xc3, 0xc4, 0xc5, 0xc6, 0xc7,
|
|
|
|
0xc8, 0xc9, 0xca, 0xcb, 0xcc, 0xcd, 0xce, 0xcf,
|
|
|
|
0xd0, 0xd1, 0xd2, 0xd3, 0xd4, 0xd5, 0xd6, 0xd7,
|
|
|
|
0xd8, 0xd9, 0xda, 0xdb, 0xdc, 0xdd, 0xde, 0xdf,
|
|
|
|
0xe0, 0xe1, 0xe2, 0xe3, 0xe4, 0xe5, 0xe6, 0xe7,
|
|
|
|
0xe8, 0xe9, 0xea, 0xeb, 0xec, 0xed, 0xee, 0xef,
|
|
|
|
0xf0, 0xf1, 0xf2, 0xf3, 0xf4, 0xf5, 0xf6, 0xf7,
|
|
|
|
0xf8, 0xf9, 0xfa, 0xfb, 0xfc, 0xfd, 0xfe,
|
|
|
|
)
|
|
|
|
trans = str.maketrans({char: replace for char in bad_chars})
|
|
|
|
trans_cache[replace] = trans
|
|
|
|
return trans
|
|
|
|
|
|
|
|
trans = maketrans_init()
|
|
|
|
return name.translate(trans)
|
|
|
|
clean_name._trans_cache = {}
|
2010-08-06 01:40:54 +00:00
|
|
|
|
|
|
|
|
2012-03-21 22:29:49 +00:00
|
|
|
def _clean_utf8(name):
|
|
|
|
name = _os.path.splitext(basename(name))[0]
|
|
|
|
if type(name) == bytes:
|
|
|
|
return name.decode("utf8", "replace")
|
|
|
|
else:
|
|
|
|
return name.encode("utf8", "replace").decode("utf8")
|
|
|
|
|
|
|
|
|
2010-08-06 01:40:54 +00:00
|
|
|
def display_name(name):
|
|
|
|
"""
|
|
|
|
Creates a display string from name to be used menus and the user interface.
|
2011-07-31 03:15:37 +00:00
|
|
|
Capitalize the first letter in all lowercase names,
|
|
|
|
mixed case names are kept as is. Intended for use with
|
|
|
|
filenames and module names.
|
2010-08-06 01:40:54 +00:00
|
|
|
"""
|
|
|
|
# string replacements
|
2012-03-21 22:29:49 +00:00
|
|
|
name = name.replace("_colon_", ":")
|
2013-10-05 14:19:39 +00:00
|
|
|
name = name.replace("_plus_", "+")
|
2010-08-06 01:40:54 +00:00
|
|
|
|
2012-03-21 22:29:49 +00:00
|
|
|
name = name.replace("_", " ")
|
2010-08-06 01:40:54 +00:00
|
|
|
|
2012-03-21 22:29:49 +00:00
|
|
|
if name.islower():
|
|
|
|
name = name.lower().title()
|
|
|
|
|
|
|
|
name = _clean_utf8(name)
|
|
|
|
return name
|
2010-08-06 01:40:54 +00:00
|
|
|
|
|
|
|
|
2011-01-03 08:28:22 +00:00
|
|
|
def display_name_from_filepath(name):
|
|
|
|
"""
|
2011-08-02 17:00:44 +00:00
|
|
|
Returns the path stripped of directory and extension,
|
2011-07-31 03:15:37 +00:00
|
|
|
ensured to be utf8 compatible.
|
2011-01-03 08:28:22 +00:00
|
|
|
"""
|
2012-03-21 22:29:49 +00:00
|
|
|
|
|
|
|
name = _clean_utf8(name)
|
|
|
|
return name
|
2011-01-03 08:28:22 +00:00
|
|
|
|
|
|
|
|
2010-08-06 01:40:54 +00:00
|
|
|
def resolve_ncase(path):
|
2010-09-07 15:17:42 +00:00
|
|
|
"""
|
|
|
|
Resolve a case insensitive path on a case sensitive system,
|
|
|
|
returning a string with the path if found else return the original path.
|
|
|
|
"""
|
2010-08-06 01:40:54 +00:00
|
|
|
|
2010-09-07 15:17:42 +00:00
|
|
|
def _ncase_path_found(path):
|
2011-11-16 16:38:37 +00:00
|
|
|
if not path or _os.path.exists(path):
|
2010-09-07 15:17:42 +00:00
|
|
|
return path, True
|
2010-08-06 01:40:54 +00:00
|
|
|
|
2011-07-31 03:15:37 +00:00
|
|
|
# filename may be a directory or a file
|
2011-11-16 16:38:37 +00:00
|
|
|
filename = _os.path.basename(path)
|
|
|
|
dirpath = _os.path.dirname(path)
|
2010-08-06 01:40:54 +00:00
|
|
|
|
2011-05-19 06:27:39 +00:00
|
|
|
suffix = path[:0] # "" but ensure byte/str match
|
2010-09-07 15:17:42 +00:00
|
|
|
if not filename: # dir ends with a slash?
|
|
|
|
if len(dirpath) < len(path):
|
|
|
|
suffix = path[:len(path) - len(dirpath)]
|
2010-08-06 01:40:54 +00:00
|
|
|
|
2011-11-16 16:38:37 +00:00
|
|
|
filename = _os.path.basename(dirpath)
|
|
|
|
dirpath = _os.path.dirname(dirpath)
|
2010-08-06 01:40:54 +00:00
|
|
|
|
2011-11-16 16:38:37 +00:00
|
|
|
if not _os.path.exists(dirpath):
|
2011-05-06 11:27:04 +00:00
|
|
|
if dirpath == path:
|
|
|
|
return path, False
|
|
|
|
|
2010-09-07 15:17:42 +00:00
|
|
|
dirpath, found = _ncase_path_found(dirpath)
|
2010-08-06 01:40:54 +00:00
|
|
|
|
2010-09-07 15:17:42 +00:00
|
|
|
if not found:
|
|
|
|
return path, False
|
2010-08-06 01:40:54 +00:00
|
|
|
|
2010-09-07 15:17:42 +00:00
|
|
|
# at this point, the directory exists but not the file
|
2010-08-06 01:40:54 +00:00
|
|
|
|
2010-09-07 15:17:42 +00:00
|
|
|
# we are expecting 'dirpath' to be a directory, but it could be a file
|
2011-11-16 16:38:37 +00:00
|
|
|
if _os.path.isdir(dirpath):
|
2014-07-30 13:35:19 +00:00
|
|
|
try:
|
|
|
|
files = _os.listdir(dirpath)
|
2015-05-17 07:17:31 +00:00
|
|
|
except PermissionError:
|
|
|
|
# We might not have the permission to list dirpath...
|
2014-07-30 13:35:19 +00:00
|
|
|
return path, False
|
2010-09-07 15:17:42 +00:00
|
|
|
else:
|
|
|
|
return path, False
|
2010-08-06 01:40:54 +00:00
|
|
|
|
2010-09-07 15:17:42 +00:00
|
|
|
filename_low = filename.lower()
|
|
|
|
f_iter_nocase = None
|
2010-08-06 01:40:54 +00:00
|
|
|
|
2010-09-07 15:17:42 +00:00
|
|
|
for f_iter in files:
|
|
|
|
if f_iter.lower() == filename_low:
|
|
|
|
f_iter_nocase = f_iter
|
|
|
|
break
|
2010-08-06 01:40:54 +00:00
|
|
|
|
2010-09-07 15:17:42 +00:00
|
|
|
if f_iter_nocase:
|
2011-11-16 16:38:37 +00:00
|
|
|
return _os.path.join(dirpath, f_iter_nocase) + suffix, True
|
2010-09-07 15:17:42 +00:00
|
|
|
else:
|
|
|
|
# cant find the right one, just return the path as is.
|
|
|
|
return path, False
|
2010-08-06 01:40:54 +00:00
|
|
|
|
2010-09-07 15:17:42 +00:00
|
|
|
ncase_path, found = _ncase_path_found(path)
|
|
|
|
return ncase_path if found else path
|
2010-08-06 01:40:54 +00:00
|
|
|
|
|
|
|
|
|
|
|
def ensure_ext(filepath, ext, case_sensitive=False):
|
|
|
|
"""
|
2011-08-02 17:00:44 +00:00
|
|
|
Return the path with the extension added if it is not already set.
|
2010-08-06 01:40:54 +00:00
|
|
|
|
2015-09-03 11:09:16 +00:00
|
|
|
:arg ext: The extension to check for, can be a compound extension. Should
|
|
|
|
start with a dot, such as '.blend' or '.tar.gz'.
|
2010-08-06 01:40:54 +00:00
|
|
|
:type ext: string
|
|
|
|
:arg case_sensitive: Check for matching case when comparing extensions.
|
|
|
|
:type case_sensitive: bool
|
|
|
|
"""
|
2011-07-31 03:15:37 +00:00
|
|
|
|
2015-09-03 11:58:11 +00:00
|
|
|
if case_sensitive:
|
|
|
|
if filepath.endswith(ext):
|
|
|
|
return filepath
|
|
|
|
else:
|
|
|
|
if filepath[-len(ext):].lower().endswith(ext.lower()):
|
|
|
|
return filepath
|
2010-08-06 01:40:54 +00:00
|
|
|
|
2015-09-03 11:09:16 +00:00
|
|
|
return filepath + ext
|
2010-09-08 04:55:37 +00:00
|
|
|
|
|
|
|
|
|
|
|
def module_names(path, recursive=False):
|
|
|
|
"""
|
|
|
|
Return a list of modules which can be imported from *path*.
|
|
|
|
|
|
|
|
:arg path: a directory to scan.
|
|
|
|
:type path: string
|
|
|
|
:arg recursive: Also return submodule names for packages.
|
|
|
|
:type recursive: bool
|
2010-09-08 07:30:20 +00:00
|
|
|
:return: a list of string pairs (module_name, module_file).
|
2010-09-08 04:55:37 +00:00
|
|
|
:rtype: list
|
|
|
|
"""
|
|
|
|
|
|
|
|
from os.path import join, isfile
|
|
|
|
|
|
|
|
modules = []
|
|
|
|
|
|
|
|
for filename in sorted(_os.listdir(path)):
|
2010-12-11 11:52:28 +00:00
|
|
|
if filename == "modules":
|
2011-01-01 07:20:34 +00:00
|
|
|
pass # XXX, hard coded exception.
|
2010-12-11 11:52:28 +00:00
|
|
|
elif filename.endswith(".py") and filename != "__init__.py":
|
2010-09-08 07:30:20 +00:00
|
|
|
fullpath = join(path, filename)
|
|
|
|
modules.append((filename[0:-3], fullpath))
|
2012-08-17 18:36:20 +00:00
|
|
|
elif "." not in filename:
|
2010-09-08 04:55:37 +00:00
|
|
|
directory = join(path, filename)
|
2010-09-08 07:30:20 +00:00
|
|
|
fullpath = join(directory, "__init__.py")
|
|
|
|
if isfile(fullpath):
|
|
|
|
modules.append((filename, fullpath))
|
2010-09-08 04:55:37 +00:00
|
|
|
if recursive:
|
2010-09-08 07:30:20 +00:00
|
|
|
for mod_name, mod_path in module_names(directory, True):
|
2011-07-31 03:15:37 +00:00
|
|
|
modules.append(("%s.%s" % (filename, mod_name),
|
2012-10-08 08:28:05 +00:00
|
|
|
mod_path,
|
|
|
|
))
|
2010-09-08 04:55:37 +00:00
|
|
|
|
|
|
|
return modules
|
2011-07-20 08:10:01 +00:00
|
|
|
|
|
|
|
|
|
|
|
def basename(path):
|
|
|
|
"""
|
2011-10-11 04:36:27 +00:00
|
|
|
Equivalent to os.path.basename, but skips a "//" prefix.
|
2011-07-20 08:10:01 +00:00
|
|
|
|
|
|
|
Use for Windows compatibility.
|
|
|
|
"""
|
2011-07-25 04:00:11 +00:00
|
|
|
return _os.path.basename(path[2:] if path[:2] in {"//", b"//"} else path)
|
2013-08-12 07:44:38 +00:00
|
|
|
|
|
|
|
|
|
|
|
def reduce_dirs(dirs):
|
|
|
|
"""
|
|
|
|
Given a sequence of directories, remove duplicates and
|
|
|
|
any directories nested in one of the other paths.
|
|
|
|
(Useful for recursive path searching).
|
|
|
|
|
|
|
|
:arg dirs: Sequence of directory paths.
|
|
|
|
:type dirs: sequence
|
|
|
|
:return: A unique list of paths.
|
|
|
|
:rtype: list
|
|
|
|
"""
|
|
|
|
dirs = list({_os.path.normpath(_os.path.abspath(d)) for d in dirs})
|
|
|
|
dirs.sort(key=lambda d: len(d))
|
2013-11-19 16:38:18 +00:00
|
|
|
for i in range(len(dirs) - 1, -1, -1):
|
2013-08-12 07:44:38 +00:00
|
|
|
for j in range(i):
|
|
|
|
print(i, j)
|
|
|
|
if len(dirs[i]) == len(dirs[j]):
|
|
|
|
break
|
|
|
|
elif is_subdir(dirs[i], dirs[j]):
|
|
|
|
del dirs[i]
|
|
|
|
break
|
|
|
|
return dirs
|