Bug fixes, DatFile uses AbstractFileReadOnly now

- fixed the argument passing for AbstractFileReadOnly and AbstractFile
- switched instances of read_from_raw to use read
- fixed deprecated decorators to show the calling line, not the decoline itself
- enable deprecation warnings on package load

PyPoE/__init__.py

@@ -26,6 +26,7 @@
 # Python
 import platform
 import os
+import warnings
 
 # =============================================================================
 # Globals
@@ -73,6 +74,7 @@ def _get_app_dir():
 # Init
 # =============================================================================
 
+warnings.simplefilter('default', DeprecationWarning)
 APP_DIR = _get_app_dir()
 DATA_DIR = os.path.join(os.path.dirname(__file__), '_data')
 DAT_SPECIFICATION = os.path.join(DATA_DIR, 'dat.specification.ini')

PyPoE/poe/file/_shared.py

@@ -82,12 +82,12 @@ def read(self, file_path_or_raw, *args, **kwargs):
         :raises TypeError: if file_path_or_raw has an invalid type
         """
         if isinstance(file_path_or_raw, BytesIO):
-            return self._read(file_path_or_raw)
+            return self._read(file_path_or_raw, *args, **kwargs)
         elif isinstance(file_path_or_raw, bytes):
-            return self._read(BytesIO(file_path_or_raw))
+            return self._read(BytesIO(file_path_or_raw), *args, **kwargs)
         elif isinstance(file_path_or_raw, str):
             with open(file_path_or_raw, 'rb') as f:
-                return self._read(f)
+                return self._read(f, *args, **kwargs)
         else:
             raise TypeError('file_path_or_raw must be a file path or bytes object')
 
@@ -122,11 +122,11 @@ def write(self, file_path_or_raw, *args, **kwargs):
         :raises TypeError: if file_path_or_raw has an invalid type
         """
         if isinstance(file_path_or_raw, BytesIO):
-            return self._write(file_path_or_raw)
+            return self._write(file_path_or_raw, *args, **kwargs)
         elif isinstance(file_path_or_raw, bytes):
-            return self._write(BytesIO(file_path_or_raw))
+            return self._write(BytesIO(file_path_or_raw), *args, **kwargs)
         elif isinstance(file_path_or_raw, str):
             with open(file_path_or_raw, 'wb') as f:
-                return self._write(f)
+                return self._write(f, *args, **kwargs)
         else:
             raise TypeError('file_path_or_raw must be a file path or bytes object')

PyPoE/poe/file/dat.py

@@ -59,6 +59,7 @@
 # Library imports
 from PyPoE import DAT_SPECIFICATION, DAT_SPECIFICATION_CONFIGSPEC
 from PyPoE.shared.decorators import deprecated
+from PyPoE.poe.file._shared import AbstractFileReadOnly
 from PyPoE.poe.file.ggpk import GGPKFile
 
 # =============================================================================
@@ -639,7 +640,7 @@ def export_to_html(self, export_table=True, export_data=False):
         return ''.join(outstr)
 
 
-class DatFile(object):
+class DatFile(AbstractFileReadOnly):
     """
     """
 
@@ -651,31 +652,33 @@ def __init__(self, file_name, *args, read_file=None, read_raw=None, options={}):
             raise ValueError('Only one of read_file and read_raw should be set.')
 
         if read_file:
-            self.read_from_file(read_file, **options)
+            self.read(os.path.join(read_file, file_name), **options)
         elif read_raw:
-            self.read_from_raw(read_raw, **options)
+            self.read(read_raw, **options)
 
     def print_data(self):
         for row in d.table_data:
             print('Row: %s' % row.rowid)
             for k in row.keys():
                 v = row[k]
                 print('|- %s: %s' % (k, v))
-
+
+    def _read(self, buffer, *args, **kwargs):
+        self.reader = DatReader(self._file_name, **kwargs)
+        self.reader.read(buffer.read())
+
+        return self.reader
+
+    @deprecated(message='Use of %(func)s is deprecated, use read instead.')
     def read_from_file(self, path, **options):
-        file_path = os.path.join(path, self._file_name)
-        with open(file_path, mode='br') as datfile:
-            raw = datfile.read()
-        return self.read_from_raw(raw, **options)
-
+        return self.read(os.path.join(path, self._file_name), **options)
+
+    @deprecated(message='Use of %(func)s is deprecated, use read instead.')
     def read_from_raw(self, raw, **options):
         """
         Specification as _ordered_ dictionary key:value format
         """
-        self.reader = DatReader(self._file_name, **options)
-        self.reader.read(raw)
-
-        return self.reader
+        return self.read(raw, **options)
 
 
 class RelationalReader(object):

PyPoE/shared/decorators.py

@@ -52,7 +52,7 @@ def deprecated_function(*args, **kwargs):
             warnings.warn(
                 self.message % {
                     'func': function.__name__,
-                }, DeprecationWarning
+                }, DeprecationWarning, stacklevel=2,
             )
 
             return function(*args, **kwargs)

PyPoE/ui/shared/file/handler.py

@@ -254,7 +254,7 @@ class DatDataHandler(FileDataHandler):
     def get_widget(self, file_data, file_name='', parent=None, *args, **kwargs):
         dat_file = DatFile(file_name)
         # We want dat values here
-        dat_file.read_from_raw(file_data, use_dat_value=True)
+        dat_file.read(file_data, use_dat_value=True)
 
         frame = DatFrame(dat_file=dat_file, parent=parent)
 

tests/PyPoE/poe/file/test_dat.py

@@ -280,7 +280,7 @@ def test_dat_file():
     spec = test_load_spec()
 
     df = dat.DatFile('TestSpec.dat')
-    dr = df.read_from_raw(temp_file, specification=spec)
+    dr = df.read(temp_file, specification=spec)
 
     for row in dr:
         for test in test_data:

tests/test_data.py

@@ -84,7 +84,7 @@ def test_definitions(node):
     }
     # Will raise errors accordingly if it fails
     df = dat.DatFile(node.name, options=opt)
-    df.read_from_raw(node.record.extract())
+    df.read(node.record.extract())