From 41d7ae9a2c093a7e0f70be97868f73f4662c1324 Mon Sep 17 00:00:00 2001 From: Stein Magnus Jodal Date: Mon, 8 Apr 2013 21:13:59 +0200 Subject: [PATCH] Replace 'folder' with 'dir' --- mopidy/__main__.py | 4 +- mopidy/backends/local/translator.py | 4 +- mopidy/frontends/mpd/translator.py | 10 ++-- mopidy/scanner.py | 4 +- mopidy/utils/path.py | 18 +++---- tests/backends/local/playlists_test.py | 2 +- tests/backends/local/translator_test.py | 2 +- tests/frontends/mpd/translator_test.py | 24 ++++----- tests/scanner_test.py | 2 +- tests/utils/path_test.py | 66 ++++++++++++------------- 10 files changed, 68 insertions(+), 68 deletions(-) diff --git a/mopidy/__main__.py b/mopidy/__main__.py index ea7bea32..4e81856a 100644 --- a/mopidy/__main__.py +++ b/mopidy/__main__.py @@ -309,8 +309,8 @@ def validate_config(raw_config, schemas, extensions=None): def create_file_structures(): - path.get_or_create_folder(path.expand_path('$XDG_DATA_DIR/mopidy')) - path.get_or_create_folder(path.expand_path('$XDG_CONFIG_DIR/mopidy')) + path.get_or_create_dir(path.expand_path('$XDG_DATA_DIR/mopidy')) + path.get_or_create_dir(path.expand_path('$XDG_CONFIG_DIR/mopidy')) path.get_or_create_file( path.expand_path('$XDG_CONFIG_DIR/mopidy/mopidy.conf')) diff --git a/mopidy/backends/local/translator.py b/mopidy/backends/local/translator.py index a36be927..683ad6b4 100644 --- a/mopidy/backends/local/translator.py +++ b/mopidy/backends/local/translator.py @@ -10,7 +10,7 @@ from mopidy.utils.path import path_to_uri logger = logging.getLogger('mopidy.backends.local') -def parse_m3u(file_path, music_folder): +def parse_m3u(file_path, media_dir): r""" Convert M3U file list of uris @@ -49,7 +49,7 @@ def parse_m3u(file_path, music_folder): if line.startswith('file://'): uris.append(line) else: - path = path_to_uri(music_folder, line) + path = path_to_uri(media_dir, line) uris.append(path) return uris diff --git a/mopidy/frontends/mpd/translator.py b/mopidy/frontends/mpd/translator.py index 21be37cc..7cf5b0c6 100644 --- a/mopidy/frontends/mpd/translator.py +++ b/mopidy/frontends/mpd/translator.py @@ -232,15 +232,15 @@ def tracks_to_tag_cache_format(tracks, media_dir): ('info_end',) ] tracks.sort(key=lambda t: t.uri) - folders, files = tracks_to_directory_tree(tracks, media_dir) - _add_to_tag_cache(result, folders, files, media_dir) + dirs, files = tracks_to_directory_tree(tracks, media_dir) + _add_to_tag_cache(result, dirs, files, media_dir) return result -def _add_to_tag_cache(result, folders, files, media_dir): +def _add_to_tag_cache(result, dirs, files, media_dir): base_path = media_dir.encode('utf-8') - for path, (entry_folders, entry_files) in folders.items(): + for path, (entry_dirs, entry_files) in dirs.items(): try: text_path = path.decode('utf-8') except UnicodeDecodeError: @@ -249,7 +249,7 @@ def _add_to_tag_cache(result, folders, files, media_dir): result.append(('directory', text_path)) result.append(('mtime', get_mtime(os.path.join(base_path, path)))) result.append(('begin', name)) - _add_to_tag_cache(result, entry_folders, entry_files, media_dir) + _add_to_tag_cache(result, entry_dirs, entry_files, media_dir) result.append(('end', name)) result.append(('songList begin',)) diff --git a/mopidy/scanner.py b/mopidy/scanner.py index 0f87a4d1..0c78839b 100644 --- a/mopidy/scanner.py +++ b/mopidy/scanner.py @@ -142,9 +142,9 @@ def translator(data): class Scanner(object): - def __init__(self, folder, data_callback, error_callback=None): + def __init__(self, base_dir, data_callback, error_callback=None): self.data = {} - self.files = path.find_files(folder) + self.files = path.find_files(base_dir) self.data_callback = data_callback self.error_callback = error_callback self.loop = gobject.MainLoop() diff --git a/mopidy/utils/path.py b/mopidy/utils/path.py index bcd610da..eb0cbbb0 100644 --- a/mopidy/utils/path.py +++ b/mopidy/utils/path.py @@ -27,16 +27,16 @@ XDG_DIRS = { } -def get_or_create_folder(folder): - folder = os.path.expanduser(folder) - if os.path.isfile(folder): +def get_or_create_dir(dir_path): + dir_path = os.path.expanduser(dir_path) + if os.path.isfile(dir_path): raise OSError( 'A file with the same name as the desired dir, ' - '"%s", already exists.' % folder) - elif not os.path.isdir(folder): - logger.info('Creating dir %s', folder) - os.makedirs(folder, 0755) - return folder + '"%s", already exists.' % dir_path) + elif not os.path.isdir(dir_path): + logger.info('Creating dir %s', dir_path) + os.makedirs(dir_path, 0755) + return dir_path def get_or_create_file(filename): @@ -121,7 +121,7 @@ def find_files(path): for dirpath, dirnames, filenames in os.walk(path, followlinks=True): for dirname in dirnames: if dirname.startswith(b'.'): - # Skip hidden folders by modifying dirnames inplace + # Skip hidden dirs by modifying dirnames inplace dirnames.remove(dirname) for filename in filenames: diff --git a/tests/backends/local/playlists_test.py b/tests/backends/local/playlists_test.py index b35b504f..acaac941 100644 --- a/tests/backends/local/playlists_test.py +++ b/tests/backends/local/playlists_test.py @@ -123,5 +123,5 @@ class LocalPlaylistsControllerTest( pass @unittest.SkipTest - def test_playlist_folder_is_createad(self): + def test_playlist_dir_is_created(self): pass diff --git a/tests/backends/local/translator_test.py b/tests/backends/local/translator_test.py index 61a86672..67907ff1 100644 --- a/tests/backends/local/translator_test.py +++ b/tests/backends/local/translator_test.py @@ -35,7 +35,7 @@ class M3UToUriTest(unittest.TestCase): uris = parse_m3u(path_to_data_dir('comment.m3u'), data_dir) self.assertEqual([song1_uri], uris) - def test_file_is_relative_to_correct_folder(self): + def test_file_is_relative_to_correct_dir(self): with tempfile.NamedTemporaryFile(delete=False) as tmp: tmp.write('song1.mp3') try: diff --git a/tests/frontends/mpd/translator_test.py b/tests/frontends/mpd/translator_test.py index 2f646faf..e4755d01 100644 --- a/tests/frontends/mpd/translator_test.py +++ b/tests/frontends/mpd/translator_test.py @@ -221,18 +221,18 @@ class TracksToTagCacheFormatTest(unittest.TestCase): self.assertEqual(formated, song_list) self.assertEqual(len(result), 0) - def test_tag_cache_suports_directories(self): + def test_tag_cache_supports_directories(self): track = Track(uri='file:///dir/subdir/folder/song.mp3') formated = self.translate(track) result = translator.tracks_to_tag_cache_format([track], self.media_dir) result = self.consume_headers(result) - folder, result = self.consume_directory(result) + dir_data, result = self.consume_directory(result) song_list, result = self.consume_song_list(result) self.assertEqual(len(song_list), 0) self.assertEqual(len(result), 0) - song_list, result = self.consume_song_list(folder) + song_list, result = self.consume_song_list(dir_data) self.assertEqual(len(result), 0) self.assertEqual(formated, song_list) @@ -241,11 +241,11 @@ class TracksToTagCacheFormatTest(unittest.TestCase): result = translator.tracks_to_tag_cache_format([track], self.media_dir) result = self.consume_headers(result) - folder, result = self.consume_directory(result) + dir_data, result = self.consume_directory(result) - self.assertEqual(('directory', 'folder/sub'), folder[0]) - self.assertEqual(('mtime', mtime('.')), folder[1]) - self.assertEqual(('begin', 'sub'), folder[2]) + self.assertEqual(('directory', 'folder/sub'), dir_data[0]) + self.assertEqual(('mtime', mtime('.')), dir_data[1]) + self.assertEqual(('begin', 'sub'), dir_data[2]) def test_tag_cache_suports_sub_directories(self): track = Track(uri='file:///dir/subdir/folder/sub/song.mp3') @@ -254,17 +254,17 @@ class TracksToTagCacheFormatTest(unittest.TestCase): result = self.consume_headers(result) - folder, result = self.consume_directory(result) + dir_data, result = self.consume_directory(result) song_list, result = self.consume_song_list(result) self.assertEqual(len(song_list), 0) self.assertEqual(len(result), 0) - folder, result = self.consume_directory(folder) + dir_data, result = self.consume_directory(dir_data) song_list, result = self.consume_song_list(result) self.assertEqual(len(result), 0) self.assertEqual(len(song_list), 0) - song_list, result = self.consume_song_list(folder) + song_list, result = self.consume_song_list(dir_data) self.assertEqual(len(result), 0) self.assertEqual(formated, song_list) @@ -299,8 +299,8 @@ class TracksToTagCacheFormatTest(unittest.TestCase): result = translator.tracks_to_tag_cache_format(tracks, self.media_dir) result = self.consume_headers(result) - folder, result = self.consume_directory(result) - song_list, song_result = self.consume_song_list(folder) + dir_data, result = self.consume_directory(result) + song_list, song_result = self.consume_song_list(dir_data) self.assertEqual(formated[1], song_list) self.assertEqual(len(song_result), 0) diff --git a/tests/scanner_test.py b/tests/scanner_test.py index 617f2537..edcc2242 100644 --- a/tests/scanner_test.py +++ b/tests/scanner_test.py @@ -196,7 +196,7 @@ class ScannerTest(unittest.TestCase): self.check('scanner/simple/song1.mp3', 'title', 'trackname') self.check('scanner/simple/song1.ogg', 'title', 'trackname') - def test_nonexistant_folder_does_not_fail(self): + def test_nonexistant_dir_does_not_fail(self): self.scan('scanner/does-not-exist') self.assert_(not self.errors) diff --git a/tests/utils/path_test.py b/tests/utils/path_test.py index 461f0809..a73cb8e4 100644 --- a/tests/utils/path_test.py +++ b/tests/utils/path_test.py @@ -13,7 +13,7 @@ from mopidy.utils import path from tests import unittest, path_to_data_dir -class GetOrCreateFolderTest(unittest.TestCase): +class GetOrCreateDirTest(unittest.TestCase): def setUp(self): self.parent = tempfile.mkdtemp() @@ -21,40 +21,40 @@ class GetOrCreateFolderTest(unittest.TestCase): if os.path.isdir(self.parent): shutil.rmtree(self.parent) - def test_creating_folder(self): - folder = os.path.join(self.parent, 'test') - self.assert_(not os.path.exists(folder)) - self.assert_(not os.path.isdir(folder)) - created = path.get_or_create_folder(folder) - self.assert_(os.path.exists(folder)) - self.assert_(os.path.isdir(folder)) - self.assertEqual(created, folder) + def test_creating_dir(self): + dir_path = os.path.join(self.parent, 'test') + self.assert_(not os.path.exists(dir_path)) + self.assert_(not os.path.isdir(dir_path)) + created = path.get_or_create_dir(dir_path) + self.assert_(os.path.exists(dir_path)) + self.assert_(os.path.isdir(dir_path)) + self.assertEqual(created, dir_path) - def test_creating_nested_folders(self): - level2_folder = os.path.join(self.parent, 'test') - level3_folder = os.path.join(self.parent, 'test', 'test') - self.assert_(not os.path.exists(level2_folder)) - self.assert_(not os.path.isdir(level2_folder)) - self.assert_(not os.path.exists(level3_folder)) - self.assert_(not os.path.isdir(level3_folder)) - created = path.get_or_create_folder(level3_folder) - self.assert_(os.path.exists(level2_folder)) - self.assert_(os.path.isdir(level2_folder)) - self.assert_(os.path.exists(level3_folder)) - self.assert_(os.path.isdir(level3_folder)) - self.assertEqual(created, level3_folder) + def test_creating_nested_dirs(self): + level2_dir = os.path.join(self.parent, 'test') + level3_dir = os.path.join(self.parent, 'test', 'test') + self.assert_(not os.path.exists(level2_dir)) + self.assert_(not os.path.isdir(level2_dir)) + self.assert_(not os.path.exists(level3_dir)) + self.assert_(not os.path.isdir(level3_dir)) + created = path.get_or_create_dir(level3_dir) + self.assert_(os.path.exists(level2_dir)) + self.assert_(os.path.isdir(level2_dir)) + self.assert_(os.path.exists(level3_dir)) + self.assert_(os.path.isdir(level3_dir)) + self.assertEqual(created, level3_dir) - def test_creating_existing_folder(self): - created = path.get_or_create_folder(self.parent) + def test_creating_existing_dir(self): + created = path.get_or_create_dir(self.parent) self.assert_(os.path.exists(self.parent)) self.assert_(os.path.isdir(self.parent)) self.assertEqual(created, self.parent) - def test_create_folder_with_name_of_existing_file_throws_oserror(self): + def test_create_dir_with_name_of_existing_file_throws_oserror(self): conflicting_file = os.path.join(self.parent, 'test') open(conflicting_file, 'w').close() - folder = os.path.join(self.parent, 'test') - self.assertRaises(OSError, path.get_or_create_folder, folder) + dir_path = os.path.join(self.parent, 'test') + self.assertRaises(OSError, path.get_or_create_dir, dir_path) class PathToFileURITest(unittest.TestCase): @@ -66,7 +66,7 @@ class PathToFileURITest(unittest.TestCase): result = path.path_to_uri('/etc/fstab') self.assertEqual(result, 'file:///etc/fstab') - def test_folder_and_path(self): + def test_dir_and_path(self): if sys.platform == 'win32': result = path.path_to_uri('C:/WINDOWS/', 'clock.avi') self.assertEqual(result, 'file:///C://WINDOWS/clock.avi') @@ -145,10 +145,10 @@ class SplitPathTest(unittest.TestCase): def test_empty_path(self): self.assertEqual([], path.split_path('')) - def test_single_folder(self): + def test_single_dir(self): self.assertEqual(['foo'], path.split_path('foo')) - def test_folders(self): + def test_dirs(self): self.assertEqual(['foo', 'bar', 'baz'], path.split_path('foo/bar/baz')) def test_initial_slash_is_ignored(self): @@ -190,10 +190,10 @@ class FindFilesTest(unittest.TestCase): def find(self, value): return list(path.find_files(path_to_data_dir(value))) - def test_basic_folder(self): + def test_basic_dir(self): self.assert_(self.find('')) - def test_nonexistant_folder(self): + def test_nonexistant_dir(self): self.assertEqual(self.find('does-not-exist'), []) def test_file(self): @@ -207,7 +207,7 @@ class FindFilesTest(unittest.TestCase): self.assert_( is_bytes(name), '%s is not bytes object' % repr(name)) - def test_ignores_hidden_folders(self): + def test_ignores_hidden_dirs(self): self.assertEqual(self.find('.hidden'), []) def test_ignores_hidden_files(self):