apply pre-commit fixes

Author: hamelsmu

quartodoc/__main__.py

@@ -12,6 +12,7 @@
 from quartodoc import Builder, convert_inventory
 from pydantic import BaseModel
 
+
 def get_package_path(package_name):
     """
     Get the path to a package installed in the current environment.
@@ -20,13 +21,16 @@ def get_package_path(package_name):
         lib = importlib.import_module(package_name)
         return lib.__path__[0]
     except ModuleNotFoundError:
-        raise ModuleNotFoundError(f"Package {package_name} not found.  Please install it in your environment.")
+        raise ModuleNotFoundError(
+            f"Package {package_name} not found.  Please install it in your environment."
+        )
 
 
 class FileInfo(BaseModel):
     size: int
     mtime: float
-    name: str= ""
+    name: str = ""
+
 
 class QuartoDocFileChangeHandler(PatternMatchingEventHandler):
     """
@@ -35,51 +39,59 @@ class QuartoDocFileChangeHandler(PatternMatchingEventHandler):
 
     # Ignore patterns for the file watcher that are not relevant to the docs
     py_ignore_patterns = [
-        '*/__pycache__/*',  # These are the compiled python code files which are automatically generated by Python
-        '*/.ipynb_checkpoints/*',  # This directory is created by Jupyter Notebook for auto-saving notebooks
-        '*/.vscode/*',  # If you're using Visual Studio Code, it creates this directory to store settings specific to that project.
-        '*/.idea/*',  # Similar to .vscode/, but for JetBrains IDEs like PyCharm.
-        '*/.git/*',  # i This directory is created by Git. It's not relevant to the docs.
-        '*/venv/*', '*/env/*',  '*/.env/*',  # Common names for directories containing a Python virtual environment.
-        '*/.pytest_cache/*',  # This directory is created when you run Pytest.
-        '*/.eggs/*', '*/dist/*', '*/build/*', '*/*.egg-info/*', # These are typically created when building Python packages with setuptools.
-        '*.pyo',  # These are optimized .pyc files, created when Python is run with the -O flag.
-        '*.pyd',  # This is the equivalent of a .pyc file, but for C extensions on Windows.
-        '*/.mypy_cache/*', # This directory is created when you run mypy.
+        "*/__pycache__/*",  # These are the compiled python code files which are automatically generated by Python
+        "*/.ipynb_checkpoints/*",  # This directory is created by Jupyter Notebook for auto-saving notebooks
+        "*/.vscode/*",  # If you're using Visual Studio Code, it creates this directory to store settings specific to that project.
+        "*/.idea/*",  # Similar to .vscode/, but for JetBrains IDEs like PyCharm.
+        "*/.git/*",  # i This directory is created by Git. It's not relevant to the docs.
+        "*/venv/*",
+        "*/env/*",
+        "*/.env/*",  # Common names for directories containing a Python virtual environment.
+        "*/.pytest_cache/*",  # This directory is created when you run Pytest.
+        "*/.eggs/*",
+        "*/dist/*",
+        "*/build/*",
+        "*/*.egg-info/*",  # These are typically created when building Python packages with setuptools.
+        "*.pyo",  # These are optimized .pyc files, created when Python is run with the -O flag.
+        "*.pyd",  # This is the equivalent of a .pyc file, but for C extensions on Windows.
+        "*/.mypy_cache/*",  # This directory is created when you run mypy.
     ]
 
     def __init__(self, callback):
-        super().__init__(ignore_patterns=self.py_ignore_patterns, ignore_directories=True)
+        super().__init__(
+            ignore_patterns=self.py_ignore_patterns, ignore_directories=True
+        )
         self.callback = callback
         self.old_file_info = FileInfo(size=-1, mtime=-1, name="")
 
-
-    def get_file_info(self, path:str) -> FileInfo:
+    def get_file_info(self, path: str) -> FileInfo:
         """
         Get the file size and modification time.
         """
-        return FileInfo(size=os.stat(path).st_size, 
-                        mtime=os.stat(path).st_mtime, 
-                        name=path)
-    
-    def is_diff(self, old:FileInfo, new:FileInfo) -> bool:
+        return FileInfo(
+            size=os.stat(path).st_size, mtime=os.stat(path).st_mtime, name=path
+        )
+
+    def is_diff(self, old: FileInfo, new: FileInfo) -> bool:
         """
         Check if a file has changed. Prevents duplicate events from being triggered.
         """
         same_nm = old.name == new.name
         diff_sz = old.size != new.size
-        diff_tm = (new.mtime - old.mtime) # wait 1/4 second before triggering
+        diff_tm = new.mtime - old.mtime  # wait 1/4 second before triggering
 
-        if diff_tm < .25: # if consequetive events are less than 1/4th of a second apart, ignore
+        if (
+            diff_tm < 0.25
+        ):  # if consequetive events are less than 1/4th of a second apart, ignore
             return False
         elif same_nm:
             if diff_sz or diff_tm >= 0.25:
                 return True
             else:
                 return False
         else:
-            return True     
-    
+            return True
+
     def callback_if_diff(self, event):
         """
         Call the callback if the file has changed.
@@ -92,14 +104,15 @@ def callback_if_diff(self, event):
 
     @classmethod
     def print_event(cls, event):
-        print(f'Rebuilding docs.  Detected: {event.event_type} path : {event.src_path}')
+        print(f"Rebuilding docs.  Detected: {event.event_type} path : {event.src_path}")
 
     def on_modified(self, event):
         self.callback_if_diff(event)
 
     def on_created(self, event):
         self.callback_if_diff(event)
 
+
 def _enable_logs():
     import logging
     import sys
@@ -132,10 +145,29 @@ def cli():
 
 
 @click.command()
-@click.option("--config", default="_quarto.yml", help="Change the path to the configuration file.  The default is `./_quarto.yml`")
-@click.option("--filter", nargs=1, default="*", help="Specify the filter to select specific files. The default is '*' which selects all files.")
-@click.option("--dry-run", is_flag=True, default=False, help="If set, prevents new documents from being generated.")
-@click.option("--watch", is_flag=True, default=False, help="If set, the command will keep running and watch for changes in the package directory.")
+@click.option(
+    "--config",
+    default="_quarto.yml",
+    help="Change the path to the configuration file.  The default is `./_quarto.yml`",
+)
+@click.option(
+    "--filter",
+    nargs=1,
+    default="*",
+    help="Specify the filter to select specific files. The default is '*' which selects all files.",
+)
+@click.option(
+    "--dry-run",
+    is_flag=True,
+    default=False,
+    help="If set, prevents new documents from being generated.",
+)
+@click.option(
+    "--watch",
+    is_flag=True,
+    default=False,
+    help="If set, the command will keep running and watch for changes in the package directory.",
+)
 @click.option("--verbose", is_flag=True, default=False, help="Enable verbose logging.")
 def build(config, filter, dry_run, watch, verbose):
     """
@@ -160,7 +192,7 @@ def build(config, filter, dry_run, watch, verbose):
                 pkg_path = get_package_path(builder.package)
                 print(f"Watching {pkg_path} for changes...")
                 observer = Observer()
-                observer._event_queue.maxsize = 1 # the default is 0 which is infinite, and there isn't a way to set this in the constructor
+                observer._event_queue.maxsize = 1  # the default is 0 which is infinite, and there isn't a way to set this in the constructor
                 event_handler = QuartoDocFileChangeHandler(callback=doc_build)
                 observer.schedule(event_handler, pkg_path, recursive=True)
                 observer.schedule(event_handler, cfg_path, recursive=True)
@@ -173,9 +205,10 @@ def build(config, filter, dry_run, watch, verbose):
                 finally:
                     observer.stop()
                     observer.join()
-            else:   
+            else:
                 doc_build()
 
+
 @click.command()
 @click.argument("config", default="_quarto.yml")
 @click.option("--dry-run", is_flag=True, default=False)
@@ -192,7 +225,6 @@ def interlinks(config, dry_run):
         return
 
     for k, v in interlinks["sources"].items():
-
         # TODO: user shouldn't need to include their own docs in interlinks
         if v["url"] == "/":
             continue

quartodoc/autosummary.py

@@ -358,6 +358,7 @@ def _is_valueless(obj: dc.Object):
 
 # pkgdown =====================================================================
 
+
 # TODO: styles -- pkgdown, single-page, many-pages
 class Builder:
     """Base class for building API docs.
@@ -643,9 +644,7 @@ def from_quarto_config(cls, quarto_cfg: "str | dict"):
 
 
 class BuilderPkgdown(Builder):
-    """Build an API in R pkgdown style.
-
-    """
+    """Build an API in R pkgdown style."""
 
     style = "pkgdown"
 

quartodoc/builder/blueprint.py

@@ -128,7 +128,6 @@ def _non_default_entries(el: "BaseModel"):
 
 class BlueprintTransformer(PydanticTransformer):
     def __init__(self, get_object=None, parser="numpy"):
-
         if get_object is None:
             loader = GriffeLoader(
                 docstring_parser=Parser(parser),

quartodoc/interlinks.py

@@ -369,7 +369,6 @@ def from_items(cls, items: "list[EnhancedItem]"):
 
     @classmethod
     def from_quarto_config(cls, cfg: str | dict, root_dir: str | None = None):
-
         if isinstance(cfg, str):
             if root_dir is None:
                 root_dir = Path(cfg).parent
@@ -391,7 +390,6 @@ def from_quarto_config(cls, cfg: str | dict, root_dir: str | None = None):
 
         # load other inventories ----
         for doc_name, cfg in sources.items():
-
             fname = doc_name + "_objects.json"
             inv_path = p_root / Path(cache) / fname
 

quartodoc/inventory.py

@@ -134,7 +134,10 @@ def _to_clean_dict(inv: soi.Inventory):
 
 @dispatch
 def _create_inventory_item(
-    item: Union[dc.Object, dc.Alias], uri, dispname="-", priority="1",
+    item: Union[dc.Object, dc.Alias],
+    uri,
+    dispname="-",
+    priority="1",
 ) -> soi.DataObjStr:
     target = item
 

quartodoc/tests/test_interlinks.py

@@ -55,7 +55,6 @@ def test_ref_from_string(raw, dst):
 
 @pytest.mark.parametrize("entry", spec)
 def test_spec_entry(invs: Inventories, entry: TestSpecEntry):
-
     ref_str, text = parse_md_style_link(entry.input)
     ref_str = ref_str.replace("`", "%60")  # weird, but matches pandoc
 

quartodoc/validation.py

@@ -1,27 +1,26 @@
-
-def fmt(err:dict):
+def fmt(err: dict):
     "format error messages from pydantic."
     msg = ""
-    if err['msg'].startswith('Discriminator'):
+    if err["msg"].startswith("Discriminator"):
         return msg
-    if err['type'] == 'value_error.missing':
-        msg += 'Missing field'
+    if err["type"] == "value_error.missing":
+        msg += "Missing field"
     else:
-        msg += err['msg'] + ':'
-        
-    if 'loc' in err:
-        if len(err['loc']) == 1:
+        msg += err["msg"] + ":"
+
+    if "loc" in err:
+        if len(err["loc"]) == 1:
             msg += f" from root level: `{err['loc'][0]}`"
-        elif len(err['loc']) == 3:
+        elif len(err["loc"]) == 3:
             msg += f" `{err['loc'][2]}` for element {err['loc'][1]} in the list for `{err['loc'][0]}`"
-        elif len(err['loc']) == 4 and err['loc'][2] == 'Page':
+        elif len(err["loc"]) == 4 and err["loc"][2] == "Page":
             msg += f" `{err['loc'][3]}` for element {err['loc'][1]} in the list for `{err['loc'][0]}`, which you need when setting `kind: page`."
-        elif len(err['loc']) == 5:
+        elif len(err["loc"]) == 5:
             msg += f" `{err['loc'][4]}` for element {err['loc'][3]} in the list for `{err['loc'][2]}` located in element {err['loc'][1]} in the list for `{err['loc'][0]}`"
-        elif len(err['loc']) == 6 and err['loc'][4] == 'Auto':
+        elif len(err["loc"]) == 6 and err["loc"][4] == "Auto":
             msg += f" `{err['loc'][5]}` for element {err['loc'][3]} in the list for `{err['loc'][2]}` located in element {err['loc'][1]} in the list for `{err['loc'][0]}`"
         else:
-            return str(err) # so we can debug and include more cases
+            return str(err)  # so we can debug and include more cases
     else:
         msg += str(err)
     return msg