[v0.3.0] Add file_type to File object

Signed-off-by: Sanket Saurav <[email protected]>

CHANGELOG.md

@@ -0,0 +1,5 @@
+# Changelog
+
+## 0.3.0 (2018-06-17)
+ - Add `file_type` attribute on the `File` object, with the following
+ recognized possible values: `image`, `text`, `media`, and `binary`

Pipfile

@@ -14,6 +14,7 @@ mock = "*"
 twine = "*"
 "boto3" = "*"
 future = "*"
+mimelib = "*"
 
 [requires]
 python_version = "2.7"

s3tree/__version__.py

@@ -1,4 +1,4 @@
 #!/usr/bin/env python
 # -*- coding: utf-8 -*-
 
-__version__ = '0.2.0'
+__version__ = '0.3.0'

s3tree/models.py

@@ -3,6 +3,7 @@
 """This module contains the model objects that are used to represent
 trees and files in S3Tree."""
 import os
+import mimelib
 from future.utils import python_2_unicode_compatible
 from json import dumps
 from .utils import humanize_file_size, cached_property
@@ -59,6 +60,9 @@ def __init__(self, data, s3tree):
         self.size_in_bytes = data.get('Size')
         self.storage_class = data.get('StorageClass')
 
+        # create a mime object for this file
+        self.mime = mimelib.url(self.path)
+
         # private attributes
         self.__s3tree = s3tree
 
@@ -72,6 +76,11 @@ def name(self):
         """File name of this file."""
         return os.path.basename(self.path)
 
+    @property
+    def file_type(self):
+        """Returns this file's type."""
+        return self.mime.file_type
+
     def read(self):
         """Read the contents of this file. This method returns a string."""
         try:
@@ -87,7 +96,7 @@ def __str__(self):
     @cached_property
     def as_dict(self):
         """Dictionary representation of this file."""
-        properties = ('name', 'path', 'etag', 'size',
+        properties = ('name', 'path', 'etag', 'size', 'file_type',
                       'size_in_bytes')
         data = {p: getattr(self, p) for p in properties}
         data['last_modified'] = self.last_modified.isoformat()

setup.py

@@ -18,7 +18,7 @@
 VERSION = None
 
 # What packages are required for this module to be executed?
-REQUIRED = ['boto3', 'future', 'six']
+REQUIRED = ['boto3', 'future', 'mimelib', 'six']
 
 here = os.path.abspath(os.path.dirname(__file__))
 

tests/test_models.py

@@ -61,6 +61,7 @@ def test_file_as_dict_property(file_data, s3tree):
     file_obj = File(file_data, s3tree)
     orig_data = dict(name='tooltag-add.png',
                      path='admin/img/tooltag-add.png',
+                     file_type='image',
                      etag='"2152fd3b4a4dd92fef70a86e50e1453b"',
                      size_in_bytes=2048,
                      size='2 KB',