hippogriffe 0.1.1__py3-none-any.whl → 0.1.3__py3-none-any.whl

hippogriffe/_extension.py

@@ -41,52 +41,54 @@ class _PublicApi:
         self._data: dict[str, list[str]] = {}
         self._builtin_modules = builtin_modules
         self._public_modules = stdlib_modules + extra_public_modules
-        seen: set[griffe.Alias | griffe.Object] = set()  # Don't infinite loop on cycles
+        # Don't infinite loop on cycles. We only store Objects, and not Aliases, as in
+        # cycles then the aliases with be distinct: `X.Y.X.Y` is not `X.Y`, though the
+        # underlying object is the same.
 
-        agenda: list[tuple[griffe.Alias | griffe.Object, bool]] = [(pkg, False)]
+        agenda: list[tuple[griffe.Object, bool]] = [(pkg, False)]
+        seen: set[griffe.Object] = {pkg}
         while len(agenda) > 0:
             item, force_public = agenda.pop()
-            seen.add(item)
-            # Skip private elements
-            if item.name.startswith("_") and not (
-                item.name.startswith("__") and item.name.endswith("__")
-            ):
-                continue
-            if isinstance(item, griffe.Alias):
-                try:
-                    final_item = item.final_target
-                except griffe.AliasResolutionError:
-                    continue
-                if item.name != final_item.name:
-                    # Renaming during import counts as private.
-                    # (In particular this happens for backward compatibility, e.g.
-                    # `equinox.nn.inference_mode` and `equinox.tree_inference`.)
-                    continue
-            else:
-                final_item = item
-
             toplevel_public = item.path in top_level_public_api
             if force_public or toplevel_public:
                 # If we're in the public API, then we consider all of our children to be
                 # in it as well... (this saves us from having to parse out `filters` and
                 # `members` from our documentation)
-                agenda.extend(
-                    (x, True) for x in item.all_members.values() if x not in seen
-                )
                 try:
-                    paths = self._data[final_item.path]
+                    paths = self._data[item.path]
                 except KeyError:
-                    paths = self._data[final_item.path] = []
+                    paths = self._data[item.path] = []
                 paths.append(item.path)
-                self._objects.add(final_item)
+                self._objects.add(item)
                 if toplevel_public:
-                    self._toplevel_objects.add(final_item)
+                    self._toplevel_objects.add(item)
+                sub_force_public = True
             else:
                 # ...if we're not in the public API then check our members -- some of
                 # them might be in the public API.
-                agenda.extend(
-                    (x, False) for x in item.all_members.values() if x not in seen
-                )
+                sub_force_public = False
+            for member in item.all_members.values():
+                # Skip private elements
+                if member.name.startswith("_") and not (
+                    member.name.startswith("__") and item.name.endswith("__")
+                ):
+                    continue
+                if isinstance(member, griffe.Alias):
+                    try:
+                        final_member = member.final_target
+                    except griffe.AliasResolutionError:
+                        continue
+                    if member.name != final_member.name:
+                        # Renaming during import counts as private.
+                        # (In particular this happens for backward compatibility, e.g.
+                        # `equinox.nn.inference_mode` and `equinox.tree_inference`.)
+                        continue
+                else:
+                    final_member = member
+                if final_member in seen:
+                    continue
+                agenda.append((final_member, sub_force_public))
+                seen.add(final_member)
 
     def toplevel(self) -> Iterable[griffe.Object]:
         return self._toplevel_objects
@@ -235,18 +237,6 @@ def _get_repo_url(repo_url: None | str) -> tuple[pathlib.Path, str]:
             "`hippogriffe.show_source_links` requires specifying a top-level "
             "`repo_url`."
         )
-    is_github = (
-        repo_url.removeprefix("https://")
-        .removeprefix("https://")
-        .startswith("github.com")
-    )
-    if not is_github:
-        # We need to format the `repo_url` to what the repo expects, so we have to
-        # hardcode this in.
-        raise ValueError(
-            "`hippogriffe.show_source_links` currently only supports "
-            "`repo_url: https://github.com/...`."
-        )
     try:
         git_head = subprocess.run(
             ["git", "rev-parse", "HEAD"], capture_output=True, check=False
@@ -264,9 +254,19 @@ def _get_repo_url(repo_url: None | str) -> tuple[pathlib.Path, str]:
     else:
         toplevel = pathlib.Path(git_toplevel.stdout.decode().strip())
         commit_hash = git_head.stdout.decode().strip()
-    repo_url = (
-        f"{repo_url.removesuffix('/')}/blob/{commit_hash}/{{path}}#L{{start}}-{{end}}"
-    )
+    raw_url = repo_url.removeprefix("https://").removeprefix("https://")
+    if raw_url.startswith("github.com") or raw_url.startswith("gitlab.com"):
+        repo_url = (
+            f"{repo_url.removesuffix('/')}/blob/{commit_hash}/{{path}}"
+            "#L{start}-{end}"
+        )
+    else:
+        # We need to format the `repo_url` to what the repo expects, so we have to
+        # hardcode this in.
+        raise ValueError(
+            "`hippogriffe.show_source_links` currently only supports "
+            "`repo_url: https://github.com/...` and `repo_url: https://gitlab.com/...`."
+        )
     return toplevel, repo_url
 
 

{hippogriffe-0.1.1.dist-info → hippogriffe-0.1.3.dist-info}/METADATA

@@ -1,7 +1,7 @@
 Metadata-Version: 2.4
 Name: hippogriffe
-Version: 0.1.1
-Summary: A simple ipynb->md converter for MkDocs
+Version: 0.1.3
+Summary: Tweaks for `mkdocstrings[python]`
 Project-URL: repository, https://github.com/patrick-kidger/hippogriffe
 Author-email: Patrick Kidger <contact@kidger.site>
 License:                                  Apache License

{hippogriffe-0.1.1.dist-info → hippogriffe-0.1.3.dist-info}/RECORD

@@ -1,12 +1,12 @@
 hippogriffe/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-hippogriffe/_extension.py,sha256=8hNBWcIxG5ux6iOnPUWOf5Ks6oxPZy6mjXez21bNaJM,13948
+hippogriffe/_extension.py,sha256=eCxc3ojhWAErkcCe0aCFifscR7giwg2LSIk8Sng0i60,14244
 hippogriffe/_plugin.py,sha256=H0oPka_7URED9wOVYAWUNTWTJXFmH6q7g2W2G5hy64c,4564
 hippogriffe/assets/_hippogriffe.css,sha256=BgyZLCaOaZNgQErdUb01vpNso4ilUMmoZ5d_OeVpfRE,147
 hippogriffe/templates/material/hippogriffe/class.html.jinja,sha256=5i624gIuZfnf5toH3jWclzg1qlekqIZ2ODbpzeZcULw,954
 hippogriffe/templates/material/hippogriffe/fn.html.jinja,sha256=vxrWOPkPkGD3Po9hbcYlyEjsJKhJmOHic4G5t2J0djc,196
 hippogriffe/templates/material/hippogriffe/hippogriffe.jinja,sha256=KxTBKY0XqiFzqTT1iqFxhN2GhmtwLT4GWc8S86zyjOc,583
-hippogriffe-0.1.1.dist-info/METADATA,sha256=1Hl3bjXgHzuBbA7muETfEYYF1iT0jvoTWxw7nIgeF1A,16274
-hippogriffe-0.1.1.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-hippogriffe-0.1.1.dist-info/entry_points.txt,sha256=Et3dFNWG-biZ7XCvPI9na-buFT_hht1YT0p0JDNEQQM,158
-hippogriffe-0.1.1.dist-info/licenses/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
-hippogriffe-0.1.1.dist-info/RECORD,,
+hippogriffe-0.1.3.dist-info/METADATA,sha256=OLb3uUzB1-8xA9Db8lGBHf3rTgVBxuFioMA_X0DjSF8,16268
+hippogriffe-0.1.3.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+hippogriffe-0.1.3.dist-info/entry_points.txt,sha256=Et3dFNWG-biZ7XCvPI9na-buFT_hht1YT0p0JDNEQQM,158
+hippogriffe-0.1.3.dist-info/licenses/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
+hippogriffe-0.1.3.dist-info/RECORD,,