update to version 0.1.2

CHANGELOG.md

@@ -1,71 +0,0 @@
-# Changelog
-
-All notable changes to this project will be documented in this file.
-
-The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
-and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
-
-## [Unreleased]
-
-## [0.1.4] - 2018-04-06
-
-### Added
-
-- `encoding` option can be `auto`, which will use `chardet` package to decide which encoding to use. If `chardet` is noe installed, will raise a warning and fallback to 'utf-8'. (Thanks to [@ltfychrise])
-- Add changelog.
-
-### Change
-
-- Reorganize test codes/files.
-
-### Fixed
-
-- Fix integer filed can't be negative bug. (Thanks to [@ltfychrise])
-- Fix `_seek_back` method not make `_pos` back bug. (Thanks to [@ltfychrise])
-
-## [0.1.3] - 2017-06-21
-
-### Added
-
-- Now `UnicodeDecodeError` is wrapped in `InvalidTorrentDataException`.
-
-### Fixed
-
-- Use `IOError` instead of `FileNotFoundError` in Python 2.
-
-### Changed
-
-- `InvalidTorrentFileException` rename to `InvalidTorrentDataException`.
-
-## [0.1.2] - 2017-06-21
-
-### Changed
-
-- Emm, I don't know, I just changed the version code...
-
-## [0.1.1] - 2017-06-20
-
-### Added
-
-- CLI add coding `--coding/-c` option for file string filed encoding.
-
-### Changed
-
-- `ed2k` and `filehash` field now use same structure as 'pieces'.
-
-## [0.1.0] - 2017-05-23
-
-### Added
-
-- Parse torrent from file and data into a dict.
-- CLI provided.
-- Simple tests.
-- Available on pip.
-
-[@ltfychrise]: https://github.com/ltfychrise
-[Unreleased]: https://github.com/7sDream/torrent_parser/compare/v0.1.3...HEAD
-[0.1.4]: https://github.com/7sDream/torrent_parser/compare/v0.1.3...v0.1.4
-[0.1.3]: https://github.com/7sDream/torrent_parser/compare/v0.1.2...v0.1.3
-[0.1.2]: https://github.com/7sDream/torrent_parser/compare/v0.1.1...v0.1.2
-[0.1.1]: https://github.com/7sDream/torrent_parser/compare/v0.1.0...v0.1.1
-[0.1.0]: https://github.com/7sDream/torrent_parser/tree/v0.1.0

MANIFEST.in

@@ -1,3 +1,3 @@
-include README.md LICENSE CHANGELOG.md
+include README.md LICENSE changelog.md
 include test.py
 include test.torrent

README.md

@@ -37,13 +37,9 @@ http://tracker.trackerfix.com:80/announce
 ## Test
 
 ```bash
-python -m unittest tests
+python -m unittest test
 ```
 
-## Changelog
-
-See [Changelog][CHANGELOG].
-
 ## LICENSE
 
 See [License][LICENSE].
@@ -52,4 +48,3 @@ See [License][LICENSE].
 [screenshots-normal]: http://rikka-10066868.image.myqcloud.com/1492616d-9f14-4fe2-9146-9a3ac06c6868.png
 [screenshots-indent]: http://rikka-10066868.image.myqcloud.com/eadc4184-6deb-42eb-bfd4-239da8f50c08.png
 [LICENSE]: https://github.com/7sDream/torrent_parser/blob/master/LICENSE
-[CHANGELOG]: https://github.com/7sDream/torrent_parser/blob/master/CHANGELOG.md

test.py

@@ -7,36 +7,31 @@ from torrent_parser import TorrentFileParser, parse_torrent_file
 
 
 class Test(unittest.TestCase):
-    REAL_FILE = 'tests/testfiles/real.torrent'
-    NEG_FILE = 'tests/testfiles/neg.torrent'
+    TEST_FILENAME = 'test.torrent'
 
     def test_parse_torrent_file_use_shortcut(self):
-        parse_torrent_file(self.REAL_FILE)
+        parse_torrent_file(self.TEST_FILENAME)
 
     def test_parse_torrent_file_use_class(self):
-        with open(self.REAL_FILE, 'rb') as fp:
+        with open(self.TEST_FILENAME, 'rb') as fp:
             TorrentFileParser(fp).parse()
 
-    def test_encoding_auto(self):
-        with open(self.REAL_FILE, 'rb') as fp:
-            TorrentFileParser(fp, encoding='auto').parse()
-
     def test_parse_torrent_file_to_ordered_dict(self):
-        data = parse_torrent_file(self.REAL_FILE, True)
+        data = parse_torrent_file(self.TEST_FILENAME, True)
         self.assertIsInstance(data, collections.OrderedDict)
 
-        with open(self.REAL_FILE, 'rb') as fp:
+        with open(self.TEST_FILENAME, 'rb') as fp:
             data = TorrentFileParser(fp, True).parse()
         self.assertIsInstance(data, collections.OrderedDict)
 
     def test_parse_correctness(self):
-        data = parse_torrent_file(self.REAL_FILE)
+        data = parse_torrent_file(self.TEST_FILENAME)
         self.assertIn(['udp://tracker.publicbt.com:80/announce'],
                       data['announce-list'])
         self.assertEqual(data['creation date'], 1409254242)
 
     def test_parse_two_times(self):
-        with open(self.REAL_FILE, 'rb') as fp:
+        with open(self.TEST_FILENAME, 'rb') as fp:
             parser = TorrentFileParser(fp)
             data = parser.parse()
             self.assertIn(['udp://tracker.publicbt.com:80/announce'],
@@ -46,11 +41,3 @@ class Test(unittest.TestCase):
             self.assertIn(['udp://tracker.publicbt.com:80/announce'],
                           data['announce-list'])
             self.assertEqual(data['creation date'], 1409254242)
-
-    def test_int_is_negative(self):
-        data = parse_torrent_file(self.NEG_FILE)
-        self.assertEqual(data['neg'], -1)
-
-
-if __name__ == '__main__':
-    unittest.main()

tests/__init__.py

@@ -1 +0,0 @@
-from .test_all import *

tests/testfiles/neg.torrent

@@ -1 +0,0 @@
-d3:negi-1ee

torrent_parser.py

@@ -21,48 +21,21 @@ import collections
 import io
 import json
 import sys
-import warnings
 
-try:
-    FileNotFoundError
-except NameError:
-    # Python 2 do not have FileNotFoundError, use IOError instead
-    # noinspection PyShadowingBuiltins
-    FileNotFoundError = IOError
-
-try:
-    # noinspection PyPackageRequirements
-    from chardet import detect as _detect
-except ImportError:
-    def _detect(_):
-        warnings.warn("No chardet module installed, encoding will be utf-8")
-        return {'encoding': 'utf-8', 'confidence': 1}
 
 __all__ = [
-    'InvalidTorrentDataException',
+    'InvalidTorrentFileException',
     'parse_torrent_file',
     'TorrentFileParser',
 ]
 
-__version__ = '0.1.4'
+__version__ = '0.1.2'
 
 
-def detect(content):
-    return _detect(content)['encoding']
-
-
-class InvalidTorrentDataException(Exception):
+class InvalidTorrentFileException(Exception):
     def __init__(self, pos, msg=None):
-        msg = msg or "Invalid torrent format when read at pos {pos}"
-        msg = msg.format(pos=pos)
-        super(InvalidTorrentDataException, self).__init__(msg)
-
-
-class __EndCls(object):
-    pass
-
-
-_END = __EndCls()
+        msg = msg or "Invalid torrent format when reading at pos " + str(pos)
+        super(InvalidTorrentFileException, self).__init__(msg)
 
 
 class TorrentFileParser(object):
@@ -91,8 +64,7 @@ class TorrentFileParser(object):
         """
         :param fp: a **binary** file-like object to parse,
           which means need 'b' mode when use built-in open function
-        :param encoding: file content encoding, default utf-8, use 'auto' to
-          enable charset auto detection ('chardet' package should be installed)
+        :param encoding: file content encoding, default utf-8
         :param use_ordered_dict: Use collections.OrderedDict as dict container
           default False, which mean use built-in dict
         """
@@ -116,7 +88,7 @@ class TorrentFileParser(object):
 
         try:
             c = self._read_byte(1, True)
-            raise InvalidTorrentDataException(
+            raise InvalidTorrentFileException(
                 0, 'Expect EOF, but get [{}] at pos {}'.format(c, self._pos)
             )
         except EOFError:  # expect EOF
@@ -125,7 +97,7 @@ class TorrentFileParser(object):
         if isinstance(data, dict):
             return data
 
-        raise InvalidTorrentDataException('Outermost element is not a dict')
+        raise InvalidTorrentFileException('Outermost element is not a dict')
 
     def _read_byte(self, count=1, raise_eof=False):
         assert count >= 0
@@ -133,7 +105,7 @@ class TorrentFileParser(object):
         if count != 0 and len(gotten) == 0:
             if raise_eof:
                 raise EOFError()
-            raise InvalidTorrentDataException(
+            raise InvalidTorrentFileException(
                 self._pos,
                 'Unexpected EOF when reading torrent file'
             )
@@ -142,7 +114,6 @@ class TorrentFileParser(object):
 
     def _seek_back(self, count):
         self._content.seek(-count, 1)
-        self._pos = self._pos - count
 
     def _restart(self):
         self._content.seek(0, 0)
@@ -150,8 +121,9 @@ class TorrentFileParser(object):
 
     def _dict_items_generator(self):
         while True:
+            try:
                 k = self._next_element()
-            if k is _END:
+            except InvalidTorrentFileException:
                 return
             if k == 'pieces':
                 v = self._next_hash()
@@ -173,8 +145,9 @@ class TorrentFileParser(object):
 
     def _list_items_generator(self):
         while True:
+            try:
                 element = self._next_element()
-            if element is _END:
+            except InvalidTorrentFileException:
                 return
             yield element
 
@@ -184,31 +157,19 @@ class TorrentFileParser(object):
     def _next_int(self, end=END_INDICATOR):
         value = 0
         char = self._read_byte(1)
-        neg = False
         while char != end:
-            if not neg and char == b'-':
-                neg = True
-            elif not b'0' <= char <= b'9':
-                raise InvalidTorrentDataException(self._pos - 1)
-            else:
+            # noinspection PyTypeChecker
+            if not b'0' <= char <= b'9':
+                raise InvalidTorrentFileException(self._pos)
             value = value * 10 + int(char) - int(b'0')
             char = self._read_byte(1)
-        return -value if neg else value
+        return value
 
     def _next_string(self, decode=True):
         length = self._next_int(b':')
         raw = self._read_byte(length)
         if decode:
-            encoding = self._encoding
-            if encoding == 'auto':
-                encoding = detect(raw)
-            try:
-                string = raw.decode(encoding)
-            except UnicodeDecodeError as e:
-                raise InvalidTorrentDataException(
-                    self._pos - length + e.start,
-                    "Fail to decode string at pos {pos} using " + e.encoding
-                )
+            string = raw.decode(self._encoding)
             return string
         return raw
 
@@ -219,9 +180,7 @@ class TorrentFileParser(object):
     def _next_hash(self, p_len=20, need_list=True):
         raw = self._next_string(decode=False)
         if len(raw) % p_len != 0:
-            raise InvalidTorrentDataException(
-                self._pos - len(raw), "Hash bit length not match at pos {pos}"
-            )
+            raise InvalidTorrentFileException(self._pos)
         res = [
             ''.join([self.__to_hex(c) for c in h])
             for h in (raw[x:x+p_len] for x in range(0, len(raw), p_len))
@@ -232,9 +191,8 @@ class TorrentFileParser(object):
             return res[0]
         return res
 
-    @staticmethod
-    def _next_end():
-        return _END
+    def _next_end(self):
+        raise InvalidTorrentFileException(self._pos)
 
     def _next_type(self):
         for (element_type, indicator) in self.TYPES:
@@ -243,7 +201,7 @@ class TorrentFileParser(object):
             if indicator == char:
                 return element_type
             self._seek_back(indicator_length)
-        raise InvalidTorrentDataException(self._pos)
+        raise InvalidTorrentFileException(self._pos)
 
     def _type_to_func(self, t):
         return getattr(self, '_next_' + t)
@@ -298,7 +256,7 @@ def __main():
         else:
             target_file = open(args.file, 'rb')
     except FileNotFoundError:
-        sys.stderr.write('File "{}" not exist\n'.format(args.file))
+        sys.stderr.write('Unable to find file {}\n'.format(args.file))
         exit(1)
 
     # noinspection PyUnboundLocalVariable
@@ -311,6 +269,5 @@ def __main():
 
     print(data)
 
-
 if __name__ == '__main__':
     __main()