From 2eb10e391a4c31228b3e55fec9527e47504283e3 Mon Sep 17 00:00:00 2001
From: Adrian Sampson <adrian@radbox.org>
Date: Wed, 21 Jul 2010 23:01:32 -0700
Subject: [PATCH] add "format" field to MediaFile for getting the file type

This allows using $format in your path format string, which is nice.
---
 beets/library.py             |   1 +
 beets/mediafile.py           |  15 +++++++++++++++
 test/rsrc/test.blb           | Bin 5120 -> 5120 bytes
 test/test_db.py              |   6 ++++++
 test/test_mediafile_basic.py |   5 +++++
 5 files changed, 27 insertions(+)

diff --git a/beets/library.py b/beets/library.py
index cb5ddeb77..2e639e334 100644
--- a/beets/library.py
+++ b/beets/library.py
@@ -60,6 +60,7 @@ ITEM_FIELDS = [
 
     ('length',      'real', False, True),
     ('bitrate',     'int',  False, True),
+    ('format',      'text', False, True),
 ]
 ITEM_KEYS_WRITABLE = [f[0] for f in ITEM_FIELDS if f[3] and f[2]]
 ITEM_KEYS_META     = [f[0] for f in ITEM_FIELDS if f[3]]
diff --git a/beets/mediafile.py b/beets/mediafile.py
index 74dc00b11..7581c57f4 100644
--- a/beets/mediafile.py
+++ b/beets/mediafile.py
@@ -50,6 +50,18 @@ class FileTypeError(UnreadableFileError):
     pass
 
 
+# Constants.
+
+# Human-readable type names.
+TYPES = {
+    'mp3':  'MP3',
+    'mp4':  'AAC',
+    'ogg':  'OGG',
+    'flac': 'FLAC',
+    'ape':  'APE',
+}
+
+
 # Flags for encoding field behavior.
 
 class Enumeration(object):
@@ -660,3 +672,6 @@ class MediaFile(object):
         else:
             return self.mgfile.info.bitrate
 
+    @property
+    def format(self):
+        return TYPES[self.type]
diff --git a/test/rsrc/test.blb b/test/rsrc/test.blb
index 15d3d859d8f2345f393ae159528b0fe0b9c42215..aba567880745da92ac12a1549f1635f586302a38 100644
GIT binary patch
delta 88
zcmZqBXwaA-Ehxf(3WO)>Sn@MgGO#dAW?=4Oj%K{YFnOY*{KU!6Sbz!>C)YB@ay8X4
fvx|$1Gqy%=Zf4A6<j_$_%P-1JEZH2&yjlPN*z6PU

delta 82
zcmZqBXwaA-Ehx-@3WO%=Sn@NyWnf{L%)s2m9L-qCFnOY*{KU!6Sego%*(cXB#%{J|
Z5@O`i1nSF^lw@o)o;WvUa}@J30RVUW5&{4K

diff --git a/test/test_db.py b/test/test_db.py
index f504564bd..86e16f073 100644
--- a/test/test_db.py
+++ b/test/test_db.py
@@ -46,6 +46,7 @@ def item(): return beets.library.Item({
     'path':        'somepath',
     'length':      60.0,
     'bitrate':     128000,
+    'format':      'FLAC',
     'mb_trackid':  'someID-1',
     'mb_albumid':  'someID-2',
     'mb_artistid': 'someID-3',
@@ -247,6 +248,11 @@ class DestinationTest(unittest.TestCase):
     def test_sanitize_replaces_colon_with_dash(self):
         p = beets.library._sanitize_path(u':', 'Darwin')
         self.assertEqual(p, u'-')
+    
+    def test_path_with_format(self):
+        self.lib.path_format = '$artist/$album ($format)'
+        p = self.lib.destination(self.i)
+        self.assert_('(FLAC)' in p)
 
 class MigrationTest(unittest.TestCase):
     """Tests the ability to change the database schema between
diff --git a/test/test_mediafile_basic.py b/test/test_mediafile_basic.py
index 81bc39d9d..005c54a43 100644
--- a/test/test_mediafile_basic.py
+++ b/test/test_mediafile_basic.py
@@ -207,26 +207,31 @@ read_only_correct_dicts = {
     'full.mp3': {
         'length': 1.0,
         'bitrate': 80000,
+        'format': 'MP3',
     },
 
     'full.flac': {
         'length': 1.0,
         'bitrate': 705600,
+        'format': 'FLAC',
     },
 
     'full.m4a': {
         'length': 1.0,
         'bitrate': 64000,
+        'format': 'AAC',
     },
     
     'full.ogg': {
         'length': 1.0,
         'bitrate': 48000,
+        'format': 'OGG',
     },
     
     'full.ape': {
         'length': 1.0,
         'bitrate': 705600,
+        'format': 'APE',
     },
 
 }