lint and test improvements

Author: GhostofGoes

CHANGELOG.md

@@ -19,7 +19,8 @@
     - If you pass it some weird bytes that aren't decodable as utf-8, it's obviously going to break. Don't be dumb :)
 
 ### Changed
-* Reduce size of wheel file (`.whl`)
+* BREAKING CHANGE: refactored how settings are handled. Instead of module-level globals, they're implemented in a Settings singleton in `getmac.settings`. For example, `getmac.getmac.PORT` should now be `getmac.settings.PORT`.
+* Reduce size of wheel distribution (`.whl` file)
 
 ### Removed
 * Removed support for Python 2.7. It's time. Supporting 2.7 has become an onerous burden on the project, and has prevented fully supporting 3.10 and 3.11 due to having to stay on an ancient version of pytest. I'm done supporting a version of the language that hasn't been updated in nearly 15 years, and has been wholly unsupported for over 5 years.
@@ -36,6 +37,8 @@
   * Add `pyproject.toml`, consolidated most tool configurations here
   * Removed `setup.py`,  `MANIFEST.in`, `requirements*.txt`, `tox.ini`
 * Switched to CodeCov from Coveralls
+* Use [isort](https://pycqa.github.io/isort/index.html) to sort imports
+* Refactored source code documentation and added an API reference to the docs
 
 ## 0.9.5 (07/15/2024)
 

docs/misc_docs/TODO.md

@@ -10,7 +10,7 @@
 - [ ] Re-add Man pages (and auto-build them in CI and include in releases and the distributions)
 - [x] Document `get_by_method()`
 - [x] Document `initialize_method_cache()`
-- [ ] Auto-generated API docs
+- [x] Auto-generated API docs
 - [x] Add docstrings to all util methods
 - [x] Furo, sphinx-autodoc-typehints, sphinx-argparse-cli, sphinx-automodapi, sphinx-copybutton, recommonmark
 
@@ -19,7 +19,7 @@
 - [ ] >90% test coverage
   - refactor tests to use the new system and structure
   - directly test methods via a `Method.parse()` function
-  - add `Method.parse()` that handles the parsing of command 
+  - add `Method.parse()` that handles the parsing of command
 - [ ] Improve CLI tests to ensure output is what's expected (e.g. ensure `--override-port` logs a warning and the value actually gets overridden)
 
 ## Features
@@ -43,7 +43,7 @@
         - Passing an instance of a subclass of `getmac.Method`
         - Add a CLI argument to reference class by name
     - Add ability to exclude methods. Just remove them from METHODS list so they never get used. Useful for testing specific methods or working around buggy methods.
-    - Document these features in the README/docs, including the CLI arguments 
+    - Document these features in the README/docs, including the CLI arguments
 
 ## Enhancements/fixes/misc.
 - [ ] Properly support WSL2
@@ -92,9 +92,9 @@ Removing Tox, maybe. Can do version enumeration in GitHub Actions, for all platf
 
 # Etc
 - [ ] Add to Conda Forge ([example here](https://github.com/conda-forge/staged-recipes/pull/26828/files))
-- [ ] Add [isort](https://pycqa.github.io/isort/) (requires python 3.8+)
+- [x] Add [isort](https://pycqa.github.io/isort/) (requires python 3.8+)
 - [ ] cache the result of executable checks in `getmac.utils.popen()`
-- [ ] Refactor the default interface code. Combine the functions into 
+- [ ] Refactor the default interface code. Combine the functions into
 one, move the default fallback logic into the function.
 - TODO: MAC -> IP. "to_find='mac'"? (create GitHub issue?)
 - [ ] Move method classes into a separate file

getmac/getmac.py

@@ -1763,35 +1763,35 @@ def get_mac_address(
             mac = get_by_method("ip4", ip)
         elif interface:
             mac = get_by_method("iface", interface)
-        else:  # Default to searching for interface
+        # === Default to searching for interface ===
+        elif consts.WINDOWS and network_request:
             # Default to finding MAC of the interface with the default route
-            if consts.WINDOWS and network_request:
-                default_iface_ip = utils.fetch_ip_using_dns()
-                mac = get_by_method("ip4", default_iface_ip)
-            elif consts.WINDOWS:
-                # TODO: implement proper default interface detection on windows
-                #   (add a Method subclass to implement DefaultIface on Windows)
-                mac = get_by_method("iface", "Ethernet")
-            else:
-                if not gvars.DEFAULT_IFACE:
-                    gvars.DEFAULT_IFACE = get_by_method("default_iface")  # type: ignore
+            default_iface_ip = utils.fetch_ip_using_dns()
+            mac = get_by_method("ip4", default_iface_ip)
+        elif consts.WINDOWS:
+            # TODO: implement proper default interface detection on windows
+            #   (add a Method subclass to implement DefaultIface on Windows)
+            mac = get_by_method("iface", "Ethernet")
+        else:
+            if not gvars.DEFAULT_IFACE:
+                gvars.DEFAULT_IFACE = get_by_method("default_iface")  # type: ignore
 
-                    if gvars.DEFAULT_IFACE:
-                        gvars.DEFAULT_IFACE = str(gvars.DEFAULT_IFACE).strip()
+                if gvars.DEFAULT_IFACE:
+                    gvars.DEFAULT_IFACE = str(gvars.DEFAULT_IFACE).strip()
 
-                    # TODO: better fallback if default iface lookup fails
-                    if not gvars.DEFAULT_IFACE and consts.BSD:
-                        gvars.DEFAULT_IFACE = "em0"
-                    elif not gvars.DEFAULT_IFACE and consts.DARWIN:  # OSX, maybe?
-                        gvars.DEFAULT_IFACE = "en0"
-                    elif not gvars.DEFAULT_IFACE:
-                        gvars.DEFAULT_IFACE = "eth0"
+                # TODO: better fallback if default iface lookup fails
+                if not gvars.DEFAULT_IFACE and consts.BSD:
+                    gvars.DEFAULT_IFACE = "em0"
+                elif not gvars.DEFAULT_IFACE and consts.DARWIN:  # OSX, maybe?
+                    gvars.DEFAULT_IFACE = "en0"
+                elif not gvars.DEFAULT_IFACE:
+                    gvars.DEFAULT_IFACE = "eth0"
 
-                mac = get_by_method("iface", gvars.DEFAULT_IFACE)
+            mac = get_by_method("iface", gvars.DEFAULT_IFACE)
 
-                # TODO: hack to fallback to loopback if lookup fails
-                if not mac:
-                    mac = get_by_method("iface", "lo")
+            # TODO: hack to fallback to loopback if lookup fails
+            if not mac:
+                mac = get_by_method("iface", "lo")
 
     gvars.log.debug(f"Raw MAC found: {mac}")
 

getmac/utils.py

@@ -246,7 +246,7 @@ def uuid_convert(mac: int) -> str:
 
 def fetch_ip_using_dns() -> str:
     """
-    Determines the IP address of the default network interface.
+    Determine the IP address of the default network interface.
 
     Sends a UDP packet to Cloudflare's DNS (``1.1.1.1``), which should go through
     the default interface. This populates the source address of the socket,

getmac/variables.py

@@ -156,6 +156,7 @@ class Constants(VarsClass):
 class Variables(VarsClass):
     """
     Things that can change.
+
     Essentially most of the global variables in getmac.
     """
 

pdm.lock

@@ -86,9 +86,9 @@ test = [
     "pytest-benchmark",
     "pytest-cov",
     "pytest-xdist",
+    "pytest-sugar",
     "psutil",
     "pygments<3.0,>=2.13",
-    # TODO: pytest-sugar
 ]
 lint = [
     "codespell>=2.2.4",
@@ -234,10 +234,6 @@ extend-exclude = [
 # If you're still confused, ask a fellow developer for assistance.
 # You can also run "ruff rule <rule>" to explain a rule on the command line, without a browser or internet access.
 select = [
-    "F",    # Pyflakes
-    "E",    # pycodestyle
-    "W",    # Warning
-    "N",    # pep8-naming
     "ANN",  # flake8-annotations
     "S",    # flake8-bandit
     "B",    # flake8-bugbear
@@ -254,11 +250,18 @@ select = [
     "RET",  # flake8-return
     "TID",  # flake8-tidy-imports
     "ARG",  # flake8-unused-arguments
+    "N",    # pep8-naming
+    "E",    # pycodestyle - Error
+    "W",    # pycodestyle - Warning
+    "F",    # Pyflakes
     "PGH",  # pygrep-hooks
-    "PLC",  # Pylint Convention
-    "PLE",  # Pylint Errors
-    "PLW",  # Pylint Warnings
+    "PLC",  # Pylint - Convention
+    "PLE",  # Pylint - Errors
+    "PLR",  # Pylint - Refactor
+    "PLW",  # Pylint - Warnings
+    # "UP",   # pyupgrade
     "RUF",  # Ruff-specific rules
+
 ]
 
 # Linting error codes to ignore
@@ -273,10 +276,13 @@ ignore = [
     "RUF012",  # Mutable class attributes should be annotated with typing.ClassVar
     "S603",    # subprocess-without-shell-equals-true
     "PLC0415", # import should be at the top-level of a file (getmac uses imports in functions)
+    "PLR0915",
+    "PLR0912",
+    "PLR2004",
 ]
 
 [tool.ruff.lint.per-file-ignores]
-"tests/*.py" = ["ANN001", "ANN002", "ANN003", "ANN201", "ANN202", "S101", "S104", "S603"]
+"tests/*.py" = ["ANN001", "ANN002", "ANN003", "ANN201", "ANN202", "S101", "S104", "S603", "D", "PLR"]
 
 [tool.isort]
 profile = "black"

pyproject.toml

@@ -1,4 +1,3 @@
-import io
 from os import path
 
 import pytest
@@ -12,9 +11,7 @@
 def get_sample():
     def _get_sample(sample_path):
         sdir = path.realpath(path.join(path.dirname(__file__), "samples"))
-        with io.open(
-            path.join(sdir, sample_path), "rt", newline="", encoding="utf-8"
-        ) as f:
+        with open(path.join(sdir, sample_path), newline="", encoding="utf-8") as f:
             return f.read()
 
     return _get_sample