enrich pre-commit hook

Author: GreatBahram

.github/workflows/test.yml

@@ -17,4 +17,4 @@ jobs:
                 pip install '.[dev]'
             - name: Run tests
               run: |
-                pytest
+                pytest

.gitignore

@@ -8,4 +8,3 @@ wheels/
 
 # Virtual environments
 .venv
-

.pre-commit-config.yaml

@@ -8,3 +8,17 @@ repos:
     rev: v1.2.3
     hooks:
     - id: flake8
+- repo: https://github.com/pre-commit/pre-commit-hooks
+  rev: v4.5.0
+  hooks:
+    - id: check-case-conflict
+    - id: check-merge-conflict
+    - id: check-symlinks
+    - id: check-toml
+    - id: check-yaml
+    - id: end-of-file-fixer
+    - id: mixed-line-ending
+      args: ["--fix=lf"]
+    - id: trailing-whitespace
+      exclude: \.md$
+    - id: no-commit-to-branch

README.md

@@ -65,4 +65,4 @@ Install pre-commit hooks to ensure code quality:
 ```shell
 pre-commit install
 pre-commit install -t pre-push
-```
+```

pyproject.toml

@@ -46,4 +46,4 @@ where = ["src"]
 max-line-length = 88
 
 [tool.pytest.ini_options]
-testpaths = ["src/tests"]
+testpaths = ["src/tests"]

shecan.svg

@@ -37,7 +37,7 @@ def list_dns():
 
 
 def current_dns() -> List[Resolver]:
-    """ List current dns servers in /etc/resolv.conf."""
+    """List current dns servers in /etc/resolv.conf."""
     resolv_list = []
     if sys.platform == "linux":
         with open("/etc/resolv.conf", mode="rt") as resovl_file:

src/shecan/api.py

@@ -85,7 +85,7 @@ def verify_dns() -> None:
 
 
 def show_current_dns() -> None:
-    """ List current dns servers in /etc/resolv.conf."""
+    """List current dns servers in /etc/resolv.conf."""
     try:
         resolvers = shecan.current_dns()
     except FileNotFoundError:
@@ -120,7 +120,10 @@ def shecan_cli():
     set_.set_defaults(op="set")
 
     # `restore` command
-    restore = subparsers.add_parser("restore", help="Restore old DNS configuration.")
+    restore = subparsers.add_parser(
+        "restore",
+        help="Restore old DNS configuration.",
+    )
     restore.set_defaults(op="restore")
 
     # `update` command
@@ -129,7 +132,8 @@ def shecan_cli():
 
     # `show` command
     show = subparsers.add_parser(
-        "show", help="Show your current dns servers in '/etc/resolv.conf'."
+        "show",
+        help="Show your current dns servers in '/etc/resolv.conf'.",
     )
     show.set_defaults(op="show")
 
@@ -148,14 +152,14 @@ def shecan_cli():
     elif args.op == "verify":
         verify_dns()
     elif args.op == "set":
-
         if sys.platform != "linux":
             logger.error("Currently only Linux operating system is supported.")
             sys.exit(2)
 
         content = [f"nameserver {dns_ip}" for dns_ip in shecan.list_dns()]
         if not content:
-            logger.error("Couldn't find Shecan DNS IP addresses in the config file.")
+            error_msg = "Couldn't find Shecan DNS IP addresses in the config file."
+            logger.error(error_msg)
             sys.exit(1)
 
         update_resolv_file(content)

src/shecan/cli.py

@@ -46,11 +46,15 @@ def list_dns(self):
             ips = []
         return ips
 
-    def delete(self,) -> None:
+    def delete(
+        self,
+    ) -> None:
         """Remove all Shecan's dns servers from configuration."""
         self._parser.remove_section(self._name)
         self._initialize()
 
-    def remove(self,) -> None:
+    def remove(
+        self,
+    ) -> None:
         """Remove the configuration file."""
         Path(self.config_file).unlink()

src/shecan/db.py

@@ -3,6 +3,7 @@
 ~~~~~~~~~~~~~~
 This module provides utility functions that are used within shecan.
 """
+
 from typing import Tuple
 from urllib import request
 
@@ -13,7 +14,7 @@
 
 
 def get_shecan_ips(url: str = BASE_URL, selector: str = CSS_SELECTOR) -> Tuple[str]:
-    """ Retrieve shecan DNS IP addresses."""
+    """Retrieve shecan DNS IP addresses."""
     data = request.urlopen(BASE_URL).read().decode("utf-8")
     soup = BeautifulSoup(data, "lxml")
     ips = soup.select(selector)