74d043f8a544242e9c0053d4730be8dd7b757f94
[blender.git] / release / scripts / modules / bpy / path.py
1 # ##### BEGIN GPL LICENSE BLOCK #####
2 #
3 #  This program is free software; you can redistribute it and/or
4 #  modify it under the terms of the GNU General Public License
5 #  as published by the Free Software Foundation; either version 2
6 #  of the License, or (at your option) any later version.
7 #
8 #  This program is distributed in the hope that it will be useful,
9 #  but WITHOUT ANY WARRANTY; without even the implied warranty of
10 #  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
11 #  GNU General Public License for more details.
12 #
13 #  You should have received a copy of the GNU General Public License
14 #  along with this program; if not, write to the Free Software Foundation,
15 #  Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
16 #
17 # ##### END GPL LICENSE BLOCK #####
18
19 # <pep8 compliant>
20
21 """
22 This module has a similar scope to os.path, containing utility
23 functions for dealing with paths in Blender.
24 """
25
26 import bpy as _bpy
27 import os as _os
28
29
30 def abspath(path, start=None):
31     """
32     Returns the absolute path relative to the current blend file using the "//" prefix.
33
34     :arg start: Relative to this path, when not set the current filename is used.
35     :type start: string
36     """
37     if path.startswith("//"):
38         return _os.path.join(_os.path.dirname(_bpy.data.filepath) if start is None else start, path[2:])
39
40     return path
41
42
43 def relpath(path, start=None):
44     """
45     Returns the path relative to the current blend file using the "//" prefix.
46
47     :arg start: Relative to this path, when not set the current filename is used.
48     :type start: string
49     """
50     if not path.startswith("//"):
51         if start is None:
52             start = _os.path.dirname(_bpy.data.filepath)
53         return "//" + _os.path.relpath(path, start)
54
55     return path
56
57
58 def is_subdir(path, directory):
59     """
60     Returns true if *path* in a subdirectory of *directory*.
61     Both paths must be absolute.
62     """
63     from os.path import normpath, normcase
64     path = normpath(normcase(path))
65     directory = normpath(normcase(directory))
66     return path.startswith(directory)
67
68
69 def clean_name(name, replace="_"):
70     """
71     Returns a name with characters replaced that may cause problems under various circumstances, such as writing to a file.
72     All characters besides A-Z/a-z, 0-9 are replaced with "_"
73     or the replace argument if defined.
74     """
75
76     unclean_chars = \
77                  "\x00\x01\x02\x03\x04\x05\x06\x07\x08\x09\x0a\x0b\x0c\x0d\x0e\
78                   \x0f\x10\x11\x12\x13\x14\x15\x16\x17\x18\x19\x1a\x1b\x1c\x1d\
79                   \x1e\x1f\x20\x21\x22\x23\x24\x25\x26\x27\x28\x29\x2a\x2b\x2c\
80                   \x2e\x2f\x3a\x3b\x3c\x3d\x3e\x3f\x40\x5b\x5c\x5d\x5e\x60\x7b\
81                   \x7c\x7d\x7e\x7f\x80\x81\x82\x83\x84\x85\x86\x87\x88\x89\x8a\
82                   \x8b\x8c\x8d\x8e\x8f\x90\x91\x92\x93\x94\x95\x96\x97\x98\x99\
83                   \x9a\x9b\x9c\x9d\x9e\x9f\xa0\xa1\xa2\xa3\xa4\xa5\xa6\xa7\xa8\
84                   \xa9\xaa\xab\xac\xad\xae\xaf\xb0\xb1\xb2\xb3\xb4\xb5\xb6\xb7\
85                   \xb8\xb9\xba\xbb\xbc\xbd\xbe\xbf\xc0\xc1\xc2\xc3\xc4\xc5\xc6\
86                   \xc7\xc8\xc9\xca\xcb\xcc\xcd\xce\xcf\xd0\xd1\xd2\xd3\xd4\xd5\
87                   \xd6\xd7\xd8\xd9\xda\xdb\xdc\xdd\xde\xdf\xe0\xe1\xe2\xe3\xe4\
88                   \xe5\xe6\xe7\xe8\xe9\xea\xeb\xec\xed\xee\xef\xf0\xf1\xf2\xf3\
89                   \xf4\xf5\xf6\xf7\xf8\xf9\xfa\xfb\xfc\xfd\xfe"
90
91     for ch in unclean_chars:
92         name = name.replace(ch, replace)
93     return name
94
95
96 def display_name(name):
97     """
98     Creates a display string from name to be used menus and the user interface.
99     Capitalize the first letter in all lowercase names, mixed case names are kept as is.
100     Intended for use with filenames and module names.
101     """
102
103     name_base = _os.path.splitext(name)[0]
104
105     # string replacements
106     name_base = name_base.replace("_colon_", ":")
107
108     name_base = name_base.replace("_", " ")
109
110     if name_base.islower():
111         return name_base.lower().title()
112     else:
113         return name_base
114
115
116 def display_name_from_filepath(name):
117     """
118     Returns the path stripped of directort and extension, ensured to be utf8 compatible.
119     """
120     return _os.path.splitext(_os.path.basename(name))[0].encode("utf8", "replace").decode("utf8")
121
122
123 def resolve_ncase(path):
124     """
125     Resolve a case insensitive path on a case sensitive system,
126     returning a string with the path if found else return the original path.
127     """
128
129     import os
130
131     def _ncase_path_found(path):
132         if not path or os.path.exists(path):
133             return path, True
134
135         filename = os.path.basename(path)  # filename may be a directory or a file
136         dirpath = os.path.dirname(path)
137
138         suffix = path[:0]  # "" but ensure byte/str match
139         if not filename:  # dir ends with a slash?
140             if len(dirpath) < len(path):
141                 suffix = path[:len(path) - len(dirpath)]
142
143             filename = os.path.basename(dirpath)
144             dirpath = os.path.dirname(dirpath)
145
146         if not os.path.exists(dirpath):
147             if dirpath == path:
148                 return path, False
149
150             dirpath, found = _ncase_path_found(dirpath)
151
152             if not found:
153                 return path, False
154
155         # at this point, the directory exists but not the file
156
157         # we are expecting 'dirpath' to be a directory, but it could be a file
158         if os.path.isdir(dirpath):
159             files = os.listdir(dirpath)
160         else:
161             return path, False
162
163         filename_low = filename.lower()
164         f_iter_nocase = None
165
166         for f_iter in files:
167             if f_iter.lower() == filename_low:
168                 f_iter_nocase = f_iter
169                 break
170
171         if f_iter_nocase:
172             return os.path.join(dirpath, f_iter_nocase) + suffix, True
173         else:
174             # cant find the right one, just return the path as is.
175             return path, False
176
177     ncase_path, found = _ncase_path_found(path)
178     return ncase_path if found else path
179
180
181 def ensure_ext(filepath, ext, case_sensitive=False):
182     """
183     Return the path with the extension added its its not alredy set.
184
185     :arg ext: The extension to check for.
186     :type ext: string
187     :arg case_sensitive: Check for matching case when comparing extensions.
188     :type case_sensitive: bool
189     """
190     import os
191     fn_base, fn_ext = os.path.splitext(filepath)
192     if fn_base and fn_ext:
193         if (case_sensitive and ext == fn_ext) or (ext.lower() == fn_ext.lower()):
194             return filepath
195         else:
196             return fn_base + ext
197
198     else:
199         return filepath + ext
200
201
202 def module_names(path, recursive=False):
203     """
204     Return a list of modules which can be imported from *path*.
205
206     :arg path: a directory to scan.
207     :type path: string
208     :arg recursive: Also return submodule names for packages.
209     :type recursive: bool
210     :return: a list of string pairs (module_name, module_file).
211     :rtype: list
212     """
213
214     from os.path import join, isfile
215
216     modules = []
217
218     for filename in sorted(_os.listdir(path)):
219         if filename == "modules":
220             pass  # XXX, hard coded exception.
221         elif filename.endswith(".py") and filename != "__init__.py":
222             fullpath = join(path, filename)
223             modules.append((filename[0:-3], fullpath))
224         elif ("." not in filename):
225             directory = join(path, filename)
226             fullpath = join(directory, "__init__.py")
227             if isfile(fullpath):
228                 modules.append((filename, fullpath))
229                 if recursive:
230                     for mod_name, mod_path in module_names(directory, True):
231                         modules.append(("%s.%s" % (filename, mod_name), mod_path))
232
233     return modules