Merge pull request #50 from staticdev/pre-commit

Pre-commit, docstrings, type-hinting

Author: Thiago C. D'Ávila

.pre-commit-config.yaml

@@ -2,30 +2,31 @@ repos:
   - repo: https://github.com/pre-commit/pre-commit-hooks
     rev: v2.5.0
     hooks:
+      - id: check-toml
       - id: check-yaml
       - id: end-of-file-fixer
       - id: trailing-whitespace
       - id: check-added-large-files
-      - id: check-toml
   - repo: https://github.com/prettier/prettier
     rev: 2.0.5
     hooks:
       - id: prettier
-  - repo: local
+  - repo: https://github.com/psf/black
+    rev: 19.10b0
     hooks:
       - id: black
-        name: black
-        entry: poetry run black
-        language: system
-        types: [python]
+  - repo: https://gitlab.com/pycqa/flake8
+    rev: 3.7.9
+    hooks:
       - id: flake8
-        name: flake8
-        entry: poetry run flake8
-        language: system
-        types: [python]
-      - id: mypy
-        name: mypy
-        entry: poetry run mypy
-        language: system
-        types: [python]
-        require_serial: true
+        additional_dependencies:
+          - flake8-bandit==2.1.2
+          - flake8-bugbear==20.1.4
+          - flake8-docstrings==1.5.0
+          - pep8-naming==0.10.0
+          - darglint==1.2.3
+  - repo: https://github.com/asottile/reorder_python_imports
+    rev: v2.3.0
+    hooks:
+      - id: reorder-python-imports
+        args: [--application-directories=src]

noxfile.py

@@ -12,12 +12,14 @@
 
 def install_with_constraints(session: Session, *args: str, **kwargs: Any) -> None:
     """Install packages constrained by Poetry's lock file.
+
     This function is a wrapper for nox.sessions.Session.install. It
     invokes pip to install packages inside of the session's virtualenv.
     Additionally, pip is passed a constraints file generated from
     Poetry's lock file, to ensure that the packages are pinned to the
     versions specified in poetry.lock. This allows you to manage the
     packages as Poetry development dependencies.
+
     Arguments:
         session: The Session object.
         args: Command-line arguments for pip.

poetry.lock

@@ -34,6 +34,7 @@ pytest = "^5.4.2"
 coverage = {extras = ["toml"], version = "^5.0.4"}
 pytest-cov = "^2.8.1"
 typeguard = "^2.7.1"
+pre-commit = "^2.4.0"
 
 [tool.coverage.paths]
 source = ["src", "*/site-packages"]

pyproject.toml

@@ -1,16 +1,29 @@
 #!/usr/bin/env python
 # -*- coding: utf-8 -*-
-
 """Bits & Bytes related humanization."""
 
 
-def natural_size(value, binary=False, gnu=False, formatting="%.1f"):
-    """Format a number of byteslike a human readable filesize (eg. 10 kB).  By
+def natural_size(
+    value: int, binary: bool = False, gnu: bool = False, formatting: str = "%.1f"
+) -> str:
+    """Returns human-readable file size.
+
+    Format a number of byteslike a human readable filesize (eg. 10 kB).  By
     default, decimal suffixes (kB, MB) are used.  Passing binary=true will use
     binary suffixes (KiB, MiB) are used and the base will be 2**10 instead of
     10**3.  If ``gnu`` is True, the binary argument is ignored and GNU-style
     (ls -sh style) prefixes are used (K, M) with the 2**10 definition.
-    Non-gnu modes are compatible with jinja2's ``filesizeformat`` filter."""
+    Non-gnu modes are compatible with jinja2's ``filesizeformat`` filter.
+
+    Args:
+        value (int): size number.
+        binary (bool): binary format. Defaults to False.
+        gnu (bool): GNU format. Defaults to False.
+        formatting (str): format pattern. Defaults to "%.1f".
+
+    Returns:
+        str: file size in natural language.
+    """
     if gnu:
         sufs = ("K", "M", "G", "T", "P", "E", "Z", "Y")
     elif binary:

src/humanizer_portugues/filesize.py

@@ -1,27 +1,35 @@
 #!/usr/bin/env python
 # -*- coding: utf-8 -*-
-
 """Lists related humanization."""
+from typing import List
 
 __all__ = ["natural_list"]
 
 
-def natural_list(itens, separator, conjunction=None):
-    """
-    Returns human readable list separated by separator
-    Optional argument is conjuntion that substitutes the last separator
+def natural_list(items: List, separator: str, conjunction: str = None) -> str:
+    """Returns human readable list separated by separator.
+
+    Optional argument is conjuntion that substitutes the last separator.
+
+    Args:
+        items (List): list of items.
+        separator (str): separator of items.
+        conjunction (str): word/string as last separator. Defaults to None.
+
+    Returns:
+        str: list in natural language.
     """
-    len_itens = len(itens)
-    if len_itens == 0:
+    len_items = len(items)
+    if len_items == 0:
         return ""
-    if len_itens == 1:
-        return itens[0]
-    phrase = itens[0]
+    if len_items == 1:
+        return items[0]
+    phrase = items[0]
     if conjunction:
-        for i in range(1, len_itens - 1):
-            phrase += "%s %s" % (separator, itens[i])
-        phrase += " %s %s" % (conjunction, itens[len_itens - 1])
+        for i in range(1, len_items - 1):
+            phrase += "%s %s" % (separator, items[i])
+        phrase += " %s %s" % (conjunction, items[len_items - 1])
     else:
-        for i in range(1, len_itens):
-            phrase += "%s %s" % (separator, itens[i])
+        for i in range(1, len_items):
+            phrase += "%s %s" % (separator, items[i])
     return phrase