lots of pre-commit

Author: Joshua Li

.pre-commit-config.yaml

@@ -2,12 +2,31 @@ repos:
 -   repo: local
     hooks:
     - id: flake8
-      name: flake8
       entry: flake8
+      name: flake8
       language: python
-      types: [python]
+      types: [file, python]
     - id: black
+      entry: black -v
       name: black
-      entry: black
       language: python
-      types: [python]
+      types: [file, python]
+-   repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v1.4.0
+    hooks:
+    - id: trailing-whitespace
+    - id: end-of-file-fixer
+    - id: fix-encoding-pragma
+    - id: check-docstring-first
+    - id: check-merge-conflict
+    - id: check-yaml
+    - id: debug-statements
+    - id: name-tests-test
+    - id: check-added-large-files
+    - id: check-byte-order-marker
+    - id: mixed-line-ending
+    - id: requirements-txt-fixer
+-   repo: https://github.com/asottile/reorder_python_imports
+    rev: v1.2.0
+    hooks:
+    - id: reorder-python-imports

pylibgen/__init__.py

@@ -1 +1,4 @@
-from .pylibgen import Library, Book, constants
+# -*- coding: utf-8 -*-
+from .pylibgen import Book
+from .pylibgen import constants
+from .pylibgen import Library

pylibgen/constants.py

@@ -1,3 +1,4 @@
+# -*- coding: utf-8 -*-
 from collections import namedtuple
 
 __Mirror = namedtuple("Mirror", ("name", "search", "lookup"))
@@ -15,7 +16,7 @@
         "&open={open}"
         "&phrase={phrase}",
         "http://libgen.io/json.php" "?ids={ids}" "&fields={fields}",
-    )
+    ),
     # TODO gen.lib.rus.ec support
 }
 
@@ -33,19 +34,11 @@
     "phrase": 0,
 }
 
+# modes year, publisher, series, language, extension, tags are possible,
+# but way too general and not recommended.
+# AFAIK, there isn't a way to combine multiple search modes and respective
+# strings to filter down the search.
 SEARCH_MODES = ("title", "author", "isbn")
-"""
-The following modes are possible, but way too general and not recommended.
-AFAIK, there isn't a way to combine multiple search modes and respective
-strings to filter down the search.
-
-    'year',
-    'publisher',
-    'series',
-    'language',
-    'extension',
-    'tags',
-"""
 
 # strangely, libgen only allows these amounts.
 SEARCH_RESULTS_PER_PAGE = (25, 50, 100)

pylibgen/exceptions.py

@@ -1,3 +1,4 @@
+# -*- coding: utf-8 -*-
 class LibraryException(Exception):
     pass
 

pylibgen/pylibgen.py

@@ -1,9 +1,11 @@
+# -*- coding: utf-8 -*-
 import re
 from urllib.parse import quote_plus
 
 import requests
 
-from . import constants, exceptions
+from . import constants
+from . import exceptions
 
 
 class Library(object):

setup.py

@@ -1,5 +1,8 @@
+# -*- coding: utf-8 -*-
 import os
-from setuptools import setup, find_packages
+
+from setuptools import find_packages
+from setuptools import setup
 
 version = "2.0.0b2"
 url = "https://github.com/JoshuaRLi/pylibgen"

tests/test_book.py tests/book_test.py

@@ -1,6 +1,8 @@
+# -*- coding: utf-8 -*-
+import pytest
 import requests
+
 import pylibgen
-import pytest
 
 
 def check_url(url):

tests/test_library.py tests/library_test.py

@@ -1,6 +1,8 @@
-import pylibgen
+# -*- coding: utf-8 -*-
 import pytest
 
+import pylibgen
+
 test_books = {
     # Automate the Boring Stuff with Python: Practical Programming for Total Beginners
     ("automate the boring stuff", "title"): {
@@ -31,13 +33,13 @@
 @pytest.mark.parametrize("test_book", list(test_books.items()))
 def test_mirror(mirror, test_book):
     search_params, md5_of_ids = test_book
-    l = pylibgen.Library(mirror)
-    ids = l.search(*search_params)
+    library = pylibgen.Library(mirror)
+    ids = library.search(*search_params)
 
     assert isinstance(ids, list)
     assert set(ids) == set(md5_of_ids.keys())
 
-    books = l.lookup(ids)
+    books = library.lookup(ids)
     assert isinstance(books, list)
     assert all((isinstance(b, pylibgen.Book) for b in books))
     for book in books:
@@ -46,6 +48,6 @@ def test_mirror(mirror, test_book):
 
 @pytest.mark.parametrize("mirror", pylibgen.constants.MIRRORS)
 def test_all_book_fields(mirror):
-    l = pylibgen.Library(mirror)
-    book = l.lookup("112887", fields=["*"])
+    library = pylibgen.Library(mirror)
+    book = library.lookup("112887", fields=["*"])
     assert set(book.__dict__.keys()) == pylibgen.constants.ALL_BOOK_FIELDS

tox.ini

@@ -12,4 +12,4 @@ commands =
 
 [flake8]
 max-line-length = 90
-exclude = tests/test_*.py,__init__.py,setup.py
+exclude = __init__.py,setup.py