Pre-commit hooks to handle #noqas

Stop blanket #noqas and remove unnecessary ones

Author: martinburchell

.pre-commit-config.yaml

@@ -18,3 +18,11 @@ repos:
     rev: 5.0.4
     hooks:
     -   id: flake8
+-   repo: https://github.com/asottile/yesqa
+    rev: v1.5.0
+    hooks:
+    -   id: yesqa
+-   repo: https://github.com/pre-commit/pygrep-hooks
+    rev: v1.9.0
+    hooks:
+    -   id: python-check-blanket-noqa

cardinal_pythonlib/argparse_func.py

@@ -55,7 +55,7 @@ class ShowAllSubparserHelpAction(_HelpAction):
     shows help for all subparsers. As per
 
     https://stackoverflow.com/questions/20094215/argparse-subparser-monolithic-help-output
-    """  # noqa: E501
+    """
 
     def __call__(
         self,
@@ -147,7 +147,7 @@ def str2bool(v: str) -> bool:
             default=NICE,  # if the argument is entirely absent
             help="Activate nice mode.")
 
-    """  # noqa: E501
+    """
     lv = v.lower()
     if lv in ("yes", "true", "t", "y", "1"):
         return True

cardinal_pythonlib/cmdline.py

@@ -48,7 +48,7 @@ def cmdline_split(s: str, platform: Union[int, str] = "this") -> List[str]:
             - ``1`` = POSIX;
             - ``0`` = Windows/CMD
             - (other values reserved)
-    """  # noqa: E501
+    """
     if platform == "this":
         platform = sys.platform != "win32"  # RNC: includes 64-bit Windows
 

cardinal_pythonlib/compression.py

@@ -88,7 +88,7 @@ def gzip_string(text: str, encoding: str = "utf-8") -> bytes:
         print(gz1 == gz2)  # False
         # ... but the difference is probably in the timestamp bytes!
 
-    """  # noqa: E501
+    """
     data = text.encode(encoding)
     return gzip.compress(data)
 

cardinal_pythonlib/datetimefunc.py

@@ -307,7 +307,7 @@ def strfdelta(
 
     Modified from
     https://stackoverflow.com/questions/538666/python-format-timedelta-to-string
-    """  # noqa: E501
+    """
 
     # Convert tdelta to integer seconds.
     if inputtype == "timedelta":
@@ -639,7 +639,7 @@ def duration_to_iso(
       realistic (negative, 1000 years, 11 months, and the maximum length for
       seconds/microseconds).
 
-    """  # noqa: E501
+    """
     prefix = ""
     negative = d < Duration()
     if negative and minus_sign_at_front:

cardinal_pythonlib/dicts.py

@@ -120,7 +120,7 @@ def rename_keys_in_dict(d: Dict[str, Any], renames: Dict[str, str]) -> None:
 
     See
     https://stackoverflow.com/questions/4406501/change-the-name-of-a-key-in-dictionary.
-    """  # noqa: E501
+    """
     for old_key, new_key in renames.items():
         if new_key == old_key:
             continue
@@ -257,7 +257,7 @@ class LazyDict(dict):
 
     The ``*args``/``**kwargs`` parts are useful, but we don't want to have to
     name 'thunk' explicitly.
-    """  # noqa: E501
+    """
 
     def get(
         self, key: Hashable, thunk: Any = None, *args: Any, **kwargs: Any
@@ -292,7 +292,7 @@ class LazyButHonestDict(dict):
     Compared to the StackOverflow version: no obvious need to have a default
     returning ``None``, when we're implementing this as a special function.
     In contrast, helpful to have ``*args``/``**kwargs`` options.
-    """  # noqa: E501
+    """
 
     def lazyget(
         self, key: Hashable, thunk: Callable, *args: Any, **kwargs: Any

cardinal_pythonlib/docker.py

@@ -35,7 +35,7 @@ def running_under_docker() -> bool:
     As per
     https://stackoverflow.com/questions/43878953/how-does-one-detect-if-one-is-running-within-a-docker-container-within-python
     ... but without leaving a file open.
-    """  # noqa: E501
+    """
     # 1. Does /.dockerenv exist?
     if os.path.exists("/.dockerenv"):
         return True

cardinal_pythonlib/dogpile_cache.py

@@ -128,7 +128,7 @@ def get_namespace(fn: Callable, namespace: Optional[str]) -> str:
             normally a ``str``; if not ``None``, ``str(namespace)`` will be
             added to the result. See
             https://dogpilecache.readthedocs.io/en/latest/api.html#dogpile.cache.region.CacheRegion.cache_on_arguments
-    """  # noqa: E501
+    """
     # See hidden attributes with dir(fn)
     # noinspection PyUnresolvedReferences
     return "{module}:{name}{extra}".format(

cardinal_pythonlib/dsp.py

@@ -65,7 +65,7 @@ def normalized_frequency(f: float, sampling_freq: float) -> float:
     - e.g. see https://en.wikipedia.org/wiki/Nyquist_frequency,
       https://docs.scipy.org/doc/scipy/reference/generated/scipy.signal.iirnotch.html
 
-    """  # noqa: E501
+    """
     return f / (sampling_freq / 2.0)
 
 

cardinal_pythonlib/email/sendmail.py

@@ -462,7 +462,7 @@ def send_email(
       https://docs.djangoproject.com/en/2.1/ref/settings/#email-use-ssl). We
       don't support that here.
 
-    """  # noqa: E501
+    """
     if isinstance(to, str):
         to = [to]
     if isinstance(cc, str):
@@ -533,7 +533,7 @@ def is_email_valid(email_: str) -> bool:
 
     See
     https://stackoverflow.com/questions/8022530/how-to-check-for-valid-email-address.
-    """  # noqa: E501
+    """
     # Very basic checks!
     if not email_:
         return False